Compartilhar via


Azure Resource Manager

O Azure Resource Manager expõe as APIs para gerenciar todos os recursos do Azure.

Esse conector está disponível nos seguintes produtos e regiões:

Service Class Regions
Copilot Studio Premium Todas as regiões do Power Automate
Aplicativos Lógicos Standard Todas as regiões de Aplicativos Lógicos
Power Apps Premium Todas as regiões do Power Apps
Power Automate Premium Todas as regiões do Power Automate
Contato
Nome Microsoft
URL Suporte do Microsoft LogicApps
Suporte do Microsoft Power Automate
Suporte do Microsoft Power Apps
Metadados do conector
Publicador Microsoft
Site https://azure.microsoft.com/features/resource-manager/

Problemas e limitações conhecidos

  • Se você tiver um erro com a mensagem "Não foi possível encontrar nenhuma conexão válida para o nome de referência de conexão 'shared_office365' no cabeçalho de tokens APIM", você poderá solucionar problemas fazendo o seguinte:
    • Limpe o cache do navegador.
    • Exclua a conexão e adicione-a novamente.
  • A ação Listar marcas de recurso de assinatura pode efetuar pull dos dados de marca excluídos devido a limitações no serviço subjacente que gerencia dados de marca.
  • Por design, o Conector ARM no Power Automate não dá suporte a atribuições de função de usuário diretas para segredos do Azure Key Vault.

Criando uma conexão

O conector dá suporte aos seguintes tipos de autenticação:

Default Parâmetros para criar conexão. Todas as regiões Não compartilhável

Padrão

Aplicável: todas as regiões

Parâmetros para criar conexão.

Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Limitações

Nome Chamadas Período de renovação
Chamadas à API por conexão 1200 60 segundos

Ações

Atualizar um grupo de recursos existente

Atualiza um grupo de recursos existente. Se o recurso não existir, essa solicitação falhará.

Cancelar o registro do provedor de recursos

Cancela o registro do provedor de uma assinatura. Essa operação falhará se houver recursos desse provedor de recursos na assinatura.

Cancelar uma implantação de modelo

Cancele uma implantação de modelo em execução no momento. Todas as operações de modelo pendentes serão suspensas.

Criar ou atualizar um grupo de recursos

Criar ou atualizar um grupo de recursos. O código de resposta pode ser usado para distinguir entre uma criação (201) ou uma atualização (200).

Criar ou atualizar um nome de marca de recurso de assinatura

Crie ou atualize um nome de marca de recurso de assinatura.

Criar ou atualizar um recurso

Cria ou atualiza um recurso. O código de resposta pode ser usado para distinguir entre uma criação (201) ou uma atualização (200).

Criar ou atualizar um valor de marca de recurso de assinatura

Criar ou atualizar um valor de marca de recurso de assinatura.

Criar ou atualizar uma implantação de modelo

Crie ou atualize uma implantação de modelo de grupo de recursos nomeado. Um modelo e parâmetros são esperados para que a solicitação seja bem-sucedida.

Excluir implantação de modelo

Exclui uma implantação de modelo de grupo de recursos. Os recursos não serão excluídos; apenas os metadados sobre a implantação do modelo.

Excluir um grupo de recursos

Exclua um grupo de recursos específico na assinatura.

Excluir um nome de marca de recurso de assinatura

Exclua um nome de marca de recurso de assinatura.

Excluir um recurso

Exclui um recurso.

Excluir um valor de marca de recurso de assinatura

Exclua um valor de marca de recurso de assinatura.

Exportar modelo de implantação

Exporta um modelo de uma implantação de grupo de recursos anterior.

Exportar um modelo de grupo de recursos

Exporta um modelo de implantação de um grupo de recursos existente. Isso só poderá ser bem-sucedido se os recursos subjacentes tiverem um esquema definido pela Microsoft.

Invocar a operação de recurso no provedor

Invoca uma operação em um recurso do Azure.

Invocar operação de recurso

Invoca uma operação em um recurso do Azure.

Ler provedor de recursos

Lê um provedor de recursos específico na assinatura.

Ler um grupo de recursos

Lê um grupo de recursos específico na assinatura.

Ler um recurso

Lê um objeto de recurso.

Ler um recurso no provedor

Lê um objeto de recurso.

Ler uma assinatura

Lê os detalhes de uma assinatura específica.

Ler uma implantação de modelo

Lê uma implantação de modelo em um grupo de recursos.

Ler uma operação de implantação de modelo

Lê uma operação de implantação de modelo de grupo de recursos específica. Isso é útil para solucionar problemas de implantações de modelo com falha.

Lista as operações de implantação de modelo

Lista todas as operações de implantação de modelo. Isso é útil para solucionar problemas de implantações de modelo com falha.

Lista os locais de assinatura

Lista os locais disponíveis para a assinatura.

Listar assinaturas

Obtém uma lista de todas as assinaturas às quais a entidade de segurança tem acesso.

Listar grupos de recursos

Lista todos os grupos de recursos na assinatura. Os resultados são paginados em mais de 1.000 registros.

Listar implantações de modelo

Lista todas as implantações de modelo do grupo de recursos. Essa operação é útil para saber o que foi provisionado até agora.

Listar marcas de recurso de assinatura

Lista todas as marcas de recurso de assinatura.

Listar provedores de recursos

