API REST do cluster no Azure HDInsight

Artigo
02/07/2024

Criar

Cria um cluster na assinatura especificada.

Solicitação

Confira Parâmetros e cabeçalhos comuns para cabeçalhos e parâmetros usados por clusters.

Método	URI da solicitação
PUT	`https://management.azure.com/subscriptions/{subscription Id}/resourceGroups/{resourceGroup Name}/providers/Microsoft.HDInsight/clusters/{cluster name}?api-version={api-version}`

O exemplo a seguir mostra o corpo da solicitação para criar um cluster hadoop baseado em Linux. Para obter exemplos de criação de clusters de outras maneiras, consulte a seção Exemplos abaixo.

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

Nome do elemento	Obrigatório	Tipo	Descrição
id	Sim	String	Especifica o identificador de recurso do cluster.
name	Sim	String	Especifica o nome do cluster.
tipo	Sim	String	Especifica o tipo do cluster.
local	Sim	String	Especifica o local do Azure com suporte em que o cluster deve ser criado. Para obter mais informações, consulte Listar todas as localizações geográficas disponíveis.
marcas	Não	String	Especifica as marcas que serão atribuídas ao cluster. Para obter mais informações sobre como usar marcas, consulte Usando marcas para organizar seus recursos do Azure.
Propriedades	Yes	Tipo complexo	Especifica as propriedades do cluster.

Propriedades

Nome do elemento	Obrigatório	Tipo	Descrição
clusterVersion	Sim	String	Especifica a versão do cluster
osType	Sim	String	Especifica o sistema operacional para o cluster. Os valores válidos são Linux e Windows
clusterDefinition	Yes	Tipo complexo	Especifica informações sobre o tipo de cluster e as configurações
computeProfile	Yes	Tipo complexo	Especifica informações sobre a topologia de cluster e as propriedades de função associadas

clusterDefinition

Nome do elemento	Obrigatório	Tipo	Descrição
kind	Sim	String	Especifica o tipo de cluster. Os valores válidos são hadoop, hbase, storm & spark
configurações	Yes	Dicionário	Esse elemento é um dicionário de tipo de configuração e seu dicionário de valor associado. O tipo de configuração do gateway é usado para configurar o usuário http usado para se conectar a APIs Web e ao portal do Ambari O tipo de configuração core-site é usado para configurar a conta de armazenamento padrão para o cluster

computeProfile

Nome do elemento	Obrigatório	Tipo	Descrição
clusterVersion	Sim	String	Especifica a versão do cluster
role	Yes	Matriz de Tipo Complexo (função)	Especifica informações sobre funções no cluster

função

Nome do elemento	Obrigatório	Tipo	Descrição
name	Sim	String	Especifica o nome da função
targetInstanceCount	Sim	Integer	Especifica a contagem de instâncias de destino para a função
hardwareProfile	Yes	Tipo complexo	Especifica informações sobre o perfil de hardware para a função
osProfile	Yes	Tipo complexo	Especifica informações sobre o perfil do sistema operacional para a função

hardwareProfile

Nome do elemento	Obrigatório	Tipo	Descrição
vmSize	Sim	String	Especifica o tamanho da VM. Consulte as opções de configuração do HDInsight (uma vez neste link, role para baixo até os tipos de preço do Nó) para obter tamanhos válidos

osProfile

Nome do elemento	Obrigatório	Tipo	Descrição
linuxOperatingSystemProfile	No	Tipo complexo	Especifica as configurações relacionadas ao sistema operacional linux
windowsOperatingSystemProfile	No	Tipo complexo	Especifica as configurações relacionadas ao sistema operacional do Windows
virtualNetworkProfile	No	Tipo complexo	Especifica as configurações relacionadas à rede virtual se o cluster estiver sendo implantado em uma rede virtual na assinatura do usuário
scriptActions	No	Matriz de tipo complexo	Lista de ações de script a serem executadas no cluster

linuxOperatingSystemProfile

Nome do elemento	Obrigatório	Tipo	Descrição
Nome de Usuário	Sim	String	Nome de usuário do SSH
sshProfile	No	Tipo complexo	Especifica a chave SSH. Um dos sshProfile ou Password é necessário.
Senha	Não	String	Especifica a senha SSH Um dos sshProfile ou Password é necessário.

sshProfile

Nome do elemento	Obrigatório	Tipo	Descrição
publicKeys	Yes	Array	Contém uma lista de objetos certificateData. O valor é uma chave pública ssh-rsa

windowsOperatingSystemProfile

Nome do elemento	Obrigatório	Tipo	Descrição
rdpSettings	No	Tipo complexo	Especifica as configurações de RDP para clusters do Windows

rdpSettings

Nome do elemento	Obrigatório	Tipo	Descrição
Nome de Usuário	Sim	String	Especifica o nome de usuário RDP
password	Sim	String	Especifica a senha para o usuário RDP
expirayDate	Sim	Data	Data de expiração para as credenciais rdp

