openapi-directory/api/azure.com/web-Certificates.json

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

{"openapi":"3.0.0","info":{"title":"Certificates API Client","version":"2018-11-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/web/resource-manager/Microsoft.Web/stable/2018-11-01/Certificates.json","version":"2.0"}],"x-preferred":true,"x-providerName":"azure.com","x-serviceName":"web-Certificates","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/subscriptions/{subscriptionId}/providers/Microsoft.Web/certificates":{"get":{"description":"Get all certificates for a subscription.","operationId":"Certificates_List","parameters":[{"$ref":"#/components/parameters/subscriptionIdParameter"},{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificateCollection"},"examples":{"List Certificates for subscription":{"$ref":"#/components/examples/List_Certificates_for_subscription"}}}}},"default":{"description":"App Service error response.","content":{"application/json":{"schema":{"description":"App Service error response.","properties":{"error":{"description":"Error model.","properties":{"code":{"description":"Standardized string to programmatically identify the error.","readOnly":true,"type":"string"},"details":{"items":{"description":"Detailed errors.","properties":{"code":{"description":"Standardized string to programmatically identify the error.","readOnly":true,"type":"string"},"message":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"},"target":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"}},"readOnly":true},"type":"array"},"innererror":{"description":"More information to debug error.","readOnly":true,"type":"string"},"message":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"},"target":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"}},"readOnly":true,"type":"object"}},"type":"object"}}}}},"summary":"Get all certificates for a subscription.","tags":["Certificates"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/certificates":{"get":{"description":"Get all certificates in a resource group.","operationId":"Certificates_ListByResourceGroup","parameters":[{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/subscriptionIdParameter"},{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"OK.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificateCollection"},"examples":{"List Certificates by resource group":{"$ref":"#/components/examples/List_Certificates_by_resource_group"}}}}},"default":{"description":"App Service error response.","content":{"application/json":{"schema":{"description":"App Service error response.","properties":{"error":{"description":"Error model.","properties":{"code":{"description":"Standardized string to programmatically identify the error.","readOnly":true,"type":"string"},"details":{"items":{"description":"Detailed errors.","properties":{"code":{"description":"Standardized string to programmatically identify the error.","readOnly":true,"type":"string"},"message":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"},"target":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"}},"readOnly":true},"type":"array"},"innererror":{"description":"More information to debug error.","readOnly":true,"type":"string"},"message":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"},"target":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"}},"readOnly":true,"type":"object"}},"type":"object"}}}}},"summary":"Get all certificates in a resource group.","tags":["Certificates"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/certificates/{name}":{"delete":{"description":"Delete a certificate.","operationId":"Certificates_Delete","parameters":[{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"description":"Name of the certificate.","in":"path","name":"name","required":true,"schema":{"type":"string"},"examples":{"Delete Certificate":{"value":"testc6282"}}},{"$ref":"#/components/parameters/subscriptionIdParameter"},{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"Successfully deleted certificate."},"204":{"description":"Certificate does not exist."}},"summary":"Delete a certificate.","tags":["Certificates"]},"get":{"description":"Get a certificate.","operationId":"Certificates_Get","parameters":[{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"description":"Name of the certificate.","in":"path","name":"name","required":true,"schema":{"type":"string"},"examples":{"Get Certificate":{"value":"testc6282"}}},{"$ref":"#/components/parameters/subscriptionIdParameter"},{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Certificate"},"examples":{"Get Certificate":{"$ref":"#/components/examples/Get_Certificate"}}}}},"default":{"description":"App Service error response.","content":{"application/json":{"schema":{"description":"App Service error response.","properties":{"error":{"description":"Error model.","properties":{"code":{"description":"Standardized string to programmatically identify the error.","readOnly":true,"type":"string"},"details":{"items":{"description":"Detailed errors.","properties":{"code":{"description":"Standardized string to programmatically identify the error.","readOnly":true,"type":"string"},"message":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"},"target":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"}},"readOnly":true},"type":"array"},"innererror":{"description":"More information to debug error.","readOnly":true,"type":"string"},"message":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"},"target":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"}},"readOnly":true,"type":"object"}},"type":"object"}}}}},"summary":"Get a certificate.","tags":["Certificates"]},"patch":{"description":"Create or update a certificate.","operationId":"Certificates_Update","parameters":[{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"description":"Name of the certificate.","in":"path","name":"name","required":true,"schema":{"type":"string"},"examples":{"Patch Certificate":{"value":"testc6282"}}},{"$ref":"#/components/parameters/subscriptionIdParameter"},{"$ref":"#/components/parameters/apiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificatePatchResource"}}},"description":"Details of certificate, if it exists already.","required":true},"responses":{"200":{"description":"OK.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Certificate"},"examples":{"Patch Certificate":{"$ref":"#/components/examples/Patch_Certificate"}}}}},"default":{"description":"App Service error response.","content":{"application/json":{"schema":{"description":"App Service error response.","properties":{"error":{"description":"Error model.","properties":{"code":{"description":"Standardized string to programmatically identify the error.","readOnly":true,"type":"string"},"details":{"items":{"description":"Detailed errors.","properties":{"code":{"description":"Standardized string to programmatically identify the error.","readOnly":true,"type":"string"},"message":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"},"target":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"}},"readOnly":true},"type":"array"},"innererror":{"description":"More information to debug error.","readOnly":true,"type":"string"},"message":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"},"target":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"}},"readOnly":true,"type":"object"}},"type":"object"}}}}},"summary":"Create or update a certificate.","tags":["Certificates"]},"put":{"description":"Create or update a certificate.","operationId":"Certificates_CreateOrUpdate","parameters":[{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"description":"Name of the certificate.","in":"path","name":"name","required":true,"schema":{"type":"string"},"examples":{"Create Or Update Certificate":{"value":"testc6282"}}},{"$ref":"#/components/parameters/subscriptionIdParameter"},{"$ref":"#/components/parameters/apiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Certificate"}}},"description":"Details of certificate, if it exists already.","required":true},"responses":{"200":{"description":"OK.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Certificate"},"examples":{"Create Or Update Certificate":{"$ref":"#/components/examples/Create_Or_Update_Certificate"}}}}},"default":{"description":"App Service error response.","content":{"application/json":{"schema":{"description":"App Service error response.","properties":{"error":{"description":"Error model.","properties":{"code":{"description":"Standardized string to programmatically identify the error.","readOnly":true,"type":"string"},"details":{"items":{"description":"Detailed errors.","properties":{"code":{"description":"Standardized string to programmatically identify the error.","readOnly":true,"type":"string"},"message":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"},"target":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"}},"readOnly":true},"type":"array"},"innererror":{"description":"More information to debug error.","readOnly":true,"type":"string"},"message":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"},"target":{"description":"Detailed error description and debugging information.","readOnly":true,"type":"string"}},"readOnly":true,"type":"object"}},"type":"object"}}}}},"summary":"Create or update a certificate.","tags":["Certificates"]}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"List_Certificates_for_subscription":{"value":{"value":[{"id":"/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/certificates/testc6282","location":"East US","name":"testc6282","properties":{"expirationDate":"2039-12-31T23:59:59+00:00","friendlyName":"","hostNames":["ServerCert"],"issueDate":"2015-11-12T23:40:25+00:00","issuer":"CACert","password":"SWsSsd__233$Sdsds#%Sd!","subjectName":"ServerCert","thumbprint":"FE703D7411A44163B6D32B3AD9B03E175886EBFE"},"type":"Microsoft.Web/certificates"},{"id":"/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/certificates/testc4912","location":"West US","name":"testc4912","properties":{"expirationDate":"2040-12-31T23:59:59+00:00","friendlyName":"","hostNames":["ServerCert2"],"issueDate":"2015-12-12T23:40:25+00:00","issuer":"CACert","password":"SWsSsd__233$Sdsds#%Sd!","subjectName":"ServerCert2","thumbprint":"FE703D7411A44163B6D32B3AD9B0490D5886EBFE"},"type":"Microsoft.Web/certificates"}]}},"List_Certificates_by_resource_group":{"value":{"value":[{"id":"/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/certificates/testc6282","location":"East US","name":"testc6282","properties":{"expirationDate":"2039-12-31T23:59:59+00:00","friendlyName":"","hostNames":["ServerCert"],"issueDate":"2015-11-12T23:40:25+00:00","issuer":"CACert","password":"SWsSsd__233$Sdsds#%Sd!","subjectName":"ServerCert","thumbprint":"FE703D7411A44163B6D32B3AD9B03E175886EBFE"},"type":"Microsoft.Web/certificates"},{"id":"/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/certificates/testc4912","location":"West US","name":"testc4912","properties":{"expirationDate":"2040-12-31T23:59:59+00:00","friendlyName":"","hostNames":["ServerCert2"],"issueDate":"2015-12-12T23:40:25+00:00","issuer":"CACert","password":"SWsSsd__233$Sdsds#%Sd!","subjectName":"ServerCert2","thumbprint":"FE703D7411A44163B6D32B3AD9B0490D5886EBFE"},"type":"Microsoft.Web/certificates"}]}},"Get_Certificate":{"value":{"id":"/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/certificates/testc6282","location":"East US","name":"testc6282","properties":{"expirationDate":"2039-12-31T23:59:59+00:00","friendlyName":"","hostNames":["ServerCert"],"issueDate":"2015-11-12T23:40:25+00:00","issuer":"CACert","password":"SWsSsd__233$Sdsds#%Sd!","subjectName":"ServerCert","thumbprint":"FE703D7411A44163B6D32B3AD9B03E175886EBFE"},"type":"Microsoft.Web/certificates"}},"Patch_Certificate":{"value":{"id":"/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/certificates/testc6282","location":"East US","name":"testc6282","properties":{"expirationDate":"2039-12-31T23:59:59+00:00","friendlyName":"","hostNames":["ServerCert"],"issueDate":"2015-11-12T23:40:25+00:00","issuer":"CACert","password":"SWsSsd__233$Sdsds#%Sd!","subjectName":"ServerCert","thumbprint":"FE703D7411A44163B6D32B3AD9B03E175886EBFE"},"type":"Microsoft.Web/certificates"}},"Create_Or_Update_Certificate":{"value":{"id":"/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/certificates/testc6282","location":"East US","name":"testc6282","properties":{"expirationDate":"2039-12-31T23:59:59+00:00","friendlyName":"","hostNames":["ServerCert"],"issueDate":"2015-11-12T23:40:25+00:00","issuer":"CACert","password":"SWsSsd__233$Sdsds#%Sd!","subjectName":"ServerCert","thumbprint":"FE703D7411A44163B6D32B3AD9B03E175886EBFE"},"type":"Microsoft.Web/certificates"}}},"parameters":{"apiVersionParameter":{"description":"API Version","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"List Certificates for subscription":{"value":"2018-02-01"},"List Certificates by resource group":{"value":"2018-02-01"},"Delete Certificate":{"value":"2018-02-01"},"Get Certificate":{"value":"2018-02-01"},"Patch Certificate":{"value":"2018-02-01"},"Create Or Update Certificate":{"value":"2018-02-01"}}},"resourceGroupNameParameter":{"description":"Name of the resource group to which the resource belongs.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._\\(\\)]+[^\\.]$"},"examples":{"List Certificates by resource group":{"value":"testrg123"},"Delete Certificate":{"value":"testrg123"},"Get Certificate":{"value":"testrg123"},"Patch Certificate":{"value":"testrg123"},"Create Or Update Certificate":{"value":"testrg123"}}},"subscriptionIdParameter":{"description":"Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"List Certificates for subscription":{"value":"34adfa4f-cedf-4dc0-ba29-b6d1a69ab345"},"List Certificates by resource group":{"value":"34adfa4f-cedf-4dc0-ba29-b6d1a69ab345"},"Delete Certificate":{"value":"34adfa4f-cedf-4dc0-ba29-b6d1a69ab345"},"Get Certificate":{"value":"34adfa4f-cedf-4dc0-ba29-b6d1a69ab345"},"Patch Certificate":{"value":"34adfa4f-cedf-4dc0-ba29-b6d1a69ab345"},"Create Or Update Certificate":{"value":"34adfa4f-cedf-4dc0-ba29-b6d1a69ab345"}}}},"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":[{"description":"Azure resource. This resource is tracked in Azure Resource Manager","properties":{"id":{"description":"Resource Id.","readOnly":true,"type":"string"},"kind":{"description":"Kind of resource.","type":"string"},"location":{"description":"Resource Location.","type":"string"},"name":{"description":"Resource Name.","readOnly":true,"type":"string"},"tags":{"additionalProperties":{"type":"string"},"description":"Resource tags.","type":"object"},"type":{"description":"Resource type.","readOnly":true,"type":"string"}},"required":["location"],"x-ms-azure-resource":true}],"description":"SSL certificate for an app.","properties":{"properties":{"description":"Certificate resource specific properties","properties":{"cerBlob":{"description":"Raw bytes of .cer file","format":"byte","readOnly":true,"type":"string"},"expirationDate":{"description":"Certificate expiration date.","format":"date-time","readOnly":true,"type":"string"},"friendlyName":{"description":"Friendly name of the certificate.","readOnly":true,"type":"string"},"hostNames":{"description":"Host names the certificate applies to.","items":{"type":"string"},"type":"array"},"hostingEnvironmentProfile":{"description":"Specification for an App Service Environment to use for this resource.","properties":{"id":{"description":"Resource ID of the App Service Environment.","type":"string"},"name":{"description":"Name of the App Service Environment.","readOnly":true,"type":"string"},"type":{"description":"Resource type of the App Service Environment.","readOnly":true,"type":"string"}},"type":"object"},"issueDate":{"description":"Certificate issue Date.","format":"date-time","readOnly":true,"type":"string"},"issuer":{"description":"Certificate issuer.","readOnly":true,"type":"string"},"keyVaultId":{"description":"Key Vault Csm resource Id.","type":"string"},"keyVaultSecretName":{"description":"Key Vault secret name.","type":"string"},"keyVaultSecretStatus":{"description":"Status of the Key Vault secret.","enum":["Initialized","WaitingOnCertificateOrder","Succeeded","CertificateOrderFailed","OperationNotPermittedOnKeyVault","AzureServiceUnauthorizedToAccessKeyVault","KeyVaultDoesNotExist","KeyVaultSecretDoesNotExist","UnknownError","ExternalPrivateKey","Unknown"],"readOnly":true,"type":"string","x-ms-enum":{"modelAsString":false,"name":"KeyVaultSecretStatus"}},"password":{"description":"Certificate password.","type":"string","x-ms-mutability":["create"]},"pfxBlob":{"description":"Pfx blob.","format":"byte","type":"string"},"publicKeyHash":{"description":"Public key hash.","readOnly":true,"type":"string"},"selfLink":{"description":"Self link.","readOnly":true,"type":"string"},"serverFarmId":{"description":"Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\".","type":"string"},"siteName":{"description":"App name.","readOnly":true,"type":"string"},"subjectName":{"description":"Subject name of the certificate.","readOnly":true,"type":"string"},"thumbprint":{"description":"Certificate thumbprint.","readOnly":true,"type":"string"},"valid":{"description":"Is the certificate valid?.","readOnly":true,"type":"boolean"}},"required":["password"],"x-ms-client-flatten":true}},"type":"object"},"CertificateCollection":{"description":"Collection of certificates.","properties":{"nextLink":{"description":"Link to next page of resources.","readOnly":true,"type":"string"},"value":{"description":"Collection of resources.","items":{"$ref":"#/components/schemas/Certificate"},"type":"array"}},"required":["value"],"type":"object"},"CertificatePatchResource":{"allOf":[{"description":"Azure proxy only resource. This resource is not tracked by Azure Resource Manager.","properties":{"id":{"description":"Resource Id.","readOnly":true,"type":"string"},"kind":{"description":"Kind of resource.","type":"string"},"name":{"description":"Resource Name.","readOnly":true,"type":"string"},"type":{"description":"Resource type.","readOnly":true,"type":"string"}},"x-ms-azure-resource":true}],"description":"ARM resource for a certificate.","properties":{"properties":{"description":"CertificatePatchResource resource specific properties","properties":{"cerBlob":{"description":"Raw bytes of .cer file","format":"byte","readOnly":true,"type":"string"},"expirationDate":{"description":"Certificate expiration date.","format":"date-time","readOnly":true,"type":"string"},"friendlyName":{"description":"Friendly name of the certificate.","readOnly":true,"type":"string"},"hostNames":{"description":"Host names the certificate applies to.","items":{"type":"string"},"type":"array"},"hostingEnvironmentProfile":{"description":"Specification for an App Service Environment to use for this resource.","properties":{"id":{"description":"Resource ID of the App Service Environment.","type":"string"},"name":{"description":"Name of the App Service Environment.","readOnly":true,"type":"string"},"type":{"description":"Resource type of the App Service Environment.","readOnly":true,"type":"string"}},"type":"object"},"issueDate":{"description":"Certificate issue Date.","format":"date-time","readOnly":true,"type":"string"},"issuer":{"description":"Certificate issuer.","readOnly":true,"type":"string"},"keyVaultId":{"description":"Key Vault Csm resource Id.","type":"string"},"keyVaultSecretName":{"description":"Key Vault secret name.","type":"string"},"keyVaultSecretStatus":{"description":"Status of the Key Vault secret.","enum":["Initialized","WaitingOnCertificateOrder","Succeeded","CertificateOrderFailed","OperationNotPermittedOnKeyVault","AzureServiceUnauthorizedToAccessKeyVault","KeyVaultDoesNotExist","KeyVaultSecretDoesNotExist","UnknownError","ExternalPrivateKey","Unknown"],"readOnly":true,"type":"string","x-ms-enum":{"modelAsString":false,"name":"KeyVaultSecretStatus"}},"password":{"description":"Certificate password.","type":"string","x-ms-mutability":["create"]},"pfxBlob":{"description":"Pfx blob.","format":"byte","type":"string"},"publicKeyHash":{"description":"Public key hash.","readOnly":true,"type":"string"},"selfLink":{"description":"Self link.","readOnly":true,"type":"string"},"serverFarmId":{"description":"Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\".","type":"string"},"siteName":{"description":"App name.","readOnly":true,"type":"string"},"subjectName":{"description":"Subject name of the certificate.","readOnly":true,"type":"string"},"thumbprint":{"description":"Certificate thumbprint.","readOnly":true,"type":"string"},"valid":{"description":"Is the certificate valid?.","readOnly":true,"type":"boolean"}},"required":["password"],"x-ms-client-flatten":true}},"type":"object"}}}}