Lista os provedores de recursos disponíveis para a assinatura.

Listar recursos por assinatura

Lê todos os recursos em uma assinatura específica. Os resultados são paginados em mais de 1.000 registros.

Listar recursos por grupo de recursos

Lista todos os recursos em um grupo de recursos.

Registrar provedor de recursos

Registra um provedor de recursos a ser usado com uma assinatura. Isso provisionará permissões para o serviço em sua assinatura.

Validar uma implantação de modelo

Valida um modelo de implantação. Essa operação não tem efeitos colaterais e pode ser usada para testar uma implantação de modelo para sintaxe ou erros lógicos.

Atualizar um grupo de recursos existente

Atualiza um grupo de recursos existente. Se o recurso não existir, essa solicitação falhará.

Parâmetros

Nome Chave Obrigatório Tipo Description
Subscription
subscriptionId True string

O identificador exclusivo para a assinatura do Microsoft Azure. A ID da assinatura faz parte da ID de cada recurso do Azure.

Grupo de Recursos
resourceGroupName True string

Nome do grupo de recursos.

ID
id string

A ID do grupo de recursos (por exemplo, /subscriptions/XXX/resourceGroups/YYY).

Nome
name string

O nome do grupo de recursos.

Localização
location True string

O local do grupo de recursos. Ele não pode ser alterado após a criação do grupo de recursos. Tem que ser um dos locais do Azure com suporte, como Oeste dos EUA, Leste dos EUA, Europa Ocidental, Leste da Ásia, etc.

Gerenciado Por
managedBy string

ID do recurso que gerencia esse grupo de recursos.

Etiquetas
tags object

As marcas anexadas ao grupo de recursos.

Estado de provisionamento
provisioningState string

O estado de provisionamento.

Retornos

Informações do grupo de recursos.

Cancelar o registro do provedor de recursos

Cancela o registro do provedor de uma assinatura. Essa operação falhará se houver recursos desse provedor de recursos na assinatura.

Parâmetros

Nome Chave Obrigatório Tipo Description
Subscription
subscriptionId True string

O identificador exclusivo para a assinatura do Microsoft Azure. A ID da assinatura faz parte da ID de cada recurso do Azure.

Provedor de recursos
resourceProviderNamespace True string

Namespace do provedor de recursos.

Retornos

Informações do provedor de recursos.

Corpo
Provider

Cancelar uma implantação de modelo

Cancele uma implantação de modelo em execução no momento. Todas as operações de modelo pendentes serão suspensas.

Parâmetros

Nome Chave Obrigatório Tipo Description
Subscription
subscriptionId True string

O identificador exclusivo para a assinatura do Microsoft Azure. A ID da assinatura faz parte da ID de cada recurso do Azure.

Grupo de Recursos
resourceGroupName True string

Nome do grupo de recursos.

Nome da implantação
deploymentName True string

O nome da implantação do modelo do grupo de recursos.

Criar ou atualizar um grupo de recursos

Criar ou atualizar um grupo de recursos. O código de resposta pode ser usado para distinguir entre uma criação (201) ou uma atualização (200).

Parâmetros

Nome Chave Obrigatório Tipo Description
Subscription
subscriptionId True string

O identificador exclusivo para a assinatura do Microsoft Azure. A ID da assinatura faz parte da ID de cada recurso do Azure.

Nome do Grupo de Recursos
resourceGroupName True string

O nome do grupo de recursos a ser criado ou atualizado.

ID
id string

A ID do grupo de recursos (por exemplo, /subscriptions/XXX/resourceGroups/YYY).

Nome
name string

O nome do grupo de recursos.

Localização
location True string

O local do grupo de recursos. Ele não pode ser alterado após a criação do grupo de recursos. Tem que ser um dos locais do Azure com suporte, como Oeste dos EUA, Leste dos EUA, Europa Ocidental, Leste da Ásia, etc.

Gerenciado Por
managedBy string

ID do recurso que gerencia esse grupo de recursos.

Etiquetas
tags object

As marcas anexadas ao grupo de recursos.

Estado de provisionamento
provisioningState string

O estado de provisionamento.

Retornos

Informações do grupo de recursos.

Criar ou atualizar um nome de marca de recurso de assinatura

Crie ou atualize um nome de marca de recurso de assinatura.

Parâmetros

Nome Chave Obrigatório Tipo Description
Subscription
subscriptionId True string

O identificador exclusivo para a assinatura do Microsoft Azure. A ID da assinatura faz parte da ID de cada recurso do Azure.

Nome da Marca
tagName True string

O nome da marca.

Retornos

Detalhes da marca.

Corpo
TagDetails

Criar ou atualizar um recurso

Cria ou atualiza um recurso. O código de resposta pode ser usado para distinguir entre uma criação (201) ou uma atualização (200).

Parâmetros

Nome Chave Obrigatório Tipo Description
Subscription
subscriptionId True string

O identificador exclusivo para a assinatura do Microsoft Azure. A ID da assinatura faz parte da ID de cada recurso do Azure.

Grupo de Recursos
resourceGroupName True string

Nome do grupo de recursos.

Provedor de recursos
resourceProviderNamespace True string

Namespace do provedor de recursos.

ID de recurso curto
shortResourceId True string

A ID curta do recurso, incluindo o nome do recurso e o tipo de recurso. Por exemplo, sites/mySite

