Package-level declarations

Types

data class ArmResourceDefinitionResourceElementTemplateDetailsResponse(val configuration: ArmResourceDefinitionResourceElementTemplateResponse? = null, val dependsOnProfile: DependsOnProfileResponse? = null, val name: String? = null, val resourceElementType: String)

The arm resource definition resource element template details.

data class ArmResourceDefinitionResourceElementTemplateResponse(val artifactProfile: NSDArtifactProfileResponse? = null, val parameterValues: String? = null, val templateType: String? = null)

The arm template RE.

Link copied to clipboard
data class ArmTemplateArtifactProfileResponse(val templateName: String? = null, val templateVersion: String? = null)

Template artifact profile.

Link copied to clipboard
data class ArmTemplateMappingRuleProfileResponse(val templateParameters: String? = null)

Template mapping rule profile

Link copied to clipboard
data class ArtifactManifestPropertiesFormatResponse(val artifactManifestState: String, val artifacts: List<ManifestArtifactFormatResponse>? = null, val provisioningState: String)

Artifact manifest properties.

List of network fabric controller ids.

data class ArtifactStorePrivateEndPointsFormatResponse(val manualPrivateEndPointConnections: List<ReferencedResourceResponse>? = null)

List of manual private endpoints.

Link copied to clipboard
data class ArtifactStorePropertiesFormatResponse(val backingResourcePublicNetworkAccess: String? = null, val managedResourceGroupConfiguration: ArtifactStorePropertiesFormatResponseManagedResourceGroupConfiguration? = null, val provisioningState: String, val replicationStrategy: String? = null, val storageResourceId: String, val storeType: String? = null)

Artifact store properties.

Link copied to clipboard
data class AzureArcK8sClusterNFVIDetailsResponse(val customLocationReference: ReferencedResourceResponse? = null, val name: String? = null, val nfviType: String)

The AzureArcK8sCluster NFVI detail.

data class AzureArcKubernetesArtifactProfileResponse(val artifactStore: ReferencedResourceResponse? = null, val helmArtifactProfile: HelmArtifactProfileResponse? = null)

Azure arc kubernetes artifact profile properties.

data class AzureArcKubernetesDeployMappingRuleProfileResponse(val applicationEnablement: String? = null, val helmMappingRuleProfile: HelmMappingRuleProfileResponse? = null)

Azure arc kubernetes deploy mapping rule profile.

data class AzureArcKubernetesHelmApplicationResponse(val artifactProfile: AzureArcKubernetesArtifactProfileResponse? = null, val artifactType: String, val dependsOnProfile: DependsOnProfileResponse? = null, val deployParametersMappingRuleProfile: AzureArcKubernetesDeployMappingRuleProfileResponse? = null, val name: String? = null)

Azure arc kubernetes helm application configurations.

data class AzureArcKubernetesNetworkFunctionTemplateResponse(val networkFunctionApplications: List<AzureArcKubernetesHelmApplicationResponse>? = null, val nfviType: String)

Azure Arc kubernetes network function template.

data class AzureCoreArmTemplateArtifactProfileResponse(val artifactStore: ReferencedResourceResponse? = null, val templateArtifactProfile: ArmTemplateArtifactProfileResponse? = null)

Azure template artifact profile properties.

data class AzureCoreArmTemplateDeployMappingRuleProfileResponse(val applicationEnablement: String? = null, val templateMappingRuleProfile: ArmTemplateMappingRuleProfileResponse? = null)

Azure template deploy mapping rule profile.

data class AzureCoreNetworkFunctionArmTemplateApplicationResponse(val artifactProfile: AzureCoreArmTemplateArtifactProfileResponse? = null, val artifactType: String, val dependsOnProfile: DependsOnProfileResponse? = null, val deployParametersMappingRuleProfile: AzureCoreArmTemplateDeployMappingRuleProfileResponse? = null, val name: String? = null)

Azure core network function Template application definition.

Link copied to clipboard

Azure virtual network function template.