virtualNetworkProfile

Nome do elemento	Obrigatório	Tipo	Descrição
id	Sim	String	ID do recurso Rede Virtual
sub-rede	Sim	String	Especifica o nome da sub-rede

scriptActions

Nome do elemento	Obrigatório	Tipo	Descrição
name	Sim	String	Nome amigável para a ação de script
uri	Sim	String	URL para o arquivo de ação de script
parameters	Não	String	Argumentos a serem passados ao executar o arquivo de ação de script

Resposta

Se a validação for concluída e a solicitação for aceita, a operação retornará 200 (OK).

Código de status: 200 OK

O corpo da resposta para um cluster linux cria usando a chave 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"  
                    }  
                }  
            ]  
        }  
    }  
}

Nome do elemento	Type	Descrição
provisioningState	Cadeia de caracteres	Indica o estado de provisionamento atual.
clusterState	Cadeia de caracteres	Indica o estado do cluster HDInsight mais detalhado enquanto o provisionamento está em andamento.
createdDate	Data	Datetime quando a solicitação de criação do cluster foi recebida
quotaInfo	Tipo complexo	Especifica os núcleosUsado pelo cluster
erros	Matriz de mensagens de erro	Contém a mensagem de erro se provisioningState = 'failed'
connectivityEndpoints	Tipo complexo	Especifica os pontos de extremidade públicos para o cluster

connectivityEndpoints

Nome do elemento	Type	Descrição
name	String	Nome amigável para o ponto de extremidade de conectividade
protocolo	String	Especifica o protocolo a ser usado (exemplo: HTTPS, SSH)
local	Cadeia de caracteres	Especifica a URL a ser conectada
porta	INT	Especifica a porta a ser conectada

Criar um cluster HDInsight premium ingressado no domínio (somente Linux, versão prévia)

Crie um cluster ingressado no domínio premium com o Apache Ranger. O usuário precisa fornecer SecurityProfile no corpo da solicitação para criar um cluster seguro.

Solicitação

Consulte Parâmetros e cabeçalhos comuns para cabeçalhos e parâmetros usados por clusters.

Método	URI da solicitação
PUT	`https://management.azure.com/subscriptions/{subscription Id}/resourceGroups/{resourceGroup Name}/providers/Microsoft.HDInsight/clusters/{cluster name}?api-version={api-version}`

O exemplo a seguir mostra o corpo da solicitação para criar um cluster Hadoop baseado em Linux, premium e ingressado no domínio.

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

Nome do elemento	Obrigatório	Tipo	Descrição
id	Sim	String	Especifica o identificador de recurso do cluster.
name	Sim	String	Especifica o nome do cluster.
tipo	Sim	String	Especifica o tipo do cluster.
local	Sim	String	Especifica o local do Azure com suporte em que o cluster deve ser criado. Para obter mais informações, consulte Listar todas as localizações geográficas disponíveis.
marcas	Não	String	Especifica as marcas que serão atribuídas ao cluster. Para obter mais informações sobre como usar marcas, consulte Usando marcas para organizar seus recursos do Azure.
Propriedades	Yes	Tipo complexo	Especifica as propriedades do cluster.

Propriedades

Nome do elemento	Obrigatório	Tipo	Descrição
clusterVersion	Sim	String	Especifica a versão do cluster
osType	Sim	String	Especifica o sistema operacional para o cluster. O valor válido é Linux porque somente os tipos de cluster do Linux podem ingressar em um domínio Azure AD.
Camada	Não	String	O valor padrão é padrão. Os valores válidos são standard e premium. Se nenhum valor for especificado, o valor será considerado padrão. Especifica a Camada para o cluster. Os clusters ingressados no domínio só têm suporte na camada premium
clusterDefinition	Yes	Tipo complexo	Especifica informações sobre o tipo de cluster e as configurações
computeProfile	Yes	Tipo complexo	Especifica informações sobre a topologia de cluster e as propriedades de função associadas
securityProfile	No	Tipo complexo	Se um cluster seguro e ingressado no domínio estiver sendo criado, esse elemento especificará as configurações relacionadas ao Active Directory

clusterDefinition

Nome do elemento	Obrigatório	Tipo	Descrição
kind	Sim	String	Especifica o tipo de cluster. Os valores válidos são hadoop, hbase, storm & spark
configurações	Yes	Dicionário	Esse elemento é um dicionário de tipo de configuração e seu dicionário de valor associado. O tipo de configuração do gateway é usado para configurar o usuário http usado para se conectar a APIs Web e ao portal do Ambari O tipo de configuração core-site é usado para configurar a conta de armazenamento padrão para o cluster

computeProfile

Nome do elemento	Obrigatório	Tipo	Descrição
clusterVersion	Sim	String	Especifica a versão do cluster
role	Yes	Matriz de Tipo Complexo (função)	Especifica informações sobre funções no cluster

