Partilhar via

Gerenciar recursos do Azure usando a API REST

  • Artigo

Saiba como usar a API REST para o Azure Resource Manager para gerenciar seus recursos do Azure. Para obter uma referência abrangente de como estruturar chamadas REST do Azure, consulte Introdução ao REST. Veja a referência da API REST de Gerenciamento de Recursos para obter mais detalhes sobre as operações disponíveis.

Obter um token de acesso

Para fazer uma chamada de API REST para o Azure, primeiro você precisa obter um token de acesso. Inclua esse token de acesso nos cabeçalhos de suas chamadas de API REST do Azure usando o cabeçalho "Authorization" e definindo o valor como "Bearer {access-token}".

Se você precisar recuperar novos tokens programaticamente como parte do seu aplicativo, você pode obter um token de acesso registrando seu aplicativo cliente com o Microsoft Entra ID.

Se você estiver começando e quiser testar as APIs REST do Azure usando seu token individual, poderá recuperar seu token de acesso atual rapidamente com o Azure PowerShell ou a CLI do Azure.

token=$(az account get-access-token --query accessToken --output tsv)

Âmbito da operação

Você pode chamar muitas operações do Azure Resource Manager em escopos diferentes:

Type Âmbito
Grupo de Gestão providers/Microsoft.Management/managementGroups/{managementGroupId}
Subscrição subscriptions/{subscriptionId}
Grupo de recursos subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}
Recurso subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderName}/{resourceType}/{resourceName}

Listar recursos

A operação REST a seguir retorna os recursos dentro de um grupo de recursos fornecido.

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/resources?api-version=2021-04-01 HTTP/1.1
Authorization: Bearer <bearer-token>
Host: management.azure.com

Aqui está um exemplo de comando cURL que você pode usar para listar todos os recursos em um grupo de recursos usando a API do Azure Resource Manager:

curl  -H "Authorization: Bearer $token" -H 'Content-Type: application/json' -X GET 'https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/resources?api-version=2021-04-01'

Com a etapa de autenticação, este exemplo se parece com:

token=$(az account get-access-token --query accessToken --output tsv)
curl  -H "Authorization: Bearer $token" -H 'Content-Type: application/json' -X GET 'https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/resources?api-version=2021-04-01'

Implantar recursos em um grupo de recursos existente

Você pode implantar recursos do Azure diretamente usando a API REST ou implantar um modelo do Gerenciador de Recursos para criar recursos do Azure.

Implantar um recurso

A operação REST a seguir cria uma conta de armazenamento. Para ver este exemplo com mais detalhes, consulte Criar uma conta de Armazenamento do Azure com a API REST. A documentação de referência completa e os exemplos para o Storage Resource Provider estão disponíveis na Referência da API REST do Storage Resource Provider.

PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}?api-version=2018-02-01 HTTP/1.1
Authorization: Bearer <bearer-token>
Content-Type: application/json
Host: management.azure.com

{
  "sku": {
    "name": "Standard_GRS"
  },
  "kind": "StorageV2",
  "location": "eastus2",
}

Implantar um modelo

As operações a seguir implantam um modelo de início rápido para criar uma conta de armazenamento. Para obter mais informações, consulte Guia de início rápido: criar modelos do Azure Resource Manager usando o Visual Studio Code. Para obter a referência de API desta chamada, consulte Implantações - Criar ou atualizar.

PUT /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/my-deployment?api-version=2021-04-01 HTTP/1.1
Authorization: Bearer <bearer-token>
Content-Type: application/json
Host: management.azure.com

{
  "properties": {
    "templateLink": {
      "uri": "https://example.com/azuretemplates/azuredeploy.json"
    },
    "parametersLink": {
        "uri": "https://example.com/azuretemplates/azuredeploy.parameters.json"
    },
    "mode": "Incremental"
  }
}

Para as APIs REST, o valor de uri não pode ser um arquivo local ou um arquivo que só está disponível em sua rede local. O Azure Resource Manager deve ser capaz de acessar o modelo. Forneça um valor de URI que possa ser baixado como HTTP ou HTTPS. Para obter mais informações, consulte Implantar recursos com modelos do Resource Manager e Azure PowerShell.

Implantar um grupo de recursos e recursos

Você pode criar um grupo de recursos e implantar recursos no grupo usando um modelo. Para obter mais informações, consulte Criar grupo de recursos e implantar recursos.

Implantar recursos em várias assinaturas ou grupos de recursos

Normalmente, você implanta todos os recursos em seu modelo em um único grupo de recursos. No entanto, há cenários em que você deseja implantar um conjunto de recursos juntos, mas colocá-los em diferentes grupos de recursos ou assinaturas. Para obter mais informações, consulte Implantar recursos do Azure em várias assinaturas ou grupos de recursos.

Eliminar recursos

A operação a seguir mostra como excluir uma conta de armazenamento.

DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}?api-version=2022-09-01 HTTP/1.1
Authorization: Bearer <bearer-token>
Host: management.azure.com

Para obter mais informações sobre como o Azure Resource Manager ordena a exclusão de recursos, consulte Exclusão do grupo de recursos do Azure Resource Manager.

Gerir o acesso aos recursos

O controle de acesso baseado em função do Azure (Azure RBAC) é a maneira de gerenciar o acesso a recursos no Azure. Para obter mais informações, consulte Adicionar ou remover atribuições de função do Azure usando REST.

Próximos passos

  • Para saber mais sobre o Azure Resource Manager, consulte Visão geral do Azure Resource Manager.
  • Para saber mais sobre as operações REST suportadas do Azure Resource Manager, consulte Referência REST do Azure Resource Manager.
  • Para aprender a sintaxe do modelo do Resource Manager, consulte Compreender a estrutura e a sintaxe dos modelos do Azure Resource Manager.
  • Para saber como desenvolver modelos, consulte os tutoriais passo a passo.
  • Para exibir os esquemas de modelo do Azure Resource Manager, consulte Referência de modelo.