data class AzureCoreNetworkFunctionVhdApplicationResponse(val artifactProfile: AzureCoreVhdImageArtifactProfileResponse? = null, val artifactType: String, val dependsOnProfile: DependsOnProfileResponse? = null, val deployParametersMappingRuleProfile: AzureCoreVhdImageDeployMappingRuleProfileResponse? = null, val name: String? = null)

Azure core network function vhd application definition.

Link copied to clipboard
data class AzureCoreNFVIDetailsResponse(val location: String? = null, val name: String? = null, val nfviType: String)

The Azure Core NFVI detail.

Link copied to clipboard
data class AzureCoreVhdImageArtifactProfileResponse(val artifactStore: ReferencedResourceResponse? = null, val vhdArtifactProfile: VhdImageArtifactProfileResponse? = null)

Azure vhd artifact profile properties.

data class AzureCoreVhdImageDeployMappingRuleProfileResponse(val applicationEnablement: String? = null, val vhdImageMappingRuleProfile: VhdImageMappingRuleProfileResponse? = null)

Azure vhd deploy mapping rule profile.

data class AzureOperatorNexusArmTemplateArtifactProfileResponse(val artifactStore: ReferencedResourceResponse? = null, val templateArtifactProfile: ArmTemplateArtifactProfileResponse? = null)

Azure Operator Distributed Services vhd artifact profile properties.

data class AzureOperatorNexusArmTemplateDeployMappingRuleProfileResponse(val applicationEnablement: String? = null, val templateMappingRuleProfile: ArmTemplateMappingRuleProfileResponse? = null)

Azure Operator Distributed Services template deploy mapping rule profile.

data class AzureOperatorNexusClusterNFVIDetailsResponse(val customLocationReference: ReferencedResourceResponse? = null, val name: String? = null, val nfviType: String)

The AzureOperatorNexusCluster NFVI detail.

data class AzureOperatorNexusImageArtifactProfileResponse(val artifactStore: ReferencedResourceResponse? = null, val imageArtifactProfile: ImageArtifactProfileResponse? = null)

Azure Operator Distributed Services image artifact profile properties.

data class AzureOperatorNexusImageDeployMappingRuleProfileResponse(val applicationEnablement: String? = null, val imageMappingRuleProfile: ImageMappingRuleProfileResponse? = null)

Azure Operator Distributed Services image deploy mapping rule profile.

data class AzureOperatorNexusNetworkFunctionArmTemplateApplicationResponse(val artifactProfile: AzureOperatorNexusArmTemplateArtifactProfileResponse? = null, val artifactType: String, val dependsOnProfile: DependsOnProfileResponse? = null, val deployParametersMappingRuleProfile: AzureOperatorNexusArmTemplateDeployMappingRuleProfileResponse? = null, val name: String? = null)

Azure Operator Distributed Services network function Template application definition.

data class AzureOperatorNexusNetworkFunctionImageApplicationResponse(val artifactProfile: AzureOperatorNexusImageArtifactProfileResponse? = null, val artifactType: String, val dependsOnProfile: DependsOnProfileResponse? = null, val deployParametersMappingRuleProfile: AzureOperatorNexusImageDeployMappingRuleProfileResponse? = null, val name: String? = null)

Azure Operator Distributed Services network function image application definition.

Azure Operator Distributed Services network function template.

data class ConfigurationGroupSchemaPropertiesFormatResponse(val description: String? = null, val provisioningState: String, val schemaDefinition: String? = null, val versionState: String)

Configuration group schema properties.

Link copied to clipboard
data class ConfigurationValueWithoutSecretsResponse(val configurationGroupSchemaName: String, val configurationGroupSchemaOfferingLocation: String, val configurationGroupSchemaResourceReference: Either<OpenDeploymentResourceReferenceResponse, SecretDeploymentResourceReferenceResponse>? = null, val configurationType: String, val configurationValue: String? = null, val provisioningState: String, val publisherName: String, val publisherScope: String)

The ConfigurationValue with no secrets.

