Microsoft.KeyVault (preview:7.6.1)

2025/01/17 • 12 updated methods

GetDeletedSecrets (updated)
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.
Reference :  Link ¶

⚶ Changes

{
  "#id": "GetDeletedSecrets",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client API version."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "A response message containing a list of deleted secrets in the key vault along with a link to the next page of deleted secrets.",
            "old": "A response message containing a list of the deleted secrets in the vault along with a link to the next page of deleted secrets"
          },
          "$items": {
            "$properties": {
              "@added_e7b7a3577a214f1dbd3f1ffec04c32c2": {
                "#name": "id",
                "Description": "Secret identifier.",
                "Required": false,
                "Type": "string"
              },
              "@added_4dc4b2b875404fa187ebccf860df5cbb": {
                "#name": "attributes",
                "Description": "The secret management attributes.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "enabled",
                    "Description": "Determines whether the object is enabled.",
                    "Required": false,
                    "Type": "boolean"
                  },
                  {
                    "#name": "nbf",
                    "Description": "Not before date in UTC.",
                    "Format": "unixtime",
                    "Required": false,
                    "Type": "integer"
                  },
                  {
                    "#name": "exp",
                    "Description": "Expiry date in UTC.",
                    "Format": "unixtime",
                    "Required": false,
                    "Type": "integer"
                  },
                  {
                    "#name": "created",
                    "Description": "Creation time in UTC.",
                    "Format": "unixtime",
                    "Required": false,
                    "Type": "integer"
                  },
                  {
                    "#name": "updated",
                    "Description": "Last updated time in UTC.",
                    "Format": "unixtime",
                    "Required": false,
                    "Type": "integer"
                  },
                  {
                    "#name": "recoverableDays",
                    "Description": "softDelete data retention days. Value should be >=7 and <=90 when softDelete enabled, otherwise 0.",
                    "Format": "int32",
                    "Required": false,
                    "Type": "integer"
                  },
                  {
                    "#name": "recoveryLevel",
                    "Description": "Reflects the deletion recovery level currently in effect for secrets in the current vault. If it contains 'Purgeable', the secret can be permanently deleted by a privileged user; otherwise, only the system can purge the secret, at the end of the retention interval.",
                    "Enum": [
                      [
                        "Purgeable",
                        "Denotes a vault state in which deletion is an irreversible operation, without the possibility for recovery. This level corresponds to no protection being available against a Delete operation; the data is irretrievably lost upon accepting a Delete operation at the entity level or higher (vault, resource group, subscription etc.)"
                      ],
                      [
                        "Recoverable+Purgeable",
                        "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days), unless a Purge operation is requested, or the subscription is cancelled. System wil permanently delete it after 90 days, if not recovered"
                      ],
                      [
                        "Recoverable",
                        "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days) and while the subscription is still available. System wil permanently delete it after 90 days, if not recovered"
                      ],
                      [
                        "Recoverable+ProtectedSubscription",
                        "Denotes a vault and subscription state in which deletion is recoverable within retention interval (90 days), immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself  cannot be permanently canceled. System wil permanently delete it after 90 days, if not recovered"
                      ],
                      [
                        "CustomizedRecoverable+Purgeable",
                        "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge when 7 <= SoftDeleteRetentionInDays < 90). This level guarantees the recoverability of the deleted entity during the retention interval, unless a Purge operation is requested, or the subscription is cancelled."
                      ],
                      [
                        "CustomizedRecoverable",
                        "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge when 7 <= SoftDeleteRetentionInDays < 90).This level guarantees the recoverability of the deleted entity during the retention interval and while the subscription is still available."
                      ],
                      [
                        "CustomizedRecoverable+ProtectedSubscription",
                        "Denotes a vault and subscription state in which deletion is recoverable, immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled when 7 <= SoftDeleteRetentionInDays < 90. This level guarantees the recoverability of the deleted entity during the retention interval, and also reflects the fact that the subscription itself cannot be cancelled."
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  }
                ]
              },
              "@added_4eda757927dd46388aee6b3d0151d468": {
                "#name": "tags",
                "Description": "Application specific metadata in the form of key-value pairs.",
                "Required": false,
                "Type": "object"
              },
              "@added_9aac2abfe8404143b83f1fc833d42041": {
                "#name": "contentType",
                "Description": "Type of the secret value such as a password.",
                "Required": false,
                "Type": "string"
              },
              "@added_e4d1f1cc0584410e850c726a2bf9add9": {
                "#name": "managed",
                "Description": "True if the secret's lifetime is managed by key vault. If this is a key backing a certificate, then managed will be true.",
                "Required": false,
                "Type": "boolean"
              }
            }
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /deletedsecrets
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
maxresults:
{
Description: Maximum number of results to return in a page. If not specified the service will return up to 25 results. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: A response message containing a list of deleted secrets in the key vault along with a link to the next page of deleted secrets. ,
Required: False ,
}
[
{
id:
{
Description: Secret identifier. ,
Required: False ,
}
string ,
attributes:
{
Description: The secret management attributes. ,
Required: False ,
}
{
enabled:
{
Description: Determines whether the object is enabled. ,
Required: False ,
}
boolean ,
nbf:
{
Description: Not before date in UTC. ,
Format: unixtime ,
Required: False ,
}
integer ,
exp:
{
Description: Expiry date in UTC. ,
Format: unixtime ,
Required: False ,
}
integer ,
created:
{
Description: Creation time in UTC. ,
Format: unixtime ,
Required: False ,
}
integer ,
updated:
{
Description: Last updated time in UTC. ,
Format: unixtime ,
Required: False ,
}
integer ,
recoverableDays:
{
Description: softDelete data retention days. Value should be >=7 and <=90 when softDelete enabled, otherwise 0. ,
Format: int32 ,
Required: False ,
}
integer ,
recoveryLevel:
{
Description: Reflects the deletion recovery level currently in effect for secrets in the current vault. If it contains 'Purgeable', the secret can be permanently deleted by a privileged user; otherwise, only the system can purge the secret, at the end of the retention interval. ,
Enum:
{
Purgeable: Denotes a vault state in which deletion is an irreversible operation, without the possibility for recovery. This level corresponds to no protection being available against a Delete operation; the data is irretrievably lost upon accepting a Delete operation at the entity level or higher (vault, resource group, subscription etc.) ,
Recoverable+Purgeable: Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days), unless a Purge operation is requested, or the subscription is cancelled. System wil permanently delete it after 90 days, if not recovered ,
Recoverable: Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days) and while the subscription is still available. System wil permanently delete it after 90 days, if not recovered ,
Recoverable+ProtectedSubscription: Denotes a vault and subscription state in which deletion is recoverable within retention interval (90 days), immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled. System wil permanently delete it after 90 days, if not recovered ,
CustomizedRecoverable+Purgeable: Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge when 7 <= SoftDeleteRetentionInDays < 90). This level guarantees the recoverability of the deleted entity during the retention interval, unless a Purge operation is requested, or the subscription is cancelled. ,
CustomizedRecoverable: Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge when 7 <= SoftDeleteRetentionInDays < 90).This level guarantees the recoverability of the deleted entity during the retention interval and while the subscription is still available. ,
CustomizedRecoverable+ProtectedSubscription: Denotes a vault and subscription state in which deletion is recoverable, immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled when 7 <= SoftDeleteRetentionInDays < 90. This level guarantees the recoverability of the deleted entity during the retention interval, and also reflects the fact that the subscription itself cannot be cancelled. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Application specific metadata in the form of key-value pairs. ,
Required: False ,
}
object ,
contentType:
{
Description: Type of the secret value such as a password. ,
Required: False ,
}
string ,
managed:
{
Description: True if the secret's lifetime is managed by key vault. If this is a key backing a certificate, then managed will be true. ,
Required: False ,
}
boolean ,
recoveryId:
{
Description: The url of the recovery object, used to identify and recover the deleted secret. ,
Required: False ,
}
string ,
scheduledPurgeDate:
{
Description: The time when the secret is scheduled to be purged, in UTC ,
Format: unixtime ,
Required: False ,
}
integer ,
deletedDate:
{
Description: The time when the secret was deleted, in UTC ,
Format: unixtime ,
Required: False ,
}
integer ,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of deleted secrets. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The key vault server error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
GetDeletedSecret (updated)
Description :  The Get Deleted Secret operation returns the specified deleted secret along with its attributes. This operation requires the secrets/get permission.
Reference :  Link ¶

⚶ Changes

{
  "#id": "GetDeletedSecret",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client API version."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@added_8d16d02e25d544e89f3aec36d6ce95fb": {
          "#name": "value",
          "Description": "The secret value.",
          "Required": false,
          "Type": "string"
        },
        "@added_ea381a69390a4ade877c0c3778a6a42e": {
          "#name": "id",
          "Description": "The secret id.",
          "Required": false,
          "Type": "string"
        },
        "@added_1d4061f9fca442b89fa97a297e57693e": {
          "#name": "contentType",
          "Description": "The content type of the secret.",
          "Required": false,
          "Type": "string"
        },
        "@added_ee33a20b8075484d957bc56f5a352a47": {
          "#name": "attributes",
          "Description": "The secret management attributes.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "enabled",
              "Description": "Determines whether the object is enabled.",
              "Required": false,
              "Type": "boolean"
            },
            {
              "#name": "nbf",
              "Description": "Not before date in UTC.",
              "Format": "unixtime",
              "Required": false,
              "Type": "integer"
            },
            {
              "#name": "exp",
              "Description": "Expiry date in UTC.",
              "Format": "unixtime",
              "Required": false,
              "Type": "integer"
            },
            {
              "#name": "created",
              "Description": "Creation time in UTC.",
              "Format": "unixtime",
              "Required": false,
              "Type": "integer"
            },
            {
              "#name": "updated",
              "Description": "Last updated time in UTC.",
              "Format": "unixtime",
              "Required": false,
              "Type": "integer"
            },
            {
              "#name": "recoverableDays",
              "Description": "softDelete data retention days. Value should be >=7 and <=90 when softDelete enabled, otherwise 0.",
              "Format": "int32",
              "Required": false,
              "Type": "integer"
            },
            {
              "#name": "recoveryLevel",
              "Description": "Reflects the deletion recovery level currently in effect for secrets in the current vault. If it contains 'Purgeable', the secret can be permanently deleted by a privileged user; otherwise, only the system can purge the secret, at the end of the retention interval.",
              "Enum": [
                [
                  "Purgeable",
                  "Denotes a vault state in which deletion is an irreversible operation, without the possibility for recovery. This level corresponds to no protection being available against a Delete operation; the data is irretrievably lost upon accepting a Delete operation at the entity level or higher (vault, resource group, subscription etc.)"
                ],
                [
                  "Recoverable+Purgeable",
                  "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days), unless a Purge operation is requested, or the subscription is cancelled. System wil permanently delete it after 90 days, if not recovered"
                ],
                [
                  "Recoverable",
                  "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days) and while the subscription is still available. System wil permanently delete it after 90 days, if not recovered"
                ],
                [
                  "Recoverable+ProtectedSubscription",
                  "Denotes a vault and subscription state in which deletion is recoverable within retention interval (90 days), immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself  cannot be permanently canceled. System wil permanently delete it after 90 days, if not recovered"
                ],
                [
                  "CustomizedRecoverable+Purgeable",
                  "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge when 7 <= SoftDeleteRetentionInDays < 90). This level guarantees the recoverability of the deleted entity during the retention interval, unless a Purge operation is requested, or the subscription is cancelled."
                ],
                [
                  "CustomizedRecoverable",
                  "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge when 7 <= SoftDeleteRetentionInDays < 90).This level guarantees the recoverability of the deleted entity during the retention interval and while the subscription is still available."
                ],
                [
                  "CustomizedRecoverable+ProtectedSubscription",
                  "Denotes a vault and subscription state in which deletion is recoverable, immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled when 7 <= SoftDeleteRetentionInDays < 90. This level guarantees the recoverability of the deleted entity during the retention interval, and also reflects the fact that the subscription itself cannot be cancelled."
                ]
              ],
              "Required": false,
              "Type": "string"
            }
          ]
        },
        "@added_a405f16ae4fc4f418fc05d17f2c4864d": {
          "#name": "tags",
          "Description": "Application specific metadata in the form of key-value pairs.",
          "Required": false,
          "Type": "object"
        },
        "@added_4139064370b04edd846a08538981482a": {
          "#name": "kid",
          "Description": "If this is a secret backing a KV certificate, then this field specifies the corresponding key backing the KV certificate.",
          "Required": false,
          "Type": "string"
        },
        "@added_2079b2ad55574a4d9f1070d1a2b430a0": {
          "#name": "managed",
          "Description": "True if the secret's lifetime is managed by key vault. If this is a secret backing a certificate, then managed will be true.",
          "Required": false,
          "Type": "boolean"
        }
      }
    }
  }
}

