Microsoft.HybridNetwork publishers/networkFunctionDefinitionGroups/networkFunctionDefinitionVersions

Bicep resource definition

The publishers/networkFunctionDefinitionGroups/networkFunctionDefinitionVersions 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/publishers/networkFunctionDefinitionGroups/networkFunctionDefinitionVersions resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.HybridNetwork/publishers/networkFunctionDefinitionGroups/networkFunctionDefinitionVersions@2024-04-15' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    deployParameters: 'string'
    description: 'string'
    networkFunctionType: 'string'
    // For remaining properties, see NetworkFunctionDefinitionVersionPropertiesFormat objects
  }
  tags: {
    {customized property}: 'string'
  }
}

AzureCoreNetworkFunctionApplication objects

Set the artifactType property to specify the type of object.

For ArmTemplate, use:

{
  artifactProfile: {
    artifactStore: {
      id: 'string'
    }
    templateArtifactProfile: {
      templateName: 'string'
      templateVersion: 'string'
    }
  }
  artifactType: 'ArmTemplate'
  deployParametersMappingRuleProfile: {
    applicationEnablement: 'string'
    templateMappingRuleProfile: {
      templateParameters: 'string'
    }
  }
}

For VhdImageFile, use:

{
  artifactProfile: {
    artifactStore: {
      id: 'string'
    }
    vhdArtifactProfile: {
      vhdName: 'string'
      vhdVersion: 'string'
    }
  }
  artifactType: 'VhdImageFile'
  deployParametersMappingRuleProfile: {
    applicationEnablement: 'string'
    vhdImageMappingRuleProfile: {
      userConfiguration: 'string'
    }
  }
}

NetworkFunctionDefinitionVersionPropertiesFormat objects

Set the networkFunctionType property to specify the type of object.

For ContainerizedNetworkFunction, use:

{
  networkFunctionTemplate: {
    nfviType: 'string'
    // For remaining properties, see ContainerizedNetworkFunctionTemplate objects
  }
  networkFunctionType: 'ContainerizedNetworkFunction'
}

For VirtualNetworkFunction, use:

{
  networkFunctionTemplate: {
    nfviType: 'string'
    // For remaining properties, see VirtualNetworkFunctionTemplate objects
  }
  networkFunctionType: 'VirtualNetworkFunction'
}

VirtualNetworkFunctionTemplate objects

Set the nfviType property to specify the type of object.

For AzureCore, use:

{
  networkFunctionApplications: [
    {
      dependsOnProfile: {
        installDependsOn: [
          'string'
        ]
        uninstallDependsOn: [
          'string'
        ]
        updateDependsOn: [
          'string'
        ]
      }
      name: 'string'
      artifactType: 'string'
      // For remaining properties, see AzureCoreNetworkFunctionApplication objects
    }
  ]
  nfviType: 'AzureCore'
}

For AzureOperatorNexus, use:

{
  networkFunctionApplications: [
    {
      dependsOnProfile: {
        installDependsOn: [
          'string'
        ]
        uninstallDependsOn: [
          'string'
        ]
        updateDependsOn: [
          'string'
        ]
      }
      name: 'string'
      artifactType: 'string'
      // For remaining properties, see AzureOperatorNexusNetworkFunctionApplication objects
    }
  ]
  nfviType: 'AzureOperatorNexus'
}

ContainerizedNetworkFunctionTemplate objects

Set the nfviType property to specify the type of object.

For AzureArcKubernetes, use:

{
  networkFunctionApplications: [
    {
      dependsOnProfile: {
        installDependsOn: [
          'string'
        ]
        uninstallDependsOn: [
          'string'
        ]
        updateDependsOn: [
          'string'
        ]
      }
      name: 'string'
      artifactType: 'string'
      // For remaining properties, see AzureArcKubernetesNetworkFunctionApplication objects
    }
  ]
  nfviType: 'AzureArcKubernetes'
}

AzureOperatorNexusNetworkFunctionApplication objects

Set the artifactType property to specify the type of object.

For ArmTemplate, use:

{
  artifactProfile: {
    artifactStore: {
      id: 'string'
    }
    templateArtifactProfile: {
      templateName: 'string'
      templateVersion: 'string'
    }
  }
  artifactType: 'ArmTemplate'
  deployParametersMappingRuleProfile: {
    applicationEnablement: 'string'
    templateMappingRuleProfile: {
      templateParameters: 'string'
    }
  }
}

For ImageFile, use:

{
  artifactProfile: {
    artifactStore: {
      id: 'string'
    }
    imageArtifactProfile: {
      imageName: 'string'
      imageVersion: 'string'
    }
  }
  artifactType: 'ImageFile'
  deployParametersMappingRuleProfile: {
    applicationEnablement: 'string'
    imageMappingRuleProfile: {
      userConfiguration: 'string'
    }
  }
}

AzureArcKubernetesNetworkFunctionApplication objects

Set the artifactType property to specify the type of object.

For HelmPackage, use:

{
  artifactProfile: {
    artifactStore: {
      id: 'string'
    }
    helmArtifactProfile: {
      helmPackageName: 'string'
      helmPackageVersionRange: 'string'
      imagePullSecretsValuesPaths: [
        'string'
      ]
      registryValuesPaths: [
        'string'
      ]
    }
  }
  artifactType: 'HelmPackage'
  deployParametersMappingRuleProfile: {
    applicationEnablement: 'string'
    helmMappingRuleProfile: {
      helmPackageVersion: 'string'
      options: {
        installOptions: {
          atomic: 'string'
          timeout: 'string'
          wait: 'string'
        }
        upgradeOptions: {
          atomic: 'string'
          timeout: 'string'
          wait: 'string'
        }
      }
      releaseName: 'string'
      releaseNamespace: 'string'
      values: 'string'
    }
  }
}

