Azure HDInsight のクラスター REST API

作成

指定したサブスクリプションにクラスターを作成します。

要求

クラスターで使用される ヘッダーとパラメーター については、「共通パラメーターとヘッダー」を参照してください。

Method	要求 URI
PUT	https://management.azure.com/subscriptions/{subscription Id}/resourceGroups/{resourceGroup Name}/providers/Microsoft.HDInsight/clusters/{cluster name}?api-version={api-version}

次の例は、Linux ベースの hadoop クラスターを作成するための要求本文を示しています。 他の方法でクラスターを作成する例については、以下の「例」セクションを参照してください。

{  
    "id":"/subscriptions/{subscription-id}/resourceGroups/myresourcegroup1/providers/Microsoft.HDInsight/clusters/mycluster",  
  "name":"mycluster",   
  "type":"Microsoft.HDInsight/clusters",  
  
    "location": "location-name",  
    "tags": { "tag1": "value1", "tag2": "value2" },  
    "properties": {  
        "clusterVersion": "3.2",  
        "osType": "Linux",  
        "clusterDefinition": {  
            "kind": "hadoop",  
  
            "configurations": {  
                "gateway": {  
                    "restAuthCredential.isEnabled": true,  
                    "restAuthCredential.username": "http-user",  
                    "restAuthCredential.password": "password"  
                },  
  
                "core-site": {  
                    "fs.defaultFS": "wasb://container@storageaccount.blob.core.windows.net",  
                    "fs.azure.account.key.storageaccount.blob.core.windows.net": storage-account-key"  
                }  
            }  
        },
  
        "computeProfile": {  
            "roles": [  
                {  
                    "name": "headnode",  
  
                    "targetInstanceCount": 2,  
  
                    "hardwareProfile": {  
                        "vmSize": "Large"  
                    },  
  
                    "osProfile": {  
                        "linuxOperatingSystemProfile": {  
                            "username": "username",  
                            "sshProfile": {  
                                "publicKeys": [   
                                    { "certificateData": "ssh-rsa key" }  
                                ]  
                            }  
                        }  
                    }  
                },  
                {  
                    "name": "workernode",  
  
                    "targetInstanceCount": 1,  
  
                    "hardwareProfile": {  
                        "vmSize": "Large"  
                    },  
  
                    "osProfile": {  
                        "linuxOperatingSystemProfile": {  
                            "username": "username",  
                            "sshProfile": {  
                                "publicKeys": [  
                                    { "certificateData": " ssh-rsa key" }  
                                ]  
                            }  
                        }  
                    }  
                },  
                {  
                    "name": "zookeepernode",  
  
                    "targetInstanceCount": 3,  
  
                    "hardwareProfile": {  
                        "vmSize": "Small"  
                    },  
  
                    "osProfile": {  
                        "linuxOperatingSystemProfile": {  
                            "username": "username",  
                            "sshProfile": {  
                                "publicKeys": [   
                                    { "certificateData": "ssh-rsa key" }  
                                ]  
                            }  
                        }  
                    }  
                }  
            ]  
        }  
    }  
}  
  

要素名	必須	型	説明
id	はい	文字列	クラスターのリソース識別子を指定します。
name	はい	文字列	クラスターの名前を指定します。
type	はい	文字列	クラスターの種類を指定します。
location	はい	文字列	クラスターを作成する必要がある、サポートされている Azure の場所を指定します。 詳細については、「 使用可能なすべての地域の場所を一覧表示する」を参照してください。
tags	いいえ	文字列	クラスターに割り当てるタグを指定します。 タグの使用の詳細については、「タグ を使用して Azure リソースを整理する」を参照してください。
プロパティ	はい	複合型	クラスターのプロパティを指定します。

プロパティ

要素名	必須	型	説明
clusterVersion	はい	文字列	クラスターのバージョンを指定します
osType	はい	文字列	クラスターのオペレーティング システムを指定します。 有効な値は Linux と Windows です
clusterDefinition	Yes	複合型	クラスターの種類と構成に関する情報を指定します
computeProfile	Yes	複合型	クラスター トポロジと関連するロール プロパティに関する情報を指定します

clusterDefinition

要素名	必須	型	説明
kind	はい	文字列	クラスターの種類を指定します。 有効な値は、hadoop、hbase、storm & spark です
configuration	はい	Dictionary	この要素は、構成の種類とその関連する値ディクショナリのディクショナリです。 ゲートウェイ構成の種類は、Web API と Ambari ポータルへの接続に使用される http ユーザーを構成するために使用されます コア サイト構成の種類は、クラスターの既定のストレージ アカウントを構成するために使用されます

computeProfile

要素名	必須	型	説明
clusterVersion	はい	文字列	クラスターのバージョンを指定します
role	Yes	複合型の配列 (ロール)	クラスター内のロールに関する情報を指定します

role

要素名	必須	型	説明
name	はい	文字列	ロール名を指定します
targetInstanceCount	はい	Integer	ロールのターゲット インスタンス数を指定します
hardwareProfile	Yes	複合型	ロールのハードウェア プロファイルに関する情報を指定します
osProfile	Yes	複合型	ロールの os プロファイルに関する情報を指定します

hardwareProfile

要素名	必須	型	説明
vmSize	はい	文字列	VM のサイズを指定します。 有効なサイズについては、 HDInsight 構成オプション (このリンクで 1 回、 Node 価格レベルまで下にスクロール) を参照してください

osProfile

要素名	必須	型	説明
linuxOperatingSystemProfile	いいえ	複合型	Linux OS 関連の設定を指定します
windowsOperatingSystemProfile	いいえ	複合型	Windows OS 関連の設定を指定します
virtualNetworkProfile	いいえ	複合型	クラスターがユーザーのサブスクリプション内の仮想ネットワークにデプロイされている場合に、仮想ネットワーク関連の設定を指定します
scriptActions	いいえ	複合型の配列	クラスターで実行するスクリプト アクションの一覧

linuxOperatingSystemProfile

要素名	必須	型	説明
ユーザー名	はい	文字列	SSH ユーザー名
sshProfile	いいえ	複合型	SSH キーを指定します。 sshProfile または Password のいずれかが必要です。
Password	いいえ	文字列	SSH パスワードを指定します sshProfile または Password のいずれかが必要です。

sshProfile

要素名	必須	型	説明
publicKeys	はい	Array	certificateData オブジェクトの一覧が含まれます。 値は ssh-rsa 公開キーです

windowsOperatingSystemProfile

要素名	必須	型	説明
rdpSettings	いいえ	複合型	Windows クラスターの RDP 設定を指定します

