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 networkFunctions 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.HybridNetwork/networkFunctions resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.HybridNetwork/networkFunctions@2024-04-15' = {
etag: 'string'
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
location: 'string'
name: 'string'
properties: {
allowSoftwareUpdate: bool
networkFunctionDefinitionGroupName: 'string'
networkFunctionDefinitionOfferingLocation: 'string'
networkFunctionDefinitionVersion: 'string'
networkFunctionDefinitionVersionResourceReference: {
idType: 'string'
// For remaining properties, see DeploymentResourceIdReference objects
}
nfviId: 'string'
nfviType: 'string'
publisherName: 'string'
publisherScope: 'string'
roleOverrideValues: [
'string'
]
configurationType: 'string'
// For remaining properties, see NetworkFunctionPropertiesFormat objects
}
tags: {
{customized property}: 'string'
}
}
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:
{
id: 'string'
idType: 'Open'
}
For Secret, use:
{
id: 'string'
idType: 'Secret'
}
Property Values
Microsoft.HybridNetwork/networkFunctions
| Name | Description | Value |
|---|---|---|
| etag | A unique read-only string that changes whenever the resource is updated. | string |
| identity | The managed identity of the network function. | ManagedServiceIdentity |
| 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 |
DeploymentResourceIdReference
| Name | Description | Value |
|---|---|---|
| idType | Set to 'Open' for type OpenDeploymentResourceReference. Set to 'Secret' for type SecretDeploymentResourceReference. | 'Open' 'Secret' (required) |
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 |
NetworkFunctionPropertiesFormat
| Name | Description | Value |
|---|---|---|
| allowSoftwareUpdate | Indicates if software updates are allowed during deployment. | bool |
| configurationType | Set to 'Open' for type NetworkFunctionValueWithoutSecrets. Set to 'Secret' for type NetworkFunctionValueWithSecrets. | 'Open' 'Secret' (required) |
| networkFunctionDefinitionGroupName | The network function definition group name for the network function. | string |
| networkFunctionDefinitionOfferingLocation | The location of the network function definition offering. | string |
| networkFunctionDefinitionVersion | The network function definition version for the network function. | string |
| 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' |
| publisherName | The publisher name for the network function. | string |
| publisherScope | The scope of the publisher. | 'Private' 'Unknown' |
| roleOverrideValues | The role configuration override values from the user. | string[] |
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. |
OpenDeploymentResourceReference
| Name | Description | Value |
|---|---|---|
| id | Resource ID. | string |
| idType | The resource reference arm id type. | 'Open' (required) |
SecretDeploymentResourceReference
| Name | Description | Value |
|---|---|---|
| id | Resource ID. | string Constraints: Sensitive value. Pass in as a secure parameter. |
| idType | The resource reference arm id type. | 'Secret' (required) |
TrackedResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentities
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|
ARM template resource definition
The networkFunctions 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.
Usage Examples
Resource format
To create a Microsoft.HybridNetwork/networkFunctions resource, add the following JSON to your template.
{
"type": "Microsoft.HybridNetwork/networkFunctions",
"apiVersion": "2024-04-15",
"name": "string",
"etag": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"location": "string",
"properties": {
"allowSoftwareUpdate": "bool",
"networkFunctionDefinitionGroupName": "string",
"networkFunctionDefinitionOfferingLocation": "string",
"networkFunctionDefinitionVersion": "string",
"networkFunctionDefinitionVersionResourceReference": {
"idType": "string"
// For remaining properties, see DeploymentResourceIdReference objects
},
"nfviId": "string",
"nfviType": "string",
"publisherName": "string",
"publisherScope": "string",
"roleOverrideValues": [ "string" ],
"configurationType": "string"
// For remaining properties, see NetworkFunctionPropertiesFormat objects
},
"tags": {
"{customized property}": "string"
}
}
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:
{
"id": "string",
"idType": "Open"
}
For Secret, use:
{
"id": "string",
"idType": "Secret"
}
Property Values
Microsoft.HybridNetwork/networkFunctions
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2024-04-15' |
| etag | A unique read-only string that changes whenever the resource is updated. | string |
| identity | The managed identity of the network function. | ManagedServiceIdentity |
| 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' |
DeploymentResourceIdReference
| Name | Description | Value |
|---|---|---|
| idType | Set to 'Open' for type OpenDeploymentResourceReference. Set to 'Secret' for type SecretDeploymentResourceReference. | 'Open' 'Secret' (required) |
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 |
NetworkFunctionPropertiesFormat
| Name | Description | Value |
|---|---|---|
| allowSoftwareUpdate | Indicates if software updates are allowed during deployment. | bool |
| configurationType | Set to 'Open' for type NetworkFunctionValueWithoutSecrets. Set to 'Secret' for type NetworkFunctionValueWithSecrets. | 'Open' 'Secret' (required) |
| networkFunctionDefinitionGroupName | The network function definition group name for the network function. | string |
| networkFunctionDefinitionOfferingLocation | The location of the network function definition offering. | string |
| networkFunctionDefinitionVersion | The network function definition version for the network function. | string |
| 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' |
| publisherName | The publisher name for the network function. | string |
| publisherScope | The scope of the publisher. | 'Private' 'Unknown' |
| roleOverrideValues | The role configuration override values from the user. | string[] |
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. |
OpenDeploymentResourceReference
| Name | Description | Value |
|---|---|---|
| id | Resource ID. | string |
| idType | The resource reference arm id type. | 'Open' (required) |
SecretDeploymentResourceReference
| Name | Description | Value |
|---|---|---|
| id | Resource ID. | string Constraints: Sensitive value. Pass in as a secure parameter. |
| idType | The resource reference arm id type. | 'Secret' (required) |
TrackedResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentities
| Name | Description | Value |
|---|
UserAssignedIdentity
| 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@2024-04-15"
name = "string"
parent_id = "string"
identity {
type = "string"
identity_ids = [
"string"
]
}
location = "string"
tags = {
{customized property} = "string"
}
body = {
etag = "string"
properties = {
allowSoftwareUpdate = bool
networkFunctionDefinitionGroupName = "string"
networkFunctionDefinitionOfferingLocation = "string"
networkFunctionDefinitionVersion = "string"
networkFunctionDefinitionVersionResourceReference = {
idType = "string"
// For remaining properties, see DeploymentResourceIdReference objects
}
nfviId = "string"
nfviType = "string"
publisherName = "string"
publisherScope = "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:
{
id = "string"
idType = "Open"
}
For Secret, use:
{
id = "string"
idType = "Secret"
}
Property Values
Microsoft.HybridNetwork/networkFunctions
| Name | Description | Value |
|---|---|---|
| etag | A unique read-only string that changes whenever the resource is updated. | string |
| identity | The managed identity of the network function. | ManagedServiceIdentity |
| 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@2024-04-15" |
DeploymentResourceIdReference
| Name | Description | Value |
|---|---|---|
| idType | Set to 'Open' for type OpenDeploymentResourceReference. Set to 'Secret' for type SecretDeploymentResourceReference. | 'Open' 'Secret' (required) |
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 |
NetworkFunctionPropertiesFormat
| Name | Description | Value |
|---|---|---|
| allowSoftwareUpdate | Indicates if software updates are allowed during deployment. | bool |
| configurationType | Set to 'Open' for type NetworkFunctionValueWithoutSecrets. Set to 'Secret' for type NetworkFunctionValueWithSecrets. | 'Open' 'Secret' (required) |
| networkFunctionDefinitionGroupName | The network function definition group name for the network function. | string |
| networkFunctionDefinitionOfferingLocation | The location of the network function definition offering. | string |
| networkFunctionDefinitionVersion | The network function definition version for the network function. | string |
| 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' |
| publisherName | The publisher name for the network function. | string |
| publisherScope | The scope of the publisher. | 'Private' 'Unknown' |
| roleOverrideValues | The role configuration override values from the user. | string[] |
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. |
OpenDeploymentResourceReference
| Name | Description | Value |
|---|---|---|
| id | Resource ID. | string |
| idType | The resource reference arm id type. | 'Open' (required) |
SecretDeploymentResourceReference
| Name | Description | Value |
|---|---|---|
| id | Resource ID. | string Constraints: Sensitive value. Pass in as a secure parameter. |
| idType | The resource reference arm id type. | 'Secret' (required) |
TrackedResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentities
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|