openapi-directory/api/azure.com/automation-certificate.json

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

{"openapi":"3.0.0","info":{"title":"AutomationManagement","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/certificate.json","version":"2.0"}],"x-providerName":"azure.com","x-serviceName":"automation-certificate","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/certificates":{"get":{"description":"Retrieve a list of certificates.","externalDocs":{"url":"http://aka.ms/azureautomationsdk/certificateoperations"},"operationId":"Certificate_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 certificates":{"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 certificates":{"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":{"List certificates":{"value":"subid"}}},{"description":"Client Api Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"List certificates":{"value":"2015-10-31"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificateListResult"},"examples":{"List certificates":{"$ref":"#/components/examples/List_certificates"}}}}},"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":["Certificate"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/certificates/{certificateName}":{"delete":{"description":"Delete the certificate.","externalDocs":{"url":"http://aka.ms/azureautomationsdk/certificateoperations"},"operationId":"Certificate_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 a certificate":{"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 a certificate":{"value":"myAutomationAccount33"}}},{"description":"The name of certificate.","in":"path","name":"certificateName","required":true,"schema":{"type":"string"},"examples":{"Delete a certificate":{"value":"testCert"}}},{"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 a certificate":{"value":"subid"}}},{"description":"Client Api Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Delete a certificate":{"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":["Certificate"]},"get":{"description":"Retrieve the certificate identified by certificate name.","externalDocs":{"url":"http://aka.ms/azureautomationsdk/certificateoperations"},"operationId":"Certificate_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 a certificate":{"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 a certificate":{"value":"myAutomationAccount33"}}},{"description":"The name of certificate.","in":"path","name":"certificateName","required":true,"schema":{"type":"string"},"examples":{"Get a certificate":{"value":"testCert"}}},{"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 a certificate":{"value":"subid"}}},{"description":"Client Api Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Get a certificate":{"value":"2015-10-31"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Certificate"},"examples":{"Get a certificate":{"$ref":"#/components/examples/Get_a_certificate"}}}}},"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":["Certificate"]},"patch":{"description":"Update a certificate.","externalDocs":{"url":"http://aka.ms/azureautomationsdk/certificateoperations"},"operationId":"Certificate_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 a certificate":{"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 a certificate":{"value":"myAutomationAccount33"}}},{"description":"The parameters supplied to the update certificate operation.","in":"path","name":"certificateName","required":true,"schema":{"type":"string"},"examples":{"Update a certificate":{"value":"testCert"}}},{"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 a certificate":{"value":"subid"}}},{"description":"Client Api Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Update a certificate":{"value":"2015-10-31"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificateUpdateParameters"}}},"description":"The parameters supplied to the update certificate operation.","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Certificate"},"examples":{"Update a certificate":{"$ref":"#/components/examples/Update_a_certificate"}}}}},"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":["Certificate"]},"put":{"description":"Create a certificate.","externalDocs":{"url":"http://aka.ms/azureautomationsdk/certificateoperations"},"operationId":"Certificate_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 a certificate":{"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 a certificate":{"value":"myAutomationAccount18"}}},{"description":"The parameters supplied to the create or update certificate operation.","in":"path","name":"certificateName","required":true,"schema":{"type":"string"},"examples":{"Create or update a certificate":{"value":"testCert"}}},{"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 a certificate":{"value":"subid"}}},{"description":"Client Api Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Create or update a certificate":{"value":"2015-10-31"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificateCreateOrUpdateParameters"}}},"description":"The parameters supplied to the create or update certificate operation.","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Certificate"},"examples":{"Create or update a certificate":{"$ref":"#/components/examples/Create_or_update_a_certificate"}}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Certificate"},"examples":{"Create or update a certificate":{"$ref":"#/components/examples/Create_or_update_a_certificate"}}}}},"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":["Certificate"]}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"List_certificates":{"value":{"value":[{"id":"/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/certificates/testCert","name":"testCert","properties":{"creationTime":"2017-03-29T17:26:43.337+00:00","description":"Sample Cert","expiryTime":"2018-03-29T17:25:45+00:00","isExportable":false,"lastModifiedTime":"2017-03-29T17:28:55.01+00:00","thumbprint":"thumbprint of cert"}}]}},"Get_a_certificate":{"value":{"id":"/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/certificates/testCert","name":"testCert","properties":{"creationTime":"2017-03-29T17:26:43.337+00:00","description":"Sample Cert","expiryTime":"2018-03-29T17:25:45+00:00","isExportable":false,"lastModifiedTime":"2017-03-29T17:28:55.01+00:00","thumbprint":"thumbprint of cert"}}},"Update_a_certificate":{"value":{"id":"/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/certificates/testCert","name":"testCert","properties":{"creationTime":"2017-03-29T17:26:43.337+00:00","description":"sample certificate. Description updated","expiryTime":"2018-03-29T17:25:45+00:00","isExportable":false,"lastModifiedTime":"2017-03-29T17:28:55.01+00:00","thumbprint":"thumbprint of cert"}}},"Create_or_update_a_certificate":{"value":{"id":"/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/certificates/testCert","name":"testCert","properties":{"creationTime":"2017-03-29T17:26:43.337+00:00","description":"Sample Cert","expiryTime":"2018-03-29T17:25:45+00:00","isExportable":false,"lastModifiedTime":"2017-03-29T17:26:43.337+00:00","thumbprint":"thumbprint of cert"}}}},"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":{"Certificate":{"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 certificate.","properties":{"properties":{"$ref":"#/components/schemas/CertificateProperties"}}},"CertificateCreateOrUpdateParameters":{"description":"The parameters supplied to the create or update or replace certificate operation.","properties":{"name":{"description":"Gets or sets the name of the certificate.","type":"string"},"properties":{"$ref":"#/components/schemas/CertificateCreateOrUpdateProperties"}},"required":["name","properties"]},"CertificateCreateOrUpdateProperties":{"description":"The properties of the create certificate operation.","properties":{"base64Value":{"description":"Gets or sets the base64 encoded value of the certificate.","type":"string"},"description":{"description":"Gets or sets the description of the certificate.","type":"string"},"isExportable":{"description":"Gets or sets the is exportable flag of the certificate.","type":"boolean","nullable":false},"thumbprint":{"description":"Gets or sets the thumbprint of the certificate.","type":"string"}},"required":["base64Value"]},"CertificateListResult":{"description":"The response model for the list certificate operation.","properties":{"nextLink":{"description":"Gets or sets the next link.","type":"string"},"value":{"description":"Gets or sets a list of certificates.","items":{"$ref":"#/components/schemas/Certificate"},"type":"array"}}},"CertificateProperties":{"description":"Properties of the certificate.","properties":{"creationTime":{"description":"Gets the creation time.","format":"date-time","readOnly":true,"type":"string","nullable":false},"description":{"description":"Gets or sets the description.","type":"string"},"expiryTime":{"description":"Gets the expiry time of the certificate.","format":"date-time","readOnly":true,"type":"string","nullable":false},"isExportable":{"description":"Gets the is exportable flag of the certificate.","readOnly":true,"type":"boolean","nullable":false},"lastModifiedTime":{"description":"Gets the last modified time.","format":"date-time","readOnly":true,"type":"string","nullable":false},"thumbprint":{"description":"Gets the thumbprint of the certificate.","readOnly":true,"type":"string"}}},"CertificateUpdateParameters":{"description":"The parameters supplied to the update certificate operation.","properties":{"name":{"description":"Gets or sets the name of the certificate.","type":"string"},"properties":{"$ref":"#/components/schemas/CertificateUpdateProperties"}}},"CertificateUpdateProperties":{"description":"The properties of the update certificate operation","properties":{"description":{"description":"Gets or sets the description of the certificate.","type":"string"}}}}}}