Property Values

Microsoft.HybridNetwork/publishers/networkFunctionDefinitionGroups/networkFunctionDefinitionVersions

Name Description Value
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Max length = 64
Pattern = ^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$ (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.
Symbolic name for resource of type: publishers/networkFunctionDefinitionGroups
properties Network function definition version properties. NetworkFunctionDefinitionVersionPropertiesFormat
tags Resource tags Dictionary of tag names and values. See Tags in templates

ArmTemplateArtifactProfile

Name Description Value
templateName Template name. string
templateVersion Template version. string

ArmTemplateMappingRuleProfile

Name Description Value
templateParameters List of template parameters. string

AzureArcKubernetesArtifactProfile

Name Description Value
artifactStore The reference to artifact store. ReferencedResource
helmArtifactProfile Helm artifact profile. HelmArtifactProfile

AzureArcKubernetesDeployMappingRuleProfile

Name Description Value
applicationEnablement The application enablement. 'Disabled'
'Enabled'
'Unknown'
helmMappingRuleProfile The helm mapping rule profile. HelmMappingRuleProfile

AzureArcKubernetesHelmApplication

Name Description Value
artifactProfile Azure arc kubernetes artifact profile. AzureArcKubernetesArtifactProfile
artifactType The artifact type. 'HelmPackage' (required)
deployParametersMappingRuleProfile Deploy mapping rule profile. AzureArcKubernetesDeployMappingRuleProfile

AzureArcKubernetesNetworkFunctionApplication

Name Description Value
artifactType Set to 'HelmPackage' for type AzureArcKubernetesHelmApplication. 'HelmPackage' (required)
dependsOnProfile Depends on profile definition. DependsOnProfile
name The name of the network function application. string

AzureArcKubernetesNetworkFunctionTemplate

Name Description Value
networkFunctionApplications Network function applications. AzureArcKubernetesNetworkFunctionApplication[]
nfviType The network function type. 'AzureArcKubernetes' (required)

AzureCoreArmTemplateArtifactProfile

Name Description Value
artifactStore The reference to artifact store. ReferencedResource
templateArtifactProfile Template artifact profile. ArmTemplateArtifactProfile

AzureCoreArmTemplateDeployMappingRuleProfile

Name Description Value
applicationEnablement The application enablement. 'Disabled'
'Enabled'
'Unknown'
templateMappingRuleProfile The template mapping rule profile. ArmTemplateMappingRuleProfile

AzureCoreNetworkFunctionApplication

Name Description Value
artifactType Set to 'ArmTemplate' for type AzureCoreNetworkFunctionArmTemplateApplication. Set to 'VhdImageFile' for type AzureCoreNetworkFunctionVhdApplication. 'ArmTemplate'
'VhdImageFile' (required)
dependsOnProfile Depends on profile definition. DependsOnProfile
name The name of the network function application. string

AzureCoreNetworkFunctionArmTemplateApplication

Name Description Value
artifactProfile Azure template artifact profile. AzureCoreArmTemplateArtifactProfile
artifactType The artifact type. 'ArmTemplate' (required)
deployParametersMappingRuleProfile Deploy mapping rule profile. AzureCoreArmTemplateDeployMappingRuleProfile

AzureCoreNetworkFunctionTemplate

Name Description Value
networkFunctionApplications Network function applications. AzureCoreNetworkFunctionApplication[]
nfviType The network function type. 'AzureCore' (required)

AzureCoreNetworkFunctionVhdApplication

Name Description Value
artifactProfile Azure vhd image artifact profile. AzureCoreVhdImageArtifactProfile
artifactType The artifact type. 'VhdImageFile' (required)
deployParametersMappingRuleProfile Deploy mapping rule profile. AzureCoreVhdImageDeployMappingRuleProfile

AzureCoreVhdImageArtifactProfile

Name Description Value
artifactStore The reference to artifact store. ReferencedResource
vhdArtifactProfile Vhd artifact profile. VhdImageArtifactProfile

AzureCoreVhdImageDeployMappingRuleProfile

Name Description Value
applicationEnablement The application enablement. 'Disabled'
'Enabled'
'Unknown'
vhdImageMappingRuleProfile The vhd mapping rule profile. VhdImageMappingRuleProfile

AzureOperatorNexusArmTemplateArtifactProfile

Name Description Value
artifactStore The reference to artifact store. ReferencedResource
templateArtifactProfile Template artifact profile. ArmTemplateArtifactProfile

AzureOperatorNexusArmTemplateDeployMappingRuleProfile

Name Description Value
applicationEnablement The application enablement. 'Disabled'
'Enabled'
'Unknown'
templateMappingRuleProfile The template mapping rule profile. ArmTemplateMappingRuleProfile

AzureOperatorNexusImageArtifactProfile

Name Description Value
artifactStore The reference to artifact store. ReferencedResource
imageArtifactProfile Image artifact profile. ImageArtifactProfile

AzureOperatorNexusImageDeployMappingRuleProfile

Name Description Value
applicationEnablement The application enablement. 'Disabled'
'Enabled'
'Unknown'
imageMappingRuleProfile The vhd mapping rule profile. ImageMappingRuleProfile

AzureOperatorNexusNetworkFunctionApplication

Name Description Value
artifactType Set to 'ArmTemplate' for type AzureOperatorNexusNetworkFunctionArmTemplateApplication. Set to 'ImageFile' for type AzureOperatorNexusNetworkFunctionImageApplication. 'ArmTemplate'
'ImageFile' (required)
dependsOnProfile Depends on profile definition. DependsOnProfile
name The name of the network function application. string

AzureOperatorNexusNetworkFunctionArmTemplateApplication

Name Description Value
artifactProfile Azure Operator Distributed Services Template artifact profile. AzureOperatorNexusArmTemplateArtifactProfile
artifactType The artifact type. 'ArmTemplate' (required)
deployParametersMappingRuleProfile Deploy mapping rule profile. AzureOperatorNexusArmTemplateDeployMappingRuleProfile

AzureOperatorNexusNetworkFunctionImageApplication

Name Description Value
artifactProfile Azure Operator Distributed Services image artifact profile. AzureOperatorNexusImageArtifactProfile
artifactType The artifact type. 'ImageFile' (required)
deployParametersMappingRuleProfile Deploy mapping rule profile. AzureOperatorNexusImageDeployMappingRuleProfile

AzureOperatorNexusNetworkFunctionTemplate

Name Description Value
networkFunctionApplications Network function applications. AzureOperatorNexusNetworkFunctionApplication[]
nfviType The network function type. 'AzureOperatorNexus' (required)

ContainerizedNetworkFunctionDefinitionVersion

Name Description Value
networkFunctionTemplate Containerized network function template. ContainerizedNetworkFunctionTemplate
networkFunctionType The network function type. 'ContainerizedNetworkFunction' (required)

ContainerizedNetworkFunctionTemplate

Name Description Value
nfviType Set to 'AzureArcKubernetes' for type AzureArcKubernetesNetworkFunctionTemplate. 'AzureArcKubernetes' (required)

DependsOnProfile

Name Description Value
installDependsOn Application installation operation dependency. string[]
uninstallDependsOn Application deletion operation dependency. string[]
updateDependsOn Application update operation dependency. string[]

HelmArtifactProfile

Name Description Value
helmPackageName Helm package name. string
helmPackageVersionRange Helm package version range. string
imagePullSecretsValuesPaths The image pull secrets values path list. string[]
registryValuesPaths The registry values path list. string[]

HelmInstallOptions

Name Description Value
atomic The helm deployment atomic options string
timeout The helm deployment timeout options string
wait The helm deployment wait options string

HelmMappingRuleProfile

Name Description Value
helmPackageVersion Helm package version. string
options The helm deployment options HelmMappingRuleProfileOptions
releaseName Helm release name. string
releaseNamespace Helm release namespace. string
values Helm release values. string

HelmMappingRuleProfileOptions

Name Description Value
installOptions The helm deployment install options HelmInstallOptions
upgradeOptions The helm deployment upgrade options HelmUpgradeOptions

HelmUpgradeOptions

Name Description Value
atomic The helm deployment atomic options string
timeout The helm deployment timeout options string
wait The helm deployment wait options string

ImageArtifactProfile

Name Description Value
imageName Image name. string
imageVersion Image version. string

ImageMappingRuleProfile

Name Description Value
userConfiguration List of values. string

NetworkFunctionDefinitionVersionPropertiesFormat

Name Description Value
deployParameters The deployment parameters of the network function definition version. string
description The network function definition version description. string
networkFunctionType Set to 'ContainerizedNetworkFunction' for type ContainerizedNetworkFunctionDefinitionVersion. Set to 'VirtualNetworkFunction' for type VirtualNetworkFunctionDefinitionVersion. 'ContainerizedNetworkFunction'
'VirtualNetworkFunction' (required)

ReferencedResource

Name Description Value
id Resource ID. string

TrackedResourceTags

Name Description Value

VhdImageArtifactProfile

Name Description Value
vhdName Vhd name. string
vhdVersion Vhd version. string

VhdImageMappingRuleProfile

Name Description Value
userConfiguration List of values. string

VirtualNetworkFunctionDefinitionVersion

Name Description Value
networkFunctionTemplate Virtual network function template. VirtualNetworkFunctionTemplate
networkFunctionType The network function type. 'VirtualNetworkFunction' (required)

VirtualNetworkFunctionTemplate

Name Description Value
nfviType Set to 'AzureCore' for type AzureCoreNetworkFunctionTemplate. Set to 'AzureOperatorNexus' for type AzureOperatorNexusNetworkFunctionTemplate. 'AzureCore'
'AzureOperatorNexus' (required)

ARM template resource definition

The publishers/networkFunctionDefinitionGroups/networkFunctionDefinitionVersions resource type can be deployed with operations that target:

Usage Examples

Resource format

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

{
  "type": "Microsoft.HybridNetwork/publishers/networkFunctionDefinitionGroups/networkFunctionDefinitionVersions",
  "apiVersion": "2024-04-15",
  "name": "string",
  "location": "string",
  "properties": {
    "deployParameters": "string",
    "description": "string",
    "networkFunctionType": "string"
    // For remaining properties, see NetworkFunctionDefinitionVersionPropertiesFormat objects
  },
  "tags": {
    "{customized property}": "string"
  }
}

AzureCoreNetworkFunctionApplication objects

Set the artifactType property to specify the type of object.

For ArmTemplate, use:

{
  "artifactProfile": {
    "artifactStore": {
      "id": "string"
    },
    "templateArtifactProfile": {
      "templateName": "string",
      "templateVersion": "string"
    }
  },
  "artifactType": "ArmTemplate",
  "deployParametersMappingRuleProfile": {
    "applicationEnablement": "string",
    "templateMappingRuleProfile": {
      "templateParameters": "string"
    }
  }
}

For VhdImageFile, use:

{
  "artifactProfile": {
    "artifactStore": {
      "id": "string"
    },
    "vhdArtifactProfile": {
      "vhdName": "string",
      "vhdVersion": "string"
    }
  },
  "artifactType": "VhdImageFile",
  "deployParametersMappingRuleProfile": {
    "applicationEnablement": "string",
    "vhdImageMappingRuleProfile": {
      "userConfiguration": "string"
    }
  }
}

NetworkFunctionDefinitionVersionPropertiesFormat objects

Set the networkFunctionType property to specify the type of object.

For ContainerizedNetworkFunction, use:

{
  "networkFunctionTemplate": {
    "nfviType": "string"
    // For remaining properties, see ContainerizedNetworkFunctionTemplate objects
  },
  "networkFunctionType": "ContainerizedNetworkFunction"
}

For VirtualNetworkFunction, use:

{
  "networkFunctionTemplate": {
    "nfviType": "string"
    // For remaining properties, see VirtualNetworkFunctionTemplate objects
  },
  "networkFunctionType": "VirtualNetworkFunction"
}

VirtualNetworkFunctionTemplate objects

Set the nfviType property to specify the type of object.

For AzureCore, use:

{
  "networkFunctionApplications": [ {
    "dependsOnProfile": {
      "installDependsOn": [ "string" ],
      "uninstallDependsOn": [ "string" ],
      "updateDependsOn": [ "string" ]
    },
    "name": "string",
    "artifactType": "string"
    // For remaining properties, see AzureCoreNetworkFunctionApplication objects
  } ],
  "nfviType": "AzureCore"
}

For AzureOperatorNexus, use:

{
  "networkFunctionApplications": [ {
    "dependsOnProfile": {
      "installDependsOn": [ "string" ],
      "uninstallDependsOn": [ "string" ],
      "updateDependsOn": [ "string" ]
    },
    "name": "string",
    "artifactType": "string"
    // For remaining properties, see AzureOperatorNexusNetworkFunctionApplication objects
  } ],
  "nfviType": "AzureOperatorNexus"
}

ContainerizedNetworkFunctionTemplate objects

Set the nfviType property to specify the type of object.

For AzureArcKubernetes, use:

{
  "networkFunctionApplications": [ {
    "dependsOnProfile": {
      "installDependsOn": [ "string" ],
      "uninstallDependsOn": [ "string" ],
      "updateDependsOn": [ "string" ]
    },
    "name": "string",
    "artifactType": "string"
    // For remaining properties, see AzureArcKubernetesNetworkFunctionApplication objects
  } ],
  "nfviType": "AzureArcKubernetes"
}

AzureOperatorNexusNetworkFunctionApplication objects

Set the artifactType property to specify the type of object.

For ArmTemplate, use:

{
  "artifactProfile": {
    "artifactStore": {
      "id": "string"
    },
    "templateArtifactProfile": {
      "templateName": "string",
      "templateVersion": "string"
    }
  },
  "artifactType": "ArmTemplate",
  "deployParametersMappingRuleProfile": {
    "applicationEnablement": "string",
    "templateMappingRuleProfile": {
      "templateParameters": "string"
    }
  }
}

For ImageFile, use:

{
  "artifactProfile": {
    "artifactStore": {
      "id": "string"
    },
    "imageArtifactProfile": {
      "imageName": "string",
      "imageVersion": "string"
    }
  },
  "artifactType": "ImageFile",
  "deployParametersMappingRuleProfile": {
    "applicationEnablement": "string",
    "imageMappingRuleProfile": {
      "userConfiguration": "string"
    }
  }
}

AzureArcKubernetesNetworkFunctionApplication objects

Set the artifactType property to specify the type of object.

For HelmPackage, use:

{
  "artifactProfile": {
    "artifactStore": {
      "id": "string"
    },
    "helmArtifactProfile": {
      "helmPackageName": "string",
      "helmPackageVersionRange": "string",
      "imagePullSecretsValuesPaths": [ "string" ],
      "registryValuesPaths": [ "string" ]
    }
  },
  "artifactType": "HelmPackage",
  "deployParametersMappingRuleProfile": {
    "applicationEnablement": "string",
    "helmMappingRuleProfile": {
      "helmPackageVersion": "string",
      "options": {
        "installOptions": {
          "atomic": "string",
          "timeout": "string",
          "wait": "string"
        },
        "upgradeOptions": {
          "atomic": "string",
          "timeout": "string",
          "wait": "string"
        }
      },
      "releaseName": "string",
      "releaseNamespace": "string",
      "values": "string"
    }
  }
}

Property Values

Microsoft.HybridNetwork/publishers/networkFunctionDefinitionGroups/networkFunctionDefinitionVersions

Name Description Value
apiVersion The api version '2024-04-15'
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Max length = 64
Pattern = ^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$ (required)
properties Network function definition version properties. NetworkFunctionDefinitionVersionPropertiesFormat
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.HybridNetwork/publishers/networkFunctionDefinitionGroups/networkFunctionDefinitionVersions'

ArmTemplateArtifactProfile

Name Description Value
templateName Template name. string
templateVersion Template version. string

ArmTemplateMappingRuleProfile

Name Description Value
templateParameters List of template parameters. string

AzureArcKubernetesArtifactProfile

Name Description Value
artifactStore The reference to artifact store. ReferencedResource
helmArtifactProfile Helm artifact profile. HelmArtifactProfile

AzureArcKubernetesDeployMappingRuleProfile

Name Description Value
applicationEnablement The application enablement. 'Disabled'
'Enabled'
'Unknown'
helmMappingRuleProfile The helm mapping rule profile. HelmMappingRuleProfile

AzureArcKubernetesHelmApplication

Name Description Value
artifactProfile Azure arc kubernetes artifact profile. AzureArcKubernetesArtifactProfile
artifactType The artifact type. 'HelmPackage' (required)
deployParametersMappingRuleProfile Deploy mapping rule profile. AzureArcKubernetesDeployMappingRuleProfile

AzureArcKubernetesNetworkFunctionApplication

Name Description Value
artifactType Set to 'HelmPackage' for type AzureArcKubernetesHelmApplication. 'HelmPackage' (required)
dependsOnProfile Depends on profile definition. DependsOnProfile
name The name of the network function application. string

AzureArcKubernetesNetworkFunctionTemplate

Name Description Value
networkFunctionApplications Network function applications. AzureArcKubernetesNetworkFunctionApplication[]
nfviType The network function type. 'AzureArcKubernetes' (required)

AzureCoreArmTemplateArtifactProfile

Name Description Value
artifactStore The reference to artifact store. ReferencedResource
templateArtifactProfile Template artifact profile. ArmTemplateArtifactProfile

AzureCoreArmTemplateDeployMappingRuleProfile

Name Description Value
applicationEnablement The application enablement. 'Disabled'
'Enabled'
'Unknown'
templateMappingRuleProfile The template mapping rule profile. ArmTemplateMappingRuleProfile

AzureCoreNetworkFunctionApplication

Name Description Value
artifactType Set to 'ArmTemplate' for type AzureCoreNetworkFunctionArmTemplateApplication. Set to 'VhdImageFile' for type AzureCoreNetworkFunctionVhdApplication. 'ArmTemplate'
'VhdImageFile' (required)
dependsOnProfile Depends on profile definition. DependsOnProfile
name The name of the network function application. string

AzureCoreNetworkFunctionArmTemplateApplication

Name Description Value
artifactProfile Azure template artifact profile. AzureCoreArmTemplateArtifactProfile
artifactType The artifact type. 'ArmTemplate' (required)
deployParametersMappingRuleProfile Deploy mapping rule profile. AzureCoreArmTemplateDeployMappingRuleProfile

AzureCoreNetworkFunctionTemplate

Name Description Value
networkFunctionApplications Network function applications. AzureCoreNetworkFunctionApplication[]
nfviType The network function type. 'AzureCore' (required)

AzureCoreNetworkFunctionVhdApplication

Name Description Value
artifactProfile Azure vhd image artifact profile. AzureCoreVhdImageArtifactProfile
artifactType The artifact type. 'VhdImageFile' (required)
deployParametersMappingRuleProfile Deploy mapping rule profile. AzureCoreVhdImageDeployMappingRuleProfile

AzureCoreVhdImageArtifactProfile

Name Description Value
artifactStore The reference to artifact store. ReferencedResource
vhdArtifactProfile Vhd artifact profile. VhdImageArtifactProfile

AzureCoreVhdImageDeployMappingRuleProfile

Name Description Value
applicationEnablement The application enablement. 'Disabled'
'Enabled'
'Unknown'
vhdImageMappingRuleProfile The vhd mapping rule profile. VhdImageMappingRuleProfile

AzureOperatorNexusArmTemplateArtifactProfile

Name Description Value
artifactStore The reference to artifact store. ReferencedResource
templateArtifactProfile Template artifact profile. ArmTemplateArtifactProfile

AzureOperatorNexusArmTemplateDeployMappingRuleProfile

Name Description Value
applicationEnablement The application enablement. 'Disabled'
'Enabled'
'Unknown'
templateMappingRuleProfile The template mapping rule profile. ArmTemplateMappingRuleProfile

AzureOperatorNexusImageArtifactProfile

Name Description Value
artifactStore The reference to artifact store. ReferencedResource
imageArtifactProfile Image artifact profile. ImageArtifactProfile

AzureOperatorNexusImageDeployMappingRuleProfile

Name Description Value
applicationEnablement The application enablement. 'Disabled'
'Enabled'
'Unknown'
imageMappingRuleProfile The vhd mapping rule profile. ImageMappingRuleProfile

AzureOperatorNexusNetworkFunctionApplication

Name Description Value
artifactType Set to 'ArmTemplate' for type AzureOperatorNexusNetworkFunctionArmTemplateApplication. Set to 'ImageFile' for type AzureOperatorNexusNetworkFunctionImageApplication. 'ArmTemplate'
'ImageFile' (required)
dependsOnProfile Depends on profile definition. DependsOnProfile
name The name of the network function application. string

AzureOperatorNexusNetworkFunctionArmTemplateApplication

Name Description Value
artifactProfile Azure Operator Distributed Services Template artifact profile. AzureOperatorNexusArmTemplateArtifactProfile
artifactType The artifact type. 'ArmTemplate' (required)
deployParametersMappingRuleProfile Deploy mapping rule profile. AzureOperatorNexusArmTemplateDeployMappingRuleProfile

AzureOperatorNexusNetworkFunctionImageApplication

Name Description Value
artifactProfile Azure Operator Distributed Services image artifact profile. AzureOperatorNexusImageArtifactProfile
artifactType The artifact type. 'ImageFile' (required)
deployParametersMappingRuleProfile Deploy mapping rule profile. AzureOperatorNexusImageDeployMappingRuleProfile

AzureOperatorNexusNetworkFunctionTemplate

Name Description Value
networkFunctionApplications Network function applications. AzureOperatorNexusNetworkFunctionApplication[]
nfviType The network function type. 'AzureOperatorNexus' (required)

ContainerizedNetworkFunctionDefinitionVersion

Name Description Value
networkFunctionTemplate Containerized network function template. ContainerizedNetworkFunctionTemplate
networkFunctionType The network function type. 'ContainerizedNetworkFunction' (required)

ContainerizedNetworkFunctionTemplate

Name Description Value
nfviType Set to 'AzureArcKubernetes' for type AzureArcKubernetesNetworkFunctionTemplate. 'AzureArcKubernetes' (required)

DependsOnProfile

Name Description Value
installDependsOn Application installation operation dependency. string[]
uninstallDependsOn Application deletion operation dependency. string[]
updateDependsOn Application update operation dependency. string[]

HelmArtifactProfile

Name Description Value
helmPackageName Helm package name. string
helmPackageVersionRange Helm package version range. string
imagePullSecretsValuesPaths The image pull secrets values path list. string[]
registryValuesPaths The registry values path list. string[]

HelmInstallOptions

Name Description Value
atomic The helm deployment atomic options string
timeout The helm deployment timeout options string
wait The helm deployment wait options string

HelmMappingRuleProfile

Name Description Value
helmPackageVersion Helm package version. string
options The helm deployment options HelmMappingRuleProfileOptions
releaseName Helm release name. string
releaseNamespace Helm release namespace. string
values Helm release values. string

HelmMappingRuleProfileOptions

Name Description Value
installOptions The helm deployment install options HelmInstallOptions
upgradeOptions The helm deployment upgrade options HelmUpgradeOptions

HelmUpgradeOptions

Name Description Value
atomic The helm deployment atomic options string
timeout The helm deployment timeout options string
wait The helm deployment wait options string

ImageArtifactProfile

Name Description Value
imageName Image name. string
imageVersion Image version. string

ImageMappingRuleProfile

Name Description Value
userConfiguration List of values. string

NetworkFunctionDefinitionVersionPropertiesFormat

Name Description Value
deployParameters The deployment parameters of the network function definition version. string
description The network function definition version description. string
networkFunctionType Set to 'ContainerizedNetworkFunction' for type ContainerizedNetworkFunctionDefinitionVersion. Set to 'VirtualNetworkFunction' for type VirtualNetworkFunctionDefinitionVersion. 'ContainerizedNetworkFunction'
'VirtualNetworkFunction' (required)

ReferencedResource

Name Description Value
id Resource ID. string

TrackedResourceTags

Name Description Value

VhdImageArtifactProfile

Name Description Value
vhdName Vhd name. string
vhdVersion Vhd version. string

VhdImageMappingRuleProfile

Name Description Value
userConfiguration List of values. string

VirtualNetworkFunctionDefinitionVersion

Name Description Value
networkFunctionTemplate Virtual network function template. VirtualNetworkFunctionTemplate
networkFunctionType The network function type. 'VirtualNetworkFunction' (required)

VirtualNetworkFunctionTemplate

Name Description Value
nfviType Set to 'AzureCore' for type AzureCoreNetworkFunctionTemplate. Set to 'AzureOperatorNexus' for type AzureOperatorNexusNetworkFunctionTemplate. 'AzureCore'
'AzureOperatorNexus' (required)

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.HybridNetwork/publishers/networkFunctionDefinitionGroups/networkFunctionDefinitionVersions@2024-04-15"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      deployParameters = "string"
      description = "string"
      networkFunctionType = "string"
      // For remaining properties, see NetworkFunctionDefinitionVersionPropertiesFormat objects
    }
  }
}

