Microsoft Azure

ResourceManagementClient

Provides operations for working with resources and resource groups.

Developer tools#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Provides operations for working with resources and resource groups.

Endpoints 86

Providers

  • GETProviders_ListAtTenantScope/providers?$top=0&$expand=string&api-version=stringGets all resource providers for the tenant.
  • GETProviders_GetAtTenantScope/providers/:resourceProviderNamespace?$expand=string&api-version=stringGets the specified resource provider at the tenant level.
  • GETProviders_List/subscriptions/:subscriptionId/providers?$top=0&$expand=string&api-version=stringGets all resource providers for a subscription.
  • GETProviders_Get/subscriptions/:subscriptionId/providers/:resourceProviderNamespace?$expand=string&api-version=stringGets the specified resource provider.
  • POSTProviders_Register/subscriptions/:subscriptionId/providers/:resourceProviderNamespace/register?api-version=stringRegisters a subscription with a resource provider.
  • POSTProviders_Unregister/subscriptions/:subscriptionId/providers/:resourceProviderNamespace/unregister?api-version=stringUnregisters a subscription from a resource provider.

Deployments

  • GETDeployments_ListAtManagementGroupScope/providers/Microsoft.Management/managementGroups/:groupId/providers/Microsoft.Resources/deployments/?$filter=string&$top=0&api-version=stringGet all the deployments for a management group.
  • GETDeployments_GetAtManagementGroupScope/providers/Microsoft.Management/managementGroups/:groupId/providers/Microsoft.Resources/deployments/:deploymentName?api-version=stringGets a deployment.
  • PUTDeploys resources at management group scope./providers/Microsoft.Management/managementGroups/:groupId/providers/Microsoft.Resources/deployments/:deploymentName?api-version=stringYou can provide the template and parameters directly in the request or link to JSON files.
  • DELETEDeletes a deployment from the deployment history./providers/Microsoft.Management/managementGroups/:groupId/providers/Microsoft.Resources/deployments/:deploymentName?api-version=stringA template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. This is an…
  • HEADDeployments_CheckExistenceAtManagementGroupScope/providers/Microsoft.Management/managementGroups/:groupId/providers/Microsoft.Resources/deployments/:deploymentName?api-version=stringChecks whether the deployment exists.
  • POSTCancels a currently running template deployment./providers/Microsoft.Management/managementGroups/:groupId/providers/Microsoft.Resources/deployments/:deploymentName/cancel?api-version=stringYou can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled.…
  • POSTDeployments_ExportTemplateAtManagementGroupScope/providers/Microsoft.Management/managementGroups/:groupId/providers/Microsoft.Resources/deployments/:deploymentName/exportTemplate?api-version=stringExports the template used for specified deployment.
  • POSTDeployments_ValidateAtManagementGroupScope/providers/Microsoft.Management/managementGroups/:groupId/providers/Microsoft.Resources/deployments/:deploymentName/validate?api-version=stringValidates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..
  • POSTDeployments_CalculateTemplateHash/providers/Microsoft.Resources/calculateTemplateHash?api-version=stringCalculate the hash of the given template.
  • GETDeployments_ListAtTenantScope/providers/Microsoft.Resources/deployments/?$filter=string&$top=0&api-version=stringGet all the deployments at the tenant scope.
  • GETDeployments_GetAtTenantScope/providers/Microsoft.Resources/deployments/:deploymentName?api-version=stringGets a deployment.
  • PUTDeploys resources at tenant scope./providers/Microsoft.Resources/deployments/:deploymentName?api-version=stringYou can provide the template and parameters directly in the request or link to JSON files.
  • DELETEDeletes a deployment from the deployment history./providers/Microsoft.Resources/deployments/:deploymentName?api-version=stringA template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. This is an…
  • HEADDeployments_CheckExistenceAtTenantScope/providers/Microsoft.Resources/deployments/:deploymentName?api-version=stringChecks whether the deployment exists.
  • POSTCancels a currently running template deployment./providers/Microsoft.Resources/deployments/:deploymentName/cancel?api-version=stringYou can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled.…
  • POSTDeployments_ExportTemplateAtTenantScope/providers/Microsoft.Resources/deployments/:deploymentName/exportTemplate?api-version=stringExports the template used for specified deployment.
  • POSTDeployments_ValidateAtTenantScope/providers/Microsoft.Resources/deployments/:deploymentName/validate?api-version=stringValidates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..
  • GETDeployments_ListAtSubscriptionScope/subscriptions/:subscriptionId/providers/Microsoft.Resources/deployments/?$filter=string&$top=0&api-version=stringGet all the deployments for a subscription.
  • GETDeployments_GetAtSubscriptionScope/subscriptions/:subscriptionId/providers/Microsoft.Resources/deployments/:deploymentName?api-version=stringGets a deployment.
  • PUTDeploys resources at subscription scope./subscriptions/:subscriptionId/providers/Microsoft.Resources/deployments/:deploymentName?api-version=stringYou can provide the template and parameters directly in the request or link to JSON files.
  • DELETEDeletes a deployment from the deployment history./subscriptions/:subscriptionId/providers/Microsoft.Resources/deployments/:deploymentName?api-version=stringA template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. This is an…
  • HEADDeployments_CheckExistenceAtSubscriptionScope/subscriptions/:subscriptionId/providers/Microsoft.Resources/deployments/:deploymentName?api-version=stringChecks whether the deployment exists.
  • POSTCancels a currently running template deployment./subscriptions/:subscriptionId/providers/Microsoft.Resources/deployments/:deploymentName/cancel?api-version=stringYou can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled.…
  • POSTDeployments_ExportTemplateAtSubscriptionScope/subscriptions/:subscriptionId/providers/Microsoft.Resources/deployments/:deploymentName/exportTemplate?api-version=stringExports the template used for specified deployment.
  • POSTDeployments_ValidateAtSubscriptionScope/subscriptions/:subscriptionId/providers/Microsoft.Resources/deployments/:deploymentName/validate?api-version=stringValidates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..
  • POSTDeployments_WhatIfAtSubscriptionScope/subscriptions/:subscriptionId/providers/Microsoft.Resources/deployments/:deploymentName/whatIf?api-version=stringReturns changes that will be made by the deployment if executed at the scope of the subscription.
  • GETDeployments_ListByResourceGroup/subscriptions/:subscriptionId/resourcegroups/:resourceGroupName/providers/Microsoft.Resources/deployments/?$filter=string&$top=0&api-version=stringGet all the deployments for a resource group.
  • GETDeployments_Get/subscriptions/:subscriptionId/resourcegroups/:resourceGroupName/providers/Microsoft.Resources/deployments/:deploymentName?api-version=stringGets a deployment.
  • PUTDeploys resources to a resource group./subscriptions/:subscriptionId/resourcegroups/:resourceGroupName/providers/Microsoft.Resources/deployments/:deploymentName?api-version=stringYou can provide the template and parameters directly in the request or link to JSON files.
  • DELETEDeletes a deployment from the deployment history./subscriptions/:subscriptionId/resourcegroups/:resourceGroupName/providers/Microsoft.Resources/deployments/:deploymentName?api-version=stringA template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. Deleting a…
  • HEADDeployments_CheckExistence/subscriptions/:subscriptionId/resourcegroups/:resourceGroupName/providers/Microsoft.Resources/deployments/:deploymentName?api-version=stringChecks whether the deployment exists.
  • POSTCancels a currently running template deployment./subscriptions/:subscriptionId/resourcegroups/:resourceGroupName/providers/Microsoft.Resources/deployments/:deploymentName/cancel?api-version=stringYou can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled.…
  • POSTDeployments_ExportTemplate/subscriptions/:subscriptionId/resourcegroups/:resourceGroupName/providers/Microsoft.Resources/deployments/:deploymentName/exportTemplate?api-version=stringExports the template used for specified deployment.
  • POSTDeployments_Validate/subscriptions/:subscriptionId/resourcegroups/:resourceGroupName/providers/Microsoft.Resources/deployments/:deploymentName/validate?api-version=stringValidates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..
  • POSTDeployments_WhatIf/subscriptions/:subscriptionId/resourcegroups/:resourceGroupName/providers/Microsoft.Resources/deployments/:deploymentName/whatIf?api-version=stringReturns changes that will be made by the deployment if executed at the scope of the resource group.
  • GETDeployments_ListAtScope/:scope/providers/Microsoft.Resources/deployments/?$filter=string&$top=0&api-version=stringGet all the deployments at the given scope.
  • GETDeployments_GetAtScope/:scope/providers/Microsoft.Resources/deployments/:deploymentName?api-version=stringGets a deployment.
  • PUTDeploys resources at a given scope./:scope/providers/Microsoft.Resources/deployments/:deploymentName?api-version=stringYou can provide the template and parameters directly in the request or link to JSON files.
  • DELETEDeletes a deployment from the deployment history./:scope/providers/Microsoft.Resources/deployments/:deploymentName?api-version=stringA template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. This is an…
  • HEADDeployments_CheckExistenceAtScope/:scope/providers/Microsoft.Resources/deployments/:deploymentName?api-version=stringChecks whether the deployment exists.
  • POSTCancels a currently running template deployment./:scope/providers/Microsoft.Resources/deployments/:deploymentName/cancel?api-version=stringYou can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled.…
  • POSTDeployments_ExportTemplateAtScope/:scope/providers/Microsoft.Resources/deployments/:deploymentName/exportTemplate?api-version=stringExports the template used for specified deployment.
  • POSTDeployments_ValidateAtScope/:scope/providers/Microsoft.Resources/deployments/:deploymentName/validate?api-version=stringValidates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..

