Workload Networks - Create Dns Service

Serviço:

AVS

Versão API:

2025-09-01

Criar um WorkloadNetworkDnsService

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsServices/{dnsServiceId}?api-version=2025-09-01

Parâmetros URI

Nome	Em	Necessário	Tipo	Descrição
dnsServiceId	path	True	string pattern: ^[-\w\._]+$	ID do serviço DNS.
privateCloudName	path	True	string pattern: ^[-\w\._]+$	Nome da nuvem privada
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser um UUID.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Órgão do Pedido

Nome	Tipo	Descrição
properties.defaultDnsZone	string	Zona DNS padrão do Serviço DNS.
properties.displayName	string	Nome para exibição do serviço DNS.
properties.dnsServiceIp	string	IP do serviço DNS do serviço DNS.
properties.fqdnZones	string[]	Zonas FQDN do Serviço DNS.
properties.logLevel	DnsServiceLogLevelEnum	Nível de log do Serviço DNS.
properties.revision	integer (int64)	Número de revisão NSX.

Respostas

Nome	Tipo	Descrição
200 OK	WorkloadNetworkDnsService	Operação de atualização do recurso 'WorkloadNetworkDnsService' bem-sucedida
201 Created	WorkloadNetworkDnsService	Recurso 'WorkloadNetworkDnsService' criar operação bem-sucedida Cabeçalhos Retry-After: integer
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de autorização: https://login.microsoftonline.com/common/oauth2/authorize

Alcances

Nome	Descrição
user_impersonation	personificar a sua conta de utilizador

Exemplos

WorkloadNetworks_CreateDnsService

Pedido de exemplo

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/workloadNetworks/default/dnsServices/dnsService1?api-version=2025-09-01

{
  "properties": {
    "displayName": "dnsService1",
    "dnsServiceIp": "5.5.5.5",
    "defaultDnsZone": "defaultDnsZone1",
    "fqdnZones": [
      "fqdnZone1"
    ],
    "logLevel": "INFO",
    "revision": 1
  }
}

Java

import com.azure.resourcemanager.avs.models.DnsServiceLogLevelEnum;
import java.util.Arrays;

/**
 * Samples for WorkloadNetworks CreateDnsService.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-09-01/WorkloadNetworks_CreateDnsService.json
     */
    /**
     * Sample code: WorkloadNetworks_CreateDnsService.
     * 
     * @param manager Entry point to AvsManager.
     */
    public static void workloadNetworksCreateDnsService(com.azure.resourcemanager.avs.AvsManager manager) {
        manager.workloadNetworks().defineDnsService("dnsService1").withExistingPrivateCloud("group1", "cloud1")
            .withDisplayName("dnsService1").withDnsServiceIp("5.5.5.5").withDefaultDnsZone("defaultDnsZone1")
            .withFqdnZones(Arrays.asList("fqdnZone1")).withLogLevel(DnsServiceLogLevelEnum.INFO).withRevision(1L)
            .create();
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.avs import AVSClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-avs
# USAGE
    python workload_networks_create_dns_service.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = AVSClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.workload_networks.begin_create_dns_service(
        resource_group_name="group1",
        private_cloud_name="cloud1",
        dns_service_id="dnsService1",
        workload_network_dns_service={
            "properties": {
                "defaultDnsZone": "defaultDnsZone1",
                "displayName": "dnsService1",
                "dnsServiceIp": "5.5.5.5",
                "fqdnZones": ["fqdnZone1"],
                "logLevel": "INFO",
                "revision": 1,
            }
        },
    ).result()
    print(response)


# x-ms-original-file: 2025-09-01/WorkloadNetworks_CreateDnsService.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armavs_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/avs/armavs/v2"
)