AzureCoreNetworkFunctionApplication objects

Set the artifactType property to specify the type of object.

For ArmTemplate, use:

{
  artifactProfile = {
    artifactStore = {
      id = "string"
    }
    templateArtifactProfile = {
      templateName = "string"
      templateVersion = "string"
    }
  }
  artifactType = "ArmTemplate"
  deployParametersMappingRuleProfile = {
    applicationEnablement = "string"
    templateMappingRuleProfile = {
      templateParameters = "string"
    }
  }
}

For VhdImageFile, use:

{
  artifactProfile = {
    artifactStore = {
      id = "string"
    }
    vhdArtifactProfile = {
      vhdName = "string"
      vhdVersion = "string"
    }
  }
  artifactType = "VhdImageFile"
  deployParametersMappingRuleProfile = {
    applicationEnablement = "string"
    vhdImageMappingRuleProfile = {
      userConfiguration = "string"
    }
  }
}

NetworkFunctionDefinitionVersionPropertiesFormat objects

Set the networkFunctionType property to specify the type of object.

For ContainerizedNetworkFunction, use:

{
  networkFunctionTemplate = {
    nfviType = "string"
    // For remaining properties, see ContainerizedNetworkFunctionTemplate objects
  }
  networkFunctionType = "ContainerizedNetworkFunction"
}