Link copied to clipboard
data class ConfigurationValueWithSecretsResponse(val configurationGroupSchemaName: String, val configurationGroupSchemaOfferingLocation: String, val configurationGroupSchemaResourceReference: Either<OpenDeploymentResourceReferenceResponse, SecretDeploymentResourceReferenceResponse>? = null, val configurationType: String, val provisioningState: String, val publisherName: String, val publisherScope: String)

The ConfigurationValue with secrets.

data class ContainerizedNetworkFunctionDefinitionVersionResponse(val deployParameters: String? = null, val description: String? = null, val networkFunctionTemplate: AzureArcKubernetesNetworkFunctionTemplateResponse? = null, val networkFunctionType: String, val provisioningState: String, val versionState: String)

Containerized network function network function definition version properties.

Link copied to clipboard
data class CustomProfileResponse(val metadataConfigurationPath: String? = null)

Specifies the custom settings for the virtual machine.

Link copied to clipboard
data class DataDiskResponse(val createOption: String? = null, val diskSizeGB: Int? = null, val name: String? = null)

Specifies information about the operating system disk used by the virtual machine.

For more information about disks, see About disks and VHDs for Azure virtual machines.

Link copied to clipboard
data class DependsOnProfileResponse(val installDependsOn: List<String>? = null, val uninstallDependsOn: List<String>? = null, val updateDependsOn: List<String>? = null)

Depends on profile definition.