rdpSettings

要素名	必須	型	説明
username	はい	文字列	RDP ユーザー名を指定します
password	はい	文字列	RDP ユーザーのパスワードを指定します
expiryDate	はい	Date	RDP 資格情報の有効期限

virtualNetworkProfile

要素名	必須	型	説明
id	はい	文字列	Virtual Network リソース ID
サブネット	はい	文字列	サブネット名を指定します

scriptActions

要素名	必須	型	説明
name	はい	文字列	スクリプト アクションのフレンドリ名
uri	はい	文字列	スクリプト アクション ファイルの URL
parameters	いいえ	文字列	スクリプト アクション ファイルの実行時に渡す引数

Response

検証が完了し、要求が受け入れられた場合、操作は 200 (OK) を返します。

状態コード: 200 OK

Linux クラスターの応答本文は、ssh キーを使用して作成します。

{  
    "id":"/subscriptions/{subscription-id}/resourceGroups/myresourcegroup1/providers/Microsoft.HDInsight/clusters/mycluster",  
  "name":"mycluster",   
  "type":"Microsoft.HDInsight/clusters",  
  
    "location": "location-name",  
    "tags": { "tag1": "value1", "tag2": "value2" },  
    "properties": {  
        "clusterVersion": "3.2",  
        "osType": "Linux",  
		"provisioningState": "InProgress",  
		"clusterState": "Accepted",  
		"createdDate": "2015-09-23",  
		"quotaInfo": {  
			"coresUsed": 20  
}  
        "clusterDefinition": {  
            "kind": "hadoop"  
        },  
  
        "computeProfile": {  
            "roles": [  
                {  
                    "name": "headnode",  
  
                    "targetInstanceCount": 2,  
  
                    "hardwareProfile": {  
                        "vmSize": "Large"  
                    }  
  
                },  
                {  
                    "name": "workernode",  
  
                    "targetInstanceCount": 1,  
  
                    "hardwareProfile": {  
                        "vmSize": "Large"  
                    }  
                },  
                {  
                    "name": "zookeepernode",  
  
                    "targetInstanceCount": 3,  
  
                    "hardwareProfile": {  
                        "vmSize": "Small"  
                    }  
                }  
            ]  
        }  
    }  
}  
  

要素名	Type	説明
provisioningState	文字列	現在のプロビジョニング状態を示します。
clusterState	文字列	プロビジョニングの進行中の HDInsight クラスターの詳細な状態を示します。
createdDate	Date	クラスター作成要求を受信した日時
quotaInfo	複合型	クラスターによって使用されるコアを指定します
エラー	エラー メッセージの配列	provisioningState = 'failed" の場合のエラー メッセージが含まれます
connectivityEndpoints	複合型	クラスターのパブリック エンドポイントを指定します

connectivityEndpoints

要素名	Type	説明
name	String	接続エンドポイントのフレンドリ名
protocol	String	使用するプロトコルを指定します (例: HTTPS、SSH)
location	文字列	接続する URL を指定します
port	INT	接続するポートを指定します

Premium ドメイン参加済み HDInsight クラスターを作成する (Linux のみ、プレビュー)

Apache Ranger を使用して Premium ドメイン参加済みクラスターを作成します。 セキュリティで保護されたクラスターを作成するには、ユーザーが要求本文で SecurityProfile を指定する必要があります。

要求

クラスターで使用される ヘッダーとパラメーター については、「共通のパラメーターとヘッダー」を参照してください。

Method	要求 URI
PUT	https://management.azure.com/subscriptions/{subscription Id}/resourceGroups/{resourceGroup Name}/providers/Microsoft.HDInsight/clusters/{cluster name}?api-version={api-version}

次の例は、Linux ベースの Premium ドメイン参加 Hadoop クラスターを作成するための要求本文を示しています。

{
	"id": "/subscriptions/{ subscription-id }/resourceGroups/myresourcegroup1/providers/Microsoft.HDInsight/ clusters/mycluster ", "
	name "
	: "mycluster",
	"type": "Microsoft.HDInsight/clusters",
	"location": "location-name",
	"tags": {
		"tag1": "value1",
		"tag2": "value2"
	},
	"properties": {
		"clusterVersion": "3.5",
		"osType": "Linux",
		"tier": "premium",
		"clusterDefinition": {
			"kind": "hadoop",
			"configurations": {
				"gateway": {
					"restAuthCredential.isEnabled": true,
					"restAuthCredential.username": "http-user",
					"restAuthCredential.password": "password"
				},
				"core-site": {
					"fs.defaultFS": "wasb://container@storageaccount.blob.core.windows.net",
					"fs.azure.account.key.storageaccount.blob.core.windows.net": "storage-account-key"
				}
			}
		},
		"securityProfile": {
			"directoryType": "ActiveDirectory",
			"domain": "mydomain.com",
			"organizationalUnitDN": "OU=Hadoop,DC=mydomain,DC=COM",
			"ldapsUrls": ["ldaps://mydomain.com:636"],
			"domainUsername": "clusteradmin@mydomain.com",
			"domainUserPassword": "password",
			"clusterUsersGroupDNs": ["ADGroup1", "ADGroup2"]
		},
		"computeProfile": {
			"roles": [
				{
					"name": "headnode",
					"targetInstanceCount": 2,
					"hardwareProfile": {
						"vmSize": "Large"
					},
					"osProfile": {
						"linuxOperatingSystemProfile": {
							"username": "username",
							"sshProfile": {
								"publicKeys": [
									{
										"certificateData": "ssh-rsa key"
									}
								]
							}
						}
					},
					"virtualNetworkProfile": {
						"id": "/subscriptions/mysubscriptionid/resourceGroups/myrresourcegroup/providers/Microsoft.Network/virtualNetworks/myvirtualnetwork",
						"subnet": "/subscriptions/mysubscriptionid /resourceGroups/myresourcegroup/providers/Microsoft.Network/virtualNetworks/myvirtualnetwork/subnets/mysubnet"
					}
				},
				{
					"name": "workernode",
					"targetInstanceCount": 1,
					"hardwareProfile": {
						"vmSize": "Large"
					},
					"osProfile": {
						"linuxOperatingSystemProfile": {
							"username": "username",
							"sshProfile": {
								"publicKeys": [
									{
										"certificateData": " ssh-rsa key"
									}
								]
							}
						}
					},
					"virtualNetworkProfile": {
						"id": "/subscriptions/mysubscriptionid/resourceGroups/myrresourcegroup/providers/Microsoft.Network/virtualNetworks/myvirtualnetwork",
						"subnet": "/subscriptions/mysubscriptionid /resourceGroups/myresourcegroup/providers/Microsoft.Network/virtualNetworks/myvirtualnetwork/subnets/mysubnet"
					}
				},
				{
					"name": "zookeepernode",
					"targetInstanceCount": 3,
					"hardwareProfile": {
						"vmSize": "Small"
					},
					"osProfile": {
						"linuxOperatingSystemProfile": {
							"username": "username",
							"sshProfile": {
								"publicKeys": [
									{
										"certificateData": "ssh-rsa key"
									}
								]
							}
						},
						"virtualNetworkProfile": {
							"id": "/subscriptions/mysubscriptionid/resourceGroups/myrresourcegroup/providers/Microsoft.Network/virtualNetworks/myvirtualnetwork",
							"subnet": "/subscriptions/mysubscriptionid /resourceGroups/myresourcegroup/providers/Microsoft.Network/virtualNetworks/myvirtualnetwork/subnets/mysubnet"
						}
					}
				}
			]
		}
	}
}  
  