securityProfile

Nome do elemento	Obrigatório	Tipo	Descrição
directoryType	Sim	String	Tipo de diretório LDAP usado. Atualmente, "ActiveDirectory" é o único valor com suporte.
domínio	Sim	String	Domínio do Active Directory para o cluster
organizationalUnitDN	Sim	String	Nome diferenciado da unidade organizacional no Active Directory em que as contas de usuário e computador serão criadas
ldapsUrls	Yes	Matriz de cadeia de caracteres	URLs de um ou vários servidores LDAPS para o Active Directory
domainUserName	Sim	String	Uma conta de usuário de domínio com permissões suficientes para criar o cluster. Ele deve estar no formato user@domain
domainUserPassword	Sim	String	Senha para a conta de usuário de domínio
clusterUsersGroupDNS	No	Matriz de cadeia de caracteres	Nomes diferenciados dos grupos do Active Directory que estarão disponíveis no Ambari e no Apache Ranger

função

Nome do elemento	Obrigatório	Tipo	Descrição
name	Sim	String	Especifica o nome da função
targetInstanceCount	Sim	Integer	Especifica a contagem de instâncias de destino para a função
hardwareProfile	Yes	Tipo complexo	Especifica informações sobre o perfil de hardware para a função
osProfile	Yes	Tipo complexo	Especifica informações sobre o perfil do sistema operacional para a função

hardwareProfile

Nome do elemento	Obrigatório	Tipo	Descrição
vmSize	Sim	String	Especifica o tamanho da VM. Consulte as opções de configuração do HDInsight (uma vez neste link, role para baixo até os tipos de preço do Nó) para obter tamanhos válidos

osProfile

Nome do elemento	Obrigatório	Tipo	Descrição
linuxOperatingSystemProfile	No	Tipo complexo	Especifica as configurações relacionadas ao sistema operacional linux
virtualNetworkProfile	No	Tipo complexo	Especifica as configurações relacionadas à rede virtual se o cluster estiver sendo implantado em uma rede virtual na assinatura do usuário
scriptActions	No	Matriz de tipo complexo	Lista de ações de script a serem executadas no cluster

linuxOperatingSystemProfile

Nome do elemento	Obrigatório	Tipo	Descrição
Nome de Usuário	Sim	String	Nome de usuário do SSH
sshProfile	No	Tipo complexo	Especifica a chave SSH. Um dos sshProfile ou Password é necessário.
Senha	Não	String	Especifica a senha SSH Um dos sshProfile ou Password é necessário.

sshProfile

Nome do elemento	Obrigatório	Tipo	Descrição
publicKeys	Yes	Array	Contém uma lista de objetos certificateData. O valor é uma chave pública ssh-rsa

virtualNetworkProfile

Nome do elemento	Obrigatório	Tipo	Descrição
id	Sim	String	Rede Virtual ID do Recurso
sub-rede	Sim	String	Especifica o nome da sub-rede

scriptActions

Nome do elemento	Obrigatório	Tipo	Descrição
name	Sim	String	Nome amigável para a ação de script
uri	Sim	String	URL para o arquivo de ação de script
parameters	Não	String	Argumentos a serem passados ao executar o arquivo de ação de script

Resposta

Se a validação for concluída e a solicitação for aceita, a operação retornará 200 (OK).

Código de status: 200 OK

O corpo da resposta para um cluster linux cria usando a chave 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"  
                    }  
                }  
            ]  
        }  
    }  
}

Nome do elemento	Type	Descrição
provisioningState	Cadeia de caracteres	Indica o estado de provisionamento atual.
clusterState	Cadeia de caracteres	Indica o estado do cluster HDInsight mais detalhado enquanto o provisionamento está em andamento.
createdDate	Data	Datetime quando a solicitação de criação do cluster foi recebida
quotaInfo	Tipo complexo	Especifica os núcleosUsado pelo cluster
erros	Matriz de mensagens de erro	Contém a mensagem de erro se provisioningState = 'failed'
connectivityEndpoints	Tipo complexo	Especifica os pontos de extremidade públicos para o cluster

connectivityEndpoints

Nome do elemento	Type	Descrição
name	String	Nome amigável para o ponto de extremidade de conectividade
protocolo	String	Especifica o protocolo a ser usado (exemplo: HTTPS, SSH)
local	Cadeia de caracteres	Especifica a URL a ser conectada
porta	INT	Especifica a porta a ser conectada

Criar um cluster com o Azure Data Lake Store como o sistema de arquivos padrão

Cria um cluster na assinatura especificada com o Azure Data Lake Store como o sistema de arquivos padrão. Forneça um objeto ClusterIdentity no corpo da solicitação e configure a propriedade default-filesystem com a URL apropriada do Data Lake Store.

O Azure Data Lake pode ser configurado como o sistema de arquivos padrão para versões de cluster a partir da 3.5 inclusive.

