{ "swagger": "2.0", "info": { "title": "AuthorizationClient", "version": "2015-01-01" }, "host": "management.azure.com", "schemes": [ "https" ], "consumes": [ "application/json", "text/json" ], "produces": [ "application/json", "text/json" ], "paths": { "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Authorization/locks/{lockName}": { "put": { "tags": [ "ManagementLocks" ], "operationId": "ManagementLocks_CreateOrUpdateAtResourceGroupLevel", "description": "Create or update a management lock at the resource group level.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The resource group name." }, { "name": "lockName", "in": "path", "required": true, "type": "string", "description": "The lock name." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ManagementLockProperties" }, "description": "The management lock parameters." }, { "in": "query", "$ref": "#/parameters/ApiVersionParameter" }, { "in": "query", "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "201": { "description": "", "schema": { "$ref": "#/definitions/ManagementLockObject" } }, "200": { "description": "", "schema": { "$ref": "#/definitions/ManagementLockObject" } } } } }, "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}/providers/Microsoft.Authorization/locks/{lockName}": { "put": { "tags": [ "ManagementLocks" ], "operationId": "ManagementLocks_CreateOrUpdateAtResourceLevel", "description": "Create or update a management lock at the resource level or any level below resource.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group. " }, { "name": "resourceProviderNamespace", "in": "path", "required": true, "type": "string", "description": "Resource identity." }, { "name": "parentResourcePath", "in": "path", "required": true, "type": "string", "description": "Resource identity.", "x-ms-skip-url-encoding": true }, { "name": "resourceType", "in": "path", "required": true, "type": "string", "description": "Resource identity.", "x-ms-skip-url-encoding": true }, { "name": "resourceName", "in": "path", "required": true, "type": "string", "description": "Resource identity." }, { "name": "lockName", "in": "path", "required": true, "type": "string", "description": "The name of lock." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ManagementLockProperties" }, "description": "Create or update management lock parameters." }, { "in": "query", "$ref": "#/parameters/ApiVersionParameter" }, { "in": "query", "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ManagementLockObject" } }, "201": { "description": "", "schema": { "$ref": "#/definitions/ManagementLockObject" } } } }, "delete": { "tags": [ "ManagementLocks" ], "operationId": "ManagementLocks_DeleteAtResourceLevel", "description": "Deletes the management lock of a resource or any level below resource.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group. " }, { "name": "resourceProviderNamespace", "in": "path", "required": true, "type": "string", "description": "Resource identity." }, { "name": "parentResourcePath", "in": "path", "required": true, "type": "string", "description": "Resource identity.", "x-ms-skip-url-encoding": true }, { "name": "resourceType", "in": "path", "required": true, "type": "string", "description": "Resource identity.", "x-ms-skip-url-encoding": true }, { "name": "resourceName", "in": "path", "required": true, "type": "string", "description": "Resource identity." }, { "name": "lockName", "in": "path", "required": true, "type": "string", "description": "The name of lock." }, { "in": "query", "$ref": "#/parameters/ApiVersionParameter" }, { "in": "query", "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "202": { "description": "" }, "200": { "description": "" }, "204": { "description": "" } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/locks/{lockName}": { "put": { "tags": [ "ManagementLocks" ], "operationId": "ManagementLocks_CreateOrUpdateAtSubscriptionLevel", "description": "Create or update a management lock at the subscription level.", "parameters": [ { "name": "lockName", "in": "path", "required": true, "type": "string", "description": "The name of lock." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ManagementLockProperties" }, "description": "The management lock parameters." }, { "in": "query", "$ref": "#/parameters/ApiVersionParameter" }, { "in": "query", "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ManagementLockObject" } }, "201": { "description": "", "schema": { "$ref": "#/definitions/ManagementLockObject" } } } }, "delete": { "tags": [ "ManagementLocks" ], "operationId": "ManagementLocks_DeleteAtSubscriptionLevel", "description": "Deletes the management lock of a subscription.", "parameters": [ { "name": "lockName", "in": "path", "required": true, "type": "string", "description": "The name of lock." }, { "in": "query", "$ref": "#/parameters/ApiVersionParameter" }, { "in": "query", "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "204": { "description": "" }, "202": { "description": "" }, "200": { "description": "" } } }, "get": { "tags": [ "ManagementLocks" ], "operationId": "ManagementLocks_Get", "description": "Gets the management lock of a scope.", "parameters": [ { "name": "lockName", "in": "path", "required": true, "type": "string", "description": "Name of the management lock." }, { "in": "query", "$ref": "#/parameters/ApiVersionParameter" }, { "in": "query", "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "204": { "description": "", "schema": { "$ref": "#/definitions/ManagementLockObject" } }, "200": { "description": "", "schema": { "$ref": "#/definitions/ManagementLockObject" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Authorization/locks/{lockName}": { "delete": { "tags": [ "ManagementLocks" ], "operationId": "ManagementLocks_DeleteAtResourceGroupLevel", "description": "Deletes the management lock of a resource group.", "parameters": [ { "name": "resourceGroup", "in": "path", "required": true, "type": "string", "description": "The resource group names." }, { "name": "lockName", "in": "path", "required": true, "type": "string", "description": "The name of lock." }, { "in": "query", "$ref": "#/parameters/ApiVersionParameter" }, { "in": "query", "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "" }, "202": { "description": "" }, "204": { "description": "" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Authorization/locks": { "get": { "tags": [ "ManagementLocks" ], "operationId": "ManagementLocks_ListAtResourceGroupLevel", "description": "Gets all the management locks of a resource group.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "Resource group name." }, { "name": "$filter", "in": "query", "required": false, "type": "string", "description": "The filter to apply on the operation." }, { "in": "query", "$ref": "#/parameters/ApiVersionParameter" }, { "in": "query", "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ManagementLockListResult" } } }, "x-ms-pageable": true, "x-ms-odata": "#/definitions/ManagementLockObject" } }, "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}/providers/Microsoft.Authorization/locks": { "get": { "tags": [ "ManagementLocks" ], "operationId": "ManagementLocks_ListAtResourceLevel", "description": "Gets all the management locks of a resource or any level below resource.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group. The name is case insensitive." }, { "name": "resourceProviderNamespace", "in": "path", "required": true, "type": "string", "description": "Resource identity." }, { "name": "parentResourcePath", "in": "path", "required": true, "type": "string", "description": "Resource identity.", "x-ms-skip-url-encoding": true }, { "name": "resourceType", "in": "path", "required": true, "type": "string", "description": "Resource identity.", "x-ms-skip-url-encoding": true }, { "name": "resourceName", "in": "path", "required": true, "type": "string", "description": "Resource identity." }, { "name": "$filter", "in": "query", "required": false, "type": "string", "description": "The filter to apply on the operation." }, { "in": "query", "$ref": "#/parameters/ApiVersionParameter" }, { "in": "query", "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ManagementLockListResult" } } }, "x-ms-pageable": true, "x-ms-odata": "#/definitions/ManagementLockObject" } }, "/{nextLink}": { "get": { "tags": [ "ManagementLocks" ], "operationId": "ManagementLocks_ListNext", "description": "Get a list of management locks at resource level or below.", "parameters": [ { "name": "nextLink", "in": "path", "required": true, "type": "string", "description": "NextLink from the previous successful call to List operation.", "x-ms-skip-url-encoding": true }, { "in": "query", "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ManagementLockListResult" } } }, "x-ms-pageable": true } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/locks": { "get": { "tags": [ "ManagementLocks" ], "operationId": "ManagementLocks_ListAtSubscriptionLevel", "description": "Gets all the management locks of a subscription.", "parameters": [ { "name": "$filter", "in": "query", "required": false, "type": "string", "description": "The filter to apply on the operation." }, { "in": "query", "$ref": "#/parameters/ApiVersionParameter" }, { "in": "query", "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ManagementLockListResult" } } }, "x-ms-pageable": true, "x-ms-odata": "#/definitions/ManagementLockObject" } } }, "definitions": { "DeploymentExtendedFilter": { "properties": { "provisioningState": { "type": "string", "description": "Gets or sets the provisioning state." } }, "description": "Deployment filter." }, "GenericResourceFilter": { "properties": { "resourceType": { "type": "string", "description": "Gets or sets the resource type." }, "tagname": { "type": "string", "description": "Gets or sets the tag name." }, "tagvalue": { "type": "string", "description": "Gets or sets the tag value." } }, "description": "Resource filter." }, "ResourceGroupExtendedFilter": { "properties": { "tagName": { "type": "string", "description": "Gets or sets the tag name." }, "tagValue": { "type": "string", "description": "Gets or sets the tag value." } }, "description": "Resource group filter." }, "ManagementLockProperties": { "properties": { "level": { "type": "string", "description": "Gets or sets the lock level of the management lock.", "enum": [ "NotSpecified", "CanNotDelete", "ReadOnly" ], "x-ms-enum": "LockLevel" }, "notes": { "type": "string", "description": "Gets or sets the notes of the management lock." } }, "description": "The management lock properties." }, "ManagementLockObject": { "properties": { "properties": { "$ref": "#/definitions/ManagementLockProperties", "description": "Gets or sets the properties of the lock." }, "id": { "type": "string", "description": "Gets or sets the Id of the lock." }, "type": { "type": "string", "description": "Gets or sets the type of the lock." }, "name": { "type": "string", "description": "Gets or sets the name of the lock." } }, "description": "Management lock information." }, "ManagementLockListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/ManagementLockObject" }, "description": "Gets or sets the list of locks." }, "nextLink": { "type": "string", "description": "Gets or sets the URL to get the next set of results." } }, "description": "List of management locks." }, "Resource": { "properties": { "id": { "readOnly": true, "type": "string", "description": "Resource Id" }, "name": { "readOnly": true, "type": "string", "description": "Resource name" }, "type": { "readOnly": true, "type": "string", "description": "Resource type" }, "location": { "type": "string", "description": "Resource location" }, "tags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Resource tags" } }, "required": [ "location" ], "x-ms-external": true }, "SubResource": { "properties": { "id": { "type": "string", "description": "Resource Id" } }, "x-ms-external": true } }, "parameters": { "SubscriptionIdParameter": { "name": "subscriptionId", "in": "path", "required": true, "type": "string", "description": "Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." }, "ApiVersionParameter": { "name": "api-version", "in": "query", "required": true, "type": "string", "description": "Client Api Version." } } }