For VirtualNetworkFunction, use:

{
  networkFunctionTemplate = {
    nfviType = "string"
    // For remaining properties, see VirtualNetworkFunctionTemplate objects
  }
  networkFunctionType = "VirtualNetworkFunction"
}

VirtualNetworkFunctionTemplate objects

Set the nfviType property to specify the type of object.

For AzureCore, use:

{
  networkFunctionApplications = [
    {
      dependsOnProfile = {
        installDependsOn = [
          "string"
        ]
        uninstallDependsOn = [
          "string"
        ]
        updateDependsOn = [
          "string"
        ]
      }
      name = "string"
      artifactType = "string"
      // For remaining properties, see AzureCoreNetworkFunctionApplication objects
    }
  ]
  nfviType = "AzureCore"
}

For AzureOperatorNexus, use:

{
  networkFunctionApplications = [
    {
      dependsOnProfile = {
        installDependsOn = [
          "string"
        ]
        uninstallDependsOn = [
          "string"
        ]
        updateDependsOn = [
          "string"
        ]
      }
      name = "string"
      artifactType = "string"
      // For remaining properties, see AzureOperatorNexusNetworkFunctionApplication objects
    }
  ]
  nfviType = "AzureOperatorNexus"
}

ContainerizedNetworkFunctionTemplate objects