Solicitação

Consulte Parâmetros e cabeçalhos comuns para cabeçalhos e parâmetros usados por clusters.

Método	URI da solicitação
PUT	`https://management.azure.com/subscriptions/{subscription Id}/resourceGroups/{resourceGroup Name}/providers/Microsoft.HDInsight/clusters/{cluster name}?api-version={api-version}}`

O exemplo a seguir mostra o corpo da solicitação para criar um cluster Hadoop baseado em Linux usando o Azure Data Lake Store como o sistema de arquivos padrão para o cluster.

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

Nome do elemento	Obrigatório	Tipo	Descrição
id	Sim	String	Especifica o identificador de recurso do cluster.
name	Sim	String	Especifica o nome do cluster.
tipo	Sim	String	Especifica o tipo do cluster.
local	Sim	String	Especifica o local do Azure com suporte em que o cluster deve ser criado. Para obter mais informações, consulte Listar todas as localizações geográficas disponíveis.
marcas	Não	String	Especifica as marcas que serão atribuídas ao cluster. Para obter mais informações sobre como usar marcas, consulte Usando marcas para organizar seus recursos do Azure.
Propriedades	Yes	Tipo complexo	Especifica as propriedades do cluster.

Propriedades

Nome do elemento	Obrigatório	Tipo	Descrição
clusterVersion	Sim	String	Especifica a versão do cluster
osType	Sim	String	Especifica o sistema operacional do cluster. O valor válido é Linux
Camada	Não	String	Especifica a camada do cluster. Os valores válidos são standard e premium. Se a camada não for especificada, o cluster será da camada standard.
clusterDefinition	Yes	Tipo complexo	Especifica informações sobre o tipo de cluster e as configurações
computeProfile	Yes	Tipo complexo	Especifica informações sobre a topologia de cluster e as propriedades de função associadas

clusterDefinition

Nome do elemento	Obrigatório	Tipo	Descrição
kind	Sim	String	Especifica o tipo de cluster. Os valores válidos são hadoop, hbase, storm & spark
configurações	Yes	Dicionário	Esse elemento é um dicionário do tipo de configuração e seu dicionário de valor associado. o tipo de configuração de gateway é usado para configurar o usuário http usado para se conectar a APIs Web e ao portal do Ambari o tipo de configuração core-site é usado para configurar a conta de armazenamento padrão para o cluster

computeProfile

Nome do elemento	Obrigatório	Tipo	Descrição
clusterVersion	Sim	String	Especifica a versão do cluster
role	Yes	Matriz de tipo complexo (função)	Especifica informações sobre funções no cluster

função

Nome do elemento	Obrigatório	Tipo	Descrição
name	Sim	String	Especifica o nome da função
targetInstanceCount	Sim	Integer	Especifica a contagem de instâncias de destino para a função
hardwareProfile	Yes	Tipo complexo	Especifica informações sobre o perfil de hardware para a função
osProfile	Yes	Tipo complexo	Especifica informações sobre o perfil do sistema operacional para a função

hardwareProfile

Nome do elemento	Obrigatório	Tipo	Descrição
vmSize	Sim	String	Especifica o tamanho da VM. Consulte as opções de configuração do HDInsight (uma vez neste link, role para baixo até Tipos de preço do nó) para obter tamanhos válidos

osProfile

Nome do elemento	Obrigatório	Tipo	Descrição
linuxOperatingSystemProfile	No	Tipo complexo	Especifica as configurações relacionadas ao sistema operacional linux
virtualNetworkProfile	No	Tipo complexo	Especifica as configurações relacionadas à rede virtual se o cluster estiver sendo implantado em uma rede virtual na assinatura do usuário
scriptActions	No	Matriz de tipo complexo	Lista de ações de script a serem executadas no cluster

linuxOperatingSystemProfile

Nome do elemento	Obrigatório	Tipo	Descrição
Nome de Usuário	Sim	String	Nome de usuário do SSH
sshProfile	No	Tipo complexo	Especifica a chave SSH. Um dos sshProfile ou Password é necessário.
Senha	Não	String	Especifica a senha SSH Um dos sshProfile ou Password é necessário.

sshProfile

Nome do elemento	Obrigatório	Tipo	Descrição
publicKeys	Yes	Array	Contém uma lista de objetos certificateData. O valor é uma chave pública ssh-rsa

virtualNetworkProfile

Nome do elemento	Obrigatório	Tipo	Descrição
id	Sim	String	ID do recurso Rede Virtual
sub-rede	Sim	String	Especifica o nome da sub-rede

scriptActions

Nome do elemento	Obrigatório	Tipo	Descrição
name	Sim	String	Nome amigável para a ação de script
uri	Sim	String	URL para o arquivo de ação de script
parameters	Não	String	Argumentos a serem passados ao executar o arquivo de ação de script