Versão da API do Cliente
x-ms-api-version True string

Versão da API a ser usada.

ID
id string

ID do recurso

Nome
name string

Nome do recurso

Tipo
type string

Tipo de recurso

Localização
location string

Local do recurso

Etiquetas
tags object

Etiquetas de recursos

ID
name string

A ID do plano.

Publicador
publisher string

A ID do editor.

Product
product string

A ID da oferta.

Código de promoção
promotionCode string

O código de promoção.

Variante
kind string

O tipo do recurso.

Gerenciado Por
managedBy string

ID do recurso que gerencia esse recurso.

Nome
name string

O nome do sku.

Camada
tier string

A camada de sku.

Tamanho
size string

O tamanho da sku.

Família
family string

A família SKU.

Modelo
model string

O modelo de sku.

Capacity
capacity integer

A capacidade de sku.

ID da entidade de segurança
principalId string

A ID principal da identidade do recurso.

ID do Inquilino
tenantId string

A ID do locatário do recurso.

Tipo
type string

O tipo de identidade.

Propriedades
properties object

As propriedades do recurso.

Retornos

Informações sobre o recurso.

Criar ou atualizar um valor de marca de recurso de assinatura

Criar ou atualizar um valor de marca de recurso de assinatura.

Parâmetros

Nome Chave Obrigatório Tipo Description
Subscription
subscriptionId True string

O identificador exclusivo para a assinatura do Microsoft Azure. A ID da assinatura faz parte da ID de cada recurso do Azure.

Nome da Marca
tagName True string

O nome da marca.

Valor da marca
tagValue True string

O valor da etiqueta.

Retornos

Informações de marcação.

Corpo
TagValue

Criar ou atualizar uma implantação de modelo

Crie ou atualize uma implantação de modelo de grupo de recursos nomeado. Um modelo e parâmetros são esperados para que a solicitação seja bem-sucedida.

Parâmetros

Nome Chave Obrigatório Tipo Description
Subscription
subscriptionId True string

O identificador exclusivo para a assinatura do Microsoft Azure. A ID da assinatura faz parte da ID de cada recurso do Azure.

Grupo de Recursos
resourceGroupName True string

Nome do grupo de recursos.

Nome da implantação
deploymentName True string

O nome da implantação.

Conteúdo do modelo
template object

O conteúdo do modelo. Pode ser um JObject ou uma cadeia de caracteres JSON bem formada. Use apenas um modelo ou TemplateLink.

URI do modelo
uri True string

URI referenciando o modelo.

Versão do conteúdo do modelo
contentVersion string

Se incluído, ele deverá corresponder ao ContentVersion no modelo.

Parâmetros
parameters object

Parâmetros de implantação. Pode ser um JObject ou uma cadeia de caracteres JSON bem formada. Use apenas um dos Parâmetros ou ParametersLink.

URI de parâmetros
uri True string

URI referenciando o modelo.

Versão do conteúdo de parâmetros
contentVersion string

Se incluído, ele deverá corresponder ao ContentVersion no modelo.

Modo de Implantação
mode True string

O modo de implantação.

Nível de detalhes
detailLevel string

O nível de detalhes de depuração.

Aguardar a implantação
wait boolean

Se a ação deve aguardar até que a implantação seja concluída

Retornos

Informações de implantação.

Excluir implantação de modelo

Exclui uma implantação de modelo de grupo de recursos. Os recursos não serão excluídos; apenas os metadados sobre a implantação do modelo.

Parâmetros

Nome Chave Obrigatório Tipo Description
Subscription
subscriptionId True string

O identificador exclusivo para a assinatura do Microsoft Azure. A ID da assinatura faz parte da ID de cada recurso do Azure.

Grupo de Recursos
resourceGroupName True string

Nome do grupo de recursos.

Nome da implantação
deploymentName True string

O nome da implantação do modelo do grupo de recursos.

Excluir um grupo de recursos

Exclua um grupo de recursos específico na assinatura.

Parâmetros

Nome Chave Obrigatório Tipo Description
Subscription
subscriptionId True string

O identificador exclusivo para a assinatura do Microsoft Azure. A ID da assinatura faz parte da ID de cada recurso do Azure.

Grupo de Recursos
resourceGroupName True string

Nome do grupo de recursos.

Excluir um nome de marca de recurso de assinatura

Exclua um nome de marca de recurso de assinatura.

Parâmetros

Nome Chave Obrigatório Tipo Description
Subscription
subscriptionId True string

O identificador exclusivo para a assinatura do Microsoft Azure. A ID da assinatura faz parte da ID de cada recurso do Azure.

Nome da Marca
tagName True string

O nome da marca.

Excluir um recurso

Exclui um recurso.

Parâmetros

Nome Chave Obrigatório Tipo Description
Subscription
subscriptionId True string

O identificador exclusivo para a assinatura do Microsoft Azure. A ID da assinatura faz parte da ID de cada recurso do Azure.

Grupo de Recursos
resourceGroupName True string

Nome do grupo de recursos.

Provedor de recursos
resourceProviderNamespace True string

Namespace do provedor de recursos.

ID de recurso curto
shortResourceId True string

A ID curta do recurso, incluindo o nome do recurso e o tipo de recurso. Por exemplo, sites/mySite

Versão da API do Cliente
x-ms-api-version True string

Versão da API a ser usada.

