Microsoft.HybridNetwork networkFunctions 2021-05-01

Bicep resource definition

The networkFunctions resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.HybridNetwork/networkFunctions resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.HybridNetwork/networkFunctions@2021-05-01' = {
  etag: 'string'
  location: 'string'
  name: 'string'
  properties: {
    device: {
      id: 'string'
    }
    managedApplicationParameters: any(...)
    networkFunctionContainerConfigurations: any(...)
    networkFunctionUserConfigurations: [
      {
        networkInterfaces: [
          {
            ipConfigurations: [
              {
                dnsServers: [
                  'string'
                ]
                gateway: 'string'
                ipAddress: 'string'
                ipAllocationMethod: 'string'
                ipVersion: 'string'
                subnet: 'string'
              }
            ]
            macAddress: 'string'
            networkInterfaceName: 'string'
            vmSwitchType: 'string'
          }
        ]
        osProfile: {
          customData: 'string'
        }
        roleName: 'string'
        userDataParameters: any(...)
      }
    ]
    skuName: 'string'
    vendorName: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.HybridNetwork/networkFunctions

Name Description Value
etag A unique read-only string that changes whenever the resource is updated. string
location The geo-location where the resource lives string (required)
name The resource name string (required)
properties Network function properties. NetworkFunctionPropertiesFormat
tags Resource tags Dictionary of tag names and values. See Tags in templates

NetworkFunctionPropertiesFormat

Name Description Value
device The reference to the device resource. Once set, it cannot be updated. SubResource
managedApplicationParameters The parameters for the managed application. any
networkFunctionContainerConfigurations The network function container configurations from the user. any
networkFunctionUserConfigurations The network function configurations from the user. NetworkFunctionUserConfiguration[]
skuName The sku name for the network function. Once set, it cannot be updated. string
vendorName The vendor name for the network function. Once set, it cannot be updated. string

NetworkFunctionUserConfiguration

Name Description Value
networkInterfaces The network interface configuration. NetworkInterface[]
osProfile Specifies the operating system settings for the role instance. NetworkFunctionUserConfigurationOsProfile
roleName The name of the network function role. string
userDataParameters The user data parameters from the customer. any

NetworkFunctionUserConfigurationOsProfile

Name Description Value
customData Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the virtual machine. The maximum length of the binary array is 65535 bytes.

Note: Do not pass any secrets or passwords in customData property

This property cannot be updated after the VM is created.

customData is passed to the VM to be saved as a file. For more information see Custom Data on Azure VMs

For using cloud-init for your Linux VM, see Using cloud-init to customize a Linux VM during creation
string

NetworkInterface

Name Description Value
ipConfigurations A list of IP configurations of the network interface. NetworkInterfaceIPConfiguration[]
macAddress The MAC address of the network interface. string
networkInterfaceName The name of the network interface. string
vmSwitchType The type of the VM switch. 'Lan'
'Management'
'Unknown'
'Wan'

NetworkInterfaceIPConfiguration

Name Description Value
dnsServers The list of DNS servers IP addresses. string[]
gateway The value of the gateway. string
ipAddress The value of the IP address. string
ipAllocationMethod IP address allocation method. 'Dynamic'
'Static'
'Unknown'
ipVersion IP address version. 'IPv4'
'Unknown'
subnet The value of the subnet. string

SubResource

Name Description Value
id Resource ID. string

TrackedResourceTags

Name Description Value

ARM template resource definition

The networkFunctions resource type can be deployed with operations that target:

Usage Examples

Resource format

To create a Microsoft.HybridNetwork/networkFunctions resource, add the following JSON to your template.

{
  "type": "Microsoft.HybridNetwork/networkFunctions",
  "apiVersion": "2021-05-01",
  "name": "string",
  "etag": "string",
  "location": "string",
  "properties": {
    "device": {
      "id": "string"
    },
    "managedApplicationParameters": {},
    "networkFunctionContainerConfigurations": {},
    "networkFunctionUserConfigurations": [
      {
        "networkInterfaces": [
          {
            "ipConfigurations": [
              {
                "dnsServers": [ "string" ],
                "gateway": "string",
                "ipAddress": "string",
                "ipAllocationMethod": "string",
                "ipVersion": "string",
                "subnet": "string"
              }
            ],
            "macAddress": "string",
            "networkInterfaceName": "string",
            "vmSwitchType": "string"
          }
        ],
        "osProfile": {
          "customData": "string"
        },
        "roleName": "string",
        "userDataParameters": {}
      }
    ],
    "skuName": "string",
    "vendorName": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.HybridNetwork/networkFunctions

Name Description Value
apiVersion The api version '2021-05-01'
etag A unique read-only string that changes whenever the resource is updated. string
location The geo-location where the resource lives string (required)
name The resource name string (required)
properties Network function properties. NetworkFunctionPropertiesFormat
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.HybridNetwork/networkFunctions'

NetworkFunctionPropertiesFormat

Name Description Value
device The reference to the device resource. Once set, it cannot be updated. SubResource
managedApplicationParameters The parameters for the managed application. any
networkFunctionContainerConfigurations The network function container configurations from the user. any
networkFunctionUserConfigurations The network function configurations from the user. NetworkFunctionUserConfiguration[]
skuName The sku name for the network function. Once set, it cannot be updated. string
vendorName The vendor name for the network function. Once set, it cannot be updated. string

NetworkFunctionUserConfiguration

Name Description Value
networkInterfaces The network interface configuration. NetworkInterface[]
osProfile Specifies the operating system settings for the role instance. NetworkFunctionUserConfigurationOsProfile
roleName The name of the network function role. string
userDataParameters The user data parameters from the customer. any

NetworkFunctionUserConfigurationOsProfile

Name Description Value
customData Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the virtual machine. The maximum length of the binary array is 65535 bytes.

Note: Do not pass any secrets or passwords in customData property

This property cannot be updated after the VM is created.

customData is passed to the VM to be saved as a file. For more information see Custom Data on Azure VMs

For using cloud-init for your Linux VM, see Using cloud-init to customize a Linux VM during creation
string

NetworkInterface

Name Description Value
ipConfigurations A list of IP configurations of the network interface. NetworkInterfaceIPConfiguration[]
macAddress The MAC address of the network interface. string
networkInterfaceName The name of the network interface. string
vmSwitchType The type of the VM switch. 'Lan'
'Management'
'Unknown'
'Wan'

NetworkInterfaceIPConfiguration

Name Description Value
dnsServers The list of DNS servers IP addresses. string[]
gateway The value of the gateway. string
ipAddress The value of the IP address. string
ipAllocationMethod IP address allocation method. 'Dynamic'
'Static'
'Unknown'
ipVersion IP address version. 'IPv4'
'Unknown'
subnet The value of the subnet. string

SubResource

Name Description Value
id Resource ID. string

TrackedResourceTags

Name Description Value

Terraform (AzAPI provider) resource definition

The networkFunctions 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.HybridNetwork/networkFunctions resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.HybridNetwork/networkFunctions@2021-05-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    etag = "string"
    properties = {
      device = {
        id = "string"
      }
      managedApplicationParameters = ?
      networkFunctionContainerConfigurations = ?
      networkFunctionUserConfigurations = [
        {
          networkInterfaces = [
            {
              ipConfigurations = [
                {
                  dnsServers = [
                    "string"
                  ]
                  gateway = "string"
                  ipAddress = "string"
                  ipAllocationMethod = "string"
                  ipVersion = "string"
                  subnet = "string"
                }
              ]
              macAddress = "string"
              networkInterfaceName = "string"
              vmSwitchType = "string"
            }
          ]
          osProfile = {
            customData = "string"
          }
          roleName = "string"
          userDataParameters = ?
        }
      ]
      skuName = "string"
      vendorName = "string"
    }
  }
}

Property Values

Microsoft.HybridNetwork/networkFunctions

Name Description Value
etag A unique read-only string that changes whenever the resource is updated. string
location The geo-location where the resource lives string (required)
name The resource name string (required)
properties Network function properties. NetworkFunctionPropertiesFormat
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.HybridNetwork/networkFunctions@2021-05-01"

NetworkFunctionPropertiesFormat

Name Description Value
device The reference to the device resource. Once set, it cannot be updated. SubResource
managedApplicationParameters The parameters for the managed application. any
networkFunctionContainerConfigurations The network function container configurations from the user. any
networkFunctionUserConfigurations The network function configurations from the user. NetworkFunctionUserConfiguration[]
skuName The sku name for the network function. Once set, it cannot be updated. string
vendorName The vendor name for the network function. Once set, it cannot be updated. string

NetworkFunctionUserConfiguration

Name Description Value
networkInterfaces The network interface configuration. NetworkInterface[]
osProfile Specifies the operating system settings for the role instance. NetworkFunctionUserConfigurationOsProfile
roleName The name of the network function role. string
userDataParameters The user data parameters from the customer. any

NetworkFunctionUserConfigurationOsProfile

Name Description Value
customData Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the virtual machine. The maximum length of the binary array is 65535 bytes.

Note: Do not pass any secrets or passwords in customData property

This property cannot be updated after the VM is created.

customData is passed to the VM to be saved as a file. For more information see Custom Data on Azure VMs

For using cloud-init for your Linux VM, see Using cloud-init to customize a Linux VM during creation
string

NetworkInterface

Name Description Value
ipConfigurations A list of IP configurations of the network interface. NetworkInterfaceIPConfiguration[]
macAddress The MAC address of the network interface. string
networkInterfaceName The name of the network interface. string
vmSwitchType The type of the VM switch. 'Lan'
'Management'
'Unknown'
'Wan'

NetworkInterfaceIPConfiguration

Name Description Value
dnsServers The list of DNS servers IP addresses. string[]
gateway The value of the gateway. string
ipAddress The value of the IP address. string
ipAllocationMethod IP address allocation method. 'Dynamic'
'Static'
'Unknown'
ipVersion IP address version. 'IPv4'
'Unknown'
subnet The value of the subnet. string

SubResource

Name Description Value
id Resource ID. string

TrackedResourceTags

Name Description Value