DeploymentOperations

  • GETDeploymentOperations_ListAtManagementGroupScope/providers/Microsoft.Management/managementGroups/:groupId/providers/Microsoft.Resources/deployments/:deploymentName/operations?$top=0&api-version=stringGets all deployments operations for a deployment.
  • GETDeploymentOperations_GetAtManagementGroupScope/providers/Microsoft.Management/managementGroups/:groupId/providers/Microsoft.Resources/deployments/:deploymentName/operations/:operationId?api-version=stringGets a deployments operation.
  • GETDeploymentOperations_ListAtTenantScope/providers/Microsoft.Resources/deployments/:deploymentName/operations?$top=0&api-version=stringGets all deployments operations for a deployment.
  • GETDeploymentOperations_GetAtTenantScope/providers/Microsoft.Resources/deployments/:deploymentName/operations/:operationId?api-version=stringGets a deployments operation.
  • GETDeploymentOperations_ListAtSubscriptionScope/subscriptions/:subscriptionId/providers/Microsoft.Resources/deployments/:deploymentName/operations?$top=0&api-version=stringGets all deployments operations for a deployment.
  • GETDeploymentOperations_GetAtSubscriptionScope/subscriptions/:subscriptionId/providers/Microsoft.Resources/deployments/:deploymentName/operations/:operationId?api-version=stringGets a deployments operation.
  • GETDeploymentOperations_List/subscriptions/:subscriptionId/resourcegroups/:resourceGroupName/deployments/:deploymentName/operations?$top=0&api-version=stringGets all deployments operations for a deployment.
  • GETDeploymentOperations_Get/subscriptions/:subscriptionId/resourcegroups/:resourceGroupName/deployments/:deploymentName/operations/:operationId?api-version=stringGets a deployments operation.
  • GETDeploymentOperations_ListAtScope/:scope/providers/Microsoft.Resources/deployments/:deploymentName/operations?$top=0&api-version=stringGets all deployments operations for a deployment.
  • GETDeploymentOperations_GetAtScope/:scope/providers/Microsoft.Resources/deployments/:deploymentName/operations/:operationId?api-version=stringGets a deployments operation.

