openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

github.com/httptoolkit/openapi-directory-js

1 lines • 77.6 kB

JSON

{"openapi":"3.0.0","info":{"description":"Provides operations for working with resources and resource groups.","title":"ResourceManagementClient","version":"2018-05-01","x-apisguru-categories":["cloud"],"x-logo":{"url":"https://assets.onestore.ms/cdnfiles/onestorerolling-1606-01000/shell/v3/images/logo/microsoft.png"},"x-origin":[{"format":"swagger","url":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json","version":"2.0"}],"x-preferred":true,"x-providerName":"azure.com","x-serviceName":"resources","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/providers/Microsoft.Resources/operations":{"get":{"description":"Lists all of the available Microsoft.Resources REST API operations.","operationId":"Operations_List","parameters":[{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"OK. The request has succeeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationListResult"}}}}},"tags":["Operations"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/providers":{"get":{"description":"Gets all resource providers for a subscription.","operationId":"Providers_List","parameters":[{"description":"The number of results to return. If null is passed returns all deployments.","in":"query","name":"$top","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"The properties to include in the results. For example, use &$expand=metadata in the query string to retrieve resource provider metadata. To include property aliases in response, use $expand=resourceTypes/aliases.","in":"query","name":"$expand","required":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"200":{"description":"OK - Returns an array of resource providers.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProviderListResult"}}}}},"tags":["Providers"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/":{"get":{"description":"Get all the deployments for a subscription.","operationId":"Deployments_ListAtSubscriptionScope","parameters":[{"description":"The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'.","in":"query","name":"$filter","required":false,"schema":{"type":"string"}},{"description":"The number of results to get. If null is passed, returns all deployments.","in":"query","name":"$top","required":false,"schema":{"type":"integer","format":"int32"}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"200":{"description":"OK - Returns an array of deployments.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentListResult"}}}}},"tags":["Deployments"],"x-ms-odata":"#/components/schemas/DeploymentExtendedFilter","x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}":{"delete":{"description":"A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.","operationId":"Deployments_DeleteAtSubscriptionScope","parameters":[{"description":"The name of the deployment to delete.","in":"path","name":"deploymentName","required":true,"schema":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[-\\w\\._\$\$]+$"}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"202":{"description":"Accepted - Returns this status until the asynchronous operation has completed."},"204":{"description":"No Content"}},"summary":"Deletes a deployment from the deployment history.","tags":["Deployments"],"x-ms-long-running-operation":true},"get":{"description":"Gets a deployment.","operationId":"Deployments_GetAtSubscriptionScope","parameters":[{"description":"The name of the deployment to get.","in":"path","name":"deploymentName","required":true,"schema":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[-\\w\\._\$\$]+$"}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"200":{"description":"OK - Returns information about the deployment, including provisioning status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentExtended"}}}}},"tags":["Deployments"]},"head":{"description":"Checks whether the deployment exists.","operationId":"Deployments_CheckExistenceAtSubscriptionScope","parameters":[{"description":"The name of the deployment to check.","in":"path","name":"deploymentName","required":true,"schema":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[-\\w\\._\$\$]+$"}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"204":{"description":"No Content"},"404":{"description":"Not Found"}},"tags":["Deployments"]},"put":{"description":"You can provide the template and parameters directly in the request or link to JSON files.","operationId":"Deployments_CreateOrUpdateAtSubscriptionScope","parameters":[{"description":"The name of the deployment.","in":"path","name":"deploymentName","required":true,"schema":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[-\\w\\._\$\$]+$"}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"requestBody":{"$ref":"#/components/requestBodies/Deployment2"},"responses":{"200":{"description":"OK - Returns information about the deployment, including provisioning status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentExtended"}}}},"201":{"description":"Created - Returns information about the deployment, including provisioning status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentExtended"}}}}},"summary":"Deploys resources at subscription scope.","tags":["Deployments"],"x-ms-long-running-operation":true}},"/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/cancel":{"post":{"description":"You can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled. Canceling a template deployment stops the currently running template deployment and leaves the resources partially deployed.","operationId":"Deployments_CancelAtSubscriptionScope","parameters":[{"description":"The name of the deployment to cancel.","in":"path","name":"deploymentName","required":true,"schema":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[-\\w\\._\$\$]+$"}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"204":{"description":"No Content"}},"summary":"Cancels a currently running template deployment.","tags":["Deployments"]}},"/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate":{"post":{"description":"Exports the template used for specified deployment.","operationId":"Deployments_ExportTemplateAtSubscriptionScope","parameters":[{"description":"The name of the deployment from which to get the template.","in":"path","name":"deploymentName","required":true,"schema":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[-\\w\\._\$\$]+$"}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"200":{"description":"OK - Returns the template.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentExportResult"}}}}},"tags":["Deployments"]}},"/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/operations":{"get":{"description":"Gets all deployments operations for a deployment.","operationId":"DeploymentOperations_ListAtSubscriptionScope","parameters":[{"description":"The name of the deployment with the operation to get.","in":"path","name":"deploymentName","required":true,"schema":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[-\\w\\._\$\$]+$"}},{"description":"The number of results to return.","in":"query","name":"$top","required":false,"schema":{"type":"integer","format":"int32"}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"200":{"description":"OK - Return an array of deployment operations.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentOperationsListResult"}}}}},"tags":["DeploymentOperations"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/operations/{operationId}":{"get":{"description":"Gets a deployments operation.","operationId":"DeploymentOperations_GetAtSubscriptionScope","parameters":[{"description":"The name of the deployment.","in":"path","name":"deploymentName","required":true,"schema":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[-\\w\\._\$\$]+$"}},{"description":"The ID of the operation to get.","in":"path","name":"operationId","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"200":{"description":"OK - Returns information about the deployment operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentOperation"}}}}},"tags":["DeploymentOperations"]}},"/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/validate":{"post":{"description":"Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..","operationId":"Deployments_ValidateAtSubscriptionScope","parameters":[{"description":"The name of the deployment.","in":"path","name":"deploymentName","required":true,"schema":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[-\\w\\._\$\$]+$"}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"requestBody":{"$ref":"#/components/requestBodies/Deployment"},"responses":{"200":{"description":"OK - Returns the validation result.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentValidateResult"}}}},"400":{"description":"Returns the validation result.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentValidateResult"}}}}},"tags":["Deployments"]}},"/subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}":{"get":{"description":"Gets the specified resource provider.","operationId":"Providers_Get","parameters":[{"description":"The $expand query parameter. For example, to include property aliases in response, use $expand=resourceTypes/aliases.","in":"query","name":"$expand","required":false,"schema":{"type":"string"}},{"description":"The namespace of the resource provider.","in":"path","name":"resourceProviderNamespace","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"200":{"description":"OK - Returns information about the resource provider.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Provider"}}}}},"tags":["Providers"]}},"/subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}/register":{"post":{"description":"Registers a subscription with a resource provider.","operationId":"Providers_Register","parameters":[{"description":"The namespace of the resource provider to register.","in":"path","name":"resourceProviderNamespace","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"200":{"description":"OK - Returns information about the resource provider.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Provider"}}}}},"tags":["Providers"]}},"/subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}/unregister":{"post":{"description":"Unregisters a subscription from a resource provider.","operationId":"Providers_Unregister","parameters":[{"description":"The namespace of the resource provider to unregister.","in":"path","name":"resourceProviderNamespace","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"200":{"description":"OK - Returns information about the resource provider.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Provider"}}}}},"tags":["Providers"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/resources":{"get":{"description":"Get all the resources for a resource group.","operationId":"Resources_ListByResourceGroup","parameters":[{"description":"The resource group with the resources to get.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._\$\$]+$"}},{"description":"The filter to apply on the operation. The properties you can use for eq (equals) or ne (not equals) are: location, resourceType, name, resourceGroup, identity, identity/principalId, plan, plan/publisher, plan/product, plan/name, plan/version, and plan/promotionCode. For example, to filter by a resource type, use: $filter=resourceType eq 'Microsoft.Network/virtualNetworks' You can use substringof(value, property) in the filter. The properties you can use for substring are: name and resourceGroup. For example, to get all resources with 'demo' anywhere in the name, use: $filter=substringof('demo', name) You can link more than one substringof together by adding and/or operators. You can filter by tag names and values. For example, to filter for a tag name and value, use $filter=tagName eq 'tag1' and tagValue eq 'Value1' You can use some properties together when filtering. The combinations you can use are: substringof and/or resourceType, plan and plan/publisher and plan/name, identity and identity/principalId.","in":"query","name":"$filter","required":false,"schema":{"type":"string"}},{"description":"The $expand query parameter. You can expand createdTime and changedTime. For example, to expand both properties, use $expand=changedTime,createdTime","in":"query","name":"$expand","required":false,"schema":{"type":"string"}},{"description":"The number of results to return. If null is passed, returns all resources.","in":"query","name":"$top","required":false,"schema":{"type":"integer","format":"int32"}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"200":{"description":"OK - Returns an array of resources","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceListResult"}}}}},"tags":["ResourceGroups"],"x-ms-odata":"#/components/schemas/GenericResourceFilter","x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{sourceResourceGroupName}/moveResources":{"post":{"description":"The 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 source group and the target group are locked for the duration of the operation. Write and delete operations are blocked on the groups until the move completes. ","operationId":"Resources_MoveResources","parameters":[{"description":"The name of the resource group containing the resources to move.","in":"path","name":"sourceResourceGroupName","required":true,"schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._\$\$]+$"}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"requestBody":{"$ref":"#/components/requestBodies/ResourcesMoveInfo"},"responses":{"202":{"description":"Accepted"},"204":{"description":"No Content"}},"summary":"Moves resources from one resource group to another resource group.","tags":["Resources"],"x-ms-long-running-operation":true}},"/subscriptions/{subscriptionId}/resourceGroups/{sourceResourceGroupName}/validateMoveResources":{"post":{"description":"This 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 resource group may be in a different subscription. If validation succeeds, it returns HTTP response code 204 (no content). If validation fails, it returns HTTP response code 409 (Conflict) with an error message. Retrieve the URL in the Location header value to check the result of the long-running operation.","operationId":"Resources_ValidateMoveResources","parameters":[{"description":"The name of the resource group containing the resources to validate for move.","in":"path","name":"sourceResourceGroupName","required":true,"schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._\$\$]+$"}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"requestBody":{"$ref":"#/components/requestBodies/ResourcesMoveInfo"},"responses":{"202":{"description":"Accepted"},"204":{"description":"No Content"},"409":{"description":"Conflict"}},"summary":"Validates whether resources can be moved from one resource group to another resource group.","tags":["Resources"],"x-ms-long-running-operation":true}},"/subscriptions/{subscriptionId}/resourcegroups":{"get":{"description":"Gets all the resource groups for a subscription.","operationId":"ResourceGroups_List","parameters":[{"description":"The filter to apply on the operation. You can filter by tag names and values. For example, to filter for a tag name and value, use $filter=tagName eq 'tag1' and tagValue eq 'Value1'","in":"query","name":"$filter","required":false,"schema":{"type":"string"}},{"description":"The number of results to return. If null is passed, returns all resource groups.","in":"query","name":"$top","required":false,"schema":{"type":"integer","format":"int32"}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"200":{"description":"OK - Returns an array of resource groups.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceGroupListResult"}}}}},"tags":["ResourceGroups"],"x-ms-odata":"#/components/schemas/ResourceGroupFilter","x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}":{"delete":{"description":"When you delete a resource group, all of its resources are also deleted. Deleting a resource group deletes all of its template deployments and currently stored operations.","operationId":"ResourceGroups_Delete","parameters":[{"description":"The name of the resource group to delete. The name is case insensitive.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._\$\$]+$"}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"200":{"description":"OK"},"202":{"description":"Accepted"}},"summary":"Deletes a resource group.","tags":["ResourceGroups"],"x-ms-long-running-operation":true},"get":{"description":"Gets a resource group.","operationId":"ResourceGroups_Get","parameters":[{"description":"The name of the resource group to get. The name is case insensitive.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._\$\$]+$"}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"200":{"description":"OK - Returns information about the resource group.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceGroup"}}}}},"tags":["ResourceGroups"]},"head":{"description":"Checks whether a resource group exists.","operationId":"ResourceGroups_CheckExistence","parameters":[{"description":"The name of the resource group to check. The name is case insensitive.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._\$\$]+$"}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"204":{"description":"No Content"},"404":{"description":"Not Found"}},"tags":["ResourceGroups"]},"patch":{"description":"Resource 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 group. If a field is unspecified, the current value is retained.","operationId":"ResourceGroups_Update","parameters":[{"description":"The name of the resource group to update. The name is case insensitive.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._\$\$]+$"}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceGroupPatchable"}}},"description":"Parameters supplied to update a resource group.","required":true},"responses":{"200":{"description":"OK - Returns information about the resource group.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceGroup"}}}}},"summary":"Updates a resource group.","tags":["ResourceGroups"]},"put":{"description":"Creates or updates a resource group.","operationId":"ResourceGroups_CreateOrUpdate","parameters":[{"description":"The name of the resource group to create or update. Can include alphanumeric, underscore, parentheses, hyphen, period (except at end), and Unicode characters that match the allowed characters.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._\$\$]+$"},"examples":{"Create or update a resource group":{"value":"myResourceGroup"}}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceGroup"}}},"description":"Parameters supplied to the create or update a resource group.","required":true},"responses":{"200":{"description":"OK - Returns information about the new resource group.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceGroup"},"examples":{"Create or update a resource group":{"$ref":"#/components/examples/Create_or_update_a_resource_group"}}}}},"201":{"description":"Created - Returns information about the new resource group.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceGroup"},"examples":{"Create or update a resource group":{"$ref":"#/components/examples/Create_or_update_a_resource_group"}}}}}},"tags":["ResourceGroups"]}},"/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/deployments/{deploymentName}/operations":{"get":{"description":"Gets all deployments operations for a deployment.","operationId":"DeploymentOperations_List","parameters":[{"description":"The name of the resource group. The name is case insensitive.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._\$\$]+$"}},{"description":"The name of the deployment with the operation to get.","in":"path","name":"deploymentName","required":true,"schema":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[-\\w\\._\$\$]+$"}},{"description":"The number of results to return.","in":"query","name":"$top","required":false,"schema":{"type":"integer","format":"int32"}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"200":{"description":"OK - Return an array of deployment operations.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentOperationsListResult"}}}}},"tags":["DeploymentOperations"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/deployments/{deploymentName}/operations/{operationId}":{"get":{"description":"Gets a deployments operation.","operationId":"DeploymentOperations_Get","parameters":[{"description":"The name of the resource group. The name is case insensitive.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._\$\$]+$"}},{"description":"The name of the deployment.","in":"path","name":"deploymentName","required":true,"schema":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[-\\w\\._\$\$]+$"}},{"description":"The ID of the operation to get.","in":"path","name":"operationId","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"200":{"description":"OK - Returns information about the deployment operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentOperation"}}}}},"tags":["DeploymentOperations"]}},"/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/exportTemplate":{"post":{"description":"Captures the specified resource group as a template.","operationId":"ResourceGroups_ExportTemplate","parameters":[{"description":"The name of the resource group to export as a template.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._\$\$]+$"}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportTemplateRequest"}}},"description":"Parameters for exporting the template.","required":true},"responses":{"200":{"description":"OK - Returns the result of the export.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceGroupExportResult"}}}}},"tags":["ResourceGroups"]}},"/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/":{"get":{"description":"Get all the deployments for a resource group.","operationId":"Deployments_ListByResourceGroup","parameters":[{"description":"The name of the resource group with the deployments to get. The name is case insensitive.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._\$\$]+$"}},{"description":"The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'.","in":"query","name":"$filter","required":false,"schema":{"type":"string"}},{"description":"The number of results to get. If null is passed, returns all deployments.","in":"query","name":"$top","required":false,"schema":{"type":"integer","format":"int32"}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"200":{"description":"OK - Returns an array of deployments.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentListResult"}}}}},"tags":["Deployments"],"x-ms-odata":"#/components/schemas/DeploymentExtendedFilter","x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}":{"delete":{"description":"A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. Deleting a template deployment does not affect the state of the resource group. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.","operationId":"Deployments_Delete","parameters":[{"description":"The name of the resource group with the deployment to delete. The name is case insensitive.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._\$\$]+$"}},{"description":"The name of the deployment to delete.","in":"path","name":"deploymentName","required":true,"schema":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[-\\w\\._\$\$]+$"}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"202":{"description":"Accepted - Returns this status until the asynchronous operation has completed."},"204":{"description":"No Content"}},"summary":"Deletes a deployment from the deployment history.","tags":["Deployments"],"x-ms-long-running-operation":true},"get":{"description":"Gets a deployment.","operationId":"Deployments_Get","parameters":[{"description":"The name of the resource group. The name is case insensitive.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._\$\$]+$"}},{"description":"The name of the deployment to get.","in":"path","name":"deploymentName","required":true,"schema":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[-\\w\\._\$\$]+$"}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"200":{"description":"OK - Returns information about the deployment, including provisioning status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentExtended"}}}}},"tags":["Deployments"]},"head":{"description":"Checks whether the deployment exists.","operationId":"Deployments_CheckExistence","parameters":[{"description":"The name of the resource group with the deployment to check. The name is case insensitive.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._\$\$]+$"}},{"description":"The name of the deployment to check.","in":"path","name":"deploymentName","required":true,"schema":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[-\\w\\._\$\$]+$"}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"204":{"description":"No Content"},"404":{"description":"Not Found"}},"tags":["Deployments"]},"put":{"description":"You can provide the template and parameters directly in the request or link to JSON files.","operationId":"Deployments_CreateOrUpdate","parameters":[{"description":"The name of the resource group to deploy the resources to. The name is case insensitive. The resource group must already exist.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._\$\$]+$"}},{"description":"The name of the deployment.","in":"path","name":"deploymentName","required":true,"schema":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[-\\w\\._\$\$]+$"}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"requestBody":{"$ref":"#/components/requestBodies/Deployment2"},"responses":{"200":{"description":"OK - Returns information about the deployment, including provisioning status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentExtended"}}}},"201":{"description":"Created - Returns information about the deployment, including provisioning status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentExtended"}}}}},"summary":"Deploys resources to a resource group.","tags":["Deployments"],"x-ms-long-running-operation":true}},"/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/cancel":{"post":{"description":"You can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled. Canceling a template deployment stops the currently running template deployment and leaves the resource group partially deployed.","operationId":"Deployments_Cancel","parameters":[{"description":"The name of the resource group. The name is case insensitive.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._\$\$]+$"}},{"description":"The name of the deployment to cancel.","in":"path","name":"deploymentName","required":true,"schema":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[-\\w\\._\$\$]+$"}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"204":{"description":"No Content"}},"summary":"Cancels a currently running template deployment.","tags":["Deployments"]}},"/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate":{"post":{"description":"Exports the template used for specified deployment.","operationId":"Deployments_ExportTemplate","parameters":[{"description":"The name of the resource group. The name is case insensitive.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._\$\$]+$"}},{"description":"The name of the deployment from which to get the template.","in":"path","name":"deploymentName","required":true,"schema":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[-\\w\\._\$\$]+$"}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"200":{"description":"OK - Returns the template.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentExportResult"}}}}},"tags":["Deployments"]}},"/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/validate":{"post":{"description":"Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..","operationId":"Deployments_Validate","parameters":[{"description":"The name of the resource group the template will be deployed to. The name is case insensitive.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._\$\$]+$"}},{"description":"The name of the deployment.","in":"path","name":"deploymentName","required":true,"schema":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[-\\w\\._\$\$]+$"}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"requestBody":{"$ref":"#/components/requestBodies/Deployment"},"responses":{"200":{"description":"OK - Returns the validation result.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentValidateResult"}}}},"400":{"description":"Returns the validation result.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentValidateResult"}}}}},"tags":["Deployments"]}},"/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}":{"delete":{"description":"Deletes a resource.","operationId":"Resources_Delete","parameters":[{"description":"The name of the resource group that contains the resource to delete. The name is case insensitive.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._\$\$]+$"}},{"description":"The namespace of the resource provider.","in":"path","name":"resourceProviderNamespace","required":true,"schema":{"type":"string"}},{"description":"The parent resource identity.","in":"path","name":"parentResourcePath","required":true,"x-ms-skip-url-encoding":true,"schema":{"type":"string"}},{"description":"The resource type.","in":"path","name":"resourceType","required":true,"x-ms-skip-url-encoding":true,"schema":{"type":"string"}},{"description":"The name of the resource to delete.","in":"path","name":"resourceName","required":true,"schema":{"type":"string"}},{"description":"The API version to use for the operation.","in":"query","name":"api-version","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"200":{"description":"OK"},"202":{"description":"Accepted"},"204":{"description":"No Content"}},"tags":["Resources"],"x-ms-long-running-operation":true},"get":{"description":"Gets a resource.","operationId":"Resources_Get","parameters":[{"description":"The name of the resource group containing the resource to get. The name is case insensitive.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._\$\$]+$"}},{"description":"The namespace of the resource provider.","in":"path","name":"resourceProviderNamespace","required":true,"schema":{"type":"string"}},{"description":"The parent resource identity.","in":"path","name":"parentResourcePath","required":true,"x-ms-skip-url-encoding":true,"schema":{"type":"string"}},{"description":"The resource type of the resource.","in":"path","name":"resourceType","required":true,"x-ms-skip-url-encoding":true,"schema":{"type":"string"}},{"description":"The name of the resource to get.","in":"path","name":"resourceName","required":true,"schema":{"type":"string"}},{"description":"The API version to use for the operation.","in":"query","name":"api-version","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"200":{"description":"OK - Returns information about the resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericResource"}}}}},"tags":["Resources"]},"head":{"description":"Checks whether a resource exists.","operationId":"Resources_CheckExistence","parameters":[{"description":"The name of the resource group containing the resource to check. The name is case insensitive.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._\$\$]+$"}},{"description":"The resource provider of the resource to check.","in":"path","name":"resourceProviderNamespace","required":true,"schema":{"type":"string"}},{"description":"The parent resource identity.","in":"path","name":"parentResourcePath","required":true,"x-ms-skip-url-encoding":true,"schema":{"type":"string"}},{"description":"The resource type.","in":"path","name":"resourceType","required":true,"x-ms-skip-url-encoding":true,"schema":{"type":"string"}},{"description":"The name of the resource to check whether it exists.","in":"path","name":"resourceName","required":true,"schema":{"type":"string"}},{"description":"The API version to use for the operation.","in":"query","name":"api-version","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"204":{"description":"No Content"},"404":{"description":"Not Found"}},"tags":["Resources"]},"patch":{"description":"Updates a resource.","operationId":"Resources_Update","parameters":[{"description":"The name of the resource group for the resource. The name is case insensitive.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._\$\$]+$"}},{"description":"The namespace of the resource provider.","in":"path","name":"resourceProviderNamespace","required":true,"schema":{"type":"string"}},{"description":"The parent resource identity.","in":"path","name":"parentResourcePath","required":true,"x-ms-skip-url-encoding":true,"schema":{"type":"string"}},{"description":"The resource type of the resource to update.","in":"path","name":"resourceType","required":true,"x-ms-skip-url-encoding":true,"schema":{"type":"string"}},{"description":"The name of the resource to update.","in":"path","name":"resourceName","required":true,"schema":{"type":"string"}},{"description":"The API version to use for the operation.","in":"query","name":"api-version","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericResource"}}},"description":"Parameters for updating the resource.","required":true},"responses":{"200":{"description":"OK - Returns information about the resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericResource"}}}},"202":{"description":"Accepted"}},"tags":["Resources"],"x-ms-long-running-operation":true},"put":{"description":"Creates a resource.","operationId":"Resources_CreateOrUpdate","parameters":[{"description":"The name of the resource group for the resource. The name is case insensitive.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._\$\$]+$"}},{"description":"The namespace of the resource provider.","in":"path","name":"resourceProviderNamespace","required":true,"schema":{"type":"string"}},{"description":"The parent resource identity.","in":"path","name":"parentResourcePath","required":true,"x-ms-skip-url-encoding":true,"schema":{"type":"string"}},{"description":"The resource type of the resource to create.","in":"path","name":"resourceType","required":true,"x-ms-skip-url-encoding":true,"schema":{"type":"string"}},{"description":"The name of the resource to create.","in":"path","name":"resourceName","required":true,"schema":{"type":"string"}},{"description":"The API version to use for the operation.","in":"query","name":"api-version","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericResource"}}},"description":"Parameters for creating or updating the resource.","required":true},"responses":{"200":{"description":"OK - Returns information about the resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericResource"}}}},"201":{"description":"Created - Returns information about the resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericResource"}}}},"202":{"description":"Accepted"}},"tags":["Resources"],"x-ms-long-running-operation":true}},"/subscriptions/{subscriptionId}/resources":{"get":{"description":"Get all the resources in a subscription.","operationId":"Resources_List","parameters":[{"description":"The filter to apply on the operation. The properties you can use for eq (equals) or ne (not equals) are: location, resourceType, name, resourceGroup, identity, identity/principalId, plan, plan/publisher, plan/product, plan/name, plan/version, and plan/promotionCode. For example, to filter by a resource type, use: $filter=resourceType eq 'Microsoft.Network/virtualNetworks' You can use substringof(value, property) in the filter. The properties you can use for substring are: name and resourceGroup. For example, to get all resources with 'demo' anywhere in the name, use: $filter=substringof('demo', name) You can link more than one substringof together by adding and/or operators. You can filter by tag names and values. For example, to filter for a tag name and value, use $filter=tagName eq 'tag1' and tagValue eq 'Value1' You can use some properties together when filtering. The combinations you can use are: substringof and/or resourceType, plan and plan/publisher and plan/name, identity and identity/principalId.","in":"query","name":"$filter","required":false,"schema":{"type":"string"}},{"description":"The $expand query parameter. You can expand createdTime and changedTime. For example, to expand both properties, use $expand=changedTime,createdTime","in":"query","name":"$expand","required":false,"schema":{"type":"string"}},{"description":"The number of results to return. If null is passed, returns all resource groups.","in":"query","name":"$top","required":false,"schema":{"type":"integer","format":"int32"}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"200":{"description":"OK - Returns an array of resources.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceListResult"}}}}},"tags":["Resources"],"x-ms-odata":"#/components/schemas/GenericResourceFilter","x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/tagNames":{"get":{"description":"Gets the names and values of all resource tags that are defined in a subscription.","operationId":"Tags_List","parameters":[{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"200":{"description":"OK - Returns an array of tag names and values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagsListResult"}}}}},"tags":["Tags"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/tagNames/{tagName}":{"delete":{"description":"You must remove all values from a resource tag before you can delete it.","operationId":"Tags_Delete","parameters":[{"description":"The name of the tag.","in":"path","name":"tagName","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"200":{"description":"OK"},"204":{"description":"No Content"}},"summary":"Deletes a tag from the subscription.","tags":["Tags"]},"put":{"description":"The 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 cannot create tags with one of these prefixes.","operationId":"Tags_CreateOrUpdate","parameters":[{"description":"The name of the tag to create.","in":"path","name":"tagName","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"200":{"description":"OK - Returns information about the tag.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagDetails"}}}},"201":{"description":"Created - Returns information about the tag.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagDetails"}}}}},"summary":"Creates a tag in the subscription.","tags":["Tags"]}},"/subscriptions/{subscriptionId}/tagNames/{tagName}/tagValues/{tagValue}":{"delete":{"description":"Deletes a tag value.","operationId":"Tags_DeleteValue","parameters":[{"description":"The name of the tag.","in":"path","name":"tagName","required":true,"schema":{"type":"string"}},{"description":"The value of the tag to delete.","in":"path","name":"tagValue","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"200":{"description":"OK"},"204":{"description":"No Content"}},"tags":["Tags"]},"put":{"description":"Creates a tag value. The name of the tag must already exist.","operationId":"Tags_CreateOrUpdateValue","parameters":[{"description":"The name of the tag.","in":"path","name":"tagName","required":true,"schema":{"type":"string"}},{"description":"The value of the tag to create.","in":"path","name":"tagValue","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"200":{"description":"OK - Returns information about the tag value.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagValue"}}}},"201":{"description":"Created - Returns information about the tag value.","content":{"application/json":{"schema