要素名	必須	型	説明
id	はい	文字列	クラスターのリソース識別子を指定します。
name	はい	文字列	クラスターの名前を指定します。
type	はい	文字列	クラスターの種類を指定します。
location	はい	文字列	クラスターを作成する必要がある、サポートされている Azure の場所を指定します。 詳細については、「 使用可能なすべての地域の場所を一覧表示する」を参照してください。
tags	いいえ	文字列	クラスターに割り当てるタグを指定します。 タグの使用の詳細については、「タグ を使用して Azure リソースを整理する」を参照してください。
プロパティ	はい	複合型	クラスターのプロパティを指定します。

プロパティ

要素名	必須	型	説明
clusterVersion	はい	文字列	クラスターのバージョンを指定します
osType	はい	文字列	クラスターのオペレーティング システムを指定します。 Azure AD ドメインに参加できるのは Linux クラスターの種類だけなので、有効な値は Linux です。
レベル	いいえ	文字列	既定値は standard です。 有効な値は 、Standard と Premium です。 値が指定されていない場合、値は 標準と見なされます。 クラスターの階層を指定します。 ドメイン参加済みクラスターは Premium レベルでのみサポートされます
clusterDefinition	Yes	複合型	クラスターの種類と構成に関する情報を指定します
computeProfile	Yes	複合型	クラスター トポロジと関連するロール プロパティに関する情報を指定します
securityProfile	いいえ	複合型	セキュリティで保護されたドメイン参加済みクラスターを作成する場合、この要素は Active Directory 関連の設定を指定します

clusterDefinition

要素名	必須	型	説明
kind	はい	文字列	クラスターの種類を指定します。 有効な値は hadoop、hbase、storm & spark です
configuration	はい	Dictionary	この要素は、構成の種類とそれに関連付けられている値ディクショナリのディクショナリです。 ゲートウェイ構成の種類は、Web API と Ambari ポータルへの接続に使用される http ユーザーを構成するために使用されます core-site 構成の種類は、クラスターの既定のストレージ アカウントを構成するために使用されます

computeProfile

要素名	必須	型	説明
clusterVersion	はい	文字列	クラスターのバージョンを指定します
role	Yes	複合型の配列 (ロール)	クラスター内のロールに関する情報を指定します

securityProfile

要素名	必須	型	説明
directoryType	はい	文字列	使用される LDAP ディレクトリの種類。 現在、サポートされている値は "ActiveDirectory" のみです。
domain	はい	文字列	クラスターの Active Directory ドメイン
organizationalUnitDN	はい	文字列	ユーザーアカウントとコンピューター アカウントが作成される Active Directory 内の組織単位の識別名
ldapsUrls	Yes	文字列の配列	Active Directory の 1 つまたは複数の LDAPS サーバーの URL
domainUserName	はい	文字列	クラスターを作成するための十分なアクセス許可を持つドメイン ユーザー アカウント。 user@domain形式にする必要があります
domainUserPassword	はい	文字列	ドメイン ユーザー アカウントのパスワード
clusterUsersGroupDNS	いいえ	文字列の配列	Ambari と Apache Ranger で使用できる Active Directory グループの識別名

role

要素名	必須	型	説明
name	はい	文字列	ロール名を指定します
targetInstanceCount	はい	Integer	ロールのターゲット インスタンス数を指定します
hardwareProfile	Yes	複合型	ロールのハードウェア プロファイルに関する情報を指定します
osProfile	Yes	複合型	ロールの os プロファイルに関する情報を指定します

hardwareProfile

要素名	必須	型	説明
vmSize	はい	文字列	VM のサイズを指定します。 有効なサイズについては、 HDInsight 構成オプション (このリンクで 1 回、 Node 価格レベルまで下にスクロール) を参照してください

osProfile

要素名	必須	型	説明
linuxOperatingSystemProfile	いいえ	複合型	Linux OS 関連の設定を指定します
virtualNetworkProfile	いいえ	複合型	クラスターがユーザーのサブスクリプション内の仮想ネットワークにデプロイされている場合に、仮想ネットワーク関連の設定を指定します
scriptActions	いいえ	複合型の配列	クラスターで実行するスクリプト アクションの一覧

linuxOperatingSystemProfile

要素名	必須	型	説明
ユーザー名	はい	文字列	SSH ユーザー名
sshProfile	いいえ	複合型	SSH キーを指定します。 sshProfile または Password のいずれかが必要です。
Password	いいえ	文字列	SSH パスワードを指定します sshProfile または Password のいずれかが必要です。

sshProfile

要素名	必須	型	説明
publicKeys	はい	Array	certificateData オブジェクトの一覧が含まれます。 値は ssh-rsa 公開キーです

virtualNetworkProfile

要素名	必須	型	説明
id	はい	文字列	Virtual Network リソース ID
サブネット	はい	文字列	サブネット名を指定します

scriptActions

要素名	必須	型	説明
name	はい	文字列	スクリプト アクションのフレンドリ名
uri	はい	文字列	スクリプト アクション ファイルの URL
parameters	いいえ	文字列	スクリプト アクション ファイルの実行時に渡す引数

Response

検証が完了し、要求が受け入れられた場合、操作は 200 (OK) を返します。

状態コード: 200 OK

linux クラスターの応答本文は、ssh キーを使用して作成します。