Operations

  • GETOperations_List/providers/Microsoft.Resources/operations?api-version=stringLists all of the available Microsoft.Resources REST API operations.

ResourceGroups

  • GETResources_ListByResourceGroup/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/resources?$filter=string&$expand=string&$top=0&api-version=stringGet all the resources for a resource group.
  • GETResourceGroups_List/subscriptions/:subscriptionId/resourcegroups?$filter=string&$top=0&api-version=stringGets all the resource groups for a subscription.
  • GETResourceGroups_Get/subscriptions/:subscriptionId/resourcegroups/:resourceGroupName?api-version=stringGets a resource group.
  • PUTResourceGroups_CreateOrUpdate/subscriptions/:subscriptionId/resourcegroups/:resourceGroupName?api-version=stringCreates or updates a resource group.
  • DELETEDeletes a resource group./subscriptions/:subscriptionId/resourcegroups/:resourceGroupName?api-version=stringWhen you delete a resource group, all of its resources are also deleted. Deleting a resource group deletes all of its template deployments and currently…
  • HEADResourceGroups_CheckExistence/subscriptions/:subscriptionId/resourcegroups/:resourceGroupName?api-version=stringChecks whether a resource group exists.
  • PATCHUpdates a resource group./subscriptions/:subscriptionId/resourcegroups/:resourceGroupName?api-version=stringResource groups can be updated through a simple PATCH operation to a group address. The format of the request is the same as that for creating a resource…
  • POSTResourceGroups_ExportTemplate/subscriptions/:subscriptionId/resourcegroups/:resourceGroupName/exportTemplate?api-version=stringCaptures the specified resource group as a template.