⚼ Request

GET:  /deletedsecrets/{secret-name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
secret-name:
{
Description: The name of the secret. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The secret value. ,
Required: False ,
}
string ,
id:
{
Description: The secret id. ,
Required: False ,
}
string ,
contentType:
{
Description: The content type of the secret. ,
Required: False ,
}
string ,
attributes:
{
Description: The secret management attributes. ,
Required: False ,
}
{
enabled:
{
Description: Determines whether the object is enabled. ,
Required: False ,
}
boolean ,
nbf:
{
Description: Not before date in UTC. ,
Format: unixtime ,
Required: False ,
}
integer ,
exp:
{
Description: Expiry date in UTC. ,
Format: unixtime ,
Required: False ,
}
integer ,
created:
{
Description: Creation time in UTC. ,
Format: unixtime ,
Required: False ,
}
integer ,
updated:
{
Description: Last updated time in UTC. ,
Format: unixtime ,
Required: False ,
}
integer ,
recoverableDays:
{
Description: softDelete data retention days. Value should be >=7 and <=90 when softDelete enabled, otherwise 0. ,
Format: int32 ,
Required: False ,
}
integer ,
recoveryLevel:
{
Description: Reflects the deletion recovery level currently in effect for secrets in the current vault. If it contains 'Purgeable', the secret can be permanently deleted by a privileged user; otherwise, only the system can purge the secret, at the end of the retention interval. ,
Enum:
{
Purgeable: Denotes a vault state in which deletion is an irreversible operation, without the possibility for recovery. This level corresponds to no protection being available against a Delete operation; the data is irretrievably lost upon accepting a Delete operation at the entity level or higher (vault, resource group, subscription etc.) ,
Recoverable+Purgeable: Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days), unless a Purge operation is requested, or the subscription is cancelled. System wil permanently delete it after 90 days, if not recovered ,
Recoverable: Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days) and while the subscription is still available. System wil permanently delete it after 90 days, if not recovered ,
Recoverable+ProtectedSubscription: Denotes a vault and subscription state in which deletion is recoverable within retention interval (90 days), immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled. System wil permanently delete it after 90 days, if not recovered ,
CustomizedRecoverable+Purgeable: Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge when 7 <= SoftDeleteRetentionInDays < 90). This level guarantees the recoverability of the deleted entity during the retention interval, unless a Purge operation is requested, or the subscription is cancelled. ,
CustomizedRecoverable: Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge when 7 <= SoftDeleteRetentionInDays < 90).This level guarantees the recoverability of the deleted entity during the retention interval and while the subscription is still available. ,
CustomizedRecoverable+ProtectedSubscription: Denotes a vault and subscription state in which deletion is recoverable, immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled when 7 <= SoftDeleteRetentionInDays < 90. This level guarantees the recoverability of the deleted entity during the retention interval, and also reflects the fact that the subscription itself cannot be cancelled. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Application specific metadata in the form of key-value pairs. ,
Required: False ,
}
object ,
kid:
{
Description: If this is a secret backing a KV certificate, then this field specifies the corresponding key backing the KV certificate. ,
Required: False ,
}
string ,
managed:
{
Description: True if the secret's lifetime is managed by key vault. If this is a secret backing a certificate, then managed will be true. ,
Required: False ,
}
boolean ,
recoveryId:
{
Description: The url of the recovery object, used to identify and recover the deleted secret. ,
Required: False ,
}
string ,
scheduledPurgeDate:
{
Description: The time when the secret is scheduled to be purged, in UTC ,
Format: unixtime ,
Required: False ,
}
integer ,
deletedDate:
{
Description: The time when the secret was deleted, in UTC ,
Format: unixtime ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The key vault server error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
PurgeDeletedSecret (updated)
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.
Reference :  Link ¶

⚶ Changes

{
  "#id": "PurgeDeletedSecret",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client API version."
      }
    }
  ]
}

⚼ Request