{  
    "id":"/subscriptions/{subscription-id}/resourceGroups/myresourcegroup1/providers/Microsoft.HDInsight/clusters/mycluster",  
  "name":"mycluster",   
  "type":"Microsoft.HDInsight/clusters",  
  
    "location": "location-name",  
    "tags": { "tag1": "value1", "tag2": "value2" },  
    "properties": {  
        "clusterVersion": "3.2",  
        "osType": "Linux",  
		"provisioningState": "InProgress",  
		"clusterState": "Accepted",  
		"createdDate": "2015-09-23",  
		"quotaInfo": {  
			"coresUsed": 20  
}  
        "clusterDefinition": {  
            "kind": "hadoop"  
        },  
  
        "computeProfile": {  
            "roles": [  
                {  
                    "name": "headnode",  
  
                    "targetInstanceCount": 2,  
  
                    "hardwareProfile": {  
                        "vmSize": "Large"  
                    }  
  
                },  
                {  
                    "name": "workernode",  
  
                    "targetInstanceCount": 1,  
  
                    "hardwareProfile": {  
                        "vmSize": "Large"  
                    }  
                },  
                {  
                    "name": "zookeepernode",  
  
                    "targetInstanceCount": 3,  
  
                    "hardwareProfile": {  
                        "vmSize": "Small"  
                    }  
                }  
            ]  
        }  
    }  
}  
  

要素名	Type	説明
provisioningState	文字列	現在のプロビジョニング状態を示します。
clusterState	文字列	プロビジョニングの進行中に、より詳細な HDInsight クラスターの状態を示します。
createdDate	Date	クラスター作成要求を受信した日時
quotaInfo	複合型	クラスターによって使用されるコアを指定します
エラー	エラー メッセージの配列	provisioningState = 'failed" の場合のエラー メッセージが含まれます
connectivityEndpoints	複合型	クラスターのパブリック エンドポイントを指定します

connectivityEndpoints

要素名	Type	説明
name	String	接続エンドポイントのフレンドリ名
protocol	String	使用するプロトコルを指定します (例: HTTPS、SSH)
location	文字列	接続する URL を指定します
port	INT	接続するポートを指定します

既定のファイルシステムとして Azure Data Lake Store を使用してクラスターを作成する

既定のファイルシステムとして Azure Data Lake Store を使用して、指定したサブスクリプションにクラスターを作成します。 要求本文に ClusterIdentity オブジェクトを指定し、適切な Data Lake Store URL を使用して default-filesystem プロパティを構成します。

Azure Data Lake は、3.5 以降のクラスター バージョンの既定のファイルシステムとして構成できます。

要求

クラスターで使用される ヘッダーとパラメーター については、「共通パラメーターとヘッダー」を参照してください。

Method	要求 URI
PUT	https://management.azure.com/subscriptions/{subscription Id}/resourceGroups/{resourceGroup Name}/providers/Microsoft.HDInsight/clusters/{cluster name}?api-version={api-version}}

次の例は、クラスターの既定のファイルシステムとして Azure Data Lake Store を使用して Linux ベースの Hadoop クラスターを作成するための要求本文を示しています。

{
	"id": "/subscriptions/{subscription-id}/resourceGroups/myresourcegroup1/providers/Microsoft.HDInsight/clusters/mycluster",
	"name": "mycluster",
	"type": "Microsoft.HDInsight/clusters",
	"location": "location-name",
	"tags": {
		"tag1": "value1",
		"tag2": "value2"
	},
	"properties": {
		"clusterVersion": "3.5",
		"osType": "Linux",
		"tier": "Standard",
		"clusterDefinition": {
			"kind": "hadoop",
			"configurations": {
				"gateway": {
					"restAuthCredential.isEnabled": true,
					"restAuthCredential.username": "http-user",
					"restAuthCredential.password": "password"
				},
				"clusterIdentity": {
					"clusterIdentity.applicationId": "applicationId",
					"clusterIdentity.certificate": "certificate-contents-in-base64-encoding",
					"clusterIdentity.aadTenantId": "aad-tenant-id",
					"clusterIdentity.resourceUri": "https://KonaCompute.net/",
					"clusterIdentity.certificatePassword": "certificate-password"
				},
				"core-site": {
					"fs.defaultFS": "adl://home",
					"dfs.adls.home.hostname": "yourstorageaccount.azuredatalakestore.net",
					"dfs.adls.home.mountpoint": "/path/to/cluster/root"
				}
			}
		},
		"computeProfile": {
			"roles": [
				{
					"name": "headnode",
					"targetInstanceCount": 2,
					"hardwareProfile": {
						"vmSize": "Large"
					},
					"osProfile": {
						"linuxOperatingSystemProfile": {
							"username": "username",
							"sshProfile": {
								"publicKeys": [
									{
										"certificateData": "ssh-rsa key"
									}
								]
							}
						}
					}
				},
				{
					"name": "workernode",
					"targetInstanceCount": 1,
					"hardwareProfile": {
						"vmSize": "Large"
					},
					"osProfile": {
						"linuxOperatingSystemProfile": {
							"username": "username",
							"sshProfile": {
								"publicKeys": [
									{
										"certificateData": " ssh-rsa key"
									}
								]
							}
						}
					}
				},
				{
					"name": "zookeepernode",
					"targetInstanceCount": 3,
					"hardwareProfile": {
						"vmSize": "Small"
					},
					"osProfile": {
						"linuxOperatingSystemProfile": {
							"username": "username",
							"sshProfile": {
								"publicKeys": [
									{
										"certificateData": "ssh-rsa key"
									}
								]
							}
						}
					}
				}
			]
		}
	}
}  

要素名	必須	型	説明
id	はい	文字列	クラスターのリソース識別子を指定します。
name	はい	文字列	クラスターの名前を指定します。
type	はい	文字列	クラスターの種類を指定します。
location	はい	文字列	クラスターを作成する必要がある、サポートされている Azure の場所を指定します。 詳細については、「 使用可能なすべての地域の場所を一覧表示する」を参照してください。
tags	いいえ	文字列	クラスターに割り当てるタグを指定します。 タグの使用の詳細については、「タグ を使用して Azure リソースを整理する」を参照してください。
プロパティ	はい	複合型	クラスターのプロパティを指定します。

プロパティ

要素名	必須	型	説明
clusterVersion	はい	文字列	クラスターのバージョンを指定します
osType	はい	文字列	クラスターのオペレーティング システムを指定します。 有効な値は Linux です
レベル	いいえ	文字列	クラスターの層を指定します。 有効な値は 、Standard と Premium です。 レベルが指定されていない場合、クラスターは Standard レベルになります。
clusterDefinition	Yes	複合型	クラスターの種類と構成に関する情報を指定します
computeProfile	Yes	複合型	クラスター トポロジと関連するロール プロパティに関する情報を指定します