Link copied to clipboard
data class GetArtifactManifestResult(val azureApiVersion: String, val id: String, val location: String, val name: String, val properties: ArtifactManifestPropertiesFormatResponse, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Artifact manifest properties.

Link copied to clipboard
data class GetArtifactStoreResult(val azureApiVersion: String, val id: String, val location: String, val name: String, val properties: ArtifactStorePropertiesFormatResponse, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Artifact store properties.

Link copied to clipboard
data class GetConfigurationGroupSchemaResult(val azureApiVersion: String, val id: String, val location: String, val name: String, val properties: ConfigurationGroupSchemaPropertiesFormatResponse, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Configuration group schema resource.

Link copied to clipboard
data class GetConfigurationGroupValueResult(val azureApiVersion: String, val id: String, val location: String, val name: String, val properties: Either<ConfigurationValueWithSecretsResponse, ConfigurationValueWithoutSecretsResponse>, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Hybrid configuration group value resource.

Link copied to clipboard
data class GetDeviceResult(val azureApiVersion: String, val deviceType: String, val id: String, val location: String, val name: String, val networkFunctions: List<SubResourceResponse>, val provisioningState: String, val status: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Device resource.

Link copied to clipboard
data class GetNetworkFunctionDefinitionGroupResult(val azureApiVersion: String, val id: String, val location: String, val name: String, val properties: NetworkFunctionDefinitionGroupPropertiesFormatResponse, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Network function definition group resource.

data class GetNetworkFunctionDefinitionVersionResult(val azureApiVersion: String, val id: String, val location: String, val name: String, val properties: Either<ContainerizedNetworkFunctionDefinitionVersionResponse, VirtualNetworkFunctionNetworkFunctionDefinitionVersionResponse>, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Network function definition version.

Link copied to clipboard
data class GetNetworkFunctionResult(val azureApiVersion: String, val etag: String? = null, val id: String, val identity: ManagedServiceIdentityResponse? = null, val location: String, val name: String, val properties: Either<NetworkFunctionValueWithSecretsResponse, NetworkFunctionValueWithoutSecretsResponse>, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Network function resource response.

Link copied to clipboard
data class GetNetworkServiceDesignGroupResult(val azureApiVersion: String, val id: String, val location: String, val name: String, val properties: NetworkServiceDesignGroupPropertiesFormatResponse, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

network service design group resource.

Link copied to clipboard
data class GetNetworkServiceDesignVersionResult(val azureApiVersion: String, val id: String, val location: String, val name: String, val properties: NetworkServiceDesignVersionPropertiesFormatResponse, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

network service design version.

Link copied to clipboard
data class GetPublisherResult(val azureApiVersion: String, val id: String, val identity: ManagedServiceIdentityResponse? = null, val location: String, val name: String, val properties: PublisherPropertiesFormatResponse, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

publisher resource.

Link copied to clipboard
data class GetSiteNetworkServiceResult(val azureApiVersion: String, val id: String, val identity: ManagedServiceIdentityResponse? = null, val location: String, val name: String, val properties: SiteNetworkServicePropertiesFormatResponse, val sku: SkuResponse? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Site network service resource.

Link copied to clipboard
data class GetSiteResult(val azureApiVersion: String, val id: String, val location: String, val name: String, val properties: SitePropertiesFormatResponse, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Site resource.

Link copied to clipboard
data class GetVendorResult(val azureApiVersion: String, val id: String, val name: String, val provisioningState: String, val skus: List<SubResourceResponse>, val systemData: SystemDataResponse, val type: String)

Vendor resource.

Link copied to clipboard
data class GetVendorSkuPreviewResult(val azureApiVersion: String, val id: String, val name: String, val provisioningState: String, val systemData: SystemDataResponse, val type: String)

Customer subscription which can use a sku.

Link copied to clipboard
data class GetVendorSkusResult(val azureApiVersion: String, val deploymentMode: String? = null, val id: String, val managedApplicationParameters: Any? = null, val managedApplicationTemplate: Any? = null, val name: String, val networkFunctionTemplate: NetworkFunctionTemplateResponse? = null, val networkFunctionType: String? = null, val preview: Boolean? = null, val provisioningState: String, val skuType: String? = null, val systemData: SystemDataResponse, val type: String)

Sku sub resource.

Link copied to clipboard
data class HelmArtifactProfileResponse(val helmPackageName: String? = null, val helmPackageVersionRange: String? = null, val imagePullSecretsValuesPaths: List<String>? = null, val registryValuesPaths: List<String>? = null)

Helm artifact profile.

Link copied to clipboard
data class HelmInstallOptionsResponse(val atomic: String? = null, val timeout: String? = null, val wait: String? = null)

The helm deployment install options

Link copied to clipboard
data class HelmMappingRuleProfileResponse(val helmPackageVersion: String? = null, val options: HelmMappingRuleProfileResponseOptions? = null, val releaseName: String? = null, val releaseNamespace: String? = null, val values: String? = null)

Helm mapping rule profile

Link copied to clipboard
data class HelmMappingRuleProfileResponseOptions(val installOptions: HelmInstallOptionsResponse? = null, val upgradeOptions: HelmUpgradeOptionsResponse? = null)

The helm deployment options

Link copied to clipboard
data class HelmUpgradeOptionsResponse(val atomic: String? = null, val timeout: String? = null, val wait: String? = null)

The helm deployment install options

Link copied to clipboard
data class ImageArtifactProfileResponse(val imageName: String? = null, val imageVersion: String? = null)

Image artifact profile.

Link copied to clipboard
data class ImageMappingRuleProfileResponse(val userConfiguration: String? = null)

Image mapping rule profile

Link copied to clipboard
data class ImageReferenceResponse(val exactVersion: String? = null, val offer: String? = null, val publisher: String? = null, val sku: String? = null, val version: String? = null)

The image reference properties.

Link copied to clipboard

Specifies the Linux operating system settings on the virtual machine.

Link copied to clipboard
data class ListArtifactManifestCredentialResult(val credentialType: String)

The artifact manifest credential definition.

Link copied to clipboard

List of manual private endpoints.

Link copied to clipboard
data class ListDeviceRegistrationKeyResult(val registrationKey: String)

The device registration key.

Link copied to clipboard
data class ListVendorSkusCredentialResult(val acrServerUrl: String? = null, val acrToken: String? = null, val expiry: String? = null, val repositories: List<String>? = null, val username: String? = null)

The Sku credential definition.

data class ManagedResourceGroupConfigurationResponse(val location: String? = null, val name: String? = null)

Managed resource group configuration.

Link copied to clipboard
data class ManagedServiceIdentityResponse(val principalId: String, val tenantId: String, val type: String, val userAssignedIdentities: Map<String, UserAssignedIdentityResponse>? = null)

Managed service identity (system assigned and/or user assigned identities)

Link copied to clipboard
data class ManifestArtifactFormatResponse(val artifactName: String? = null, val artifactType: String? = null, val artifactVersion: String? = null)

Manifest artifact properties.

data class NetworkFunctionDefinitionGroupPropertiesFormatResponse(val description: String? = null, val provisioningState: String)

Network function definition group properties.

data class NetworkFunctionDefinitionResourceElementTemplateDetailsResponse(val configuration: ArmResourceDefinitionResourceElementTemplateResponse? = null, val dependsOnProfile: DependsOnProfileResponse? = null, val name: String? = null, val resourceElementType: String)

The network function definition resource element template details.

Link copied to clipboard
data class NetworkFunctionRoleConfigurationResponse(val customProfile: CustomProfileResponse? = null, val networkInterfaces: List<NetworkInterfaceResponse>? = null, val osProfile: OsProfileResponse? = null, val roleName: String? = null, val roleType: String? = null, val storageProfile: StorageProfileResponse? = null, val userDataParameters: Any? = null, val userDataTemplate: Any? = null, val virtualMachineSize: String? = null)

Network function role configuration.

Link copied to clipboard
data class NetworkFunctionTemplateResponse(val networkFunctionRoleConfigurations: List<NetworkFunctionRoleConfigurationResponse>? = null)

The network function template.

data class NetworkFunctionValueWithoutSecretsResponse(val allowSoftwareUpdate: Boolean? = null, val configurationType: String, val deploymentValues: String? = null, val networkFunctionDefinitionGroupName: String? = null, val networkFunctionDefinitionOfferingLocation: String? = null, val networkFunctionDefinitionVersion: String? = null, val networkFunctionDefinitionVersionResourceReference: Either<OpenDeploymentResourceReferenceResponse, SecretDeploymentResourceReferenceResponse>? = null, val nfviId: String? = null, val nfviType: String? = null, val provisioningState: String, val publisherName: String? = null, val publisherScope: String? = null, val roleOverrideValues: List<String>? = null)

NetworkFunction with no secrets.

Link copied to clipboard
data class NetworkFunctionValueWithSecretsResponse(val allowSoftwareUpdate: Boolean? = null, val configurationType: String, val networkFunctionDefinitionGroupName: String? = null, val networkFunctionDefinitionOfferingLocation: String? = null, val networkFunctionDefinitionVersion: String? = null, val networkFunctionDefinitionVersionResourceReference: Either<OpenDeploymentResourceReferenceResponse, SecretDeploymentResourceReferenceResponse>? = null, val nfviId: String? = null, val nfviType: String? = null, val provisioningState: String, val publisherName: String? = null, val publisherScope: String? = null, val roleOverrideValues: List<String>? = null)

NetworkFunction with secrets.

Link copied to clipboard
data class NetworkInterfaceIPConfigurationResponse(val dnsServers: List<String>? = null, val gateway: String? = null, val ipAddress: String? = null, val ipAllocationMethod: String? = null, val ipVersion: String? = null, val subnet: String? = null)

Network interface IP configuration properties.

Link copied to clipboard
data class NetworkInterfaceResponse(val ipConfigurations: List<NetworkInterfaceIPConfigurationResponse>? = null, val macAddress: String? = null, val networkInterfaceName: String? = null, val vmSwitchType: String? = null)

Network interface properties.

data class NetworkServiceDesignGroupPropertiesFormatResponse(val description: String? = null, val provisioningState: String)

network service design group properties.

data class NetworkServiceDesignVersionPropertiesFormatResponse(val configurationGroupSchemaReferences: Map<String, ReferencedResourceResponse>? = null, val description: String? = null, val nfvisFromSite: Map<String, NfviDetailsResponse>? = null, val provisioningState: String, val resourceElementTemplates: List<Either<ArmResourceDefinitionResourceElementTemplateDetailsResponse, NetworkFunctionDefinitionResourceElementTemplateDetailsResponse>>? = null, val versionState: String)

network service design version properties.

Link copied to clipboard
data class NfviDetailsResponse(val name: String? = null, val type: String? = null)

The nfvi details.

Link copied to clipboard
data class NSDArtifactProfileResponse(val artifactName: String? = null, val artifactStoreReference: ReferencedResourceResponse? = null, val artifactVersion: String? = null)

Artifact profile properties.

Link copied to clipboard
data class OpenDeploymentResourceReferenceResponse(val id: String? = null, val idType: String)

Non secret deployment resource id reference.

Link copied to clipboard
data class OsDiskResponse(val diskSizeGB: Int? = null, val name: String? = null, val osType: String? = null)

Specifies information about the operating system disk used by the virtual machine.

For more information about disks, see About disks and VHDs for Azure virtual machines.

Link copied to clipboard
data class OsProfileResponse(val adminUsername: String? = null, val customData: String? = null, val customDataRequired: Boolean? = null, val linuxConfiguration: LinuxConfigurationResponse? = null)

Specifies the operating system settings for the role instance.

Link copied to clipboard
data class PublisherPropertiesFormatResponse(val provisioningState: String, val scope: String? = null)

publisher properties.

Link copied to clipboard
data class ReferencedResourceResponse(val id: String? = null)

Reference to another resource.

Secret deployment resource id reference.

data class SiteNetworkServicePropertiesFormatResponse(val desiredStateConfigurationGroupValueReferences: Map<String, ReferencedResourceResponse>? = null, val lastStateConfigurationGroupValueReferences: Map<String, ReferencedResourceResponse>, val lastStateNetworkServiceDesignVersionName: String, val managedResourceGroupConfiguration: ManagedResourceGroupConfigurationResponse? = null, val networkServiceDesignGroupName: String, val networkServiceDesignVersionName: String, val networkServiceDesignVersionOfferingLocation: String, val networkServiceDesignVersionResourceReference: Either<OpenDeploymentResourceReferenceResponse, SecretDeploymentResourceReferenceResponse>? = null, val provisioningState: String, val publisherName: String, val publisherScope: String, val siteReference: ReferencedResourceResponse? = null)

Site network service properties.

Link copied to clipboard
data class SitePropertiesFormatResponse(val nfvis: List<Any>? = null, val provisioningState: String, val siteNetworkServiceReferences: List<ReferencedResourceResponse>)

Site properties.

Link copied to clipboard
data class SkuResponse(val name: String, val tier: String)

Sku, to be associated with a SiteNetworkService.

Link copied to clipboard
data class SshConfigurationResponse(val publicKeys: List<SshPublicKeyResponse>? = null)

SSH configuration for Linux based VMs running on Azure

Link copied to clipboard
data class SshPublicKeyResponse(val keyData: String? = null, val path: String? = null)

Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed.

Link copied to clipboard
data class StorageProfileResponse(val dataDisks: List<DataDiskResponse>? = null, val imageReference: ImageReferenceResponse? = null, val osDisk: OsDiskResponse? = null)

Specifies the storage settings for the virtual machine disks.

Link copied to clipboard
data class SubResourceResponse(val id: String? = null)

Reference to another sub resource.

Link copied to clipboard
data class SystemDataResponse(val createdAt: String? = null, val createdBy: String? = null, val createdByType: String? = null, val lastModifiedAt: String? = null, val lastModifiedBy: String? = null, val lastModifiedByType: String? = null)

Metadata pertaining to creation and last modification of the resource.

Link copied to clipboard
data class UserAssignedIdentityResponse(val clientId: String, val principalId: String)

User assigned identity properties

Link copied to clipboard
data class VhdImageArtifactProfileResponse(val vhdName: String? = null, val vhdVersion: String? = null)

Vhd artifact profile.

Link copied to clipboard
data class VhdImageMappingRuleProfileResponse(val userConfiguration: String? = null)

Vhd mapping rule profile

data class VirtualNetworkFunctionNetworkFunctionDefinitionVersionResponse(val deployParameters: String? = null, val description: String? = null, val networkFunctionTemplate: Either<AzureCoreNetworkFunctionTemplateResponse, AzureOperatorNexusNetworkFunctionTemplateResponse>? = null, val networkFunctionType: String, val provisioningState: String, val versionState: String)

Virtual network function network function definition version properties.