Skip to main content

azNetworkInterface

Deploy an Azure Network Interface to the relevant subscription.

Attributes

AttributeTypeMandatoryValuesDefaultNotes
NameStringYes
ResourceGroupNameStringYes
LocationStringYes
VirtualNetworkObjectYes
NSGNameStringNo
EnableAcceleratedNetworkingBooleanNoFalse
IPConfigObject
DiagnosticObject
TagObject
LockObject

Virtual Network

AttributeTypeMandatoryValuesDefaultNotes
NameStringYes
SubnetNameStringYes
ResourceGroupNameStringNoDefaults to RG of resource

IPConfig

AttributeTypeMandatoryValuesDefaultNotes
NameStringYes
PublicIPNameStringNo
LoadBalancerObjectNo

IPConfig LoadBalancer

AttributeTypeMandatoryValuesDefaultNotes
NameStringYes
ResourceGroupNameStringNoDefaults to RG of resource
BackendPoolStringYes

Diagnostic

AttributeTypeMandatoryValuesDefaultNotes
NameStringYes
MetricObjectNo
Target ObjectNo

Diagnostic Metric

AttributeTypeMandatoryValuesDefaultNotes
EnabledBooleanNoDefaults to true if Category is not null
CategoryArrayNoAllMetrics

Input by YAML

Object model for YAML deployment:

azNetworkInterface:
# Mandatory
- Name: 'string'
ResourceGroupName: 'string'
Location: 'string'
VirtualNetwork:
Name: 'string'
SubnetName: 'string'
# Optional
ResourceGroupName: 'string' # Defaults to RG of resource
IPConfig:
- Name: 'string'
PublicIPName: 'string'
LoadBalancer:
Name: 'string'
ResourceGroupName: 'string' # Defaults to RG of resource
BackendPool: 'string'
NSGName: 'string'
EnableAcceleratedNetworking: boolean # True, False(D)
Diagnostic:
- Name: 'string'
Metric:
Enabled: boolean # True (D if MetricCategory not null), False
Category: [array] # Defaults to all if enabled
Target:
Blob:
StorageAccount: 'string'
ResourceGroupName: 'string' # Defaults to RG of resource
Subscription: 'string' # Defaults to Sub of resource
StorageKeyType: 'string' # Primary, Secondary
RetentionInDays: number
EventHub:
Name: 'string'
Namespace: 'string'
ResourceGroupName: 'string' # Defaults to RG of resource
Subscription: 'string' # Defaults to Sub of resource
SharedAccessPolicy: 'string' # RootManageSharedAccessKey (D)
LogAnalytics:
Workspace: 'string'
ResourceGroupName: 'string' # Defaults to RG of resource
Subscription: 'string' # Defaults to Sub of resource
Tag:
'keyvalue-pairs'
Lock:
- Name: 'string'
Level: 'string' # CanNotDelete, ReadOnly
Notes: 'string'

Input by JSON

Object model for JSON deployment:

{
"azNetworkInterface": [
{
"Name": "string",
"ResourceGroupName": "string",
"Location": "string",
"VirtualNetwork": [
{
"Name": "string",
"SubnetName": "string",
"ResourceGroupName": "string"
}
],
"IPConfig": [
{
"Name": "string",
"PublicIPName": "string"
}
],
"NSGName": "string",
"EnableAcceleratedNetworking": boolean,
"Diagnostic": [
{
"Name": "string",
"Metric": {
"Enabled": boolean,
"Category": [array]
},
"Target": {
"Blob": {
"StorageAccount": "string",
"ResourceGroupName": "string",
"Subscription": "string",
"StorageKeyType": "string",
"RetentionInDays": number
},
"EventHub": {
"Name": "string",
"Namespace": "string",
"ResourceGroupName": "string",
"Subscription": "string",
"SharedAccessPolicy": "string"
},
"LogAnalytics": {
"Workspace": "string",
"ResourceGroupName": "string",
"Subscription": "string"
}
}
}
],
"Tag": {
"key": "value"
},
"Lock": [
{
"Name": "string",
"Level": "string",
"Notes": "string"
}
]
}
]
}