Zones - Create Or Update

リファレンス

Service:: DNS

API Version:: 2018-05-01

DNS ゾーンを作成または更新します。ゾーン内の DNS レコードは変更しません。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones/{zoneName}?api-version=2018-05-01

URI パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string	リソースグループの名前。
subscriptionId	path	True	string	Microsoft Azure サブスクリプションを一意に識別する Azure サブスクリプション ID を指定します。
zoneName	path	True	string	DNS ゾーンの名前 (終了ドットなし)。
api-version	query	True	string	API バージョンを指定します。

要求ヘッダー

名前	必須	型	説明
If-Match		string	DNS ゾーンの etag。現在のゾーンを常に上書きするには、この値を省略します。同時変更が誤って上書きされないように、最後に表示される etag 値を指定します。
If-None-Match		string	新しい DNS ゾーンの作成を許可するが、既存のゾーンを更新できないようにするには、'*' に設定します。その他の値は無視されます。

要求本文

名前	必須	型	説明
location	True	string	リソースの場所。
etag		string	ゾーンの etag。
properties.registrationVirtualNetworks		SubResource[]	この DNS ゾーンにホスト名を登録する仮想ネットワークへの参照の一覧。これは、ZoneType が Private の場合にのみです。
properties.resolutionVirtualNetworks		SubResource[]	この DNS ゾーン内のレコードを解決する仮想ネットワークへの参照の一覧。これは、ZoneType が Private の場合にのみです。
properties.zoneType		ZoneType	この DNS ゾーンの種類 (パブリックまたはプライベート)。
tags		object	リソースタグ。

応答

名前	型	説明
200 OK	Zone	DNS ゾーンが更新されました。
201 Created	Zone	DNS ゾーンが作成されました。
Other Status Codes	CloudError	既定の応答。エラー定義に従って逆シリアル化されます。

例

Create zone

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/dnsZones/zone1?api-version=2018-05-01

{
  "location": "Global",
  "tags": {
    "key1": "value1"
  }
}


import com.azure.resourcemanager.dns.fluent.models.ZoneInner;
import java.util.HashMap;
import java.util.Map;

/** Samples for Zones CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/dns/resource-manager/Microsoft.Network/stable/2018-05-01/examples/CreateOrUpdateZone.json
     */
    /**
     * Sample code: Create zone.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createZone(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.dnsZones().manager().serviceClient().getZones().createOrUpdateWithResponse("rg1", "zone1",
            new ZoneInner().withLocation("Global").withTags(mapOf("key1", "fakeTokenPlaceholder")), null, null,
            com.azure.core.util.Context.NONE);
    }

    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

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

from azure.identity import DefaultAzureCredential
from azure.mgmt.dns import DnsManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-dns
# USAGE
    python create_or_update_zone.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 = DnsManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.zones.create_or_update(
        resource_group_name="rg1",
        zone_name="zone1",
        parameters={"location": "Global", "tags": {"key1": "value1"}},
    )
    print(response)


# x-ms-original-file: specification/dns/resource-manager/Microsoft.Network/stable/2018-05-01/examples/CreateOrUpdateZone.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

package armdns_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/dns/armdns"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c767823fdfd9d5e96bad245e3ea4d14d94a716bb/specification/dns/resource-manager/Microsoft.Network/stable/2018-05-01/examples/CreateOrUpdateZone.json
func ExampleZonesClient_CreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdns.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewZonesClient().CreateOrUpdate(ctx, "rg1", "zone1", armdns.Zone{
		Location: to.Ptr("Global"),
		Tags: map[string]*string{
			"key1": to.Ptr("value1"),
		},
	}, &armdns.ZonesClientCreateOrUpdateOptions{IfMatch: nil,
		IfNoneMatch: nil,
	})
	if err != nil {
		log.Fatalf("failed to finish the request: %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.Zone = armdns.Zone{
	// 	Name: to.Ptr("zone1"),
	// 	Type: to.Ptr("Microsoft.Network/dnsZones"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/dnsZones/zone1"),
	// 	Location: to.Ptr("global"),
	// 	Tags: map[string]*string{
	// 		"key1": to.Ptr("value1"),
	// 	},
	// 	Etag: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 	Properties: &armdns.ZoneProperties{
	// 		MaxNumberOfRecordSets: to.Ptr[int64](5000),
	// 		NameServers: []*string{
	// 			to.Ptr("ns1-01.azure-dns.com"),
	// 			to.Ptr("ns2-01.azure-dns.net"),
	// 			to.Ptr("ns3-01.azure-dns.org"),
	// 			to.Ptr("ns4-01.azure-dns.info")},
	// 			NumberOfRecordSets: to.Ptr[int64](2),
	// 			ZoneType: to.Ptr(armdns.ZoneTypePublic),
	// 		},
	// 	}
}

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

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

/**
 * This sample demonstrates how to Creates or updates a DNS zone. Does not modify DNS records within the zone.
 *
 * @summary Creates or updates a DNS zone. Does not modify DNS records within the zone.
 * x-ms-original-file: specification/dns/resource-manager/Microsoft.Network/stable/2018-05-01/examples/CreateOrUpdateZone.json
 */