Excluir um valor de marca de recurso de assinatura

Exclua um valor de marca de recurso de assinatura.

Parâmetros

Nome Chave Obrigatório Tipo Description
Subscription
subscriptionId True string

O identificador exclusivo para a assinatura do Microsoft Azure. A ID da assinatura faz parte da ID de cada recurso do Azure.

Nome da Marca
tagName True string

O nome da marca.

Valor da marca
tagValue True string

O valor da etiqueta.

Exportar modelo de implantação

Exporta um modelo de uma implantação de grupo de recursos anterior.

Parâmetros

Nome Chave Obrigatório Tipo Description
Subscription
subscriptionId True string

O identificador exclusivo para a assinatura do Microsoft Azure. A ID da assinatura faz parte da ID de cada recurso do Azure.

Grupo de Recursos
resourceGroupName True string

Nome do grupo de recursos.

Nome da implantação
deploymentName True string

O nome da implantação do modelo do grupo de recursos.

Retornos

O resultado da exportação da implantação.

Exportar um modelo de grupo de recursos

Exporta um modelo de implantação de um grupo de recursos existente. Isso só poderá ser bem-sucedido se os recursos subjacentes tiverem um esquema definido pela Microsoft.

Parâmetros

Nome Chave Obrigatório Tipo Description
Subscription
subscriptionId True string

O identificador exclusivo para a assinatura do Microsoft Azure. A ID da assinatura faz parte da ID de cada recurso do Azure.

Grupo de Recursos
resourceGroupName True string

Nome do grupo de recursos.

resources
resources array of string

As IDs dos recursos. A única cadeia de caracteres com suporte atualmente é '*' (todos os recursos). As atualizações futuras da API darão suporte à exportação de recursos específicos.

opções
options string

As opções de modelo de exportação. Os valores com suporte incluem 'IncludeParameterDefaultValue', 'IncludeComments' ou 'IncludeParameterDefaultValue, IncludeComments

Retornos

Invocar a operação de recurso no provedor

Invoca uma operação em um recurso do Azure.

Parâmetros

Nome Chave Obrigatório Tipo Description
Subscription
subscriptionId True string

O identificador exclusivo para a assinatura do Microsoft Azure. A ID da assinatura faz parte da ID de cada recurso do Azure.

Provedor de recursos
resourceProviderNamespace True string

Namespace do provedor de recursos.

ID de recurso curto
shortResourceId True string

A ID curta do recurso, incluindo o nome do recurso e o tipo de recurso. Por exemplo, sites/mySite

Versão da API do Cliente
x-ms-api-version True string

Versão da API a ser usada.

Retornos

A resposta da operação.

Resposta
object

Invocar operação de recurso

Invoca uma operação em um recurso do Azure.

Parâmetros

Nome Chave Obrigatório Tipo Description
Subscription
subscriptionId True string

O identificador exclusivo para a assinatura do Microsoft Azure. A ID da assinatura faz parte da ID de cada recurso do Azure.

Grupo de Recursos
resourceGroupName True string

Nome do grupo de recursos.

Provedor de recursos
resourceProviderNamespace True string

Namespace do provedor de recursos.

ID de recurso curto
shortResourceId True string

A ID curta do recurso, incluindo o nome do recurso e o tipo de recurso. Por exemplo, sites/mySite

Versão da API do Cliente
x-ms-api-version True string

Versão da API a ser usada.

Nome da ação
actionName True string

Nome da ação de recurso a ser invocada

Retornos

A resposta da operação de ação.

Resposta de ação
object

Ler provedor de recursos

Lê um provedor de recursos específico na assinatura.

Parâmetros

Nome Chave Obrigatório Tipo Description
Subscription
subscriptionId True string

O identificador exclusivo para a assinatura do Microsoft Azure. A ID da assinatura faz parte da ID de cada recurso do Azure.

Provedor de recursos
resourceProviderNamespace True string

Namespace do provedor de recursos.

Expanda
$expand string

O parâmetro de consulta $expand.

Retornos

Informações do provedor de recursos.

Corpo
Provider

Ler um grupo de recursos

Lê um grupo de recursos específico na assinatura.

Parâmetros

Nome Chave Obrigatório Tipo Description
Subscription
subscriptionId True string

O identificador exclusivo para a assinatura do Microsoft Azure. A ID da assinatura faz parte da ID de cada recurso do Azure.

Grupo de Recursos
resourceGroupName True string

Nome do grupo de recursos.

Retornos

Informações do grupo de recursos.

Ler um recurso

Lê um objeto de recurso.

Parâmetros

Nome Chave Obrigatório Tipo Description
Subscription
subscriptionId True string

O identificador exclusivo para a assinatura do Microsoft Azure. A ID da assinatura faz parte da ID de cada recurso do Azure.

Grupo de Recursos
resourceGroupName True string

Nome do grupo de recursos.

Provedor de recursos
resourceProviderNamespace True string

Namespace do provedor de recursos.

ID de recurso curto
shortResourceId True string

A ID curta do recurso, incluindo o nome do recurso e o tipo de recurso. Por exemplo, sites/mySite

Versão da API do Cliente
x-ms-api-version True string

Versão da API a ser usada.

Retornos

Informações sobre o recurso.

Ler um recurso no provedor

Lê um objeto de recurso.

Parâmetros