DELETE:  /deletedsecrets/{secret-name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
secret-name:
{
Description: The name of the secret. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The key vault server error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
RecoverDeletedSecret (updated)
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.
Reference :  Link ¶

⚶ Changes

{
  "#id": "RecoverDeletedSecret",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client API version."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "attributes": [
          {
            "@added_5a75361cd8064978ad548b3185f900fc": {
              "#name": "enabled",
              "Description": "Determines whether the object is enabled.",
              "Required": false,
              "Type": "boolean"
            }
          },
          {
            "@added_c74e02b13254445fbb4ccc962388d2a0": {
              "#name": "nbf",
              "Description": "Not before date in UTC.",
              "Format": "unixtime",
              "Required": false,
              "Type": "integer"
            }
          },
          {
            "@added_330ae1000ac046b3b53ed94cdc68b87c": {
              "#name": "exp",
              "Description": "Expiry date in UTC.",
              "Format": "unixtime",
              "Required": false,
              "Type": "integer"
            }
          },
          {
            "@added_9bb686ef076d43aaa6e6ceb245bd3f80": {
              "#name": "created",
              "Description": "Creation time in UTC.",
              "Format": "unixtime",
              "Required": false,
              "Type": "integer"
            }
          },
          {
            "@added_aa0c65a44b7d4d719e771519e113e90c": {
              "#name": "updated",
              "Description": "Last updated time in UTC.",
              "Format": "unixtime",
              "Required": false,
              "Type": "integer"
            }
          },
          {
            "#name": "recoveryLevel",
            "Enum": {
              "new": [
                [
                  "Purgeable",
                  "Denotes a vault state in which deletion is an irreversible operation, without the possibility for recovery. This level corresponds to no protection being available against a Delete operation; the data is irretrievably lost upon accepting a Delete operation at the entity level or higher (vault, resource group, subscription etc.)"
                ],
                [
                  "Recoverable+Purgeable",
                  "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days), unless a Purge operation is requested, or the subscription is cancelled. System wil permanently delete it after 90 days, if not recovered"
                ],
                [
                  "Recoverable",
                  "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days) and while the subscription is still available. System wil permanently delete it after 90 days, if not recovered"
                ],
                [
                  "Recoverable+ProtectedSubscription",
                  "Denotes a vault and subscription state in which deletion is recoverable within retention interval (90 days), immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself  cannot be permanently canceled. System wil permanently delete it after 90 days, if not recovered"
                ],
                [
                  "CustomizedRecoverable+Purgeable",
                  "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge when 7 <= SoftDeleteRetentionInDays < 90). This level guarantees the recoverability of the deleted entity during the retention interval, unless a Purge operation is requested, or the subscription is cancelled."
                ],
                [
                  "CustomizedRecoverable",
                  "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge when 7 <= SoftDeleteRetentionInDays < 90).This level guarantees the recoverability of the deleted entity during the retention interval and while the subscription is still available."
                ],
                [
                  "CustomizedRecoverable+ProtectedSubscription",
                  "Denotes a vault and subscription state in which deletion is recoverable, immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled when 7 <= SoftDeleteRetentionInDays < 90. This level guarantees the recoverability of the deleted entity during the retention interval, and also reflects the fact that the subscription itself cannot be cancelled."
                ]
              ],
              "old": [
                [
                  "Purgeable",
                  "Denotes a vault state in which deletion is an irreversible operation, without the possibility for recovery. This level corresponds to no protection being available against a Delete operation; the data is irretrievably lost upon accepting a Delete operation at the entity level or higher (vault, resource group, subscription etc.)"
                ],
                [
                  "Recoverable+Purgeable",
                  "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days), unless a Purge operation is requested, or the subscription is cancelled. System wil permanently delete it after 90 days, if not recovered"
                ],
                [
                  "Recoverable",
                  "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval(90 days) and while the subscription is still available. System wil permanently delete it after 90 days, if not recovered"
                ],
                [
                  "Recoverable+ProtectedSubscription",
                  "Denotes a vault and subscription state in which deletion is recoverable within retention interval (90 days), immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself  cannot be permanently canceled. System wil permanently delete it after 90 days, if not recovered"
                ],
                [
                  "CustomizedRecoverable+Purgeable",
                  "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge when 7<= SoftDeleteRetentionInDays < 90). This level guarantees the recoverability of the deleted entity during the retention interval, unless a Purge operation is requested, or the subscription is cancelled."
                ],
                [
                  "CustomizedRecoverable",
                  "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge when 7<= SoftDeleteRetentionInDays < 90).This level guarantees the recoverability of the deleted entity during the retention interval and while the subscription is still available."
                ],
                [
                  "CustomizedRecoverable+ProtectedSubscription",
                  "Denotes a vault and subscription state in which deletion is recoverable, immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled when 7<= SoftDeleteRetentionInDays < 90. This level guarantees the recoverability of the deleted entity during the retention interval, and also reflects the fact that the subscription itself cannot be cancelled."
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /deletedsecrets/{secret-name}/recover
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
secret-name:
{
Description: The name of the deleted secret. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The secret value. ,
Required: False ,
}
string ,
id:
{
Description: The secret id. ,
Required: False ,
}
string ,
contentType:
{
Description: The content type of the secret. ,
Required: False ,
}
string ,
attributes:
{
Description: The secret management attributes. ,
Required: False ,
}
{
enabled:
{
Description: Determines whether the object is enabled. ,
Required: False ,
}
boolean ,
nbf:
{
Description: Not before date in UTC. ,
Format: unixtime ,
Required: False ,
}
integer ,
exp:
{
Description: Expiry date in UTC. ,
Format: unixtime ,
Required: False ,
}
integer ,
created:
{
Description: Creation time in UTC. ,
Format: unixtime ,
Required: False ,
}
integer ,
updated:
{
Description: Last updated time in UTC. ,
Format: unixtime ,
Required: False ,
}
integer ,
recoverableDays:
{
Description: softDelete data retention days. Value should be >=7 and <=90 when softDelete enabled, otherwise 0. ,
Format: int32 ,
Required: False ,
}
integer ,
recoveryLevel:
{
Description: Reflects the deletion recovery level currently in effect for secrets in the current vault. If it contains 'Purgeable', the secret can be permanently deleted by a privileged user; otherwise, only the system can purge the secret, at the end of the retention interval. ,
Enum:
{
Purgeable: Denotes a vault state in which deletion is an irreversible operation, without the possibility for recovery. This level corresponds to no protection being available against a Delete operation; the data is irretrievably lost upon accepting a Delete operation at the entity level or higher (vault, resource group, subscription etc.) ,
Recoverable+Purgeable: Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days), unless a Purge operation is requested, or the subscription is cancelled. System wil permanently delete it after 90 days, if not recovered ,
Recoverable: Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days) and while the subscription is still available. System wil permanently delete it after 90 days, if not recovered ,
Recoverable+ProtectedSubscription: Denotes a vault and subscription state in which deletion is recoverable within retention interval (90 days), immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled. System wil permanently delete it after 90 days, if not recovered ,
CustomizedRecoverable+Purgeable: Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge when 7 <= SoftDeleteRetentionInDays < 90). This level guarantees the recoverability of the deleted entity during the retention interval, unless a Purge operation is requested, or the subscription is cancelled. ,
CustomizedRecoverable: Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge when 7 <= SoftDeleteRetentionInDays < 90).This level guarantees the recoverability of the deleted entity during the retention interval and while the subscription is still available. ,
CustomizedRecoverable+ProtectedSubscription: Denotes a vault and subscription state in which deletion is recoverable, immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled when 7 <= SoftDeleteRetentionInDays < 90. This level guarantees the recoverability of the deleted entity during the retention interval, and also reflects the fact that the subscription itself cannot be cancelled. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Application specific metadata in the form of key-value pairs. ,
Required: False ,
}
object ,
kid:
{
Description: If this is a secret backing a KV certificate, then this field specifies the corresponding key backing the KV certificate. ,
Required: False ,
}
string ,
managed:
{
Description: True if the secret's lifetime is managed by key vault. If this is a secret backing a certificate, then managed will be true. ,
Required: False ,
}
boolean ,
}

⚐ Response (default)

{
error:
{
Description: The key vault server error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
GetSecrets (updated)
Description :  The Get Secrets operation is applicable to the entire vault. However, only the base secret identifier and its attributes are provided in the response. Individual secret versions are not listed in the response. This operation requires the secrets/list permission.
Reference :  Link ¶

⚶ Changes

{
  "#id": "GetSecrets",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client API version."
      }
    },
    {
      "#name": "maxresults",
      "Description": {
        "new": "Maximum number of results to return in a page. If not specified the service will return up to 25 results.",
        "old": "Maximum number of results to return in a page. If not specified, the service will return up to 25 results."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "attributes": [
              {
                "@added_f77e514e85794fafb098c664c410b792": {
                  "#name": "enabled",
                  "Description": "Determines whether the object is enabled.",
                  "Required": false,
                  "Type": "boolean"
                }
              },
              {
                "@added_e95eb6c26c4d49259521d1aeea4e3de5": {
                  "#name": "nbf",
                  "Description": "Not before date in UTC.",
                  "Format": "unixtime",
                  "Required": false,
                  "Type": "integer"
                }
              },
              {
                "@added_70a6db322013420f9caa36d78f2295b4": {
                  "#name": "exp",
                  "Description": "Expiry date in UTC.",
                  "Format": "unixtime",
                  "Required": false,
                  "Type": "integer"
                }
              },
              {
                "@added_8d40d03c06f94f6996b47922ecdab686": {
                  "#name": "created",
                  "Description": "Creation time in UTC.",
                  "Format": "unixtime",
                  "Required": false,
                  "Type": "integer"
                }
              },
              {
                "@added_5251371c9bbf42c0bc62f3497ba2dae4": {
                  "#name": "updated",
                  "Description": "Last updated time in UTC.",
                  "Format": "unixtime",
                  "Required": false,
                  "Type": "integer"
                }
              },
              {
                "#name": "recoveryLevel",
                "Enum": {
                  "new": [
                    [
                      "Purgeable",
                      "Denotes a vault state in which deletion is an irreversible operation, without the possibility for recovery. This level corresponds to no protection being available against a Delete operation; the data is irretrievably lost upon accepting a Delete operation at the entity level or higher (vault, resource group, subscription etc.)"
                    ],
                    [
                      "Recoverable+Purgeable",
                      "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days), unless a Purge operation is requested, or the subscription is cancelled. System wil permanently delete it after 90 days, if not recovered"
                    ],
                    [
                      "Recoverable",
                      "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days) and while the subscription is still available. System wil permanently delete it after 90 days, if not recovered"
                    ],
                    [
                      "Recoverable+ProtectedSubscription",
                      "Denotes a vault and subscription state in which deletion is recoverable within retention interval (90 days), immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself  cannot be permanently canceled. System wil permanently delete it after 90 days, if not recovered"
                    ],
                    [
                      "CustomizedRecoverable+Purgeable",
                      "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge when 7 <= SoftDeleteRetentionInDays < 90). This level guarantees the recoverability of the deleted entity during the retention interval, unless a Purge operation is requested, or the subscription is cancelled."
                    ],
                    [
                      "CustomizedRecoverable",
                      "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge when 7 <= SoftDeleteRetentionInDays < 90).This level guarantees the recoverability of the deleted entity during the retention interval and while the subscription is still available."
                    ],
                    [
                      "CustomizedRecoverable+ProtectedSubscription",
                      "Denotes a vault and subscription state in which deletion is recoverable, immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled when 7 <= SoftDeleteRetentionInDays < 90. This level guarantees the recoverability of the deleted entity during the retention interval, and also reflects the fact that the subscription itself cannot be cancelled."
                    ]
                  ],
                  "old": [
                    [
                      "Purgeable",
                      "Denotes a vault state in which deletion is an irreversible operation, without the possibility for recovery. This level corresponds to no protection being available against a Delete operation; the data is irretrievably lost upon accepting a Delete operation at the entity level or higher (vault, resource group, subscription etc.)"
                    ],
                    [
                      "Recoverable+Purgeable",
                      "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days), unless a Purge operation is requested, or the subscription is cancelled. System wil permanently delete it after 90 days, if not recovered"
                    ],
                    [
                      "Recoverable",
                      "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval(90 days) and while the subscription is still available. System wil permanently delete it after 90 days, if not recovered"
                    ],
                    [
                      "Recoverable+ProtectedSubscription",
                      "Denotes a vault and subscription state in which deletion is recoverable within retention interval (90 days), immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself  cannot be permanently canceled. System wil permanently delete it after 90 days, if not recovered"
                    ],
                    [
                      "CustomizedRecoverable+Purgeable",
                      "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge when 7<= SoftDeleteRetentionInDays < 90). This level guarantees the recoverability of the deleted entity during the retention interval, unless a Purge operation is requested, or the subscription is cancelled."
                    ],
                    [
                      "CustomizedRecoverable",
                      "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge when 7<= SoftDeleteRetentionInDays < 90).This level guarantees the recoverability of the deleted entity during the retention interval and while the subscription is still available."
                    ],
                    [
                      "CustomizedRecoverable+ProtectedSubscription",
                      "Denotes a vault and subscription state in which deletion is recoverable, immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled when 7<= SoftDeleteRetentionInDays < 90. This level guarantees the recoverability of the deleted entity during the retention interval, and also reflects the fact that the subscription itself cannot be cancelled."
                    ]
                  ]
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /secrets
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
maxresults:
{
Description: Maximum number of results to return in a page. If not specified the service will return up to 25 results. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: A response message containing a list of secrets in the key vault along with a link to the next page of secrets. ,
Required: False ,
}
[
{
id:
{
Description: Secret identifier. ,
Required: False ,
}
string ,
attributes:
{
Description: The secret management attributes. ,
Required: False ,
}
{
enabled:
{
Description: Determines whether the object is enabled. ,
Required: False ,
}
boolean ,
nbf:
{
Description: Not before date in UTC. ,
Format: unixtime ,
Required: False ,
}
integer ,
exp:
{
Description: Expiry date in UTC. ,
Format: unixtime ,
Required: False ,
}
integer ,
created:
{
Description: Creation time in UTC. ,
Format: unixtime ,
Required: False ,
}
integer ,
updated:
{
Description: Last updated time in UTC. ,
Format: unixtime ,
Required: False ,
}
integer ,
recoverableDays:
{
Description: softDelete data retention days. Value should be >=7 and <=90 when softDelete enabled, otherwise 0. ,
Format: int32 ,
Required: False ,
}
integer ,
recoveryLevel:
{
Description: Reflects the deletion recovery level currently in effect for secrets in the current vault. If it contains 'Purgeable', the secret can be permanently deleted by a privileged user; otherwise, only the system can purge the secret, at the end of the retention interval. ,
Enum:
{
Purgeable: Denotes a vault state in which deletion is an irreversible operation, without the possibility for recovery. This level corresponds to no protection being available against a Delete operation; the data is irretrievably lost upon accepting a Delete operation at the entity level or higher (vault, resource group, subscription etc.) ,
Recoverable+Purgeable: Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days), unless a Purge operation is requested, or the subscription is cancelled. System wil permanently delete it after 90 days, if not recovered ,
Recoverable: Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days) and while the subscription is still available. System wil permanently delete it after 90 days, if not recovered ,
Recoverable+ProtectedSubscription: Denotes a vault and subscription state in which deletion is recoverable within retention interval (90 days), immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled. System wil permanently delete it after 90 days, if not recovered ,
CustomizedRecoverable+Purgeable: Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge when 7 <= SoftDeleteRetentionInDays < 90). This level guarantees the recoverability of the deleted entity during the retention interval, unless a Purge operation is requested, or the subscription is cancelled. ,
CustomizedRecoverable: Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge when 7 <= SoftDeleteRetentionInDays < 90).This level guarantees the recoverability of the deleted entity during the retention interval and while the subscription is still available. ,
CustomizedRecoverable+ProtectedSubscription: Denotes a vault and subscription state in which deletion is recoverable, immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled when 7 <= SoftDeleteRetentionInDays < 90. This level guarantees the recoverability of the deleted entity during the retention interval, and also reflects the fact that the subscription itself cannot be cancelled. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Application specific metadata in the form of key-value pairs. ,
Required: False ,
}
object ,
contentType:
{
Description: Type of the secret value such as a password. ,
Required: False ,
}
string ,
managed:
{
Description: True if the secret's lifetime is managed by key vault. If this is a key backing a certificate, then managed will be true. ,
Required: False ,
}
boolean ,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of secrets. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The key vault server error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
SetSecret (updated)
Description :  The SET operation adds a secret to the Azure Key Vault. If the named secret already exists, Azure Key Vault creates a new version of that secret. This operation requires the secrets/set permission.
Reference :  Link ¶

⚶ Changes

{
  "#id": "SetSecret",
  "Description": {
    "new": "The SET operation adds a secret to the Azure Key Vault. If the named secret already exists, Azure Key Vault creates a new version of that secret. This operation requires the secrets/set permission.",
    "old": " The SET operation adds a secret to the Azure Key Vault. If the named secret already exists, Azure Key Vault creates a new version of that secret. This operation requires the secrets/set permission."
  },
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client API version."
      }
    },
    {
      "parameters": {
        "$properties": {
          "attributes": [
            {
              "@added_2fb0d6041c3e41ea883aa79a42365f53": {
                "#name": "enabled",
                "Description": "Determines whether the object is enabled.",
                "Required": false,
                "Type": "boolean"
              }
            },
            {
              "@added_28cdf27c59164afe89e9128a7b999eed": {
                "#name": "nbf",
                "Description": "Not before date in UTC.",
                "Format": "unixtime",
                "Required": false,
                "Type": "integer"
              }
            },
            {
              "@added_c7f25395ee90425aa7a69d30861dacfc": {
                "#name": "exp",
                "Description": "Expiry date in UTC.",
                "Format": "unixtime",
                "Required": false,
                "Type": "integer"
              }
            },
            {
              "@added_c9755ab5c58e42ba98ac413ba306404b": {
                "#name": "created",
                "Description": "Creation time in UTC.",
                "Format": "unixtime",
                "Required": false,
                "Type": "integer"
              }
            },
            {
              "@added_46b4c941747f41e9984bec5dd287a78f": {
                "#name": "updated",
                "Description": "Last updated time in UTC.",
                "Format": "unixtime",
                "Required": false,
                "Type": "integer"
              }
            },
            {
              "#name": "recoveryLevel",
              "Enum": {
                "new": [
                  [
                    "Purgeable",
                    "Denotes a vault state in which deletion is an irreversible operation, without the possibility for recovery. This level corresponds to no protection being available against a Delete operation; the data is irretrievably lost upon accepting a Delete operation at the entity level or higher (vault, resource group, subscription etc.)"
                  ],
                  [
                    "Recoverable+Purgeable",
                    "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days), unless a Purge operation is requested, or the subscription is cancelled. System wil permanently delete it after 90 days, if not recovered"
                  ],
                  [
                    "Recoverable",
                    "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days) and while the subscription is still available. System wil permanently delete it after 90 days, if not recovered"
                  ],
                  [
                    "Recoverable+ProtectedSubscription",
                    "Denotes a vault and subscription state in which deletion is recoverable within retention interval (90 days), immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself  cannot be permanently canceled. System wil permanently delete it after 90 days, if not recovered"
                  ],
                  [
                    "CustomizedRecoverable+Purgeable",
                    "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge when 7 <= SoftDeleteRetentionInDays < 90). This level guarantees the recoverability of the deleted entity during the retention interval, unless a Purge operation is requested, or the subscription is cancelled."
                  ],
                  [
                    "CustomizedRecoverable",
                    "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge when 7 <= SoftDeleteRetentionInDays < 90).This level guarantees the recoverability of the deleted entity during the retention interval and while the subscription is still available."
                  ],
                  [
                    "CustomizedRecoverable+ProtectedSubscription",
                    "Denotes a vault and subscription state in which deletion is recoverable, immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled when 7 <= SoftDeleteRetentionInDays < 90. This level guarantees the recoverability of the deleted entity during the retention interval, and also reflects the fact that the subscription itself cannot be cancelled."
                  ]
                ],
                "old": [
                  [
                    "Purgeable",
                    "Denotes a vault state in which deletion is an irreversible operation, without the possibility for recovery. This level corresponds to no protection being available against a Delete operation; the data is irretrievably lost upon accepting a Delete operation at the entity level or higher (vault, resource group, subscription etc.)"
                  ],
                  [
                    "Recoverable+Purgeable",
                    "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days), unless a Purge operation is requested, or the subscription is cancelled. System wil permanently delete it after 90 days, if not recovered"
                  ],
                  [
                    "Recoverable",
                    "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval(90 days) and while the subscription is still available. System wil permanently delete it after 90 days, if not recovered"
                  ],
                  [
                    "Recoverable+ProtectedSubscription",
                    "Denotes a vault and subscription state in which deletion is recoverable within retention interval (90 days), immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself  cannot be permanently canceled. System wil permanently delete it after 90 days, if not recovered"
                  ],
                  [
                    "CustomizedRecoverable+Purgeable",
                    "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge when 7<= SoftDeleteRetentionInDays < 90). This level guarantees the recoverability of the deleted entity during the retention interval, unless a Purge operation is requested, or the subscription is cancelled."
                  ],
                  [
                    "CustomizedRecoverable",
                    "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge when 7<= SoftDeleteRetentionInDays < 90).This level guarantees the recoverability of the deleted entity during the retention interval and while the subscription is still available."
                  ],
                  [
                    "CustomizedRecoverable+ProtectedSubscription",
                    "Denotes a vault and subscription state in which deletion is recoverable, immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled when 7<= SoftDeleteRetentionInDays < 90. This level guarantees the recoverability of the deleted entity during the retention interval, and also reflects the fact that the subscription itself cannot be cancelled."
                  ]
                ]
              }
            }
          ]
        }
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "attributes": [
          {
            "@added_14fed14dacec4ecda4a0b7761cd6b181": {
              "#name": "enabled",
              "Description": "Determines whether the object is enabled.",
              "Required": false,
              "Type": "boolean"
            }
          },
          {
            "@added_0fb1c69cc1bb4adc9629d8b643ad90c0": {
              "#name": "nbf",
              "Description": "Not before date in UTC.",
              "Format": "unixtime",
              "Required": false,
              "Type": "integer"
            }
          },
          {
            "@added_ee7231fb43fd426fa1b15240048879ba": {
              "#name": "exp",
              "Description": "Expiry date in UTC.",
              "Format": "unixtime",
              "Required": false,
              "Type": "integer"
            }
          },
          {
            "@added_4af501a6f0bb42108c304ed857a3f380": {
              "#name": "created",
              "Description": "Creation time in UTC.",
              "Format": "unixtime",
              "Required": false,
              "Type": "integer"
            }
          },
          {
            "@added_ba62582548a840788d2dd007fdaf832c": {
              "#name": "updated",
              "Description": "Last updated time in UTC.",
              "Format": "unixtime",
              "Required": false,
              "Type": "integer"
            }
          },
          {
            "#name": "recoveryLevel",
            "Enum": {
              "new": [
                [
                  "Purgeable",
                  "Denotes a vault state in which deletion is an irreversible operation, without the possibility for recovery. This level corresponds to no protection being available against a Delete operation; the data is irretrievably lost upon accepting a Delete operation at the entity level or higher (vault, resource group, subscription etc.)"
                ],
                [
                  "Recoverable+Purgeable",
                  "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days), unless a Purge operation is requested, or the subscription is cancelled. System wil permanently delete it after 90 days, if not recovered"
                ],
                [
                  "Recoverable",
                  "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days) and while the subscription is still available. System wil permanently delete it after 90 days, if not recovered"
                ],
                [
                  "Recoverable+ProtectedSubscription",
                  "Denotes a vault and subscription state in which deletion is recoverable within retention interval (90 days), immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself  cannot be permanently canceled. System wil permanently delete it after 90 days, if not recovered"
                ],
                [
                  "CustomizedRecoverable+Purgeable",
                  "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge when 7 <= SoftDeleteRetentionInDays < 90). This level guarantees the recoverability of the deleted entity during the retention interval, unless a Purge operation is requested, or the subscription is cancelled."
                ],
                [
                  "CustomizedRecoverable",
                  "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge when 7 <= SoftDeleteRetentionInDays < 90).This level guarantees the recoverability of the deleted entity during the retention interval and while the subscription is still available."
                ],
                [
                  "CustomizedRecoverable+ProtectedSubscription",
                  "Denotes a vault and subscription state in which deletion is recoverable, immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled when 7 <= SoftDeleteRetentionInDays < 90. This level guarantees the recoverability of the deleted entity during the retention interval, and also reflects the fact that the subscription itself cannot be cancelled."
                ]
              ],
              "old": [
                [
                  "Purgeable",
                  "Denotes a vault state in which deletion is an irreversible operation, without the possibility for recovery. This level corresponds to no protection being available against a Delete operation; the data is irretrievably lost upon accepting a Delete operation at the entity level or higher (vault, resource group, subscription etc.)"
                ],
                [
                  "Recoverable+Purgeable",
                  "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days), unless a Purge operation is requested, or the subscription is cancelled. System wil permanently delete it after 90 days, if not recovered"
                ],
                [
                  "Recoverable",
                  "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval(90 days) and while the subscription is still available. System wil permanently delete it after 90 days, if not recovered"
                ],
                [
                  "Recoverable+ProtectedSubscription",
                  "Denotes a vault and subscription state in which deletion is recoverable within retention interval (90 days), immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself  cannot be permanently canceled. System wil permanently delete it after 90 days, if not recovered"
                ],
                [
                  "CustomizedRecoverable+Purgeable",
                  "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge when 7<= SoftDeleteRetentionInDays < 90). This level guarantees the recoverability of the deleted entity during the retention interval, unless a Purge operation is requested, or the subscription is cancelled."
                ],
                [
                  "CustomizedRecoverable",
                  "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge when 7<= SoftDeleteRetentionInDays < 90).This level guarantees the recoverability of the deleted entity during the retention interval and while the subscription is still available."
                ],
                [
                  "CustomizedRecoverable+ProtectedSubscription",
                  "Denotes a vault and subscription state in which deletion is recoverable, immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled when 7<= SoftDeleteRetentionInDays < 90. This level guarantees the recoverability of the deleted entity during the retention interval, and also reflects the fact that the subscription itself cannot be cancelled."
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /secrets/{secret-name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
secret-name:
{
Description: The name of the secret. The value you provide may be copied globally for the purpose of running the service. The value provided should not include personally identifiable or sensitive information. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters for setting the secret. ,
Required: True ,
}
{
value:
{
Description: The value of the secret. ,
Required: True ,
}
string ,
tags:
{
Description: Application specific metadata in the form of key-value pairs. ,
Required: False ,
}
object ,
contentType:
{
Description: Type of the secret value such as a password. ,
Required: False ,
}
string ,
attributes:
{
Description: The secret management attributes. ,
Required: False ,
}
{
enabled:
{
Description: Determines whether the object is enabled. ,
Required: False ,
}
boolean ,
nbf:
{
Description: Not before date in UTC. ,
Format: unixtime ,
Required: False ,
}
integer ,
exp:
{
Description: Expiry date in UTC. ,
Format: unixtime ,
Required: False ,
}
integer ,
created:
{
Description: Creation time in UTC. ,
Format: unixtime ,
Required: False ,
}
integer ,
updated:
{
Description: Last updated time in UTC. ,
Format: unixtime ,
Required: False ,
}
integer ,
recoverableDays:
{
Description: softDelete data retention days. Value should be >=7 and <=90 when softDelete enabled, otherwise 0. ,
Format: int32 ,
Required: False ,
}
integer ,
recoveryLevel:
{
Description: Reflects the deletion recovery level currently in effect for secrets in the current vault. If it contains 'Purgeable', the secret can be permanently deleted by a privileged user; otherwise, only the system can purge the secret, at the end of the retention interval. ,
Enum:
{
Purgeable: Denotes a vault state in which deletion is an irreversible operation, without the possibility for recovery. This level corresponds to no protection being available against a Delete operation; the data is irretrievably lost upon accepting a Delete operation at the entity level or higher (vault, resource group, subscription etc.) ,
Recoverable+Purgeable: Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days), unless a Purge operation is requested, or the subscription is cancelled. System wil permanently delete it after 90 days, if not recovered ,
Recoverable: Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days) and while the subscription is still available. System wil permanently delete it after 90 days, if not recovered ,
Recoverable+ProtectedSubscription: Denotes a vault and subscription state in which deletion is recoverable within retention interval (90 days), immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled. System wil permanently delete it after 90 days, if not recovered ,
CustomizedRecoverable+Purgeable: Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge when 7 <= SoftDeleteRetentionInDays < 90). This level guarantees the recoverability of the deleted entity during the retention interval, unless a Purge operation is requested, or the subscription is cancelled. ,
CustomizedRecoverable: Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge when 7 <= SoftDeleteRetentionInDays < 90).This level guarantees the recoverability of the deleted entity during the retention interval and while the subscription is still available. ,
CustomizedRecoverable+ProtectedSubscription: Denotes a vault and subscription state in which deletion is recoverable, immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled when 7 <= SoftDeleteRetentionInDays < 90. This level guarantees the recoverability of the deleted entity during the retention interval, and also reflects the fact that the subscription itself cannot be cancelled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
value:
{
Description: The secret value. ,
Required: False ,
}
string ,
id:
{
Description: The secret id. ,
Required: False ,
}
string ,
contentType:
{
Description: The content type of the secret. ,
Required: False ,
}
string ,
attributes:
{
Description: The secret management attributes. ,
Required: False ,
}
{
enabled:
{
Description: Determines whether the object is enabled. ,
Required: False ,
}
boolean ,
nbf:
{
Description: Not before date in UTC. ,
Format: unixtime ,
Required: False ,
}
integer ,
exp:
{
Description: Expiry date in UTC. ,
Format: unixtime ,
Required: False ,
}
integer ,
created:
{
Description: Creation time in UTC. ,
Format: unixtime ,
Required: False ,
}
integer ,
updated:
{
Description: Last updated time in UTC. ,
Format: unixtime ,
Required: False ,
}
integer ,
recoverableDays:
{
Description: softDelete data retention days. Value should be >=7 and <=90 when softDelete enabled, otherwise 0. ,
Format: int32 ,
Required: False ,
}
integer ,
recoveryLevel:
{
Description: Reflects the deletion recovery level currently in effect for secrets in the current vault. If it contains 'Purgeable', the secret can be permanently deleted by a privileged user; otherwise, only the system can purge the secret, at the end of the retention interval. ,
Enum:
{
Purgeable: Denotes a vault state in which deletion is an irreversible operation, without the possibility for recovery. This level corresponds to no protection being available against a Delete operation; the data is irretrievably lost upon accepting a Delete operation at the entity level or higher (vault, resource group, subscription etc.) ,
Recoverable+Purgeable: Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days), unless a Purge operation is requested, or the subscription is cancelled. System wil permanently delete it after 90 days, if not recovered ,
Recoverable: Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days) and while the subscription is still available. System wil permanently delete it after 90 days, if not recovered ,
Recoverable+ProtectedSubscription: Denotes a vault and subscription state in which deletion is recoverable within retention interval (90 days), immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled. System wil permanently delete it after 90 days, if not recovered ,
CustomizedRecoverable+Purgeable: Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge when 7 <= SoftDeleteRetentionInDays < 90). This level guarantees the recoverability of the deleted entity during the retention interval, unless a Purge operation is requested, or the subscription is cancelled. ,
CustomizedRecoverable: Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge when 7 <= SoftDeleteRetentionInDays < 90).This level guarantees the recoverability of the deleted entity during the retention interval and while the subscription is still available. ,
CustomizedRecoverable+ProtectedSubscription: Denotes a vault and subscription state in which deletion is recoverable, immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled when 7 <= SoftDeleteRetentionInDays < 90. This level guarantees the recoverability of the deleted entity during the retention interval, and also reflects the fact that the subscription itself cannot be cancelled. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Application specific metadata in the form of key-value pairs. ,
Required: False ,
}
object ,
kid:
{
Description: If this is a secret backing a KV certificate, then this field specifies the corresponding key backing the KV certificate. ,
Required: False ,
}
string ,
managed:
{
Description: True if the secret's lifetime is managed by key vault. If this is a secret backing a certificate, then managed will be true. ,
Required: False ,
}
boolean ,
}

⚐ Response (default)

{
error:
{
Description: The key vault server error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
DeleteSecret (updated)
Description :  The DELETE operation applies to any secret stored in Azure Key Vault. DELETE cannot be applied to an individual version of a secret. This operation requires the secrets/delete permission.
Reference :  Link ¶

⚶ Changes

{
  "#id": "DeleteSecret",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client API version."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@added_a121fd755af04b17826cc7dabab325fe": {
          "#name": "value",
          "Description": "The secret value.",
          "Required": false,
          "Type": "string"
        },
        "@added_a65e3dc19f034e058dc30dde59bfc79e": {
          "#name": "id",
          "Description": "The secret id.",
          "Required": false,
          "Type": "string"
        },
        "@added_c807aa74a934422db24f7a3b64cef51d": {
          "#name": "contentType",
          "Description": "The content type of the secret.",
          "Required": false,
          "Type": "string"
        },
        "@added_ecb294b79246437daddd18109e8a7fb1": {
          "#name": "attributes",
          "Description": "The secret management attributes.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "enabled",
              "Description": "Determines whether the object is enabled.",
              "Required": false,
              "Type": "boolean"
            },
            {
              "#name": "nbf",
              "Description": "Not before date in UTC.",
              "Format": "unixtime",
              "Required": false,
              "Type": "integer"
            },
            {
              "#name": "exp",
              "Description": "Expiry date in UTC.",
              "Format": "unixtime",
              "Required": false,
              "Type": "integer"
            },
            {
              "#name": "created",
              "Description": "Creation time in UTC.",
              "Format": "unixtime",
              "Required": false,
              "Type": "integer"
            },
            {
              "#name": "updated",
              "Description": "Last updated time in UTC.",
              "Format": "unixtime",
              "Required": false,
              "Type": "integer"
            },
            {
              "#name": "recoverableDays",
              "Description": "softDelete data retention days. Value should be >=7 and <=90 when softDelete enabled, otherwise 0.",
              "Format": "int32",
              "Required": false,
              "Type": "integer"
            },
            {
              "#name": "recoveryLevel",
              "Description": "Reflects the deletion recovery level currently in effect for secrets in the current vault. If it contains 'Purgeable', the secret can be permanently deleted by a privileged user; otherwise, only the system can purge the secret, at the end of the retention interval.",
              "Enum": [
                [
                  "Purgeable",
                  "Denotes a vault state in which deletion is an irreversible operation, without the possibility for recovery. This level corresponds to no protection being available against a Delete operation; the data is irretrievably lost upon accepting a Delete operation at the entity level or higher (vault, resource group, subscription etc.)"
                ],
                [
                  "Recoverable+Purgeable",
                  "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days), unless a Purge operation is requested, or the subscription is cancelled. System wil permanently delete it after 90 days, if not recovered"
                ],
                [
                  "Recoverable",
                  "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days) and while the subscription is still available. System wil permanently delete it after 90 days, if not recovered"
                ],
                [
                  "Recoverable+ProtectedSubscription",
                  "Denotes a vault and subscription state in which deletion is recoverable within retention interval (90 days), immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself  cannot be permanently canceled. System wil permanently delete it after 90 days, if not recovered"
                ],
                [
                  "CustomizedRecoverable+Purgeable",
                  "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge when 7 <= SoftDeleteRetentionInDays < 90). This level guarantees the recoverability of the deleted entity during the retention interval, unless a Purge operation is requested, or the subscription is cancelled."
                ],
                [
                  "CustomizedRecoverable",
                  "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge when 7 <= SoftDeleteRetentionInDays < 90).This level guarantees the recoverability of the deleted entity during the retention interval and while the subscription is still available."
                ],
                [
                  "CustomizedRecoverable+ProtectedSubscription",
                  "Denotes a vault and subscription state in which deletion is recoverable, immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled when 7 <= SoftDeleteRetentionInDays < 90. This level guarantees the recoverability of the deleted entity during the retention interval, and also reflects the fact that the subscription itself cannot be cancelled."
                ]
              ],
              "Required": false,
              "Type": "string"
            }
          ]
        },
        "@added_704f5ca0dbac47d0b1d14ad6794934dc": {
          "#name": "tags",
          "Description": "Application specific metadata in the form of key-value pairs.",
          "Required": false,
          "Type": "object"
        },
        "@added_6ffaf5d731b942a5b527fe46c6daa6e8": {
          "#name": "kid",
          "Description": "If this is a secret backing a KV certificate, then this field specifies the corresponding key backing the KV certificate.",
          "Required": false,
          "Type": "string"
        },
        "@added_591c802482c34a5eb22ec8e966fbe983": {
          "#name": "managed",
          "Description": "True if the secret's lifetime is managed by key vault. If this is a secret backing a certificate, then managed will be true.",
          "Required": false,
          "Type": "boolean"
        }
      }
    }
  }
}

⚼ Request

DELETE:  /secrets/{secret-name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
secret-name:
{
Description: The name of the secret. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The secret value. ,
Required: False ,
}
string ,
id:
{
Description: The secret id. ,
Required: False ,
}
string ,
contentType:
{
Description: The content type of the secret. ,
Required: False ,
}
string ,
attributes:
{
Description: The secret management attributes. ,
Required: False ,
}
{
enabled:
{
Description: Determines whether the object is enabled. ,
Required: False ,
}
boolean ,
nbf:
{
Description: Not before date in UTC. ,
Format: unixtime ,
Required: False ,
}
integer ,
exp:
{
Description: Expiry date in UTC. ,
Format: unixtime ,
Required: False ,
}
integer ,
created:
{
Description: Creation time in UTC. ,
Format: unixtime ,
Required: False ,
}
integer ,
updated:
{
Description: Last updated time in UTC. ,
Format: unixtime ,
Required: False ,
}
integer ,
recoverableDays:
{
Description: softDelete data retention days. Value should be >=7 and <=90 when softDelete enabled, otherwise 0. ,
Format: int32 ,
Required: False ,
}
integer ,
recoveryLevel:
{
Description: Reflects the deletion recovery level currently in effect for secrets in the current vault. If it contains 'Purgeable', the secret can be permanently deleted by a privileged user; otherwise, only the system can purge the secret, at the end of the retention interval. ,
Enum:
{
Purgeable: Denotes a vault state in which deletion is an irreversible operation, without the possibility for recovery. This level corresponds to no protection being available against a Delete operation; the data is irretrievably lost upon accepting a Delete operation at the entity level or higher (vault, resource group, subscription etc.) ,
Recoverable+Purgeable: Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days), unless a Purge operation is requested, or the subscription is cancelled. System wil permanently delete it after 90 days, if not recovered ,
Recoverable: Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days) and while the subscription is still available. System wil permanently delete it after 90 days, if not recovered ,
Recoverable+ProtectedSubscription: Denotes a vault and subscription state in which deletion is recoverable within retention interval (90 days), immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled. System wil permanently delete it after 90 days, if not recovered ,
CustomizedRecoverable+Purgeable: Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge when 7 <= SoftDeleteRetentionInDays < 90). This level guarantees the recoverability of the deleted entity during the retention interval, unless a Purge operation is requested, or the subscription is cancelled. ,
CustomizedRecoverable: Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge when 7 <= SoftDeleteRetentionInDays < 90).This level guarantees the recoverability of the deleted entity during the retention interval and while the subscription is still available. ,
CustomizedRecoverable+ProtectedSubscription: Denotes a vault and subscription state in which deletion is recoverable, immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled when 7 <= SoftDeleteRetentionInDays < 90. This level guarantees the recoverability of the deleted entity during the retention interval, and also reflects the fact that the subscription itself cannot be cancelled. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Application specific metadata in the form of key-value pairs. ,
Required: False ,
}
object ,
kid:
{
Description: If this is a secret backing a KV certificate, then this field specifies the corresponding key backing the KV certificate. ,
Required: False ,
}
string ,
managed:
{
Description: True if the secret's lifetime is managed by key vault. If this is a secret backing a certificate, then managed will be true. ,
Required: False ,
}
boolean ,
recoveryId:
{
Description: The url of the recovery object, used to identify and recover the deleted secret. ,
Required: False ,
}
string ,
scheduledPurgeDate:
{
Description: The time when the secret is scheduled to be purged, in UTC ,
Format: unixtime ,
Required: False ,
}
integer ,
deletedDate:
{
Description: The time when the secret was deleted, in UTC ,
Format: unixtime ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The key vault server error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
GetSecret (updated)
Description :  The GET operation is applicable to any secret stored in Azure Key Vault. This operation requires the secrets/get permission.
Reference :  Link ¶

⚶ Changes

{
  "#id": "GetSecret",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client API version."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "attributes": [
          {
            "@added_df0621f000c548f9a8e9a447061c71cd": {
              "#name": "enabled",
              "Description": "Determines whether the object is enabled.",
              "Required": false,
              "Type": "boolean"
            }
          },
          {
            "@added_8564ade8e9cc439d8b5b43b9d1e8f10f": {
              "#name": "nbf",
              "Description": "Not before date in UTC.",
              "Format": "unixtime",
              "Required": false,
              "Type": "integer"
            }
          },
          {
            "@added_2938a11dd70f4039b4b5cca9361c4590": {
              "#name": "exp",
              "Description": "Expiry date in UTC.",
              "Format": "unixtime",
              "Required": false,
              "Type": "integer"
            }
          },
          {
            "@added_d2026fba49dc46dfb56fc599499ff5e0": {
              "#name": "created",
              "Description": "Creation time in UTC.",
              "Format": "unixtime",
              "Required": false,
              "Type": "integer"
            }
          },
          {
            "@added_04db48cece054d6e9e1ed0782cc9de62": {
              "#name": "updated",
              "Description": "Last updated time in UTC.",
              "Format": "unixtime",
              "Required": false,
              "Type": "integer"
            }
          },
          {
            "#name": "recoveryLevel",
            "Enum": {
              "new": [
                [
                  "Purgeable",
                  "Denotes a vault state in which deletion is an irreversible operation, without the possibility for recovery. This level corresponds to no protection being available against a Delete operation; the data is irretrievably lost upon accepting a Delete operation at the entity level or higher (vault, resource group, subscription etc.)"
                ],
                [
                  "Recoverable+Purgeable",
                  "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days), unless a Purge operation is requested, or the subscription is cancelled. System wil permanently delete it after 90 days, if not recovered"
                ],
                [
                  "Recoverable",
                  "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days) and while the subscription is still available. System wil permanently delete it after 90 days, if not recovered"
                ],
                [
                  "Recoverable+ProtectedSubscription",
                  "Denotes a vault and subscription state in which deletion is recoverable within retention interval (90 days), immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself  cannot be permanently canceled. System wil permanently delete it after 90 days, if not recovered"
                ],
                [
                  "CustomizedRecoverable+Purgeable",
                  "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge when 7 <= SoftDeleteRetentionInDays < 90). This level guarantees the recoverability of the deleted entity during the retention interval, unless a Purge operation is requested, or the subscription is cancelled."
                ],
                [
                  "CustomizedRecoverable",
                  "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge when 7 <= SoftDeleteRetentionInDays < 90).This level guarantees the recoverability of the deleted entity during the retention interval and while the subscription is still available."
                ],
                [
                  "CustomizedRecoverable+ProtectedSubscription",
                  "Denotes a vault and subscription state in which deletion is recoverable, immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled when 7 <= SoftDeleteRetentionInDays < 90. This level guarantees the recoverability of the deleted entity during the retention interval, and also reflects the fact that the subscription itself cannot be cancelled."
                ]
              ],
              "old": [
                [
                  "Purgeable",
                  "Denotes a vault state in which deletion is an irreversible operation, without the possibility for recovery. This level corresponds to no protection being available against a Delete operation; the data is irretrievably lost upon accepting a Delete operation at the entity level or higher (vault, resource group, subscription etc.)"
                ],
                [
                  "Recoverable+Purgeable",
                  "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days), unless a Purge operation is requested, or the subscription is cancelled. System wil permanently delete it after 90 days, if not recovered"
                ],
                [
                  "Recoverable",
                  "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval(90 days) and while the subscription is still available. System wil permanently delete it after 90 days, if not recovered"
                ],
                [
                  "Recoverable+ProtectedSubscription",
                  "Denotes a vault and subscription state in which deletion is recoverable within retention interval (90 days), immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself  cannot be permanently canceled. System wil permanently delete it after 90 days, if not recovered"
                ],
                [
                  "CustomizedRecoverable+Purgeable",
                  "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge when 7<= SoftDeleteRetentionInDays < 90). This level guarantees the recoverability of the deleted entity during the retention interval, unless a Purge operation is requested, or the subscription is cancelled."
                ],
                [
                  "CustomizedRecoverable",
                  "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge when 7<= SoftDeleteRetentionInDays < 90).This level guarantees the recoverability of the deleted entity during the retention interval and while the subscription is still available."
                ],
                [
                  "CustomizedRecoverable+ProtectedSubscription",
                  "Denotes a vault and subscription state in which deletion is recoverable, immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled when 7<= SoftDeleteRetentionInDays < 90. This level guarantees the recoverability of the deleted entity during the retention interval, and also reflects the fact that the subscription itself cannot be cancelled."
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /secrets/{secret-name}/{secret-version}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
secret-name:
{
Description: The name of the secret. ,
Required: True ,
}
string ,
secret-version:
{
Description: The version of the secret. This URI fragment is optional. If not specified, the latest version of the secret is returned. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The secret value. ,
Required: False ,
}
string ,
id:
{
Description: The secret id. ,
Required: False ,
}
string ,
contentType:
{
Description: The content type of the secret. ,
Required: False ,
}
string ,
attributes:
{
Description: The secret management attributes. ,
Required: False ,
}
{
enabled:
{
Description: Determines whether the object is enabled. ,
Required: False ,
}
boolean ,
nbf:
{
Description: Not before date in UTC. ,
Format: unixtime ,
Required: False ,
}
integer ,
exp:
{
Description: Expiry date in UTC. ,
Format: unixtime ,
Required: False ,
}
integer ,
created:
{
Description: Creation time in UTC. ,
Format: unixtime ,
Required: False ,
}
integer ,
updated:
{
Description: Last updated time in UTC. ,
Format: unixtime ,
Required: False ,
}
integer ,
recoverableDays:
{
Description: softDelete data retention days. Value should be >=7 and <=90 when softDelete enabled, otherwise 0. ,
Format: int32 ,
Required: False ,
}
integer ,
recoveryLevel:
{
Description: Reflects the deletion recovery level currently in effect for secrets in the current vault. If it contains 'Purgeable', the secret can be permanently deleted by a privileged user; otherwise, only the system can purge the secret, at the end of the retention interval. ,
Enum:
{
Purgeable: Denotes a vault state in which deletion is an irreversible operation, without the possibility for recovery. This level corresponds to no protection being available against a Delete operation; the data is irretrievably lost upon accepting a Delete operation at the entity level or higher (vault, resource group, subscription etc.) ,
Recoverable+Purgeable: Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days), unless a Purge operation is requested, or the subscription is cancelled. System wil permanently delete it after 90 days, if not recovered ,
Recoverable: Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days) and while the subscription is still available. System wil permanently delete it after 90 days, if not recovered ,
Recoverable+ProtectedSubscription: Denotes a vault and subscription state in which deletion is recoverable within retention interval (90 days), immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled. System wil permanently delete it after 90 days, if not recovered ,
CustomizedRecoverable+Purgeable: Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge when 7 <= SoftDeleteRetentionInDays < 90). This level guarantees the recoverability of the deleted entity during the retention interval, unless a Purge operation is requested, or the subscription is cancelled. ,
CustomizedRecoverable: Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge when 7 <= SoftDeleteRetentionInDays < 90).This level guarantees the recoverability of the deleted entity during the retention interval and while the subscription is still available. ,
CustomizedRecoverable+ProtectedSubscription: Denotes a vault and subscription state in which deletion is recoverable, immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled when 7 <= SoftDeleteRetentionInDays < 90. This level guarantees the recoverability of the deleted entity during the retention interval, and also reflects the fact that the subscription itself cannot be cancelled. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Application specific metadata in the form of key-value pairs. ,
Required: False ,
}
object ,
kid:
{
Description: If this is a secret backing a KV certificate, then this field specifies the corresponding key backing the KV certificate. ,
Required: False ,
}
string ,
managed:
{
Description: True if the secret's lifetime is managed by key vault. If this is a secret backing a certificate, then managed will be true. ,
Required: False ,
}
boolean ,
}

⚐ Response (default)

{
error:
{
Description: The key vault server error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
UpdateSecret (updated)
Description :  The UPDATE operation changes specified attributes of an existing stored secret. Attributes that are not specified in the request are left unchanged. The value of a secret itself cannot be changed. This operation requires the secrets/set permission.
Reference :  Link ¶

⚶ Changes

{
  "#id": "UpdateSecret",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client API version."
      }
    },
    {
      "parameters": {
        "$properties": {
          "attributes": [
            {
              "@added_237129fef318433099056e571af6c8a4": {
                "#name": "enabled",
                "Description": "Determines whether the object is enabled.",
                "Required": false,
                "Type": "boolean"
              }
            },
            {
              "@added_86df3097e3214bb2ac3f13664f3eb059": {
                "#name": "nbf",
                "Description": "Not before date in UTC.",
                "Format": "unixtime",
                "Required": false,
                "Type": "integer"
              }
            },
            {
              "@added_4ae29e57fa6e44b6a09a6c1280dd5865": {
                "#name": "exp",
                "Description": "Expiry date in UTC.",
                "Format": "unixtime",
                "Required": false,
                "Type": "integer"
              }
            },
            {
              "@added_8f20a71c17494ad7bcc0ebee161777c1": {
                "#name": "created",
                "Description": "Creation time in UTC.",
                "Format": "unixtime",
                "Required": false,
                "Type": "integer"
              }
            },
            {
              "@added_ce903a9c3bfb4b1da2796eda2c6b714a": {
                "#name": "updated",
                "Description": "Last updated time in UTC.",
                "Format": "unixtime",
                "Required": false,
                "Type": "integer"
              }
            },
            {
              "#name": "recoveryLevel",
              "Enum": {
                "new": [
                  [
                    "Purgeable",
                    "Denotes a vault state in which deletion is an irreversible operation, without the possibility for recovery. This level corresponds to no protection being available against a Delete operation; the data is irretrievably lost upon accepting a Delete operation at the entity level or higher (vault, resource group, subscription etc.)"
                  ],
                  [
                    "Recoverable+Purgeable",
                    "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days), unless a Purge operation is requested, or the subscription is cancelled. System wil permanently delete it after 90 days, if not recovered"
                  ],
                  [
                    "Recoverable",
                    "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days) and while the subscription is still available. System wil permanently delete it after 90 days, if not recovered"
                  ],
                  [
                    "Recoverable+ProtectedSubscription",
                    "Denotes a vault and subscription state in which deletion is recoverable within retention interval (90 days), immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself  cannot be permanently canceled. System wil permanently delete it after 90 days, if not recovered"
                  ],
                  [
                    "CustomizedRecoverable+Purgeable",
                    "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge when 7 <= SoftDeleteRetentionInDays < 90). This level guarantees the recoverability of the deleted entity during the retention interval, unless a Purge operation is requested, or the subscription is cancelled."
                  ],
                  [
                    "CustomizedRecoverable",
                    "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge when 7 <= SoftDeleteRetentionInDays < 90).This level guarantees the recoverability of the deleted entity during the retention interval and while the subscription is still available."
                  ],
                  [
                    "CustomizedRecoverable+ProtectedSubscription",
                    "Denotes a vault and subscription state in which deletion is recoverable, immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled when 7 <= SoftDeleteRetentionInDays < 90. This level guarantees the recoverability of the deleted entity during the retention interval, and also reflects the fact that the subscription itself cannot be cancelled."
                  ]
                ],
                "old": [
                  [
                    "Purgeable",
                    "Denotes a vault state in which deletion is an irreversible operation, without the possibility for recovery. This level corresponds to no protection being available against a Delete operation; the data is irretrievably lost upon accepting a Delete operation at the entity level or higher (vault, resource group, subscription etc.)"
                  ],
                  [
                    "Recoverable+Purgeable",
                    "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days), unless a Purge operation is requested, or the subscription is cancelled. System wil permanently delete it after 90 days, if not recovered"
                  ],
                  [
                    "Recoverable",
                    "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval(90 days) and while the subscription is still available. System wil permanently delete it after 90 days, if not recovered"
                  ],
                  [
                    "Recoverable+ProtectedSubscription",
                    "Denotes a vault and subscription state in which deletion is recoverable within retention interval (90 days), immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself  cannot be permanently canceled. System wil permanently delete it after 90 days, if not recovered"
                  ],
                  [
                    "CustomizedRecoverable+Purgeable",
                    "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge when 7<= SoftDeleteRetentionInDays < 90). This level guarantees the recoverability of the deleted entity during the retention interval, unless a Purge operation is requested, or the subscription is cancelled."
                  ],
                  [
                    "CustomizedRecoverable",
                    "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge when 7<= SoftDeleteRetentionInDays < 90).This level guarantees the recoverability of the deleted entity during the retention interval and while the subscription is still available."
                  ],
                  [
                    "CustomizedRecoverable+ProtectedSubscription",
                    "Denotes a vault and subscription state in which deletion is recoverable, immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled when 7<= SoftDeleteRetentionInDays < 90. This level guarantees the recoverability of the deleted entity during the retention interval, and also reflects the fact that the subscription itself cannot be cancelled."
                  ]
                ]
              }
            }
          ]
        }
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "attributes": [
          {
            "@added_b7a28c4f2761454ebf5ae64ca9256d42": {
              "#name": "enabled",
              "Description": "Determines whether the object is enabled.",
              "Required": false,
              "Type": "boolean"
            }
          },
          {
            "@added_04a06fd378574ee1a859a4888eef3194": {
              "#name": "nbf",
              "Description": "Not before date in UTC.",
              "Format": "unixtime",
              "Required": false,
              "Type": "integer"
            }
          },
          {
            "@added_256929b76bb3485b8fe7a574f2a15739": {
              "#name": "exp",
              "Description": "Expiry date in UTC.",
              "Format": "unixtime",
              "Required": false,
              "Type": "integer"
            }
          },
          {
            "@added_5765fe487a1f4852b1b7d8e3e1ba8c66": {
              "#name": "created",
              "Description": "Creation time in UTC.",
              "Format": "unixtime",
              "Required": false,
              "Type": "integer"
            }
          },
          {
            "@added_dbe379bcd0624acba661009e82360bbe": {
              "#name": "updated",
              "Description": "Last updated time in UTC.",
              "Format": "unixtime",
              "Required": false,
              "Type": "integer"
            }
          },
          {
            "#name": "recoveryLevel",
            "Enum": {
              "new": [
                [
                  "Purgeable",
                  "Denotes a vault state in which deletion is an irreversible operation, without the possibility for recovery. This level corresponds to no protection being available against a Delete operation; the data is irretrievably lost upon accepting a Delete operation at the entity level or higher (vault, resource group, subscription etc.)"
                ],
                [
                  "Recoverable+Purgeable",
                  "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days), unless a Purge operation is requested, or the subscription is cancelled. System wil permanently delete it after 90 days, if not recovered"
                ],
                [
                  "Recoverable",
                  "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days) and while the subscription is still available. System wil permanently delete it after 90 days, if not recovered"
                ],
                [
                  "Recoverable+ProtectedSubscription",
                  "Denotes a vault and subscription state in which deletion is recoverable within retention interval (90 days), immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself  cannot be permanently canceled. System wil permanently delete it after 90 days, if not recovered"
                ],
                [
                  "CustomizedRecoverable+Purgeable",
                  "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge when 7 <= SoftDeleteRetentionInDays < 90). This level guarantees the recoverability of the deleted entity during the retention interval, unless a Purge operation is requested, or the subscription is cancelled."
                ],
                [
                  "CustomizedRecoverable",
                  "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge when 7 <= SoftDeleteRetentionInDays < 90).This level guarantees the recoverability of the deleted entity during the retention interval and while the subscription is still available."
                ],
                [
                  "CustomizedRecoverable+ProtectedSubscription",
                  "Denotes a vault and subscription state in which deletion is recoverable, immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled when 7 <= SoftDeleteRetentionInDays < 90. This level guarantees the recoverability of the deleted entity during the retention interval, and also reflects the fact that the subscription itself cannot be cancelled."
                ]
              ],
              "old": [
                [
                  "Purgeable",
                  "Denotes a vault state in which deletion is an irreversible operation, without the possibility for recovery. This level corresponds to no protection being available against a Delete operation; the data is irretrievably lost upon accepting a Delete operation at the entity level or higher (vault, resource group, subscription etc.)"
                ],
                [
                  "Recoverable+Purgeable",
                  "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days), unless a Purge operation is requested, or the subscription is cancelled. System wil permanently delete it after 90 days, if not recovered"
                ],
                [
                  "Recoverable",
                  "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval(90 days) and while the subscription is still available. System wil permanently delete it after 90 days, if not recovered"
                ],
                [
                  "Recoverable+ProtectedSubscription",
                  "Denotes a vault and subscription state in which deletion is recoverable within retention interval (90 days), immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself  cannot be permanently canceled. System wil permanently delete it after 90 days, if not recovered"
                ],
                [
                  "CustomizedRecoverable+Purgeable",
                  "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge when 7<= SoftDeleteRetentionInDays < 90). This level guarantees the recoverability of the deleted entity during the retention interval, unless a Purge operation is requested, or the subscription is cancelled."
                ],
                [
                  "CustomizedRecoverable",
                  "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge when 7<= SoftDeleteRetentionInDays < 90).This level guarantees the recoverability of the deleted entity during the retention interval and while the subscription is still available."
                ],
                [
                  "CustomizedRecoverable+ProtectedSubscription",
                  "Denotes a vault and subscription state in which deletion is recoverable, immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled when 7<= SoftDeleteRetentionInDays < 90. This level guarantees the recoverability of the deleted entity during the retention interval, and also reflects the fact that the subscription itself cannot be cancelled."
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /secrets/{secret-name}/{secret-version}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
secret-name:
{
Description: The name of the secret. ,
Required: True ,
}
string ,
secret-version:
{
Description: The version of the secret. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters for update secret operation. ,
Required: True ,
}
{
contentType:
{
Description: Type of the secret value such as a password. ,
Required: False ,
}
string ,
attributes:
{
Description: The secret management attributes. ,
Required: False ,
}
{
enabled:
{
Description: Determines whether the object is enabled. ,
Required: False ,
}
boolean ,
nbf:
{
Description: Not before date in UTC. ,
Format: unixtime ,
Required: False ,
}
integer ,
exp:
{
Description: Expiry date in UTC. ,
Format: unixtime ,
Required: False ,
}
integer ,
created:
{
Description: Creation time in UTC. ,
Format: unixtime ,
Required: False ,
}
integer ,
updated:
{
Description: Last updated time in UTC. ,
Format: unixtime ,
Required: False ,
}
integer ,
recoverableDays:
{
Description: softDelete data retention days. Value should be >=7 and <=90 when softDelete enabled, otherwise 0. ,
Format: int32 ,
Required: False ,
}
integer ,
recoveryLevel:
{
Description: Reflects the deletion recovery level currently in effect for secrets in the current vault. If it contains 'Purgeable', the secret can be permanently deleted by a privileged user; otherwise, only the system can purge the secret, at the end of the retention interval. ,
Enum:
{
Purgeable: Denotes a vault state in which deletion is an irreversible operation, without the possibility for recovery. This level corresponds to no protection being available against a Delete operation; the data is irretrievably lost upon accepting a Delete operation at the entity level or higher (vault, resource group, subscription etc.) ,
Recoverable+Purgeable: Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days), unless a Purge operation is requested, or the subscription is cancelled. System wil permanently delete it after 90 days, if not recovered ,
Recoverable: Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days) and while the subscription is still available. System wil permanently delete it after 90 days, if not recovered ,
Recoverable+ProtectedSubscription: Denotes a vault and subscription state in which deletion is recoverable within retention interval (90 days), immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled. System wil permanently delete it after 90 days, if not recovered ,
CustomizedRecoverable+Purgeable: Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge when 7 <= SoftDeleteRetentionInDays < 90). This level guarantees the recoverability of the deleted entity during the retention interval, unless a Purge operation is requested, or the subscription is cancelled. ,
CustomizedRecoverable: Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge when 7 <= SoftDeleteRetentionInDays < 90).This level guarantees the recoverability of the deleted entity during the retention interval and while the subscription is still available. ,
CustomizedRecoverable+ProtectedSubscription: Denotes a vault and subscription state in which deletion is recoverable, immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled when 7 <= SoftDeleteRetentionInDays < 90. This level guarantees the recoverability of the deleted entity during the retention interval, and also reflects the fact that the subscription itself cannot be cancelled. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Application specific metadata in the form of key-value pairs. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
value:
{
Description: The secret value. ,
Required: False ,
}
string ,
id:
{
Description: The secret id. ,
Required: False ,
}
string ,
contentType:
{
Description: The content type of the secret. ,
Required: False ,
}
string ,
attributes:
{
Description: The secret management attributes. ,
Required: False ,
}
{
enabled:
{
Description: Determines whether the object is enabled. ,
Required: False ,
}
boolean ,
nbf:
{
Description: Not before date in UTC. ,
Format: unixtime ,
Required: False ,
}
integer ,
exp:
{
Description: Expiry date in UTC. ,
Format: unixtime ,
Required: False ,
}
integer ,
created:
{
Description: Creation time in UTC. ,
Format: unixtime ,
Required: False ,
}
integer ,
updated:
{
Description: Last updated time in UTC. ,
Format: unixtime ,
Required: False ,
}
integer ,
recoverableDays:
{
Description: softDelete data retention days. Value should be >=7 and <=90 when softDelete enabled, otherwise 0. ,
Format: int32 ,
Required: False ,
}
integer ,
recoveryLevel:
{
Description: Reflects the deletion recovery level currently in effect for secrets in the current vault. If it contains 'Purgeable', the secret can be permanently deleted by a privileged user; otherwise, only the system can purge the secret, at the end of the retention interval. ,
Enum:
{
Purgeable: Denotes a vault state in which deletion is an irreversible operation, without the possibility for recovery. This level corresponds to no protection being available against a Delete operation; the data is irretrievably lost upon accepting a Delete operation at the entity level or higher (vault, resource group, subscription etc.) ,
Recoverable+Purgeable: Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days), unless a Purge operation is requested, or the subscription is cancelled. System wil permanently delete it after 90 days, if not recovered ,
Recoverable: Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days) and while the subscription is still available. System wil permanently delete it after 90 days, if not recovered ,
Recoverable+ProtectedSubscription: Denotes a vault and subscription state in which deletion is recoverable within retention interval (90 days), immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled. System wil permanently delete it after 90 days, if not recovered ,
CustomizedRecoverable+Purgeable: Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge when 7 <= SoftDeleteRetentionInDays < 90). This level guarantees the recoverability of the deleted entity during the retention interval, unless a Purge operation is requested, or the subscription is cancelled. ,
CustomizedRecoverable: Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge when 7 <= SoftDeleteRetentionInDays < 90).This level guarantees the recoverability of the deleted entity during the retention interval and while the subscription is still available. ,
CustomizedRecoverable+ProtectedSubscription: Denotes a vault and subscription state in which deletion is recoverable, immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled when 7 <= SoftDeleteRetentionInDays < 90. This level guarantees the recoverability of the deleted entity during the retention interval, and also reflects the fact that the subscription itself cannot be cancelled. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Application specific metadata in the form of key-value pairs. ,
Required: False ,
}
object ,
kid:
{
Description: If this is a secret backing a KV certificate, then this field specifies the corresponding key backing the KV certificate. ,
Required: False ,
}
string ,
managed:
{
Description: True if the secret's lifetime is managed by key vault. If this is a secret backing a certificate, then managed will be true. ,
Required: False ,
}
boolean ,
}

⚐ Response (default)

{
error:
{
Description: The key vault server error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
BackupSecret (updated)
Description :  Requests that a backup of the specified secret be downloaded to the client. All versions of the secret will be downloaded. This operation requires the secrets/backup permission.
Reference :  Link ¶

⚶ Changes

{
  "#id": "BackupSecret",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client API version."
      }
    }
  ]
}

⚼ Request

POST:  /secrets/{secret-name}/backup
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
secret-name:
{
Description: The name of the secret. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The backup blob containing the backed up secret. ,
Format: base64url ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The key vault server error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
GetSecretVersions (updated)
Description :  The full secret identifier and attributes are provided in the response. No values are returned for the secrets. This operations requires the secrets/list permission.
Reference :  Link ¶

⚶ Changes

{
  "#id": "GetSecretVersions",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client API version."
      }
    },
    {
      "#name": "maxresults",
      "Description": {
        "new": "Maximum number of results to return in a page. If not specified the service will return up to 25 results.",
        "old": "Maximum number of results to return in a page. If not specified, the service will return up to 25 results."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "attributes": [
              {
                "@added_155da2fdbf754ac88b7dad95be93545f": {
                  "#name": "enabled",
                  "Description": "Determines whether the object is enabled.",
                  "Required": false,
                  "Type": "boolean"
                }
              },
              {
                "@added_c090392ae2504022a75cd0538cdf901c": {
                  "#name": "nbf",
                  "Description": "Not before date in UTC.",
                  "Format": "unixtime",
                  "Required": false,
                  "Type": "integer"
                }
              },
              {
                "@added_1cdaa8d75137481ebccdf27beed4d97c": {
                  "#name": "exp",
                  "Description": "Expiry date in UTC.",
                  "Format": "unixtime",
                  "Required": false,
                  "Type": "integer"
                }
              },
              {
                "@added_c51866062b98497cb2d81f1ce6846d00": {
                  "#name": "created",
                  "Description": "Creation time in UTC.",
                  "Format": "unixtime",
                  "Required": false,
                  "Type": "integer"
                }
              },
              {
                "@added_41f0541afbea48f98602aa048fbb0621": {
                  "#name": "updated",
                  "Description": "Last updated time in UTC.",
                  "Format": "unixtime",
                  "Required": false,
                  "Type": "integer"
                }
              },
              {
                "#name": "recoveryLevel",
                "Enum": {
                  "new": [
                    [
                      "Purgeable",
                      "Denotes a vault state in which deletion is an irreversible operation, without the possibility for recovery. This level corresponds to no protection being available against a Delete operation; the data is irretrievably lost upon accepting a Delete operation at the entity level or higher (vault, resource group, subscription etc.)"
                    ],
                    [
                      "Recoverable+Purgeable",
                      "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days), unless a Purge operation is requested, or the subscription is cancelled. System wil permanently delete it after 90 days, if not recovered"
                    ],
                    [
                      "Recoverable",
                      "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days) and while the subscription is still available. System wil permanently delete it after 90 days, if not recovered"
                    ],
                    [
                      "Recoverable+ProtectedSubscription",
                      "Denotes a vault and subscription state in which deletion is recoverable within retention interval (90 days), immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself  cannot be permanently canceled. System wil permanently delete it after 90 days, if not recovered"
                    ],
                    [
                      "CustomizedRecoverable+Purgeable",
                      "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge when 7 <= SoftDeleteRetentionInDays < 90). This level guarantees the recoverability of the deleted entity during the retention interval, unless a Purge operation is requested, or the subscription is cancelled."
                    ],
                    [
                      "CustomizedRecoverable",
                      "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge when 7 <= SoftDeleteRetentionInDays < 90).This level guarantees the recoverability of the deleted entity during the retention interval and while the subscription is still available."
                    ],
                    [
                      "CustomizedRecoverable+ProtectedSubscription",
                      "Denotes a vault and subscription state in which deletion is recoverable, immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled when 7 <= SoftDeleteRetentionInDays < 90. This level guarantees the recoverability of the deleted entity during the retention interval, and also reflects the fact that the subscription itself cannot be cancelled."
                    ]
                  ],
                  "old": [
                    [
                      "Purgeable",
                      "Denotes a vault state in which deletion is an irreversible operation, without the possibility for recovery. This level corresponds to no protection being available against a Delete operation; the data is irretrievably lost upon accepting a Delete operation at the entity level or higher (vault, resource group, subscription etc.)"
                    ],
                    [
                      "Recoverable+Purgeable",
                      "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days), unless a Purge operation is requested, or the subscription is cancelled. System wil permanently delete it after 90 days, if not recovered"
                    ],
                    [
                      "Recoverable",
                      "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval(90 days) and while the subscription is still available. System wil permanently delete it after 90 days, if not recovered"
                    ],
                    [
                      "Recoverable+ProtectedSubscription",
                      "Denotes a vault and subscription state in which deletion is recoverable within retention interval (90 days), immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself  cannot be permanently canceled. System wil permanently delete it after 90 days, if not recovered"
                    ],
                    [
                      "CustomizedRecoverable+Purgeable",
                      "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge when 7<= SoftDeleteRetentionInDays < 90). This level guarantees the recoverability of the deleted entity during the retention interval, unless a Purge operation is requested, or the subscription is cancelled."
                    ],
                    [
                      "CustomizedRecoverable",
                      "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge when 7<= SoftDeleteRetentionInDays < 90).This level guarantees the recoverability of the deleted entity during the retention interval and while the subscription is still available."
                    ],
                    [
                      "CustomizedRecoverable+ProtectedSubscription",
                      "Denotes a vault and subscription state in which deletion is recoverable, immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled when 7<= SoftDeleteRetentionInDays < 90. This level guarantees the recoverability of the deleted entity during the retention interval, and also reflects the fact that the subscription itself cannot be cancelled."
                    ]
                  ]
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /secrets/{secret-name}/versions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
secret-name:
{
Description: The name of the secret. ,
Required: True ,
}
string ,
maxresults:
{
Description: Maximum number of results to return in a page. If not specified the service will return up to 25 results. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: A response message containing a list of secrets in the key vault along with a link to the next page of secrets. ,
Required: False ,
}
[
{
id:
{
Description: Secret identifier. ,
Required: False ,
}
string ,
attributes:
{
Description: The secret management attributes. ,
Required: False ,
}
{
enabled:
{
Description: Determines whether the object is enabled. ,
Required: False ,
}
boolean ,
nbf:
{
Description: Not before date in UTC. ,
Format: unixtime ,
Required: False ,
}
integer ,
exp:
{
Description: Expiry date in UTC. ,
Format: unixtime ,
Required: False ,
}
integer ,
created:
{
Description: Creation time in UTC. ,
Format: unixtime ,
Required: False ,
}
integer ,
updated:
{
Description: Last updated time in UTC. ,
Format: unixtime ,
Required: False ,
}
integer ,
recoverableDays:
{
Description: softDelete data retention days. Value should be >=7 and <=90 when softDelete enabled, otherwise 0. ,
Format: int32 ,
Required: False ,
}
integer ,
recoveryLevel:
{
Description: Reflects the deletion recovery level currently in effect for secrets in the current vault. If it contains 'Purgeable', the secret can be permanently deleted by a privileged user; otherwise, only the system can purge the secret, at the end of the retention interval. ,
Enum:
{
Purgeable: Denotes a vault state in which deletion is an irreversible operation, without the possibility for recovery. This level corresponds to no protection being available against a Delete operation; the data is irretrievably lost upon accepting a Delete operation at the entity level or higher (vault, resource group, subscription etc.) ,
Recoverable+Purgeable: Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days), unless a Purge operation is requested, or the subscription is cancelled. System wil permanently delete it after 90 days, if not recovered ,
Recoverable: Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days) and while the subscription is still available. System wil permanently delete it after 90 days, if not recovered ,
Recoverable+ProtectedSubscription: Denotes a vault and subscription state in which deletion is recoverable within retention interval (90 days), immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled. System wil permanently delete it after 90 days, if not recovered ,
CustomizedRecoverable+Purgeable: Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge when 7 <= SoftDeleteRetentionInDays < 90). This level guarantees the recoverability of the deleted entity during the retention interval, unless a Purge operation is requested, or the subscription is cancelled. ,
CustomizedRecoverable: Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge when 7 <= SoftDeleteRetentionInDays < 90).This level guarantees the recoverability of the deleted entity during the retention interval and while the subscription is still available. ,
CustomizedRecoverable+ProtectedSubscription: Denotes a vault and subscription state in which deletion is recoverable, immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled when 7 <= SoftDeleteRetentionInDays < 90. This level guarantees the recoverability of the deleted entity during the retention interval, and also reflects the fact that the subscription itself cannot be cancelled. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Application specific metadata in the form of key-value pairs. ,
Required: False ,
}
object ,
contentType:
{
Description: Type of the secret value such as a password. ,
Required: False ,
}
string ,
managed:
{
Description: True if the secret's lifetime is managed by key vault. If this is a key backing a certificate, then managed will be true. ,
Required: False ,
}
boolean ,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of secrets. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The key vault server error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
RestoreSecret (updated)
Description :  Restores a backed up secret, and all its versions, to a vault. This operation requires the secrets/restore permission.
Reference :  Link ¶

⚶ Changes

{
  "#id": "RestoreSecret",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client API version."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "attributes": [
          {
            "@added_f00400c06ce74e2780f8850ba8341327": {
              "#name": "enabled",
              "Description": "Determines whether the object is enabled.",
              "Required": false,
              "Type": "boolean"
            }
          },
          {
            "@added_2c6c83b20bbe44e5b0254a236b33d998": {
              "#name": "nbf",
              "Description": "Not before date in UTC.",
              "Format": "unixtime",
              "Required": false,
              "Type": "integer"
            }
          },
          {
            "@added_a15cbf02cd3041318d787c357825c12a": {
              "#name": "exp",
              "Description": "Expiry date in UTC.",
              "Format": "unixtime",
              "Required": false,
              "Type": "integer"
            }
          },
          {
            "@added_cc18bbc796c64647943b9dc5f25e1205": {
              "#name": "created",
              "Description": "Creation time in UTC.",
              "Format": "unixtime",
              "Required": false,
              "Type": "integer"
            }
          },
          {
            "@added_6218b82829c346f78c0adcf81b656ae9": {
              "#name": "updated",
              "Description": "Last updated time in UTC.",
              "Format": "unixtime",
              "Required": false,
              "Type": "integer"
            }
          },
          {
            "#name": "recoveryLevel",
            "Enum": {
              "new": [
                [
                  "Purgeable",
                  "Denotes a vault state in which deletion is an irreversible operation, without the possibility for recovery. This level corresponds to no protection being available against a Delete operation; the data is irretrievably lost upon accepting a Delete operation at the entity level or higher (vault, resource group, subscription etc.)"
                ],
                [
                  "Recoverable+Purgeable",
                  "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days), unless a Purge operation is requested, or the subscription is cancelled. System wil permanently delete it after 90 days, if not recovered"
                ],
                [
                  "Recoverable",
                  "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days) and while the subscription is still available. System wil permanently delete it after 90 days, if not recovered"
                ],
                [
                  "Recoverable+ProtectedSubscription",
                  "Denotes a vault and subscription state in which deletion is recoverable within retention interval (90 days), immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself  cannot be permanently canceled. System wil permanently delete it after 90 days, if not recovered"
                ],
                [
                  "CustomizedRecoverable+Purgeable",
                  "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge when 7 <= SoftDeleteRetentionInDays < 90). This level guarantees the recoverability of the deleted entity during the retention interval, unless a Purge operation is requested, or the subscription is cancelled."
                ],
                [
                  "CustomizedRecoverable",
                  "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge when 7 <= SoftDeleteRetentionInDays < 90).This level guarantees the recoverability of the deleted entity during the retention interval and while the subscription is still available."
                ],
                [
                  "CustomizedRecoverable+ProtectedSubscription",
                  "Denotes a vault and subscription state in which deletion is recoverable, immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled when 7 <= SoftDeleteRetentionInDays < 90. This level guarantees the recoverability of the deleted entity during the retention interval, and also reflects the fact that the subscription itself cannot be cancelled."
                ]
              ],
              "old": [
                [
                  "Purgeable",
                  "Denotes a vault state in which deletion is an irreversible operation, without the possibility for recovery. This level corresponds to no protection being available against a Delete operation; the data is irretrievably lost upon accepting a Delete operation at the entity level or higher (vault, resource group, subscription etc.)"
                ],
                [
                  "Recoverable+Purgeable",
                  "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days), unless a Purge operation is requested, or the subscription is cancelled. System wil permanently delete it after 90 days, if not recovered"
                ],
                [
                  "Recoverable",
                  "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval(90 days) and while the subscription is still available. System wil permanently delete it after 90 days, if not recovered"
                ],
                [
                  "Recoverable+ProtectedSubscription",
                  "Denotes a vault and subscription state in which deletion is recoverable within retention interval (90 days), immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself  cannot be permanently canceled. System wil permanently delete it after 90 days, if not recovered"
                ],
                [
                  "CustomizedRecoverable+Purgeable",
                  "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge when 7<= SoftDeleteRetentionInDays < 90). This level guarantees the recoverability of the deleted entity during the retention interval, unless a Purge operation is requested, or the subscription is cancelled."
                ],
                [
                  "CustomizedRecoverable",
                  "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge when 7<= SoftDeleteRetentionInDays < 90).This level guarantees the recoverability of the deleted entity during the retention interval and while the subscription is still available."
                ],
                [
                  "CustomizedRecoverable+ProtectedSubscription",
                  "Denotes a vault and subscription state in which deletion is recoverable, immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled when 7<= SoftDeleteRetentionInDays < 90. This level guarantees the recoverability of the deleted entity during the retention interval, and also reflects the fact that the subscription itself cannot be cancelled."
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /secrets/restore
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters to restore the secret. ,
Required: True ,
}
{
value:
{
Description: The backup blob associated with a secret bundle. ,
Format: base64url ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
value:
{
Description: The secret value. ,
Required: False ,
}
string ,
id:
{
Description: The secret id. ,
Required: False ,
}
string ,
contentType:
{
Description: The content type of the secret. ,
Required: False ,
}
string ,
attributes:
{
Description: The secret management attributes. ,
Required: False ,
}
{
enabled:
{
Description: Determines whether the object is enabled. ,
Required: False ,
}
boolean ,
nbf:
{
Description: Not before date in UTC. ,
Format: unixtime ,
Required: False ,
}
integer ,
exp:
{
Description: Expiry date in UTC. ,
Format: unixtime ,
Required: False ,
}
integer ,
created:
{
Description: Creation time in UTC. ,
Format: unixtime ,
Required: False ,
}
integer ,
updated:
{
Description: Last updated time in UTC. ,
Format: unixtime ,
Required: False ,
}
integer ,
recoverableDays:
{
Description: softDelete data retention days. Value should be >=7 and <=90 when softDelete enabled, otherwise 0. ,
Format: int32 ,
Required: False ,
}
integer ,
recoveryLevel:
{
Description: Reflects the deletion recovery level currently in effect for secrets in the current vault. If it contains 'Purgeable', the secret can be permanently deleted by a privileged user; otherwise, only the system can purge the secret, at the end of the retention interval. ,
Enum:
{
Purgeable: Denotes a vault state in which deletion is an irreversible operation, without the possibility for recovery. This level corresponds to no protection being available against a Delete operation; the data is irretrievably lost upon accepting a Delete operation at the entity level or higher (vault, resource group, subscription etc.) ,
Recoverable+Purgeable: Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days), unless a Purge operation is requested, or the subscription is cancelled. System wil permanently delete it after 90 days, if not recovered ,
Recoverable: Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days) and while the subscription is still available. System wil permanently delete it after 90 days, if not recovered ,
Recoverable+ProtectedSubscription: Denotes a vault and subscription state in which deletion is recoverable within retention interval (90 days), immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled. System wil permanently delete it after 90 days, if not recovered ,
CustomizedRecoverable+Purgeable: Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge when 7 <= SoftDeleteRetentionInDays < 90). This level guarantees the recoverability of the deleted entity during the retention interval, unless a Purge operation is requested, or the subscription is cancelled. ,
CustomizedRecoverable: Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge when 7 <= SoftDeleteRetentionInDays < 90).This level guarantees the recoverability of the deleted entity during the retention interval and while the subscription is still available. ,
CustomizedRecoverable+ProtectedSubscription: Denotes a vault and subscription state in which deletion is recoverable, immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled when 7 <= SoftDeleteRetentionInDays < 90. This level guarantees the recoverability of the deleted entity during the retention interval, and also reflects the fact that the subscription itself cannot be cancelled. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Application specific metadata in the form of key-value pairs. ,
Required: False ,
}
object ,
kid:
{
Description: If this is a secret backing a KV certificate, then this field specifies the corresponding key backing the KV certificate. ,
Required: False ,
}
string ,
managed:
{
Description: True if the secret's lifetime is managed by key vault. If this is a secret backing a certificate, then managed will be true. ,
Required: False ,
}
boolean ,
}

⚐ Response (default)

{
error:
{
Description: The key vault server error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}