clusterDefinition

要素名	必須	型	説明
kind	はい	文字列	クラスターの種類を指定します。 有効な値は hadoop、hbase、storm & spark です
configuration	はい	Dictionary	この要素は、構成の種類とそれに関連付けられている値ディクショナリのディクショナリです。 ゲートウェイ構成の種類は、Web API と Ambari ポータルへの接続に使用される http ユーザーを構成するために使用されます core-site 構成の種類は、クラスターの既定のストレージ アカウントを構成するために使用されます

computeProfile

要素名	必須	型	説明
clusterVersion	はい	文字列	クラスターのバージョンを指定します
role	Yes	複合型の配列 (ロール)	クラスター内のロールに関する情報を指定します

role

要素名	必須	型	説明
name	はい	文字列	ロール名を指定します
targetInstanceCount	はい	Integer	ロールのターゲット インスタンス数を指定します
hardwareProfile	Yes	複合型	ロールのハードウェア プロファイルに関する情報を指定します
osProfile	Yes	複合型	ロールの os プロファイルに関する情報を指定します

hardwareProfile

要素名	必須	型	説明
vmSize	はい	文字列	VM のサイズを指定します。 有効なサイズについては、 HDInsight 構成オプション (このリンクで 1 回、 Node 価格レベルまで下にスクロール) を参照してください

osProfile

要素名	必須	型	説明
linuxOperatingSystemProfile	いいえ	複合型	Linux OS 関連の設定を指定します
virtualNetworkProfile	いいえ	複合型	クラスターがユーザーのサブスクリプション内の仮想ネットワークにデプロイされている場合に、仮想ネットワーク関連の設定を指定します
scriptActions	いいえ	複合型の配列	クラスターで実行するスクリプト アクションの一覧

linuxOperatingSystemProfile

要素名	必須	型	説明
ユーザー名	はい	文字列	SSH ユーザー名
sshProfile	いいえ	複合型	SSH キーを指定します。 sshProfile または Password のいずれかが必要です。
Password	いいえ	文字列	SSH パスワードを指定します sshProfile または Password のいずれかが必要です。

sshProfile

要素名	必須	型	説明
publicKeys	はい	Array	certificateData オブジェクトの一覧を格納します。 この値は ssh-rsa 公開キーです

virtualNetworkProfile

要素名	必須	型	説明
id	はい	文字列	Virtual Network リソース ID
サブネット	はい	文字列	サブネット名を指定します

scriptActions

要素名	必須	型	説明
name	はい	文字列	スクリプト アクションのフレンドリ名
uri	はい	文字列	スクリプト アクション ファイルの URL
parameters	いいえ	文字列	スクリプト アクション ファイルの実行時に渡す引数

Response

検証が完了し、要求が受け入れられた場合、操作は 200 (OK) を返します。

状態コード: 200 OK

linux クラスターの応答本文は、ssh キーを使用して作成します。

{
	"id": "/subscriptions/{subscription ID}/resourceGroups/rg1/providers/Microsoft.HDInsightCurrent/clusters/mycluster",
	"name": "mycluster",
	"type": "Microsoft.HDInsightCurrent/clusters",
	"location": "East Asia",
	"etag": "{value}",
	"tags": null,
	"properties": {
		"clusterVersion": "3.5.1000.0",
		"osType": "Linux",
		"clusterDefinition": {
			"kind": "hadoop"
		},
		"computeProfile": {
			"roles": [
				{
					"name": "headnode",
					"targetInstanceCount": 2,
					"hardwareProfile": {
						"vmSize": "Standard_D3"
					},
					"osProfile": {
						"linuxOperatingSystemProfile": {
							"username": "myuser"
						}
					}
				},
				{
					"name": "workernode",
					"targetInstanceCount": 2,
					"hardwareProfile": {
						"vmSize": "Standard_D3"
					},
					"osProfile": {
						"linuxOperatingSystemProfile": {
							"username": "myuser"
						}
					}
				}
			]
		},
		"provisioningState": "InProgress",
		"clusterState": "Accepted",
		"createdDate": "2016-11-15T09:21:47.61",
		"quotaInfo": {
			"coresUsed": 16
		},
		"tier": "standard"
	}
}  

要素名	Type	説明
provisioningState	文字列	現在のプロビジョニング状態を示します。
clusterState	文字列	プロビジョニングの進行中に、より詳細な HDInsight クラスターの状態を示します。
createdDate	Date	クラスター作成要求を受信した日時
quotaInfo	複合型	クラスターによって使用されるコアを指定します
エラー	エラー メッセージの配列	provisioningState = 'failed" の場合のエラー メッセージが含まれます
connectivityEndpoints	複合型	クラスターのパブリック エンドポイントを指定します

connectivityEndpoints

要素名	Type	説明
name	String	接続エンドポイントのフレンドリ名
protocol	String	使用するプロトコルを指定します (例: HTTPS、SSH)
location	文字列	接続する URL を指定します
port	INT	接続するポートを指定します

削除

HDInsight クラスターを削除します。

要求

クラスターで使用される ヘッダーとパラメーター については、「共通パラメーターとヘッダー」を参照してください。

Method	要求 URI
DELETE	https://management.azure.com/subscriptions/{subscription Id}/resourceGroups/{resourceGroup Name}/providers/Microsoft.HDInsight/clusters/{cluster name}?api-version={api-version}

Response

操作が非同期的に完了することを示す HTTP 202 (Accepted)。 非同期ポーリングでは、操作が正常に完了すると 204 (NoContent) が返されます。

注釈

クラスターの削除要求の進行状況を追跡するには、「非同期操作 (202 Accepted and Location ヘッダー)」を参照してください。

Get

指定したクラスターの詳細/プロパティを取得します。

要求

クラスターで使用される ヘッダーとパラメーター については、「共通パラメーターとヘッダー」を参照してください。

Method	要求 URI
GET	https://management.azure.com/subscriptions/{subscription Id}/resourceGroups/{resourceGroup Name}/providers/Microsoft.HDInsight/clusters/{cluster name}?api-version={api-version}

Response

要求が正常に完了すると、操作は 200 (OK) を返します

状態コード: 200 OK

応答本文は、クラスターの作成と同じです。

Linux クラスターの詳細に対する応答本文