Set the nfviType property to specify the type of object.

For AzureArcKubernetes, use:

{
  networkFunctionApplications = [
    {
      dependsOnProfile = {
        installDependsOn = [
          "string"
        ]
        uninstallDependsOn = [
          "string"
        ]
        updateDependsOn = [
          "string"
        ]
      }
      name = "string"
      artifactType = "string"
      // For remaining properties, see AzureArcKubernetesNetworkFunctionApplication objects
    }
  ]
  nfviType = "AzureArcKubernetes"
}

AzureOperatorNexusNetworkFunctionApplication objects

Set the artifactType property to specify the type of object.

For ArmTemplate, use:

{
  artifactProfile = {
    artifactStore = {
      id = "string"
    }
    templateArtifactProfile = {
      templateName = "string"
      templateVersion = "string"
    }
  }
  artifactType = "ArmTemplate"
  deployParametersMappingRuleProfile = {
    applicationEnablement = "string"
    templateMappingRuleProfile = {
      templateParameters = "string"
    }
  }
}

For ImageFile, use:

{
  artifactProfile = {
    artifactStore = {
      id = "string"
    }
    imageArtifactProfile = {
      imageName = "string"
      imageVersion = "string"
    }
  }
  artifactType = "ImageFile"
  deployParametersMappingRuleProfile = {
    applicationEnablement = "string"
    imageMappingRuleProfile = {
      userConfiguration = "string"
    }
  }
}

