UNPKG

openapi-directory

Version:

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

1 lines 7.14 kB
{"openapi":"3.0.0","info":{"description":"Deployment Admin Client.","title":"DeploymentAdminClient","version":"2019-01-01","x-apisguru-categories":["cloud"],"x-logo":{"url":"https://assets.onestore.ms/cdnfiles/onestorerolling-1606-01000/shell/v3/images/logo/microsoft.png"},"x-origin":[{"format":"swagger","url":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/azsadmin/resource-manager/deployment/Microsoft.Deployment.Admin/preview/2019-01-01/ActionPlan.json","version":"2.0"}],"x-providerName":"azure.com","x-serviceName":"azsadmin-ActionPlan","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/subscriptions/{subscriptionId}/providers/Microsoft.Deployment.Admin/locations/global/actionPlans":{"get":{"description":"Gets the list of action plans","operationId":"ActionPlans_List","parameters":[{"description":"Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Gets the list of action plans":{"value":"20ff7fc3-e762-44dd-bd96-b71116dcdc23"}}},{"description":"Client API Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string","default":"2019-01-01"},"examples":{"Gets the list of action plans":{"value":"2019-01-01"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionPlanList"},"examples":{"Gets the list of action plans":{"$ref":"#/components/examples/Gets_the_list_of_action_plans"}}}}}},"tags":["ActionPlans"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/providers/Microsoft.Deployment.Admin/locations/global/actionPlans/{planId}":{"get":{"description":"Gets the specified action plan","operationId":"ActionPlans_Get","parameters":[{"description":"Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Gets the specified action plan":{"value":"20ff7fc3-e762-44dd-bd96-b71116dcdc23"}}},{"$ref":"#/components/parameters/PlanIdParameter"},{"description":"Client API Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string","default":"2019-01-01"},"examples":{"Gets the specified action plan":{"value":"2019-01-01"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionPlanResourceEntity"},"examples":{"Gets the specified action plan":{"$ref":"#/components/examples/Gets_the_specified_action_plan"}}}}},"404":{"description":"NOT FOUND"}},"tags":["ActionPlans"]}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"Gets_the_list_of_action_plans":{"value":{"value":[{"id":"/subscriptions/be8b2e19-7f92-4644-b808-a18283aebb01/providers/Microsoft.Deployment.Admin/locations/global/actionplans/5f7d40b0-c504-4ebe-9db2-6f906d0faf6e","name":"global/5f7d40b0-c504-4ebe-9db2-6f906d0faf6e","properties":{"actionPlanUri":"https://deploymentrp.blob.redmond.ext-n22r1708.masd.stbtest.microsoft.com/msdpfilecontainer-cb72641657134ed79ffeb632a58a671e/Deployment/DeploymentPlan.json","endTime":"2019-10-15T19:36:29.5214075Z","parameters":{},"provisioningState":"Succeeded","resourceGroupName":"Microsoft.NullProvider","startTime":"2019-10-15T19:29:22.6861068Z","subscriptionId":"ca13578c-6d3b-4478-b63e-a65c89601d86"},"type":"Microsoft.Deployment.Admin/locations/actionplans"}]}},"Gets_the_specified_action_plan":{"value":{"id":"/subscriptions/be8b2e19-7f92-4644-b808-a18283aebb01/providers/Microsoft.Deployment.Admin/locations/global/actionplans/5f7d40b0-c504-4ebe-9db2-6f906d0faf6e","name":"global/5f7d40b0-c504-4ebe-9db2-6f906d0faf6e","properties":{"actionPlanUri":"https://deploymentrp.blob.redmond.ext-n22r1708.masd.stbtest.microsoft.com/msdpfilecontainer-cb72641657134ed79ffeb632a58a671e/Deployment/DeploymentPlan.json","endTime":"2019-10-15T19:36:29.5214075Z","parameters":{},"provisioningState":"Succeeded","resourceGroupName":"Microsoft.NullProvider","startTime":"2019-10-15T19:29:22.6861068Z","subscriptionId":"ca13578c-6d3b-4478-b63e-a65c89601d86"},"type":"Microsoft.Deployment.Admin/locations/actionplans"}}},"parameters":{"PlanIdParameter":{"description":"Identifier of the action plan.","in":"path","name":"planId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Gets the specified action plan":{"value":"5f7d40b0-c504-4ebe-9db2-6f906d0faf6e"}}}},"securitySchemes":{"azure_auth":{"description":"Authorization uses an Azure Active Directory OAuth2 flow.","type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://login.microsoftonline.com/common/oauth2/authorize","scopes":{"user_impersonation":"impersonate your user account"}}}}},"schemas":{"ActionPlanAdminProperties":{"description":"Action Plan Properties","properties":{"actionPlanInstanceId":{"description":"Action plan instance identifier","type":"string"},"actionPlanUri":{"description":"Action plan uri","type":"string"},"blobContainerName":{"description":"Blob container name storing the deployment data","type":"string"},"endTime":{"description":"The deployment end time","format":"date-time","type":"string"},"error":{"description":"Error information","properties":{"code":{"description":"Error Code","type":"string"},"details":{"$ref":"#/components/schemas/ExtendedErrorInfo"},"message":{"description":"Error Message","type":"string"}},"type":"object"},"parameters":{"description":"Error information","properties":{"value":{"description":"Parameters as JToken string","type":"string"}},"type":"object"},"provisioningState":{"description":"The provisioning state","type":"string"},"resourceGroupName":{"description":"The target resource group name","type":"string"},"startTime":{"description":"The deployment start time","format":"date-time","type":"string"},"subscriptionId":{"description":"The target subscription identifier","type":"string"}},"type":"object"},"ActionPlanList":{"description":"List of action plans","properties":{"nextLink":{"description":"Continuation token","type":"string"},"value":{"description":"Array of action plans.","items":{"$ref":"#/components/schemas/ActionPlanResourceEntity"},"type":"array"}}},"ActionPlanResourceEntity":{"allOf":[{"description":"Object model of azure resource manager base.","properties":{"id":{"description":"ID of the resource.","readOnly":true,"type":"string"},"location":{"description":"Location of the resource.","type":"string"},"name":{"description":"Name of the resource.","readOnly":true,"type":"string"},"type":{"description":"Type of Resource.","readOnly":true,"type":"string"}},"type":"object","x-ms-azure-resource":true}],"description":"Action Plan Resource Entity","properties":{"eTag":{"description":"Entity tag of the resource","type":"string"},"properties":{"$ref":"#/components/schemas/ActionPlanAdminProperties"}},"type":"object"},"ExtendedErrorInfo":{}}}}