Nome Chave Obrigatório Tipo Description
Subscription
subscriptionId True string

O identificador exclusivo para a assinatura do Microsoft Azure. A ID da assinatura faz parte da ID de cada recurso do Azure.

Provedor de recursos
resourceProviderNamespace True string

Namespace do provedor de recursos.

ID de recurso curto
shortResourceId True string

A ID curta do recurso, incluindo o nome do recurso e o tipo de recurso. Por exemplo, sites/mySite

Versão da API do Cliente
x-ms-api-version True string

Versão da API a ser usada.

Retornos

Informações sobre o recurso.

Ler uma assinatura

Lê os detalhes de uma assinatura específica.

Parâmetros

Nome Chave Obrigatório Tipo Description
Subscription
subscriptionId True string

O identificador exclusivo para a assinatura do Microsoft Azure. A ID da assinatura faz parte da ID de cada recurso do Azure.

Retornos

Informações da assinatura.

Corpo
Subscription

Ler uma implantação de modelo

Lê uma implantação de modelo em um grupo de recursos.

Parâmetros

Nome Chave Obrigatório Tipo Description
Subscription
subscriptionId True string

O identificador exclusivo para a assinatura do Microsoft Azure. A ID da assinatura faz parte da ID de cada recurso do Azure.

Grupo de Recursos
resourceGroupName True string

Nome do grupo de recursos.

Nome da implantação
deploymentName True string

O nome da implantação do modelo do grupo de recursos.

Aguardar a implantação
wait boolean

Se a ação deve aguardar até que a implantação seja concluída

Retornos

Informações de implantação.

Ler uma operação de implantação de modelo

Lê uma operação de implantação de modelo de grupo de recursos específica. Isso é útil para solucionar problemas de implantações de modelo com falha.

Parâmetros

Nome Chave Obrigatório Tipo Description
Subscription
subscriptionId True string

O identificador exclusivo para a assinatura do Microsoft Azure. A ID da assinatura faz parte da ID de cada recurso do Azure.

Grupo de Recursos
resourceGroupName True string

Nome do grupo de recursos.

Nome da implantação
deploymentName True string

O nome da implantação do modelo do grupo de recursos.

ID da operação
operationId True string

ID da operação.

Retornos

Informações da operação de implantação.

Lista as operações de implantação de modelo

Lista todas as operações de implantação de modelo. Isso é útil para solucionar problemas de implantações de modelo com falha.

Parâmetros

Nome Chave Obrigatório Tipo Description
Subscription
subscriptionId True string

O identificador exclusivo para a assinatura do Microsoft Azure. A ID da assinatura faz parte da ID de cada recurso do Azure.

Grupo de Recursos
resourceGroupName True string

Nome do grupo de recursos.

Nome da implantação
deploymentName True string

O nome da implantação do modelo do grupo de recursos.

TOP
$top integer

Parâmetros de consulta. Se nada for passado, retornará todos os valores.

Retornos

Lista de operações de implantação.

Lista os locais de assinatura

Lista os locais disponíveis para a assinatura.

Parâmetros

Nome Chave Obrigatório Tipo Description
Subscription
subscriptionId True string

O identificador exclusivo para a assinatura do Microsoft Azure. A ID da assinatura faz parte da ID de cada recurso do Azure.

Retornos

Resposta da operação de lista de localização.

Listar assinaturas

Obtém uma lista de todas as assinaturas às quais a entidade de segurança tem acesso.

Retornos

Resposta da operação da lista de assinaturas.

Listar grupos de recursos

Lista todos os grupos de recursos na assinatura. Os resultados são paginados em mais de 1.000 registros.

Parâmetros

Nome Chave Obrigatório Tipo Description
Subscription
subscriptionId True string

O identificador exclusivo para a assinatura do Microsoft Azure. A ID da assinatura faz parte da ID de cada recurso do Azure.

Filter
$filter string

O filtro a ser aplicado na operação.

TOP
$top integer

Parâmetros de consulta. Se nada for passado, retornará todos os valores.

Retornos

Lista de grupos de recursos.

Listar implantações de modelo

Lista todas as implantações de modelo do grupo de recursos. Essa operação é útil para saber o que foi provisionado até agora.

Parâmetros

Nome Chave Obrigatório Tipo Description
Subscription
subscriptionId True string

O identificador exclusivo para a assinatura do Microsoft Azure. A ID da assinatura faz parte da ID de cada recurso do Azure.

Grupo de Recursos
resourceGroupName True string

Nome do grupo de recursos.

Filter
$filter string

O filtro a ser aplicado na operação.

TOP
$top integer

Parâmetros de consulta. Se nada for passado, retornará todos os valores.

Retornos

Lista de implantações.

Listar marcas de recurso de assinatura

Lista todas as marcas de recurso de assinatura.

Parâmetros

Nome Chave Obrigatório Tipo Description
Subscription
subscriptionId True string

O identificador exclusivo para a assinatura do Microsoft Azure. A ID da assinatura faz parte da ID de cada recurso do Azure.

Retornos

Lista de marcas de assinatura.

Listar provedores de recursos

Lista os provedores de recursos disponíveis para a assinatura.

Parâmetros

Nome Chave Obrigatório Tipo Description
Subscription
subscriptionId True string

O identificador exclusivo para a assinatura do Microsoft Azure. A ID da assinatura faz parte da ID de cada recurso do Azure.