Resposta

Se a validação for concluída e a solicitação for aceita, a operação retornará 200 (OK).

Código de status: 200 OK

O corpo da resposta para um cluster linux cria usando a chave 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"
	}
}

Nome do elemento	Type	Descrição
provisioningState	Cadeia de caracteres	Indica o estado de provisionamento atual.
clusterState	Cadeia de caracteres	Indica o estado do cluster HDInsight mais detalhado enquanto o provisionamento está em andamento.
createdDate	Data	Datetime quando a solicitação de criação do cluster foi recebida
quotaInfo	Tipo complexo	Especifica os núcleosUsado pelo cluster
erros	Matriz de mensagens de erro	Contém a mensagem de erro se provisioningState = 'failed'
connectivityEndpoints	Tipo complexo	Especifica os pontos de extremidade públicos para o cluster

connectivityEndpoints

Nome do elemento	Type	Descrição
name	String	Nome amigável para o ponto de extremidade de conectividade
protocolo	String	Especifica o protocolo a ser usado (exemplo: HTTPS, SSH)
local	Cadeia de caracteres	Especifica a URL a ser conectada
porta	INT	Especifica a porta a ser conectada

Excluir

Exclui um cluster HDInsight.

Solicitação

Confira Parâmetros e cabeçalhos comuns para cabeçalhos e parâmetros usados por clusters.

Método	URI da solicitação
DELETE	`https://management.azure.com/subscriptions/{subscription Id}/resourceGroups/{resourceGroup Name}/providers/Microsoft.HDInsight/clusters/{cluster name}?api-version={api-version}`

Resposta

HTTP 202 (Aceito) para indicar que a operação será concluída de forma assíncrona. A sondagem assíncrona retornará um 204 (NoContent) depois que a operação for concluída com êxito.

Comentários

Para acompanhar o progresso de uma solicitação de cluster de exclusão, consulte Operações assíncronas (cabeçalho 202 Aceito e Local)

Get

Obtém os detalhes/propriedades do cluster especificado.

Solicitação

Confira Parâmetros e cabeçalhos comuns para cabeçalhos e parâmetros usados por clusters.

Método	URI da solicitação
GET	`https://management.azure.com/subscriptions/{subscription Id}/resourceGroups/{resourceGroup Name}/providers/Microsoft.HDInsight/clusters/{cluster name}?api-version={api-version}`

Resposta

A operação retornará 200 (OK) se a solicitação for concluída com êxito

Código de status: 200 OK

O corpo da resposta é o mesmo que criar cluster.

Corpo da resposta para detalhes do cluster 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"  
                       }  
                     }  
                }  
            ]  
        }  
    }  
}

Nome do elemento	Type	Descrição
provisioningState	Cadeia de caracteres	Indica o estado de provisionamento atual.
clusterState	Cadeia de caracteres	Indica o estado do cluster HDInsight mais detalhado enquanto o provisionamento está em andamento.
createdDate	Data	Datetime quando a solicitação de criação do cluster foi recebida
quotaInfo	Tipo complexo	Especifica os núcleosUsusado pelo cluster
erros	Matriz de mensagens de erro	Contém a mensagem de erro se provisioningState = 'failed'
connectivityEndpoints	Tipo complexo	Especifica os pontos de extremidade públicos para o cluster

connectivityEndpoints

Nome do elemento	Type	Descrição
name	String	Nome amigável para o ponto de extremidade de conectividade
protocolo	String	Especifica o protocolo a ser usado (exemplo: HTTPS, SSH)
local	Cadeia de caracteres	Especifica a URL a ser conectada
porta	INT	Especifica a porta a ser conectada

Listar configurações

Recupera todos os detalhes de configuração do cluster (incluindo informações confidenciais).

Solicitação

Confira Parâmetros e cabeçalhos comuns para cabeçalhos e parâmetros usados por clusters.

Método	URI da solicitação
POST	`https://management.azure.com/subscriptions/{subscription Id}/resourceGroups/{resourceGroup Name}/providers/Microsoft.HDInsight/clusters/{cluster name}/configurations?api-version={api-version}`

Resposta

HTTP 200 (OK) após a conclusão bem-sucedida da operação.

Resposta de exemplo:

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

Nome do elemento	Type	Descrição
configurações	Dicionário	Esse elemento é um dicionário de tipo de configuração e seu dicionário de valor associado. O tipo de configuração do gateway é usado para configurar o usuário http usado para se conectar a APIs Web e ao portal do Ambari O tipo de configuração core-site é usado para configurar a conta de armazenamento padrão para o cluster

Obter informações de configuração

Obtém detalhes sobre um único tipo de configuração (omite valores confidenciais).

Solicitação

Confira Parâmetros e cabeçalhos comuns para cabeçalhos e parâmetros usados por clusters.