{  
    "id":"/subscriptions/{subscription-id}/resourceGroups/myresourcegroup1/providers/Microsoft.HDInsight/clusters/mycluster",  
  "name":"mycluster",   
  "type":"Microsoft.HDInsight/clusters",  
  
    "location": "location-name",  
    "tags": { "tag1": "value1", "tag2": "value2" },  
    "properties": {  
        "clusterVersion": "3.2",  
        "osType": "Linux",  
		"provisioningState": "InProgress",  
		"clusterState": "Accepted",  
		"createdDate": "2015-09-23",  
		"quotaInfo": {  
			"coresUsed": 20  
}  
        "clusterDefinition": {  
            "kind": "hadoop"  
        },  
  
        "computeProfile": {  
            "roles": [  
                {  
                    "name": "headnode",  
  
                    "targetInstanceCount": 2,  
  
                    "hardwareProfile": {  
                        "vmSize": "Large"  
                    },  
                    "osProfile": {  
                       "linuxOperatingSystemProfile": {  
                          "username": "sshuser"  
                       }  
                     }  
  
                },  
                {  
                    "name": "workernode",  
  
                    "targetInstanceCount": 1,  
  
                    "hardwareProfile": {  
                        "vmSize": "Large"  
                    },  
  
                    "osProfile": {  
                       "linuxOperatingSystemProfile": {  
                          "username": "sshuser"  
                       }  
                     }  
  
                },  
                {  
                    "name": "zookeepernode",  
  
                    "targetInstanceCount": 3,  
  
                    "hardwareProfile": {  
                        "vmSize": "Small"  
                    },  
  
                    "osProfile": {  
                       "linuxOperatingSystemProfile": {  
                          "username": "sshuser"  
                       }  
                     }  
                }  
            ]  
        }  
    }  
}  
  

要素名	Type	説明
provisioningState	文字列	現在のプロビジョニング状態を示します。
clusterState	文字列	プロビジョニングの進行中に、より詳細な HDInsight クラスターの状態を示します。
createdDate	Date	クラスター作成要求を受信した日時
quotaInfo	複合型	クラスターによって使用されるコアを指定します
エラー	エラー メッセージの配列	provisioningState = 'failed" の場合のエラー メッセージが含まれます
connectivityEndpoints	複合型	クラスターのパブリック エンドポイントを指定します

connectivityEndpoints

要素名	Type	説明
name	String	接続エンドポイントのフレンドリ名
protocol	String	使用するプロトコルを指定します (例: HTTPS、SSH)
location	文字列	接続する URL を指定します
port	INT	接続するポートを指定します

構成を一覧表示する

すべてのクラスター構成の詳細 (機密情報を含む) を取得します。

要求

クラスターで使用される ヘッダーとパラメーター については、「共通パラメーターとヘッダー」を参照してください。

Method	要求 URI
POST	https://management.azure.com/subscriptions/{subscription Id}/resourceGroups/{resourceGroup Name}/providers/Microsoft.HDInsight/clusters/{cluster name}/configurations?api-version={api-version}

Response

操作が正常に完了した場合の HTTP 200 (OK)。

応答の例:

"configurations":   
{  
     "gateway": {  
          "restAuthCredential.isEnabled": true,  
          "restAuthCredential.username": "username",  
          "restAuthCredential.password": "Password123!"     
      },  
  
      "core-site": {  
           "fs.defaultFS": "wasbs://mycontainter@mystorageaccount.blob.core.windows.net",
	   "fs.azure.account.key.mystorageaccount.blob.core.windows.net": "storagekey1value"  
      }  
}  
  

要素名	Type	説明
configuration	Dictionary	この要素は、構成の種類とその関連する値ディクショナリのディクショナリです。 ゲートウェイ構成の種類は、Web API と Ambari ポータルへの接続に使用される http ユーザーを構成するために使用されます コア サイト構成の種類は、クラスターの既定のストレージ アカウントを構成するために使用されます

構成を取得する

1 つの構成の種類に関する詳細を取得します (機密性の高い値は省略します)。

要求

クラスターで使用される ヘッダーとパラメーター については、「共通パラメーターとヘッダー」を参照してください。

Method	要求 URI
GET	https://management.azure.com/subscriptions/{subscription Id}/resourceGroups/{resourceGroup Name}/providers/Microsoft.HDInsight/clusters/{cluster name}/configurations/{configuration Type}?api-version={api-version}

Response

操作が正常に完了した場合の HTTP 200 (OK)。

応答の例:

{
     "core-site": {  
          "fs.defaultFS": "wasbs://mycontainter@mystorageaccount.blob.core.windows.net",
	  "fs.azure.account.key.mystorageaccount.blob.core.windows.net": ""
     }
}
  

ゲートウェイ設定を取得する

この操作により、クラスター ゲートウェイの HTTP 資格情報が取得されます。

要求

クラスターで使用される ヘッダーとパラメーター については、「共通パラメーターとヘッダー」を参照してください。

Method	要求 URI
POST	https://management.azure.com/subscriptions/{subscription Id}/resourceGroups/{resourceGroup Name}/providers/Microsoft.HDInsight/clusters/{cluster name}/getGatewaySettings?api-version={api-version}

Response

操作が正常に完了した場合の HTTP 200 (OK)。

応答の例:

{  
     "restAuthCredential.isEnabled": true,  
     "restAuthCredential.username": "username",  
     "restAuthCredential.password": "Password123!"  
}  

ゲートウェイの設定を更新する

この操作により、ユーザーはクラスター ゲートウェイの HTTP 資格情報を変更できます。

要求

クラスターで使用される ヘッダーとパラメーター については、「共通パラメーターとヘッダー」を参照してください。

Method	要求 URI
POST	https://management.azure.com/subscriptions/{subscription Id}/resourceGroups/{resourceGroup Name}/providers/Microsoft.HDInsight/clusters/{cluster name}/updateGatewaySettings?api-version={api-version}

{  
     "restAuthCredential.isEnabled": true,  
     "restAuthCredential.username": "username",  
     "restAuthCredential.password": "Password123!"  
}  

Response

操作が正常に完了した場合の HTTP 202 (Accepted)。

接続設定の変更 (非推奨)

この操作により、ユーザーはクラスターへの HTTPS 接続を有効または無効にすることができます。

代わりに updateGatewaySettings を 使用してください。

要求

クラスターで使用される ヘッダーとパラメーター については、「共通パラメーターとヘッダー」を参照してください。

Method	要求 URI
POST	https://management.azure.com/subscriptions/{subscription Id}/resourceGroups/{resourceGroup Name}/providers/Microsoft.HDInsight/clusters/{cluster name}/configurations/{configuration Type}?api-version={api-version}

接続を有効にするには