TOP
$top integer

Parâmetros de consulta. Se nada for passado, retornará todos os valores.

Expanda
$expand string

O parâmetro de consulta $expand.

Retornos

Lista de provedores de recursos.

Listar recursos por assinatura

Lê todos os recursos em uma assinatura específica. Os resultados são paginados em mais de 1.000 registros.

Parâmetros

Nome Chave Obrigatório Tipo Description
Subscription
subscriptionId True string

O identificador exclusivo para a assinatura do Microsoft Azure. A ID da assinatura faz parte da ID de cada recurso do Azure.

Filter
$filter string

O filtro a ser aplicado na operação.

Expanda
$expand string

O parâmetro de consulta $expand.

TOP
$top integer

Parâmetros de consulta. Se nada for passado, retornará todos os valores.

Retornos

Lista de recursos.

Listar recursos por grupo de recursos

Lista todos os recursos em um grupo de recursos.

Parâmetros

Nome Chave Obrigatório Tipo Description
Subscription
subscriptionId True string

O identificador exclusivo para a assinatura do Microsoft Azure. A ID da assinatura faz parte da ID de cada recurso do Azure.

Grupo de Recursos
resourceGroupName True string

Nome do grupo de recursos.

Filter
$filter string

O filtro a ser aplicado na operação.

Expanda
$expand string

O parâmetro de consulta $expand.

TOP
$top integer

Parâmetros de consulta. Se nada for passado, retornará todos os valores.

Retornos

Lista de recursos.

Registrar provedor de recursos

Registra um provedor de recursos a ser usado com uma assinatura. Isso provisionará permissões para o serviço em sua assinatura.

Parâmetros

Nome Chave Obrigatório Tipo Description
Subscription
subscriptionId True string

O identificador exclusivo para a assinatura do Microsoft Azure. A ID da assinatura faz parte da ID de cada recurso do Azure.

Provedor de recursos
resourceProviderNamespace True string

Namespace do provedor de recursos.

Retornos

Informações do provedor de recursos.

Corpo
Provider

Validar uma implantação de modelo

Valida um modelo de implantação. Essa operação não tem efeitos colaterais e pode ser usada para testar uma implantação de modelo para sintaxe ou erros lógicos.

Parâmetros

Nome Chave Obrigatório Tipo Description
Subscription
subscriptionId True string

O identificador exclusivo para a assinatura do Microsoft Azure. A ID da assinatura faz parte da ID de cada recurso do Azure.

Grupo de Recursos
resourceGroupName True string

Nome do grupo de recursos.

Nome da implantação
deploymentName True string

O nome da implantação do modelo do grupo de recursos.

Conteúdo do modelo
template object

O conteúdo do modelo. Pode ser um JObject ou uma cadeia de caracteres JSON bem formada. Use apenas um modelo ou TemplateLink.

URI do modelo
uri True string

URI referenciando o modelo.

Versão do conteúdo do modelo
contentVersion string

Se incluído, ele deverá corresponder ao ContentVersion no modelo.

Parâmetros
parameters object

Parâmetros de implantação. Pode ser um JObject ou uma cadeia de caracteres JSON bem formada. Use apenas um dos Parâmetros ou ParametersLink.

URI de parâmetros
uri True string

URI referenciando o modelo.

Versão do conteúdo de parâmetros
contentVersion string

Se incluído, ele deverá corresponder ao ContentVersion no modelo.

Modo de Implantação
mode True string

O modo de implantação.

Nível de detalhes
detailLevel string

O nível de detalhes de depuração.

Retornos

Informações da resposta de implantação de modelo de validação.

Definições

Localização

Informações de localização.

Nome Caminho Tipo Description
ID
id string

A ID totalmente qualificada do local. Por exemplo, /subscriptions/000000000-0000-0000-0000-000000000000/locations/westus.

ID da assinatura
subscriptionId string

A ID da assinatura.

Nome do Local
name string

O nome do local.

Nome de Exibição
displayName string

O nome de exibição do local.

Latitude
latitude string

A latitude do local.

Longitude
longitude string

A longitude do local.

LocationListResult

Resposta da operação de lista de localização.

Nome Caminho Tipo Description
value
value array of Location

Os locais.

Subscription

Informações da assinatura.

Nome Caminho Tipo Description
ID
id string

A ID totalmente qualificada. Por exemplo, /subscriptions/000000000-0000-0000-0000-0000000000000.

ID da assinatura
subscriptionId string

A ID da assinatura.

ID do Inquilino
tenantId string

A ID do locatário.

Nome de Exibição
displayName string

O nome de exibição da assinatura.

Estado
state string

O estado da assinatura.

Políticas de assinatura
subscriptionPolicies SubscriptionPolicies

Políticas de assinatura.

Fonte de autorização
authorizationSource string

A origem da autorização da solicitação. Os valores válidos são uma ou mais combinações de Legacy, RoleBased, Bypassed, Direct e Management. Por exemplo, "Herdado, RoleBased".

SubscriptionPolicies

Políticas de assinatura.

Nome Caminho Tipo Description
ID de Posicionamento do Local
locationPlacementId string

A ID de posicionamento do local da assinatura. A ID indica quais regiões estão visíveis para uma assinatura. Por exemplo, uma assinatura com uma ID de posicionamento de local de Public_2014-09-01 tem acesso a regiões públicas do Azure.

