diff --git a/arm-machinelearning/2016-05-01-preview/swagger/webservices.json b/arm-machinelearning/2016-05-01-preview/swagger/webservices.json new file mode 100644 index 000000000000..f749439e44b0 --- /dev/null +++ b/arm-machinelearning/2016-05-01-preview/swagger/webservices.json @@ -0,0 +1,915 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure ML Web Services Management Client", + "description": "These APIs allow end users to operate on Azure Machine Learning Web Services resources. They support the following operations:", + "version": "2016-05-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json", + "text/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/webServices/{webServiceName}": { + "put": { + "tags": [ + "WebServices" + ], + "operationId": "WebServices_CreateOrUpdateWebService", + "description": "Create a new Azure ML web service or update an existing one.", + "parameters": [ + { + "in": "body", + "name": "createOrUpdatePayload", + "description": "The payload to create or update the Azure ML web service.", + "required": true, + "schema": { + "$ref": "#/definitions/WebService" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WebService" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/WebService" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "WebServices" + ], + "operationId": "WebServices_GetWebService", + "description": "Retrieve an Azure ML web service definition by its subscription, resource group and name.", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WebService" + } + } + } + }, + "patch": { + "tags": [ + "WebServices" + ], + "operationId": "WebServices_PatchWebService", + "description": "Patch an existing Azure ML web service resource.", + "parameters": [ + { + "in": "body", + "name": "patchPayload", + "description": "The payload to patch the Azure ML web service with.", + "required": true, + "schema": { + "$ref": "#/definitions/WebService" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WebService" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "WebServices" + ], + "operationId": "WebServices_RemoveWebService", + "description": "Remove an existing Azure ML web service.", + "responses": { + "202": { + "description": "Async delete operation was accepted." + }, + "204": { + "description": "No Content" + } + }, + "x-ms-long-running-operation": true + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "description": "Name of the resource group.", + "in": "path", + "type": "string", + "required": true + }, + { + "name": "webServiceName", + "description": "The Azure ML web service name which you want to reach.", + "in": "path", + "type": "string", + "required": true + }, + { + "$ref": "#/parameters/APIVersionParameter" + } + ] + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/webServices/{webServiceName}/listKeys": { + "get": { + "tags": [ + "WebServices" + ], + "operationId": "WebServices_GetWebServiceKeys", + "description": "Get the access keys of a particular Azure ML web service", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "description": "Name of the resource group.", + "in": "path", + "type": "string", + "required": true + }, + { + "name": "webServiceName", + "description": "The Azure ML web service name which you want to reach.", + "in": "path", + "type": "string", + "required": true + }, + { + "$ref": "#/parameters/APIVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WebServiceKeys" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/webServices": { + "get": { + "tags": [ + "WebServices" + ], + "operationId": "WebServices_GetWebServicesInResourceGroup", + "description": "Retrieve all Azure ML web services in a given resource group.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "description": "Name of the resource group.", + "in": "path", + "type": "string", + "required": true + }, + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "in": "query", + "name": "$skiptoken", + "type": "string", + "description": "Continuation token for pagination.", + "required": false + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedWebServicesList" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearning/webServices": { + "get": { + "tags": [ + "WebServices" + ], + "operationId": "WebServices_GetWebServicesInSubscription", + "description": "Retrieve all Azure ML web services in the current Azure subscription.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "in": "query", + "name": "$skiptoken", + "type": "string", + "description": "Continuation token for pagination.", + "required": false + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedWebServicesList" + } + } + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "description": "Azure subscription id.", + "in": "path", + "type": "string", + "required": true + }, + "APIVersionParameter": { + "in": "query", + "name": "api-version", + "type": "string", + "description": "The versiong of the Microsoft.MachineLearning resource provider API to be used.", + "required": true + } + }, + "definitions": { + "Resource": { + "required": [ + "location" + ], + "properties": { + "id": { + "description": "Resource Id", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Resource Name", + "type": "string" + }, + "location": { + "description": "Resource Location", + "type": "string" + }, + "type": { + "description": "Resource type", + "type": "string", + "readOnly": true + }, + "tags": { + "description": "Resource tags", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "WebService": { + "type": "object", + "description": "Instance of an Azure ML web service resource.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/WebServiceProperties", + "description": "Web service resource properties." + } + } + }, + "WebServiceProperties": { + "type": "object", + "description": "The set of properties specific to the Azure ML web service resource.", + "required": [ + "packageType" + ], + "discriminator": "packageType", + "properties": { + "title": { + "type": "string", + "description": "The title of the Azure ML web service." + }, + "description": { + "type": "string", + "description": "The description of the Azure ML web service." + }, + "createdOn": { + "type": "string", + "description": "The moment of time the Azure ML web service was created.", + "format": "date-time", + "readOnly": true + }, + "modifiedOn": { + "type": "string", + "description": "The moment of time the web service was last modified.", + "format": "date-time", + "readOnly": true + }, + "provisioningState": { + "type": "string", + "description": "The web service resource's provisioning state.", + "enum": [ + "Unknown", + "Provisioning", + "Succeeded", + "Failed", + "Canceled" + ], + "readOnly": true + }, + "keys": { + "$ref": "#/definitions/WebServiceKeys", + "description": "The set of access keys for the web service. If not specified at creation time (PUT), they will be generated automatically by the resource provider." + }, + "readOnly": { + "type": "boolean", + "description": "If true, the web service can no longer be updated / patched, only removed. Otherwise, the service resource supports changes." + }, + "swaggerLocation": { + "type": "string", + "description": "The uri for the swagger spec associated with this web service.", + "readOnly": true + }, + "realtimeConfiguration": { + "$ref": "#/definitions/RealtimeConfiguration", + "description": "Configuration for the service's realtime endpoint." + }, + "diagnostics": { + "$ref": "#/definitions/DiagnosticsConfiguration", + "description": "Settings controlling the diagnostics traces collection for the web service." + }, + "storageAccount": { + "$ref": "#/definitions/StorageAccount", + "description": "The storage account associated with the service. This is used to store both datasets and diagnostic traces. This information is required at creation time (PUT) and only the key is updateable after that. The account credentials are hidden on a GET web service call." + }, + "machineLearningWorkspace": { + "$ref": "#/definitions/MachineLearningWorkspace", + "description": "This is only populated at creation time (PUT) for web services originating from an AzureML Studio experiment." + }, + "commitmentPlan": { + "$ref": "#/definitions/CommitmentPlan", + "description": "The commitment plan associated with this web service. This is required to be specified at creation time (PUT) and is not updateable afterwards." + }, + "input": { + "$ref": "#/definitions/ServiceInputOutputSpecification", + "description": "Swagger schema for the service's input(s), as applicable." + }, + "output": { + "$ref": "#/definitions/ServiceInputOutputSpecification", + "description": "Swagger schema for the service's output(s), as applicable." + }, + "assets": { + "type": "object", + "description": "Set of assets associated with the web service.", + "additionalProperties": { + "$ref": "#/definitions/AssetItem" + } + }, + "parameters": { + "type": "object", + "description": "The set of global parameters values defined for the web service, given as a global parameter name -> default value collection. If no default value is specified, the parameter is considered to be required.", + "additionalProperties": { + "type": "string" + } + }, + "packageType": { + "type": "string", + "description": "The type of package deployed with this web service. Only Graph based services are supported at this time.", + "enum": [ + "Graph" + ], + "readOnly": true + } + } + }, + "WebServicePropertiesForGraph": { + "description": "Properties specific to a Graph based web service.", + "x-ms-discriminator-value": "Graph", + "allOf": [ + { + "$ref": "#/definitions/WebServiceProperties" + } + ], + "properties": { + "package": { + "type": "object", + "description": "The definition of the graph package making up this web service.", + "properties": { + "nodes": { + "type": "object", + "description": "The set of nodes making up the graph, provided as a nodeId -> GraphNode map", + "additionalProperties": { + "$ref": "#/definitions/GraphNode" + } + }, + "edges": { + "type": "array", + "description": "The list of edges making up the graph.", + "items": { + "$ref": "#/definitions/GraphEdge" + } + }, + "graphParameters": { + "type": "object", + "description": "The collection of global parameters for the graph, given as a global parameter name -> GraphParameter map. Each parameter here has a 1:1 match with the global parameters values map declared at the WebServiceProperties level.", + "additionalProperties": { + "$ref": "#/definitions/GraphParameter" + } + } + } + } + } + }, + "WebServiceKeys": { + "type": "object", + "description": "Access keys for the web service calls.", + "properties": { + "primary": { + "type": "string", + "description": "The primary access key." + }, + "secondary": { + "type": "string", + "description": "The secondary access key." + } + } + }, + "PaginatedWebServicesList": { + "type": "object", + "description": "Paginated list of web services.", + "properties": { + "value": { + "type": "array", + "description": "List of web services objects.", + "items": { + "$ref": "#/definitions/WebService" + } + }, + "nextLink": { + "type": "string", + "description": "Continuation link to be used to potentially retrieve the next page of results in the list." + } + } + }, + "RealtimeConfiguration": { + "type": "object", + "description": "Holds the available configuration options for an Azure ML web service endpoint.", + "properties": { + "maxConcurrentCalls": { + "type": "integer", + "minimum": 4, + "maximum": 200, + "description": "Maximum number of concurrent calls allowed on the realtime endpoint." + } + } + }, + "DiagnosticsConfiguration": { + "type": "object", + "description": "Diagnostics settings for an Azure ML web service.", + "properties": { + "level": { + "type": "string", + "description": "Level of tracing to be used: None - disables tracing; Error - collects only error (stderr) traces; All - collects all traces (stdout and stderr).", + "enum": [ + "None", + "Error", + "All" + ] + }, + "expiry": { + "type": "string", + "description": "Moment of time after which diagnostics are no longer collected. If null, diagnostic collection is not time limited.", + "format": "date-time" + } + } + }, + "StorageAccount": { + "type": "object", + "description": "Access information for a storage account.", + "properties": { + "name": { + "type": "string", + "description": "The storage account's name." + }, + "key": { + "type": "string", + "description": "The storage account's active key." + } + } + }, + "MachineLearningWorkspace": { + "type": "object", + "description": "Information about the machine learning workspace containing the experiment that is source for the web service.", + "properties": { + "id": { + "type": "string", + "description": "The workspace ARM resource id." + } + }, + "required": [ + "id" + ] + }, + "CommitmentPlan": { + "type": "object", + "description": "Information about the machine learning commitment plan associated with the web service.", + "properties": { + "id": { + "type": "string", + "description": "The commitment plan ARM resource id." + } + }, + "required": [ + "id" + ] + }, + "ServiceInputOutputSpecification": { + "type": "object", + "description": "The swagger 2.0 schema describing the service's inputs or outputs. See Swagger specification: http://swagger.io/specification/", + "properties": { + "title": { + "type": "string", + "description": "Swagger schema title." + }, + "description": { + "type": "string", + "description": "Swagger schema description." + }, + "type": { + "type": "string", + "description": "The type of the entity described in swagger. Always 'object'.", + "default": "object" + }, + "properties": { + "type": "object", + "description": "Collection of (name -> swagger schema) for each input or output of the web service.", + "additionalProperties": { + "$ref": "#/definitions/TableSpecification" + } + } + }, + "required": [ + "type", + "properties" + ] + }, + "TableSpecification": { + "type": "object", + "description": "The swagger 2.0 schema describing a single service input or output. See Swagger specification: http://swagger.io/specification/", + "properties": { + "title": { + "type": "string", + "description": "Swagger schema title." + }, + "description": { + "type": "string", + "description": "Swagger schema description." + }, + "type": { + "type": "string", + "description": "The type of the entity described in swagger. Always 'object'.", + "default": "object" + }, + "properties": { + "type": "object", + "description": "The set of columns within the data table.", + "additionalProperties": { + "$ref": "#/definitions/ColumnSpecification" + } + } + }, + "required": [ + "type", + "properties" + ] + }, + "ColumnSpecification": { + "type": "object", + "description": "Swagger 2.0 schema for a column within the data table representing a web service input or output. See Swagger specification: http://swagger.io/specification/", + "properties": { + "type": { + "type": "string", + "description": "Data type of the column.", + "enum": [ + "Boolean", + "Integer", + "Number", + "String" + ] + }, + "format": { + "type": "string", + "description": "Additional format information for the data type.", + "enum": [ + "Byte", + "Char", + "Datetime", + "Double", + "Duration", + "Float", + "Int8", + "Int16", + "Int32", + "Int64", + "Uint8", + "Uint16", + "Uint32", + "Uint64" + ] + }, + "enum": { + "type": "array", + "description": "If the data type is categorical, this provides the list of accepted categories.", + "items": { + "type": "object" + } + }, + "x-ms-isnullable": { + "type": "boolean", + "description": "Flag indicating if the type supports null values or not." + }, + "x-ms-isordered": { + "type": "boolean", + "description": "Flag indicating whether the categories are treated as an ordered set or not, if this is a categorical column." + } + }, + "required": [ + "type" + ] + }, + "AssetItem": { + "type": "object", + "description": "Information about an asset associated with the web service.", + "properties": { + "name": { + "type": "string", + "description": "Asset's friendly name." + }, + "type": { + "type": "string", + "description": "Asset's type.", + "enum": [ + "Module", + "Resource" + ] + }, + "locationInfo": { + "description": "Access information for the asset.", + "$ref": "#/definitions/AssetLocation" + }, + "inputPorts": { + "type": "object", + "description": "Information about the asset's input ports.", + "additionalProperties": { + "$ref": "#/definitions/InputPort" + } + }, + "outputPorts": { + "type": "object", + "description": "Information about the asset's output ports.", + "additionalProperties": { + "$ref": "#/definitions/OutputPort" + } + }, + "metadata": { + "type": "object", + "description": "If the asset is a custom module, this holds the module's metadata.", + "additionalProperties": { + "type": "string" + } + }, + "parameters": { + "type": "array", + "description": "If the asset is a custom module, this holds the module's parameters.", + "items": { + "$ref": "#/definitions/ModuleAssetParameter" + } + } + }, + "required": [ + "name", + "type", + "locationInfo" + ] + }, + "AssetLocation": { + "type": "object", + "description": "Describes the access location for a web service asset.", + "properties": { + "uri": { + "type": "string", + "description": "The URI where the asset is accessible from, (e.g. aml://abc for system assets or https://xyz for user asets", + "format": "url" + }, + "credentials": { + "type": "string", + "description": "Access credentials for the asset, if applicable (e.g. asset specified by storage account connection string + blob URI)" + } + }, + "required": [ + "uri" + ] + }, + "ModuleAssetParameter": { + "type": "object", + "description": "Parameter definition for a module asset.", + "properties": { + "name": { + "type": "string", + "description": "Parameter name." + }, + "parameterType": { + "type": "string", + "description": "Parameter type." + }, + "modeValuesInfo": { + "type": "object", + "description": "Definitions for nested interface parameters if this is a complex module parameter.", + "additionalProperties": { + "$ref": "#/definitions/ModeValueInfo" + } + } + } + }, + "ModeValueInfo": { + "type": "object", + "description": "Nested parameter definition.", + "properties": { + "interfaceString": { + "type": "string", + "description": "The interface string name for the nested parameter." + }, + "parameters": { + "type": "array", + "description": "The definition of the parameter.", + "items": { + "$ref": "#/definitions/ModuleAssetParameter" + } + } + } + }, + "InputPort": { + "type": "object", + "description": "Asset input port", + "properties": { + "type": { + "type": "string", + "description": "Port data type.", + "enum": [ + "Dataset" + ], + "default": "Dataset" + } + } + }, + "OutputPort": { + "type": "object", + "description": "Asset output port", + "properties": { + "type": { + "type": "string", + "description": "Port data type.", + "enum": [ + "Dataset" + ], + "default": "Dataset" + } + } + }, + "GraphNode": { + "type": "object", + "description": "Specifies a node in the web service graph. The node can either be an input, output or asset node, so only one of the corresponding id properties is populated at any given time.", + "properties": { + "assetId": { + "type": "string", + "description": "The id of the asset represented by this node." + }, + "inputId": { + "type": "string", + "description": "The id of the input element represented by this node." + }, + "outputId": { + "type": "string", + "description": "The id of the output element represented by this node." + }, + "parameters": { + "type": "object", + "description": "If applicable, parameters of the node. Global graph parameters map into these, with values set at runtime.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "GraphEdge": { + "type": "object", + "description": "Defines an edge within the web service's graph.", + "properties": { + "sourceNodeId": { + "type": "string", + "description": "The source graph node's identifier." + }, + "sourcePortId": { + "type": "string", + "description": "The identifier of the source node's port that the edge connects from." + }, + "targetNodeId": { + "type": "string", + "description": "The destination graph node's identifier." + }, + "targetPortId": { + "type": "string", + "description": "The identifier of the destination node's port that the edge connects into." + } + } + }, + "GraphParameter": { + "type": "object", + "description": "Defines a global parameter in the graph.", + "properties": { + "description": { + "type": "string", + "description": "Description of this graph parameter." + }, + "type": { + "type": "string", + "description": "Graph parameter's type.", + "enum": [ + "String", + "Int", + "Float", + "Enumerated", + "Script", + "Mode", + "Credential", + "Boolean", + "Double", + "ColumnPicker", + "ParameterRange", + "DataGatewayName" + ] + }, + "links": { + "type": "array", + "description": "Association links for this parameter to nodes in the graph.", + "items": { + "$ref": "#/definitions/GraphParameterLink" + } + } + }, + "required": [ + "type", + "links" + ] + }, + "GraphParameterLink": { + "type": "object", + "description": "Association link for a graph global parameter to a node in the graph.", + "properties": { + "nodeId": { + "type": "string", + "description": "The graph node's identifier" + }, + "parameterKey": { + "type": "string", + "description": "The identifier of the node parameter that the global parameter maps to." + } + }, + "required": [ + "nodeId", + "parameterKey" + ] + } + } +} diff --git a/arm-resources/features/2015-12-01/swagger/features.json b/arm-resources/features/2015-12-01/swagger/features.json index b87b387ef2f3..b4640e321ec1 100644 --- a/arm-resources/features/2015-12-01/swagger/features.json +++ b/arm-resources/features/2015-12-01/swagger/features.json @@ -1,326 +1,326 @@ -{ - "swagger": "2.0", - "info": { - "title": "FeatureClient", - "version": "2015-12-01" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json", - "text/json" - ], - "produces": [ - "application/json", - "text/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/providers/Microsoft.Features/features": { - "get": { - "tags": [ - "Features" - ], - "operationId": "Features_ListAll", - "description": "Gets a list of previewed features for all the providers in the current subscription.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/FeatureOperationsListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Features/providers/{resourceProviderNamespace}/features": { - "get": { - "tags": [ - "Features" - ], - "operationId": "Features_List", - "description": "Gets a list of previewed features of a resource provider.", - "parameters": [ - { - "name": "resourceProviderNamespace", - "in": "path", - "required": true, - "type": "string", - "description": "The namespace of the resource provider." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/FeatureOperationsListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Features/providers/{resourceProviderNamespace}/features/{featureName}": { - "get": { - "tags": [ - "Features" - ], - "operationId": "Features_Get", - "description": "Get all features under the subscription.", - "parameters": [ - { - "name": "resourceProviderNamespace", - "in": "path", - "required": true, - "type": "string", - "description": "Namespace of the resource provider." - }, - { - "name": "featureName", - "in": "path", - "required": true, - "type": "string", - "description": "Previewed feature name in the resource provider." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/FeatureResult" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Features/providers/{resourceProviderNamespace}/features/{featureName}/register": { - "post": { - "tags": [ - "Features" - ], - "operationId": "Features_Register", - "description": "Registers for a previewed feature of a resource provider.", - "parameters": [ - { - "name": "resourceProviderNamespace", - "in": "path", - "required": true, - "type": "string", - "description": "Namespace of the resource provider." - }, - { - "name": "featureName", - "in": "path", - "required": true, - "type": "string", - "description": "Previewed feature name in the resource provider." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/FeatureResult" - } - } - } - } - } - }, - "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." - }, - "ResourceGroupFilter": { - "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." - }, - "FeatureProperties": { - "properties": { - "state": { - "type": "string", - "description": "Gets or sets the state of the previewed feature." - } - }, - "description": "Previewed feature information." - }, - "FeatureResult": { - "properties": { - "name": { - "type": "string", - "description": "Gets or sets the name of the feature." - }, - "properties": { - "$ref": "#/definitions/FeatureProperties", - "description": "Gets or sets the properties of the previewed feature." - }, - "id": { - "type": "string", - "description": "Gets or sets the Id of the feature." - }, - "type": { - "type": "string", - "description": "Gets or sets the type of the feature." - } - }, - "description": "Previewed feature information." - }, - "FeatureOperationsListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/FeatureResult" - }, - "description": "Gets or sets the list of Features." - }, - "nextLink": { - "type": "string", - "description": "Gets or sets the URL to get the next set of results." - } - }, - "description": "List of previewed features." - }, - "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-azure-resource": true - }, - "SubResource": { - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - } - }, - "x-ms-azure-resource": 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." - } - } +{ + "swagger": "2.0", + "info": { + "title": "FeatureClient", + "version": "2015-12-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json", + "text/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Features/features": { + "get": { + "tags": [ + "Features" + ], + "operationId": "Features_ListAll", + "description": "Gets a list of previewed features for all the providers in the current subscription.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/FeatureOperationsListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Features/providers/{resourceProviderNamespace}/features": { + "get": { + "tags": [ + "Features" + ], + "operationId": "Features_List", + "description": "Gets a list of previewed features of a resource provider.", + "parameters": [ + { + "name": "resourceProviderNamespace", + "in": "path", + "required": true, + "type": "string", + "description": "The namespace of the resource provider." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/FeatureOperationsListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Features/providers/{resourceProviderNamespace}/features/{featureName}": { + "get": { + "tags": [ + "Features" + ], + "operationId": "Features_Get", + "description": "Get all features under the subscription.", + "parameters": [ + { + "name": "resourceProviderNamespace", + "in": "path", + "required": true, + "type": "string", + "description": "Namespace of the resource provider." + }, + { + "name": "featureName", + "in": "path", + "required": true, + "type": "string", + "description": "Previewed feature name in the resource provider." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/FeatureResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Features/providers/{resourceProviderNamespace}/features/{featureName}/register": { + "post": { + "tags": [ + "Features" + ], + "operationId": "Features_Register", + "description": "Registers for a previewed feature of a resource provider.", + "parameters": [ + { + "name": "resourceProviderNamespace", + "in": "path", + "required": true, + "type": "string", + "description": "Namespace of the resource provider." + }, + { + "name": "featureName", + "in": "path", + "required": true, + "type": "string", + "description": "Previewed feature name in the resource provider." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/FeatureResult" + } + } + } + } + } + }, + "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." + }, + "ResourceGroupFilter": { + "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." + }, + "FeatureProperties": { + "properties": { + "state": { + "type": "string", + "description": "Gets or sets the state of the previewed feature." + } + }, + "description": "Previewed feature information." + }, + "FeatureResult": { + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the name of the feature." + }, + "properties": { + "$ref": "#/definitions/FeatureProperties", + "description": "Gets or sets the properties of the previewed feature." + }, + "id": { + "type": "string", + "description": "Gets or sets the Id of the feature." + }, + "type": { + "type": "string", + "description": "Gets or sets the type of the feature." + } + }, + "description": "Previewed feature information." + }, + "FeatureOperationsListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/FeatureResult" + }, + "description": "Gets or sets the list of Features." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the URL to get the next set of results." + } + }, + "description": "List of previewed features." + }, + "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-azure-resource": true + }, + "SubResource": { + "properties": { + "id": { + "type": "string", + "description": "Resource Id" + } + }, + "x-ms-azure-resource": 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." + } + } } \ No newline at end of file diff --git a/arm-resources/locks/2015-01-01/swagger/locks.json b/arm-resources/locks/2015-01-01/swagger/locks.json index b0da3ecf4ec1..6f510038434b 100644 --- a/arm-resources/locks/2015-01-01/swagger/locks.json +++ b/arm-resources/locks/2015-01-01/swagger/locks.json @@ -1,753 +1,753 @@ -{ - "swagger": "2.0", - "info": { - "title": "ManagementLockClient", - "version": "2015-01-01" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json", - "text/json" - ], - "produces": [ - "application/json", - "text/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "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/ManagementLockObject" - }, - "description": "The management lock parameters." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/ManagementLockObject" - } - }, - "201": { - "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. ", - "pattern": "^[-\\w\\._]+$" - }, - { - "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/ManagementLockObject" - }, - "description": "Create or update management lock parameters." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$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." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "204": { - "description": "" - }, - "200": { - "description": "" - }, - "202": { - "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/ManagementLockObject" - }, - "description": "The management lock parameters." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "", - "schema": { - "$ref": "#/definitions/ManagementLockObject" - } - }, - "200": { - "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." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "204": { - "description": "" - }, - "200": { - "description": "" - }, - "202": { - "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." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/ManagementLockObject" - } - }, - "204": { - "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." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "204": { - "description": "" - }, - "200": { - "description": "" - }, - "202": { - "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." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/ManagementLockListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "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.", - "pattern": "^[-\\w\\._]+$" - }, - { - "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." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/ManagementLockListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "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 - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/ManagementLockListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/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." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/ManagementLockListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "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." - }, - "ResourceGroupFilter": { - "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": { - "name": "LockLevel", - "modelAsString": true - } - }, - "notes": { - "type": "string", - "description": "Gets or sets the notes of the management lock." - } - }, - "description": "The management lock properties." - }, - "ManagementLockObject": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$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.", - "x-ms-azure-resource": true - }, - "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-azure-resource": true - }, - "SubResource": { - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - } - }, - "x-ms-azure-resource": 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." - } - } -} +{ + "swagger": "2.0", + "info": { + "title": "ManagementLockClient", + "version": "2015-01-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json", + "text/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "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/ManagementLockObject" + }, + "description": "The management lock parameters." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ManagementLockObject" + } + }, + "201": { + "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. ", + "pattern": "^[-\\w\\._]+$" + }, + { + "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/ManagementLockObject" + }, + "description": "Create or update management lock parameters." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$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." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "" + }, + "200": { + "description": "" + }, + "202": { + "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/ManagementLockObject" + }, + "description": "The management lock parameters." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/ManagementLockObject" + } + }, + "200": { + "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." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "" + }, + "200": { + "description": "" + }, + "202": { + "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." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ManagementLockObject" + } + }, + "204": { + "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." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "" + }, + "200": { + "description": "" + }, + "202": { + "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." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ManagementLockListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "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.", + "pattern": "^[-\\w\\._]+$" + }, + { + "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." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ManagementLockListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "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 + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ManagementLockListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/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." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ManagementLockListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "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." + }, + "ResourceGroupFilter": { + "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": { + "name": "LockLevel", + "modelAsString": true + } + }, + "notes": { + "type": "string", + "description": "Gets or sets the notes of the management lock." + } + }, + "description": "The management lock properties." + }, + "ManagementLockObject": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$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.", + "x-ms-azure-resource": true + }, + "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-azure-resource": true + }, + "SubResource": { + "properties": { + "id": { + "type": "string", + "description": "Resource Id" + } + }, + "x-ms-azure-resource": 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." + } + } +} diff --git a/arm-resources/resources/2015-11-01/swagger/resources.json b/arm-resources/resources/2015-11-01/swagger/resources.json index fa9f522fe896..1a7726a36a34 100644 --- a/arm-resources/resources/2015-11-01/swagger/resources.json +++ b/arm-resources/resources/2015-11-01/swagger/resources.json @@ -1,2818 +1,2818 @@ -{ - "swagger": "2.0", - "info": { - "title": "ResourceManagementClient", - "version": "2015-11-01" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}": { - "delete": { - "tags": [ - "Deployments" - ], - "operationId": "Deployments_Delete", - "description": "Begin deleting deployment.To determine whether the operation has finished processing the request, call GetLongRunningOperationStatus.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group. The name is case insensitive.", - "pattern": "^[-\\w\\._]+$" - }, - { - "name": "deploymentName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the deployment to be deleted." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "202": { - "description": "" - }, - "204": { - "description": "" - } - }, - "x-ms-long-running-operation": true - }, - "head": { - "tags": [ - "Deployments" - ], - "operationId": "Deployments_CheckExistence", - "description": "Checks whether deployment exists.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group to check. The name is case insensitive.", - "pattern": "^[-\\w\\._]+$" - }, - { - "name": "deploymentName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the deployment." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "204": { - "description": "" - }, - "404": { - "description": "" - } - } - }, - "put": { - "tags": [ - "Deployments" - ], - "operationId": "Deployments_CreateOrUpdate", - "description": "Create a named template deployment using a template.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group. The name is case insensitive.", - "pattern": "^[-\\w\\._]+$" - }, - { - "name": "deploymentName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the deployment." - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/Deployment" - }, - "description": "Additional parameters supplied to the operation." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/DeploymentExtended" - } - }, - "201": { - "description": "", - "schema": { - "$ref": "#/definitions/DeploymentExtended" - } - } - }, - "x-ms-long-running-operation": true - }, - "get": { - "tags": [ - "Deployments" - ], - "operationId": "Deployments_Get", - "description": "Get a deployment.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group to get. The name is case insensitive.", - "pattern": "^[-\\w\\._]+$" - }, - { - "name": "deploymentName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the deployment." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/DeploymentExtended" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/cancel": { - "post": { - "tags": [ - "Deployments" - ], - "operationId": "Deployments_Cancel", - "description": "Cancel a currently running template deployment.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group. The name is case insensitive.", - "pattern": "^[-\\w\\._]+$" - }, - { - "name": "deploymentName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the deployment." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "204": { - "description": "" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/validate": { - "post": { - "tags": [ - "Deployments" - ], - "operationId": "Deployments_Validate", - "description": "Validate a deployment template.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group. The name is case insensitive.", - "pattern": "^[-\\w\\._]+$" - }, - { - "name": "deploymentName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the deployment." - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/Deployment" - }, - "description": "Deployment to validate." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/DeploymentValidateResult" - } - }, - "400": { - "description": "", - "schema": { - "$ref": "#/definitions/DeploymentValidateResult" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/": { - "get": { - "tags": [ - "Deployments" - ], - "operationId": "Deployments_List", - "description": "Get a list of deployments.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group to filter by. The name is case insensitive." - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "The filter to apply on the operation." - }, - { - "name": "$top", - "in": "query", - "required": false, - "type": "integer", - "format": "int32", - "description": "Query parameters. If null is passed returns all deployments." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/DeploymentListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-odata": "#/definitions/DeploymentExtendedFilter" - } - }, - "/subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}/unregister": { - "post": { - "tags": [ - "Providers" - ], - "operationId": "Providers_Unregister", - "description": "Unregisters provider from a subscription.", - "parameters": [ - { - "name": "resourceProviderNamespace", - "in": "path", - "required": true, - "type": "string", - "description": "Namespace of the resource provider." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/Provider" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}/register": { - "post": { - "tags": [ - "Providers" - ], - "operationId": "Providers_Register", - "description": "Registers provider to be used with a subscription.", - "parameters": [ - { - "name": "resourceProviderNamespace", - "in": "path", - "required": true, - "type": "string", - "description": "Namespace of the resource provider." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/Provider" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers": { - "get": { - "tags": [ - "Providers" - ], - "operationId": "Providers_List", - "description": "Gets a list of resource providers.", - "parameters": [ - { - "name": "$top", - "in": "query", - "required": false, - "type": "integer", - "format": "int32", - "description": "Query parameters. If null is passed returns all deployments." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/ProviderListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}": { - "get": { - "tags": [ - "Providers" - ], - "operationId": "Providers_Get", - "description": "Gets a resource provider.", - "parameters": [ - { - "name": "resourceProviderNamespace", - "in": "path", - "required": true, - "type": "string", - "description": "Namespace of the resource provider." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/Provider" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/resources": { - "get": { - "tags": [ - "ResourceGroups" - ], - "operationId": "ResourceGroups_ListResources", - "description": "Get all of the resources under a subscription.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "Query parameters. If null is passed returns all resource groups." - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "The filter to apply on the operation." - }, - { - "name": "$top", - "in": "query", - "required": false, - "type": "integer", - "format": "int32", - "description": "Query parameters. If null is passed returns all resource groups." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/ResourceListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-odata": "#/definitions/GenericResourceFilter" - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}": { - "head": { - "tags": [ - "ResourceGroups" - ], - "operationId": "ResourceGroups_CheckExistence", - "description": "Checks whether resource group exists.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group to check. The name is case insensitive.", - "pattern": "^[-\\w\\._]+$" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "204": { - "description": "" - }, - "404": { - "description": "" - } - } - }, - "put": { - "tags": [ - "ResourceGroups" - ], - "operationId": "ResourceGroups_CreateOrUpdate", - "description": "Create a resource group.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group to be created or updated.", - "pattern": "^[-\\w\\._]+$" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ResourceGroup" - }, - "description": "Parameters supplied to the create or update resource group service operation." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "", - "schema": { - "$ref": "#/definitions/ResourceGroup" - } - }, - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/ResourceGroup" - } - } - } - }, - "delete": { - "tags": [ - "ResourceGroups" - ], - "operationId": "ResourceGroups_Delete", - "description": "Begin deleting resource group.To determine whether the operation has finished processing the request, call GetLongRunningOperationStatus.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group to be deleted. The name is case insensitive.", - "pattern": "^[-\\w\\._]+$" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "202": { - "description": "" - }, - "200": { - "description": "" - } - }, - "x-ms-long-running-operation": true - }, - "get": { - "tags": [ - "ResourceGroups" - ], - "operationId": "ResourceGroups_Get", - "description": "Get a resource group.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group to get. The name is case insensitive.", - "pattern": "^[-\\w\\._]+$" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/ResourceGroup" - } - } - } - }, - "patch": { - "tags": [ - "ResourceGroups" - ], - "operationId": "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 groups, though if a field is unspecified current value will be carried over. ", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group to be created or updated. The name is case insensitive.", - "pattern": "^[-\\w\\._]+$" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ResourceGroup" - }, - "description": "Parameters supplied to the update state resource group service operation." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/ResourceGroup" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups": { - "get": { - "tags": [ - "ResourceGroups" - ], - "operationId": "ResourceGroups_List", - "description": "Gets a collection of resource groups.", - "parameters": [ - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "The filter to apply on the operation." - }, - { - "name": "$top", - "in": "query", - "required": false, - "type": "integer", - "format": "int32", - "description": "Query parameters. If null is passed returns all resource groups." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/ResourceGroupListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-odata": "#/definitions/ResourceGroupFilter" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{sourceResourceGroupName}/moveResources": { - "post": { - "tags": [ - "Resources" - ], - "operationId": "Resources_MoveResources", - "description": "Begin moving resources.To determine whether the operation has finished processing the request, call GetLongRunningOperationStatus.", - "parameters": [ - { - "name": "sourceResourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "Source resource group name.", - "pattern": "^[-\\w\\._]+$" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ResourcesMoveInfo" - }, - "description": "move resources' parameters." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "202": { - "description": "" - }, - "204": { - "description": "" - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resources": { - "get": { - "tags": [ - "Resources" - ], - "operationId": "Resources_List", - "description": "Get all of the resources under a subscription.", - "parameters": [ - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "The filter to apply on the operation." - }, - { - "name": "$top", - "in": "query", - "required": false, - "type": "integer", - "format": "int32", - "description": "Query parameters. If null is passed returns all resource groups." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/ResourceListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-odata": "#/definitions/GenericResourceFilter" - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}": { - "head": { - "tags": [ - "Resources" - ], - "operationId": "Resources_CheckExistence", - "description": "Checks whether resource exists.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group. The name is case insensitive.", - "pattern": "^[-\\w\\._]+$" - }, - { - "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": "api-version", - "in": "query", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "204": { - "description": "" - }, - "404": { - "description": "" - } - } - }, - "delete": { - "tags": [ - "Resources" - ], - "operationId": "Resources_Delete", - "description": "Delete resource and all of its resources. ", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group. The name is case insensitive.", - "pattern": "^[-\\w\\._]+$" - }, - { - "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": "api-version", - "in": "query", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "" - }, - "204": { - "description": "" - }, - "202": { - "description": "" - } - } - }, - "put": { - "tags": [ - "Resources" - ], - "operationId": "Resources_CreateOrUpdate", - "description": "Create a resource.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group. The name is case insensitive.", - "pattern": "^[-\\w\\._]+$" - }, - { - "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": "api-version", - "in": "query", - "required": true, - "type": "string" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/GenericResource" - }, - "description": "Create or update resource parameters." - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "", - "schema": { - "$ref": "#/definitions/GenericResource" - } - }, - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/GenericResource" - } - } - } - }, - "get": { - "tags": [ - "Resources" - ], - "operationId": "Resources_Get", - "description": "Returns a resource belonging to a resource group.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group. The name is case insensitive.", - "pattern": "^[-\\w\\._]+$" - }, - { - "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": "api-version", - "in": "query", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/GenericResource" - } - }, - "204": { - "description": "", - "schema": { - "$ref": "#/definitions/GenericResource" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/tagNames/{tagName}/tagValues/{tagValue}": { - "delete": { - "tags": [ - "Tags" - ], - "operationId": "Tags_DeleteValue", - "description": "Delete a subscription resource tag value.", - "parameters": [ - { - "name": "tagName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the tag." - }, - { - "name": "tagValue", - "in": "path", - "required": true, - "type": "string", - "description": "The value of the tag." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "" - }, - "204": { - "description": "" - } - } - }, - "put": { - "tags": [ - "Tags" - ], - "operationId": "Tags_CreateOrUpdateValue", - "description": "Create a subscription resource tag value.", - "parameters": [ - { - "name": "tagName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the tag." - }, - { - "name": "tagValue", - "in": "path", - "required": true, - "type": "string", - "description": "The value of the tag." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/TagValue" - } - }, - "201": { - "description": "", - "schema": { - "$ref": "#/definitions/TagValue" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/tagNames/{tagName}": { - "put": { - "tags": [ - "Tags" - ], - "operationId": "Tags_CreateOrUpdate", - "description": "Create a subscription resource tag.", - "parameters": [ - { - "name": "tagName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the tag." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/TagDetails" - } - }, - "201": { - "description": "", - "schema": { - "$ref": "#/definitions/TagDetails" - } - } - } - }, - "delete": { - "tags": [ - "Tags" - ], - "operationId": "Tags_Delete", - "description": "Delete a subscription resource tag.", - "parameters": [ - { - "name": "tagName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the tag." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "" - }, - "204": { - "description": "" - } - } - } - }, - "/subscriptions/{subscriptionId}/tagNames": { - "get": { - "tags": [ - "Tags" - ], - "operationId": "Tags_List", - "description": "Get a list of subscription resource tags.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/TagsListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/deployments/{deploymentName}/operations/{operationId}": { - "get": { - "tags": [ - "DeploymentOperations" - ], - "operationId": "DeploymentOperations_Get", - "description": "Get a list of deployments operations.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group. The name is case insensitive.", - "pattern": "^[-\\w\\._]+$" - }, - { - "name": "deploymentName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the deployment." - }, - { - "name": "operationId", - "in": "path", - "required": true, - "type": "string", - "description": "Operation Id." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/DeploymentOperation" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/deployments/{deploymentName}/operations": { - "get": { - "tags": [ - "DeploymentOperations" - ], - "operationId": "DeploymentOperations_List", - "description": "Gets a list of deployments operations.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group. The name is case insensitive.", - "pattern": "^[-\\w\\._]+$" - }, - { - "name": "deploymentName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the deployment." - }, - { - "name": "$top", - "in": "query", - "required": false, - "type": "integer", - "format": "int32", - "description": "Query parameters." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/DeploymentOperationsListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/providers/{resourceProviderNamespace}/operations": { - "get": { - "tags": [ - "ResourceProviderOperationDetails" - ], - "operationId": "ResourceProviderOperationDetails_List", - "description": "Gets a list of resource providers.", - "parameters": [ - { - "name": "resourceProviderNamespace", - "in": "path", - "required": true, - "type": "string", - "description": "Resource identity." - }, - { - "name": "api-version", - "in": "query", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/ResourceProviderOperationDetailListResult" - } - }, - "204": { - "description": "", - "schema": { - "$ref": "#/definitions/ResourceProviderOperationDetailListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policydefinitions/{policyDefinitionName}": { - "put": { - "tags": [ - "PolicyDefinitions" - ], - "operationId": "PolicyDefinitions_CreateOrUpdate", - "description": "Create or update policy definition.", - "parameters": [ - { - "name": "policyDefinitionName", - "in": "path", - "required": true, - "type": "string", - "description": "The policy definition name." - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/PolicyDefinition" - }, - "description": "The policy definition properties" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "", - "schema": { - "$ref": "#/definitions/PolicyDefinition" - } - } - } - }, - "get": { - "tags": [ - "PolicyDefinitions" - ], - "operationId": "PolicyDefinitions_Get", - "description": "Gets policy definition.", - "parameters": [ - { - "name": "policyDefinitionName", - "in": "path", - "required": true, - "type": "string", - "description": "The policy definition name." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/PolicyDefinition" - } - } - } - }, - "delete": { - "tags": [ - "PolicyDefinitions" - ], - "operationId": "PolicyDefinitions_Delete", - "description": "Deletes policy definition.", - "parameters": [ - { - "name": "policyDefinitionName", - "in": "path", - "required": true, - "type": "string", - "description": "The policy definition name." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}providers/Microsoft.Authorization/policyAssignments": { - "get": { - "tags": [ - "PolicyAssignments" - ], - "operationId": "PolicyAssignments_ListForResource", - "description": "Gets policy assignments of the 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": "The name of the resource provider." - }, - { - "name": "parentResourcePath", - "in": "path", - "required": true, - "type": "string", - "description": "The parent resource path." - }, - { - "name": "resourceType", - "in": "path", - "required": true, - "type": "string", - "description": "The resource type." - }, - { - "name": "resourceName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource name." - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "The filter to apply on the operation.", - "x-ms-skip-url-encoding": true - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/PolicyAssignmentListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Authorization/policyAssignments": { - "get": { - "tags": [ - "PolicyAssignments" - ], - "operationId": "PolicyAssignments_ListForResourceGroup", - "description": "Gets policy assignments of the 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.", - "x-ms-skip-url-encoding": true - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/PolicyAssignmentListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}": { - "delete": { - "tags": [ - "PolicyAssignments" - ], - "operationId": "PolicyAssignments_Delete", - "description": "Delete policy assignment.", - "parameters": [ - { - "name": "scope", - "in": "path", - "required": true, - "type": "string", - "description": "Scope.", - "x-ms-skip-url-encoding": true - }, - { - "name": "policyAssignmentName", - "in": "path", - "required": true, - "type": "string", - "description": "Policy assignment name." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/PolicyAssignment" - } - } - } - }, - "put": { - "tags": [ - "PolicyAssignments" - ], - "operationId": "PolicyAssignments_Create", - "description": "Create policy assignment.", - "parameters": [ - { - "name": "scope", - "in": "path", - "required": true, - "type": "string", - "description": "Scope.", - "x-ms-skip-url-encoding": true - }, - { - "name": "policyAssignmentName", - "in": "path", - "required": true, - "type": "string", - "description": "Policy assignment name." - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/PolicyAssignment" - }, - "description": "Policy assignment." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "", - "schema": { - "$ref": "#/definitions/PolicyAssignment" - } - } - } - }, - "get": { - "tags": [ - "PolicyAssignments" - ], - "operationId": "PolicyAssignments_Get", - "description": "Get single policy assignment.", - "parameters": [ - { - "name": "scope", - "in": "path", - "required": true, - "type": "string", - "description": "Scope.", - "x-ms-skip-url-encoding": true - }, - { - "name": "policyAssignmentName", - "in": "path", - "required": true, - "type": "string", - "description": "Policy assignment name." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/PolicyAssignment" - } - } - } - } - }, - "/{policyAssignmentId}": { - "delete": { - "tags": [ - "PolicyAssignments" - ], - "operationId": "PolicyAssignments_DeleteById", - "description": "Delete policy assignment.", - "parameters": [ - { - "name": "policyAssignmentId", - "in": "path", - "required": true, - "type": "string", - "description": "Policy assignment Id", - "x-ms-skip-url-encoding": true - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/PolicyAssignment" - } - } - } - }, - "put": { - "tags": [ - "PolicyAssignments" - ], - "operationId": "PolicyAssignments_CreateById", - "description": "Create policy assignment by Id.", - "parameters": [ - { - "name": "policyAssignmentId", - "in": "path", - "required": true, - "type": "string", - "description": "Policy assignment Id", - "x-ms-skip-url-encoding": true - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/PolicyAssignment" - }, - "description": "Policy assignment." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "", - "schema": { - "$ref": "#/definitions/PolicyAssignment" - } - } - } - }, - "get": { - "tags": [ - "PolicyAssignments" - ], - "operationId": "PolicyAssignments_GetById", - "description": "Get single policy assignment.", - "parameters": [ - { - "name": "policyAssignmentId", - "in": "path", - "required": true, - "type": "string", - "description": "Policy assignment Id", - "x-ms-skip-url-encoding": true - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/PolicyAssignment" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policyAssignments": { - "get": { - "tags": [ - "PolicyAssignments" - ], - "operationId": "PolicyAssignments_List", - "description": "Gets policy assignments of the subscription.", - "parameters": [ - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "The filter to apply on the operation.", - "x-ms-skip-url-encoding": true - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/PolicyAssignmentListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/{scope}/providers/Microsoft.Authorization/policyAssignments": { - "get": { - "tags": [ - "PolicyAssignments" - ], - "operationId": "PolicyAssignments_ListForScope", - "description": "Gets policy assignments of the scope.", - "parameters": [ - { - "name": "scope", - "in": "path", - "required": true, - "type": "string", - "description": "Scope.", - "x-ms-skip-url-encoding": true - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "The filter to apply on the operation.", - "x-ms-skip-url-encoding": true - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/PolicyAssignmentListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - } - }, - "definitions": { - "PolicyAssignmentProperties": { - "properties": { - "scope": { - "type": "string", - "description": "Gets or sets the policy assignment scope." - }, - "displayName": { - "type": "string", - "description": "Gets or sets the policy assignment display name." - }, - "policyDefinitionId": { - "type": "string", - "description": "Gets or sets the policy definition Id." - } - }, - "description": "Policy Assignment properties." - }, - "PolicyAssignment": { - "properties": { - "properties": { - "$ref": "#/definitions/PolicyAssignmentProperties", - "description": "Gets or sets the policy assignment properties." - }, - "name": { - "type": "string", - "readOnly": true, - "description": "Gets or sets the policy assignment name." - } - }, - "description": "Policy assignment." - }, - "PolicyAssignmentListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/PolicyAssignment" - }, - "description": "Policy assignment list." - }, - "nextLink": { - "type": "string", - "description": "Gets or sets the URL to get the next set of policy assignment results." - } - }, - "description": "Policy assignment list operation result." - }, - "PolicyDefinitionProperties": { - "properties": { - "description": { - "type": "string", - "description": "Gets or sets the policy definition description." - }, - "displayName": { - "type": "string", - "description": "Gets or sets the policy definition display name." - }, - "policyRule": { - "type": "object", - "description": "The policy rule json." - } - }, - "description": "Policy definition properties." - }, - "PolicyDefinition": { - "properties": { - "properties": { - "$ref": "#/definitions/PolicyDefinitionProperties", - "description": "Gets or sets the policy definition properties." - }, - "name": { - "type": "string", - "description": "Gets or sets the policy definition name." - } - }, - "description": "Policy definition." - }, - "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." - }, - "ResourceGroupFilter": { - "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." - }, - "TemplateLink": { - "properties": { - "uri": { - "type": "string", - "description": "URI referencing the template." - }, - "contentVersion": { - "type": "string", - "description": "If included it must match the ContentVersion in the template." - } - }, - "required": [ - "uri" - ], - "description": "Entity representing the reference to the template." - }, - "ParametersLink": { - "properties": { - "uri": { - "type": "string", - "description": "URI referencing the template." - }, - "contentVersion": { - "type": "string", - "description": "If included it must match the ContentVersion in the template." - } - }, - "required": [ - "uri" - ], - "description": "Entity representing the reference to the deployment paramaters." - }, - "DeploymentProperties": { - "properties": { - "template": { - "type": "object", - "description": "Gets or sets the template content. Use only one of Template or TemplateLink." - }, - "templateLink": { - "$ref": "#/definitions/TemplateLink", - "description": "Gets or sets the URI referencing the template. Use only one of Template or TemplateLink." - }, - "parameters": { - "type": "object", - "description": "Deployment parameters. Use only one of Parameters or ParametersLink." - }, - "parametersLink": { - "$ref": "#/definitions/ParametersLink", - "description": "Gets or sets the URI referencing the parameters. Use only one of Parameters or ParametersLink." - }, - "mode": { - "type": "string", - "description": "Gets or sets the deployment mode.", - "enum": [ - "Incremental", - "Complete" - ], - "x-ms-enum": { - "name": "DeploymentMode", - "modelAsString": false - } - } - }, - "description": "Deployment properties." - }, - "Deployment": { - "properties": { - "properties": { - "$ref": "#/definitions/DeploymentProperties", - "description": "Gets or sets the deployment properties." - } - }, - "description": "Deployment operation parameters." - }, - "ResourceManagementError": { - "properties": { - "code": { - "type": "string", - "description": "Gets or sets the error code returned from the server." - }, - "message": { - "type": "string", - "description": "Gets or sets the error message returned from the server." - }, - "target": { - "type": "string", - "description": "Gets or sets the target of the error." - } - }, - "required": [ - "code", - "message" - ] - }, - "ResourceManagementErrorWithDetails": { - "properties": { - "details": { - "type": "array", - "items": { - "$ref": "#/definitions/ResourceManagementError" - }, - "description": "Gets or sets validation error." - } - }, - "allOf": [ - { - "$ref": "#/definitions/ResourceManagementError" - } - ], - "required": [ - "code", - "message" - ] - }, - "ProviderResourceType": { - "properties": { - "resourceType": { - "type": "string", - "description": "Gets or sets the resource type." - }, - "locations": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Gets or sets the collection of locations where this resource type can be created in." - }, - "apiVersions": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Gets or sets the api version." - }, - "properties": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Gets or sets the properties." - } - }, - "description": "Resource type managed by the resource provider." - }, - "Provider": { - "properties": { - "id": { - "type": "string", - "description": "Gets or sets the provider id." - }, - "namespace": { - "type": "string", - "description": "Gets or sets the namespace of the provider." - }, - "registrationState": { - "type": "string", - "description": "Gets or sets the registration state of the provider." - }, - "resourceTypes": { - "type": "array", - "items": { - "$ref": "#/definitions/ProviderResourceType" - }, - "description": "Gets or sets the collection of provider resource types." - } - }, - "description": "Resource provider information." - }, - "BasicDependency": { - "properties": { - "id": { - "type": "string", - "description": "Gets or sets the ID of the dependency." - }, - "resourceType": { - "type": "string", - "description": "Gets or sets the dependency resource type." - }, - "resourceName": { - "type": "string", - "description": "Gets or sets the dependency resource name." - } - }, - "description": "Deployment dependency information." - }, - "Dependency": { - "properties": { - "dependsOn": { - "type": "array", - "items": { - "$ref": "#/definitions/BasicDependency" - }, - "description": "Gets the list of dependencies." - }, - "id": { - "type": "string", - "description": "Gets or sets the ID of the dependency." - }, - "resourceType": { - "type": "string", - "description": "Gets or sets the dependency resource type." - }, - "resourceName": { - "type": "string", - "description": "Gets or sets the dependency resource name." - } - }, - "description": "Deployment dependency information." - }, - "DeploymentPropertiesExtended": { - "properties": { - "provisioningState": { - "type": "string", - "description": "Gets or sets the state of the provisioning." - }, - "correlationId": { - "type": "string", - "description": "Gets or sets the correlation ID of the deployment." - }, - "timestamp": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the timestamp of the template deployment." - }, - "outputs": { - "type": "object", - "description": "Gets or sets key/value pairs that represent deploymentoutput." - }, - "providers": { - "type": "array", - "items": { - "$ref": "#/definitions/Provider" - }, - "description": "Gets the list of resource providers needed for the deployment." - }, - "dependencies": { - "type": "array", - "items": { - "$ref": "#/definitions/Dependency" - }, - "description": "Gets the list of deployment dependencies." - }, - "template": { - "type": "object", - "description": "Gets or sets the template content. Use only one of Template or TemplateLink." - }, - "templateLink": { - "$ref": "#/definitions/TemplateLink", - "description": "Gets or sets the URI referencing the template. Use only one of Template or TemplateLink." - }, - "parameters": { - "type": "object", - "description": "Deployment parameters. Use only one of Parameters or ParametersLink." - }, - "parametersLink": { - "$ref": "#/definitions/ParametersLink", - "description": "Gets or sets the URI referencing the parameters. Use only one of Parameters or ParametersLink." - }, - "mode": { - "type": "string", - "description": "Gets or sets the deployment mode.", - "enum": [ - "Incremental", - "Complete" - ], - "x-ms-enum": { - "name": "DeploymentMode", - "modelAsString": false - } - } - }, - "description": "Deployment properties with additional details." - }, - "DeploymentValidateResult": { - "properties": { - "error": { - "$ref": "#/definitions/ResourceManagementErrorWithDetails", - "description": "Gets or sets validation error." - }, - "properties": { - "$ref": "#/definitions/DeploymentPropertiesExtended", - "description": "Gets or sets the template deployment properties." - } - }, - "description": "Information from validate template deployment response." - }, - "DeploymentExtended": { - "properties": { - "id": { - "type": "string", - "description": "Gets or sets the ID of the deployment." - }, - "name": { - "type": "string", - "description": "Gets or sets the name of the deployment." - }, - "properties": { - "$ref": "#/definitions/DeploymentPropertiesExtended", - "description": "Gets or sets deployment properties." - } - }, - "required": [ - "name" - ], - "description": "Deployment information." - }, - "DeploymentListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/DeploymentExtended" - }, - "description": "Gets or sets the list of deployments." - }, - "nextLink": { - "type": "string", - "description": "Gets or sets the URL to get the next set of results." - } - }, - "description": "List of deployments." - }, - "ProviderListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Provider" - }, - "description": "Gets or sets the list of resource providers." - }, - "nextLink": { - "type": "string", - "description": "Gets or sets the URL to get the next set of results." - } - }, - "description": "List of resource providers." - }, - "GenericResource": { - "properties": { - "plan": { - "$ref": "#/definitions/Plan", - "description": "Gets or sets the plan of the resource." - }, - "properties": { - "type": "object", - "description": "Gets or sets the resource properties." - } - }, - "allOf": [ - { - "$ref": "Resource" - } - ], - "description": "Resource information." - }, - "Plan": { - "properties": { - "name": { - "type": "string", - "description": "Gets or sets the plan ID." - }, - "publisher": { - "type": "string", - "description": "Gets or sets the publisher ID." - }, - "product": { - "type": "string", - "description": "Gets or sets the offer ID." - }, - "promotionCode": { - "type": "string", - "description": "Gets or sets the promotion code." - } - }, - "description": "Plan for the resource." - }, - "ResourceListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/GenericResource" - }, - "description": "Gets or sets the list of resource groups." - }, - "nextLink": { - "type": "string", - "description": "Gets or sets the URL to get the next set of results." - } - }, - "required": [ - "nextLink" - ], - "description": "List of resource groups." - }, - "ResourceGroup": { - "properties": { - "id": { - "readOnly": true, - "type": "string", - "description": "Gets the ID of the resource group." - }, - "name": { - "type": "string", - "description": "Gets or sets the Name of the resource group." - }, - "properties": { - "$ref": "#/definitions/ResourceGroupProperties" - }, - "location": { - "type": "string", - "description": "Gets or sets the location of the resource group. It cannot be changed after the resource group has been created. Has to be one of the supported Azure Locations, such as West US, East US, West Europe, East Asia, etc." - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Gets or sets the tags attached to the resource group." - } - }, - "required": [ - "location" - ], - "description": "Resource group information." - }, - "ResourceGroupProperties": { - "properties": { - "provisioningState": { - "readOnly": true, - "type": "string", - "description": "Gets resource group provisioning state." - } - }, - "description": "The resource group properties." - }, - "ResourceGroupListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ResourceGroup" - }, - "description": "Gets or sets the list of resource groups." - }, - "nextLink": { - "type": "string", - "description": "Gets or sets the URL to get the next set of results." - } - }, - "required": [ - "nextLink" - ], - "description": "List of resource groups." - }, - "ResourcesMoveInfo": { - "properties": { - "resources": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Gets or sets the ids of the resources." - }, - "targetResourceGroup": { - "type": "string", - "description": "The target resource group." - } - }, - "description": "Parameters of move resources." - }, - "TagCount": { - "properties": { - "type": { - "type": "string", - "description": "Type of count." - }, - "value": { - "type": "string", - "description": "Value of count." - } - }, - "description": "Tag count." - }, - "TagValue": { - "properties": { - "id": { - "type": "string", - "description": "Gets or sets the tag ID." - }, - "tagValue": { - "type": "string", - "description": "Gets or sets the tag value." - }, - "count": { - "$ref": "#/definitions/TagCount", - "description": "Gets or sets the tag value count." - } - }, - "description": "Tag information." - }, - "TagDetails": { - "properties": { - "id": { - "type": "string", - "description": "Gets or sets the tag ID." - }, - "tagName": { - "type": "string", - "description": "Gets or sets the tag name." - }, - "count": { - "$ref": "#/definitions/TagCount", - "description": "Gets or sets the tag count." - }, - "values": { - "type": "array", - "items": { - "$ref": "#/definitions/TagValue" - }, - "description": "Gets or sets the list of tag values." - } - }, - "description": "Tag details." - }, - "TagsListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/TagDetails" - }, - "description": "Gets or sets the list of tags." - }, - "nextLink": { - "type": "string", - "description": "Gets or sets the URL to get the next set of results." - } - }, - "required": [ - "nextLink" - ], - "description": "List of subscription tags." - }, - "TargetResource": { - "properties": { - "id": { - "type": "string", - "description": "Gets or sets the ID of the resource." - }, - "resourceName": { - "type": "string", - "description": "Gets or sets the name of the resource." - }, - "resourceType": { - "type": "string", - "description": "Gets or sets the type of the resource." - } - }, - "description": "Target resource." - }, - "DeploymentOperationProperties": { - "properties": { - "provisioningState": { - "type": "string", - "description": "Gets or sets the state of the provisioning." - }, - "timestamp": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the date and time of the operation." - }, - "statusCode": { - "type": "string", - "description": "Gets or sets operation status code." - }, - "statusMessage": { - "type": "object", - "description": "Gets or sets operation status message." - }, - "targetResource": { - "$ref": "#/definitions/TargetResource", - "description": "Gets or sets the target resource." - } - }, - "description": "Deployment operation properties." - }, - "DeploymentOperation": { - "properties": { - "id": { - "type": "string", - "description": "Gets or sets full deployment operation id." - }, - "operationId": { - "type": "string", - "description": "Gets or sets deployment operation id." - }, - "properties": { - "$ref": "#/definitions/DeploymentOperationProperties", - "description": "Gets or sets deployment properties." - } - }, - "description": "Deployment operation information." - }, - "DeploymentOperationsListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/DeploymentOperation" - }, - "description": "Gets or sets the list of deployments." - }, - "nextLink": { - "type": "string", - "description": "Gets or sets the URL to get the next set of results." - } - }, - "description": "List of deployment operations." - }, - "ResourceProviderOperationDisplayProperties": { - "properties": { - "publisher": { - "type": "string", - "description": "Gets or sets operation description." - }, - "provider": { - "type": "string", - "description": "Gets or sets operation provider." - }, - "resource": { - "type": "string", - "description": "Gets or sets operation resource." - }, - "operation": { - "type": "string", - "description": "Gets or sets operation." - }, - "description": { - "type": "string", - "description": "Gets or sets operation description." - } - }, - "description": "Resource provider operation's display properties." - }, - "ResourceProviderOperationDefinition": { - "properties": { - "name": { - "type": "string", - "description": "Gets or sets the provider operation name." - }, - "display": { - "$ref": "#/definitions/ResourceProviderOperationDisplayProperties", - "description": "Gets or sets the display property of the provider operation." - } - }, - "description": "Resource provider operation information." - }, - "ResourceProviderOperationDetailListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ResourceProviderOperationDefinition" - }, - "description": "Gets or sets the list of resource provider operations." - } - }, - "description": "List of resource provider operations." - }, - "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-azure-resource": true - }, - "SubResource": { - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - } - }, - "x-ms-azure-resource": 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." - } - } +{ + "swagger": "2.0", + "info": { + "title": "ResourceManagementClient", + "version": "2015-11-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}": { + "delete": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_Delete", + "description": "Begin deleting deployment.To determine whether the operation has finished processing the request, call GetLongRunningOperationStatus.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group. The name is case insensitive.", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "deploymentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the deployment to be deleted." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "" + }, + "204": { + "description": "" + } + }, + "x-ms-long-running-operation": true + }, + "head": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_CheckExistence", + "description": "Checks whether deployment exists.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group to check. The name is case insensitive.", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "deploymentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the deployment." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "" + }, + "404": { + "description": "" + } + } + }, + "put": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_CreateOrUpdate", + "description": "Create a named template deployment using a template.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group. The name is case insensitive.", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "deploymentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the deployment." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Deployment" + }, + "description": "Additional parameters supplied to the operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/DeploymentExtended" + } + }, + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/DeploymentExtended" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_Get", + "description": "Get a deployment.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group to get. The name is case insensitive.", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "deploymentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the deployment." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/DeploymentExtended" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/cancel": { + "post": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_Cancel", + "description": "Cancel a currently running template deployment.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group. The name is case insensitive.", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "deploymentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the deployment." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/validate": { + "post": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_Validate", + "description": "Validate a deployment template.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group. The name is case insensitive.", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "deploymentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the deployment." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Deployment" + }, + "description": "Deployment to validate." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/DeploymentValidateResult" + } + }, + "400": { + "description": "", + "schema": { + "$ref": "#/definitions/DeploymentValidateResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/": { + "get": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_List", + "description": "Get a list of deployments.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group to filter by. The name is case insensitive." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Query parameters. If null is passed returns all deployments." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/DeploymentListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/DeploymentExtendedFilter" + } + }, + "/subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}/unregister": { + "post": { + "tags": [ + "Providers" + ], + "operationId": "Providers_Unregister", + "description": "Unregisters provider from a subscription.", + "parameters": [ + { + "name": "resourceProviderNamespace", + "in": "path", + "required": true, + "type": "string", + "description": "Namespace of the resource provider." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/Provider" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}/register": { + "post": { + "tags": [ + "Providers" + ], + "operationId": "Providers_Register", + "description": "Registers provider to be used with a subscription.", + "parameters": [ + { + "name": "resourceProviderNamespace", + "in": "path", + "required": true, + "type": "string", + "description": "Namespace of the resource provider." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/Provider" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers": { + "get": { + "tags": [ + "Providers" + ], + "operationId": "Providers_List", + "description": "Gets a list of resource providers.", + "parameters": [ + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Query parameters. If null is passed returns all deployments." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ProviderListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}": { + "get": { + "tags": [ + "Providers" + ], + "operationId": "Providers_Get", + "description": "Gets a resource provider.", + "parameters": [ + { + "name": "resourceProviderNamespace", + "in": "path", + "required": true, + "type": "string", + "description": "Namespace of the resource provider." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/Provider" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/resources": { + "get": { + "tags": [ + "ResourceGroups" + ], + "operationId": "ResourceGroups_ListResources", + "description": "Get all of the resources under a subscription.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Query parameters. If null is passed returns all resource groups." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Query parameters. If null is passed returns all resource groups." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ResourceListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/GenericResourceFilter" + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}": { + "head": { + "tags": [ + "ResourceGroups" + ], + "operationId": "ResourceGroups_CheckExistence", + "description": "Checks whether resource group exists.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group to check. The name is case insensitive.", + "pattern": "^[-\\w\\._]+$" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "" + }, + "404": { + "description": "" + } + } + }, + "put": { + "tags": [ + "ResourceGroups" + ], + "operationId": "ResourceGroups_CreateOrUpdate", + "description": "Create a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group to be created or updated.", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ResourceGroup" + }, + "description": "Parameters supplied to the create or update resource group service operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/ResourceGroup" + } + }, + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ResourceGroup" + } + } + } + }, + "delete": { + "tags": [ + "ResourceGroups" + ], + "operationId": "ResourceGroups_Delete", + "description": "Begin deleting resource group.To determine whether the operation has finished processing the request, call GetLongRunningOperationStatus.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group to be deleted. The name is case insensitive.", + "pattern": "^[-\\w\\._]+$" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "" + }, + "200": { + "description": "" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "ResourceGroups" + ], + "operationId": "ResourceGroups_Get", + "description": "Get a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group to get. The name is case insensitive.", + "pattern": "^[-\\w\\._]+$" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ResourceGroup" + } + } + } + }, + "patch": { + "tags": [ + "ResourceGroups" + ], + "operationId": "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 groups, though if a field is unspecified current value will be carried over. ", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group to be created or updated. The name is case insensitive.", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ResourceGroup" + }, + "description": "Parameters supplied to the update state resource group service operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ResourceGroup" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups": { + "get": { + "tags": [ + "ResourceGroups" + ], + "operationId": "ResourceGroups_List", + "description": "Gets a collection of resource groups.", + "parameters": [ + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Query parameters. If null is passed returns all resource groups." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ResourceGroupListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/ResourceGroupFilter" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{sourceResourceGroupName}/moveResources": { + "post": { + "tags": [ + "Resources" + ], + "operationId": "Resources_MoveResources", + "description": "Begin moving resources.To determine whether the operation has finished processing the request, call GetLongRunningOperationStatus.", + "parameters": [ + { + "name": "sourceResourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Source resource group name.", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ResourcesMoveInfo" + }, + "description": "move resources' parameters." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "" + }, + "204": { + "description": "" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resources": { + "get": { + "tags": [ + "Resources" + ], + "operationId": "Resources_List", + "description": "Get all of the resources under a subscription.", + "parameters": [ + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Query parameters. If null is passed returns all resource groups." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ResourceListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/GenericResourceFilter" + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}": { + "head": { + "tags": [ + "Resources" + ], + "operationId": "Resources_CheckExistence", + "description": "Checks whether resource exists.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group. The name is case insensitive.", + "pattern": "^[-\\w\\._]+$" + }, + { + "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": "api-version", + "in": "query", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "" + }, + "404": { + "description": "" + } + } + }, + "delete": { + "tags": [ + "Resources" + ], + "operationId": "Resources_Delete", + "description": "Delete resource and all of its resources. ", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group. The name is case insensitive.", + "pattern": "^[-\\w\\._]+$" + }, + { + "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": "api-version", + "in": "query", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "" + }, + "204": { + "description": "" + }, + "202": { + "description": "" + } + } + }, + "put": { + "tags": [ + "Resources" + ], + "operationId": "Resources_CreateOrUpdate", + "description": "Create a resource.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group. The name is case insensitive.", + "pattern": "^[-\\w\\._]+$" + }, + { + "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": "api-version", + "in": "query", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GenericResource" + }, + "description": "Create or update resource parameters." + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/GenericResource" + } + }, + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/GenericResource" + } + } + } + }, + "get": { + "tags": [ + "Resources" + ], + "operationId": "Resources_Get", + "description": "Returns a resource belonging to a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group. The name is case insensitive.", + "pattern": "^[-\\w\\._]+$" + }, + { + "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": "api-version", + "in": "query", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/GenericResource" + } + }, + "204": { + "description": "", + "schema": { + "$ref": "#/definitions/GenericResource" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/tagNames/{tagName}/tagValues/{tagValue}": { + "delete": { + "tags": [ + "Tags" + ], + "operationId": "Tags_DeleteValue", + "description": "Delete a subscription resource tag value.", + "parameters": [ + { + "name": "tagName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the tag." + }, + { + "name": "tagValue", + "in": "path", + "required": true, + "type": "string", + "description": "The value of the tag." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "" + }, + "204": { + "description": "" + } + } + }, + "put": { + "tags": [ + "Tags" + ], + "operationId": "Tags_CreateOrUpdateValue", + "description": "Create a subscription resource tag value.", + "parameters": [ + { + "name": "tagName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the tag." + }, + { + "name": "tagValue", + "in": "path", + "required": true, + "type": "string", + "description": "The value of the tag." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/TagValue" + } + }, + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/TagValue" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/tagNames/{tagName}": { + "put": { + "tags": [ + "Tags" + ], + "operationId": "Tags_CreateOrUpdate", + "description": "Create a subscription resource tag.", + "parameters": [ + { + "name": "tagName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the tag." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/TagDetails" + } + }, + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/TagDetails" + } + } + } + }, + "delete": { + "tags": [ + "Tags" + ], + "operationId": "Tags_Delete", + "description": "Delete a subscription resource tag.", + "parameters": [ + { + "name": "tagName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the tag." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "" + }, + "204": { + "description": "" + } + } + } + }, + "/subscriptions/{subscriptionId}/tagNames": { + "get": { + "tags": [ + "Tags" + ], + "operationId": "Tags_List", + "description": "Get a list of subscription resource tags.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/TagsListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/deployments/{deploymentName}/operations/{operationId}": { + "get": { + "tags": [ + "DeploymentOperations" + ], + "operationId": "DeploymentOperations_Get", + "description": "Get a list of deployments operations.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group. The name is case insensitive.", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "deploymentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the deployment." + }, + { + "name": "operationId", + "in": "path", + "required": true, + "type": "string", + "description": "Operation Id." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/DeploymentOperation" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/deployments/{deploymentName}/operations": { + "get": { + "tags": [ + "DeploymentOperations" + ], + "operationId": "DeploymentOperations_List", + "description": "Gets a list of deployments operations.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group. The name is case insensitive.", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "deploymentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the deployment." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Query parameters." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/DeploymentOperationsListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/{resourceProviderNamespace}/operations": { + "get": { + "tags": [ + "ResourceProviderOperationDetails" + ], + "operationId": "ResourceProviderOperationDetails_List", + "description": "Gets a list of resource providers.", + "parameters": [ + { + "name": "resourceProviderNamespace", + "in": "path", + "required": true, + "type": "string", + "description": "Resource identity." + }, + { + "name": "api-version", + "in": "query", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ResourceProviderOperationDetailListResult" + } + }, + "204": { + "description": "", + "schema": { + "$ref": "#/definitions/ResourceProviderOperationDetailListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policydefinitions/{policyDefinitionName}": { + "put": { + "tags": [ + "PolicyDefinitions" + ], + "operationId": "PolicyDefinitions_CreateOrUpdate", + "description": "Create or update policy definition.", + "parameters": [ + { + "name": "policyDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "The policy definition name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PolicyDefinition" + }, + "description": "The policy definition properties" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/PolicyDefinition" + } + } + } + }, + "get": { + "tags": [ + "PolicyDefinitions" + ], + "operationId": "PolicyDefinitions_Get", + "description": "Gets policy definition.", + "parameters": [ + { + "name": "policyDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "The policy definition name." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/PolicyDefinition" + } + } + } + }, + "delete": { + "tags": [ + "PolicyDefinitions" + ], + "operationId": "PolicyDefinitions_Delete", + "description": "Deletes policy definition.", + "parameters": [ + { + "name": "policyDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "The policy definition name." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}providers/Microsoft.Authorization/policyAssignments": { + "get": { + "tags": [ + "PolicyAssignments" + ], + "operationId": "PolicyAssignments_ListForResource", + "description": "Gets policy assignments of the 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": "The name of the resource provider." + }, + { + "name": "parentResourcePath", + "in": "path", + "required": true, + "type": "string", + "description": "The parent resource path." + }, + { + "name": "resourceType", + "in": "path", + "required": true, + "type": "string", + "description": "The resource type." + }, + { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource name." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation.", + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/PolicyAssignmentListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Authorization/policyAssignments": { + "get": { + "tags": [ + "PolicyAssignments" + ], + "operationId": "PolicyAssignments_ListForResourceGroup", + "description": "Gets policy assignments of the 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.", + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/PolicyAssignmentListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}": { + "delete": { + "tags": [ + "PolicyAssignments" + ], + "operationId": "PolicyAssignments_Delete", + "description": "Delete policy assignment.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "Scope.", + "x-ms-skip-url-encoding": true + }, + { + "name": "policyAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "Policy assignment name." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/PolicyAssignment" + } + } + } + }, + "put": { + "tags": [ + "PolicyAssignments" + ], + "operationId": "PolicyAssignments_Create", + "description": "Create policy assignment.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "Scope.", + "x-ms-skip-url-encoding": true + }, + { + "name": "policyAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "Policy assignment name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PolicyAssignment" + }, + "description": "Policy assignment." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/PolicyAssignment" + } + } + } + }, + "get": { + "tags": [ + "PolicyAssignments" + ], + "operationId": "PolicyAssignments_Get", + "description": "Get single policy assignment.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "Scope.", + "x-ms-skip-url-encoding": true + }, + { + "name": "policyAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "Policy assignment name." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/PolicyAssignment" + } + } + } + } + }, + "/{policyAssignmentId}": { + "delete": { + "tags": [ + "PolicyAssignments" + ], + "operationId": "PolicyAssignments_DeleteById", + "description": "Delete policy assignment.", + "parameters": [ + { + "name": "policyAssignmentId", + "in": "path", + "required": true, + "type": "string", + "description": "Policy assignment Id", + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/PolicyAssignment" + } + } + } + }, + "put": { + "tags": [ + "PolicyAssignments" + ], + "operationId": "PolicyAssignments_CreateById", + "description": "Create policy assignment by Id.", + "parameters": [ + { + "name": "policyAssignmentId", + "in": "path", + "required": true, + "type": "string", + "description": "Policy assignment Id", + "x-ms-skip-url-encoding": true + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PolicyAssignment" + }, + "description": "Policy assignment." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/PolicyAssignment" + } + } + } + }, + "get": { + "tags": [ + "PolicyAssignments" + ], + "operationId": "PolicyAssignments_GetById", + "description": "Get single policy assignment.", + "parameters": [ + { + "name": "policyAssignmentId", + "in": "path", + "required": true, + "type": "string", + "description": "Policy assignment Id", + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/PolicyAssignment" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policyAssignments": { + "get": { + "tags": [ + "PolicyAssignments" + ], + "operationId": "PolicyAssignments_List", + "description": "Gets policy assignments of the subscription.", + "parameters": [ + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation.", + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/PolicyAssignmentListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{scope}/providers/Microsoft.Authorization/policyAssignments": { + "get": { + "tags": [ + "PolicyAssignments" + ], + "operationId": "PolicyAssignments_ListForScope", + "description": "Gets policy assignments of the scope.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "Scope.", + "x-ms-skip-url-encoding": true + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation.", + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/PolicyAssignmentListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "PolicyAssignmentProperties": { + "properties": { + "scope": { + "type": "string", + "description": "Gets or sets the policy assignment scope." + }, + "displayName": { + "type": "string", + "description": "Gets or sets the policy assignment display name." + }, + "policyDefinitionId": { + "type": "string", + "description": "Gets or sets the policy definition Id." + } + }, + "description": "Policy Assignment properties." + }, + "PolicyAssignment": { + "properties": { + "properties": { + "$ref": "#/definitions/PolicyAssignmentProperties", + "description": "Gets or sets the policy assignment properties." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Gets or sets the policy assignment name." + } + }, + "description": "Policy assignment." + }, + "PolicyAssignmentListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PolicyAssignment" + }, + "description": "Policy assignment list." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the URL to get the next set of policy assignment results." + } + }, + "description": "Policy assignment list operation result." + }, + "PolicyDefinitionProperties": { + "properties": { + "description": { + "type": "string", + "description": "Gets or sets the policy definition description." + }, + "displayName": { + "type": "string", + "description": "Gets or sets the policy definition display name." + }, + "policyRule": { + "type": "object", + "description": "The policy rule json." + } + }, + "description": "Policy definition properties." + }, + "PolicyDefinition": { + "properties": { + "properties": { + "$ref": "#/definitions/PolicyDefinitionProperties", + "description": "Gets or sets the policy definition properties." + }, + "name": { + "type": "string", + "description": "Gets or sets the policy definition name." + } + }, + "description": "Policy definition." + }, + "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." + }, + "ResourceGroupFilter": { + "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." + }, + "TemplateLink": { + "properties": { + "uri": { + "type": "string", + "description": "URI referencing the template." + }, + "contentVersion": { + "type": "string", + "description": "If included it must match the ContentVersion in the template." + } + }, + "required": [ + "uri" + ], + "description": "Entity representing the reference to the template." + }, + "ParametersLink": { + "properties": { + "uri": { + "type": "string", + "description": "URI referencing the template." + }, + "contentVersion": { + "type": "string", + "description": "If included it must match the ContentVersion in the template." + } + }, + "required": [ + "uri" + ], + "description": "Entity representing the reference to the deployment paramaters." + }, + "DeploymentProperties": { + "properties": { + "template": { + "type": "object", + "description": "Gets or sets the template content. Use only one of Template or TemplateLink." + }, + "templateLink": { + "$ref": "#/definitions/TemplateLink", + "description": "Gets or sets the URI referencing the template. Use only one of Template or TemplateLink." + }, + "parameters": { + "type": "object", + "description": "Deployment parameters. Use only one of Parameters or ParametersLink." + }, + "parametersLink": { + "$ref": "#/definitions/ParametersLink", + "description": "Gets or sets the URI referencing the parameters. Use only one of Parameters or ParametersLink." + }, + "mode": { + "type": "string", + "description": "Gets or sets the deployment mode.", + "enum": [ + "Incremental", + "Complete" + ], + "x-ms-enum": { + "name": "DeploymentMode", + "modelAsString": false + } + } + }, + "description": "Deployment properties." + }, + "Deployment": { + "properties": { + "properties": { + "$ref": "#/definitions/DeploymentProperties", + "description": "Gets or sets the deployment properties." + } + }, + "description": "Deployment operation parameters." + }, + "ResourceManagementError": { + "properties": { + "code": { + "type": "string", + "description": "Gets or sets the error code returned from the server." + }, + "message": { + "type": "string", + "description": "Gets or sets the error message returned from the server." + }, + "target": { + "type": "string", + "description": "Gets or sets the target of the error." + } + }, + "required": [ + "code", + "message" + ] + }, + "ResourceManagementErrorWithDetails": { + "properties": { + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceManagementError" + }, + "description": "Gets or sets validation error." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ResourceManagementError" + } + ], + "required": [ + "code", + "message" + ] + }, + "ProviderResourceType": { + "properties": { + "resourceType": { + "type": "string", + "description": "Gets or sets the resource type." + }, + "locations": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Gets or sets the collection of locations where this resource type can be created in." + }, + "apiVersions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Gets or sets the api version." + }, + "properties": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Gets or sets the properties." + } + }, + "description": "Resource type managed by the resource provider." + }, + "Provider": { + "properties": { + "id": { + "type": "string", + "description": "Gets or sets the provider id." + }, + "namespace": { + "type": "string", + "description": "Gets or sets the namespace of the provider." + }, + "registrationState": { + "type": "string", + "description": "Gets or sets the registration state of the provider." + }, + "resourceTypes": { + "type": "array", + "items": { + "$ref": "#/definitions/ProviderResourceType" + }, + "description": "Gets or sets the collection of provider resource types." + } + }, + "description": "Resource provider information." + }, + "BasicDependency": { + "properties": { + "id": { + "type": "string", + "description": "Gets or sets the ID of the dependency." + }, + "resourceType": { + "type": "string", + "description": "Gets or sets the dependency resource type." + }, + "resourceName": { + "type": "string", + "description": "Gets or sets the dependency resource name." + } + }, + "description": "Deployment dependency information." + }, + "Dependency": { + "properties": { + "dependsOn": { + "type": "array", + "items": { + "$ref": "#/definitions/BasicDependency" + }, + "description": "Gets the list of dependencies." + }, + "id": { + "type": "string", + "description": "Gets or sets the ID of the dependency." + }, + "resourceType": { + "type": "string", + "description": "Gets or sets the dependency resource type." + }, + "resourceName": { + "type": "string", + "description": "Gets or sets the dependency resource name." + } + }, + "description": "Deployment dependency information." + }, + "DeploymentPropertiesExtended": { + "properties": { + "provisioningState": { + "type": "string", + "description": "Gets or sets the state of the provisioning." + }, + "correlationId": { + "type": "string", + "description": "Gets or sets the correlation ID of the deployment." + }, + "timestamp": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the timestamp of the template deployment." + }, + "outputs": { + "type": "object", + "description": "Gets or sets key/value pairs that represent deploymentoutput." + }, + "providers": { + "type": "array", + "items": { + "$ref": "#/definitions/Provider" + }, + "description": "Gets the list of resource providers needed for the deployment." + }, + "dependencies": { + "type": "array", + "items": { + "$ref": "#/definitions/Dependency" + }, + "description": "Gets the list of deployment dependencies." + }, + "template": { + "type": "object", + "description": "Gets or sets the template content. Use only one of Template or TemplateLink." + }, + "templateLink": { + "$ref": "#/definitions/TemplateLink", + "description": "Gets or sets the URI referencing the template. Use only one of Template or TemplateLink." + }, + "parameters": { + "type": "object", + "description": "Deployment parameters. Use only one of Parameters or ParametersLink." + }, + "parametersLink": { + "$ref": "#/definitions/ParametersLink", + "description": "Gets or sets the URI referencing the parameters. Use only one of Parameters or ParametersLink." + }, + "mode": { + "type": "string", + "description": "Gets or sets the deployment mode.", + "enum": [ + "Incremental", + "Complete" + ], + "x-ms-enum": { + "name": "DeploymentMode", + "modelAsString": false + } + } + }, + "description": "Deployment properties with additional details." + }, + "DeploymentValidateResult": { + "properties": { + "error": { + "$ref": "#/definitions/ResourceManagementErrorWithDetails", + "description": "Gets or sets validation error." + }, + "properties": { + "$ref": "#/definitions/DeploymentPropertiesExtended", + "description": "Gets or sets the template deployment properties." + } + }, + "description": "Information from validate template deployment response." + }, + "DeploymentExtended": { + "properties": { + "id": { + "type": "string", + "description": "Gets or sets the ID of the deployment." + }, + "name": { + "type": "string", + "description": "Gets or sets the name of the deployment." + }, + "properties": { + "$ref": "#/definitions/DeploymentPropertiesExtended", + "description": "Gets or sets deployment properties." + } + }, + "required": [ + "name" + ], + "description": "Deployment information." + }, + "DeploymentListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DeploymentExtended" + }, + "description": "Gets or sets the list of deployments." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the URL to get the next set of results." + } + }, + "description": "List of deployments." + }, + "ProviderListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Provider" + }, + "description": "Gets or sets the list of resource providers." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the URL to get the next set of results." + } + }, + "description": "List of resource providers." + }, + "GenericResource": { + "properties": { + "plan": { + "$ref": "#/definitions/Plan", + "description": "Gets or sets the plan of the resource." + }, + "properties": { + "type": "object", + "description": "Gets or sets the resource properties." + } + }, + "allOf": [ + { + "$ref": "Resource" + } + ], + "description": "Resource information." + }, + "Plan": { + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the plan ID." + }, + "publisher": { + "type": "string", + "description": "Gets or sets the publisher ID." + }, + "product": { + "type": "string", + "description": "Gets or sets the offer ID." + }, + "promotionCode": { + "type": "string", + "description": "Gets or sets the promotion code." + } + }, + "description": "Plan for the resource." + }, + "ResourceListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/GenericResource" + }, + "description": "Gets or sets the list of resource groups." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the URL to get the next set of results." + } + }, + "required": [ + "nextLink" + ], + "description": "List of resource groups." + }, + "ResourceGroup": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Gets the ID of the resource group." + }, + "name": { + "type": "string", + "description": "Gets or sets the Name of the resource group." + }, + "properties": { + "$ref": "#/definitions/ResourceGroupProperties" + }, + "location": { + "type": "string", + "description": "Gets or sets the location of the resource group. It cannot be changed after the resource group has been created. Has to be one of the supported Azure Locations, such as West US, East US, West Europe, East Asia, etc." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Gets or sets the tags attached to the resource group." + } + }, + "required": [ + "location" + ], + "description": "Resource group information." + }, + "ResourceGroupProperties": { + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Gets resource group provisioning state." + } + }, + "description": "The resource group properties." + }, + "ResourceGroupListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceGroup" + }, + "description": "Gets or sets the list of resource groups." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the URL to get the next set of results." + } + }, + "required": [ + "nextLink" + ], + "description": "List of resource groups." + }, + "ResourcesMoveInfo": { + "properties": { + "resources": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Gets or sets the ids of the resources." + }, + "targetResourceGroup": { + "type": "string", + "description": "The target resource group." + } + }, + "description": "Parameters of move resources." + }, + "TagCount": { + "properties": { + "type": { + "type": "string", + "description": "Type of count." + }, + "value": { + "type": "string", + "description": "Value of count." + } + }, + "description": "Tag count." + }, + "TagValue": { + "properties": { + "id": { + "type": "string", + "description": "Gets or sets the tag ID." + }, + "tagValue": { + "type": "string", + "description": "Gets or sets the tag value." + }, + "count": { + "$ref": "#/definitions/TagCount", + "description": "Gets or sets the tag value count." + } + }, + "description": "Tag information." + }, + "TagDetails": { + "properties": { + "id": { + "type": "string", + "description": "Gets or sets the tag ID." + }, + "tagName": { + "type": "string", + "description": "Gets or sets the tag name." + }, + "count": { + "$ref": "#/definitions/TagCount", + "description": "Gets or sets the tag count." + }, + "values": { + "type": "array", + "items": { + "$ref": "#/definitions/TagValue" + }, + "description": "Gets or sets the list of tag values." + } + }, + "description": "Tag details." + }, + "TagsListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/TagDetails" + }, + "description": "Gets or sets the list of tags." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the URL to get the next set of results." + } + }, + "required": [ + "nextLink" + ], + "description": "List of subscription tags." + }, + "TargetResource": { + "properties": { + "id": { + "type": "string", + "description": "Gets or sets the ID of the resource." + }, + "resourceName": { + "type": "string", + "description": "Gets or sets the name of the resource." + }, + "resourceType": { + "type": "string", + "description": "Gets or sets the type of the resource." + } + }, + "description": "Target resource." + }, + "DeploymentOperationProperties": { + "properties": { + "provisioningState": { + "type": "string", + "description": "Gets or sets the state of the provisioning." + }, + "timestamp": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the date and time of the operation." + }, + "statusCode": { + "type": "string", + "description": "Gets or sets operation status code." + }, + "statusMessage": { + "type": "object", + "description": "Gets or sets operation status message." + }, + "targetResource": { + "$ref": "#/definitions/TargetResource", + "description": "Gets or sets the target resource." + } + }, + "description": "Deployment operation properties." + }, + "DeploymentOperation": { + "properties": { + "id": { + "type": "string", + "description": "Gets or sets full deployment operation id." + }, + "operationId": { + "type": "string", + "description": "Gets or sets deployment operation id." + }, + "properties": { + "$ref": "#/definitions/DeploymentOperationProperties", + "description": "Gets or sets deployment properties." + } + }, + "description": "Deployment operation information." + }, + "DeploymentOperationsListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DeploymentOperation" + }, + "description": "Gets or sets the list of deployments." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the URL to get the next set of results." + } + }, + "description": "List of deployment operations." + }, + "ResourceProviderOperationDisplayProperties": { + "properties": { + "publisher": { + "type": "string", + "description": "Gets or sets operation description." + }, + "provider": { + "type": "string", + "description": "Gets or sets operation provider." + }, + "resource": { + "type": "string", + "description": "Gets or sets operation resource." + }, + "operation": { + "type": "string", + "description": "Gets or sets operation." + }, + "description": { + "type": "string", + "description": "Gets or sets operation description." + } + }, + "description": "Resource provider operation's display properties." + }, + "ResourceProviderOperationDefinition": { + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the provider operation name." + }, + "display": { + "$ref": "#/definitions/ResourceProviderOperationDisplayProperties", + "description": "Gets or sets the display property of the provider operation." + } + }, + "description": "Resource provider operation information." + }, + "ResourceProviderOperationDetailListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceProviderOperationDefinition" + }, + "description": "Gets or sets the list of resource provider operations." + } + }, + "description": "List of resource provider operations." + }, + "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-azure-resource": true + }, + "SubResource": { + "properties": { + "id": { + "type": "string", + "description": "Resource Id" + } + }, + "x-ms-azure-resource": 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." + } + } } \ No newline at end of file diff --git a/arm-resources/subscriptions/2015-11-01/swagger/subscriptions.json b/arm-resources/subscriptions/2015-11-01/swagger/subscriptions.json index 63996f760473..c224f8521bb3 100644 --- a/arm-resources/subscriptions/2015-11-01/swagger/subscriptions.json +++ b/arm-resources/subscriptions/2015-11-01/swagger/subscriptions.json @@ -1,291 +1,291 @@ -{ - "swagger": "2.0", - "info": { - "title": "SubscriptionClient", - "version": "2015-11-01" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json", - "text/json" - ], - "produces": [ - "application/json", - "text/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/locations": { - "get": { - "tags": [ - "Subscriptions" - ], - "operationId": "Subscriptions_ListLocations", - "description": "Gets a list of the subscription locations.", - "parameters": [ - { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "Id of the subscription" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/LocationListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}": { - "get": { - "tags": [ - "Subscriptions" - ], - "operationId": "Subscriptions_Get", - "description": "Gets details about particular subscription.", - "parameters": [ - { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "Id of the subscription." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/Subscription" - } - } - } - } - }, - "/subscriptions": { - "get": { - "tags": [ - "Subscriptions" - ], - "operationId": "Subscriptions_List", - "description": "Gets a list of the subscriptionIds.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/SubscriptionListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/tenants": { - "get": { - "tags": [ - "Tenants" - ], - "operationId": "Tenants_List", - "description": "Gets a list of the tenantIds.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/TenantListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - } - }, - "definitions": { - "Location": { - "properties": { - "id": { - "type": "string", - "description": "Gets or sets the ID of the resource (/subscriptions/SubscriptionId)." - }, - "subscriptionId": { - "type": "string", - "description": "Gets or sets the subscription Id." - }, - "name": { - "type": "string", - "description": "Gets or sets the location name" - }, - "displayName": { - "type": "string", - "description": "Gets or sets the display name of the location" - }, - "latitude": { - "type": "string", - "description": "Gets or sets the latitude of the location" - }, - "longitude": { - "type": "string", - "description": "Gets or sets the longitude of the location" - } - }, - "description": "Location information." - }, - "LocationListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Location" - }, - "description": "Gets the locations." - } - }, - "description": "Location list operation response." - }, - "Subscription": { - "properties": { - "id": { - "type": "string", - "description": "Gets or sets the ID of the resource (/subscriptions/SubscriptionId)." - }, - "subscriptionId": { - "type": "string", - "description": "Gets or sets the subscription Id." - }, - "displayName": { - "type": "string", - "description": "Gets or sets the subscription display name" - }, - "state": { - "type": "string", - "description": "Gets or sets the subscription state" - }, - "subscriptionPolicies": { - "$ref": "#/definitions/SubscriptionPolicies", - "description": "Gets or sets the subscription policies." - } - }, - "description": "Subscription information." - }, - "SubscriptionPolicies": { - "properties": { - "locationPlacementId": { - "type": "string", - "description": "Gets or sets the subscription location placement Id." - }, - "quotaId": { - "type": "string", - "description": "Gets or sets the subscription quota Id." - } - }, - "description": "Subscription policies." - }, - "SubscriptionListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Subscription" - }, - "description": "Gets or sets subscriptions." - }, - "nextLink": { - "type": "string", - "description": "Gets or sets the URL to get the next set of results." - } - }, - "required": [ - "nextLink" - ], - "description": "Subscription list operation response." - }, - "TenantIdDescription": { - "properties": { - "id": { - "type": "string", - "description": "Gets or sets Id" - }, - "tenantId": { - "type": "string", - "description": "Gets or sets tenantId" - } - }, - "description": "Tenant Id information" - }, - "TenantListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/TenantIdDescription" - }, - "description": "Gets or sets tenant Ids." - }, - "nextLink": { - "type": "string", - "description": "Gets or sets the URL to get the next set of results." - } - }, - "required": [ - "nextLink" - ], - "description": "Tenant Ids information." - } - }, - "parameters": { - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "Client Api Version." - } - } -} +{ + "swagger": "2.0", + "info": { + "title": "SubscriptionClient", + "version": "2015-11-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json", + "text/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/locations": { + "get": { + "tags": [ + "Subscriptions" + ], + "operationId": "Subscriptions_ListLocations", + "description": "Gets a list of the subscription locations.", + "parameters": [ + { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Id of the subscription" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/LocationListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}": { + "get": { + "tags": [ + "Subscriptions" + ], + "operationId": "Subscriptions_Get", + "description": "Gets details about particular subscription.", + "parameters": [ + { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Id of the subscription." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/Subscription" + } + } + } + } + }, + "/subscriptions": { + "get": { + "tags": [ + "Subscriptions" + ], + "operationId": "Subscriptions_List", + "description": "Gets a list of the subscriptionIds.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SubscriptionListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/tenants": { + "get": { + "tags": [ + "Tenants" + ], + "operationId": "Tenants_List", + "description": "Gets a list of the tenantIds.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/TenantListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "Location": { + "properties": { + "id": { + "type": "string", + "description": "Gets or sets the ID of the resource (/subscriptions/SubscriptionId)." + }, + "subscriptionId": { + "type": "string", + "description": "Gets or sets the subscription Id." + }, + "name": { + "type": "string", + "description": "Gets or sets the location name" + }, + "displayName": { + "type": "string", + "description": "Gets or sets the display name of the location" + }, + "latitude": { + "type": "string", + "description": "Gets or sets the latitude of the location" + }, + "longitude": { + "type": "string", + "description": "Gets or sets the longitude of the location" + } + }, + "description": "Location information." + }, + "LocationListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Location" + }, + "description": "Gets the locations." + } + }, + "description": "Location list operation response." + }, + "Subscription": { + "properties": { + "id": { + "type": "string", + "description": "Gets or sets the ID of the resource (/subscriptions/SubscriptionId)." + }, + "subscriptionId": { + "type": "string", + "description": "Gets or sets the subscription Id." + }, + "displayName": { + "type": "string", + "description": "Gets or sets the subscription display name" + }, + "state": { + "type": "string", + "description": "Gets or sets the subscription state" + }, + "subscriptionPolicies": { + "$ref": "#/definitions/SubscriptionPolicies", + "description": "Gets or sets the subscription policies." + } + }, + "description": "Subscription information." + }, + "SubscriptionPolicies": { + "properties": { + "locationPlacementId": { + "type": "string", + "description": "Gets or sets the subscription location placement Id." + }, + "quotaId": { + "type": "string", + "description": "Gets or sets the subscription quota Id." + } + }, + "description": "Subscription policies." + }, + "SubscriptionListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Subscription" + }, + "description": "Gets or sets subscriptions." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the URL to get the next set of results." + } + }, + "required": [ + "nextLink" + ], + "description": "Subscription list operation response." + }, + "TenantIdDescription": { + "properties": { + "id": { + "type": "string", + "description": "Gets or sets Id" + }, + "tenantId": { + "type": "string", + "description": "Gets or sets tenantId" + } + }, + "description": "Tenant Id information" + }, + "TenantListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/TenantIdDescription" + }, + "description": "Gets or sets tenant Ids." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the URL to get the next set of results." + } + }, + "required": [ + "nextLink" + ], + "description": "Tenant Ids information." + } + }, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + } + } +} diff --git a/arm-scheduler/2014-08-01-preview/swagger/scheduler.json b/arm-scheduler/2014-08-01-preview/swagger/scheduler.json index 3bbd50e72e91..b7e781848d64 100644 --- a/arm-scheduler/2014-08-01-preview/swagger/scheduler.json +++ b/arm-scheduler/2014-08-01-preview/swagger/scheduler.json @@ -1,1624 +1,1624 @@ -{ - "swagger": "2.0", - "info": { - "title": "SchedulerManagementClient", - "version": "2014-08-01-preview" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json", - "text/json" - ], - "produces": [ - "application/json", - "text/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/providers/Microsoft.Scheduler/jobCollections": { - "get": { - "tags": [ - "JobCollections" - ], - "operationId": "JobCollections_ListBySubscription", - "description": "Gets all job collections under specified subscription.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The job collections have been successfully returned.", - "schema": { - "$ref": "#/definitions/JobCollectionListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections": { - "get": { - "tags": [ - "JobCollections" - ], - "operationId": "JobCollections_ListByResourceGroup", - "description": "Gets all job collections under specified resource group.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name." - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The job collections have been successfully returned.", - "schema": { - "$ref": "#/definitions/JobCollectionListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}": { - "get": { - "tags": [ - "JobCollections" - ], - "operationId": "JobCollections_Get", - "description": "Gets a job collection.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name." - }, - { - "name": "jobCollectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The job collection name." - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The job collection has been successfully returned.", - "schema": { - "$ref": "#/definitions/JobCollectionDefinition" - } - } - } - }, - "put": { - "tags": [ - "JobCollections" - ], - "operationId": "JobCollections_CreateOrUpdate", - "description": "Provisions a new job collection or updates an existing job collection.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name." - }, - { - "name": "jobCollectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The job collection name." - }, - { - "$ref": "#/parameters/api-version" - }, - { - "name": "jobCollection", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/JobCollectionDefinition" - }, - "description": "The job collection definition." - } - ], - "responses": { - "200": { - "description": "The job collection has been successfully updated.", - "schema": { - "$ref": "#/definitions/JobCollectionDefinition" - } - }, - "201": { - "description": "The job collection has been successfully created.", - "schema": { - "$ref": "#/definitions/JobCollectionDefinition" - } - } - } - }, - "patch": { - "tags": [ - "JobCollections" - ], - "operationId": "JobCollections_Patch", - "description": "Patches an existing job collection.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name." - }, - { - "name": "jobCollectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The job collection name." - }, - { - "$ref": "#/parameters/api-version" - }, - { - "name": "jobCollection", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/JobCollectionDefinition" - }, - "description": "The job collection definition." - } - ], - "responses": { - "200": { - "description": "The job collection has been successfully patched.", - "schema": { - "$ref": "#/definitions/JobCollectionDefinition" - } - } - } - }, - "delete": { - "tags": [ - "JobCollections" - ], - "operationId": "JobCollections_Delete", - "description": "Deletes a job collection.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name." - }, - { - "name": "jobCollectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The job collection name." - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The job collection has been successfully deleted." - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/enable": { - "post": { - "tags": [ - "JobCollections" - ], - "operationId": "JobCollections_Enable", - "description": "Enables all of the jobs in the job collection.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name." - }, - { - "name": "jobCollectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The job collection name." - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "All of the jobs in the job collection have been successfully enabled." - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/disable": { - "post": { - "tags": [ - "JobCollections" - ], - "operationId": "JobCollections_Disable", - "description": "Disables all of the jobs in the job collection.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name." - }, - { - "name": "jobCollectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The job collection name." - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "All of the jobs in the job collection have been successfully disabled." - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/jobs/{jobName}": { - "get": { - "tags": [ - "Jobs" - ], - "operationId": "Jobs_Get", - "description": "Gets a job.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name." - }, - { - "name": "jobCollectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The job collection name." - }, - { - "name": "jobName", - "in": "path", - "required": true, - "type": "string", - "description": "The job name." - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The job has been successfully returned.", - "schema": { - "$ref": "#/definitions/JobDefinition" - } - } - } - }, - "put": { - "tags": [ - "Jobs" - ], - "operationId": "Jobs_CreateOrUpdate", - "description": "Provisions a new job or updates an existing job.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name." - }, - { - "name": "jobCollectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The job collection name." - }, - { - "name": "jobName", - "in": "path", - "required": true, - "type": "string", - "description": "The job name." - }, - { - "$ref": "#/parameters/api-version" - }, - { - "name": "job", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/JobDefinition" - }, - "description": "The job definition." - } - ], - "responses": { - "200": { - "description": "The job has been successfully updated.", - "schema": { - "$ref": "#/definitions/JobDefinition" - } - }, - "201": { - "description": "The job has been successfully created.", - "schema": { - "$ref": "#/definitions/JobDefinition" - } - } - } - }, - "patch": { - "tags": [ - "Jobs" - ], - "operationId": "Jobs_Patch", - "description": "Patches an existing job.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name." - }, - { - "name": "jobCollectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The job collection name." - }, - { - "name": "jobName", - "in": "path", - "required": true, - "type": "string", - "description": "The job name." - }, - { - "$ref": "#/parameters/api-version" - }, - { - "name": "job", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/JobDefinition" - }, - "description": "The job definition." - } - ], - "responses": { - "200": { - "description": "The job has been successfully patched.", - "schema": { - "$ref": "#/definitions/JobDefinition" - } - } - } - }, - "delete": { - "tags": [ - "Jobs" - ], - "operationId": "Jobs_Delete", - "description": "Deletes a job.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name." - }, - { - "name": "jobCollectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The job collection name." - }, - { - "name": "jobName", - "in": "path", - "required": true, - "type": "string", - "description": "The job name." - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The job has been successfully deleted." - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/jobs/{jobName}/run": { - "post": { - "tags": [ - "Jobs" - ], - "operationId": "Jobs_Run", - "description": "Runs a job.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name." - }, - { - "name": "jobCollectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The job collection name." - }, - { - "name": "jobName", - "in": "path", - "required": true, - "type": "string", - "description": "The job name." - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The job has been successfully run." - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/jobs": { - "get": { - "tags": [ - "Jobs" - ], - "operationId": "Jobs_List", - "description": "Lists all jobs under the specified job collection.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name." - }, - { - "name": "jobCollectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The job collection name." - }, - { - "$ref": "#/parameters/api-version" - }, - { - "name": "$top", - "in": "query", - "required": false, - "type": "integer", - "description": "The number of jobs to request, in the of range [1..100]." - }, - { - "name": "$skip", - "in": "query", - "required": false, - "type": "integer", - "description": "The (0-based) index of the job history list from which to begin requesting entries." - }, - { - "name": "$filter", - "description": "The filter to apply on the job state.", - "in": "query", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The job has been successfully returned.", - "schema": { - "$ref": "#/definitions/JobListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-odata": "#/definitions/JobStateFilter" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/jobs/{jobName}/history": { - "get": { - "tags": [ - "Jobs" - ], - "operationId": "Jobs_ListJobHistory", - "description": "Lists job history.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name." - }, - { - "name": "jobCollectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The job collection name." - }, - { - "name": "jobName", - "in": "path", - "required": true, - "type": "string", - "description": "The job name." - }, - { - "$ref": "#/parameters/api-version" - }, - { - "name": "$top", - "in": "query", - "required": false, - "type": "integer", - "description": "the number of job history to request, in the of range [1..100]." - }, - { - "name": "$skip", - "in": "query", - "required": false, - "type": "integer", - "description": "The (0-based) index of the job history list from which to begin requesting entries." - }, - { - "name": "$filter", - "description": "The filter to apply on the job state.", - "in": "query", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The job histories have been successfully returned.", - "schema": { - "$ref": "#/definitions/JobHistoryListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-odata": "#/definitions/JobHistoryFilter" - } - } - }, - "definitions": { - "JobCollectionListResult": { - "properties": { - "value": { - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/JobCollectionDefinition" - }, - "description": "Gets the job collections." - }, - "nextLink": { - "type": "string", - "description": "Gets or sets the URL to get the next set of job collections." - } - } - }, - "JobListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/JobDefinition" - }, - "description": "Gets or sets all jobs under job collection." - }, - "nextLink": { - "type": "string", - "description": "Gets or sets the URL to get the next set of jobs." - } - } - }, - "JobHistoryListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/JobHistoryDefinition" - }, - "description": "Gets or sets the job histories under job." - }, - "nextLink": { - "type": "string", - "description": "Gets or sets the URL to get the next set of job histories." - } - } - }, - "JobCollectionDefinition": { - "properties": { - "id": { - "type": "string", - "readOnly": true, - "description": "Gets the job collection resource identifier." - }, - "type": { - "type": "string", - "readOnly": true, - "description": "Gets the job collection resource type." - }, - "name": { - "type": "string", - "description": "Gets or sets the job collection resource name." - }, - "location": { - "type": "string", - "description": "Gets or sets the storage account location." - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Gets or sets the tags." - }, - "properties": { - "$ref": "#/definitions/JobCollectionProperties", - "description": "Gets or sets the job collection properties." - } - } - }, - "JobCollectionProperties": { - "properties": { - "sku": { - "$ref": "#/definitions/Sku", - "description": "Gets or sets the SKU." - }, - "state": { - "type": "string", - "description": "Gets or sets the state.", - "enum": [ - "Enabled", - "Disabled", - "Suspended", - "Deleted" - ], - "x-ms-enum": { - "name": "JobCollectionState", - "modelAsString": false - } - }, - "quota": { - "$ref": "#/definitions/JobCollectionQuota", - "description": "Gets or sets the job collection quota." - } - } - }, - "Sku": { - "properties": { - "name": { - "type": "string", - "description": "Gets or set the SKU.", - "enum": [ - "Standard", - "Free", - "Premium" - ], - "x-ms-enum": { - "name": "SkuDefinition", - "modelAsString": false - } - } - } - }, - "JobCollectionQuota": { - "properties": { - "maxJobCount": { - "type": "integer", - "description": "Gets or set the maximum job count." - }, - "maxJobOccurrence": { - "type": "integer", - "description": "Gets or sets the maximum job occurrence." - }, - "maxRecurrence": { - "$ref": "#/definitions/JobMaxRecurrence", - "description": "Gets or set the maximum recurrence." - } - } - }, - "JobDefinition": { - "properties": { - "id": { - "type": "string", - "readOnly": true, - "description": "Gets the job resource identifier." - }, - "type": { - "type": "string", - "readOnly": true, - "description": "Gets the job resource type." - }, - "name": { - "type": "string", - "readOnly": true, - "description": "Gets the job resource name." - }, - "properties": { - "$ref": "#/definitions/JobProperties", - "description": "Gets or sets the job properties." - } - } - }, - "JobProperties": { - "properties": { - "startTime": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the job start time." - }, - "action": { - "$ref": "#/definitions/JobAction", - "description": "Gets or sets the job action." - }, - "recurrence": { - "$ref": "#/definitions/JobRecurrence", - "description": "Gets or sets the job recurrence." - }, - "state": { - "$ref": "#/definitions/JobState", - "description": "Gets or set the job state." - }, - "status": { - "$ref": "#/definitions/JobStatus", - "readOnly": true, - "description": "Gets the job status." - } - } - }, - "JobHistoryDefinition": { - "properties": { - "id": { - "type": "string", - "readOnly": true, - "description": "Gets the job history identifier." - }, - "type": { - "type": "string", - "readOnly": true, - "description": "Gets the job history resource type." - }, - "name": { - "type": "string", - "readOnly": true, - "description": "Gets the job history name." - }, - "properties": { - "$ref": "#/definitions/JobHistoryDefinitionProperties", - "readOnly": true, - "description": "Gets or sets the job history properties." - } - } - }, - "JobHistoryDefinitionProperties": { - "properties": { - "startTime": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "Gets the start time for this job." - }, - "endTime": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "Gets the end time for this job." - }, - "expectedExecutionTime": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "Gets the expected execution time for this job." - }, - "actionName": { - "type": "string", - "readOnly": true, - "description": "Gets the job history action name.", - "enum": [ - "MainAction", - "ErrorAction" - ], - "x-ms-enum": { - "name": "JobHistoryActionName", - "modelAsString": false - } - }, - "status": { - "$ref": "#/definitions/JobExecutionStatus", - "readOnly": true, - "description": "Gets the job history status." - }, - "message": { - "type": "string", - "readOnly": true, - "description": "Gets the message for the job history." - }, - "retryCount": { - "type": "integer", - "readOnly": true, - "description": "Gets the retry count for job." - }, - "repeatCount": { - "type": "integer", - "readOnly": true, - "description": "Gets the repeat count for the job." - } - } - }, - "JobAction": { - "properties": { - "type": { - "type": "string", - "description": "Gets or sets the job action type.", - "enum": [ - "Http", - "Https", - "StorageQueue", - "ServiceBusQueue", - "ServiceBusTopic" - ], - "x-ms-enum": { - "name": "JobActionType", - "modelAsString": false - } - }, - "request": { - "$ref": "#/definitions/HttpRequest", - "description": "Gets or sets the http requests." - }, - "queueMessage": { - "$ref": "#/definitions/StorageQueueMessage", - "description": "Gets or sets the storage queue message." - }, - "serviceBusQueueMessage": { - "$ref": "#/definitions/ServiceBusQueueMessage", - "description": "Gets or sets the service bus queue message." - }, - "serviceBusTopicMessage": { - "$ref": "#/definitions/ServiceBusTopicMessage", - "description": "Gets or sets the service bus topic message." - }, - "retryPolicy": { - "$ref": "#/definitions/RetryPolicy", - "description": "Gets or sets the retry policy." - }, - "errorAction": { - "$ref": "#/definitions/JobErrorAction", - "description": "Gets or sets the error action." - } - } - }, - "JobErrorAction": { - "properties": { - "type": { - "type": "string", - "description": "Gets or sets the job error action type.", - "enum": [ - "Http", - "Https", - "StorageQueue", - "ServiceBusQueue", - "ServiceBusTopic" - ], - "x-ms-enum": { - "name": "JobActionType", - "modelAsString": false - } - }, - "request": { - "$ref": "#/definitions/HttpRequest", - "description": "Gets or sets the http requests." - }, - "queueMessage": { - "$ref": "#/definitions/StorageQueueMessage", - "description": "Gets or sets the storage queue message." - }, - "serviceBusQueueMessage": { - "$ref": "#/definitions/ServiceBusQueueMessage", - "description": "Gets or sets the service bus queue message." - }, - "serviceBusTopicMessage": { - "$ref": "#/definitions/ServiceBusTopicMessage", - "description": "Gets or sets the service bus topic message." - }, - "retryPolicy": { - "$ref": "#/definitions/RetryPolicy", - "description": "Gets or sets the retry policy." - } - } - }, - "HttpRequest": { - "properties": { - "authentication": { - "$ref": "#/definitions/HttpAuthentication", - "description": "Gets or sets the http authentication." - }, - "uri": { - "type": "string", - "description": "Gets or sets the Uri." - }, - "method": { - "type": "string", - "description": "Gets or sets the method of the request." - }, - "body": { - "type": "string", - "description": "Gets or sets the request body." - }, - "headers": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Gets or sets the headers." - } - } - }, - "ClientCertAuthentication": { - "properties": { - "password": { - "type": "string", - "description": "Gets or sets the password." - }, - "pfx": { - "type": "string", - "description": "Gets or sets the pfx." - }, - "certificateThumbprint": { - "type": "string", - "description": "Gets or sets the certificate thumbprint." - }, - "certificateExpirationDate": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the certificate expiration date." - }, - "certificateSubjectName": { - "type": "string", - "description": "Gets or sets the certificate subject name." - } - }, - "allOf": [ - { - "$ref": "#/definitions/HttpAuthentication" - } - ] - }, - "BasicAuthentication": { - "properties": { - "username": { - "type": "string", - "description": "Gets or sets the username." - }, - "password": { - "type": "string", - "description": "Gets or sets the password." - } - }, - "allOf": [ - { - "$ref": "#/definitions/HttpAuthentication" - } - ] - }, - "OAuthAuthentication": { - "properties": { - "secret": { - "type": "string", - "description": "Gets or sets the secret." - }, - "tenant": { - "type": "string", - "description": "Gets or sets the tenant." - }, - "audience": { - "type": "string", - "description": "Gets or sets the audience." - }, - "clientId": { - "type": "string", - "description": "Gets or sets the client identifier." - } - }, - "allOf": [ - { - "$ref": "#/definitions/HttpAuthentication" - } - ] - }, - "HttpAuthentication": { - "properties": { - "type": { - "type": "string", - "description": "Gets or sets the http authentication type.", - "enum": [ - "NotSpecified", - "ClientCertificate", - "ActiveDirectoryOAuth", - "Basic" - ], - "x-ms-enum": { - "name": "HttpAuthenticationType", - "modelAsString": false - } - } - } - }, - "StorageQueueMessage": { - "properties": { - "storageAccount": { - "type": "string", - "description": "Gets or sets the storage account name." - }, - "queueName": { - "type": "string", - "description": "Gets or sets the queue name." - }, - "sasToken": { - "type": "string", - "description": "Gets or sets the SAS key." - }, - "message": { - "type": "string", - "description": "Gets or sets the message." - } - } - }, - "ServiceBusQueueMessage": { - "properties": { - "queueName": { - "type": "string", - "description": "Gets or sets the queue name." - } - }, - "allOf": [ - { - "$ref": "#/definitions/ServiceBusMessage" - } - ] - }, - "ServiceBusTopicMessage": { - "properties": { - "topicPath": { - "type": "string", - "description": "Gets or sets the topic path." - } - }, - "allOf": [ - { - "$ref": "#/definitions/ServiceBusMessage" - } - ] - }, - "ServiceBusMessage": { - "properties": { - "authentication": { - "$ref": "#/definitions/ServiceBusAuthentication", - "description": "Gets or sets the authentication." - }, - "brokeredMessageProperties": { - "$ref": "#/definitions/ServiceBusBrokeredMessageProperties", - "description": "Gets or sets the brokered message properties." - }, - "customMessageProperties": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Gets or sets the custom message properties." - }, - "message": { - "type": "string", - "description": "Gets or sets the message." - }, - "namespace": { - "type": "string", - "description": "Gets or sets the namespace." - }, - "transportType": { - "type": "string", - "description": "Gets or sets the transport type.", - "enum": [ - "NotSpecified", - "NetMessaging", - "AMQP" - ], - "x-ms-enum": { - "name": "ServiceBusTransportType", - "modelAsString": false - } - } - } - }, - "ServiceBusAuthentication": { - "properties": { - "sasKey": { - "type": "string", - "description": "Gets or sets the SAS key." - }, - "sasKeyName": { - "type": "string", - "description": "Gets or sets the SAS key name." - }, - "type": { - "type": "string", - "description": "Gets or sets the authentication type.", - "enum": [ - "NotSpecified", - "SharedAccessKey" - ], - "x-ms-enum": { - "name": "ServiceBusAuthenticationType", - "modelAsString": false - } - } - } - }, - "ServiceBusBrokeredMessageProperties": { - "properties": { - "contentType": { - "type": "string", - "description": "Gets or sets the content type." - }, - "correlationId": { - "type": "string", - "description": "Gets or sets the correlation id." - }, - "forcePersistence": { - "type": "boolean", - "description": "Gets or sets the force persistence." - }, - "label": { - "type": "string", - "description": "Gets or sets the label." - }, - "messageId": { - "type": "string", - "description": "Gets or sets the message id." - }, - "partitionKey": { - "type": "string", - "description": "Gets or sets the partition key." - }, - "replyTo": { - "type": "string", - "description": "Gets or sets the reply to." - }, - "replyToSessionId": { - "type": "string", - "description": "Gets or sets the reply to session id." - }, - "scheduledEnqueueTimeUtc": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the scheduled enqueue time UTC." - }, - "sessionId": { - "type": "string", - "description": "Gets or sets the session id." - }, - "timeToLive": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the time to live." - }, - "to": { - "type": "string", - "description": "Gets or sets the to." - }, - "viaPartitionKey": { - "type": "string", - "description": "Gets or sets the via partition key." - } - } - }, - "RetryPolicy": { - "properties": { - "retryType": { - "type": "string", - "description": "Gets or sets the retry strategy to be used.", - "enum": [ - "None", - "Fixed" - ], - "x-ms-enum": { - "name": "RetryType", - "modelAsString": false - } - }, - "retryInterval": { - "type": "string", - "format": "duration", - "description": "Gets or sets the retry interval between retries." - }, - "retryCount": { - "type": "integer", - "description": "Gets or sets the number of times a retry should be attempted." - } - } - }, - "JobMaxRecurrence": { - "properties": { - "frequency": { - "type": "string", - "description": "Gets or sets the frequency of recurrence (second, minute, hour, day, week, month).", - "enum": [ - "Minute", - "Hour", - "Day", - "Week", - "Month" - ], - "x-ms-enum": { - "name": "RecurrenceFrequency", - "modelAsString": false - } - }, - "interval": { - "type": "integer", - "description": "Gets or sets the interval between retries." - } - } - }, - "JobRecurrence": { - "properties": { - "frequency": { - "type": "string", - "description": "Gets or sets the frequency of recurrence (second, minute, hour, day, week, month).", - "enum": [ - "Minute", - "Hour", - "Day", - "Week", - "Month" - ], - "x-ms-enum": { - "name": "RecurrenceFrequency", - "modelAsString": false - } - }, - "interval": { - "type": "integer", - "description": "Gets or sets the interval between retries." - }, - "count": { - "type": "integer", - "description": "Gets or sets the maximum number of times that the job should run." - }, - "endTime": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the time at which the job will complete." - }, - "schedule": { - "$ref": "#/definitions/JobRecurrenceSchedule" - } - } - }, - "RecurrenceFrequency": { - "type": "string", - "description": "Gets or sets the frequency of recurrence (minute, hour, day, week, month).", - "enum": [ - "Minute", - "Hour", - "Day", - "Week", - "Month" - ], - "x-ms-enum": { - "name": "RecurrenceFrequency", - "modelAsString": false - } - }, - "JobRecurrenceSchedule": { - "properties": { - "weekDays": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "Monday", - "Tuesday", - "Wednesday", - "Thursday", - "Friday", - "Saturday", - "Sunday" - ], - "x-ms-enum": { - "name": "DayOfWeek", - "modelAsString": false - } - }, - "description": "Gets or sets the days of the week that the job should execute on." - }, - "hours": { - "type": "array", - "items": { - "type": "integer" - }, - "description": "Gets or sets the hours of the day that the job should execute at." - }, - "minutes": { - "type": "array", - "items": { - "type": "integer" - }, - "description": "Gets or sets the minutes of the hour that the job should execute at." - }, - "monthDays": { - "type": "array", - "items": { - "type": "integer" - }, - "description": "Gets or sets the days of the month that the job should execute on. Must be between 1 and 31." - }, - "monthlyOccurrences": { - "type": "array", - "items": { - "$ref": "#/definitions/JobRecurrenceScheduleMonthlyOccurrence" - }, - "description": "Gets or sets the occurrences of days within a month." - } - } - }, - "JobRecurrenceScheduleMonthlyOccurrence": { - "properties": { - "day": { - "type": "string", - "description": "Gets or sets the day. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday.", - "enum": [ - "Monday", - "Tuesday", - "Wednesday", - "Thursday", - "Friday", - "Saturday", - "Sunday" - ], - "x-ms-enum": { - "name": "JobScheduleDay", - "modelAsString": false - } - }, - "Occurrence": { - "type": "integer", - "description": "Gets or sets the occurrence. Must be between -5 and 5." - } - } - }, - "JobStateFilter": { - "type": "object", - "properties": { - "state": { - "$ref": "#/definitions/JobState", - "description": "Gets or sets the job state." - } - } - }, - "JobState": { - "type": "string", - "description": "Gets or set the job state.", - "enum": [ - "Enabled", - "Disabled", - "Faulted", - "Completed" - ], - "x-ms-enum": { - "name": "JobState", - "modelAsString": false - } - }, - "JobHistoryFilter": { - "type": "object", - "properties": { - "status": { - "$ref": "#/definitions/JobExecutionStatus", - "description": "Gets or sets the job execution status." - } - } - }, - "JobExecutionStatus": { - "type": "string", - "description": "Gets the job execution status.", - "enum": [ - "Completed", - "Failed", - "Postponed" - ], - "x-ms-enum": { - "name": "JobExecutionStatus", - "modelAsString": false - } - }, - "JobStatus": { - "properties": { - "executionCount": { - "type": "integer", - "readOnly": true, - "description": "Gets the number of times this job has executed." - }, - "failureCount": { - "type": "integer", - "readOnly": true, - "description": "Gets the number of times this job has failed." - }, - "faultedCount": { - "type": "integer", - "readOnly": true, - "description": "Gets the number of faulted occurrences (occurrences that were retried and failed as many times as the retry policy states)." - }, - "lastExecutionTime": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "Gets the time the last occurrence executed in ISO-8601 format. Could be empty if job has not run yet." - }, - "nextExecutionTime": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "Gets the time of the next occurrence in ISO-8601 format. Could be empty if the job is completed." - } - } - } - }, - "parameters": { - "subscriptionId": { - "name": "subscriptionId", - "description": "The subscription id.", - "in": "path", - "required": true, - "type": "string" - }, - "api-version": { - "name": "api-version", - "description": "The API version.", - "in": "query", - "required": true, - "type": "string" - } - } -} +{ + "swagger": "2.0", + "info": { + "title": "SchedulerManagementClient", + "version": "2014-08-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json", + "text/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Scheduler/jobCollections": { + "get": { + "tags": [ + "JobCollections" + ], + "operationId": "JobCollections_ListBySubscription", + "description": "Gets all job collections under specified subscription.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The job collections have been successfully returned.", + "schema": { + "$ref": "#/definitions/JobCollectionListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections": { + "get": { + "tags": [ + "JobCollections" + ], + "operationId": "JobCollections_ListByResourceGroup", + "description": "Gets all job collections under specified resource group.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The job collections have been successfully returned.", + "schema": { + "$ref": "#/definitions/JobCollectionListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}": { + "get": { + "tags": [ + "JobCollections" + ], + "operationId": "JobCollections_Get", + "description": "Gets a job collection.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "name": "jobCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The job collection name." + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The job collection has been successfully returned.", + "schema": { + "$ref": "#/definitions/JobCollectionDefinition" + } + } + } + }, + "put": { + "tags": [ + "JobCollections" + ], + "operationId": "JobCollections_CreateOrUpdate", + "description": "Provisions a new job collection or updates an existing job collection.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "name": "jobCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The job collection name." + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "jobCollection", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/JobCollectionDefinition" + }, + "description": "The job collection definition." + } + ], + "responses": { + "200": { + "description": "The job collection has been successfully updated.", + "schema": { + "$ref": "#/definitions/JobCollectionDefinition" + } + }, + "201": { + "description": "The job collection has been successfully created.", + "schema": { + "$ref": "#/definitions/JobCollectionDefinition" + } + } + } + }, + "patch": { + "tags": [ + "JobCollections" + ], + "operationId": "JobCollections_Patch", + "description": "Patches an existing job collection.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "name": "jobCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The job collection name." + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "jobCollection", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/JobCollectionDefinition" + }, + "description": "The job collection definition." + } + ], + "responses": { + "200": { + "description": "The job collection has been successfully patched.", + "schema": { + "$ref": "#/definitions/JobCollectionDefinition" + } + } + } + }, + "delete": { + "tags": [ + "JobCollections" + ], + "operationId": "JobCollections_Delete", + "description": "Deletes a job collection.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "name": "jobCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The job collection name." + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The job collection has been successfully deleted." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/enable": { + "post": { + "tags": [ + "JobCollections" + ], + "operationId": "JobCollections_Enable", + "description": "Enables all of the jobs in the job collection.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "name": "jobCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The job collection name." + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "All of the jobs in the job collection have been successfully enabled." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/disable": { + "post": { + "tags": [ + "JobCollections" + ], + "operationId": "JobCollections_Disable", + "description": "Disables all of the jobs in the job collection.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "name": "jobCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The job collection name." + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "All of the jobs in the job collection have been successfully disabled." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/jobs/{jobName}": { + "get": { + "tags": [ + "Jobs" + ], + "operationId": "Jobs_Get", + "description": "Gets a job.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "name": "jobCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The job collection name." + }, + { + "name": "jobName", + "in": "path", + "required": true, + "type": "string", + "description": "The job name." + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The job has been successfully returned.", + "schema": { + "$ref": "#/definitions/JobDefinition" + } + } + } + }, + "put": { + "tags": [ + "Jobs" + ], + "operationId": "Jobs_CreateOrUpdate", + "description": "Provisions a new job or updates an existing job.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "name": "jobCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The job collection name." + }, + { + "name": "jobName", + "in": "path", + "required": true, + "type": "string", + "description": "The job name." + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "job", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/JobDefinition" + }, + "description": "The job definition." + } + ], + "responses": { + "200": { + "description": "The job has been successfully updated.", + "schema": { + "$ref": "#/definitions/JobDefinition" + } + }, + "201": { + "description": "The job has been successfully created.", + "schema": { + "$ref": "#/definitions/JobDefinition" + } + } + } + }, + "patch": { + "tags": [ + "Jobs" + ], + "operationId": "Jobs_Patch", + "description": "Patches an existing job.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "name": "jobCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The job collection name." + }, + { + "name": "jobName", + "in": "path", + "required": true, + "type": "string", + "description": "The job name." + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "job", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/JobDefinition" + }, + "description": "The job definition." + } + ], + "responses": { + "200": { + "description": "The job has been successfully patched.", + "schema": { + "$ref": "#/definitions/JobDefinition" + } + } + } + }, + "delete": { + "tags": [ + "Jobs" + ], + "operationId": "Jobs_Delete", + "description": "Deletes a job.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "name": "jobCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The job collection name." + }, + { + "name": "jobName", + "in": "path", + "required": true, + "type": "string", + "description": "The job name." + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The job has been successfully deleted." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/jobs/{jobName}/run": { + "post": { + "tags": [ + "Jobs" + ], + "operationId": "Jobs_Run", + "description": "Runs a job.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "name": "jobCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The job collection name." + }, + { + "name": "jobName", + "in": "path", + "required": true, + "type": "string", + "description": "The job name." + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The job has been successfully run." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/jobs": { + "get": { + "tags": [ + "Jobs" + ], + "operationId": "Jobs_List", + "description": "Lists all jobs under the specified job collection.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "name": "jobCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The job collection name." + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "description": "The number of jobs to request, in the of range [1..100]." + }, + { + "name": "$skip", + "in": "query", + "required": false, + "type": "integer", + "description": "The (0-based) index of the job history list from which to begin requesting entries." + }, + { + "name": "$filter", + "description": "The filter to apply on the job state.", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The job has been successfully returned.", + "schema": { + "$ref": "#/definitions/JobListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/JobStateFilter" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/jobs/{jobName}/history": { + "get": { + "tags": [ + "Jobs" + ], + "operationId": "Jobs_ListJobHistory", + "description": "Lists job history.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "name": "jobCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The job collection name." + }, + { + "name": "jobName", + "in": "path", + "required": true, + "type": "string", + "description": "The job name." + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "description": "the number of job history to request, in the of range [1..100]." + }, + { + "name": "$skip", + "in": "query", + "required": false, + "type": "integer", + "description": "The (0-based) index of the job history list from which to begin requesting entries." + }, + { + "name": "$filter", + "description": "The filter to apply on the job state.", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The job histories have been successfully returned.", + "schema": { + "$ref": "#/definitions/JobHistoryListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/JobHistoryFilter" + } + } + }, + "definitions": { + "JobCollectionListResult": { + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/JobCollectionDefinition" + }, + "description": "Gets the job collections." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the URL to get the next set of job collections." + } + } + }, + "JobListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/JobDefinition" + }, + "description": "Gets or sets all jobs under job collection." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the URL to get the next set of jobs." + } + } + }, + "JobHistoryListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/JobHistoryDefinition" + }, + "description": "Gets or sets the job histories under job." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the URL to get the next set of job histories." + } + } + }, + "JobCollectionDefinition": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Gets the job collection resource identifier." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Gets the job collection resource type." + }, + "name": { + "type": "string", + "description": "Gets or sets the job collection resource name." + }, + "location": { + "type": "string", + "description": "Gets or sets the storage account location." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Gets or sets the tags." + }, + "properties": { + "$ref": "#/definitions/JobCollectionProperties", + "description": "Gets or sets the job collection properties." + } + } + }, + "JobCollectionProperties": { + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "Gets or sets the SKU." + }, + "state": { + "type": "string", + "description": "Gets or sets the state.", + "enum": [ + "Enabled", + "Disabled", + "Suspended", + "Deleted" + ], + "x-ms-enum": { + "name": "JobCollectionState", + "modelAsString": false + } + }, + "quota": { + "$ref": "#/definitions/JobCollectionQuota", + "description": "Gets or sets the job collection quota." + } + } + }, + "Sku": { + "properties": { + "name": { + "type": "string", + "description": "Gets or set the SKU.", + "enum": [ + "Standard", + "Free", + "Premium" + ], + "x-ms-enum": { + "name": "SkuDefinition", + "modelAsString": false + } + } + } + }, + "JobCollectionQuota": { + "properties": { + "maxJobCount": { + "type": "integer", + "description": "Gets or set the maximum job count." + }, + "maxJobOccurrence": { + "type": "integer", + "description": "Gets or sets the maximum job occurrence." + }, + "maxRecurrence": { + "$ref": "#/definitions/JobMaxRecurrence", + "description": "Gets or set the maximum recurrence." + } + } + }, + "JobDefinition": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Gets the job resource identifier." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Gets the job resource type." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Gets the job resource name." + }, + "properties": { + "$ref": "#/definitions/JobProperties", + "description": "Gets or sets the job properties." + } + } + }, + "JobProperties": { + "properties": { + "startTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the job start time." + }, + "action": { + "$ref": "#/definitions/JobAction", + "description": "Gets or sets the job action." + }, + "recurrence": { + "$ref": "#/definitions/JobRecurrence", + "description": "Gets or sets the job recurrence." + }, + "state": { + "$ref": "#/definitions/JobState", + "description": "Gets or set the job state." + }, + "status": { + "$ref": "#/definitions/JobStatus", + "readOnly": true, + "description": "Gets the job status." + } + } + }, + "JobHistoryDefinition": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Gets the job history identifier." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Gets the job history resource type." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Gets the job history name." + }, + "properties": { + "$ref": "#/definitions/JobHistoryDefinitionProperties", + "readOnly": true, + "description": "Gets or sets the job history properties." + } + } + }, + "JobHistoryDefinitionProperties": { + "properties": { + "startTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Gets the start time for this job." + }, + "endTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Gets the end time for this job." + }, + "expectedExecutionTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Gets the expected execution time for this job." + }, + "actionName": { + "type": "string", + "readOnly": true, + "description": "Gets the job history action name.", + "enum": [ + "MainAction", + "ErrorAction" + ], + "x-ms-enum": { + "name": "JobHistoryActionName", + "modelAsString": false + } + }, + "status": { + "$ref": "#/definitions/JobExecutionStatus", + "readOnly": true, + "description": "Gets the job history status." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "Gets the message for the job history." + }, + "retryCount": { + "type": "integer", + "readOnly": true, + "description": "Gets the retry count for job." + }, + "repeatCount": { + "type": "integer", + "readOnly": true, + "description": "Gets the repeat count for the job." + } + } + }, + "JobAction": { + "properties": { + "type": { + "type": "string", + "description": "Gets or sets the job action type.", + "enum": [ + "Http", + "Https", + "StorageQueue", + "ServiceBusQueue", + "ServiceBusTopic" + ], + "x-ms-enum": { + "name": "JobActionType", + "modelAsString": false + } + }, + "request": { + "$ref": "#/definitions/HttpRequest", + "description": "Gets or sets the http requests." + }, + "queueMessage": { + "$ref": "#/definitions/StorageQueueMessage", + "description": "Gets or sets the storage queue message." + }, + "serviceBusQueueMessage": { + "$ref": "#/definitions/ServiceBusQueueMessage", + "description": "Gets or sets the service bus queue message." + }, + "serviceBusTopicMessage": { + "$ref": "#/definitions/ServiceBusTopicMessage", + "description": "Gets or sets the service bus topic message." + }, + "retryPolicy": { + "$ref": "#/definitions/RetryPolicy", + "description": "Gets or sets the retry policy." + }, + "errorAction": { + "$ref": "#/definitions/JobErrorAction", + "description": "Gets or sets the error action." + } + } + }, + "JobErrorAction": { + "properties": { + "type": { + "type": "string", + "description": "Gets or sets the job error action type.", + "enum": [ + "Http", + "Https", + "StorageQueue", + "ServiceBusQueue", + "ServiceBusTopic" + ], + "x-ms-enum": { + "name": "JobActionType", + "modelAsString": false + } + }, + "request": { + "$ref": "#/definitions/HttpRequest", + "description": "Gets or sets the http requests." + }, + "queueMessage": { + "$ref": "#/definitions/StorageQueueMessage", + "description": "Gets or sets the storage queue message." + }, + "serviceBusQueueMessage": { + "$ref": "#/definitions/ServiceBusQueueMessage", + "description": "Gets or sets the service bus queue message." + }, + "serviceBusTopicMessage": { + "$ref": "#/definitions/ServiceBusTopicMessage", + "description": "Gets or sets the service bus topic message." + }, + "retryPolicy": { + "$ref": "#/definitions/RetryPolicy", + "description": "Gets or sets the retry policy." + } + } + }, + "HttpRequest": { + "properties": { + "authentication": { + "$ref": "#/definitions/HttpAuthentication", + "description": "Gets or sets the http authentication." + }, + "uri": { + "type": "string", + "description": "Gets or sets the Uri." + }, + "method": { + "type": "string", + "description": "Gets or sets the method of the request." + }, + "body": { + "type": "string", + "description": "Gets or sets the request body." + }, + "headers": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Gets or sets the headers." + } + } + }, + "ClientCertAuthentication": { + "properties": { + "password": { + "type": "string", + "description": "Gets or sets the password." + }, + "pfx": { + "type": "string", + "description": "Gets or sets the pfx." + }, + "certificateThumbprint": { + "type": "string", + "description": "Gets or sets the certificate thumbprint." + }, + "certificateExpirationDate": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the certificate expiration date." + }, + "certificateSubjectName": { + "type": "string", + "description": "Gets or sets the certificate subject name." + } + }, + "allOf": [ + { + "$ref": "#/definitions/HttpAuthentication" + } + ] + }, + "BasicAuthentication": { + "properties": { + "username": { + "type": "string", + "description": "Gets or sets the username." + }, + "password": { + "type": "string", + "description": "Gets or sets the password." + } + }, + "allOf": [ + { + "$ref": "#/definitions/HttpAuthentication" + } + ] + }, + "OAuthAuthentication": { + "properties": { + "secret": { + "type": "string", + "description": "Gets or sets the secret." + }, + "tenant": { + "type": "string", + "description": "Gets or sets the tenant." + }, + "audience": { + "type": "string", + "description": "Gets or sets the audience." + }, + "clientId": { + "type": "string", + "description": "Gets or sets the client identifier." + } + }, + "allOf": [ + { + "$ref": "#/definitions/HttpAuthentication" + } + ] + }, + "HttpAuthentication": { + "properties": { + "type": { + "type": "string", + "description": "Gets or sets the http authentication type.", + "enum": [ + "NotSpecified", + "ClientCertificate", + "ActiveDirectoryOAuth", + "Basic" + ], + "x-ms-enum": { + "name": "HttpAuthenticationType", + "modelAsString": false + } + } + } + }, + "StorageQueueMessage": { + "properties": { + "storageAccount": { + "type": "string", + "description": "Gets or sets the storage account name." + }, + "queueName": { + "type": "string", + "description": "Gets or sets the queue name." + }, + "sasToken": { + "type": "string", + "description": "Gets or sets the SAS key." + }, + "message": { + "type": "string", + "description": "Gets or sets the message." + } + } + }, + "ServiceBusQueueMessage": { + "properties": { + "queueName": { + "type": "string", + "description": "Gets or sets the queue name." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ServiceBusMessage" + } + ] + }, + "ServiceBusTopicMessage": { + "properties": { + "topicPath": { + "type": "string", + "description": "Gets or sets the topic path." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ServiceBusMessage" + } + ] + }, + "ServiceBusMessage": { + "properties": { + "authentication": { + "$ref": "#/definitions/ServiceBusAuthentication", + "description": "Gets or sets the authentication." + }, + "brokeredMessageProperties": { + "$ref": "#/definitions/ServiceBusBrokeredMessageProperties", + "description": "Gets or sets the brokered message properties." + }, + "customMessageProperties": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Gets or sets the custom message properties." + }, + "message": { + "type": "string", + "description": "Gets or sets the message." + }, + "namespace": { + "type": "string", + "description": "Gets or sets the namespace." + }, + "transportType": { + "type": "string", + "description": "Gets or sets the transport type.", + "enum": [ + "NotSpecified", + "NetMessaging", + "AMQP" + ], + "x-ms-enum": { + "name": "ServiceBusTransportType", + "modelAsString": false + } + } + } + }, + "ServiceBusAuthentication": { + "properties": { + "sasKey": { + "type": "string", + "description": "Gets or sets the SAS key." + }, + "sasKeyName": { + "type": "string", + "description": "Gets or sets the SAS key name." + }, + "type": { + "type": "string", + "description": "Gets or sets the authentication type.", + "enum": [ + "NotSpecified", + "SharedAccessKey" + ], + "x-ms-enum": { + "name": "ServiceBusAuthenticationType", + "modelAsString": false + } + } + } + }, + "ServiceBusBrokeredMessageProperties": { + "properties": { + "contentType": { + "type": "string", + "description": "Gets or sets the content type." + }, + "correlationId": { + "type": "string", + "description": "Gets or sets the correlation id." + }, + "forcePersistence": { + "type": "boolean", + "description": "Gets or sets the force persistence." + }, + "label": { + "type": "string", + "description": "Gets or sets the label." + }, + "messageId": { + "type": "string", + "description": "Gets or sets the message id." + }, + "partitionKey": { + "type": "string", + "description": "Gets or sets the partition key." + }, + "replyTo": { + "type": "string", + "description": "Gets or sets the reply to." + }, + "replyToSessionId": { + "type": "string", + "description": "Gets or sets the reply to session id." + }, + "scheduledEnqueueTimeUtc": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the scheduled enqueue time UTC." + }, + "sessionId": { + "type": "string", + "description": "Gets or sets the session id." + }, + "timeToLive": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the time to live." + }, + "to": { + "type": "string", + "description": "Gets or sets the to." + }, + "viaPartitionKey": { + "type": "string", + "description": "Gets or sets the via partition key." + } + } + }, + "RetryPolicy": { + "properties": { + "retryType": { + "type": "string", + "description": "Gets or sets the retry strategy to be used.", + "enum": [ + "None", + "Fixed" + ], + "x-ms-enum": { + "name": "RetryType", + "modelAsString": false + } + }, + "retryInterval": { + "type": "string", + "format": "duration", + "description": "Gets or sets the retry interval between retries." + }, + "retryCount": { + "type": "integer", + "description": "Gets or sets the number of times a retry should be attempted." + } + } + }, + "JobMaxRecurrence": { + "properties": { + "frequency": { + "type": "string", + "description": "Gets or sets the frequency of recurrence (second, minute, hour, day, week, month).", + "enum": [ + "Minute", + "Hour", + "Day", + "Week", + "Month" + ], + "x-ms-enum": { + "name": "RecurrenceFrequency", + "modelAsString": false + } + }, + "interval": { + "type": "integer", + "description": "Gets or sets the interval between retries." + } + } + }, + "JobRecurrence": { + "properties": { + "frequency": { + "type": "string", + "description": "Gets or sets the frequency of recurrence (second, minute, hour, day, week, month).", + "enum": [ + "Minute", + "Hour", + "Day", + "Week", + "Month" + ], + "x-ms-enum": { + "name": "RecurrenceFrequency", + "modelAsString": false + } + }, + "interval": { + "type": "integer", + "description": "Gets or sets the interval between retries." + }, + "count": { + "type": "integer", + "description": "Gets or sets the maximum number of times that the job should run." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the time at which the job will complete." + }, + "schedule": { + "$ref": "#/definitions/JobRecurrenceSchedule" + } + } + }, + "RecurrenceFrequency": { + "type": "string", + "description": "Gets or sets the frequency of recurrence (minute, hour, day, week, month).", + "enum": [ + "Minute", + "Hour", + "Day", + "Week", + "Month" + ], + "x-ms-enum": { + "name": "RecurrenceFrequency", + "modelAsString": false + } + }, + "JobRecurrenceSchedule": { + "properties": { + "weekDays": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ], + "x-ms-enum": { + "name": "DayOfWeek", + "modelAsString": false + } + }, + "description": "Gets or sets the days of the week that the job should execute on." + }, + "hours": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "Gets or sets the hours of the day that the job should execute at." + }, + "minutes": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "Gets or sets the minutes of the hour that the job should execute at." + }, + "monthDays": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "Gets or sets the days of the month that the job should execute on. Must be between 1 and 31." + }, + "monthlyOccurrences": { + "type": "array", + "items": { + "$ref": "#/definitions/JobRecurrenceScheduleMonthlyOccurrence" + }, + "description": "Gets or sets the occurrences of days within a month." + } + } + }, + "JobRecurrenceScheduleMonthlyOccurrence": { + "properties": { + "day": { + "type": "string", + "description": "Gets or sets the day. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday.", + "enum": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ], + "x-ms-enum": { + "name": "JobScheduleDay", + "modelAsString": false + } + }, + "Occurrence": { + "type": "integer", + "description": "Gets or sets the occurrence. Must be between -5 and 5." + } + } + }, + "JobStateFilter": { + "type": "object", + "properties": { + "state": { + "$ref": "#/definitions/JobState", + "description": "Gets or sets the job state." + } + } + }, + "JobState": { + "type": "string", + "description": "Gets or set the job state.", + "enum": [ + "Enabled", + "Disabled", + "Faulted", + "Completed" + ], + "x-ms-enum": { + "name": "JobState", + "modelAsString": false + } + }, + "JobHistoryFilter": { + "type": "object", + "properties": { + "status": { + "$ref": "#/definitions/JobExecutionStatus", + "description": "Gets or sets the job execution status." + } + } + }, + "JobExecutionStatus": { + "type": "string", + "description": "Gets the job execution status.", + "enum": [ + "Completed", + "Failed", + "Postponed" + ], + "x-ms-enum": { + "name": "JobExecutionStatus", + "modelAsString": false + } + }, + "JobStatus": { + "properties": { + "executionCount": { + "type": "integer", + "readOnly": true, + "description": "Gets the number of times this job has executed." + }, + "failureCount": { + "type": "integer", + "readOnly": true, + "description": "Gets the number of times this job has failed." + }, + "faultedCount": { + "type": "integer", + "readOnly": true, + "description": "Gets the number of faulted occurrences (occurrences that were retried and failed as many times as the retry policy states)." + }, + "lastExecutionTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Gets the time the last occurrence executed in ISO-8601 format. Could be empty if job has not run yet." + }, + "nextExecutionTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Gets the time of the next occurrence in ISO-8601 format. Could be empty if the job is completed." + } + } + } + }, + "parameters": { + "subscriptionId": { + "name": "subscriptionId", + "description": "The subscription id.", + "in": "path", + "required": true, + "type": "string" + }, + "api-version": { + "name": "api-version", + "description": "The API version.", + "in": "query", + "required": true, + "type": "string" + } + } +} diff --git a/arm-scheduler/2016-01-01/swagger/scheduler.json b/arm-scheduler/2016-01-01/swagger/scheduler.json index 17527fd7839e..7f82baf283a3 100644 --- a/arm-scheduler/2016-01-01/swagger/scheduler.json +++ b/arm-scheduler/2016-01-01/swagger/scheduler.json @@ -1,1624 +1,1624 @@ -{ - "swagger": "2.0", - "info": { - "title": "SchedulerManagementClient", - "version": "2016-01-01" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json", - "text/json" - ], - "produces": [ - "application/json", - "text/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/providers/Microsoft.Scheduler/jobCollections": { - "get": { - "tags": [ - "JobCollections" - ], - "operationId": "JobCollections_ListBySubscription", - "description": "Gets all job collections under specified subscription.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The job collections have been successfully returned.", - "schema": { - "$ref": "#/definitions/JobCollectionListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections": { - "get": { - "tags": [ - "JobCollections" - ], - "operationId": "JobCollections_ListByResourceGroup", - "description": "Gets all job collections under specified resource group.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name." - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The job collections have been successfully returned.", - "schema": { - "$ref": "#/definitions/JobCollectionListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}": { - "get": { - "tags": [ - "JobCollections" - ], - "operationId": "JobCollections_Get", - "description": "Gets a job collection.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name." - }, - { - "name": "jobCollectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The job collection name." - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The job collection has been successfully returned.", - "schema": { - "$ref": "#/definitions/JobCollectionDefinition" - } - } - } - }, - "put": { - "tags": [ - "JobCollections" - ], - "operationId": "JobCollections_CreateOrUpdate", - "description": "Provisions a new job collection or updates an existing job collection.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name." - }, - { - "name": "jobCollectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The job collection name." - }, - { - "$ref": "#/parameters/api-version" - }, - { - "name": "jobCollection", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/JobCollectionDefinition" - }, - "description": "The job collection definition." - } - ], - "responses": { - "200": { - "description": "The job collection has been successfully updated.", - "schema": { - "$ref": "#/definitions/JobCollectionDefinition" - } - }, - "201": { - "description": "The job collection has been successfully created.", - "schema": { - "$ref": "#/definitions/JobCollectionDefinition" - } - } - } - }, - "patch": { - "tags": [ - "JobCollections" - ], - "operationId": "JobCollections_Patch", - "description": "Patches an existing job collection.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name." - }, - { - "name": "jobCollectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The job collection name." - }, - { - "$ref": "#/parameters/api-version" - }, - { - "name": "jobCollection", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/JobCollectionDefinition" - }, - "description": "The job collection definition." - } - ], - "responses": { - "200": { - "description": "The job collection has been successfully patched.", - "schema": { - "$ref": "#/definitions/JobCollectionDefinition" - } - } - } - }, - "delete": { - "tags": [ - "JobCollections" - ], - "operationId": "JobCollections_Delete", - "description": "Deletes a job collection.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name." - }, - { - "name": "jobCollectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The job collection name." - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The job collection has been successfully deleted." - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/enable": { - "post": { - "tags": [ - "JobCollections" - ], - "operationId": "JobCollections_Enable", - "description": "Enables all of the jobs in the job collection.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name." - }, - { - "name": "jobCollectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The job collection name." - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "All of the jobs in the job collection have been successfully enabled." - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/disable": { - "post": { - "tags": [ - "JobCollections" - ], - "operationId": "JobCollections_Disable", - "description": "Disables all of the jobs in the job collection.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name." - }, - { - "name": "jobCollectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The job collection name." - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "All of the jobs in the job collection have been successfully disabled." - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/jobs/{jobName}": { - "get": { - "tags": [ - "Jobs" - ], - "operationId": "Jobs_Get", - "description": "Gets a job.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name." - }, - { - "name": "jobCollectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The job collection name." - }, - { - "name": "jobName", - "in": "path", - "required": true, - "type": "string", - "description": "The job name." - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The job has been successfully returned.", - "schema": { - "$ref": "#/definitions/JobDefinition" - } - } - } - }, - "put": { - "tags": [ - "Jobs" - ], - "operationId": "Jobs_CreateOrUpdate", - "description": "Provisions a new job or updates an existing job.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name." - }, - { - "name": "jobCollectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The job collection name." - }, - { - "name": "jobName", - "in": "path", - "required": true, - "type": "string", - "description": "The job name." - }, - { - "$ref": "#/parameters/api-version" - }, - { - "name": "job", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/JobDefinition" - }, - "description": "The job definition." - } - ], - "responses": { - "200": { - "description": "The job has been successfully updated.", - "schema": { - "$ref": "#/definitions/JobDefinition" - } - }, - "201": { - "description": "The job has been successfully created.", - "schema": { - "$ref": "#/definitions/JobDefinition" - } - } - } - }, - "patch": { - "tags": [ - "Jobs" - ], - "operationId": "Jobs_Patch", - "description": "Patches an existing job.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name." - }, - { - "name": "jobCollectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The job collection name." - }, - { - "name": "jobName", - "in": "path", - "required": true, - "type": "string", - "description": "The job name." - }, - { - "$ref": "#/parameters/api-version" - }, - { - "name": "job", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/JobDefinition" - }, - "description": "The job definition." - } - ], - "responses": { - "200": { - "description": "The job has been successfully patched.", - "schema": { - "$ref": "#/definitions/JobDefinition" - } - } - } - }, - "delete": { - "tags": [ - "Jobs" - ], - "operationId": "Jobs_Delete", - "description": "Deletes a job.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name." - }, - { - "name": "jobCollectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The job collection name." - }, - { - "name": "jobName", - "in": "path", - "required": true, - "type": "string", - "description": "The job name." - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The job has been successfully deleted." - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/jobs/{jobName}/run": { - "post": { - "tags": [ - "Jobs" - ], - "operationId": "Jobs_Run", - "description": "Runs a job.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name." - }, - { - "name": "jobCollectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The job collection name." - }, - { - "name": "jobName", - "in": "path", - "required": true, - "type": "string", - "description": "The job name." - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The job has been successfully run." - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/jobs": { - "get": { - "tags": [ - "Jobs" - ], - "operationId": "Jobs_List", - "description": "Lists all jobs under the specified job collection.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name." - }, - { - "name": "jobCollectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The job collection name." - }, - { - "$ref": "#/parameters/api-version" - }, - { - "name": "$top", - "in": "query", - "required": false, - "type": "integer", - "description": "The number of jobs to request, in the of range [1..100]." - }, - { - "name": "$skip", - "in": "query", - "required": false, - "type": "integer", - "description": "The (0-based) index of the job history list from which to begin requesting entries." - }, - { - "name": "$filter", - "description": "The filter to apply on the job state.", - "in": "query", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The job has been successfully returned.", - "schema": { - "$ref": "#/definitions/JobListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-odata": "#/definitions/JobStateFilter" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/jobs/{jobName}/history": { - "get": { - "tags": [ - "Jobs" - ], - "operationId": "Jobs_ListJobHistory", - "description": "Lists job history.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name." - }, - { - "name": "jobCollectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The job collection name." - }, - { - "name": "jobName", - "in": "path", - "required": true, - "type": "string", - "description": "The job name." - }, - { - "$ref": "#/parameters/api-version" - }, - { - "name": "$top", - "in": "query", - "required": false, - "type": "integer", - "description": "the number of job history to request, in the of range [1..100]." - }, - { - "name": "$skip", - "in": "query", - "required": false, - "type": "integer", - "description": "The (0-based) index of the job history list from which to begin requesting entries." - }, - { - "name": "$filter", - "description": "The filter to apply on the job state.", - "in": "query", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The job histories have been successfully returned.", - "schema": { - "$ref": "#/definitions/JobHistoryListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-odata": "#/definitions/JobHistoryFilter" - } - } - }, - "definitions": { - "JobCollectionListResult": { - "properties": { - "value": { - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/JobCollectionDefinition" - }, - "description": "Gets the job collections." - }, - "nextLink": { - "type": "string", - "description": "Gets or sets the URL to get the next set of job collections." - } - } - }, - "JobListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/JobDefinition" - }, - "description": "Gets or sets all jobs under job collection." - }, - "nextLink": { - "type": "string", - "description": "Gets or sets the URL to get the next set of jobs." - } - } - }, - "JobHistoryListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/JobHistoryDefinition" - }, - "description": "Gets or sets the job histories under job." - }, - "nextLink": { - "type": "string", - "description": "Gets or sets the URL to get the next set of job histories." - } - } - }, - "JobCollectionDefinition": { - "properties": { - "id": { - "type": "string", - "readOnly": true, - "description": "Gets the job collection resource identifier." - }, - "type": { - "type": "string", - "readOnly": true, - "description": "Gets the job collection resource type." - }, - "name": { - "type": "string", - "description": "Gets or sets the job collection resource name." - }, - "location": { - "type": "string", - "description": "Gets or sets the storage account location." - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Gets or sets the tags." - }, - "properties": { - "$ref": "#/definitions/JobCollectionProperties", - "description": "Gets or sets the job collection properties." - } - } - }, - "JobCollectionProperties": { - "properties": { - "sku": { - "$ref": "#/definitions/Sku", - "description": "Gets or sets the SKU." - }, - "state": { - "type": "string", - "description": "Gets or sets the state.", - "enum": [ - "Enabled", - "Disabled", - "Suspended", - "Deleted" - ], - "x-ms-enum": { - "name": "JobCollectionState", - "modelAsString": false - } - }, - "quota": { - "$ref": "#/definitions/JobCollectionQuota", - "description": "Gets or sets the job collection quota." - } - } - }, - "Sku": { - "properties": { - "name": { - "type": "string", - "description": "Gets or set the SKU.", - "enum": [ - "Standard", - "Free", - "Premium" - ], - "x-ms-enum": { - "name": "SkuDefinition", - "modelAsString": false - } - } - } - }, - "JobCollectionQuota": { - "properties": { - "maxJobCount": { - "type": "integer", - "description": "Gets or set the maximum job count." - }, - "maxJobOccurrence": { - "type": "integer", - "description": "Gets or sets the maximum job occurrence." - }, - "maxRecurrence": { - "$ref": "#/definitions/JobMaxRecurrence", - "description": "Gets or set the maximum recurrence." - } - } - }, - "JobDefinition": { - "properties": { - "id": { - "type": "string", - "readOnly": true, - "description": "Gets the job resource identifier." - }, - "type": { - "type": "string", - "readOnly": true, - "description": "Gets the job resource type." - }, - "name": { - "type": "string", - "readOnly": true, - "description": "Gets the job resource name." - }, - "properties": { - "$ref": "#/definitions/JobProperties", - "description": "Gets or sets the job properties." - } - } - }, - "JobProperties": { - "properties": { - "startTime": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the job start time." - }, - "action": { - "$ref": "#/definitions/JobAction", - "description": "Gets or sets the job action." - }, - "recurrence": { - "$ref": "#/definitions/JobRecurrence", - "description": "Gets or sets the job recurrence." - }, - "state": { - "$ref": "#/definitions/JobState", - "description": "Gets or set the job state." - }, - "status": { - "$ref": "#/definitions/JobStatus", - "readOnly": true, - "description": "Gets the job status." - } - } - }, - "JobHistoryDefinition": { - "properties": { - "id": { - "type": "string", - "readOnly": true, - "description": "Gets the job history identifier." - }, - "type": { - "type": "string", - "readOnly": true, - "description": "Gets the job history resource type." - }, - "name": { - "type": "string", - "readOnly": true, - "description": "Gets the job history name." - }, - "properties": { - "$ref": "#/definitions/JobHistoryDefinitionProperties", - "readOnly": true, - "description": "Gets or sets the job history properties." - } - } - }, - "JobHistoryDefinitionProperties": { - "properties": { - "startTime": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "Gets the start time for this job." - }, - "endTime": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "Gets the end time for this job." - }, - "expectedExecutionTime": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "Gets the expected execution time for this job." - }, - "actionName": { - "type": "string", - "readOnly": true, - "description": "Gets the job history action name.", - "enum": [ - "MainAction", - "ErrorAction" - ], - "x-ms-enum": { - "name": "JobHistoryActionName", - "modelAsString": false - } - }, - "status": { - "$ref": "#/definitions/JobExecutionStatus", - "readOnly": true, - "description": "Gets the job history status." - }, - "message": { - "type": "string", - "readOnly": true, - "description": "Gets the message for the job history." - }, - "retryCount": { - "type": "integer", - "readOnly": true, - "description": "Gets the retry count for job." - }, - "repeatCount": { - "type": "integer", - "readOnly": true, - "description": "Gets the repeat count for the job." - } - } - }, - "JobAction": { - "properties": { - "type": { - "type": "string", - "description": "Gets or sets the job action type.", - "enum": [ - "Http", - "Https", - "StorageQueue", - "ServiceBusQueue", - "ServiceBusTopic" - ], - "x-ms-enum": { - "name": "JobActionType", - "modelAsString": false - } - }, - "request": { - "$ref": "#/definitions/HttpRequest", - "description": "Gets or sets the http requests." - }, - "queueMessage": { - "$ref": "#/definitions/StorageQueueMessage", - "description": "Gets or sets the storage queue message." - }, - "serviceBusQueueMessage": { - "$ref": "#/definitions/ServiceBusQueueMessage", - "description": "Gets or sets the service bus queue message." - }, - "serviceBusTopicMessage": { - "$ref": "#/definitions/ServiceBusTopicMessage", - "description": "Gets or sets the service bus topic message." - }, - "retryPolicy": { - "$ref": "#/definitions/RetryPolicy", - "description": "Gets or sets the retry policy." - }, - "errorAction": { - "$ref": "#/definitions/JobErrorAction", - "description": "Gets or sets the error action." - } - } - }, - "JobErrorAction": { - "properties": { - "type": { - "type": "string", - "description": "Gets or sets the job error action type.", - "enum": [ - "Http", - "Https", - "StorageQueue", - "ServiceBusQueue", - "ServiceBusTopic" - ], - "x-ms-enum": { - "name": "JobActionType", - "modelAsString": false - } - }, - "request": { - "$ref": "#/definitions/HttpRequest", - "description": "Gets or sets the http requests." - }, - "queueMessage": { - "$ref": "#/definitions/StorageQueueMessage", - "description": "Gets or sets the storage queue message." - }, - "serviceBusQueueMessage": { - "$ref": "#/definitions/ServiceBusQueueMessage", - "description": "Gets or sets the service bus queue message." - }, - "serviceBusTopicMessage": { - "$ref": "#/definitions/ServiceBusTopicMessage", - "description": "Gets or sets the service bus topic message." - }, - "retryPolicy": { - "$ref": "#/definitions/RetryPolicy", - "description": "Gets or sets the retry policy." - } - } - }, - "HttpRequest": { - "properties": { - "authentication": { - "$ref": "#/definitions/HttpAuthentication", - "description": "Gets or sets the http authentication." - }, - "uri": { - "type": "string", - "description": "Gets or sets the Uri." - }, - "method": { - "type": "string", - "description": "Gets or sets the method of the request." - }, - "body": { - "type": "string", - "description": "Gets or sets the request body." - }, - "headers": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Gets or sets the headers." - } - } - }, - "ClientCertAuthentication": { - "properties": { - "password": { - "type": "string", - "description": "Gets or sets the password." - }, - "pfx": { - "type": "string", - "description": "Gets or sets the pfx." - }, - "certificateThumbprint": { - "type": "string", - "description": "Gets or sets the certificate thumbprint." - }, - "certificateExpirationDate": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the certificate expiration date." - }, - "certificateSubjectName": { - "type": "string", - "description": "Gets or sets the certificate subject name." - } - }, - "allOf": [ - { - "$ref": "#/definitions/HttpAuthentication" - } - ] - }, - "BasicAuthentication": { - "properties": { - "username": { - "type": "string", - "description": "Gets or sets the username." - }, - "password": { - "type": "string", - "description": "Gets or sets the password." - } - }, - "allOf": [ - { - "$ref": "#/definitions/HttpAuthentication" - } - ] - }, - "OAuthAuthentication": { - "properties": { - "secret": { - "type": "string", - "description": "Gets or sets the secret." - }, - "tenant": { - "type": "string", - "description": "Gets or sets the tenant." - }, - "audience": { - "type": "string", - "description": "Gets or sets the audience." - }, - "clientId": { - "type": "string", - "description": "Gets or sets the client identifier." - } - }, - "allOf": [ - { - "$ref": "#/definitions/HttpAuthentication" - } - ] - }, - "HttpAuthentication": { - "properties": { - "type": { - "type": "string", - "description": "Gets or sets the http authentication type.", - "enum": [ - "NotSpecified", - "ClientCertificate", - "ActiveDirectoryOAuth", - "Basic" - ], - "x-ms-enum": { - "name": "HttpAuthenticationType", - "modelAsString": false - } - } - } - }, - "StorageQueueMessage": { - "properties": { - "storageAccount": { - "type": "string", - "description": "Gets or sets the storage account name." - }, - "queueName": { - "type": "string", - "description": "Gets or sets the queue name." - }, - "sasToken": { - "type": "string", - "description": "Gets or sets the SAS key." - }, - "message": { - "type": "string", - "description": "Gets or sets the message." - } - } - }, - "ServiceBusQueueMessage": { - "properties": { - "queueName": { - "type": "string", - "description": "Gets or sets the queue name." - } - }, - "allOf": [ - { - "$ref": "#/definitions/ServiceBusMessage" - } - ] - }, - "ServiceBusTopicMessage": { - "properties": { - "topicPath": { - "type": "string", - "description": "Gets or sets the topic path." - } - }, - "allOf": [ - { - "$ref": "#/definitions/ServiceBusMessage" - } - ] - }, - "ServiceBusMessage": { - "properties": { - "authentication": { - "$ref": "#/definitions/ServiceBusAuthentication", - "description": "Gets or sets the authentication." - }, - "brokeredMessageProperties": { - "$ref": "#/definitions/ServiceBusBrokeredMessageProperties", - "description": "Gets or sets the brokered message properties." - }, - "customMessageProperties": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Gets or sets the custom message properties." - }, - "message": { - "type": "string", - "description": "Gets or sets the message." - }, - "namespace": { - "type": "string", - "description": "Gets or sets the namespace." - }, - "transportType": { - "type": "string", - "description": "Gets or sets the transport type.", - "enum": [ - "NotSpecified", - "NetMessaging", - "AMQP" - ], - "x-ms-enum": { - "name": "ServiceBusTransportType", - "modelAsString": false - } - } - } - }, - "ServiceBusAuthentication": { - "properties": { - "sasKey": { - "type": "string", - "description": "Gets or sets the SAS key." - }, - "sasKeyName": { - "type": "string", - "description": "Gets or sets the SAS key name." - }, - "type": { - "type": "string", - "description": "Gets or sets the authentication type.", - "enum": [ - "NotSpecified", - "SharedAccessKey" - ], - "x-ms-enum": { - "name": "ServiceBusAuthenticationType", - "modelAsString": false - } - } - } - }, - "ServiceBusBrokeredMessageProperties": { - "properties": { - "contentType": { - "type": "string", - "description": "Gets or sets the content type." - }, - "correlationId": { - "type": "string", - "description": "Gets or sets the correlation id." - }, - "forcePersistence": { - "type": "boolean", - "description": "Gets or sets the force persistence." - }, - "label": { - "type": "string", - "description": "Gets or sets the label." - }, - "messageId": { - "type": "string", - "description": "Gets or sets the message id." - }, - "partitionKey": { - "type": "string", - "description": "Gets or sets the partition key." - }, - "replyTo": { - "type": "string", - "description": "Gets or sets the reply to." - }, - "replyToSessionId": { - "type": "string", - "description": "Gets or sets the reply to session id." - }, - "scheduledEnqueueTimeUtc": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the scheduled enqueue time UTC." - }, - "sessionId": { - "type": "string", - "description": "Gets or sets the session id." - }, - "timeToLive": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the time to live." - }, - "to": { - "type": "string", - "description": "Gets or sets the to." - }, - "viaPartitionKey": { - "type": "string", - "description": "Gets or sets the via partition key." - } - } - }, - "RetryPolicy": { - "properties": { - "retryType": { - "type": "string", - "description": "Gets or sets the retry strategy to be used.", - "enum": [ - "None", - "Fixed" - ], - "x-ms-enum": { - "name": "RetryType", - "modelAsString": false - } - }, - "retryInterval": { - "type": "string", - "format": "duration", - "description": "Gets or sets the retry interval between retries." - }, - "retryCount": { - "type": "integer", - "description": "Gets or sets the number of times a retry should be attempted." - } - } - }, - "JobMaxRecurrence": { - "properties": { - "frequency": { - "type": "string", - "description": "Gets or sets the frequency of recurrence (second, minute, hour, day, week, month).", - "enum": [ - "Minute", - "Hour", - "Day", - "Week", - "Month" - ], - "x-ms-enum": { - "name": "RecurrenceFrequency", - "modelAsString": false - } - }, - "interval": { - "type": "integer", - "description": "Gets or sets the interval between retries." - } - } - }, - "JobRecurrence": { - "properties": { - "frequency": { - "type": "string", - "description": "Gets or sets the frequency of recurrence (second, minute, hour, day, week, month).", - "enum": [ - "Minute", - "Hour", - "Day", - "Week", - "Month" - ], - "x-ms-enum": { - "name": "RecurrenceFrequency", - "modelAsString": false - } - }, - "interval": { - "type": "integer", - "description": "Gets or sets the interval between retries." - }, - "count": { - "type": "integer", - "description": "Gets or sets the maximum number of times that the job should run." - }, - "endTime": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the time at which the job will complete." - }, - "schedule": { - "$ref": "#/definitions/JobRecurrenceSchedule" - } - } - }, - "RecurrenceFrequency": { - "type": "string", - "description": "Gets or sets the frequency of recurrence (minute, hour, day, week, month).", - "enum": [ - "Minute", - "Hour", - "Day", - "Week", - "Month" - ], - "x-ms-enum": { - "name": "RecurrenceFrequency", - "modelAsString": false - } - }, - "JobRecurrenceSchedule": { - "properties": { - "weekDays": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "Sunday", - "Monday", - "Tuesday", - "Wednesday", - "Thursday", - "Friday", - "Saturday" - ], - "x-ms-enum": { - "name": "DayOfWeek", - "modelAsString": false - } - }, - "description": "Gets or sets the days of the week that the job should execute on." - }, - "hours": { - "type": "array", - "items": { - "type": "integer" - }, - "description": "Gets or sets the hours of the day that the job should execute at." - }, - "minutes": { - "type": "array", - "items": { - "type": "integer" - }, - "description": "Gets or sets the minutes of the hour that the job should execute at." - }, - "monthDays": { - "type": "array", - "items": { - "type": "integer" - }, - "description": "Gets or sets the days of the month that the job should execute on. Must be between 1 and 31." - }, - "monthlyOccurrences": { - "type": "array", - "items": { - "$ref": "#/definitions/JobRecurrenceScheduleMonthlyOccurrence" - }, - "description": "Gets or sets the occurrences of days within a month." - } - } - }, - "JobRecurrenceScheduleMonthlyOccurrence": { - "properties": { - "day": { - "type": "string", - "description": "Gets or sets the day. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday.", - "enum": [ - "Monday", - "Tuesday", - "Wednesday", - "Thursday", - "Friday", - "Saturday", - "Sunday" - ], - "x-ms-enum": { - "name": "JobScheduleDay", - "modelAsString": false - } - }, - "Occurrence": { - "type": "integer", - "description": "Gets or sets the occurrence. Must be between -5 and 5." - } - } - }, - "JobStateFilter": { - "type": "object", - "properties": { - "state": { - "$ref": "#/definitions/JobState", - "description": "Gets or sets the job state." - } - } - }, - "JobState": { - "type": "string", - "description": "Gets or set the job state.", - "enum": [ - "Enabled", - "Disabled", - "Faulted", - "Completed" - ], - "x-ms-enum": { - "name": "JobState", - "modelAsString": false - } - }, - "JobHistoryFilter": { - "type": "object", - "properties": { - "status": { - "$ref": "#/definitions/JobExecutionStatus", - "description": "Gets or sets the job execution status." - } - } - }, - "JobExecutionStatus": { - "type": "string", - "description": "Gets the job execution status.", - "enum": [ - "Completed", - "Failed", - "Postponed" - ], - "x-ms-enum": { - "name": "JobExecutionStatus", - "modelAsString": false - } - }, - "JobStatus": { - "properties": { - "executionCount": { - "type": "integer", - "readOnly": true, - "description": "Gets the number of times this job has executed." - }, - "failureCount": { - "type": "integer", - "readOnly": true, - "description": "Gets the number of times this job has failed." - }, - "faultedCount": { - "type": "integer", - "readOnly": true, - "description": "Gets the number of faulted occurrences (occurrences that were retried and failed as many times as the retry policy states)." - }, - "lastExecutionTime": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "Gets the time the last occurrence executed in ISO-8601 format. Could be empty if job has not run yet." - }, - "nextExecutionTime": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "Gets the time of the next occurrence in ISO-8601 format. Could be empty if the job is completed." - } - } - } - }, - "parameters": { - "subscriptionId": { - "name": "subscriptionId", - "description": "The subscription id.", - "in": "path", - "required": true, - "type": "string" - }, - "api-version": { - "name": "api-version", - "description": "The API version.", - "in": "query", - "required": true, - "type": "string" - } - } -} +{ + "swagger": "2.0", + "info": { + "title": "SchedulerManagementClient", + "version": "2016-01-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json", + "text/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Scheduler/jobCollections": { + "get": { + "tags": [ + "JobCollections" + ], + "operationId": "JobCollections_ListBySubscription", + "description": "Gets all job collections under specified subscription.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The job collections have been successfully returned.", + "schema": { + "$ref": "#/definitions/JobCollectionListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections": { + "get": { + "tags": [ + "JobCollections" + ], + "operationId": "JobCollections_ListByResourceGroup", + "description": "Gets all job collections under specified resource group.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The job collections have been successfully returned.", + "schema": { + "$ref": "#/definitions/JobCollectionListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}": { + "get": { + "tags": [ + "JobCollections" + ], + "operationId": "JobCollections_Get", + "description": "Gets a job collection.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "name": "jobCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The job collection name." + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The job collection has been successfully returned.", + "schema": { + "$ref": "#/definitions/JobCollectionDefinition" + } + } + } + }, + "put": { + "tags": [ + "JobCollections" + ], + "operationId": "JobCollections_CreateOrUpdate", + "description": "Provisions a new job collection or updates an existing job collection.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "name": "jobCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The job collection name." + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "jobCollection", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/JobCollectionDefinition" + }, + "description": "The job collection definition." + } + ], + "responses": { + "200": { + "description": "The job collection has been successfully updated.", + "schema": { + "$ref": "#/definitions/JobCollectionDefinition" + } + }, + "201": { + "description": "The job collection has been successfully created.", + "schema": { + "$ref": "#/definitions/JobCollectionDefinition" + } + } + } + }, + "patch": { + "tags": [ + "JobCollections" + ], + "operationId": "JobCollections_Patch", + "description": "Patches an existing job collection.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "name": "jobCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The job collection name." + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "jobCollection", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/JobCollectionDefinition" + }, + "description": "The job collection definition." + } + ], + "responses": { + "200": { + "description": "The job collection has been successfully patched.", + "schema": { + "$ref": "#/definitions/JobCollectionDefinition" + } + } + } + }, + "delete": { + "tags": [ + "JobCollections" + ], + "operationId": "JobCollections_Delete", + "description": "Deletes a job collection.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "name": "jobCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The job collection name." + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The job collection has been successfully deleted." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/enable": { + "post": { + "tags": [ + "JobCollections" + ], + "operationId": "JobCollections_Enable", + "description": "Enables all of the jobs in the job collection.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "name": "jobCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The job collection name." + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "All of the jobs in the job collection have been successfully enabled." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/disable": { + "post": { + "tags": [ + "JobCollections" + ], + "operationId": "JobCollections_Disable", + "description": "Disables all of the jobs in the job collection.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "name": "jobCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The job collection name." + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "All of the jobs in the job collection have been successfully disabled." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/jobs/{jobName}": { + "get": { + "tags": [ + "Jobs" + ], + "operationId": "Jobs_Get", + "description": "Gets a job.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "name": "jobCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The job collection name." + }, + { + "name": "jobName", + "in": "path", + "required": true, + "type": "string", + "description": "The job name." + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The job has been successfully returned.", + "schema": { + "$ref": "#/definitions/JobDefinition" + } + } + } + }, + "put": { + "tags": [ + "Jobs" + ], + "operationId": "Jobs_CreateOrUpdate", + "description": "Provisions a new job or updates an existing job.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "name": "jobCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The job collection name." + }, + { + "name": "jobName", + "in": "path", + "required": true, + "type": "string", + "description": "The job name." + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "job", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/JobDefinition" + }, + "description": "The job definition." + } + ], + "responses": { + "200": { + "description": "The job has been successfully updated.", + "schema": { + "$ref": "#/definitions/JobDefinition" + } + }, + "201": { + "description": "The job has been successfully created.", + "schema": { + "$ref": "#/definitions/JobDefinition" + } + } + } + }, + "patch": { + "tags": [ + "Jobs" + ], + "operationId": "Jobs_Patch", + "description": "Patches an existing job.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "name": "jobCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The job collection name." + }, + { + "name": "jobName", + "in": "path", + "required": true, + "type": "string", + "description": "The job name." + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "job", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/JobDefinition" + }, + "description": "The job definition." + } + ], + "responses": { + "200": { + "description": "The job has been successfully patched.", + "schema": { + "$ref": "#/definitions/JobDefinition" + } + } + } + }, + "delete": { + "tags": [ + "Jobs" + ], + "operationId": "Jobs_Delete", + "description": "Deletes a job.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "name": "jobCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The job collection name." + }, + { + "name": "jobName", + "in": "path", + "required": true, + "type": "string", + "description": "The job name." + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The job has been successfully deleted." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/jobs/{jobName}/run": { + "post": { + "tags": [ + "Jobs" + ], + "operationId": "Jobs_Run", + "description": "Runs a job.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "name": "jobCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The job collection name." + }, + { + "name": "jobName", + "in": "path", + "required": true, + "type": "string", + "description": "The job name." + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The job has been successfully run." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/jobs": { + "get": { + "tags": [ + "Jobs" + ], + "operationId": "Jobs_List", + "description": "Lists all jobs under the specified job collection.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "name": "jobCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The job collection name." + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "description": "The number of jobs to request, in the of range [1..100]." + }, + { + "name": "$skip", + "in": "query", + "required": false, + "type": "integer", + "description": "The (0-based) index of the job history list from which to begin requesting entries." + }, + { + "name": "$filter", + "description": "The filter to apply on the job state.", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The job has been successfully returned.", + "schema": { + "$ref": "#/definitions/JobListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/JobStateFilter" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/jobs/{jobName}/history": { + "get": { + "tags": [ + "Jobs" + ], + "operationId": "Jobs_ListJobHistory", + "description": "Lists job history.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "name": "jobCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The job collection name." + }, + { + "name": "jobName", + "in": "path", + "required": true, + "type": "string", + "description": "The job name." + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "description": "the number of job history to request, in the of range [1..100]." + }, + { + "name": "$skip", + "in": "query", + "required": false, + "type": "integer", + "description": "The (0-based) index of the job history list from which to begin requesting entries." + }, + { + "name": "$filter", + "description": "The filter to apply on the job state.", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The job histories have been successfully returned.", + "schema": { + "$ref": "#/definitions/JobHistoryListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/JobHistoryFilter" + } + } + }, + "definitions": { + "JobCollectionListResult": { + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/JobCollectionDefinition" + }, + "description": "Gets the job collections." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the URL to get the next set of job collections." + } + } + }, + "JobListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/JobDefinition" + }, + "description": "Gets or sets all jobs under job collection." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the URL to get the next set of jobs." + } + } + }, + "JobHistoryListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/JobHistoryDefinition" + }, + "description": "Gets or sets the job histories under job." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the URL to get the next set of job histories." + } + } + }, + "JobCollectionDefinition": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Gets the job collection resource identifier." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Gets the job collection resource type." + }, + "name": { + "type": "string", + "description": "Gets or sets the job collection resource name." + }, + "location": { + "type": "string", + "description": "Gets or sets the storage account location." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Gets or sets the tags." + }, + "properties": { + "$ref": "#/definitions/JobCollectionProperties", + "description": "Gets or sets the job collection properties." + } + } + }, + "JobCollectionProperties": { + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "Gets or sets the SKU." + }, + "state": { + "type": "string", + "description": "Gets or sets the state.", + "enum": [ + "Enabled", + "Disabled", + "Suspended", + "Deleted" + ], + "x-ms-enum": { + "name": "JobCollectionState", + "modelAsString": false + } + }, + "quota": { + "$ref": "#/definitions/JobCollectionQuota", + "description": "Gets or sets the job collection quota." + } + } + }, + "Sku": { + "properties": { + "name": { + "type": "string", + "description": "Gets or set the SKU.", + "enum": [ + "Standard", + "Free", + "Premium" + ], + "x-ms-enum": { + "name": "SkuDefinition", + "modelAsString": false + } + } + } + }, + "JobCollectionQuota": { + "properties": { + "maxJobCount": { + "type": "integer", + "description": "Gets or set the maximum job count." + }, + "maxJobOccurrence": { + "type": "integer", + "description": "Gets or sets the maximum job occurrence." + }, + "maxRecurrence": { + "$ref": "#/definitions/JobMaxRecurrence", + "description": "Gets or set the maximum recurrence." + } + } + }, + "JobDefinition": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Gets the job resource identifier." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Gets the job resource type." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Gets the job resource name." + }, + "properties": { + "$ref": "#/definitions/JobProperties", + "description": "Gets or sets the job properties." + } + } + }, + "JobProperties": { + "properties": { + "startTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the job start time." + }, + "action": { + "$ref": "#/definitions/JobAction", + "description": "Gets or sets the job action." + }, + "recurrence": { + "$ref": "#/definitions/JobRecurrence", + "description": "Gets or sets the job recurrence." + }, + "state": { + "$ref": "#/definitions/JobState", + "description": "Gets or set the job state." + }, + "status": { + "$ref": "#/definitions/JobStatus", + "readOnly": true, + "description": "Gets the job status." + } + } + }, + "JobHistoryDefinition": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Gets the job history identifier." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Gets the job history resource type." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Gets the job history name." + }, + "properties": { + "$ref": "#/definitions/JobHistoryDefinitionProperties", + "readOnly": true, + "description": "Gets or sets the job history properties." + } + } + }, + "JobHistoryDefinitionProperties": { + "properties": { + "startTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Gets the start time for this job." + }, + "endTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Gets the end time for this job." + }, + "expectedExecutionTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Gets the expected execution time for this job." + }, + "actionName": { + "type": "string", + "readOnly": true, + "description": "Gets the job history action name.", + "enum": [ + "MainAction", + "ErrorAction" + ], + "x-ms-enum": { + "name": "JobHistoryActionName", + "modelAsString": false + } + }, + "status": { + "$ref": "#/definitions/JobExecutionStatus", + "readOnly": true, + "description": "Gets the job history status." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "Gets the message for the job history." + }, + "retryCount": { + "type": "integer", + "readOnly": true, + "description": "Gets the retry count for job." + }, + "repeatCount": { + "type": "integer", + "readOnly": true, + "description": "Gets the repeat count for the job." + } + } + }, + "JobAction": { + "properties": { + "type": { + "type": "string", + "description": "Gets or sets the job action type.", + "enum": [ + "Http", + "Https", + "StorageQueue", + "ServiceBusQueue", + "ServiceBusTopic" + ], + "x-ms-enum": { + "name": "JobActionType", + "modelAsString": false + } + }, + "request": { + "$ref": "#/definitions/HttpRequest", + "description": "Gets or sets the http requests." + }, + "queueMessage": { + "$ref": "#/definitions/StorageQueueMessage", + "description": "Gets or sets the storage queue message." + }, + "serviceBusQueueMessage": { + "$ref": "#/definitions/ServiceBusQueueMessage", + "description": "Gets or sets the service bus queue message." + }, + "serviceBusTopicMessage": { + "$ref": "#/definitions/ServiceBusTopicMessage", + "description": "Gets or sets the service bus topic message." + }, + "retryPolicy": { + "$ref": "#/definitions/RetryPolicy", + "description": "Gets or sets the retry policy." + }, + "errorAction": { + "$ref": "#/definitions/JobErrorAction", + "description": "Gets or sets the error action." + } + } + }, + "JobErrorAction": { + "properties": { + "type": { + "type": "string", + "description": "Gets or sets the job error action type.", + "enum": [ + "Http", + "Https", + "StorageQueue", + "ServiceBusQueue", + "ServiceBusTopic" + ], + "x-ms-enum": { + "name": "JobActionType", + "modelAsString": false + } + }, + "request": { + "$ref": "#/definitions/HttpRequest", + "description": "Gets or sets the http requests." + }, + "queueMessage": { + "$ref": "#/definitions/StorageQueueMessage", + "description": "Gets or sets the storage queue message." + }, + "serviceBusQueueMessage": { + "$ref": "#/definitions/ServiceBusQueueMessage", + "description": "Gets or sets the service bus queue message." + }, + "serviceBusTopicMessage": { + "$ref": "#/definitions/ServiceBusTopicMessage", + "description": "Gets or sets the service bus topic message." + }, + "retryPolicy": { + "$ref": "#/definitions/RetryPolicy", + "description": "Gets or sets the retry policy." + } + } + }, + "HttpRequest": { + "properties": { + "authentication": { + "$ref": "#/definitions/HttpAuthentication", + "description": "Gets or sets the http authentication." + }, + "uri": { + "type": "string", + "description": "Gets or sets the Uri." + }, + "method": { + "type": "string", + "description": "Gets or sets the method of the request." + }, + "body": { + "type": "string", + "description": "Gets or sets the request body." + }, + "headers": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Gets or sets the headers." + } + } + }, + "ClientCertAuthentication": { + "properties": { + "password": { + "type": "string", + "description": "Gets or sets the password." + }, + "pfx": { + "type": "string", + "description": "Gets or sets the pfx." + }, + "certificateThumbprint": { + "type": "string", + "description": "Gets or sets the certificate thumbprint." + }, + "certificateExpirationDate": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the certificate expiration date." + }, + "certificateSubjectName": { + "type": "string", + "description": "Gets or sets the certificate subject name." + } + }, + "allOf": [ + { + "$ref": "#/definitions/HttpAuthentication" + } + ] + }, + "BasicAuthentication": { + "properties": { + "username": { + "type": "string", + "description": "Gets or sets the username." + }, + "password": { + "type": "string", + "description": "Gets or sets the password." + } + }, + "allOf": [ + { + "$ref": "#/definitions/HttpAuthentication" + } + ] + }, + "OAuthAuthentication": { + "properties": { + "secret": { + "type": "string", + "description": "Gets or sets the secret." + }, + "tenant": { + "type": "string", + "description": "Gets or sets the tenant." + }, + "audience": { + "type": "string", + "description": "Gets or sets the audience." + }, + "clientId": { + "type": "string", + "description": "Gets or sets the client identifier." + } + }, + "allOf": [ + { + "$ref": "#/definitions/HttpAuthentication" + } + ] + }, + "HttpAuthentication": { + "properties": { + "type": { + "type": "string", + "description": "Gets or sets the http authentication type.", + "enum": [ + "NotSpecified", + "ClientCertificate", + "ActiveDirectoryOAuth", + "Basic" + ], + "x-ms-enum": { + "name": "HttpAuthenticationType", + "modelAsString": false + } + } + } + }, + "StorageQueueMessage": { + "properties": { + "storageAccount": { + "type": "string", + "description": "Gets or sets the storage account name." + }, + "queueName": { + "type": "string", + "description": "Gets or sets the queue name." + }, + "sasToken": { + "type": "string", + "description": "Gets or sets the SAS key." + }, + "message": { + "type": "string", + "description": "Gets or sets the message." + } + } + }, + "ServiceBusQueueMessage": { + "properties": { + "queueName": { + "type": "string", + "description": "Gets or sets the queue name." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ServiceBusMessage" + } + ] + }, + "ServiceBusTopicMessage": { + "properties": { + "topicPath": { + "type": "string", + "description": "Gets or sets the topic path." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ServiceBusMessage" + } + ] + }, + "ServiceBusMessage": { + "properties": { + "authentication": { + "$ref": "#/definitions/ServiceBusAuthentication", + "description": "Gets or sets the authentication." + }, + "brokeredMessageProperties": { + "$ref": "#/definitions/ServiceBusBrokeredMessageProperties", + "description": "Gets or sets the brokered message properties." + }, + "customMessageProperties": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Gets or sets the custom message properties." + }, + "message": { + "type": "string", + "description": "Gets or sets the message." + }, + "namespace": { + "type": "string", + "description": "Gets or sets the namespace." + }, + "transportType": { + "type": "string", + "description": "Gets or sets the transport type.", + "enum": [ + "NotSpecified", + "NetMessaging", + "AMQP" + ], + "x-ms-enum": { + "name": "ServiceBusTransportType", + "modelAsString": false + } + } + } + }, + "ServiceBusAuthentication": { + "properties": { + "sasKey": { + "type": "string", + "description": "Gets or sets the SAS key." + }, + "sasKeyName": { + "type": "string", + "description": "Gets or sets the SAS key name." + }, + "type": { + "type": "string", + "description": "Gets or sets the authentication type.", + "enum": [ + "NotSpecified", + "SharedAccessKey" + ], + "x-ms-enum": { + "name": "ServiceBusAuthenticationType", + "modelAsString": false + } + } + } + }, + "ServiceBusBrokeredMessageProperties": { + "properties": { + "contentType": { + "type": "string", + "description": "Gets or sets the content type." + }, + "correlationId": { + "type": "string", + "description": "Gets or sets the correlation id." + }, + "forcePersistence": { + "type": "boolean", + "description": "Gets or sets the force persistence." + }, + "label": { + "type": "string", + "description": "Gets or sets the label." + }, + "messageId": { + "type": "string", + "description": "Gets or sets the message id." + }, + "partitionKey": { + "type": "string", + "description": "Gets or sets the partition key." + }, + "replyTo": { + "type": "string", + "description": "Gets or sets the reply to." + }, + "replyToSessionId": { + "type": "string", + "description": "Gets or sets the reply to session id." + }, + "scheduledEnqueueTimeUtc": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the scheduled enqueue time UTC." + }, + "sessionId": { + "type": "string", + "description": "Gets or sets the session id." + }, + "timeToLive": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the time to live." + }, + "to": { + "type": "string", + "description": "Gets or sets the to." + }, + "viaPartitionKey": { + "type": "string", + "description": "Gets or sets the via partition key." + } + } + }, + "RetryPolicy": { + "properties": { + "retryType": { + "type": "string", + "description": "Gets or sets the retry strategy to be used.", + "enum": [ + "None", + "Fixed" + ], + "x-ms-enum": { + "name": "RetryType", + "modelAsString": false + } + }, + "retryInterval": { + "type": "string", + "format": "duration", + "description": "Gets or sets the retry interval between retries." + }, + "retryCount": { + "type": "integer", + "description": "Gets or sets the number of times a retry should be attempted." + } + } + }, + "JobMaxRecurrence": { + "properties": { + "frequency": { + "type": "string", + "description": "Gets or sets the frequency of recurrence (second, minute, hour, day, week, month).", + "enum": [ + "Minute", + "Hour", + "Day", + "Week", + "Month" + ], + "x-ms-enum": { + "name": "RecurrenceFrequency", + "modelAsString": false + } + }, + "interval": { + "type": "integer", + "description": "Gets or sets the interval between retries." + } + } + }, + "JobRecurrence": { + "properties": { + "frequency": { + "type": "string", + "description": "Gets or sets the frequency of recurrence (second, minute, hour, day, week, month).", + "enum": [ + "Minute", + "Hour", + "Day", + "Week", + "Month" + ], + "x-ms-enum": { + "name": "RecurrenceFrequency", + "modelAsString": false + } + }, + "interval": { + "type": "integer", + "description": "Gets or sets the interval between retries." + }, + "count": { + "type": "integer", + "description": "Gets or sets the maximum number of times that the job should run." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the time at which the job will complete." + }, + "schedule": { + "$ref": "#/definitions/JobRecurrenceSchedule" + } + } + }, + "RecurrenceFrequency": { + "type": "string", + "description": "Gets or sets the frequency of recurrence (minute, hour, day, week, month).", + "enum": [ + "Minute", + "Hour", + "Day", + "Week", + "Month" + ], + "x-ms-enum": { + "name": "RecurrenceFrequency", + "modelAsString": false + } + }, + "JobRecurrenceSchedule": { + "properties": { + "weekDays": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "Sunday", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday" + ], + "x-ms-enum": { + "name": "DayOfWeek", + "modelAsString": false + } + }, + "description": "Gets or sets the days of the week that the job should execute on." + }, + "hours": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "Gets or sets the hours of the day that the job should execute at." + }, + "minutes": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "Gets or sets the minutes of the hour that the job should execute at." + }, + "monthDays": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "Gets or sets the days of the month that the job should execute on. Must be between 1 and 31." + }, + "monthlyOccurrences": { + "type": "array", + "items": { + "$ref": "#/definitions/JobRecurrenceScheduleMonthlyOccurrence" + }, + "description": "Gets or sets the occurrences of days within a month." + } + } + }, + "JobRecurrenceScheduleMonthlyOccurrence": { + "properties": { + "day": { + "type": "string", + "description": "Gets or sets the day. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday.", + "enum": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ], + "x-ms-enum": { + "name": "JobScheduleDay", + "modelAsString": false + } + }, + "Occurrence": { + "type": "integer", + "description": "Gets or sets the occurrence. Must be between -5 and 5." + } + } + }, + "JobStateFilter": { + "type": "object", + "properties": { + "state": { + "$ref": "#/definitions/JobState", + "description": "Gets or sets the job state." + } + } + }, + "JobState": { + "type": "string", + "description": "Gets or set the job state.", + "enum": [ + "Enabled", + "Disabled", + "Faulted", + "Completed" + ], + "x-ms-enum": { + "name": "JobState", + "modelAsString": false + } + }, + "JobHistoryFilter": { + "type": "object", + "properties": { + "status": { + "$ref": "#/definitions/JobExecutionStatus", + "description": "Gets or sets the job execution status." + } + } + }, + "JobExecutionStatus": { + "type": "string", + "description": "Gets the job execution status.", + "enum": [ + "Completed", + "Failed", + "Postponed" + ], + "x-ms-enum": { + "name": "JobExecutionStatus", + "modelAsString": false + } + }, + "JobStatus": { + "properties": { + "executionCount": { + "type": "integer", + "readOnly": true, + "description": "Gets the number of times this job has executed." + }, + "failureCount": { + "type": "integer", + "readOnly": true, + "description": "Gets the number of times this job has failed." + }, + "faultedCount": { + "type": "integer", + "readOnly": true, + "description": "Gets the number of faulted occurrences (occurrences that were retried and failed as many times as the retry policy states)." + }, + "lastExecutionTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Gets the time the last occurrence executed in ISO-8601 format. Could be empty if job has not run yet." + }, + "nextExecutionTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Gets the time of the next occurrence in ISO-8601 format. Could be empty if the job is completed." + } + } + } + }, + "parameters": { + "subscriptionId": { + "name": "subscriptionId", + "description": "The subscription id.", + "in": "path", + "required": true, + "type": "string" + }, + "api-version": { + "name": "api-version", + "description": "The API version.", + "in": "query", + "required": true, + "type": "string" + } + } +} diff --git a/arm-search/2015-02-28/swagger/search.json b/arm-search/2015-02-28/swagger/search.json index 07c3c7dcd550..53ebc9b0caa2 100644 --- a/arm-search/2015-02-28/swagger/search.json +++ b/arm-search/2015-02-28/swagger/search.json @@ -1,508 +1,508 @@ -{ - "swagger": "2.0", - "info": { - "title": "SearchManagementClient", - "description": "Client that can be used to manage Azure Search services and API keys.", - "version": "2015-02-28" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json", - "text/json" - ], - "produces": [ - "application/json", - "text/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{serviceName}/listAdminKeys": { - "post": { - "tags": [ - "AdminKeys" - ], - "operationId": "AdminKeys_List", - "description": "Returns the primary and secondary API keys for the given Azure Search service.", - "externalDocs": { - "url": "https://msdn.microsoft.com/library/azure/dn832685.aspx" - }, - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group within the current subscription." - }, - { - "name": "serviceName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the Search service for which to list admin keys." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/AdminKeyResult" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{serviceName}/listQueryKeys": { - "get": { - "tags": [ - "QueryKeys" - ], - "operationId": "QueryKeys_List", - "description": "Returns the list of query API keys for the given Azure Search service.", - "externalDocs": { - "url": "https://msdn.microsoft.com/library/azure/dn832701.aspx" - }, - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group within the current subscription." - }, - { - "name": "serviceName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the Search service for which to list query keys." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/ListQueryKeysResult" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{serviceName}": { - "put": { - "tags": [ - "Services" - ], - "operationId": "Services_CreateOrUpdate", - "description": "Creates or updates a Search service in the given resource group. If the Search service already exists, all properties will be updated with the given values.", - "externalDocs": { - "url": "https://msdn.microsoft.com/library/azure/dn832687.aspx" - }, - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group within the current subscription." - }, - { - "name": "serviceName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the Search service to create or update." - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/SearchServiceCreateOrUpdateParameters" - }, - "description": "The properties to set or update on the Search service." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/SearchServiceResource" - } - }, - "201": { - "description": "", - "schema": { - "$ref": "#/definitions/SearchServiceResource" - } - } - } - }, - "delete": { - "tags": [ - "Services" - ], - "operationId": "Services_Delete", - "description": "Deletes a Search service in the given resource group, along with its associated resources.", - "externalDocs": { - "url": "https://msdn.microsoft.com/library/azure/dn832692.aspx" - }, - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group within the current subscription." - }, - { - "name": "serviceName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the Search service to delete." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "" - }, - "404": { - "description": "" - }, - "204": { - "description": "" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices": { - "get": { - "tags": [ - "Services" - ], - "operationId": "Services_List", - "description": "Returns a list of all Search services in the given resource group.", - "externalDocs": { - "url": "https://msdn.microsoft.com/library/azure/dn832688.aspx" - }, - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group within the current subscription." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/SearchServiceListResult" - } - } - } - } - } - }, - "definitions": { - "AdminKeyResult": { - "properties": { - "primaryKey": { - "type": "string", - "description": "Gets the primary API key of the Search service." - }, - "secondaryKey": { - "type": "string", - "description": "Gets the secondary API key of the Search service." - } - }, - "description": "Response containing the primary and secondary API keys for a given Azure Search service." - }, - "QueryKey": { - "properties": { - "name": { - "type": "string", - "description": "Gets the name of the query API key; may be empty." - }, - "key": { - "type": "string", - "description": "Gets the value of the query API key." - } - }, - "description": "Describes an API key for a given Azure Search service that has permissions for query operations only." - }, - "ListQueryKeysResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/QueryKey" - }, - "description": "Gets the query keys for the Azure Search service." - } - }, - "description": "Response containing the query API keys for a given Azure Search service." - }, - "Sku": { - "properties": { - "name": { - "type": "string", - "description": "Gets or sets the SKU of the Search service.", - "enum": [ - "free", - "standard", - "standard2" - ], - "x-ms-enum": { - "name": "SkuType" - } - } - }, - "description": "Defines the SKU of an Azure Search Service, which determines price tier and capacity limits." - }, - "SearchServiceProperties": { - "properties": { - "sku": { - "$ref": "#/definitions/Sku", - "description": "Gets or sets the SKU of the Search Service, which determines price tier and capacity limits." - }, - "replicaCount": { - "type": "integer", - "format": "int32", - "description": "Gets or sets the number of replicas in the Search service. If specified, it must be a value between 1 and 6 inclusive." - }, - "partitionCount": { - "type": "integer", - "format": "int32", - "description": "Gets or sets the number of partitions in the Search service; if specified, it can be 1, 2, 3, 4, 6, or 12." - } - }, - "description": "Defines properties of an Azure Search service that can be modified." - }, - "SearchServiceCreateOrUpdateParameters": { - "properties": { - "location": { - "type": "string", - "description": "Gets or sets the geographic location of the Search service." - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Gets or sets tags to help categorize the Search service in the Azure Portal." - }, - "properties": { - "$ref": "#/definitions/SearchServiceProperties", - "description": "Gets or sets properties of the Search service." - } - }, - "description": "Properties that describe an Azure Search service." - }, - "SearchServiceReadableProperties": { - "properties": { - "status": { - "type": "string", - "description": "Gets the status of the Search service.", - "enum": [ - "running", - "provisioning", - "deleting", - "degraded", - "disabled", - "error" - ], - "x-ms-enum": { - "name": "SearchServiceStatus" - } - }, - "statusDetails": { - "type": "string", - "description": "Gets the details of the Search service status." - }, - "provisioningState": { - "type": "string", - "description": "Gets the state of the last provisioning operation performed on the Search service.", - "enum": [ - "succeeded", - "provisioning", - "failed" - ], - "x-ms-enum": { - "name": "ProvisioningState" - } - }, - "sku": { - "$ref": "#/definitions/Sku", - "description": "Gets or sets the SKU of the Search Service, which determines price tier and capacity limits." - }, - "replicaCount": { - "type": "integer", - "format": "int32", - "description": "Gets or sets the number of replicas in the Search service. If specified, it must be a value between 1 and 6 inclusive." - }, - "partitionCount": { - "type": "integer", - "format": "int32", - "description": "Gets or sets the number of partitions in the Search service; if specified, it can be 1, 2, 3, 4, 6, or 12." - } - }, - "description": "Defines all the properties of an Azure Search service." - }, - "SearchServiceResource": { - "properties": { - "id": { - "readOnly": true, - "type": "string", - "description": "Resource Id" - }, - "name": { - "externalDocs": { - "url": "https://msdn.microsoft.com/library/azure/dn857353.aspx" - }, - "type": "string", - "description": "Gets or sets the name of the Search service." - }, - "location": { - "type": "string", - "description": "Gets or sets the geographic location of the Search service." - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Gets or sets tags to help categorize the Search service in the Azure Portal." - }, - "properties": { - "$ref": "#/definitions/SearchServiceReadableProperties", - "description": "Gets properties of the Search service." - } - }, - "description": "Describes an Azure Search service and its current state." - }, - "SearchServiceListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/SearchServiceResource" - }, - "description": "Gets the Search services in the resource group." - } - }, - "description": "Response containing a list of Azure Search services for a given resource group." - }, - "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." - } - } -} +{ + "swagger": "2.0", + "info": { + "title": "SearchManagementClient", + "description": "Client that can be used to manage Azure Search services and API keys.", + "version": "2015-02-28" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json", + "text/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{serviceName}/listAdminKeys": { + "post": { + "tags": [ + "AdminKeys" + ], + "operationId": "AdminKeys_List", + "description": "Returns the primary and secondary API keys for the given Azure Search service.", + "externalDocs": { + "url": "https://msdn.microsoft.com/library/azure/dn832685.aspx" + }, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the current subscription." + }, + { + "name": "serviceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Search service for which to list admin keys." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/AdminKeyResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{serviceName}/listQueryKeys": { + "get": { + "tags": [ + "QueryKeys" + ], + "operationId": "QueryKeys_List", + "description": "Returns the list of query API keys for the given Azure Search service.", + "externalDocs": { + "url": "https://msdn.microsoft.com/library/azure/dn832701.aspx" + }, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the current subscription." + }, + { + "name": "serviceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Search service for which to list query keys." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ListQueryKeysResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{serviceName}": { + "put": { + "tags": [ + "Services" + ], + "operationId": "Services_CreateOrUpdate", + "description": "Creates or updates a Search service in the given resource group. If the Search service already exists, all properties will be updated with the given values.", + "externalDocs": { + "url": "https://msdn.microsoft.com/library/azure/dn832687.aspx" + }, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the current subscription." + }, + { + "name": "serviceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Search service to create or update." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SearchServiceCreateOrUpdateParameters" + }, + "description": "The properties to set or update on the Search service." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchServiceResource" + } + }, + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchServiceResource" + } + } + } + }, + "delete": { + "tags": [ + "Services" + ], + "operationId": "Services_Delete", + "description": "Deletes a Search service in the given resource group, along with its associated resources.", + "externalDocs": { + "url": "https://msdn.microsoft.com/library/azure/dn832692.aspx" + }, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the current subscription." + }, + { + "name": "serviceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Search service to delete." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "" + }, + "404": { + "description": "" + }, + "204": { + "description": "" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices": { + "get": { + "tags": [ + "Services" + ], + "operationId": "Services_List", + "description": "Returns a list of all Search services in the given resource group.", + "externalDocs": { + "url": "https://msdn.microsoft.com/library/azure/dn832688.aspx" + }, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the current subscription." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchServiceListResult" + } + } + } + } + } + }, + "definitions": { + "AdminKeyResult": { + "properties": { + "primaryKey": { + "type": "string", + "description": "Gets the primary API key of the Search service." + }, + "secondaryKey": { + "type": "string", + "description": "Gets the secondary API key of the Search service." + } + }, + "description": "Response containing the primary and secondary API keys for a given Azure Search service." + }, + "QueryKey": { + "properties": { + "name": { + "type": "string", + "description": "Gets the name of the query API key; may be empty." + }, + "key": { + "type": "string", + "description": "Gets the value of the query API key." + } + }, + "description": "Describes an API key for a given Azure Search service that has permissions for query operations only." + }, + "ListQueryKeysResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/QueryKey" + }, + "description": "Gets the query keys for the Azure Search service." + } + }, + "description": "Response containing the query API keys for a given Azure Search service." + }, + "Sku": { + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the SKU of the Search service.", + "enum": [ + "free", + "standard", + "standard2" + ], + "x-ms-enum": { + "name": "SkuType" + } + } + }, + "description": "Defines the SKU of an Azure Search Service, which determines price tier and capacity limits." + }, + "SearchServiceProperties": { + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "Gets or sets the SKU of the Search Service, which determines price tier and capacity limits." + }, + "replicaCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of replicas in the Search service. If specified, it must be a value between 1 and 6 inclusive." + }, + "partitionCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of partitions in the Search service; if specified, it can be 1, 2, 3, 4, 6, or 12." + } + }, + "description": "Defines properties of an Azure Search service that can be modified." + }, + "SearchServiceCreateOrUpdateParameters": { + "properties": { + "location": { + "type": "string", + "description": "Gets or sets the geographic location of the Search service." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Gets or sets tags to help categorize the Search service in the Azure Portal." + }, + "properties": { + "$ref": "#/definitions/SearchServiceProperties", + "description": "Gets or sets properties of the Search service." + } + }, + "description": "Properties that describe an Azure Search service." + }, + "SearchServiceReadableProperties": { + "properties": { + "status": { + "type": "string", + "description": "Gets the status of the Search service.", + "enum": [ + "running", + "provisioning", + "deleting", + "degraded", + "disabled", + "error" + ], + "x-ms-enum": { + "name": "SearchServiceStatus" + } + }, + "statusDetails": { + "type": "string", + "description": "Gets the details of the Search service status." + }, + "provisioningState": { + "type": "string", + "description": "Gets the state of the last provisioning operation performed on the Search service.", + "enum": [ + "succeeded", + "provisioning", + "failed" + ], + "x-ms-enum": { + "name": "ProvisioningState" + } + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "Gets or sets the SKU of the Search Service, which determines price tier and capacity limits." + }, + "replicaCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of replicas in the Search service. If specified, it must be a value between 1 and 6 inclusive." + }, + "partitionCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of partitions in the Search service; if specified, it can be 1, 2, 3, 4, 6, or 12." + } + }, + "description": "Defines all the properties of an Azure Search service." + }, + "SearchServiceResource": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id" + }, + "name": { + "externalDocs": { + "url": "https://msdn.microsoft.com/library/azure/dn857353.aspx" + }, + "type": "string", + "description": "Gets or sets the name of the Search service." + }, + "location": { + "type": "string", + "description": "Gets or sets the geographic location of the Search service." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Gets or sets tags to help categorize the Search service in the Azure Portal." + }, + "properties": { + "$ref": "#/definitions/SearchServiceReadableProperties", + "description": "Gets properties of the Search service." + } + }, + "description": "Describes an Azure Search service and its current state." + }, + "SearchServiceListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchServiceResource" + }, + "description": "Gets the Search services in the resource group." + } + }, + "description": "Response containing a list of Azure Search services for a given resource group." + }, + "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." + } + } +} diff --git a/arm-sql/2015-05-01/swagger/sql.json b/arm-sql/2015-05-01/swagger/sql.json index f4001b33c182..b324f1971d3e 100644 --- a/arm-sql/2015-05-01/swagger/sql.json +++ b/arm-sql/2015-05-01/swagger/sql.json @@ -1,256 +1,256 @@ -{ - "swagger": "2.0", - "info": { - "title": "SqlManagementClient", - "description": "The Azure SQL Database management API provides a RESTful set of web services that interact with Azure SQL Database services to manage your databases. The API enables users to create, retrieve, update, and delete Databases, Servers and related resources.", - "version": "2015-05-01-preview" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json", - "text/json" - ], - "produces": [ - "application/json", - "text/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/securityAlertPolicies/Default": { - "put": { - "x-ms-long-running-operation": true, - "tags": [ - "SecurityAlertPolicy" - ], - "operationId": "SecurityAlertPolicy_CreateOrUpdate", - "description": "Creates or updates an Azure SQL Server security alert policy.", - "parameters": [ - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ServerSecurityAlertPolicyCreateOrUpdateParameters" - }, - "description": "The required parameters for creating or updating a Azure SQL Server security alert policy." - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the Resource Group to which the server belongs." - }, - { - "name": "serverName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the Azure SQL Server." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The Server Threat Detection Policy", - "schema": { - "$ref": "#/definitions/ServerSecurityAlertPolicy" - } - }, - "201": { - "description": "The Server Threat Detection Policy", - "schema": { - "$ref": "#/definitions/ServerSecurityAlertPolicy" - } - } - } - }, - "get": { - "tags": [ - "SecurityAlertPolicy" - ], - "operationId": "SecurityAlertPolicy_Get", - "description": "Returns an Azure SQL Server security alert policy.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the Resource Group to which the server belongs." - }, - { - "name": "serverName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the Azure SQL Server." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The Server Threat Detection Policy", - "schema": { - "$ref": "#/definitions/ServerSecurityAlertPolicy" - } - } - } - } - } - }, - "definitions": { - "ServerSecurityAlertPolicyProperties": { - "properties": { - "state": { - "readOnly": true, - "type": "string", - "description": "The state of the Azure SQL Security alert policy (New, Enabled or Disabled).", - "enum": [ - "Enabled", - "Disabled", - "New" - ], - "x-ms-enum": { - "name": "State", - "modelAsString": false - } - }, - "disabledAlerts": { - "readOnly": true, - "type": "string", - "description": "The disable alerts of the Azure SQL Security alert policy." - }, - "emailAddresses": { - "readOnly": true, - "type": "string", - "description": "The list of email addresses to send the alert." - }, - "emailAccountAdmins": { - "readOnly": true, - "type": "string", - "description": "Value that indicated whether to email the azure account admins.", - "enum": [ - "Enabled", - "Disabled" - ], - "x-ms-enum": { - "name": "EmailAccountAdmins", - "modelAsString": false - } - } - }, - "description": "Represents the properties of an Azure SQL Security alert policy." - }, - "ServerSecurityAlertPolicyCreateOrUpdateParameters": { - "x-ms-azure-resource": true, - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ServerSecurityAlertPolicyProperties", - "description": "Properties of the request." - } - }, - "required": [ - "properties" - ], - "description": "Create or update server security alert policy parameters." - }, - "ServerSecurityAlertPolicy": { - "x-ms-azure-resource": true, - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ServerSecurityAlertPolicyProperties", - "description": "Represents the properties of the resource." - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "Represents an Azure SQL Server Security Alert Policy." - }, - "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-azure-resource": true - } - }, - "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "The subscription credentials which uniquely identify Microsoft Azure subscription." - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "Client Api Version." - } - } +{ + "swagger": "2.0", + "info": { + "title": "SqlManagementClient", + "description": "The Azure SQL Database management API provides a RESTful set of web services that interact with Azure SQL Database services to manage your databases. The API enables users to create, retrieve, update, and delete Databases, Servers and related resources.", + "version": "2015-05-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json", + "text/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/securityAlertPolicies/Default": { + "put": { + "x-ms-long-running-operation": true, + "tags": [ + "SecurityAlertPolicy" + ], + "operationId": "SecurityAlertPolicy_CreateOrUpdate", + "description": "Creates or updates an Azure SQL Server security alert policy.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ServerSecurityAlertPolicyCreateOrUpdateParameters" + }, + "description": "The required parameters for creating or updating a Azure SQL Server security alert policy." + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Resource Group to which the server belongs." + }, + { + "name": "serverName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure SQL Server." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The Server Threat Detection Policy", + "schema": { + "$ref": "#/definitions/ServerSecurityAlertPolicy" + } + }, + "201": { + "description": "The Server Threat Detection Policy", + "schema": { + "$ref": "#/definitions/ServerSecurityAlertPolicy" + } + } + } + }, + "get": { + "tags": [ + "SecurityAlertPolicy" + ], + "operationId": "SecurityAlertPolicy_Get", + "description": "Returns an Azure SQL Server security alert policy.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Resource Group to which the server belongs." + }, + { + "name": "serverName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure SQL Server." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The Server Threat Detection Policy", + "schema": { + "$ref": "#/definitions/ServerSecurityAlertPolicy" + } + } + } + } + } + }, + "definitions": { + "ServerSecurityAlertPolicyProperties": { + "properties": { + "state": { + "readOnly": true, + "type": "string", + "description": "The state of the Azure SQL Security alert policy (New, Enabled or Disabled).", + "enum": [ + "Enabled", + "Disabled", + "New" + ], + "x-ms-enum": { + "name": "State", + "modelAsString": false + } + }, + "disabledAlerts": { + "readOnly": true, + "type": "string", + "description": "The disable alerts of the Azure SQL Security alert policy." + }, + "emailAddresses": { + "readOnly": true, + "type": "string", + "description": "The list of email addresses to send the alert." + }, + "emailAccountAdmins": { + "readOnly": true, + "type": "string", + "description": "Value that indicated whether to email the azure account admins.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "EmailAccountAdmins", + "modelAsString": false + } + } + }, + "description": "Represents the properties of an Azure SQL Security alert policy." + }, + "ServerSecurityAlertPolicyCreateOrUpdateParameters": { + "x-ms-azure-resource": true, + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ServerSecurityAlertPolicyProperties", + "description": "Properties of the request." + } + }, + "required": [ + "properties" + ], + "description": "Create or update server security alert policy parameters." + }, + "ServerSecurityAlertPolicy": { + "x-ms-azure-resource": true, + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ServerSecurityAlertPolicyProperties", + "description": "Represents the properties of the resource." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Represents an Azure SQL Server Security Alert Policy." + }, + "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-azure-resource": true + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription credentials which uniquely identify Microsoft Azure subscription." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + } + } } \ No newline at end of file diff --git a/arm-storage/2015-05-01-preview/swagger/storage.json b/arm-storage/2015-05-01-preview/swagger/storage.json index 65c97a8a7876..478e2eebab89 100644 --- a/arm-storage/2015-05-01-preview/swagger/storage.json +++ b/arm-storage/2015-05-01-preview/swagger/storage.json @@ -1,821 +1,821 @@ -{ - "swagger": "2.0", - "info": { - "title": "StorageManagementClient", - "description": "The Storage Management Client.", - "version": "2015-05-01-preview" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json", - "text/json" - ], - "produces": [ - "application/json", - "text/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/providers/Microsoft.Storage/checkNameAvailability": { - "post": { - "tags": [ - "StorageAccounts" - ], - "operationId": "StorageAccounts_CheckNameAvailability", - "description": "Checks that account name is valid and is not in use.", - "parameters": [ - { - "name": "accountName", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/StorageAccountCheckNameAvailabilityParameters" - }, - "description": "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. " - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/CheckNameAvailabilityResult" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}": { - "put": { - "tags": [ - "StorageAccounts" - ], - "operationId": "StorageAccounts_Create", - "description": "Asynchronously creates a new storage account with the specified parameters. Existing accounts cannot be updated with this API and should instead use the Update Storage Account API. If an account is already created and subsequent PUT request is issued with exact same set of properties, then HTTP 200 would be returned. ", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group within the user's subscription." - }, - { - "name": "accountName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. " - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/StorageAccountCreateParameters" - }, - "description": "The parameters to provide for the created account." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/StorageAccount" - } - }, - "202": { - "description": "" - } - }, - "x-ms-long-running-operation": true - }, - "delete": { - "tags": [ - "StorageAccounts" - ], - "operationId": "StorageAccounts_Delete", - "description": "Deletes a storage account in Microsoft Azure.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group within the user's subscription." - }, - { - "name": "accountName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. " - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "" - }, - "204": { - "description": "" - } - } - }, - "get": { - "tags": [ - "StorageAccounts" - ], - "operationId": "StorageAccounts_GetProperties", - "description": "Returns the properties for the specified storage account including but not limited to name, account type, location, and account status. The ListKeys operation should be used to retrieve storage keys.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group within the user's subscription." - }, - { - "name": "accountName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. " - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/StorageAccount" - } - } - } - }, - "patch": { - "tags": [ - "StorageAccounts" - ], - "operationId": "StorageAccounts_Update", - "description": "Updates the account type or tags for a storage account. It can also be used to add a custom domain (note that custom domains cannot be added via the Create operation). Only one custom domain is supported per storage account. This API can only be used to update one of tags, accountType, or customDomain per call. To update multiple of these properties, call the API multiple times with one change per call. This call does not change the storage keys for the account. If you want to change storage account keys, use the RegenerateKey operation. The location and name of the storage account cannot be changed after creation.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group within the user's subscription." - }, - { - "name": "accountName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. " - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/StorageAccountUpdateParameters" - }, - "description": "The parameters to update on the account. Note that only one property can be changed at a time using this API. " - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/StorageAccount" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/listKeys": { - "post": { - "tags": [ - "StorageAccounts" - ], - "operationId": "StorageAccounts_ListKeys", - "description": "Lists the access keys for the specified storage account.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "accountName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the storage account." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/StorageAccountKeys" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Storage/storageAccounts": { - "get": { - "tags": [ - "StorageAccounts" - ], - "operationId": "StorageAccounts_List", - "description": "Lists all the storage accounts available under the subscription. Note that storage keys are not returned; use the ListKeys operation for this.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/StorageAccountListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts": { - "get": { - "tags": [ - "StorageAccounts" - ], - "operationId": "StorageAccounts_ListByResourceGroup", - "description": "Lists all the storage accounts available under the given resource group. Note that storage keys are not returned; use the ListKeys operation for this.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group within the user's subscription." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/StorageAccountListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/regenerateKey": { - "post": { - "tags": [ - "StorageAccounts" - ], - "operationId": "StorageAccounts_RegenerateKey", - "description": "Regenerates the access keys for the specified storage account.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group within the user's subscription." - }, - { - "name": "accountName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. " - }, - { - "name": "regenerateKey", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/StorageAccountRegenerateKeyParameters" - }, - "description": "Specifies name of the key which should be regenerated." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/StorageAccountKeys" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Storage/usages": { - "get": { - "tags": [ - "Usage" - ], - "operationId": "Usage_List", - "description": "Gets the current usage count and the limit for the resources under the subscription.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/UsageListResult" - } - } - } - } - } - }, - "definitions": { - "StorageAccountCheckNameAvailabilityParameters": { - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string" - } - } - }, - "CheckNameAvailabilityResult": { - "properties": { - "nameAvailable": { - "type": "boolean", - "description": "Gets a boolean value that indicates whether the name is available for you to use. If true, the name is available. If false, the name has already been taken or invalid and cannot be used." - }, - "reason": { - "type": "string", - "description": "Gets the reason that a storage account name could not be used. The Reason element is only returned if NameAvailable is false.", - "enum": [ - "AccountNameInvalid", - "AlreadyExists" - ], - "x-ms-enum": { - "name": "Reason", - "modelAsString": false - } - }, - "message": { - "type": "string", - "description": "Gets an error message explaining the Reason value in more detail." - } - }, - "description": "The CheckNameAvailability operation response." - }, - "StorageAccountPropertiesCreateParameters": { - "properties": { - "accountType": { - "type": "string", - "description": "Gets or sets the account type.", - "enum": [ - "Standard_LRS", - "Standard_ZRS", - "Standard_GRS", - "Standard_RAGRS", - "Premium_LRS" - ], - "x-ms-enum": { - "name": "AccountType", - "modelAsString": false - } - } - } - }, - "StorageAccountCreateParameters": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/StorageAccountPropertiesCreateParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "The parameters to provide for the account." - }, - "Endpoints": { - "properties": { - "blob": { - "type": "string", - "description": "Gets the blob endpoint." - }, - "queue": { - "type": "string", - "description": "Gets the queue endpoint." - }, - "table": { - "type": "string", - "description": "Gets the table endpoint." - } - }, - "description": "The URIs that are used to perform a retrieval of a public blob, queue or table object." - }, - "CustomDomain": { - "properties": { - "name": { - "type": "string", - "description": "Gets or sets the custom domain name. Name is the CNAME source." - }, - "useSubDomain": { - "type": "boolean", - "description": "Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates" - } - }, - "description": "The custom domain assigned to this storage account. This can be set via Update." - }, - "StorageAccountProperties": { - "properties": { - "provisioningState": { - "type": "string", - "description": "Gets the status of the storage account at the time the operation was called.", - "enum": [ - "Creating", - "ResolvingDNS", - "Succeeded" - ], - "x-ms-enum": { - "name": "ProvisioningState", - "modelAsString": false - } - }, - "accountType": { - "type": "string", - "description": "Gets the type of the storage account.", - "enum": [ - "Standard_LRS", - "Standard_ZRS", - "Standard_GRS", - "Standard_RAGRS", - "Premium_LRS" - ], - "x-ms-enum": { - "name": "AccountType", - "modelAsString": false - } - }, - "primaryEndpoints": { - "$ref": "#/definitions/Endpoints", - "description": "Gets the URLs that are used to perform a retrieval of a public blob, queue or table object.Note that StandardZRS and PremiumLRS accounts only return the blob endpoint." - }, - "primaryLocation": { - "type": "string", - "description": "Gets the location of the primary for the storage account." - }, - "statusOfPrimary": { - "type": "string", - "description": "Gets the status indicating whether the primary location of the storage account is available or unavailable.", - "enum": [ - "Available", - "Unavailable" - ], - "x-ms-enum": { - "name": "AccountStatus", - "modelAsString": false - } - }, - "lastGeoFailoverTime": { - "type": "string", - "format": "date-time", - "description": "Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if the accountType is StandardGRS or StandardRAGRS." - }, - "secondaryLocation": { - "type": "string", - "description": "Gets the location of the geo replicated secondary for the storage account. Only available if the accountType is StandardGRS or StandardRAGRS." - }, - "statusOfSecondary": { - "type": "string", - "description": "Gets the status indicating whether the secondary location of the storage account is available or unavailable. Only available if the accountType is StandardGRS or StandardRAGRS.", - "enum": [ - "Available", - "Unavailable" - ], - "x-ms-enum": { - "name": "AccountStatus", - "modelAsString": false - } - }, - "creationTime": { - "type": "string", - "format": "date-time", - "description": "Gets the creation date and time of the storage account in UTC." - }, - "customDomain": { - "$ref": "#/definitions/CustomDomain", - "description": "Gets the user assigned custom domain assigned to this storage account." - }, - "secondaryEndpoints": { - "$ref": "#/definitions/Endpoints", - "description": "Gets the URLs that are used to perform a retrieval of a public blob, queue or table object from the secondary location of the storage account. Only available if the accountType is StandardRAGRS." - } - } - }, - "StorageAccount": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/StorageAccountProperties" - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "The storage account." - }, - "StorageAccountKeys": { - "properties": { - "key1": { - "type": "string", - "description": "Gets the value of key 1." - }, - "key2": { - "type": "string", - "description": "Gets the value of key 2." - } - }, - "description": "The access keys for the storage account." - }, - "StorageAccountListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/StorageAccount" - }, - "description": "Gets the list of storage accounts and their properties." - }, - "nextLink": { - "type": "string", - "description": "Gets the link to the next set of results. Currently this will always be empty as the API does not support pagination." - } - }, - "description": "The list storage accounts operation response." - }, - "StorageAccountPropertiesUpdateParameters": { - "properties": { - "accountType": { - "type": "string", - "description": "Gets or sets the account type. Note that StandardZRS and PremiumLRS accounts cannot be changed to other account types, and other account types cannot be changed to StandardZRS or PremiumLRS.", - "enum": [ - "Standard_LRS", - "Standard_ZRS", - "Standard_GRS", - "Standard_RAGRS", - "Premium_LRS" - ], - "x-ms-enum": { - "name": "AccountType", - "modelAsString": false - } - }, - "customDomain": { - "$ref": "#/definitions/CustomDomain", - "description": "User domain assigned to the storage account. Name is the CNAME source. Only one custom domain is supported per storage account at this time. To clear the existing custom domain, use an empty string for the custom domain name property." - } - } - }, - "StorageAccountUpdateParameters": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/StorageAccountPropertiesUpdateParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "The parameters to update on the account." - }, - "StorageAccountRegenerateKeyParameters": { - "properties": { - "keyName": { - "type": "string", - "enum": [ - "key1", - "key2" - ], - "x-ms-enum": { - "name": "KeyName", - "modelAsString": false - } - } - } - }, - "UsageName": { - "properties": { - "value": { - "type": "string", - "description": "Gets a string describing the resource name." - }, - "localizedValue": { - "type": "string", - "description": "Gets a localized string describing the resource name." - } - }, - "description": "The Usage Names." - }, - "Usage": { - "properties": { - "unit": { - "type": "string", - "description": "Gets the unit of measurement.", - "enum": [ - "Count", - "Bytes", - "Seconds", - "Percent", - "CountsPerSecond", - "BytesPerSecond" - ], - "x-ms-enum": { - "name": "UsageUnit", - "modelAsString": false - } - }, - "currentValue": { - "type": "integer", - "format": "int32", - "description": "Gets the current count of the allocated resources in the subscription." - }, - "limit": { - "type": "integer", - "format": "int32", - "description": "Gets the maximum count of the resources that can be allocated in the subscription." - }, - "name": { - "$ref": "#/definitions/UsageName", - "description": "Gets the name of the type of usage." - } - }, - "description": "Describes Storage Resource Usage." - }, - "UsageListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Usage" - }, - "description": "Gets or sets the list Storage Resource Usages." - } - }, - "description": "The List Usages operation response." - }, - "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-azure-resource": true - }, - "SubResource": { - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - } - }, - "x-ms-azure-resource": 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." - } - } +{ + "swagger": "2.0", + "info": { + "title": "StorageManagementClient", + "description": "The Storage Management Client.", + "version": "2015-05-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json", + "text/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Storage/checkNameAvailability": { + "post": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_CheckNameAvailability", + "description": "Checks that account name is valid and is not in use.", + "parameters": [ + { + "name": "accountName", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StorageAccountCheckNameAvailabilityParameters" + }, + "description": "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. " + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}": { + "put": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_Create", + "description": "Asynchronously creates a new storage account with the specified parameters. Existing accounts cannot be updated with this API and should instead use the Update Storage Account API. If an account is already created and subsequent PUT request is issued with exact same set of properties, then HTTP 200 would be returned. ", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the user's subscription." + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. " + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StorageAccountCreateParameters" + }, + "description": "The parameters to provide for the created account." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/StorageAccount" + } + }, + "202": { + "description": "" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_Delete", + "description": "Deletes a storage account in Microsoft Azure.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the user's subscription." + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. " + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "" + }, + "204": { + "description": "" + } + } + }, + "get": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_GetProperties", + "description": "Returns the properties for the specified storage account including but not limited to name, account type, location, and account status. The ListKeys operation should be used to retrieve storage keys.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the user's subscription." + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. " + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/StorageAccount" + } + } + } + }, + "patch": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_Update", + "description": "Updates the account type or tags for a storage account. It can also be used to add a custom domain (note that custom domains cannot be added via the Create operation). Only one custom domain is supported per storage account. This API can only be used to update one of tags, accountType, or customDomain per call. To update multiple of these properties, call the API multiple times with one change per call. This call does not change the storage keys for the account. If you want to change storage account keys, use the RegenerateKey operation. The location and name of the storage account cannot be changed after creation.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the user's subscription." + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. " + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StorageAccountUpdateParameters" + }, + "description": "The parameters to update on the account. Note that only one property can be changed at a time using this API. " + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/StorageAccount" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/listKeys": { + "post": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_ListKeys", + "description": "Lists the access keys for the specified storage account.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the storage account." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/StorageAccountKeys" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Storage/storageAccounts": { + "get": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_List", + "description": "Lists all the storage accounts available under the subscription. Note that storage keys are not returned; use the ListKeys operation for this.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/StorageAccountListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts": { + "get": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_ListByResourceGroup", + "description": "Lists all the storage accounts available under the given resource group. Note that storage keys are not returned; use the ListKeys operation for this.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the user's subscription." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/StorageAccountListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/regenerateKey": { + "post": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_RegenerateKey", + "description": "Regenerates the access keys for the specified storage account.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the user's subscription." + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. " + }, + { + "name": "regenerateKey", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StorageAccountRegenerateKeyParameters" + }, + "description": "Specifies name of the key which should be regenerated." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/StorageAccountKeys" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Storage/usages": { + "get": { + "tags": [ + "Usage" + ], + "operationId": "Usage_List", + "description": "Gets the current usage count and the limit for the resources under the subscription.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/UsageListResult" + } + } + } + } + } + }, + "definitions": { + "StorageAccountCheckNameAvailabilityParameters": { + "properties": { + "name": { + "type": "string" + }, + "type": { + "type": "string" + } + } + }, + "CheckNameAvailabilityResult": { + "properties": { + "nameAvailable": { + "type": "boolean", + "description": "Gets a boolean value that indicates whether the name is available for you to use. If true, the name is available. If false, the name has already been taken or invalid and cannot be used." + }, + "reason": { + "type": "string", + "description": "Gets the reason that a storage account name could not be used. The Reason element is only returned if NameAvailable is false.", + "enum": [ + "AccountNameInvalid", + "AlreadyExists" + ], + "x-ms-enum": { + "name": "Reason", + "modelAsString": false + } + }, + "message": { + "type": "string", + "description": "Gets an error message explaining the Reason value in more detail." + } + }, + "description": "The CheckNameAvailability operation response." + }, + "StorageAccountPropertiesCreateParameters": { + "properties": { + "accountType": { + "type": "string", + "description": "Gets or sets the account type.", + "enum": [ + "Standard_LRS", + "Standard_ZRS", + "Standard_GRS", + "Standard_RAGRS", + "Premium_LRS" + ], + "x-ms-enum": { + "name": "AccountType", + "modelAsString": false + } + } + } + }, + "StorageAccountCreateParameters": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/StorageAccountPropertiesCreateParameters" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "The parameters to provide for the account." + }, + "Endpoints": { + "properties": { + "blob": { + "type": "string", + "description": "Gets the blob endpoint." + }, + "queue": { + "type": "string", + "description": "Gets the queue endpoint." + }, + "table": { + "type": "string", + "description": "Gets the table endpoint." + } + }, + "description": "The URIs that are used to perform a retrieval of a public blob, queue or table object." + }, + "CustomDomain": { + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the custom domain name. Name is the CNAME source." + }, + "useSubDomain": { + "type": "boolean", + "description": "Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates" + } + }, + "description": "The custom domain assigned to this storage account. This can be set via Update." + }, + "StorageAccountProperties": { + "properties": { + "provisioningState": { + "type": "string", + "description": "Gets the status of the storage account at the time the operation was called.", + "enum": [ + "Creating", + "ResolvingDNS", + "Succeeded" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": false + } + }, + "accountType": { + "type": "string", + "description": "Gets the type of the storage account.", + "enum": [ + "Standard_LRS", + "Standard_ZRS", + "Standard_GRS", + "Standard_RAGRS", + "Premium_LRS" + ], + "x-ms-enum": { + "name": "AccountType", + "modelAsString": false + } + }, + "primaryEndpoints": { + "$ref": "#/definitions/Endpoints", + "description": "Gets the URLs that are used to perform a retrieval of a public blob, queue or table object.Note that StandardZRS and PremiumLRS accounts only return the blob endpoint." + }, + "primaryLocation": { + "type": "string", + "description": "Gets the location of the primary for the storage account." + }, + "statusOfPrimary": { + "type": "string", + "description": "Gets the status indicating whether the primary location of the storage account is available or unavailable.", + "enum": [ + "Available", + "Unavailable" + ], + "x-ms-enum": { + "name": "AccountStatus", + "modelAsString": false + } + }, + "lastGeoFailoverTime": { + "type": "string", + "format": "date-time", + "description": "Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if the accountType is StandardGRS or StandardRAGRS." + }, + "secondaryLocation": { + "type": "string", + "description": "Gets the location of the geo replicated secondary for the storage account. Only available if the accountType is StandardGRS or StandardRAGRS." + }, + "statusOfSecondary": { + "type": "string", + "description": "Gets the status indicating whether the secondary location of the storage account is available or unavailable. Only available if the accountType is StandardGRS or StandardRAGRS.", + "enum": [ + "Available", + "Unavailable" + ], + "x-ms-enum": { + "name": "AccountStatus", + "modelAsString": false + } + }, + "creationTime": { + "type": "string", + "format": "date-time", + "description": "Gets the creation date and time of the storage account in UTC." + }, + "customDomain": { + "$ref": "#/definitions/CustomDomain", + "description": "Gets the user assigned custom domain assigned to this storage account." + }, + "secondaryEndpoints": { + "$ref": "#/definitions/Endpoints", + "description": "Gets the URLs that are used to perform a retrieval of a public blob, queue or table object from the secondary location of the storage account. Only available if the accountType is StandardRAGRS." + } + } + }, + "StorageAccount": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/StorageAccountProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "The storage account." + }, + "StorageAccountKeys": { + "properties": { + "key1": { + "type": "string", + "description": "Gets the value of key 1." + }, + "key2": { + "type": "string", + "description": "Gets the value of key 2." + } + }, + "description": "The access keys for the storage account." + }, + "StorageAccountListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/StorageAccount" + }, + "description": "Gets the list of storage accounts and their properties." + }, + "nextLink": { + "type": "string", + "description": "Gets the link to the next set of results. Currently this will always be empty as the API does not support pagination." + } + }, + "description": "The list storage accounts operation response." + }, + "StorageAccountPropertiesUpdateParameters": { + "properties": { + "accountType": { + "type": "string", + "description": "Gets or sets the account type. Note that StandardZRS and PremiumLRS accounts cannot be changed to other account types, and other account types cannot be changed to StandardZRS or PremiumLRS.", + "enum": [ + "Standard_LRS", + "Standard_ZRS", + "Standard_GRS", + "Standard_RAGRS", + "Premium_LRS" + ], + "x-ms-enum": { + "name": "AccountType", + "modelAsString": false + } + }, + "customDomain": { + "$ref": "#/definitions/CustomDomain", + "description": "User domain assigned to the storage account. Name is the CNAME source. Only one custom domain is supported per storage account at this time. To clear the existing custom domain, use an empty string for the custom domain name property." + } + } + }, + "StorageAccountUpdateParameters": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/StorageAccountPropertiesUpdateParameters" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "The parameters to update on the account." + }, + "StorageAccountRegenerateKeyParameters": { + "properties": { + "keyName": { + "type": "string", + "enum": [ + "key1", + "key2" + ], + "x-ms-enum": { + "name": "KeyName", + "modelAsString": false + } + } + } + }, + "UsageName": { + "properties": { + "value": { + "type": "string", + "description": "Gets a string describing the resource name." + }, + "localizedValue": { + "type": "string", + "description": "Gets a localized string describing the resource name." + } + }, + "description": "The Usage Names." + }, + "Usage": { + "properties": { + "unit": { + "type": "string", + "description": "Gets the unit of measurement.", + "enum": [ + "Count", + "Bytes", + "Seconds", + "Percent", + "CountsPerSecond", + "BytesPerSecond" + ], + "x-ms-enum": { + "name": "UsageUnit", + "modelAsString": false + } + }, + "currentValue": { + "type": "integer", + "format": "int32", + "description": "Gets the current count of the allocated resources in the subscription." + }, + "limit": { + "type": "integer", + "format": "int32", + "description": "Gets the maximum count of the resources that can be allocated in the subscription." + }, + "name": { + "$ref": "#/definitions/UsageName", + "description": "Gets the name of the type of usage." + } + }, + "description": "Describes Storage Resource Usage." + }, + "UsageListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Usage" + }, + "description": "Gets or sets the list Storage Resource Usages." + } + }, + "description": "The List Usages operation response." + }, + "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-azure-resource": true + }, + "SubResource": { + "properties": { + "id": { + "type": "string", + "description": "Resource Id" + } + }, + "x-ms-azure-resource": 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." + } + } } \ No newline at end of file diff --git a/arm-storage/2015-06-15/swagger/storage.json b/arm-storage/2015-06-15/swagger/storage.json index fc7c3c052e7f..661ea49d67ab 100644 --- a/arm-storage/2015-06-15/swagger/storage.json +++ b/arm-storage/2015-06-15/swagger/storage.json @@ -1,848 +1,848 @@ -{ - "swagger": "2.0", - "info": { - "title": "StorageManagementClient", - "description": "The Storage Management Client.", - "version": "2015-06-15" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json", - "text/json" - ], - "produces": [ - "application/json", - "text/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/providers/Microsoft.Storage/checkNameAvailability": { - "post": { - "tags": [ - "StorageAccounts" - ], - "operationId": "StorageAccounts_CheckNameAvailability", - "description": "Checks that account name is valid and is not in use.", - "parameters": [ - { - "name": "accountName", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/StorageAccountCheckNameAvailabilityParameters" - }, - "description": "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/CheckNameAvailabilityResult" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}": { - "put": { - "tags": [ - "StorageAccounts" - ], - "operationId": "StorageAccounts_Create", - "description": "Asynchronously creates a new storage account with the specified parameters. Existing accounts cannot be updated with this API and should instead use the Update Storage Account API. If an account is already created and subsequent PUT request is issued with exact same set of properties, then HTTP 200 would be returned. ", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group within the user's subscription." - }, - { - "name": "accountName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. ", - "maxLength": 24, - "minLength": 3 - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/StorageAccountCreateParameters" - }, - "description": "The parameters to provide for the created account." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/StorageAccount" - } - }, - "202": { - "description": "" - } - }, - "x-ms-long-running-operation": true - }, - "delete": { - "tags": [ - "StorageAccounts" - ], - "operationId": "StorageAccounts_Delete", - "description": "Deletes a storage account in Microsoft Azure.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group within the user's subscription." - }, - { - "name": "accountName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. ", - "maxLength": 24, - "minLength": 3 - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "" - }, - "204": { - "description": "" - } - } - }, - "get": { - "tags": [ - "StorageAccounts" - ], - "operationId": "StorageAccounts_GetProperties", - "description": "Returns the properties for the specified storage account including but not limited to name, account type, location, and account status. The ListKeys operation should be used to retrieve storage keys.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group within the user's subscription." - }, - { - "name": "accountName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. ", - "maxLength": 24, - "minLength": 3 - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/StorageAccount" - } - } - } - }, - "patch": { - "tags": [ - "StorageAccounts" - ], - "operationId": "StorageAccounts_Update", - "description": "Updates the account type or tags for a storage account. It can also be used to add a custom domain (note that custom domains cannot be added via the Create operation). Only one custom domain is supported per storage account. In order to replace a custom domain, the old value must be cleared before a new value may be set. To clear a custom domain, simply update the custom domain with empty string. Then call update again with the new cutsom domain name. The update API can only be used to update one of tags, accountType, or customDomain per call. To update multiple of these properties, call the API multiple times with one change per call. This call does not change the storage keys for the account. If you want to change storage account keys, use the RegenerateKey operation. The location and name of the storage account cannot be changed after creation.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group within the user's subscription." - }, - { - "name": "accountName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. ", - "maxLength": 24, - "minLength": 3 - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/StorageAccountUpdateParameters" - }, - "description": "The parameters to update on the account. Note that only one property can be changed at a time using this API. " - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/StorageAccount" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/listKeys": { - "post": { - "tags": [ - "StorageAccounts" - ], - "operationId": "StorageAccounts_ListKeys", - "description": "Lists the access keys for the specified storage account.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "accountName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the storage account.", - "maxLength": 24, - "minLength": 3 - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/StorageAccountKeys" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Storage/storageAccounts": { - "get": { - "tags": [ - "StorageAccounts" - ], - "operationId": "StorageAccounts_List", - "description": "Lists all the storage accounts available under the subscription. Note that storage keys are not returned; use the ListKeys operation for this.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/StorageAccountListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts": { - "get": { - "tags": [ - "StorageAccounts" - ], - "operationId": "StorageAccounts_ListByResourceGroup", - "description": "Lists all the storage accounts available under the given resource group. Note that storage keys are not returned; use the ListKeys operation for this.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group within the user's subscription." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/StorageAccountListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/regenerateKey": { - "post": { - "tags": [ - "StorageAccounts" - ], - "operationId": "StorageAccounts_RegenerateKey", - "description": "Regenerates the access keys for the specified storage account.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group within the user's subscription." - }, - { - "name": "accountName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. ", - "maxLength": 24, - "minLength": 3 - }, - { - "name": "regenerateKey", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/StorageAccountRegenerateKeyParameters" - }, - "description": "Specifies name of the key which should be regenerated. key1 or key2 for the default keys" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/StorageAccountKeys" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Storage/usages": { - "get": { - "tags": [ - "Usage" - ], - "operationId": "Usage_List", - "description": "Gets the current usage count and the limit for the resources under the subscription.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/UsageListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - } - } - } - }, - "definitions": { - "StorageAccountCheckNameAvailabilityParameters": { - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "default": "Microsoft.Storage/storageAccounts" - } - }, - "required": [ - "name" - ] - }, - "CheckNameAvailabilityResult": { - "properties": { - "nameAvailable": { - "type": "boolean", - "description": "Gets a boolean value that indicates whether the name is available for you to use. If true, the name is available. If false, the name has already been taken or invalid and cannot be used." - }, - "reason": { - "type": "string", - "description": "Gets the reason that a storage account name could not be used. The Reason element is only returned if NameAvailable is false.", - "enum": [ - "AccountNameInvalid", - "AlreadyExists" - ], - "x-ms-enum": { - "name": "Reason", - "modelAsString": false - } - }, - "message": { - "type": "string", - "description": "Gets an error message explaining the Reason value in more detail." - } - }, - "description": "The CheckNameAvailability operation response." - }, - "StorageAccountPropertiesCreateParameters": { - "properties": { - "accountType": { - "type": "string", - "description": "Gets or sets the account type.", - "enum": [ - "Standard_LRS", - "Standard_ZRS", - "Standard_GRS", - "Standard_RAGRS", - "Premium_LRS" - ], - "x-ms-enum": { - "name": "AccountType", - "modelAsString": false - } - } - }, - "required": [ - "accountType" - ] - }, - "StorageAccountCreateParameters": { - "properties": { - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Resource tags" - }, - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/StorageAccountPropertiesCreateParameters" - } - }, - "required": [ - "location" - ], - "x-ms-azure-resource": true, - "description": "The parameters to provide for the account." - }, - "Endpoints": { - "properties": { - "blob": { - "type": "string", - "description": "Gets the blob endpoint." - }, - "queue": { - "type": "string", - "description": "Gets the queue endpoint." - }, - "table": { - "type": "string", - "description": "Gets the table endpoint." - }, - "file": { - "type": "string", - "description": "Gets the file endpoint." - } - }, - "description": "The URIs that are used to perform a retrieval of a public blob, queue or table object." - }, - "CustomDomain": { - "properties": { - "name": { - "type": "string", - "description": "Gets or sets the custom domain name. Name is the CNAME source." - }, - "useSubDomain": { - "type": "boolean", - "description": "Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates" - } - }, - "required": [ - "name" - ], - "description": "The custom domain assigned to this storage account. This can be set via Update." - }, - "StorageAccountProperties": { - "properties": { - "provisioningState": { - "type": "string", - "description": "Gets the status of the storage account at the time the operation was called.", - "enum": [ - "Creating", - "ResolvingDNS", - "Succeeded" - ], - "x-ms-enum": { - "name": "ProvisioningState", - "modelAsString": false - } - }, - "accountType": { - "type": "string", - "description": "Gets the type of the storage account.", - "enum": [ - "Standard_LRS", - "Standard_ZRS", - "Standard_GRS", - "Standard_RAGRS", - "Premium_LRS" - ], - "x-ms-enum": { - "name": "AccountType", - "modelAsString": false - } - }, - "primaryEndpoints": { - "$ref": "#/definitions/Endpoints", - "description": "Gets the URLs that are used to perform a retrieval of a public blob, queue or table object.Note that StandardZRS and PremiumLRS accounts only return the blob endpoint." - }, - "primaryLocation": { - "type": "string", - "description": "Gets the location of the primary for the storage account." - }, - "statusOfPrimary": { - "type": "string", - "description": "Gets the status indicating whether the primary location of the storage account is available or unavailable.", - "enum": [ - "Available", - "Unavailable" - ], - "x-ms-enum": { - "name": "AccountStatus", - "modelAsString": false - } - }, - "lastGeoFailoverTime": { - "type": "string", - "format": "date-time", - "description": "Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if the accountType is StandardGRS or StandardRAGRS." - }, - "secondaryLocation": { - "type": "string", - "description": "Gets the location of the geo replicated secondary for the storage account. Only available if the accountType is StandardGRS or StandardRAGRS." - }, - "statusOfSecondary": { - "type": "string", - "description": "Gets the status indicating whether the secondary location of the storage account is available or unavailable. Only available if the accountType is StandardGRS or StandardRAGRS.", - "enum": [ - "Available", - "Unavailable" - ], - "x-ms-enum": { - "name": "AccountStatus", - "modelAsString": false - } - }, - "creationTime": { - "type": "string", - "format": "date-time", - "description": "Gets the creation date and time of the storage account in UTC." - }, - "customDomain": { - "$ref": "#/definitions/CustomDomain", - "description": "Gets the user assigned custom domain assigned to this storage account." - }, - "secondaryEndpoints": { - "$ref": "#/definitions/Endpoints", - "description": "Gets the URLs that are used to perform a retrieval of a public blob, queue or table object from the secondary location of the storage account. Only available if the accountType is StandardRAGRS." - } - } - }, - "StorageAccount": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/StorageAccountProperties" - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "The storage account." - }, - "StorageAccountKeys": { - "properties": { - "key1": { - "type": "string", - "description": "Gets the value of key 1." - }, - "key2": { - "type": "string", - "description": "Gets the value of key 2." - } - }, - "description": "The access keys for the storage account." - }, - "StorageAccountListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/StorageAccount" - }, - "description": "Gets the list of storage accounts and their properties." - } - }, - "description": "The list storage accounts operation response." - }, - "StorageAccountPropertiesUpdateParameters": { - "properties": { - "accountType": { - "type": "string", - "description": "Gets or sets the account type. Note that StandardZRS and PremiumLRS accounts cannot be changed to other account types, and other account types cannot be changed to StandardZRS or PremiumLRS.", - "enum": [ - "Standard_LRS", - "Standard_ZRS", - "Standard_GRS", - "Standard_RAGRS", - "Premium_LRS" - ], - "x-ms-enum": { - "name": "AccountType", - "modelAsString": false - } - }, - "customDomain": { - "$ref": "#/definitions/CustomDomain", - "description": "User domain assigned to the storage account. Name is the CNAME source. Only one custom domain is supported per storage account at this time. To clear the existing custom domain, use an empty string for the custom domain name property." - } - } - }, - "StorageAccountUpdateParameters": { - "properties": { - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Resource tags" - }, - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/StorageAccountPropertiesUpdateParameters" - } - }, - "x-ms-azure-resource": true, - "description": "The parameters to update on the account." - }, - "StorageAccountRegenerateKeyParameters": { - "properties": { - "keyName": { - "type": "string" - } - }, - "required": [ - "keyName" - ] - }, - "UsageName": { - "properties": { - "value": { - "type": "string", - "description": "Gets a string describing the resource name." - }, - "localizedValue": { - "type": "string", - "description": "Gets a localized string describing the resource name." - } - }, - "description": "The Usage Names." - }, - "Usage": { - "properties": { - "unit": { - "type": "string", - "description": "Gets the unit of measurement.", - "enum": [ - "Count", - "Bytes", - "Seconds", - "Percent", - "CountsPerSecond", - "BytesPerSecond" - ], - "x-ms-enum": { - "name": "UsageUnit", - "modelAsString": false - } - }, - "currentValue": { - "type": "integer", - "format": "int32", - "description": "Gets the current count of the allocated resources in the subscription." - }, - "limit": { - "type": "integer", - "format": "int32", - "description": "Gets the maximum count of the resources that can be allocated in the subscription." - }, - "name": { - "$ref": "#/definitions/UsageName", - "description": "Gets the name of the type of usage." - } - }, - "required": [ - "unit", - "currentValue", - "limit", - "name" - ], - "description": "Describes Storage Resource Usage." - }, - "UsageListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Usage" - }, - "description": "Gets or sets the list Storage Resource Usages." - } - }, - "description": "The List Usages operation response." - }, - "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" - } - }, - "x-ms-azure-resource": 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." - } - } +{ + "swagger": "2.0", + "info": { + "title": "StorageManagementClient", + "description": "The Storage Management Client.", + "version": "2015-06-15" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json", + "text/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Storage/checkNameAvailability": { + "post": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_CheckNameAvailability", + "description": "Checks that account name is valid and is not in use.", + "parameters": [ + { + "name": "accountName", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StorageAccountCheckNameAvailabilityParameters" + }, + "description": "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}": { + "put": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_Create", + "description": "Asynchronously creates a new storage account with the specified parameters. Existing accounts cannot be updated with this API and should instead use the Update Storage Account API. If an account is already created and subsequent PUT request is issued with exact same set of properties, then HTTP 200 would be returned. ", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the user's subscription." + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. ", + "maxLength": 24, + "minLength": 3 + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StorageAccountCreateParameters" + }, + "description": "The parameters to provide for the created account." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/StorageAccount" + } + }, + "202": { + "description": "" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_Delete", + "description": "Deletes a storage account in Microsoft Azure.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the user's subscription." + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. ", + "maxLength": 24, + "minLength": 3 + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "" + }, + "204": { + "description": "" + } + } + }, + "get": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_GetProperties", + "description": "Returns the properties for the specified storage account including but not limited to name, account type, location, and account status. The ListKeys operation should be used to retrieve storage keys.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the user's subscription." + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. ", + "maxLength": 24, + "minLength": 3 + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/StorageAccount" + } + } + } + }, + "patch": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_Update", + "description": "Updates the account type or tags for a storage account. It can also be used to add a custom domain (note that custom domains cannot be added via the Create operation). Only one custom domain is supported per storage account. In order to replace a custom domain, the old value must be cleared before a new value may be set. To clear a custom domain, simply update the custom domain with empty string. Then call update again with the new cutsom domain name. The update API can only be used to update one of tags, accountType, or customDomain per call. To update multiple of these properties, call the API multiple times with one change per call. This call does not change the storage keys for the account. If you want to change storage account keys, use the RegenerateKey operation. The location and name of the storage account cannot be changed after creation.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the user's subscription." + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. ", + "maxLength": 24, + "minLength": 3 + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StorageAccountUpdateParameters" + }, + "description": "The parameters to update on the account. Note that only one property can be changed at a time using this API. " + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/StorageAccount" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/listKeys": { + "post": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_ListKeys", + "description": "Lists the access keys for the specified storage account.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the storage account.", + "maxLength": 24, + "minLength": 3 + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/StorageAccountKeys" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Storage/storageAccounts": { + "get": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_List", + "description": "Lists all the storage accounts available under the subscription. Note that storage keys are not returned; use the ListKeys operation for this.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/StorageAccountListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts": { + "get": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_ListByResourceGroup", + "description": "Lists all the storage accounts available under the given resource group. Note that storage keys are not returned; use the ListKeys operation for this.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the user's subscription." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/StorageAccountListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/regenerateKey": { + "post": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_RegenerateKey", + "description": "Regenerates the access keys for the specified storage account.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the user's subscription." + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. ", + "maxLength": 24, + "minLength": 3 + }, + { + "name": "regenerateKey", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StorageAccountRegenerateKeyParameters" + }, + "description": "Specifies name of the key which should be regenerated. key1 or key2 for the default keys" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/StorageAccountKeys" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Storage/usages": { + "get": { + "tags": [ + "Usage" + ], + "operationId": "Usage_List", + "description": "Gets the current usage count and the limit for the resources under the subscription.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/UsageListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + } + }, + "definitions": { + "StorageAccountCheckNameAvailabilityParameters": { + "properties": { + "name": { + "type": "string" + }, + "type": { + "type": "string", + "default": "Microsoft.Storage/storageAccounts" + } + }, + "required": [ + "name" + ] + }, + "CheckNameAvailabilityResult": { + "properties": { + "nameAvailable": { + "type": "boolean", + "description": "Gets a boolean value that indicates whether the name is available for you to use. If true, the name is available. If false, the name has already been taken or invalid and cannot be used." + }, + "reason": { + "type": "string", + "description": "Gets the reason that a storage account name could not be used. The Reason element is only returned if NameAvailable is false.", + "enum": [ + "AccountNameInvalid", + "AlreadyExists" + ], + "x-ms-enum": { + "name": "Reason", + "modelAsString": false + } + }, + "message": { + "type": "string", + "description": "Gets an error message explaining the Reason value in more detail." + } + }, + "description": "The CheckNameAvailability operation response." + }, + "StorageAccountPropertiesCreateParameters": { + "properties": { + "accountType": { + "type": "string", + "description": "Gets or sets the account type.", + "enum": [ + "Standard_LRS", + "Standard_ZRS", + "Standard_GRS", + "Standard_RAGRS", + "Premium_LRS" + ], + "x-ms-enum": { + "name": "AccountType", + "modelAsString": false + } + } + }, + "required": [ + "accountType" + ] + }, + "StorageAccountCreateParameters": { + "properties": { + "location": { + "type": "string", + "description": "Resource location" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/StorageAccountPropertiesCreateParameters" + } + }, + "required": [ + "location" + ], + "x-ms-azure-resource": true, + "description": "The parameters to provide for the account." + }, + "Endpoints": { + "properties": { + "blob": { + "type": "string", + "description": "Gets the blob endpoint." + }, + "queue": { + "type": "string", + "description": "Gets the queue endpoint." + }, + "table": { + "type": "string", + "description": "Gets the table endpoint." + }, + "file": { + "type": "string", + "description": "Gets the file endpoint." + } + }, + "description": "The URIs that are used to perform a retrieval of a public blob, queue or table object." + }, + "CustomDomain": { + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the custom domain name. Name is the CNAME source." + }, + "useSubDomain": { + "type": "boolean", + "description": "Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates" + } + }, + "required": [ + "name" + ], + "description": "The custom domain assigned to this storage account. This can be set via Update." + }, + "StorageAccountProperties": { + "properties": { + "provisioningState": { + "type": "string", + "description": "Gets the status of the storage account at the time the operation was called.", + "enum": [ + "Creating", + "ResolvingDNS", + "Succeeded" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": false + } + }, + "accountType": { + "type": "string", + "description": "Gets the type of the storage account.", + "enum": [ + "Standard_LRS", + "Standard_ZRS", + "Standard_GRS", + "Standard_RAGRS", + "Premium_LRS" + ], + "x-ms-enum": { + "name": "AccountType", + "modelAsString": false + } + }, + "primaryEndpoints": { + "$ref": "#/definitions/Endpoints", + "description": "Gets the URLs that are used to perform a retrieval of a public blob, queue or table object.Note that StandardZRS and PremiumLRS accounts only return the blob endpoint." + }, + "primaryLocation": { + "type": "string", + "description": "Gets the location of the primary for the storage account." + }, + "statusOfPrimary": { + "type": "string", + "description": "Gets the status indicating whether the primary location of the storage account is available or unavailable.", + "enum": [ + "Available", + "Unavailable" + ], + "x-ms-enum": { + "name": "AccountStatus", + "modelAsString": false + } + }, + "lastGeoFailoverTime": { + "type": "string", + "format": "date-time", + "description": "Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if the accountType is StandardGRS or StandardRAGRS." + }, + "secondaryLocation": { + "type": "string", + "description": "Gets the location of the geo replicated secondary for the storage account. Only available if the accountType is StandardGRS or StandardRAGRS." + }, + "statusOfSecondary": { + "type": "string", + "description": "Gets the status indicating whether the secondary location of the storage account is available or unavailable. Only available if the accountType is StandardGRS or StandardRAGRS.", + "enum": [ + "Available", + "Unavailable" + ], + "x-ms-enum": { + "name": "AccountStatus", + "modelAsString": false + } + }, + "creationTime": { + "type": "string", + "format": "date-time", + "description": "Gets the creation date and time of the storage account in UTC." + }, + "customDomain": { + "$ref": "#/definitions/CustomDomain", + "description": "Gets the user assigned custom domain assigned to this storage account." + }, + "secondaryEndpoints": { + "$ref": "#/definitions/Endpoints", + "description": "Gets the URLs that are used to perform a retrieval of a public blob, queue or table object from the secondary location of the storage account. Only available if the accountType is StandardRAGRS." + } + } + }, + "StorageAccount": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/StorageAccountProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "The storage account." + }, + "StorageAccountKeys": { + "properties": { + "key1": { + "type": "string", + "description": "Gets the value of key 1." + }, + "key2": { + "type": "string", + "description": "Gets the value of key 2." + } + }, + "description": "The access keys for the storage account." + }, + "StorageAccountListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/StorageAccount" + }, + "description": "Gets the list of storage accounts and their properties." + } + }, + "description": "The list storage accounts operation response." + }, + "StorageAccountPropertiesUpdateParameters": { + "properties": { + "accountType": { + "type": "string", + "description": "Gets or sets the account type. Note that StandardZRS and PremiumLRS accounts cannot be changed to other account types, and other account types cannot be changed to StandardZRS or PremiumLRS.", + "enum": [ + "Standard_LRS", + "Standard_ZRS", + "Standard_GRS", + "Standard_RAGRS", + "Premium_LRS" + ], + "x-ms-enum": { + "name": "AccountType", + "modelAsString": false + } + }, + "customDomain": { + "$ref": "#/definitions/CustomDomain", + "description": "User domain assigned to the storage account. Name is the CNAME source. Only one custom domain is supported per storage account at this time. To clear the existing custom domain, use an empty string for the custom domain name property." + } + } + }, + "StorageAccountUpdateParameters": { + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/StorageAccountPropertiesUpdateParameters" + } + }, + "x-ms-azure-resource": true, + "description": "The parameters to update on the account." + }, + "StorageAccountRegenerateKeyParameters": { + "properties": { + "keyName": { + "type": "string" + } + }, + "required": [ + "keyName" + ] + }, + "UsageName": { + "properties": { + "value": { + "type": "string", + "description": "Gets a string describing the resource name." + }, + "localizedValue": { + "type": "string", + "description": "Gets a localized string describing the resource name." + } + }, + "description": "The Usage Names." + }, + "Usage": { + "properties": { + "unit": { + "type": "string", + "description": "Gets the unit of measurement.", + "enum": [ + "Count", + "Bytes", + "Seconds", + "Percent", + "CountsPerSecond", + "BytesPerSecond" + ], + "x-ms-enum": { + "name": "UsageUnit", + "modelAsString": false + } + }, + "currentValue": { + "type": "integer", + "format": "int32", + "description": "Gets the current count of the allocated resources in the subscription." + }, + "limit": { + "type": "integer", + "format": "int32", + "description": "Gets the maximum count of the resources that can be allocated in the subscription." + }, + "name": { + "$ref": "#/definitions/UsageName", + "description": "Gets the name of the type of usage." + } + }, + "required": [ + "unit", + "currentValue", + "limit", + "name" + ], + "description": "Describes Storage Resource Usage." + }, + "UsageListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Usage" + }, + "description": "Gets or sets the list Storage Resource Usages." + } + }, + "description": "The List Usages operation response." + }, + "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" + } + }, + "x-ms-azure-resource": 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." + } + } } \ No newline at end of file