Método	URI da solicitação
GET	`https://management.azure.com/subscriptions/{subscription Id}/resourceGroups/{resourceGroup Name}/providers/Microsoft.HDInsight/clusters/{cluster name}/configurations/{configuration Type}?api-version={api-version}`

Resposta

HTTP 200 (OK) após a conclusão bem-sucedida da operação.

Resposta de exemplo:

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

Obter configurações de gateway

Essa operação recupera as credenciais HTTP do gateway de cluster.

Solicitação

Confira Parâmetros e cabeçalhos comuns para cabeçalhos e parâmetros usados por clusters.

Método	URI da solicitação
POST	`https://management.azure.com/subscriptions/{subscription Id}/resourceGroups/{resourceGroup Name}/providers/Microsoft.HDInsight/clusters/{cluster name}/getGatewaySettings?api-version={api-version}`

Resposta

HTTP 200 (OK) após a conclusão bem-sucedida da operação.

Resposta de exemplo:

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

Atualizar configurações de gateway

Essa operação permite que os usuários alterem as credenciais HTTP do gateway de cluster.

Solicitação

Confira Parâmetros e cabeçalhos comuns para cabeçalhos e parâmetros usados por clusters.

Método	URI da solicitação
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!"  
}

Resposta

HTTP 202 (Aceito) após a conclusão bem-sucedida da operação.

Alterar configurações de conectividade (PRETERIDO)

~~Essa operação permite que os usuários habilitem/desabilitem a conectividade HTTPS com o cluster.~~

Em vez disso, use updateGatewaySettings .

Solicitação

Confira Parâmetros e cabeçalhos comuns para cabeçalhos e parâmetros usados por clusters.

Método	URI da solicitação
POST	`https://management.azure.com/subscriptions/{subscription Id}/resourceGroups/{resourceGroup Name}/providers/Microsoft.HDInsight/clusters/{cluster name}/configurations/{configuration Type}?api-version={api-version}`

Para habilitar a conectividade

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

Listar por grupo de recursos

Listas todos os clusters na assinatura do usuário no grupo de recursos especificado.

Solicitação

Confira Parâmetros e cabeçalhos comuns para cabeçalhos e parâmetros usados por clusters.

Método	URI da solicitação
GET	`https://management.azure.com/subscriptions/{subscription Id}/resourcegroups/{resourceGroup Id}/providers/Microsoft.HDInsight/clusters?api-version={api-version}`

Resposta

A operação retornará 200 (OK) se a solicitação for concluída com êxito.

Código de status: 200 OK

O corpo da resposta é uma matriz de detalhes do cluster. Para obter mais informações, consulte Obter propriedades do cluster.

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

Listar por assinatura

Listas todos os clusters na assinatura do usuário.

Solicitação

Confira Parâmetros e cabeçalhos comuns para cabeçalhos e parâmetros usados por clusters.

Método	URI da solicitação
GET	`https://management.azure.com/subscriptions/{subscription Id}/providers/Microsoft.HDInsight/clusters?api-version={api-version}`

Resposta

A operação retornará 200 (OK) se a solicitação for concluída com êxito.

Código de status: 200 OK

O corpo da resposta é uma matriz de detalhes do cluster.

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

Para desabilitar a conectividade

{  
   "restAuthCredential.isEnabled": false  
}

Nome do elemento	Obrigatório	Tipo	Descrição
restAuthCredential.isEnabled	Sim	Boolean	Especifica se a conectividade deve ser habilitada ou desabilitada
restAuthCredential.username	Não	String	Obrigatório se isEnabled=true Especifica o nome de usuário para configurações de conectividade
restAuthCredential.password	Não	String	Obrigatório se isEnabled=true Especifica a senha para configurações de conectividade

Resposta

HTTP 202 (Aceito) para indicar que a operação será concluída de forma assíncrona. A sondagem assíncrona retornará um 204 (NoContent) depois que a operação for concluída com êxito.

Comentários

Para acompanhar o progresso de uma solicitação de cluster de exclusão, consulte Operações assíncronas (cabeçalho 202 Aceito e Local)

Alterar configurações de RDP (somente cluster do Windows)

Essa operação permite que um usuário habilite/desabilite o RDP. Aplica-se a clusters baseados no Windows.

Solicitação

Confira Parâmetros e cabeçalhos comuns para cabeçalhos e parâmetros usados por clusters.

Método	URI da solicitação
POST	`https://management.azure.com/subscriptions/{subscription Id}/resourceGroups/{resourceGroup Name}/providers/Microsoft.HDInsight/clusters/{cluster name}/changerdpsetting?api-version={api-version}`

Corpo da solicitação

Para habilitar o RDP

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

Para desabilitar o RDP

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

osProfile

Nome do elemento	Obrigatório	Tipo	Descrição
windowsOperatingSystemProfile	No	Tipo complexo	Especifica as configurações relacionadas ao sistema operacional do Windows

windowsOperatingSystemProfile