AzureArcKubernetesNetworkFunctionApplication objects

Set the artifactType property to specify the type of object.

For HelmPackage, use:

{
  artifactProfile = {
    artifactStore = {
      id = "string"
    }
    helmArtifactProfile = {
      helmPackageName = "string"
      helmPackageVersionRange = "string"
      imagePullSecretsValuesPaths = [
        "string"
      ]
      registryValuesPaths = [
        "string"
      ]
    }
  }
  artifactType = "HelmPackage"
  deployParametersMappingRuleProfile = {
    applicationEnablement = "string"
    helmMappingRuleProfile = {
      helmPackageVersion = "string"
      options = {
        installOptions = {
          atomic = "string"
          timeout = "string"
          wait = "string"
        }
        upgradeOptions = {
          atomic = "string"
          timeout = "string"
          wait = "string"
        }
      }
      releaseName = "string"
      releaseNamespace = "string"
      values = "string"
    }
  }
}

Property Values

Microsoft.HybridNetwork/publishers/networkFunctionDefinitionGroups/networkFunctionDefinitionVersions

Name Description Value
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Max length = 64
Pattern = ^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$ (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: publishers/networkFunctionDefinitionGroups
properties Network function definition version properties. NetworkFunctionDefinitionVersionPropertiesFormat
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.HybridNetwork/publishers/networkFunctionDefinitionGroups/networkFunctionDefinitionVersions@2024-04-15"

ArmTemplateArtifactProfile

Name Description Value
templateName Template name. string
templateVersion Template version. string

ArmTemplateMappingRuleProfile

Name Description Value
templateParameters List of template parameters. string

AzureArcKubernetesArtifactProfile

Name Description Value
artifactStore The reference to artifact store. ReferencedResource
helmArtifactProfile Helm artifact profile. HelmArtifactProfile

AzureArcKubernetesDeployMappingRuleProfile

Name Description Value
applicationEnablement The application enablement. 'Disabled'
'Enabled'
'Unknown'
helmMappingRuleProfile The helm mapping rule profile. HelmMappingRuleProfile

AzureArcKubernetesHelmApplication

Name Description Value
artifactProfile Azure arc kubernetes artifact profile. AzureArcKubernetesArtifactProfile
artifactType The artifact type. 'HelmPackage' (required)
deployParametersMappingRuleProfile Deploy mapping rule profile. AzureArcKubernetesDeployMappingRuleProfile

AzureArcKubernetesNetworkFunctionApplication

Name Description Value
artifactType Set to 'HelmPackage' for type AzureArcKubernetesHelmApplication. 'HelmPackage' (required)
dependsOnProfile Depends on profile definition. DependsOnProfile
name The name of the network function application. string

AzureArcKubernetesNetworkFunctionTemplate

Name Description Value
networkFunctionApplications Network function applications. AzureArcKubernetesNetworkFunctionApplication[]
nfviType The network function type. 'AzureArcKubernetes' (required)

AzureCoreArmTemplateArtifactProfile

Name Description Value
artifactStore The reference to artifact store. ReferencedResource
templateArtifactProfile Template artifact profile. ArmTemplateArtifactProfile

AzureCoreArmTemplateDeployMappingRuleProfile

Name Description Value
applicationEnablement The application enablement. 'Disabled'
'Enabled'
'Unknown'
templateMappingRuleProfile The template mapping rule profile. ArmTemplateMappingRuleProfile

AzureCoreNetworkFunctionApplication

Name Description Value
artifactType Set to 'ArmTemplate' for type AzureCoreNetworkFunctionArmTemplateApplication. Set to 'VhdImageFile' for type AzureCoreNetworkFunctionVhdApplication. 'ArmTemplate'
'VhdImageFile' (required)
dependsOnProfile Depends on profile definition. DependsOnProfile
name The name of the network function application. string

AzureCoreNetworkFunctionArmTemplateApplication

Name Description Value
artifactProfile Azure template artifact profile. AzureCoreArmTemplateArtifactProfile
artifactType The artifact type. 'ArmTemplate' (required)
deployParametersMappingRuleProfile Deploy mapping rule profile. AzureCoreArmTemplateDeployMappingRuleProfile

AzureCoreNetworkFunctionTemplate

Name Description Value
networkFunctionApplications Network function applications. AzureCoreNetworkFunctionApplication[]
nfviType The network function type. 'AzureCore' (required)

AzureCoreNetworkFunctionVhdApplication

Name Description Value
artifactProfile Azure vhd image artifact profile. AzureCoreVhdImageArtifactProfile
artifactType The artifact type. 'VhdImageFile' (required)
deployParametersMappingRuleProfile Deploy mapping rule profile. AzureCoreVhdImageDeployMappingRuleProfile

AzureCoreVhdImageArtifactProfile

Name Description Value
artifactStore The reference to artifact store. ReferencedResource
vhdArtifactProfile Vhd artifact profile. VhdImageArtifactProfile

AzureCoreVhdImageDeployMappingRuleProfile

Name Description Value
applicationEnablement The application enablement. 'Disabled'
'Enabled'
'Unknown'
vhdImageMappingRuleProfile The vhd mapping rule profile. VhdImageMappingRuleProfile

AzureOperatorNexusArmTemplateArtifactProfile

Name Description Value
artifactStore The reference to artifact store. ReferencedResource
templateArtifactProfile Template artifact profile. ArmTemplateArtifactProfile

AzureOperatorNexusArmTemplateDeployMappingRuleProfile

Name Description Value
applicationEnablement The application enablement. 'Disabled'
'Enabled'
'Unknown'
templateMappingRuleProfile The template mapping rule profile. ArmTemplateMappingRuleProfile

AzureOperatorNexusImageArtifactProfile

Name Description Value
artifactStore The reference to artifact store. ReferencedResource
imageArtifactProfile Image artifact profile. ImageArtifactProfile

AzureOperatorNexusImageDeployMappingRuleProfile

Name Description Value
applicationEnablement The application enablement. 'Disabled'
'Enabled'
'Unknown'
imageMappingRuleProfile The vhd mapping rule profile. ImageMappingRuleProfile

AzureOperatorNexusNetworkFunctionApplication

Name Description Value
artifactType Set to 'ArmTemplate' for type AzureOperatorNexusNetworkFunctionArmTemplateApplication. Set to 'ImageFile' for type AzureOperatorNexusNetworkFunctionImageApplication. 'ArmTemplate'
'ImageFile' (required)
dependsOnProfile Depends on profile definition. DependsOnProfile
name The name of the network function application. string

AzureOperatorNexusNetworkFunctionArmTemplateApplication

Name Description Value
artifactProfile Azure Operator Distributed Services Template artifact profile. AzureOperatorNexusArmTemplateArtifactProfile
artifactType The artifact type. 'ArmTemplate' (required)
deployParametersMappingRuleProfile Deploy mapping rule profile. AzureOperatorNexusArmTemplateDeployMappingRuleProfile

AzureOperatorNexusNetworkFunctionImageApplication

Name Description Value
artifactProfile Azure Operator Distributed Services image artifact profile. AzureOperatorNexusImageArtifactProfile
artifactType The artifact type. 'ImageFile' (required)
deployParametersMappingRuleProfile Deploy mapping rule profile. AzureOperatorNexusImageDeployMappingRuleProfile

AzureOperatorNexusNetworkFunctionTemplate

Name Description Value
networkFunctionApplications Network function applications. AzureOperatorNexusNetworkFunctionApplication[]
nfviType The network function type. 'AzureOperatorNexus' (required)

ContainerizedNetworkFunctionDefinitionVersion

Name Description Value
networkFunctionTemplate Containerized network function template. ContainerizedNetworkFunctionTemplate
networkFunctionType The network function type. 'ContainerizedNetworkFunction' (required)

ContainerizedNetworkFunctionTemplate

Name Description Value
nfviType Set to 'AzureArcKubernetes' for type AzureArcKubernetesNetworkFunctionTemplate. 'AzureArcKubernetes' (required)

DependsOnProfile

Name Description Value
installDependsOn Application installation operation dependency. string[]
uninstallDependsOn Application deletion operation dependency. string[]
updateDependsOn Application update operation dependency. string[]

HelmArtifactProfile

Name Description Value
helmPackageName Helm package name. string
helmPackageVersionRange Helm package version range. string
imagePullSecretsValuesPaths The image pull secrets values path list. string[]
registryValuesPaths The registry values path list. string[]

HelmInstallOptions

Name Description Value
atomic The helm deployment atomic options string
timeout The helm deployment timeout options string
wait The helm deployment wait options string

HelmMappingRuleProfile

Name Description Value
helmPackageVersion Helm package version. string
options The helm deployment options HelmMappingRuleProfileOptions
releaseName Helm release name. string
releaseNamespace Helm release namespace. string
values Helm release values. string

HelmMappingRuleProfileOptions

Name Description Value
installOptions The helm deployment install options HelmInstallOptions
upgradeOptions The helm deployment upgrade options HelmUpgradeOptions

HelmUpgradeOptions

Name Description Value
atomic The helm deployment atomic options string
timeout The helm deployment timeout options string
wait The helm deployment wait options string

ImageArtifactProfile

Name Description Value
imageName Image name. string
imageVersion Image version. string

ImageMappingRuleProfile

Name Description Value
userConfiguration List of values. string

NetworkFunctionDefinitionVersionPropertiesFormat

Name Description Value
deployParameters The deployment parameters of the network function definition version. string
description The network function definition version description. string
networkFunctionType Set to 'ContainerizedNetworkFunction' for type ContainerizedNetworkFunctionDefinitionVersion. Set to 'VirtualNetworkFunction' for type VirtualNetworkFunctionDefinitionVersion. 'ContainerizedNetworkFunction'
'VirtualNetworkFunction' (required)

ReferencedResource

Name Description Value
id Resource ID. string

TrackedResourceTags

Name Description Value

VhdImageArtifactProfile

Name Description Value
vhdName Vhd name. string
vhdVersion Vhd version. string

VhdImageMappingRuleProfile

Name Description Value
userConfiguration List of values. string

VirtualNetworkFunctionDefinitionVersion

Name Description Value
networkFunctionTemplate Virtual network function template. VirtualNetworkFunctionTemplate
networkFunctionType The network function type. 'VirtualNetworkFunction' (required)

VirtualNetworkFunctionTemplate

Name Description Value
nfviType Set to 'AzureCore' for type AzureCoreNetworkFunctionTemplate. Set to 'AzureOperatorNexus' for type AzureOperatorNexusNetworkFunctionTemplate. 'AzureCore'
'AzureOperatorNexus' (required)