swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector DeletedStorage API schemes: - https tags: - name: DeletedStorage paths: /deletedstorage: get: tags: - DeletedStorage operationId: microsoftAzureGetdeletedstorageaccounts summary: Microsoft Azure Lists Deleted Storage Accounts For The Specified Vault description: The Get Deleted Storage Accounts operation returns the storage accounts that have been deleted for a vault enabled for soft-delete. This operation requires the storage/list permission. parameters: - name: maxresults in: query required: false type: integer format: int32 minimum: 1 maximum: 25 description: Maximum number of results to return in a page. If not specified the service will return up to 25 results. - $ref: common.json#/parameters/ApiVersionParameter responses: '200': description: A response message containing a list of deleted storage accounts in the vault, along with a link to the next page of deleted storage accounts. schema: $ref: '#/definitions/DeletedStorageListResult' default: description: Key Vault error response describing why the operation failed. schema: $ref: common.json#/definitions/KeyVaultError x-ms-pageable: nextLinkName: nextLink x-ms-examples: List Deleted Storage Accounts: $ref: ./examples/listDeletedStorageAccount.json /deletedstorage/{storage-account-name}: get: tags: - DeletedStorage operationId: microsoftAzureGetdeletedstorageaccount summary: Microsoft Azure Gets The Specified Deleted Storage Account description: The Get Deleted Storage Account operation returns the specified deleted storage account along with its attributes. This operation requires the storage/get permission. parameters: - name: storage-account-name in: path required: true type: string pattern: ^[0-9a-zA-Z]+$ description: The name of the storage account. - $ref: common.json#/parameters/ApiVersionParameter responses: '200': description: The deleted storage account and information on when it will be purged, and how to recover the deleted storage account. schema: $ref: '#/definitions/DeletedStorageBundle' default: description: Key Vault error response describing why the operation failed. schema: $ref: common.json#/definitions/KeyVaultError x-ms-examples: Get Deleted Storage: $ref: ./examples/getDeletedStorageAccount.json delete: tags: - DeletedStorage operationId: microsoftAzurePurgedeletedstorageaccount summary: Microsoft Azure Permanently Deletes The Specified Storage Account description: The purge deleted storage account operation removes the secret permanently, without the possibility of recovery. This operation can only be performed on a soft-delete enabled vault. This operation requires the storage/purge permission. parameters: - name: storage-account-name in: path required: true type: string pattern: ^[0-9a-zA-Z]+$ description: The name of the storage account. - $ref: common.json#/parameters/ApiVersionParameter responses: '204': description: No content signaling that the storage account was purged forever. default: description: Key Vault error response describing why the operation failed. schema: $ref: common.json#/definitions/KeyVaultError x-ms-examples: Purge Deleted Storage Account: $ref: ./examples/purgeStorageAccount.json /deletedstorage/{storage-account-name}/recover: post: tags: - DeletedStorage operationId: microsoftAzureRecoverdeletedstorageaccount summary: Microsoft Azure Recovers The Deleted Storage Account description: Recovers the deleted storage account in the specified vault. This operation can only be performed on a soft-delete enabled vault. This operation requires the storage/recover permission. parameters: - name: storage-account-name in: path required: true type: string pattern: ^[0-9a-zA-Z]+$ description: The name of the storage account. - $ref: common.json#/parameters/ApiVersionParameter responses: '200': description: A storage bundle of the original storage account and its attributes. schema: $ref: '#/definitions/StorageBundle' default: description: Key Vault error response describing why the operation failed. schema: $ref: common.json#/definitions/KeyVaultError x-ms-examples: Recover Deleted Storage Account: $ref: ./examples/recoverStorageAccount.json /deletedstorage/{storage-account-name}/sas: get: tags: - DeletedStorage operationId: microsoftAzureGetdeletedsasdefinitions summary: Microsoft Azure Lists Deleted Sas Definitions For The Specified Vault And Storage Account description: The Get Deleted Sas Definitions operation returns the SAS definitions that have been deleted for a vault enabled for soft-delete. This operation requires the storage/listsas permission. parameters: - name: storage-account-name in: path required: true type: string pattern: ^[0-9a-zA-Z]+$ description: The name of the storage account. - name: maxresults in: query required: false type: integer format: int32 minimum: 1 maximum: 25 description: Maximum number of results to return in a page. If not specified the service will return up to 25 results. - $ref: common.json#/parameters/ApiVersionParameter responses: '200': description: A response message containing a list of deleted SAS definitions for the storage account, along with a link to the next page of deleted SAS definitions. schema: $ref: '#/definitions/DeletedSasDefinitionListResult' default: description: Key Vault error response describing why the operation failed. schema: $ref: common.json#/definitions/KeyVaultError x-ms-pageable: nextLinkName: nextLink x-ms-examples: List Deleted Storage Sas Definitions: $ref: ./examples/listDeletedStorageSasDefinition.json /deletedstorage/{storage-account-name}/sas/{sas-definition-name}: get: tags: - DeletedStorage operationId: microsoftAzureGetdeletedsasdefinition summary: Microsoft Azure Gets The Specified Deleted Sas Definition description: The Get Deleted SAS Definition operation returns the specified deleted SAS definition along with its attributes. This operation requires the storage/getsas permission. parameters: - name: storage-account-name in: path required: true type: string pattern: ^[0-9a-zA-Z]+$ description: The name of the storage account. - name: sas-definition-name in: path required: true type: string pattern: ^[0-9a-zA-Z]+$ description: The name of the SAS definition. - $ref: common.json#/parameters/ApiVersionParameter responses: '200': description: The deleted SAS definition and information on when the it will be purged, and how to recover the deleted SAS definition. schema: $ref: '#/definitions/DeletedSasDefinitionBundle' default: description: Key Vault error response describing why the operation failed. schema: $ref: common.json#/definitions/KeyVaultError x-ms-examples: Get Deleted Storage Sas Definition: $ref: ./examples/getDeletedStorageSasDefinition.json /deletedstorage/{storage-account-name}/sas/{sas-definition-name}/recover: post: tags: - DeletedStorage operationId: microsoftAzureRecoverdeletedsasdefinition summary: Microsoft Azure Recovers The Deleted Sas Definition description: Recovers the deleted SAS definition for the specified storage account. This operation can only be performed on a soft-delete enabled vault. This operation requires the storage/recover permission. parameters: - name: storage-account-name in: path required: true type: string pattern: ^[0-9a-zA-Z]+$ description: The name of the storage account. - name: sas-definition-name in: path required: true type: string pattern: ^[0-9a-zA-Z]+$ description: The name of the SAS definition. - $ref: common.json#/parameters/ApiVersionParameter responses: '200': description: A SAS definition bundle of the original SAS definition and its attributes. schema: $ref: '#/definitions/SasDefinitionBundle' default: description: Key Vault error response describing why the operation failed. schema: $ref: common.json#/definitions/KeyVaultError x-ms-examples: Recover Deleted Storage Sas Definition: $ref: ./examples/recoverStorageSasDefinition.json definitions: DeletedSasDefinitionBundle: allOf: - $ref: '#/definitions/SasDefinitionBundle' properties: recoveryId: type: string description: The url of the recovery object, used to identify and recover the deleted SAS definition. scheduledPurgeDate: type: integer format: unixtime readOnly: true description: The time when the SAS definition is scheduled to be purged, in UTC deletedDate: type: integer format: unixtime readOnly: true description: The time when the SAS definition was deleted, in UTC description: A deleted SAS definition bundle consisting of its previous id, attributes and its tags, as well as information on when it will be purged. SasDefinitionBundle: properties: id: type: string description: The SAS definition id. readOnly: true sid: x-ms-client-name: SecretId type: string description: Storage account SAS definition secret id. readOnly: true templateUri: type: string description: The SAS definition token template signed with an arbitrary key. Tokens created according to the SAS definition will have the same properties as the template. readOnly: true sasType: type: string description: The type of SAS token the SAS definition will create. enum: - account - service x-ms-enum: name: SasTokenType modelAsString: true readOnly: true validityPeriod: type: string description: The validity period of SAS tokens created according to the SAS definition. readOnly: true attributes: $ref: '#/definitions/SasDefinitionAttributes' description: The SAS definition attributes. readOnly: true tags: type: object additionalProperties: type: string description: Application specific metadata in the form of key-value pairs readOnly: true description: A SAS definition bundle consists of key vault SAS definition details plus its attributes. DeletedSasDefinitionItem: allOf: - $ref: '#/definitions/SasDefinitionItem' properties: recoveryId: type: string description: The url of the recovery object, used to identify and recover the deleted SAS definition. scheduledPurgeDate: type: integer format: unixtime readOnly: true description: The time when the SAS definition is scheduled to be purged, in UTC deletedDate: type: integer format: unixtime readOnly: true description: The time when the SAS definition was deleted, in UTC description: The deleted SAS definition item containing metadata about the deleted SAS definition. DeletedSasDefinitionListResult: properties: value: type: array items: $ref: '#/definitions/DeletedSasDefinitionItem' readOnly: true description: A response message containing a list of the deleted SAS definitions in the vault along with a link to the next page of deleted sas definitions nextLink: type: string readOnly: true description: The URL to get the next set of deleted SAS definitions. description: The deleted SAS definition list result StorageAccountAttributes: properties: enabled: type: boolean description: the enabled state of the object. created: type: integer format: unixtime readOnly: true description: Creation time in UTC. updated: type: integer format: unixtime readOnly: true description: Last updated time in UTC. recoverableDays: type: integer format: int32 readOnly: true description: softDelete data retention days. Value should be >=7 and <=90 when softDelete enabled, otherwise 0. recoveryLevel: type: string description: Reflects the deletion recovery level currently in effect for storage accounts in the current vault. If it contains 'Purgeable' the storage account can be permanently deleted by a privileged user; otherwise, only the system can purge the storage account, at the end of the retention interval. enum: - Purgeable - Recoverable+Purgeable - Recoverable - Recoverable+ProtectedSubscription - CustomizedRecoverable+Purgeable - CustomizedRecoverable - CustomizedRecoverable+ProtectedSubscription x-ms-enum: name: DeletionRecoveryLevel modelAsString: true values: - value: Purgeable description: 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.) - value: Recoverable+Purgeable description: 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 - value: Recoverable description: 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 - value: Recoverable+ProtectedSubscription description: 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 - value: CustomizedRecoverable+Purgeable description: 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. - value: CustomizedRecoverable description: 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. - value: CustomizedRecoverable+ProtectedSubscription description: 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. readOnly: true x-nullable: false description: The storage account management attributes. DeletedStorageAccountItem: allOf: - $ref: '#/definitions/StorageAccountItem' properties: recoveryId: type: string description: The url of the recovery object, used to identify and recover the deleted storage account. scheduledPurgeDate: type: integer format: unixtime readOnly: true description: The time when the storage account is scheduled to be purged, in UTC deletedDate: type: integer format: unixtime readOnly: true description: The time when the storage account was deleted, in UTC description: The deleted storage account item containing metadata about the deleted storage account. DeletedStorageListResult: properties: value: type: array items: $ref: '#/definitions/DeletedStorageAccountItem' readOnly: true description: A response message containing a list of the deleted storage accounts in the vault along with a link to the next page of deleted storage accounts nextLink: type: string readOnly: true description: The URL to get the next set of deleted storage accounts. description: The deleted storage account list result SasDefinitionAttributes: properties: enabled: type: boolean description: the enabled state of the object. created: type: integer format: unixtime readOnly: true description: Creation time in UTC. updated: type: integer format: unixtime readOnly: true description: Last updated time in UTC. recoverableDays: type: integer format: int32 readOnly: true description: softDelete data retention days. Value should be >=7 and <=90 when softDelete enabled, otherwise 0. recoveryLevel: type: string description: Reflects the deletion recovery level currently in effect for SAS definitions in the current vault. If it contains 'Purgeable' the SAS definition can be permanently deleted by a privileged user; otherwise, only the system can purge the SAS definition, at the end of the retention interval. enum: - Purgeable - Recoverable+Purgeable - Recoverable - Recoverable+ProtectedSubscription - CustomizedRecoverable+Purgeable - CustomizedRecoverable - CustomizedRecoverable+ProtectedSubscription x-ms-enum: name: DeletionRecoveryLevel modelAsString: true readOnly: true x-nullable: false description: The SAS definition management attributes. StorageAccountItem: properties: id: type: string description: Storage identifier. readOnly: true resourceId: type: string description: Storage account resource Id. readOnly: true attributes: $ref: '#/definitions/StorageAccountAttributes' description: The storage account management attributes. readOnly: true tags: type: object additionalProperties: type: string description: Application specific metadata in the form of key-value pairs. readOnly: true description: The storage account item containing storage account metadata. DeletedStorageBundle: allOf: - $ref: '#/definitions/StorageBundle' properties: recoveryId: type: string description: The url of the recovery object, used to identify and recover the deleted storage account. scheduledPurgeDate: type: integer format: unixtime readOnly: true description: The time when the storage account is scheduled to be purged, in UTC deletedDate: type: integer format: unixtime readOnly: true description: The time when the storage account was deleted, in UTC description: A deleted storage account bundle consisting of its previous id, attributes and its tags, as well as information on when it will be purged. StorageBundle: properties: id: type: string description: The storage account id. readOnly: true resourceId: type: string description: The storage account resource id. readOnly: true activeKeyName: type: string description: The current active storage account key name. readOnly: true autoRegenerateKey: type: boolean description: whether keyvault should manage the storage account for the user. readOnly: true regenerationPeriod: type: string description: The key regeneration time duration specified in ISO-8601 format. readOnly: true attributes: $ref: '#/definitions/StorageAccountAttributes' description: The storage account attributes. readOnly: true tags: type: object additionalProperties: type: string description: Application specific metadata in the form of key-value pairs readOnly: true description: A Storage account bundle consists of key vault storage account details plus its attributes. SasDefinitionItem: properties: id: type: string description: The storage SAS identifier. readOnly: true sid: x-ms-client-name: SecretId type: string description: The storage account SAS definition secret id. readOnly: true attributes: $ref: '#/definitions/SasDefinitionAttributes' description: The SAS definition management attributes. readOnly: true tags: type: object additionalProperties: type: string description: Application specific metadata in the form of key-value pairs. readOnly: true description: The SAS definition item containing storage SAS definition metadata. x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'