Nome do elemento	Obrigatório	Tipo	Descrição
rdpSettings	No	Tipo complexo	Especifica as configurações de RDP para clusters do Windows

rdpSettings

Nome do elemento	Obrigatório	Tipo	Descrição
Nome de Usuário	Sim	String	Especifica o nome de usuário RDP
password	Sim	String	Especifica a senha para o usuário RDP
expirayDate	Sim	Data	Data de expiração para as credenciais rdp

Resposta

A operação retornará 200 (OK) se a solicitação for concluída com êxito

Código de status: 200 OK

O corpo da resposta é o mesmo que Criar um cluster.

Executar ações de script em um cluster em execução (somente cluster linux)

Executar a ação Script em um cluster em execução.

Solicitação

Confira Parâmetros e cabeçalhos comuns para cabeçalhos e parâmetros usados por clusters.

Método	URI da solicitação
POST	`https://management.azure.com/subscriptions/{subscription Id}/resourceGroups/{resourceGroup Name}/providers/Microsoft.HDInsight/clusters/{cluster name}/executeScriptActions?api-version={api-version}`

Corpo da solicitação

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

scriptActions

Nome do elemento	Obrigatório	Tipo	Descrição
name	Sim	String	Especifica o nome da ação de script
uri	Sim	String	Especifica o URI da ação de script
parameters	Sim	String	Especifica os parâmetros exigidos pela ação de script
funções	Yes	Matriz de cadeia de caracteres	Especifica as funções de destino em que a ação de script é executada
persistOnSuccess	Sim	Boolean	Especifica se as ações de script serão mantidas após execuções bem-sucedidas

Resposta

Se a validação for concluída e a solicitação for aceita, a operação retornará 202 (Aceito).

Código de status: 202 (Aceito)

Listar todas as Ações de Script persistentes para um cluster (somente cluster linux)

Essa operação retorna todas as ações de scripts persistentes do cluster especificado.

Solicitação

Confira Parâmetros e cabeçalhos comuns para cabeçalhos e parâmetros usados por clusters.

Método	URI da solicitação
GET	`https://management.azure.com/subscriptions/{subscription Id}/resourceGroups/{resourceGroup Name}/providers/Microsoft.HDInsight/clusters/{cluster name}/scriptActions?api-version={api-version}`

Resposta

HTTP 200 (OK) após a conclusão bem-sucedida da operação.

Código de status: 200 OK

Resposta de exemplo:

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

Nome do elemento	Type	Descrição
name	String	Especifica o nome da ação de script.
uri	String	Especifica o URI da ação de script.
parameters	Cadeia de caracteres	Especifica os parâmetros exigidos pela ação de script
funções	Matriz de cadeia de caracteres	Especifica as funções de destino em que a ação de script é executada.
applicationName	String	Especifica o aplicativo correspondente ao qual o script está associado. applicationName será nulo se o script for fornecido pelos usuários

Remover uma ação de script persistente para um cluster (somente cluster linux)

Essa operação remove uma ação de script persistente do HDInsight para um cluster.

Solicitação

Confira Parâmetros e cabeçalhos comuns para cabeçalhos e parâmetros usados por clusters.

Método	URI da solicitação
DELETE	`https://management.azure.com/subscriptions/{subscription Id}/resourceGroups/{resourceGroup Name}/providers/Microsoft.HDInsight/clusters/{cluster name}/scriptActions/{script Name}?api-version={api-version}`

Resposta

HTTP 200 (OK) para indicar que a ação de script foi removida da lista de ações de script persistentes.
HTTP 404 (NotFound) para indicar que não há nenhuma ação de script persistente existente com scriptName correspondente.

Obter a execução da Ação de Script do histórico (somente clusters do Linux)

Esta operação retorna a execução de ação de scripts mais recente do cluster especificado ou detalhes de execução para uma execução de script individual.

Solicitação

Confira Parâmetros e cabeçalhos comuns para cabeçalhos e parâmetros usados por clusters.

