openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 19.7 kB
JSON
{"openapi":"3.0.0","info":{"title":"AutomationManagementClient","version":"2015-10-31","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/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/webhook.json","version":"2.0"}],"x-providerName":"azure.com","x-serviceName":"automation-webhook","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/webhooks":{"get":{"description":"Retrieve a list of webhooks.","externalDocs":{"url":"http://aka.ms/azureautomationsdk/webhookoperations"},"operationId":"Webhook_ListByAutomationAccount","parameters":[{"description":"Name of an Azure Resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._]+$"},"examples":{"List webhooks by Automation Account":{"value":"rg"}}},{"description":"The name of the automation account.","in":"path","name":"automationAccountName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"List webhooks by Automation Account":{"value":"myAutomationAccount33"}}},{"description":"The filter to apply on the operation.","in":"query","name":"$filter","required":false,"schema":{"type":"string"}},{"description":"Gets subscription credentials which 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":{"List webhooks by Automation Account":{"value":"subid"}}},{"description":"Client Api Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"List webhooks by Automation Account":{"value":"2015-10-31"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookListResult"},"examples":{"List webhooks by Automation Account":{"$ref":"#/components/examples/List_webhooks_by_Automation_Account"}}}}},"default":{"description":"Automation error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error response of an operation failure","properties":{"code":{"description":"Error code","type":"string"},"message":{"description":"Error message indicating why the operation failed.","type":"string"}},"type":"object"}}}}},"tags":["Webhook"],"x-ms-odata":"#/components/schemas/Webhook","x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/webhooks/generateUri":{"post":{"description":"Generates a Uri for use in creating a webhook.","externalDocs":{"url":"http://aka.ms/azureautomationsdk/webhookoperations"},"operationId":"Webhook_GenerateUri","parameters":[{"description":"Name of an Azure Resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._]+$"},"examples":{"Generate webhook uri":{"value":"rg"}}},{"description":"The name of the automation account.","in":"path","name":"automationAccountName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Generate webhook uri":{"value":"myAutomationAccount33"}}},{"description":"Gets subscription credentials which 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":{"Generate webhook uri":{"value":"subid"}}},{"description":"Client Api Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Generate webhook uri":{"value":"2015-10-31"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"},"examples":{"Generate webhook uri":{"$ref":"#/components/examples/Generate_webhook_uri"}}}}},"default":{"description":"Automation error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error response of an operation failure","properties":{"code":{"description":"Error code","type":"string"},"message":{"description":"Error message indicating why the operation failed.","type":"string"}},"type":"object"}}}}},"tags":["Webhook"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/webhooks/{webhookName}":{"delete":{"description":"Delete the webhook by name.","externalDocs":{"url":"http://aka.ms/azureautomationsdk/webhookoperations"},"operationId":"Webhook_Delete","parameters":[{"description":"Name of an Azure Resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._]+$"},"examples":{"Delete webhook":{"value":"rg"}}},{"description":"The name of the automation account.","in":"path","name":"automationAccountName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Delete webhook":{"value":"myAutomationAccount33"}}},{"description":"The webhook name.","in":"path","name":"webhookName","required":true,"schema":{"type":"string"},"examples":{"Delete webhook":{"value":"TestWebhook"}}},{"description":"Gets subscription credentials which 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":{"Delete webhook":{"value":"subid"}}},{"description":"Client Api Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Delete webhook":{"value":"2015-10-31"}}}],"responses":{"200":{"description":"OK"},"default":{"description":"Automation error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error response of an operation failure","properties":{"code":{"description":"Error code","type":"string"},"message":{"description":"Error message indicating why the operation failed.","type":"string"}},"type":"object"}}}}},"tags":["Webhook"]},"get":{"description":"Retrieve the webhook identified by webhook name.","externalDocs":{"url":"http://aka.ms/azureautomationsdk/webhookoperations"},"operationId":"Webhook_Get","parameters":[{"description":"Name of an Azure Resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._]+$"},"examples":{"Get webhook":{"value":"rg"}}},{"description":"The name of the automation account.","in":"path","name":"automationAccountName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Get webhook":{"value":"myAutomationAccount33"}}},{"description":"The webhook name.","in":"path","name":"webhookName","required":true,"schema":{"type":"string"},"examples":{"Get webhook":{"value":"TestWebhook"}}},{"description":"Gets subscription credentials which 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":{"Get webhook":{"value":"subid"}}},{"description":"Client Api Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Get webhook":{"value":"2015-10-31"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webhook"},"examples":{"Get webhook":{"$ref":"#/components/examples/Get_webhook"}}}}},"default":{"description":"Automation error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error response of an operation failure","properties":{"code":{"description":"Error code","type":"string"},"message":{"description":"Error message indicating why the operation failed.","type":"string"}},"type":"object"}}}}},"tags":["Webhook"]},"patch":{"description":"Update the webhook identified by webhook name.","externalDocs":{"url":"http://aka.ms/azureautomationsdk/webhookoperations"},"operationId":"Webhook_Update","parameters":[{"description":"Name of an Azure Resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._]+$"},"examples":{"Update webhook":{"value":"rg"}}},{"description":"The name of the automation account.","in":"path","name":"automationAccountName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Update webhook":{"value":"myAutomationAccount33"}}},{"description":"The webhook name.","in":"path","name":"webhookName","required":true,"schema":{"type":"string"},"examples":{"Update webhook":{"value":"TestWebhook"}}},{"description":"Gets subscription credentials which 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":{"Update webhook":{"value":"subid"}}},{"description":"Client Api Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Update webhook":{"value":"2015-10-31"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookUpdateParameters"}}},"description":"The update parameters for webhook.","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webhook"},"examples":{"Update webhook":{"$ref":"#/components/examples/Update_webhook"}}}}},"default":{"description":"Automation error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error response of an operation failure","properties":{"code":{"description":"Error code","type":"string"},"message":{"description":"Error message indicating why the operation failed.","type":"string"}},"type":"object"}}}}},"tags":["Webhook"]},"put":{"description":"Create the webhook identified by webhook name.","externalDocs":{"url":"http://aka.ms/azureautomationsdk/webhookoperations"},"operationId":"Webhook_CreateOrUpdate","parameters":[{"description":"Name of an Azure Resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._]+$"},"examples":{"Create or update webhook":{"value":"rg"}}},{"description":"The name of the automation account.","in":"path","name":"automationAccountName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Create or update webhook":{"value":"myAutomationAccount33"}}},{"description":"The webhook name.","in":"path","name":"webhookName","required":true,"schema":{"type":"string"},"examples":{"Create or update webhook":{"value":"TestWebhook"}}},{"description":"Gets subscription credentials which 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":{"Create or update webhook":{"value":"subid"}}},{"description":"Client Api Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Create or update webhook":{"value":"2015-10-31"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookCreateOrUpdateParameters"}}},"description":"The create or update parameters for webhook.","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webhook"},"examples":{"Create or update webhook":{"$ref":"#/components/examples/Create_or_update_webhook"}}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webhook"},"examples":{"Create or update webhook":{"$ref":"#/components/examples/Create_or_update_webhook"}}}}},"default":{"description":"Automation error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error response of an operation failure","properties":{"code":{"description":"Error code","type":"string"},"message":{"description":"Error message indicating why the operation failed.","type":"string"}},"type":"object"}}}}},"tags":["Webhook"]}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"List_webhooks_by_Automation_Account":{"value":{"value":[{"id":"/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/webhooks/TestWebhook","name":"TestWebhook","properties":{"creationTime":"2017-03-29T22:18:14.6651862+00:00","expiryTime":"2018-03-29T22:18:13.7002872+00:00","isEnabled":true,"lastModifiedBy":"","lastModifiedTime":"2017-03-29T22:18:14.6651862+00:00","runbook":{"name":"TestRunbook"}}}]}},"Generate_webhook_uri":{"value":"https://s13events.azure-automation.net/webhooks?token=O6n03K%2b1%2bSLPH50m4x9%2fcbcqtAu2tJDTvr8QHnbJ1kw%3d"},"Get_webhook":{"value":{"id":"/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/webhooks/TestWebhook","name":"TestWebhook","properties":{"creationTime":"2017-03-29T22:18:14.6651862+00:00","expiryTime":"2018-03-29T22:18:13.7002872+00:00","isEnabled":true,"lastModifiedBy":"","lastModifiedTime":"2017-03-29T22:18:14.6651862+00:00","runbook":{"name":"TestRunbook"},"uri":""}}},"Update_webhook":{"value":{"id":"/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/webhooks/TestWebhook","name":"TestWebhook","properties":{"creationTime":"2017-03-30T21:52:01.272378+00:00","expiryTime":"2018-03-30T23:03:14.5752078+00:00","isEnabled":false,"lastModifiedBy":"","lastModifiedTime":"2017-03-30T23:03:14.9069441+00:00","runbook":{"name":"TestRunbook"},"uri":""}}},"Create_or_update_webhook":{"value":{"id":"/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/webhooks/TestWebhook","name":"TestWebhook","properties":{"creationTime":"2017-03-29T22:18:14.6651862+00:00","expiryTime":"2018-03-29T22:18:13.7002872+00:00","isEnabled":true,"lastModifiedBy":"","lastModifiedTime":"2017-03-29T22:18:14.6651862+00:00","runbook":{"name":"TestRunbook"},"uri":""},"type":"Microsoft.Automation/AutomationAccounts/Webhooks"}}},"securitySchemes":{"azure_auth":{"description":"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":{"RunbookAssociationProperty":{"description":"The runbook property associated with the entity.","properties":{"name":{"description":"Gets or sets the name of the runbook.","type":"string"}}},"Webhook":{"allOf":[{"allOf":[{"description":"The core properties of ARM resources","properties":{"id":{"description":"Fully qualified resource Id for the resource","readOnly":true,"type":"string"},"name":{"description":"The name of the resource","readOnly":true,"type":"string"},"type":{"description":"The type of the resource.","readOnly":true,"type":"string"}},"type":"object","x-ms-azure-resource":true}],"description":"ARM proxy resource.","properties":{},"type":"object"}],"description":"Definition of the webhook type.","properties":{"properties":{"$ref":"#/components/schemas/WebhookProperties"}}},"WebhookCreateOrUpdateParameters":{"description":"The parameters supplied to the create or update webhook operation.","properties":{"name":{"description":"Gets or sets the name of the webhook.","type":"string"},"properties":{"$ref":"#/components/schemas/WebhookCreateOrUpdateProperties"}},"required":["name","properties"]},"WebhookCreateOrUpdateProperties":{"description":"The properties of the create webhook operation.","properties":{"expiryTime":{"description":"Gets or sets the expiry time.","format":"date-time","type":"string","nullable":false},"isEnabled":{"description":"Gets or sets the value of the enabled flag of webhook.","type":"boolean"},"parameters":{"additionalProperties":{"type":"string"},"description":"Gets or sets the parameters of the job.","type":"object"},"runOn":{"description":"Gets or sets the name of the hybrid worker group the webhook job will run on.","type":"string"},"runbook":{"$ref":"#/components/schemas/RunbookAssociationProperty"},"uri":{"description":"Gets or sets the uri.","type":"string"}}},"WebhookListResult":{"description":"The response model for the list webhook operation.","properties":{"nextLink":{"description":"Gets or sets the next link.","type":"string"},"value":{"description":"Gets or sets a list of webhooks.","items":{"$ref":"#/components/schemas/Webhook"},"type":"array"}}},"WebhookProperties":{"description":"Definition of the webhook properties","properties":{"creationTime":{"description":"Gets or sets the creation time.","format":"date-time","type":"string","nullable":false},"description":{"description":"Gets or sets the description.","type":"string"},"expiryTime":{"description":"Gets or sets the expiry time.","format":"date-time","type":"string","nullable":false},"isEnabled":{"default":false,"description":"Gets or sets the value of the enabled flag of the webhook.","type":"boolean"},"lastInvokedTime":{"description":"Gets or sets the last invoked time.","format":"date-time","type":"string","nullable":true},"lastModifiedBy":{"description":"Details of the user who last modified the Webhook","type":"string"},"lastModifiedTime":{"description":"Gets or sets the last modified time.","format":"date-time","type":"string","nullable":false},"parameters":{"additionalProperties":{"type":"string"},"description":"Gets or sets the parameters of the job that is created when the webhook calls the runbook it is associated with.","type":"object"},"runOn":{"description":"Gets or sets the name of the hybrid worker group the webhook job will run on.","type":"string"},"runbook":{"$ref":"#/components/schemas/RunbookAssociationProperty"},"uri":{"description":"Gets or sets the webhook uri.","type":"string"}}},"WebhookUpdateParameters":{"description":"The parameters supplied to the update webhook operation.","properties":{"name":{"description":"Gets or sets the name of the webhook.","type":"string"},"properties":{"$ref":"#/components/schemas/WebhookUpdateProperties"}}},"WebhookUpdateProperties":{"description":"The properties of the update webhook.","properties":{"description":{"description":"Gets or sets the description of the webhook.","type":"string"},"isEnabled":{"description":"Gets or sets the value of the enabled flag of webhook.","type":"boolean"},"parameters":{"additionalProperties":{"type":"string"},"description":"Gets or sets the parameters of the job.","type":"object"},"runOn":{"description":"Gets or sets the name of the hybrid worker group the webhook job will run on.","type":"string"}}}}}}