ID da cota
quotaId string

A ID da cota de assinatura.

Limite de gastos
spendingLimit string

O limite de gastos da assinatura.

SubscriptionListResult

Resposta da operação da lista de assinaturas.

Nome Caminho Tipo Description
value
value array of Subscription

As assinaturas.

Próximo Link
nextLink string

A URL para obter o próximo conjunto de resultados.

Entidade que representa a referência ao modelo.

Nome Caminho Tipo Description
URI do modelo
uri string

URI referenciando o modelo.

Versão do conteúdo do modelo
contentVersion string

Se incluído, ele deverá corresponder ao ContentVersion no modelo.

Entidade que representa a referência aos paramatadores de implantação.

Nome Caminho Tipo Description
URI de parâmetros
uri string

URI referenciando o modelo.

Versão do conteúdo de parâmetros
contentVersion string

Se incluído, ele deverá corresponder ao ContentVersion no modelo.

Configuração de depuração

Nome Caminho Tipo Description
Nível de detalhes
detailLevel string

O nível de detalhes de depuração.

DeploymentExportResult

O resultado da exportação da implantação.

Nome Caminho Tipo Description
Template
template object

O conteúdo do modelo.

ResourceManagementErrorWithDetails

Nome Caminho Tipo Description
codificar
code string

O código de erro retornado do servidor.

mensagem
message string

A mensagem de erro retornada do servidor.

destino
target string

O destino do erro.

details
details array of object

Erro de validação.

AliasPathType

O tipo dos caminhos para alias.

Nome Caminho Tipo Description
caminho
path string

O caminho de um alias.

apiVersions
apiVersions array of string

As versões da API.

AliasType

O tipo de alias.

Nome Caminho Tipo Description
nome
name string

O nome do alias.

Caminhos
paths array of AliasPathType

Os caminhos para um alias.

ProviderResourceType

Tipo de recurso gerenciado pelo provedor de recursos.

Nome Caminho Tipo Description
resourceType
resourceType string

O tipo de recurso.

Locais
locations array of ObjectWithoutType

A coleção de locais em que esse tipo de recurso pode ser criado.

aliases
aliases array of AliasType

Os aliases compatíveis com esse tipo de recurso.

apiVersions
apiVersions array of string

A versão da API.

propriedades
properties object

As propriedades.

Fornecedor

Informações do provedor de recursos.

Nome Caminho Tipo Description
ID
id string

A ID do provedor.

Namespace
namespace string

O namespace do provedor.

Estado de registro
registrationState string

O estado de registro do provedor.

Tipo de recurso
resourceTypes array of ProviderResourceType

A coleção de tipos de recursos do provedor.

BasicDependency

Informações de dependência de implantação.

Nome Caminho Tipo Description
id
id string

A ID da dependência.

resourceType
resourceType string

O tipo de recurso de dependência.

resourceName
resourceName string

O nome do recurso de dependência.

Dependência

Informações de dependência de implantação.

Nome Caminho Tipo Description
dependsOn
dependsOn array of BasicDependency

A lista de dependências.

id
id string

A ID da dependência.

resourceType
resourceType string

O tipo de recurso de dependência.

resourceName
resourceName string

O nome do recurso de dependência.

DeploymentPropertiesExtended

Propriedades de implantação com detalhes adicionais.

Nome Caminho Tipo Description
provisioningState
provisioningState string

O estado do provisionamento.

correlationId
correlationId string

A ID de correlação da implantação.

carimbo de data/hora
timestamp date-time

O carimbo de data/hora da implantação do modelo.

saídas
outputs object

Pares chave/valor que representam a taxa de implantação.

providers
providers array of Provider

A lista de provedores de recursos necessários para a implantação.

dependências
dependencies array of Dependency

A lista de dependências de implantação.

modelo
template object

O conteúdo do modelo. Use apenas um modelo ou TemplateLink.

link de modelo
templateLink TemplateLink

Entidade que representa a referência ao modelo.

parameters
parameters object

Parâmetros de implantação. Use apenas um dos Parâmetros ou ParametersLink.

parâmetrosLink
parametersLink ParametersLink

Entidade que representa a referência aos paramatadores de implantação.

Modo de Implantação
mode string

O modo de implantação.

configuração de depuração
debugSetting DebugSetting

DeploymentValidateResult

Informações da resposta de implantação de modelo de validação.

Nome Caminho Tipo Description
erro
error ResourceManagementErrorWithDetails
propriedades
properties DeploymentPropertiesExtended

Propriedades de implantação com detalhes adicionais.

DeploymentExtended

Informações de implantação.

Nome Caminho Tipo Description
ID
id string

A ID da implantação.

Nome
name string

O nome da implantação.

propriedades
properties DeploymentPropertiesExtended

Propriedades de implantação com detalhes adicionais.

DeploymentListResult

Lista de implantações.

Nome Caminho Tipo Description
value
value array of DeploymentExtended

A lista de implantações.

Próximo Link
nextLink string

A URL para obter o próximo conjunto de resultados.

ProviderListResult

Lista de provedores de recursos.

Nome Caminho Tipo Description
value
value array of Provider

A lista de provedores de recursos.

nextLink
nextLink string

A URL para obter o próximo conjunto de resultados.

GenericResource

Informações sobre o recurso.