// Generated from example definition: 2025-09-01/WorkloadNetworks_CreateDnsService.json
func ExampleWorkloadNetworksClient_BeginCreateDNSService() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armavs.NewClientFactory("00000000-0000-0000-0000-000000000000", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewWorkloadNetworksClient().BeginCreateDNSService(ctx, "group1", "cloud1", "dnsService1", armavs.WorkloadNetworkDNSService{
		Properties: &armavs.WorkloadNetworkDNSServiceProperties{
			DisplayName:    to.Ptr("dnsService1"),
			DNSServiceIP:   to.Ptr("5.5.5.5"),
			DefaultDNSZone: to.Ptr("defaultDnsZone1"),
			FqdnZones: []*string{
				to.Ptr("fqdnZone1"),
			},
			LogLevel: to.Ptr(armavs.DNSServiceLogLevelEnumINFO),
			Revision: to.Ptr[int64](1),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armavs.WorkloadNetworksClientCreateDNSServiceResponse{
	// 	WorkloadNetworkDNSService: &armavs.WorkloadNetworkDNSService{
	// 		ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/workloadNetworks/default/dnsServices/dnsService1"),
	// 		Name: to.Ptr("dnsService1"),
	// 		Properties: &armavs.WorkloadNetworkDNSServiceProperties{
	// 			DisplayName: to.Ptr("dnsService1"),
	// 			DNSServiceIP: to.Ptr("5.5.5.5"),
	// 			DefaultDNSZone: to.Ptr("defaultDnsZone1"),
	// 			FqdnZones: []*string{
	// 				to.Ptr("fqdnZone1"),
	// 			},
	// 			LogLevel: to.Ptr(armavs.DNSServiceLogLevelEnumINFO),
	// 			Status: to.Ptr(armavs.DNSServiceStatusEnumSUCCESS),
	// 			Revision: to.Ptr[int64](1),
	// 		},
	// 		Type: to.Ptr("Microsoft.AVS/privateClouds/workloadNetworks/dnsServices"),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { AzureVMwareSolutionAPI } = require("@azure/arm-avs");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to create a WorkloadNetworkDnsService
 *
 * @summary create a WorkloadNetworkDnsService
 * x-ms-original-file: 2025-09-01/WorkloadNetworks_CreateDnsService.json
 */
async function workloadNetworksCreateDnsService() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const client = new AzureVMwareSolutionAPI(credential, subscriptionId);
  const result = await client.workloadNetworks.createDnsService("group1", "cloud1", "dnsService1", {
    properties: {
      displayName: "dnsService1",
      dnsServiceIp: "5.5.5.5",
      defaultDnsZone: "defaultDnsZone1",
      fqdnZones: ["fqdnZone1"],
      logLevel: "INFO",
      revision: 1,
    },
  });
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Resposta de exemplo

Código de estado:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/workloadNetworks/default/dnsServices/dnsService1",
  "name": "dnsService1",
  "properties": {
    "displayName": "dnsService1",
    "dnsServiceIp": "5.5.5.5",
    "defaultDnsZone": "defaultDnsZone1",
    "fqdnZones": [
      "fqdnZone1"
    ],
    "logLevel": "INFO",
    "status": "SUCCESS",
    "revision": 1
  },
  "type": "Microsoft.AVS/privateClouds/workloadNetworks/dnsServices"
}

Código de estado:

201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/workloadNetworks/default/dnsServices/dnsService1",
  "name": "dnsService1",
  "properties": {
    "displayName": "dnsService1",
    "dnsServiceIp": "5.5.5.5",
    "defaultDnsZone": "defaultDnsZone1",
    "fqdnZones": [
      "fqdnZone1"
    ],
    "logLevel": "INFO",
    "status": "SUCCESS",
    "revision": 1
  },
  "type": "Microsoft.AVS/privateClouds/workloadNetworks/dnsServices"
}

Definições

Nome	Descrição
createdByType	O tipo de identidade que criou o recurso.
DnsServiceLogLevelEnum	Nível do registo do serviço DNS
DnsServiceStatusEnum	Estado do serviço DNS
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
systemData	Metadados referentes à criação e última modificação do recurso.
WorkloadNetworkDnsService	Serviço DNS NSX
WorkloadNetworkDnsServiceProvisioningState	Estado do provisionamento do Serviço DNS de Rede de Carga de Trabalho

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Descrição
User
Application
ManagedIdentity
Key

DnsServiceLogLevelEnum

Enumeração

Nível do registo do serviço DNS

Valor	Descrição
DEBUG	é debug
INFO	é informação
WARNING	está a avisar
ERROR	é erro
FATAL	é fatal

DnsServiceStatusEnum

Enumeração

Estado do serviço DNS

Valor	Descrição
SUCCESS	é sucesso
FAILURE	é o fracasso

ErrorAdditionalInfo

Objetivo

O erro de gerenciamento de recursos informações adicionais.

Nome	Tipo	Descrição
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objetivo

O detalhe do erro.

Nome	Tipo	Descrição
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objetivo

Resposta de erro

Nome	Tipo	Descrição
error	ErrorDetail	O objeto de erro.

systemData

Objetivo

Metadados referentes à criação e última modificação do recurso.

Nome	Tipo	Descrição
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

WorkloadNetworkDnsService

Objetivo

Serviço DNS NSX

Nome	Tipo	Descrição
id	string (arm-id)	ID de recurso totalmente qualificado para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	O nome do recurso
properties.defaultDnsZone	string	Zona DNS padrão do Serviço DNS.
properties.displayName	string	Nome para exibição do serviço DNS.
properties.dnsServiceIp	string	IP do serviço DNS do serviço DNS.
properties.fqdnZones	string[]	Zonas FQDN do Serviço DNS.
properties.logLevel	DnsServiceLogLevelEnum	Nível de log do Serviço DNS.
properties.provisioningState	WorkloadNetworkDnsServiceProvisioningState	O estado de provisionamento
properties.revision	integer (int64)	Número de revisão NSX.
properties.status	DnsServiceStatusEnum	Estado do serviço DNS.
systemData	systemData	Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

WorkloadNetworkDnsServiceProvisioningState

Enumeração

Estado do provisionamento do Serviço DNS de Rede de Carga de Trabalho

Valor	Descrição
Succeeded	O recurso foi criado.
Failed	Falha na criação de recursos.
Canceled	A criação de recursos foi cancelada.
Building	está a construir
Deleting	está a eliminar
Updating	está a atualizar