Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The networkinterfaces resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.AzureStackHCI/networkinterfaces resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.AzureStackHCI/networkinterfaces@2021-09-01-preview' = {
extendedLocation: {
name: 'string'
type: 'string'
}
location: 'string'
name: 'string'
properties: {
dnsSettings: {
dnsServers: [
'string'
]
}
ipConfigurations: [
{
name: 'string'
properties: {
gateway: 'string'
prefixLength: 'string'
privateIPAddress: 'string'
privateIPAllocationMethod: 'string'
subnet: {
id: 'string'
}
}
}
]
macAddress: 'string'
resourceName: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.AzureStackHCI/networkinterfaces
| Name | Description | Value |
|---|---|---|
| extendedLocation | The extendedLocation of the resource. | ExtendedLocation |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Min length = 3 Max length = 64 (required) |
| properties | Properties of a network interface resource | NetworkinterfacesProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
ExtendedLocation
| Name | Description | Value |
|---|---|---|
| name | The name of the extended location. | string |
| type | The type of the extended location. | 'CustomLocation' |
InterfaceDNSSettings
| Name | Description | Value |
|---|---|---|
| dnsServers | List of DNS server IP Addresses for the interface | string[] |
IpConfiguration
| Name | Description | Value |
|---|---|---|
| name | Name - The name of the resource that is unique within a resource group. This name can be used to access the resource. | string |
| properties | InterfaceIPConfigurationPropertiesFormat properties of IP configuration. | IpConfigurationProperties |
IpConfigurationProperties
| Name | Description | Value |
|---|---|---|
| gateway | Gateway for network interface | string |
| prefixLength | prefixLength for network interface | string |
| privateIPAddress | PrivateIPAddress - Private IP address of the IP configuration. | string |
| privateIPAllocationMethod | PrivateIPAllocationMethod - The private IP address allocation method. Possible values include: 'Static', 'Dynamic' | 'Dynamic' 'Static' |
| subnet | Subnet - Name of Subnet bound to the IP configuration. | IpConfigurationPropertiesSubnet |
IpConfigurationPropertiesSubnet
| Name | Description | Value |
|---|---|---|
| id | ID - The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... | string |
NetworkinterfacesProperties
| Name | Description | Value |
|---|---|---|
| dnsSettings | DNS Settings for the interface | InterfaceDNSSettings |
| ipConfigurations | IPConfigurations - A list of IPConfigurations of the network interface. | IpConfiguration[] |
| macAddress | MacAddress - The MAC address of the network interface. | string |
| resourceName | name of the object to be used in moc | string |
TrackedResourceTags
| Name | Description | Value |
|---|
Usage Examples
Azure Verified Modules
The following Azure Verified Modules can be used to deploy this resource type.
| Module | Description |
|---|---|
| Azure Stack HCI Network Interface | AVM Resource Module for Azure Stack HCI Network Interface |
Azure Quickstart Samples
The following Azure Quickstart templates contain Bicep samples for deploying this resource type.
| Bicep File | Description |
|---|---|
| Create a Linux VM from a gallery image on Azure Stack HCI | This template creates a simple Linux VM from the referenced custom image on Azure Stack HCI version 23H2+ |
| Create a VM from the referenced image on Azure Stack HCI | This template creates a simple Windows VM from the referenced Azure Marketplace image on Azure Stack HCI version 23H2+ |
ARM template resource definition
The networkinterfaces resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.AzureStackHCI/networkinterfaces resource, add the following JSON to your template.
{
"type": "Microsoft.AzureStackHCI/networkinterfaces",
"apiVersion": "2021-09-01-preview",
"name": "string",
"extendedLocation": {
"name": "string",
"type": "string"
},
"location": "string",
"properties": {
"dnsSettings": {
"dnsServers": [ "string" ]
},
"ipConfigurations": [
{
"name": "string",
"properties": {
"gateway": "string",
"prefixLength": "string",
"privateIPAddress": "string",
"privateIPAllocationMethod": "string",
"subnet": {
"id": "string"
}
}
}
],
"macAddress": "string",
"resourceName": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.AzureStackHCI/networkinterfaces
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2021-09-01-preview' |
| extendedLocation | The extendedLocation of the resource. | ExtendedLocation |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Min length = 3 Max length = 64 (required) |
| properties | Properties of a network interface resource | NetworkinterfacesProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.AzureStackHCI/networkinterfaces' |
ExtendedLocation
| Name | Description | Value |
|---|---|---|
| name | The name of the extended location. | string |
| type | The type of the extended location. | 'CustomLocation' |
InterfaceDNSSettings
| Name | Description | Value |
|---|---|---|
| dnsServers | List of DNS server IP Addresses for the interface | string[] |
IpConfiguration
| Name | Description | Value |
|---|---|---|
| name | Name - The name of the resource that is unique within a resource group. This name can be used to access the resource. | string |
| properties | InterfaceIPConfigurationPropertiesFormat properties of IP configuration. | IpConfigurationProperties |
IpConfigurationProperties
| Name | Description | Value |
|---|---|---|
| gateway | Gateway for network interface | string |
| prefixLength | prefixLength for network interface | string |
| privateIPAddress | PrivateIPAddress - Private IP address of the IP configuration. | string |
| privateIPAllocationMethod | PrivateIPAllocationMethod - The private IP address allocation method. Possible values include: 'Static', 'Dynamic' | 'Dynamic' 'Static' |
| subnet | Subnet - Name of Subnet bound to the IP configuration. | IpConfigurationPropertiesSubnet |
IpConfigurationPropertiesSubnet
| Name | Description | Value |
|---|---|---|
| id | ID - The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... | string |
NetworkinterfacesProperties
| Name | Description | Value |
|---|---|---|
| dnsSettings | DNS Settings for the interface | InterfaceDNSSettings |
| ipConfigurations | IPConfigurations - A list of IPConfigurations of the network interface. | IpConfiguration[] |
| macAddress | MacAddress - The MAC address of the network interface. | string |
| resourceName | name of the object to be used in moc | string |
TrackedResourceTags
| Name | Description | Value |
|---|
Usage Examples
Azure Quickstart Templates
The following Azure Quickstart templates deploy this resource type.
| Template | Description |
|---|---|
Create a Linux VM from a gallery image on Azure Stack HCI |
This template creates a simple Linux VM from the referenced custom image on Azure Stack HCI version 23H2+ |
| Create a VM from the referenced image on Azure Stack HCI |
This template creates a simple Windows VM from the referenced Azure Marketplace image on Azure Stack HCI version 23H2+ |
Terraform (AzAPI provider) resource definition
The networkinterfaces resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.AzureStackHCI/networkinterfaces resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.AzureStackHCI/networkinterfaces@2021-09-01-preview"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
extendedLocation = {
name = "string"
type = "string"
}
properties = {
dnsSettings = {
dnsServers = [
"string"
]
}
ipConfigurations = [
{
name = "string"
properties = {
gateway = "string"
prefixLength = "string"
privateIPAddress = "string"
privateIPAllocationMethod = "string"
subnet = {
id = "string"
}
}
}
]
macAddress = "string"
resourceName = "string"
}
}
}
Property Values
Microsoft.AzureStackHCI/networkinterfaces
| Name | Description | Value |
|---|---|---|
| extendedLocation | The extendedLocation of the resource. | ExtendedLocation |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Min length = 3 Max length = 64 (required) |
| properties | Properties of a network interface resource | NetworkinterfacesProperties |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.AzureStackHCI/networkinterfaces@2021-09-01-preview" |
ExtendedLocation
| Name | Description | Value |
|---|---|---|
| name | The name of the extended location. | string |
| type | The type of the extended location. | 'CustomLocation' |
InterfaceDNSSettings
| Name | Description | Value |
|---|---|---|
| dnsServers | List of DNS server IP Addresses for the interface | string[] |
IpConfiguration
| Name | Description | Value |
|---|---|---|
| name | Name - The name of the resource that is unique within a resource group. This name can be used to access the resource. | string |
| properties | InterfaceIPConfigurationPropertiesFormat properties of IP configuration. | IpConfigurationProperties |
IpConfigurationProperties
| Name | Description | Value |
|---|---|---|
| gateway | Gateway for network interface | string |
| prefixLength | prefixLength for network interface | string |
| privateIPAddress | PrivateIPAddress - Private IP address of the IP configuration. | string |
| privateIPAllocationMethod | PrivateIPAllocationMethod - The private IP address allocation method. Possible values include: 'Static', 'Dynamic' | 'Dynamic' 'Static' |
| subnet | Subnet - Name of Subnet bound to the IP configuration. | IpConfigurationPropertiesSubnet |
IpConfigurationPropertiesSubnet
| Name | Description | Value |
|---|---|---|
| id | ID - The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... | string |
NetworkinterfacesProperties
| Name | Description | Value |
|---|---|---|
| dnsSettings | DNS Settings for the interface | InterfaceDNSSettings |
| ipConfigurations | IPConfigurations - A list of IPConfigurations of the network interface. | IpConfiguration[] |
| macAddress | MacAddress - The MAC address of the network interface. | string |
| resourceName | name of the object to be used in moc | string |
TrackedResourceTags
| Name | Description | Value |
|---|