Método	URI da solicitação
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}`

Resposta

A operação retornará 200 (OK) se a solicitação for concluída com êxito. O corpo da resposta é uma matriz de detalhes de execução de script ou um único detalhes de execução de script se scriptExecutionId for fornecido. Abaixo está um exemplo de um detalhe de execução de script.

Código de status: 200 (OK)

Resposta de exemplo:

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

Nome do elemento	Type	Descrição
scriptExecutionId	long	Especifica a ID de execução da ação de script.
name	String	Especifica o nome da ação de script.
applicationName	String	Especifica o aplicativo correspondente ao qual o script está associado. applicationName será nulo se o script for fornecido pelos usuários
uri	String	Especifica o URI da ação de script.
parameters	Cadeia de caracteres	Especifica os parâmetros exigidos pela ação de script
funções	Matriz de cadeia de caracteres	Especifica as funções de destino nas quais a ação de script é executada.
startTime	Datetime	Especifica a hora de início da execução da ação de script
endTime	Datetime	Especifica a hora de término da execução da ação de script
status	String	Especifica o status da execução da ação de script
operação	Cadeia de caracteres	Especifica o motivo pelo qual a ação de script foi executada. Por exemplo, ScaleUp significa que a ação de script foi executada durante a escala vertical do cluster.
executionSummary	Matriz de tipo complexo	Especifica o resumo da execução em termos de quantos hosts foram bem-sucedidos e quantos hosts falharam ao executar o script.
debugInformation	Cadeia de caracteres	Especifica informações detalhadas de depuração para o script. debugInformation é retornado somente quando um scriptExecutionId é fornecido na solicitação.

executionSummary

Nome do elemento	Type	Descrição
status	String	Especifica o status da execução em hosts individuais.
instanceCount	int	Especifica o número de execuções com status correspondentes.

Promover um script do histórico de execução da Ação de Script a ser persistido (somente cluster do Linux)

Essa operação promove um script HDInsight do histórico de execução de script a ser persistido.

Solicitação

Consulte Parâmetros e cabeçalhos comuns para cabeçalhos e parâmetros usados por clusters.

Método	URI da solicitação
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}`

Resposta

HTTP 200 (OK) para indicar que a ação de script foi promovida.
HTTP 404 (NotFound) para indicar que não há nenhuma execução de ação de script existente com scriptExecutionId correspondente.

Redimensionar

Redimensiona um cluster HDInsight existente.

Solicitação

Consulte Parâmetros e cabeçalhos comuns para cabeçalhos e parâmetros usados por clusters.

Método	URI da solicitação
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}`

A seguir, mostra um exemplo de solicitação para atualizar marcas para um cluster

{  
    "targetInstanceCount": 10  
}

Nome do elemento	Obrigatório	Tipo	Descrição
targetInstanceCount	Yes	int	Especifica a nova contagem de instâncias para a função

Resposta

HTTP 202 (Aceito) para indicar que a operação será concluída de forma assíncrona. A sondagem assíncrona retornará um 204 (NoContent) assim que a operação for concluída com êxito.

Comentários

Para acompanhar o progresso de uma solicitação de exclusão de cluster, consulte Operações assíncronas (cabeçalho 202 Aceito e Local)

Atualizar

Atualizações marcas para um cluster.

Todas as outras atualizações são ações separadas descritas separadamente.

Solicitação

Consulte Parâmetros e cabeçalhos comuns para cabeçalhos e parâmetros usados por clusters.

Método	URI da solicitação
PATCH	`https://management.azure.com/subscriptions/{subscription Id}/resourceGroups/{resourceGroup Name}/providers/Microsoft.HDInsight/clusters/{cluster name}?api-version={api-version}`

A seguir, mostra um exemplo de solicitação para atualizar marcas para um cluster

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

Nome do elemento	Obrigatório	Tipo	Descrição
marcas	Sim	String	Especifica as marcas que serão atribuídas ao cluster. Para obter mais informações sobre como usar marcas, consulte Usando marcas para organizar seus recursos do Azure.

Resposta

A operação retornará 200 (OK) se a solicitação for concluída com êxito.

Código de status: 200 OK

O corpo da resposta é o mesmo que Criar um cluster.

Share via

API REST do cluster no Azure HDInsight

Criar

Solicitação

Propriedades

clusterDefinition

computeProfile

função

hardwareProfile

osProfile

linuxOperatingSystemProfile

sshProfile

windowsOperatingSystemProfile

rdpSettings

virtualNetworkProfile

scriptActions

Resposta

connectivityEndpoints

Criar um cluster HDInsight premium ingressado no domínio (somente Linux, versão prévia)

Solicitação

Propriedades

clusterDefinition

computeProfile

securityProfile

função

hardwareProfile

osProfile

linuxOperatingSystemProfile

sshProfile

virtualNetworkProfile

scriptActions

Resposta

connectivityEndpoints

Criar um cluster com o Azure Data Lake Store como o sistema de arquivos padrão

Solicitação

Propriedades

clusterDefinition

computeProfile

função

hardwareProfile

osProfile

linuxOperatingSystemProfile

sshProfile

virtualNetworkProfile

scriptActions

Resposta

connectivityEndpoints

Excluir

Solicitação

Resposta

Comentários

Get

Solicitação

Resposta

connectivityEndpoints

Listar configurações

Solicitação

Resposta

Obter informações de configuração

Solicitação

Resposta

Obter configurações de gateway

Solicitação

Resposta

Atualizar configurações de gateway

Solicitação

Resposta

Alterar configurações de conectividade (PRETERIDO)

Solicitação

Listar por grupo de recursos

Solicitação

Resposta

Listar por assinatura

Solicitação

Resposta

Resposta

Comentários

Alterar configurações de RDP (somente cluster do Windows)

Solicitação

osProfile