openapi-directory/api/azure.com/keyvault.json

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

{"openapi":"3.0.0","info":{"description":"The key vault client performs cryptographic key operations and vault operations against the Key Vault service.","title":"KeyVaultClient","version":"7.0-preview","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/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/keyvault.json","version":"2.0"}],"x-preferred":true,"x-providerName":"azure.com","x-serviceName":"keyvault","x-tags":["Azure","Microsoft"]},"paths":{"/certificates":{"get":{"description":"The GetCertificates operation returns the set of certificates resources in the specified key vault. This operation requires the certificates/list permission.","operationId":"GetCertificates","parameters":[{"description":"Maximum number of results to return in a page. If not specified the service will return up to 25 results.","in":"query","name":"maxresults","required":false,"schema":{"type":"integer","format":"int32","minimum":1,"maximum":25}},{"description":"Specifies whether to include certificates which are not completely provisioned.","in":"query","name":"includePending","required":false,"schema":{"type":"boolean"}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"A response message containing a list of certificates along with a link to the next page of certificates.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificateListResult"},"examples":{"GetCertificates":{"$ref":"#/components/examples/GetCertificates"}}}}},"default":{"description":"Key Vault error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyVaultError"}}}}},"summary":"List certificates in a specified key vault","tags":["Certificates"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/certificates/contacts":{"delete":{"description":"Deletes the certificate contacts for a specified key vault certificate. This operation requires the certificates/managecontacts permission.","operationId":"DeleteCertificateContacts","parameters":[{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"The contacts for the key vault certificate.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Contacts"},"examples":{"DeleteCertificateContacts":{"$ref":"#/components/examples/DeleteCertificateContacts"}}}}},"default":{"description":"Key Vault error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyVaultError"}}}}},"summary":"Deletes the certificate contacts for a specified key vault.","tags":["Certificates"]},"get":{"description":"The GetCertificateContacts operation returns the set of certificate contact resources in the specified key vault. This operation requires the certificates/managecontacts permission.","operationId":"GetCertificateContacts","parameters":[{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"The contacts for the key vault certificate.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Contacts"},"examples":{"GetCertificateContacts":{"$ref":"#/components/examples/GetCertificateContacts"}}}}},"default":{"description":"Key Vault error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyVaultError"}}}}},"summary":"Lists the certificate contacts for a specified key vault.","tags":["Certificates"]},"put":{"description":"Sets the certificate contacts for the specified key vault. This operation requires the certificates/managecontacts permission.","operationId":"SetCertificateContacts","parameters":[{"$ref":"#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Contacts"}}},"description":"The contacts for the key vault certificate.","required":true},"responses":{"200":{"description":"The contacts for the key vault certificate.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Contacts"},"examples":{"SetCertificateContacts":{"$ref":"#/components/examples/SetCertificateContacts"}}}}},"default":{"description":"Key Vault error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyVaultError"}}}}},"summary":"Sets the certificate contacts for the specified key vault.","tags":["Certificates"]}},"/certificates/issuers":{"get":{"description":"The GetCertificateIssuers operation returns the set of certificate issuer resources in the specified key vault. This operation requires the certificates/manageissuers/getissuers permission.","operationId":"GetCertificateIssuers","parameters":[{"description":"Maximum number of results to return in a page. If not specified the service will return up to 25 results.","in":"query","name":"maxresults","required":false,"schema":{"type":"integer","format":"int32","minimum":1,"maximum":25}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"A response message containing a list of certificate issuers in a key vault along with a link to the next page of certificate issuers.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificateIssuerListResult"},"examples":{"GetCertificateIssuers":{"$ref":"#/components/examples/GetCertificateIssuers"}}}}},"default":{"description":"Key Vault error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyVaultError"}}}}},"summary":"List certificate issuers for a specified key vault.","tags":["Certificates"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/certificates/issuers/{issuer-name}":{"delete":{"description":"The DeleteCertificateIssuer operation permanently removes the specified certificate issuer from the vault. This operation requires the certificates/manageissuers/deleteissuers permission.","operationId":"DeleteCertificateIssuer","parameters":[{"description":"The name of the issuer.","in":"path","name":"issuer-name","required":true,"schema":{"type":"string"},"examples":{"DeleteCertificateIssuer":{"value":"issuer01"}}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"The issuer for the key vault certificate.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssuerBundle"},"examples":{"DeleteCertificateIssuer":{"$ref":"#/components/examples/DeleteCertificateIssuer"}}}}},"default":{"description":"Key Vault error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyVaultError"}}}}},"summary":"Deletes the specified certificate issuer.","tags":["Certificates"]},"get":{"description":"The GetCertificateIssuer operation returns the specified certificate issuer resources in the specified key vault. This operation requires the certificates/manageissuers/getissuers permission.","operationId":"GetCertificateIssuer","parameters":[{"description":"The name of the issuer.","in":"path","name":"issuer-name","required":true,"schema":{"type":"string"},"examples":{"GetCertificateIssuer":{"value":"issuer01"}}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"The issuer for the key vault certificate.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssuerBundle"},"examples":{"GetCertificateIssuer":{"$ref":"#/components/examples/GetCertificateIssuer"}}}}},"default":{"description":"Key Vault error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyVaultError"}}}}},"summary":"Lists the specified certificate issuer.","tags":["Certificates"]},"patch":{"description":"The UpdateCertificateIssuer operation performs an update on the specified certificate issuer entity. This operation requires the certificates/setissuers permission.","operationId":"UpdateCertificateIssuer","parameters":[{"description":"The name of the issuer.","in":"path","name":"issuer-name","required":true,"schema":{"type":"string"},"examples":{"UpdateCertificateIssuer":{"value":"issuer01"}}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificateIssuerUpdateParameters"}}},"description":"Certificate issuer update parameter.","required":true,"x-ms-client-flatten":true},"responses":{"200":{"description":"The issuer for the key vault certificate.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssuerBundle"},"examples":{"UpdateCertificateIssuer":{"$ref":"#/components/examples/UpdateCertificateIssuer"}}}}},"default":{"description":"Key Vault error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyVaultError"}}}}},"summary":"Updates the specified certificate issuer.","tags":["Certificates"]},"put":{"description":"The SetCertificateIssuer operation adds or updates the specified certificate issuer. This operation requires the certificates/setissuers permission.","operationId":"SetCertificateIssuer","parameters":[{"description":"The name of the issuer.","in":"path","name":"issuer-name","required":true,"schema":{"type":"string"},"examples":{"SetCertificateIssuer":{"value":"issuer01"}}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificateIssuerSetParameters"}}},"description":"Certificate issuer set parameter.","required":true,"x-ms-client-flatten":true},"responses":{"200":{"description":"The issuer for the key vault certificate.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssuerBundle"},"examples":{"SetCertificateIssuer":{"$ref":"#/components/examples/SetCertificateIssuer"}}}}},"default":{"description":"Key Vault error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyVaultError"}}}}},"summary":"Sets the specified certificate issuer.","tags":["Certificates"]}},"/certificates/restore":{"post":{"description":"Restores a backed up certificate, and all its versions, to a vault. This operation requires the certificates/restore permission.","operationId":"RestoreCertificate","parameters":[{"$ref":"#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificateRestoreParameters"}}},"description":"The parameters to restore the certificate.","required":true,"x-ms-client-flatten":true},"responses":{"200":{"description":"Restored certificate bundle in the vault.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificateBundle"},"examples":{"RestoreCertificate":{"$ref":"#/components/examples/RestoreCertificate"}}}}},"default":{"description":"Key Vault error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyVaultError"}}}}},"summary":"Restores a backed up certificate to a vault.","tags":["Certificates"]}},"/certificates/{certificate-name}":{"delete":{"description":"Deletes all versions of a certificate object along with its associated policy. Delete certificate cannot be used to remove individual versions of a certificate object. This operation requires the certificates/delete permission.","operationId":"DeleteCertificate","parameters":[{"description":"The name of the certificate.","in":"path","name":"certificate-name","required":true,"schema":{"type":"string"},"examples":{"DeleteCertificate":{"value":"importCert01"}}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"The deleted certificate.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeletedCertificateBundle"},"examples":{"DeleteCertificate":{"$ref":"#/components/examples/DeleteCertificate"}}}}},"default":{"description":"Key Vault error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyVaultError"}}}}},"summary":"Deletes a certificate from a specified key vault.","tags":["Certificates"]}},"/certificates/{certificate-name}/backup":{"post":{"description":"Requests that a backup of the specified certificate be downloaded to the client. All versions of the certificate will be downloaded. This operation requires the certificates/backup permission.","operationId":"BackupCertificate","parameters":[{"description":"The name of the certificate.","in":"path","name":"certificate-name","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"The backup blob containing the backed up certificate.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BackupCertificateResult"},"examples":{"BackupCertificate":{"$ref":"#/components/examples/BackupCertificate"}}}}},"default":{"description":"Key Vault error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyVaultError"}}}}},"summary":"Backs up the specified certificate.","tags":["Certificates"]}},"/certificates/{certificate-name}/create":{"post":{"description":"If this is the first version, the certificate resource is created. This operation requires the certificates/create permission.","operationId":"CreateCertificate","parameters":[{"description":"The name of the certificate.","in":"path","name":"certificate-name","required":true,"schema":{"type":"string","pattern":"^[0-9a-zA-Z-]+$"},"examples":{"CreateCertificate":{"value":"selfSignedCert01"}}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificateCreateParameters"}}},"description":"The parameters to create a certificate.","required":true,"x-ms-client-flatten":true},"responses":{"202":{"description":"Created certificate bundle.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificateOperation"},"examples":{"CreateCertificate":{"$ref":"#/components/examples/CreateCertificate"}}}}},"default":{"description":"Key Vault error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyVaultError"}}}}},"summary":"Creates a new certificate.","tags":["Certificates"]}},"/certificates/{certificate-name}/import":{"post":{"description":"Imports an existing valid certificate, containing a private key, into Azure Key Vault. The certificate to be imported can be in either PFX or PEM format. If the certificate is in PEM format the PEM file must contain the key as well as x509 certificates. This operation requires the certificates/import permission.","operationId":"ImportCertificate","parameters":[{"description":"The name of the certificate.","in":"path","name":"certificate-name","required":true,"schema":{"type":"string","pattern":"^[0-9a-zA-Z-]+$"},"examples":{"ImportCertificate":{"value":"importCert01"}}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificateImportParameters"}}},"description":"The parameters to import the certificate.","required":true,"x-ms-client-flatten":true},"responses":{"200":{"description":"Imported certificate bundle to the vault.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificateBundle"},"examples":{"ImportCertificate":{"$ref":"#/components/examples/ImportCertificate"}}}}},"default":{"description":"Key Vault error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyVaultError"}}}}},"summary":"Imports a certificate into a specified key vault.","tags":["Certificates"]}},"/certificates/{certificate-name}/pending":{"delete":{"description":"Deletes the creation operation for a specified certificate that is in the process of being created. The certificate is no longer created. This operation requires the certificates/update permission.","operationId":"DeleteCertificateOperation","parameters":[{"description":"The name of the certificate.","in":"path","name":"certificate-name","required":true,"schema":{"type":"string"},"examples":{"DeleteCertificateOperation":{"value":"deletedRequestedCert01"}}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"A message containing the certificate operation response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificateOperation"},"examples":{"DeleteCertificateOperation":{"$ref":"#/components/examples/DeleteCertificateOperation"}}}}},"default":{"description":"Key Vault error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyVaultError"}}}}},"summary":"Deletes the creation operation for a specific certificate.","tags":["Certificates"]},"get":{"description":"Gets the creation operation associated with a specified certificate. This operation requires the certificates/get permission.","operationId":"GetCertificateOperation","parameters":[{"description":"The name of the certificate.","in":"path","name":"certificate-name","required":true,"schema":{"type":"string"},"examples":{"GetCertificateOperation":{"value":"selfSignedCert01"}}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"The certificate operation response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificateOperation"},"examples":{"GetCertificateOperation":{"$ref":"#/components/examples/GetCertificateOperation"}}}}},"default":{"description":"Key Vault error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyVaultError"}}}}},"summary":"Gets the creation operation of a certificate.","tags":["Certificates"]},"patch":{"description":"Updates a certificate creation operation that is already in progress. This operation requires the certificates/update permission.","operationId":"UpdateCertificateOperation","parameters":[{"description":"The name of the certificate.","in":"path","name":"certificate-name","required":true,"schema":{"type":"string"},"examples":{"UpdateCertificateOperation":{"value":"cancellationRequestedCert01"}}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificateOperationUpdateParameter"}}},"description":"The certificate operation response.","required":true,"x-ms-client-flatten":true},"responses":{"200":{"description":"A message containing the certificate operation response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificateOperation"},"examples":{"UpdateCertificateOperation":{"$ref":"#/components/examples/UpdateCertificateOperation"}}}}},"default":{"description":"Key Vault error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyVaultError"}}}}},"summary":"Updates a certificate operation.","tags":["Certificates"]}},"/certificates/{certificate-name}/pending/merge":{"post":{"description":"The MergeCertificate operation performs the merging of a certificate or certificate chain with a key pair currently available in the service. This operation requires the certificates/create permission.","operationId":"MergeCertificate","parameters":[{"description":"The name of the certificate.","in":"path","name":"certificate-name","required":true,"schema":{"type":"string"},"examples":{"MergeCertificate":{"value":"testcert"}}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificateMergeParameters"}}},"description":"The parameters to merge certificate.","required":true,"x-ms-client-flatten":true},"responses":{"201":{"description":"Merged certificate bundle to the vault.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificateBundle"},"examples":{"MergeCertificate":{"$ref":"#/components/examples/MergeCertificate"}}}}},"default":{"description":"Key Vault error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyVaultError"}}}}},"summary":"Merges a certificate or a certificate chain with a key pair existing on the server.","tags":["Certificates"]}},"/certificates/{certificate-name}/policy":{"get":{"description":"The GetCertificatePolicy operation returns the specified certificate policy resources in the specified key vault. This operation requires the certificates/get permission.","operationId":"GetCertificatePolicy","parameters":[{"description":"The name of the certificate in a given key vault.","in":"path","name":"certificate-name","required":true,"schema":{"type":"string"},"examples":{"GetCertificatePolicy":{"value":"updateCert01"}}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"The certificate policy.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificatePolicy"},"examples":{"GetCertificatePolicy":{"$ref":"#/components/examples/GetCertificatePolicy"}}}}},"default":{"description":"Key Vault error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyVaultError"}}}}},"summary":"Lists the policy for a certificate.","tags":["Certificates"]},"patch":{"description":"Set specified members in the certificate policy. Leave others as null. This operation requires the certificates/update permission.","operationId":"UpdateCertificatePolicy","parameters":[{"description":"The name of the certificate in the given vault.","in":"path","name":"certificate-name","required":true,"schema":{"type":"string"},"examples":{"UpdateCertificatePolicy":{"value":"updateCert01"}}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificatePolicy"}}},"description":"The policy for the certificate.","required":true},"responses":{"200":{"description":"The certificate policy","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificatePolicy"},"examples":{"UpdateCertificatePolicy":{"$ref":"#/components/examples/UpdateCertificatePolicy"}}}}},"default":{"description":"Key Vault error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyVaultError"}}}}},"summary":"Updates the policy for a certificate.","tags":["Certificates"]}},"/certificates/{certificate-name}/versions":{"get":{"description":"The GetCertificateVersions operation returns the versions of a certificate in the specified key vault. This operation requires the certificates/list permission.","operationId":"GetCertificateVersions","parameters":[{"description":"The name of the certificate.","in":"path","name":"certificate-name","required":true,"schema":{"type":"string"},"examples":{"GetCertificateVersions":{"value":"listVersionsCert01"}}},{"description":"Maximum number of results to return in a page. If not specified the service will return up to 25 results.","in":"query","name":"maxresults","required":false,"schema":{"type":"integer","format":"int32","minimum":1,"maximum":25}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"A response message containing a list of certificates in the key vault along with a link to the next page of keys.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificateListResult"},"examples":{"GetCertificateVersions":{"$ref":"#/components/examples/GetCertificateVersions"}}}}},"default":{"description":"Key Vault error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyVaultError"}}}}},"summary":"List the versions of a certificate.","tags":["Certificates"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/certificates/{certificate-name}/{certificate-version}":{"get":{"description":"Gets information about a specific certificate. This operation requires the certificates/get permission.","operationId":"GetCertificate","parameters":[{"description":"The name of the certificate in the given vault.","in":"path","name":"certificate-name","required":true,"schema":{"type":"string"},"examples":{"GetCertificate":{"value":"selfSignedCert01"}}},{"description":"The version of the certificate.","in":"path","name":"certificate-version","required":true,"schema":{"type":"string"},"examples":{"GetCertificate":{"value":"pending"}}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"The retrieved certificate.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificateBundle"},"examples":{"GetCertificate":{"$ref":"#/components/examples/GetCertificate"}}}}},"default":{"description":"Key Vault error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyVaultError"}}}}},"summary":"Gets information about a certificate.","tags":["Certificates"]},"patch":{"description":"The UpdateCertificate operation applies the specified update on the given certificate; the only elements updated are the certificate's attributes. This operation requires the certificates/update permission.","operationId":"UpdateCertificate","parameters":[{"description":"The name of the certificate in the given key vault.","in":"path","name":"certificate-name","required":true,"schema":{"type":"string"},"examples":{"UpdateCertificate":{"value":"updateCert01"}}},{"description":"The version of the certificate.","in":"path","name":"certificate-version","required":true,"schema":{"type":"string"},"examples":{"UpdateCertificate":{"value":"c3d31d7b36c942ad83ef36fc0785a4fc"}}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificateUpdateParameters"}}},"description":"The parameters for certificate update.","required":true,"x-ms-client-flatten":true},"responses":{"200":{"description":"The updated certificate.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificateBundle"},"examples":{"UpdateCertificate":{"$ref":"#/components/examples/UpdateCertificate"}}}}},"default":{"description":"Key Vault error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyVaultError"}}}}},"summary":"Updates the specified attributes associated with the given certificate.","tags":["Certificates"]}},"/deletedcertificates":{"get":{"description":"The GetDeletedCertificates operation retrieves the certificates in the current vault which are in a deleted state and ready for recovery or purging. This operation includes deletion-specific information. This operation requires the certificates/get/list permission. This operation can only be enabled on soft-delete enabled vaults.","operationId":"GetDeletedCertificates","parameters":[{"description":"Maximum number of results to return in a page. If not specified the service will return up to 25 results.","in":"query","name":"maxresults","required":false,"schema":{"type":"integer","format":"int32","minimum":1,"maximum":25},"examples":{"GetDeletedCertificates":{"value":"1"}}},{"description":"Specifies whether to include certificates which are not completely provisioned.","in":"query","name":"includePending","required":false,"schema":{"type":"boolean"}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"A response message containing a list of deleted certificates in the vault along with a link to the next page of deleted certificates","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeletedCertificateListResult"},"examples":{"GetDeletedCertificates":{"$ref":"#/components/examples/GetDeletedCertificates"}}}}},"default":{"description":"Key Vault error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyVaultError"}}}}},"summary":"Lists the deleted certificates in the specified vault currently available for recovery.","tags":["DeletedCertificates"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/deletedcertificates/{certificate-name}":{"delete":{"description":"The PurgeDeletedCertificate operation performs an irreversible deletion of the specified certificate, without possibility for recovery. The operation is not available if the recovery level does not specify 'Purgeable'. This operation requires the certificate/purge permission.","operationId":"PurgeDeletedCertificate","parameters":[{"description":"The name of the certificate","in":"path","name":"certificate-name","required":true,"schema":{"type":"string"},"examples":{"PurgeDeletedCertificate":{"value":"deletedcertificates"}}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"204":{"description":"No content signaling that the certificate was purged forever."},"default":{"description":"Key Vault error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyVaultError"}}}}},"summary":"Permanently deletes the specified deleted certificate.","tags":["DeletedCertificates"]},"get":{"description":"The GetDeletedCertificate operation retrieves the deleted certificate information plus its attributes, such as retention interval, scheduled permanent deletion and the current deletion recovery level. This operation requires the certificates/get permission.","operationId":"GetDeletedCertificate","parameters":[{"description":"The name of the certificate","in":"path","name":"certificate-name","required":true,"schema":{"type":"string"},"examples":{"GetDeletedCertificate":{"value":"getDeletedCert"}}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"A Certificate bundle of the certificate and its attributes","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeletedCertificateBundle"},"examples":{"GetDeletedCertificate":{"$ref":"#/components/examples/GetDeletedCertificate"}}}}},"default":{"description":"Key Vault error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyVaultError"}}}}},"summary":"Retrieves information about the specified deleted certificate.","tags":["DeletedCertificates"]}},"/deletedcertificates/{certificate-name}/recover":{"post":{"description":"The RecoverDeletedCertificate operation performs the reversal of the Delete operation. The operation is applicable in vaults enabled for soft-delete, and must be issued during the retention interval (available in the deleted certificate's attributes). This operation requires the certificates/recover permission.","operationId":"RecoverDeletedCertificate","parameters":[{"description":"The name of the deleted certificate","in":"path","name":"certificate-name","required":true,"schema":{"type":"string"},"examples":{"RecoverDeletedCertificate":{"value":"CertCreateDeleteRecoverPurgeTest"}}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"A Certificate bundle of the original certificate and its attributes","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificateBundle"},"examples":{"RecoverDeletedCertificate":{"$ref":"#/components/examples/RecoverDeletedCertificate"}}}}},"default":{"description":"Key Vault error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyVaultError"}}}}},"summary":"Recovers the deleted certificate back to its current version under /certificates.","tags":["DeletedCertificates"]}},"/deletedkeys":{"get":{"description":"Retrieves a list of the keys in the Key Vault as JSON Web Key structures that contain the public part of a deleted key. This operation includes deletion-specific information. The Get Deleted Keys operation is applicable for vaults enabled for soft-delete. While the operation can be invoked on any vault, it will return an error if invoked on a non soft-delete enabled vault. This operation requires the keys/list permission.","operationId":"GetDeletedKeys","parameters":[{"description":"Maximum number of results to return in a page. If not specified the service will return up to 25 results.","in":"query","name":"maxresults","required":false,"schema":{"type":"integer","format":"int32","minimum":1,"maximum":25},"examples":{"GetDeletedKeys":{"value":"1"}}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"A response message containing a list of deleted keys in the vault along with a link to the next page of deleted keys.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeletedKeyListResult"},"examples":{"GetDeletedKeys":{"$ref":"#/components/examples/GetDeletedKeys"}}}}},"default":{"description":"Key Vault error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyVaultError"}}}}},"summary":"Lists the deleted keys in the specified vault.","tags":["DeletedKeys"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/deletedkeys/{key-name}":{"delete":{"description":"The Purge Deleted Key operation is applicable for soft-delete enabled vaults. While the operation can be invoked on any vault, it will return an error if invoked on a non soft-delete enabled vault. This operation requires the keys/purge permission.","operationId":"PurgeDeletedKey","parameters":[{"description":"The name of the key","in":"path","name":"key-name","required":true,"schema":{"type":"string"},"examples":{"PurgeDeletedKey":{"value":"testdeletedkey"}}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"204":{"description":"No content, signaling that the key was permanently purged."},"default":{"description":"Key Vault error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyVaultError"}}}}},"summary":"Permanently deletes the specified key.","tags":["DeletedKeys"]},"get":{"description":"The Get Deleted Key operation is applicable for soft-delete enabled vaults. While the operation can be invoked on any vault, it will return an error if invoked on a non soft-delete enabled vault. This operation requires the keys/get permission. ","operationId":"GetDeletedKey","parameters":[{"description":"The name of the key.","in":"path","name":"key-name","required":true,"schema":{"type":"string"},"examples":{"GetDeletedKey":{"value":"CreateSoftKeyTest"}}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"A DeletedKeyBundle consisting of a WebKey plus its Attributes and deletion information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeletedKeyBundle"},"examples":{"GetDeletedKey":{"$ref":"#/components/examples/GetDeletedKey"}}}}},"default":{"description":"Key Vault error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyVaultError"}}}}},"summary":"Gets the public part of a deleted key.","tags":["DeletedKeys"]}},"/deletedkeys/{key-name}/recover":{"post":{"description":"The Recover Deleted Key operation is applicable for deleted keys in soft-delete enabled vaults. It recovers the deleted key back to its latest version under /keys. An attempt to recover an non-deleted key will return an error. Consider this the inverse of the delete operation on soft-delete enabled vaults. This operation requires the keys/recover permission.","operationId":"RecoverDeletedKey","parameters":[{"description":"The name of the deleted key.","in":"path","name":"key-name","required":true,"schema":{"type":"string"},"examples":{"RecoverDeletedKey":{"value":"CreateDeleteRecoverPurgeTest"}}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"A Key bundle of the original key and its attributes","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyBundle"},"examples":{"RecoverDeletedKey":{"$ref":"#/components/examples/RecoverDeletedKey"}}}}},"default":{"description":"Key Vault error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyVaultError"}}}}},"summary":"Recovers the deleted key to its latest version.","tags":["DeletedKeys"]}},"/deletedsecrets":{"get":{"description":"The Get Deleted Secrets operation returns the secrets that have been deleted for a vault enabled for soft-delete. This operation requires the secrets/list permission.","operationId":"GetDeletedSecrets","parameters":[{"description":"Maximum number of results to return in a page. If not specified the service will return up to 25 results.","in":"query","name":"maxresults","required":false,"schema":{"type":"integer","format":"int32","minimum":1,"maximum":25},"examples":{"GetDeletedSecrets":{"value":"1"}}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"A response message containing a list of deleted secrets in the vault, along with a link to the next page of deleted secrets.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeletedSecretListResult"},"examples":{"GetDeletedSecrets":{"$ref":"#/components/examples/GetDeletedSecrets"}}}}},"default":{"description":"Key Vault error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyVaultError"}}}}},"summary":"Lists deleted secrets for the specified vault.","tags":["DeletedSecrets"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/deletedsecrets/{secret-name}":{"delete":{"description":"The purge deleted secret operation removes the secret permanently, without the possibility of recovery. This operation can only be enabled on a soft-delete enabled vault. This operation requires the secrets/purge permission.","operationId":"PurgeDeletedSecret","parameters":[{"description":"The name of the secret.","in":"path","name":"secret-name","required":true,"schema":{"type":"string"},"examples":{"PurgeDeletedSecret":{"value":"testsecret"}}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"204":{"description":"No content signaling that the secret was purged forever."},"default":{"description":"Key Vault error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyVaultError"}}}}},"summary":"Permanently deletes the specified secret.","tags":["DeletedSecrets"]},"get":{"description":"The Get Deleted Secret operation returns the specified deleted secret along with its attributes. This operation requires the secrets/get permission.","operationId":"GetDeletedSecret","parameters":[{"description":"The name of the secret.","in":"path","name":"secret-name","required":true,"schema":{"type":"string"},"examples":{"GetDeletedSecret":{"value":"GetDeletedSecretTest"}}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"A secret bundle of the secret and its attributes.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeletedSecretBundle"},"examples":{"GetDeletedSecret":{"$ref":"#/components/examples/GetDeletedSecret"}}}}},"default":{"description":"Key Vault error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyVaultError"}}}}},"summary":"Gets the specified deleted secret.","tags":["DeletedSecrets"]}},"/deletedsecrets/{secret-name}/recover":{"post":{"description":"Recovers the deleted secret in the specified vault. This operation can only be performed on a soft-delete enabled vault. This operation requires the secrets/recover permission.","operationId":"RecoverDeletedSecret","parameters":[{"description":"The name of the deleted secret.","in":"path","name":"secret-name","required":true,"schema":{"type":"string"},"examples":{"RecoverDeletedSecret":{"value":"SecretCreateDeleteRecoverPurgeTest"}}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"A Secret bundle of the original secret and its attributes.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecretBundle"},"examples":{"RecoverDeletedSecret":{"$ref":"#/components/examples/RecoverDeletedSecret"}}}}},"default":{"description":"Key Vault error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyVaultError"}}}}},"summary":"Recovers the deleted secret to the latest version.","tags":["DeletedSecrets"]}},"/deletedstorage":{"get":{"description":"The Get Deleted Storage Accounts operation returns the storage accounts that have been deleted for a vault enabled for soft-delete. This operation requires the storage/list permission.","operationId":"GetDeletedStorageAccounts","parameters":[{"description":"Maximum number of results to return in a page. If not specified the service will return up to 25 results.","in":"query","name":"maxresults","required":false,"schema":{"type":"integer","format":"int32","minimum":1,"maximum":25}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"A response message containing a list of deleted storage accounts in the vault, along with a link to the next page of deleted storage accounts.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeletedStorageListResult"},"examples":{"List Deleted Storage Accounts":{"$ref":"#/components/examples/List_Deleted_Storage_Accounts"}}}}},"default":{"description":"Key Vault error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyVaultError"}}}}},"summary":"Lists deleted storage accounts for the specified vault.","tags":["DeletedStorage"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/deletedstorage/{storage-account-name}":{"delete":{"description":"The purge deleted storage account operation removes the secret permanently, without the possibility of recovery. This operation can only be performed on a soft-delete enabled vault. This operation requires the storage/purge permission.","operationId":"PurgeDeletedStorageAccount","parameters":[{"description":"The name of the storage account.","in":"path","name":"storage-account-name","required":true,"schema":{"type":"string","pattern":"^[0-9a-zA-Z]+$"},"examples":{"Purge Deleted Storage Account":{"value":"purgeStrg01"}}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"204":{"description":"No content signaling that the storage account was purged forever."},"default":{"description":"Key Vault error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyVaultError"}}}}},"summary":"Permanently deletes the specified storage account.","tags":["DeletedStorage"]},"get":{"description":"The Get Deleted Storage Account operation returns the specified deleted storage account along with its attributes. This operation requires the storage/get permission.","operationId":"GetDeletedStorageAccount","parameters":[{"description":"The name of the storage account.","in":"path","name":"storage-account-name","required":true,"schema":{"type":"string","pattern":"^[0-9a-zA-Z]+$"},"examples":{"Get Deleted Storage":{"value":"deleteStrg01"}}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"The deleted storage account and information on when it will be purged, and how to recover the deleted storage account.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeletedStorageBundle"},"examples":{"Get Deleted Storage":{"$ref":"#/components/examples/Get_Deleted_Storage"}}}}},"default":{"description":"Key Vault error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyVaultError"}}}}},"summary":"Gets the specified deleted storage account.","tags":["DeletedStorage"]}},"/deletedstorage/{storage-account-name}/recover":{"post":{"description":"Recovers the deleted storage account in the specified vault. This operation can only be performed on a soft-delete enabled vault. This operation requires the storage/recover permission.","operationId":"RecoverDeletedStorageAccount","parameters":[{"description":"The name of the storage account.","in":"path","name":"storage-account-name","required":true,"schema":{"type":"string","pattern":"^[0-9a-zA-Z]+$"},"examples":{"Recover Deleted Storage Account":{"value":"recoverStrg01"}}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"A storage bundle of the original storage account and its attributes.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorageBundle"},"examples":{"Recover Deleted Storage Account":{"$ref":"#/components/examples/Recover_Deleted_Storage_Account"}}}}},"default":{"description":"Key Vault error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyVaultError"}}}}},"summary":"Recovers the deleted storage account.","tags":["DeletedStorage"]}},"/deletedstorage/{storage-account-name}/sas":{"get":{"description":"The Get Deleted Sas Definitions operation returns the SAS definitions that have been deleted for a vault enabled for soft-delete. This operation requires the storage/listsas permission.","operationId":"GetDeletedSasDefinitions","parameters":[{"description":"The name of the storage account.","in":"path","name":"storage-account-name","required":true,"schema":{"type":"string","pattern":"^[0-9a-zA-Z]+$"},"examples":{"List Deleted Storage Sas Definitions":{"value":"listsas01"}}},{"description":"Maximum number of results to return in a page. If not specified the service will return up to 25 results.","in":"query","name":"maxresults","required":false,"schema":{"type":"integer","format":"int32","minimum":1,"maximum":25}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"A response message containing a list of deleted SAS definitions for the storage account, along with a link to the next page of deleted SAS definitions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeletedSasDefinitionListResult"},"examples":{"List Deleted Storage Sas Definitions":{"$ref":"#/components/examples/List_Deleted_Storage_Sas_Definitions"}}}}},"default":{"description":"Key Vault error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyVaultError"}}}}},"summary":"Lists deleted SAS definitions for the specified vault and storage account.","tags":["DeletedStorage"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/deletedstorage/{storage-account-name}/sas/{sas-definition-name}":{"get":{"description":"The Get Deleted SAS Definition operation returns the specified deleted SAS definition along with its attributes. This operation requires the storage/getsas permission.","operationId":"GetDeletedSasDefinition","parameters":[{"description":"The name of the storage account.","in":"path","name":"storage-account-name","required":true,"schema":{"type":"string","pattern":"^[0-9a-zA-Z]+$"},"examples":{"Get Deleted Storage Sas Definition":{"value":"deletesas01"}}},{"description":"The name of the SAS definition.","in":"path","name":"sas-definition-name","required":true,"schema":{"type":"string","pattern":"^[0-9a-zA-Z]+$"},"examples":{"Get Deleted Storage Sas Definition":{"value":"deleteStrgSasDef01"}}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"The deleted SAS definition and information on when the it will be purged, and how to recover the deleted SAS definition.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeletedSasDefinitionBundle"},"examples":{"Get Deleted Storage Sas Definition":{"$ref":"#/components/examples/Get_Deleted_Storage_Sas_Definition"}}}}},"default":{"description":"Key Vault error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyVaultError"}}}}},"summary":"Gets the specified deleted sas definition.","tags":["DeletedStorage"]}},"/deletedstorage/{storage-account-name}/sas/{sas-definition-name}/recover":{"post":{"description":"Recovers the deleted SAS definition for the specified storage account. This operation can only be performed on a soft-delete enabled vault. This operation requires the storage/recover permission.","operationId":"RecoverDeletedSasDefinition","parameters":[{"description":"The name of the storage account.","in":"path","name":"storage-account-name","required":true,"schema":{"type":"string","pattern":"^[0-9a-zA-Z]+$"},"examples":{"Recover Deleted Storage Sas Definition":{"value":"recoversas01"}}},{"description":"The name of the SAS definition.","in":"path","name":"sas-definition-name","required":true,"schema":{"type":"string","pattern":"^[0-9a-zA-Z]+$"},"examples":{"Recover Deleted Storage Sas Definition":{"value":"recoverStrgSasDef01"}}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"descrip