async function createZone() {
  const subscriptionId = "subid";
  const resourceGroupName = "rg1";
  const zoneName = "zone1";
  const parameters = { location: "Global", tags: { key1: "value1" } };
  const credential = new DefaultAzureCredential();
  const client = new DnsManagementClient(credential, subscriptionId);
  const result = await client.zones.createOrUpdate(resourceGroupName, zoneName, parameters);
  console.log(result);
}

createZone().catch(console.error);

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

Sample Response

Status code:: 200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/dnsZones/zone1",
  "etag": "00000000-0000-0000-0000-000000000000",
  "location": "global",
  "name": "zone1",
  "type": "Microsoft.Network/dnsZones",
  "properties": {
    "maxNumberOfRecordSets": 5000,
    "numberOfRecordSets": 2,
    "nameServers": [
      "ns1-01.azure-dns.com",
      "ns2-01.azure-dns.net",
      "ns3-01.azure-dns.org",
      "ns4-01.azure-dns.info"
    ],
    "zoneType": "Public"
  },
  "tags": {
    "key1": "value1"
  }
}

Status code:: 201

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/dnsZones/zone1",
  "etag": "00000000-0000-0000-0000-000000000000",
  "location": "global",
  "name": "zone1",
  "type": "Microsoft.Network/dnsZones",
  "properties": {
    "maxNumberOfRecordSets": 5000,
    "numberOfRecordSets": 2,
    "nameServers": [
      "ns1-01.azure-dns.com",
      "ns2-01.azure-dns.net",
      "ns3-01.azure-dns.org",
      "ns4-01.azure-dns.info"
    ],
    "zoneType": "Public"
  },
  "tags": {
    "key1": "value1"
  }
}

定義

名前	説明
CloudError	サービスからのエラー応答。
CloudErrorBody	サービスからのエラー応答。
SubResource	別のリソースへの参照
Zone	DNS ゾーンについて説明します。
ZoneType	この DNS ゾーンの種類 (パブリックまたはプライベート)。

CloudError

サービスからのエラー応答。

名前	型	説明
error	CloudErrorBody	クラウドエラー本文。

CloudErrorBody

サービスからのエラー応答。

名前	型	説明
code	string	エラーの識別子。コードは不変であり、プログラムによって使用されることを意図しています。
details	CloudErrorBody[]	エラーに関するその他の詳細の一覧。
message	string	ユーザーインターフェイスでの表示に適したエラーを説明するメッセージ。
target	string	特定のエラーのターゲット。たとえば、エラーが発生したプロパティの名前です。

SubResource

別のリソースへの参照

名前	型	説明
id	string	リソース ID。

Zone

DNS ゾーンについて説明します。

名前	型	既定値	説明
etag	string		ゾーンの etag。
id	string		リソースの ID
location	string		リソースの場所。
name	string		リソース名。
properties.maxNumberOfRecordSets	integer		この DNS ゾーンに作成できるレコードセットの最大数。これは読み取り専用プロパティであり、この値を設定しようとすると無視されます。
properties.maxNumberOfRecordsPerRecordSet	integer		この DNS ゾーンに作成できるレコードセットあたりのレコードの最大数。これは読み取り専用プロパティであり、この値を設定しようとすると無視されます。
properties.nameServers	string[]		この DNS ゾーンのネームサーバー。これは読み取り専用プロパティであり、この値を設定しようとすると無視されます。
properties.numberOfRecordSets	integer		この DNS ゾーン内のレコードセットの現在の数。これは読み取り専用プロパティであり、この値を設定しようとすると無視されます。
properties.registrationVirtualNetworks	SubResource[]		この DNS ゾーンにホスト名を登録する仮想ネットワークへの参照の一覧。これは、ZoneType が Private の場合にのみです。
properties.resolutionVirtualNetworks	SubResource[]		この DNS ゾーン内のレコードを解決する仮想ネットワークへの参照の一覧。これは、ZoneType が Private の場合にのみです。
properties.zoneType	ZoneType	Public	この DNS ゾーンの種類 (パブリックまたはプライベート)。
tags	object		リソースタグ。
type	string		リソースの種類。

ZoneType

この DNS ゾーンの種類 (パブリックまたはプライベート)。

名前	型	説明
Private	string
Public	string

Zones - Create Or Update

URI パラメーター

要求ヘッダー

要求本文

応答

例

Create zone

Sample Request

Sample Response

定義

CloudError

CloudErrorBody

SubResource

Zone

ZoneType

その他のリソース