Nome Caminho Tipo Description
ID
id string

ID do recurso

Nome
name string

Nome do recurso

Tipo
type string

Tipo de recurso

Localização
location string

Local do recurso

Etiquetas
tags object

Etiquetas de recursos

plano
plan Plan

Planeje o recurso.

Variante
kind string

O tipo do recurso.

Gerenciado Por
managedBy string

ID do recurso que gerencia esse recurso.

SKU
sku Sku

Sku para o recurso.

Identidade
identity Identity

Identidade do recurso.

Propriedades
properties object

As propriedades do recurso.

Plano

Planeje o recurso.

Nome Caminho Tipo Description
ID
name string

A ID do plano.

Publicador
publisher string

A ID do editor.

Product
product string

A ID da oferta.

Código de promoção
promotionCode string

O código de promoção.

Sku

Sku para o recurso.

Nome Caminho Tipo Description
Nome
name string

O nome do sku.

Camada
tier string

A camada de sku.

Tamanho
size string

O tamanho da sku.

Família
family string

A família SKU.

Modelo
model string

O modelo de sku.

Capacity
capacity integer

A capacidade de sku.

Identidade

Identidade do recurso.

Nome Caminho Tipo Description
ID da entidade de segurança
principalId string

A ID principal da identidade do recurso.

ID do Inquilino
tenantId string

A ID do locatário do recurso.

Tipo
type string

O tipo de identidade.

ResourceListResult

Lista de recursos.

Nome Caminho Tipo Description
value
value array of GenericResource

A lista de recursos.

Próximo Link
nextLink string

A URL para obter o próximo conjunto de resultados.

Grupo de recursos

Informações do grupo de recursos.

Nome Caminho Tipo Description
ID
id string

A ID do grupo de recursos (por exemplo, /subscriptions/XXX/resourceGroups/YYY).

Nome
name string

O nome do grupo de recursos.

Localização
location string

O local do grupo de recursos. Ele não pode ser alterado após a criação do grupo de recursos. Tem que ser um dos locais do Azure com suporte, como Oeste dos EUA, Leste dos EUA, Europa Ocidental, Leste da Ásia, etc.

Gerenciado Por
managedBy string

ID do recurso que gerencia esse grupo de recursos.

Etiquetas
tags object

As marcas anexadas ao grupo de recursos.

propriedades
properties ResourceGroupProperties

As propriedades do grupo de recursos.

Propriedades do Grupo de Recursos

As propriedades do grupo de recursos.

Nome Caminho Tipo Description
Estado de provisionamento
provisioningState string

O estado de provisionamento.

ResourceGroupListResult

Lista de grupos de recursos.

Nome Caminho Tipo Description
value
value array of ResourceGroup

A lista de grupos de recursos.

Próximo Link
nextLink string

A URL para obter o próximo conjunto de resultados.

TagCount

Contagem de marcas.

Nome Caminho Tipo Description
Tipo
type string

Tipo de contagem.

Value
value integer

Valor da contagem.

TagValue

Informações de marcação.

Nome Caminho Tipo Description
ID da marca
id string

A ID da marca.

Valor da marca
tagValue string

O valor da marca.

Contagem de marcas
count TagCount

Contagem de marcas.

TagDetails

Detalhes da marca.

Nome Caminho Tipo Description
ID
id string

A ID da marca.

Nome
tagName string

O nome da etiqueta.

Contagem de marcas
count TagCount

Contagem de marcas.

values
values array of TagValue

A lista de valores de marca.

TagsListResult

Lista de marcas de assinatura.

Nome Caminho Tipo Description
value
value array of TagDetails

A lista de marcas.

nextLink
nextLink string

A URL para obter o próximo conjunto de resultados.

TargetResource

Recurso de destino.

Nome Caminho Tipo Description
ID
id string

A ID do recurso.

Nome
resourceName string

O nome do recurso.

Tipo
resourceType string

O tipo do recurso.

HttpMessage

Nome Caminho Tipo Description
conteúdo
content object

Conteúdo da mensagem HTTP.

DeploymentOperationProperties

Propriedades da operação de implantação.

Nome Caminho Tipo Description
provisioningState
provisioningState string

O estado do provisionamento.

carimbo de data/hora
timestamp date-time

A data e a hora da operação.

serviceRequestId
serviceRequestId string

ID da solicitação do serviço de operação de implantação.

código de status
statusCode string

Código de status da operação.

statusMessage
statusMessage object

Mensagem de status da operação.

Recurso de destino
targetResource TargetResource

Recurso de destino.

solicitação
request HttpMessage
response
response HttpMessage

DeploymentOperation

Informações da operação de implantação.

Nome Caminho Tipo Description
ID
id string

ID da operação de implantação completa.

ID da operação
operationId string

ID da operação de implantação.

propriedades
properties DeploymentOperationProperties

Propriedades da operação de implantação.

DeploymentOperationsListResult

Lista de operações de implantação.

Nome Caminho Tipo Description
value
value array of DeploymentOperation

A lista de implantações.

Próximo Link
nextLink string

A URL para obter o próximo conjunto de resultados.

ResourceGroupExportResult

Nome Caminho Tipo Description
Template
template object

O conteúdo do modelo.

erro
error ResourceManagementErrorWithDetails

ObjectWithoutType

objeto

Esse é o tipo 'object'.