Workload Networks - Create Dns Service

Tjänst:

AVS

API-versionen:

2025-09-01

Skapa en WorkloadNetworkDnsService

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

URI-parametrar

Namn	I	Krävs	Typ	Beskrivning
dnsServiceId	path	True	string pattern: ^[-\w\._]+$	ID för DNS-tjänsten.
privateCloudName	path	True	string pattern: ^[-\w\._]+$	Namnet på det privata molnet
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
subscriptionId	path	True	string (uuid)	ID för målprenumerationen. Värdet måste vara ett UUID.
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.

Begäranarorgan

Namn	Typ	Beskrivning
properties.defaultDnsZone	string	DNS-standardzonen för DNS-tjänsten.
properties.displayName	string	Visningsnamn för DNS-tjänsten.
properties.dnsServiceIp	string	DNS-tjänstens IP-adress för DNS-tjänsten.
properties.fqdnZones	string[]	FQDN-zoner för DNS-tjänsten.
properties.logLevel	DnsServiceLogLevelEnum	DNS-tjänstloggnivå.
properties.revision	integer (int64)	NSX-revisionsnummer.

Svaren

Namn	Typ	Beskrivning
200 OK	WorkloadNetworkDnsService	Resursens 'WorkloadNetworkDnsService'-uppdateringsoperation lyckades
201 Created	WorkloadNetworkDnsService	Resursen 'WorkloadNetworkDnsService' skapade operationen lyckades Headers Retry-After: integer
Other Status Codes	ErrorResponse	Ett oväntat felsvar.

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde.

Typ: oauth2
Rinna: implicit
Auktorisations-URL: https://login.microsoftonline.com/common/oauth2/authorize

Scope

Namn	Beskrivning
user_impersonation	personifiera ditt användarkonto

Exempel

WorkloadNetworks_CreateDnsService

Exempelförfrågan

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

Exempelsvar

Statuskod:

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"
}

Statuskod:

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"
}

Definitioner

Namn	Beskrivning
createdByType	Den typ av identitet som skapade resursen.
DnsServiceLogLevelEnum	DNS-tjänsteloggnivå
DnsServiceStatusEnum	DNS-tjänststatus
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
systemData	Metadata som rör skapande och senaste ändring av resursen.
WorkloadNetworkDnsService	NSX DNS-tjänst
WorkloadNetworkDnsServiceProvisioningState	Arbetsbelastningsnätverkets DNS-tjänstprovisioneringstillstånd

createdByType

Uppräkning

Den typ av identitet som skapade resursen.

Värde	Beskrivning
User
Application
ManagedIdentity
Key

DnsServiceLogLevelEnum

Uppräkning

DNS-tjänsteloggnivå

Värde	Beskrivning
DEBUG	är felsökning
INFO	är information
WARNING	är varning
ERROR	är fel
FATAL	är dödlig

DnsServiceStatusEnum

Uppräkning

DNS-tjänststatus

Värde	Beskrivning
SUCCESS	är framgång
FAILURE	är misslyckande

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Namn	Typ	Beskrivning
info	object	Den ytterligare informationen.
type	string	Typen av ytterligare information.

ErrorDetail

Objekt

Felinformationen.

Namn	Typ	Beskrivning
additionalInfo	ErrorAdditionalInfo[]	Felet ytterligare information.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felet riktas.

ErrorResponse

Objekt

Felsvar

Namn	Typ	Beskrivning
error	ErrorDetail	Felet objektet.

systemData

Objekt

Metadata som rör skapande och senaste ändring av resursen.

Namn	Typ	Beskrivning
createdAt	string (date-time)	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string (date-time)	Tidsstämpeln för senaste ändring av resurs (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.

WorkloadNetworkDnsService

Objekt

NSX DNS-tjänst

Namn	Typ	Beskrivning
id	string (arm-id)	Fullständigt kvalificerat resurs-ID för resursen. Till exempel "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Namnet på resursen
properties.defaultDnsZone	string	DNS-standardzonen för DNS-tjänsten.
properties.displayName	string	Visningsnamn för DNS-tjänsten.
properties.dnsServiceIp	string	DNS-tjänstens IP-adress för DNS-tjänsten.
properties.fqdnZones	string[]	FQDN-zoner för DNS-tjänsten.
properties.logLevel	DnsServiceLogLevelEnum	DNS-tjänstloggnivå.
properties.provisioningState	WorkloadNetworkDnsServiceProvisioningState	Etableringstillståndet
properties.revision	integer (int64)	NSX-revisionsnummer.
properties.status	DnsServiceStatusEnum	DNS-tjänststatus.
systemData	systemData	Azure Resource Manager-metadata som innehåller createdBy och modifiedBy information.
type	string	Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

WorkloadNetworkDnsServiceProvisioningState

Uppräkning

Arbetsbelastningsnätverkets DNS-tjänstprovisioneringstillstånd

Värde	Beskrivning
Succeeded	Resursen har skapats.
Failed	Det gick inte att skapa resurser.
Canceled	Resursskapandet avbröts.
Building	håller på att byggas
Deleting	tar bort
Updating	uppdateras