Microsoft.HybridNetwork networkFunctions

ARM template 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 JSON to your template.

{
  "type": "Microsoft.HybridNetwork/networkFunctions",
  "apiVersion": "2023-09-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "etag": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "properties": {
    "allowSoftwareUpdate": "bool",
    "networkFunctionDefinitionVersionResourceReference": {
      "idType": "string"
      // For remaining properties, see DeploymentResourceIdReference objects
    },
    "nfviId": "string",
    "nfviType": "string",
    "roleOverrideValues": [ "string" ],
    "configurationType": "string"
    // For remaining properties, see NetworkFunctionPropertiesFormat objects
  }
}

NetworkFunctionPropertiesFormat objects

Set the configurationType property to specify the type of object.

For Open, use:

  "configurationType": "Open",
  "deploymentValues": "string"

For Secret, use:

  "configurationType": "Secret",
  "secretDeploymentValues": "string"

DeploymentResourceIdReference objects

Set the idType property to specify the type of object.

For Open, use:

  "idType": "Open",
  "id": "string"

For Secret, use:

  "idType": "Secret",
  "id": "string"

Property values

networkFunctions

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

ManagedServiceIdentity

Name Description Value
type Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned' (required)
userAssignedIdentities The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. UserAssignedIdentities

UserAssignedIdentities

Name Description Value
{customized property} UserAssignedIdentity

UserAssignedIdentity

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

NetworkFunctionPropertiesFormat

Name Description Value
allowSoftwareUpdate Indicates if software updates are allowed during deployment. bool
networkFunctionDefinitionVersionResourceReference The network function definition version resource reference. DeploymentResourceIdReference
nfviId The nfviId for the network function. string
nfviType The nfvi type for the network function. 'AzureArcKubernetes'
'AzureCore'
'AzureOperatorNexus'
'Unknown'
roleOverrideValues The role configuration override values from the user. string[]
configurationType Set the object type Open
Secret (required)

DeploymentResourceIdReference

Name Description Value
idType Set the object type Open
Secret (required)

OpenDeploymentResourceReference

Name Description Value
idType The resource reference arm id type. 'Open' (required)
id Resource ID. string

SecretDeploymentResourceReference

Name Description Value
idType The resource reference arm id type. 'Secret' (required)
id Resource ID. string

Constraints:
Sensitive value. Pass in as a secure parameter.

NetworkFunctionValueWithoutSecrets

Name Description Value
configurationType The value which indicates if NF values are secrets 'Open' (required)
deploymentValues The JSON-serialized deployment values from the user. string

NetworkFunctionValueWithSecrets

Name Description Value
configurationType The value which indicates if NF values are secrets 'Secret' (required)
secretDeploymentValues The JSON-serialized secret deployment values from the user. This contains secrets like passwords,keys etc string

Constraints:
Sensitive value. Pass in as a secure parameter.