{  	
   "restAuthCredential.isEnabled": true,  	
   "restAuthCredential.username": "user",  	
   "restAuthCredential.password": "password here"  
}

リソース グループ別に一覧表示する

指定したリソース グループ内のユーザーのサブスクリプション内のすべてのクラスターをListsします。

要求

クラスターで使用される ヘッダーとパラメーター については、「共通パラメーターとヘッダー」を参照してください。

Method	要求 URI
GET	https://management.azure.com/subscriptions/{subscription Id}/resourcegroups/{resourceGroup Id}/providers/Microsoft.HDInsight/clusters?api-version={api-version}

Response

要求が正常に完了すると、操作は 200 (OK) を返します。

状態コード: 200 OK

応答本文は、クラスターの詳細の配列です。 詳細については、「 クラスターのプロパティを取得する」を参照してください。

{  
  "value": [  
		{ Cluster details }  
    ]  
}  
  

サブスクリプション別に一覧表示する

ユーザーのサブスクリプション内のすべてのクラスターをListsします。

要求

クラスターで使用される ヘッダーとパラメーター については、「共通パラメーターとヘッダー」を参照してください。

Method	要求 URI
GET	https://management.azure.com/subscriptions/{subscription Id}/providers/Microsoft.HDInsight/clusters?api-version={api-version}

Response

要求が正常に完了すると、操作は 200 (OK) を返します。

状態コード: 200 OK

応答本文は、クラスターの詳細の配列です。

{  
  "value": [  
		{ Cluster details }  
    ]  
}  

接続を無効にするには

{  
   "restAuthCredential.isEnabled": false  
}  
  

要素名	必須	型	説明
restAuthCredential.isEnabled	はい	Boolean	接続を有効または無効にするかどうかを指定します
restAuthCredential.username	いいえ	文字列	isEnabled=true の場合は必須 接続設定のユーザー名を指定します
restAuthCredential.password	いいえ	文字列	isEnabled=true の場合は必須 接続設定のパスワードを指定します

Response

操作が非同期的に完了することを示す HTTP 202 (Accepted)。 非同期ポーリングでは、操作が正常に完了すると 204 (NoContent) が返されます。

注釈

クラスターの削除要求の進行状況を追跡するには、「非同期操作 (202 Accepted and Location ヘッダー)」を参照してください。

RDP 設定を変更する (Windows クラスターのみ)

この操作により、ユーザーは RDP を有効または無効にすることができます。 Windows ベースのクラスターに適用されます。

要求

クラスターで使用される ヘッダーとパラメーター については、「共通パラメーターとヘッダー」を参照してください。

Method	要求 URI
POST	https://management.azure.com/subscriptions/{subscription Id}/resourceGroups/{resourceGroup Name}/providers/Microsoft.HDInsight/clusters/{cluster name}/changerdpsetting?api-version={api-version}

要求本文

RDP を有効にするには

{  
	"osProfile": {  
        "windowsOperatingSystemProfile": {  
        	"rdpSettings": {  
        	      "username": "username",  
            	      "password": "password here",  
            	      "expiryDate": "YYYY-MM-DD"  
        	}  
        }  
    }  
}  

RDP を無効にするには

{  
	"osProfile": {  
        "windowsOperatingSystemProfile": {  
        	"rdpSettings": null  
        }  
    }  
}  

osProfile

要素名	必須	型	説明
windowsOperatingSystemProfile	いいえ	複合型	Windows OS 関連の設定を指定します

windowsOperatingSystemProfile

要素名	必須	型	説明
rdpSettings	いいえ	複合型	Windows クラスターの RDP 設定を指定します

rdpSettings

要素名	必須	型	説明
username	はい	文字列	RDP ユーザー名を指定します
password	はい	文字列	RDP ユーザーのパスワードを指定します
expiryDate	はい	Date	RDP 資格情報の有効期限

Response

要求が正常に完了すると、操作は 200 (OK) を返します

状態コード: 200 OK

応答本文は、クラスターの 作成と同じです。

実行中のクラスターでスクリプト アクションを実行する (Linux クラスターのみ)

実行中のクラスターでスクリプトの実行アクションを実行します。

要求

クラスターで使用される ヘッダーとパラメーター については、「共通パラメーターとヘッダー」を参照してください。

Method	要求 URI
POST	https://management.azure.com/subscriptions/{subscription Id}/resourceGroups/{resourceGroup Name}/providers/Microsoft.HDInsight/clusters/{cluster name}/executeScriptActions?api-version={api-version}

要求本文

{  
  "scriptActions": [  
    {  
      "name": "script-name",  
      "uri": "script-uri",  
      "parameters": "script-parameters",  
      "roles": [  
        "headnode",  
        "workernode"  
      ]  
    },  
    ...  
  ],  
  "persistOnSuccess": true  
}  
  

scriptActions

要素名	必須	型	説明
name	はい	文字列	スクリプト アクションの名前を指定します
uri	はい	文字列	スクリプト アクションの URI を指定します
parameters	はい	文字列	スクリプト アクションに必要なパラメーターを指定します
roles	Yes	文字列の配列	スクリプト アクションが実行されるターゲット ロールを指定します
persistOnSuccess	はい	ブール値	正常に実行された後にスクリプト アクションを永続化するかどうかを指定します

Response

検証が完了し、要求が受け入れられた場合、操作は 202 (Accepted) を返します。

状態コード: 202 (承諾済み)

クラスターのすべての永続化されたスクリプト アクションを一覧表示する (Linux クラスターのみ)

この操作は、指定されたクラスターのすべての永続化されたスクリプト アクションを返します。

要求

クラスターで使用される ヘッダーとパラメーター については、「共通パラメーターとヘッダー」を参照してください。

Method	要求 URI
GET	https://management.azure.com/subscriptions/{subscription Id}/resourceGroups/{resourceGroup Name}/providers/Microsoft.HDInsight/clusters/{cluster name}/scriptActions?api-version={api-version}

Response

操作が正常に完了した場合の HTTP 200 (OK)。

状態コード: 200 OK

応答の例:

{  
"value":  
[  
  {  
    "name":"script-name",  
    "uri":"script-uri",  
    "parameters":"script-parameters",  
    "roles":["headnode","workernode"],  
    "applicationName":null  
  },  
  ...  
]  
}  

要素名	Type	説明
name	String	スクリプト アクションの名前を指定します。
uri	String	スクリプト アクションの URI を指定します。
parameters	文字列	スクリプト アクションに必要なパラメーターを指定します
roles	文字列の配列	スクリプト アクションが実行される対象ロールを指定します。
applicationName	String	スクリプトが関連付けられている対応するアプリケーションを指定します。 スクリプトがユーザーによって提供される場合、applicationName は null です