Resources

  • POSTMoves resources from one resource group to another resource group./subscriptions/:subscriptionId/resourceGroups/:sourceResourceGroupName/moveResources?api-version=stringThe resources to move must be in the same source resource group. The target resource group may be in a different subscription. When moving resources, both the…
  • POSTValidates whether resources can be moved from one resource group to another resource group./subscriptions/:subscriptionId/resourceGroups/:sourceResourceGroupName/validateMoveResources?api-version=stringThis operation checks whether the specified resources can be moved to the target. The resources to move must be in the same source resource group. The target…
  • GETResources_Get/subscriptions/:subscriptionId/resourcegroups/:resourceGroupName/providers/:resourceProviderNamespace/:parentResourcePath/:resourceType/:resourceName?api-version=stringGets a resource.
  • PUTResources_CreateOrUpdate/subscriptions/:subscriptionId/resourcegroups/:resourceGroupName/providers/:resourceProviderNamespace/:parentResourcePath/:resourceType/:resourceName?api-version=stringCreates a resource.
  • DELETEResources_Delete/subscriptions/:subscriptionId/resourcegroups/:resourceGroupName/providers/:resourceProviderNamespace/:parentResourcePath/:resourceType/:resourceName?api-version=stringDeletes a resource.
  • HEADResources_CheckExistence/subscriptions/:subscriptionId/resourcegroups/:resourceGroupName/providers/:resourceProviderNamespace/:parentResourcePath/:resourceType/:resourceName?api-version=stringChecks whether a resource exists.
  • PATCHResources_Update/subscriptions/:subscriptionId/resourcegroups/:resourceGroupName/providers/:resourceProviderNamespace/:parentResourcePath/:resourceType/:resourceName?api-version=stringUpdates a resource.
  • GETResources_List/subscriptions/:subscriptionId/resources?$filter=string&$expand=string&$top=0&api-version=stringGet all the resources in a subscription.
  • GETResources_GetById/:resourceId?api-version=stringGets a resource by ID.
  • PUTResources_CreateOrUpdateById/:resourceId?api-version=stringCreate a resource by ID.
  • DELETEResources_DeleteById/:resourceId?api-version=stringDeletes a resource by ID.
  • HEADResources_CheckExistenceById/:resourceId?api-version=stringChecks by ID whether a resource exists.
  • PATCHResources_UpdateById/:resourceId?api-version=stringUpdates a resource by ID.

Tags

  • GETTags_List/subscriptions/:subscriptionId/tagNames?api-version=stringGets the names and values of all resource tags that are defined in a subscription.
  • PUTCreates a tag in the subscription./subscriptions/:subscriptionId/tagNames/:tagName?api-version=stringThe tag name can have a maximum of 512 characters and is case insensitive. Tag names created by Azure have prefixes of microsoft, azure, or windows. You…
  • DELETEDeletes a tag from the subscription./subscriptions/:subscriptionId/tagNames/:tagName?api-version=stringYou must remove all values from a resource tag before you can delete it.
  • PUTTags_CreateOrUpdateValue/subscriptions/:subscriptionId/tagNames/:tagName/tagValues/:tagValue?api-version=stringCreates a tag value. The name of the tag must already exist.
  • DELETETags_DeleteValue/subscriptions/:subscriptionId/tagNames/:tagName/tagValues/:tagValue?api-version=stringDeletes a tag value.

API details

Base URL
https://management.azure.com
Authentication
OAuth 2.0 (implicit flow) with 1 scope
Operations
86 operations on 57 pathsGET 32POST 23PUT 10DELETE 10HEAD 8PATCH 3
Main resources
Deployments 43Resources 13DeploymentOperations 10ResourceGroups 8Providers 6Tags 5Operations 1
Response formats
application/json
Description format
Swagger 2.0, API version 2019-08-01
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the ResourceManagementClient in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the ResourceManagementClient collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (implicit flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Providers_ListAtTenantScope” (GET /providers?$top=0&$expand=string&api-version=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the ResourceManagementClient?

Provides operations for working with resources and resource groups. It is listed under Developer tools and has 86 endpoints.

Who publishes the ResourceManagementClient?

It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.

What is the base URL of the ResourceManagementClient?

Requests go to https://management.azure.com. Endpoint paths are added to this base URL.

How do I authenticate with the ResourceManagementClient?

With OAuth 2.0 (implicit flow) with 1 scope.

How many endpoints does the ResourceManagementClient have?

86 operations on 57 paths (32 GET, 23 POST, 10 PUT, 10 DELETE, 8 HEAD, 3 PATCH). The largest groups are Deployments, Resources, DeploymentOperations, ResourceGroups.

Is forking the ResourceManagementClient free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.