クラスターの永続化されたスクリプト アクションを削除する (Linux クラスターのみ)

この操作により、クラスターの HDInsight 永続化スクリプト アクションが削除されます。

要求

クラスターで使用される ヘッダーとパラメーター については、「共通パラメーターとヘッダー」を参照してください。

Method	要求 URI
DELETE	https://management.azure.com/subscriptions/{subscription Id}/resourceGroups/{resourceGroup Name}/providers/Microsoft.HDInsight/clusters/{cluster name}/scriptActions/{script Name}?api-version={api-version}

Response

• 永続化されたスクリプト アクションの一覧からスクリプト アクションが削除されたことを示す HTTP 200 (OK)。

• 対応する scriptName を持つ既存の永続化されたスクリプト アクションがないことを示す HTTP 404 (NotFound)。

履歴からスクリプト アクションの実行を取得する (Linux クラスターのみ)

この操作は、指定したクラスターの最新のスクリプト アクション実行、または個々のスクリプト実行の実行の詳細を返します。

要求

クラスターで使用される ヘッダーとパラメーター については、「共通パラメーターとヘッダー」を参照してください。

Method	要求 URI
GET	https://management.azure.com/subscriptions/{subscription Id}/resourceGroups/{resourceGroup Name}/providers/Microsoft.HDInsight/clusters/{cluster name}/scriptExecutionHistory/{script Execution Id}?api-version={api-version}

Response

要求が正常に完了すると、操作は 200 (OK) を返します。 scriptExecutionId が指定されている場合、応答本文はスクリプト実行の詳細の配列または単一のスクリプト実行の詳細です。 スクリプト実行の詳細の例を次に示します。

状態コード: 200 (OK)

応答の例:

{  
  "scriptExecutionId":script-execution-id,  
  "name":"script-name",  
  "applicationName":null,  
  "uri":"script-uri",  
  "parameters":"script-parameters",  
  "roles":["headnode","workernode"],  
  "startTime":"2016-02-26T23:49:13.0773637Z",  
  "endTime":"2016-02-26T23:49:33.4964725Z",  
  "status":"Succeeded",  
  "operation":"PostClusterCreateScriptActionRequest",  
  "executionSummary":  
	[{"status":"COMPLETED",  
	 "instanceCount":4}],  
  "debugInformation": "debug-information"  
}  
  

要素名	Type	説明
scriptExecutionId	Long	スクリプト アクションの実行 ID を指定します。
name	String	スクリプト アクションの名前を指定します。
applicationName	String	スクリプトが関連付けられている対応するアプリケーションを指定します。 スクリプトがユーザーによって提供される場合、applicationName は null です
uri	String	スクリプト アクションの URI を指定します。
parameters	文字列	スクリプト アクションに必要なパラメーターを指定します
roles	文字列の配列	スクリプト アクションが実行される対象ロールを指定します。
startTime	DateTime	スクリプト アクションの実行の開始時刻を指定します
endTime	DateTime	スクリプト アクションの実行の終了時刻を指定します
status	String	スクリプト アクションの実行の状態を指定します
operation	文字列	スクリプト アクションが実行された理由を指定します。 たとえば、ScaleUp は、クラスターのスケールアップ中にスクリプト アクションが実行されたことを意味します。
executionSummary	複合型の配列	実行の概要を、成功したホストの数とスクリプトの実行に失敗したホストの数を指定します。
debugInformation	文字列	スクリプトの詳細なデバッグ情報を指定します。 debugInformation は、要求で scriptExecutionId が指定されている場合にのみ返されます。

executionSummary

要素名	Type	説明
status	String	個々のホストでの実行の状態を指定します。
instanceCount	int	対応する状態の実行数を指定します。

スクリプト アクションの実行履歴からスクリプトを永続化するように昇格する (Linux クラスターのみ)

この操作により、スクリプト実行履歴から HDInsight スクリプトが永続化されるように昇格されます。

要求

クラスターで使用される ヘッダーとパラメーター については、「共通のパラメーターとヘッダー」を参照してください。

Method	要求 URI
POST	https://management.azure.com/subscriptions/{subscription Id}/resourceGroups/{resourceGroup Name}/providers/Microsoft.HDInsight/clusters/{cluster name}/scriptExecutionHistory/{script Execution Id}/promote?api-version={api-version}

Response

• スクリプト アクションが昇格されたことを示す HTTP 200 (OK)。

• 対応する scriptExecutionId を使用して既存のスクリプト アクションの実行がないことを示す HTTP 404 (NotFound)。

サイズ変更

既存の HDInsight クラスターのサイズを変更します。

要求

クラスターで使用される ヘッダーとパラメーター については、「共通のパラメーターとヘッダー」を参照してください。

Method	要求 URI
POST	https://management.azure.com/subscriptions/{subscription Id}/resourceGroups/{resourceGroup Name}/providers/Microsoft.HDInsight/clusters/{cluster name}/roles/{role name}/resize?api-version={api-version}

クラスターのタグを更新する要求の例を次に示します。

{  
    "targetInstanceCount": 10  
}  

要素名	必須	型	説明
targetInstanceCount	Yes	int	ロールの新しいインスタンス数を指定します

Response

操作が非同期的に完了することを示す HTTP 202 (Accepted)。 非同期ポーリングでは、操作が正常に完了すると 204 (NoContent) が返されます。

注釈

クラスターの削除要求の進行状況を追跡するには、「非同期操作 (202 Accepted and Location ヘッダー)」を参照してください。

更新

クラスターのタグを更新します。

その他のすべての更新プログラムは、個別に記述された個別のアクションです。

要求

クラスターで使用される ヘッダーとパラメーター については、「共通のパラメーターとヘッダー」を参照してください。

Method	要求 URI
PATCH	https://management.azure.com/subscriptions/{subscription Id}/resourceGroups/{resourceGroup Name}/providers/Microsoft.HDInsight/clusters/{cluster name}?api-version={api-version}

クラスターのタグを更新する要求の例を次に示します。

{   
    "tags": {"department": "finance"}  
}  
  

要素名	必須	型	説明
tags	はい	文字列	クラスターに割り当てるタグを指定します。 タグの使用の詳細については、「タグ を使用して Azure リソースを整理する」を参照してください。

Response

要求が正常に完了すると、操作は 200 (OK) を返します。

状態コード: 200 OK

応答本文は、クラスターの 作成と同じです。