com.microsoft.azure.management.keyvault.Vaults.yml

### YamlMime:JavaType
uid: "com.microsoft.azure.management.keyvault.Vaults"
fullName: "com.microsoft.azure.management.keyvault.Vaults"
name: "Vaults"
nameWithType: "Vaults"
summary: "Entry point for key vaults management API."
syntax: "public interface **Vaults**</br> extends <xref href=\"com.microsoft.azure.management.resources.fluentcore.collection.SupportsCreating?alt=com.microsoft.azure.management.resources.fluentcore.collection.SupportsCreating&text=SupportsCreating\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.microsoft.azure.management.keyvault.Vault.DefinitionStages.Blank?alt=com.microsoft.azure.management.keyvault.Vault.DefinitionStages.Blank&text=Blank\" data-throw-if-not-resolved=\"False\" />&gt;, <xref href=\"com.microsoft.azure.management.resources.fluentcore.collection.SupportsDeletingById?alt=com.microsoft.azure.management.resources.fluentcore.collection.SupportsDeletingById&text=SupportsDeletingById\" data-throw-if-not-resolved=\"False\" />, <xref href=\"com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsListingByResourceGroup?alt=com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsListingByResourceGroup&text=SupportsListingByResourceGroup\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.microsoft.azure.management.keyvault.Vault?alt=com.microsoft.azure.management.keyvault.Vault&text=Vault\" data-throw-if-not-resolved=\"False\" />&gt;, <xref href=\"com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsGettingByResourceGroup?alt=com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsGettingByResourceGroup&text=SupportsGettingByResourceGroup\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.microsoft.azure.management.keyvault.Vault?alt=com.microsoft.azure.management.keyvault.Vault&text=Vault\" data-throw-if-not-resolved=\"False\" />&gt;, <xref href=\"com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsGettingById?alt=com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsGettingById&text=SupportsGettingById\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.microsoft.azure.management.keyvault.Vault?alt=com.microsoft.azure.management.keyvault.Vault&text=Vault\" data-throw-if-not-resolved=\"False\" />&gt;, <xref href=\"com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsDeletingByResourceGroup?alt=com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsDeletingByResourceGroup&text=SupportsDeletingByResourceGroup\" data-throw-if-not-resolved=\"False\" />, <xref href=\"com.microsoft.azure.management.resources.fluentcore.arm.models.HasManager?alt=com.microsoft.azure.management.resources.fluentcore.arm.models.HasManager&text=HasManager\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.microsoft.azure.management.keyvault.implementation.KeyVaultManager?alt=com.microsoft.azure.management.keyvault.implementation.KeyVaultManager&text=KeyVaultManager\" data-throw-if-not-resolved=\"False\" />&gt;, <xref href=\"com.microsoft.azure.management.resources.fluentcore.model.HasInner?alt=com.microsoft.azure.management.resources.fluentcore.model.HasInner&text=HasInner\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.microsoft.azure.management.keyvault.implementation.VaultsInner?alt=com.microsoft.azure.management.keyvault.implementation.VaultsInner&text=VaultsInner\" data-throw-if-not-resolved=\"False\" />&gt;"
methods:
- uid: "com.microsoft.azure.management.keyvault.Vaults.checkNameAvailability(java.lang.String)"
  fullName: "com.microsoft.azure.management.keyvault.Vaults.checkNameAvailability(String name)"
  name: "checkNameAvailability(String name)"
  nameWithType: "Vaults.checkNameAvailability(String name)"
  summary: "Checks that the vault name is valid and is not already in use."
  modifiers:
  - "abstract"
  parameters:
  - description: "The vault name."
    name: "name"
    type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public abstract CheckNameAvailabilityResult checkNameAvailability(String name)"
  desc: "Checks that the vault name is valid and is not already in use."
  returns:
    description: "the CheckNameAvailabilityResult object if successful."
    type: "<xref href=\"com.microsoft.azure.management.keyvault.CheckNameAvailabilityResult?alt=com.microsoft.azure.management.keyvault.CheckNameAvailabilityResult&text=CheckNameAvailabilityResult\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.keyvault.Vaults.checkNameAvailabilityAsync(java.lang.String)"
  fullName: "com.microsoft.azure.management.keyvault.Vaults.checkNameAvailabilityAsync(String name)"
  name: "checkNameAvailabilityAsync(String name)"
  nameWithType: "Vaults.checkNameAvailabilityAsync(String name)"
  summary: "Checks that the vault name is valid and is not already in use."
  modifiers:
  - "abstract"
  parameters:
  - description: "The vault name."
    name: "name"
    type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public abstract Observable<CheckNameAvailabilityResult> checkNameAvailabilityAsync(String name)"
  desc: "Checks that the vault name is valid and is not already in use."
  returns:
    description: "the observable to the CheckNameAvailabilityResult object"
    type: "<xref href=\"rx.Observable?alt=rx.Observable&text=Observable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.microsoft.azure.management.keyvault.CheckNameAvailabilityResult?alt=com.microsoft.azure.management.keyvault.CheckNameAvailabilityResult&text=CheckNameAvailabilityResult\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.azure.management.keyvault.Vaults.getDeleted(java.lang.String,java.lang.String)"
  fullName: "com.microsoft.azure.management.keyvault.Vaults.getDeleted(String vaultName, String location)"
  name: "getDeleted(String vaultName, String location)"
  nameWithType: "Vaults.getDeleted(String vaultName, String location)"
  summary: "Gets the deleted Azure key vault."
  modifiers:
  - "abstract"
  parameters:
  - description: "The name of the vault."
    name: "vaultName"
    type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
  - description: "The location of the deleted vault."
    name: "location"
    type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public abstract DeletedVault getDeleted(String vaultName, String location)"
  desc: "Gets the deleted Azure key vault."
  returns:
    description: "the DeletedVault object if successful."
    type: "<xref href=\"com.microsoft.azure.management.keyvault.DeletedVault?alt=com.microsoft.azure.management.keyvault.DeletedVault&text=DeletedVault\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.keyvault.Vaults.getDeletedAsync(java.lang.String,java.lang.String)"
  fullName: "com.microsoft.azure.management.keyvault.Vaults.getDeletedAsync(String vaultName, String location)"
  name: "getDeletedAsync(String vaultName, String location)"
  nameWithType: "Vaults.getDeletedAsync(String vaultName, String location)"
  summary: "Gets the deleted Azure key vault."
  modifiers:
  - "abstract"
  parameters:
  - description: "The name of the vault."
    name: "vaultName"
    type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
  - description: "The location of the deleted vault."
    name: "location"
    type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public abstract Observable<DeletedVault> getDeletedAsync(String vaultName, String location)"
  desc: "Gets the deleted Azure key vault."
  returns:
    description: "the <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ServiceFuture\"></xref> object"
    type: "<xref href=\"rx.Observable?alt=rx.Observable&text=Observable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.microsoft.azure.management.keyvault.DeletedVault?alt=com.microsoft.azure.management.keyvault.DeletedVault&text=DeletedVault\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.azure.management.keyvault.Vaults.listDeleted()"
  fullName: "com.microsoft.azure.management.keyvault.Vaults.listDeleted()"
  name: "listDeleted()"
  nameWithType: "Vaults.listDeleted()"
  summary: "Gets information about the deleted vaults in a subscription."
  modifiers:
  - "abstract"
  syntax: "public abstract PagedList<DeletedVault> listDeleted()"
  desc: "Gets information about the deleted vaults in a subscription."
  returns:
    description: "the PagedList&lt;DeletedVault&gt; object if successful."
    type: "<xref href=\"com.microsoft.azure.PagedList?alt=com.microsoft.azure.PagedList&text=PagedList\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.microsoft.azure.management.keyvault.DeletedVault?alt=com.microsoft.azure.management.keyvault.DeletedVault&text=DeletedVault\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.azure.management.keyvault.Vaults.listDeletedAsync()"
  fullName: "com.microsoft.azure.management.keyvault.Vaults.listDeletedAsync()"
  name: "listDeletedAsync()"
  nameWithType: "Vaults.listDeletedAsync()"
  summary: "Gets information about the deleted vaults in a subscription."
  modifiers:
  - "abstract"
  syntax: "public abstract Observable<DeletedVault> listDeletedAsync()"
  desc: "Gets information about the deleted vaults in a subscription."
  returns:
    description: "the observable to the PagedList&lt;DeletedVault&gt; object"
    type: "<xref href=\"rx.Observable?alt=rx.Observable&text=Observable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.microsoft.azure.management.keyvault.DeletedVault?alt=com.microsoft.azure.management.keyvault.DeletedVault&text=DeletedVault\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.azure.management.keyvault.Vaults.purgeDeleted(java.lang.String,java.lang.String)"
  fullName: "com.microsoft.azure.management.keyvault.Vaults.purgeDeleted(String vaultName, String location)"
  name: "purgeDeleted(String vaultName, String location)"
  nameWithType: "Vaults.purgeDeleted(String vaultName, String location)"
  summary: "Permanently deletes the specified vault."
  modifiers:
  - "abstract"
  parameters:
  - description: "The name of the soft-deleted vault."
    name: "vaultName"
    type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
  - description: "The location of the soft-deleted vault."
    name: "location"
    type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public abstract void purgeDeleted(String vaultName, String location)"
  desc: "Permanently deletes the specified vault. aka Purges the deleted Azure key vault."
- uid: "com.microsoft.azure.management.keyvault.Vaults.purgeDeletedAsync(java.lang.String,java.lang.String)"
  fullName: "com.microsoft.azure.management.keyvault.Vaults.purgeDeletedAsync(String vaultName, String location)"
  name: "purgeDeletedAsync(String vaultName, String location)"
  nameWithType: "Vaults.purgeDeletedAsync(String vaultName, String location)"
  summary: "Permanently deletes the specified vault."
  modifiers:
  - "abstract"
  parameters:
  - description: "The name of the soft-deleted vault."
    name: "vaultName"
    type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
  - description: "The location of the soft-deleted vault."
    name: "location"
    type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public abstract Completable purgeDeletedAsync(String vaultName, String location)"
  desc: "Permanently deletes the specified vault. aka Purges the deleted Azure key vault."
  returns:
    description: "the observable for the request"
    type: "<xref href=\"rx.Completable?alt=rx.Completable&text=Completable\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.keyvault.Vaults.recoverSoftDeletedVault(java.lang.String,java.lang.String,java.lang.String)"
  fullName: "com.microsoft.azure.management.keyvault.Vaults.recoverSoftDeletedVault(String resourceGroupName, String vaultName, String location)"
  name: "recoverSoftDeletedVault(String resourceGroupName, String vaultName, String location)"
  nameWithType: "Vaults.recoverSoftDeletedVault(String resourceGroupName, String vaultName, String location)"
  summary: "Recovers a soft deleted vault."
  modifiers:
  - "abstract"
  parameters:
  - description: "The name of the Resource Group to which the server belongs."
    name: "resourceGroupName"
    type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
  - description: "Name of the vault"
    name: "vaultName"
    type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
  - description: "The location of the deleted vault."
    name: "location"
    type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public abstract Vault recoverSoftDeletedVault(String resourceGroupName, String vaultName, String location)"
  desc: "Recovers a soft deleted vault."
  returns:
    description: "the recovered Vault object if successful"
    type: "<xref href=\"com.microsoft.azure.management.keyvault.Vault?alt=com.microsoft.azure.management.keyvault.Vault&text=Vault\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.keyvault.Vaults.recoverSoftDeletedVaultAsync(java.lang.String,java.lang.String,java.lang.String)"
  fullName: "com.microsoft.azure.management.keyvault.Vaults.recoverSoftDeletedVaultAsync(String resourceGroupName, String vaultName, String location)"
  name: "recoverSoftDeletedVaultAsync(String resourceGroupName, String vaultName, String location)"
  nameWithType: "Vaults.recoverSoftDeletedVaultAsync(String resourceGroupName, String vaultName, String location)"
  summary: "Recovers a soft deleted vault."
  modifiers:
  - "abstract"
  parameters:
  - description: "The name of the Resource Group to which the server belongs."
    name: "resourceGroupName"
    type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
  - description: "Name of the vault"
    name: "vaultName"
    type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
  - description: "The location of the deleted vault."
    name: "location"
    type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public abstract Observable<Vault> recoverSoftDeletedVaultAsync(String resourceGroupName, String vaultName, String location)"
  desc: "Recovers a soft deleted vault."
  returns:
    description: "the recovered Vault object if successful"
    type: "<xref href=\"rx.Observable?alt=rx.Observable&text=Observable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.microsoft.azure.management.keyvault.Vault?alt=com.microsoft.azure.management.keyvault.Vault&text=Vault\" data-throw-if-not-resolved=\"False\" />&gt;"
type: "interface"
desc: "Entry point for key vaults management API."
implements:
- "<xref href=\"com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsDeletingByResourceGroup?alt=com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsDeletingByResourceGroup&text=SupportsDeletingByResourceGroup\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsGettingById?alt=com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsGettingById&text=SupportsGettingById\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.microsoft.azure.management.keyvault.Vault?alt=com.microsoft.azure.management.keyvault.Vault&text=Vault\" data-throw-if-not-resolved=\"False\" />&gt;"
- "<xref href=\"com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsGettingByResourceGroup?alt=com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsGettingByResourceGroup&text=SupportsGettingByResourceGroup\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.microsoft.azure.management.keyvault.Vault?alt=com.microsoft.azure.management.keyvault.Vault&text=Vault\" data-throw-if-not-resolved=\"False\" />&gt;"
- "<xref href=\"com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsListingByResourceGroup?alt=com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsListingByResourceGroup&text=SupportsListingByResourceGroup\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.microsoft.azure.management.keyvault.Vault?alt=com.microsoft.azure.management.keyvault.Vault&text=Vault\" data-throw-if-not-resolved=\"False\" />&gt;"
- "<xref href=\"com.microsoft.azure.management.resources.fluentcore.arm.models.HasManager?alt=com.microsoft.azure.management.resources.fluentcore.arm.models.HasManager&text=HasManager\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.microsoft.azure.management.keyvault.implementation.KeyVaultManager?alt=com.microsoft.azure.management.keyvault.implementation.KeyVaultManager&text=KeyVaultManager\" data-throw-if-not-resolved=\"False\" />&gt;"
- "<xref href=\"com.microsoft.azure.management.resources.fluentcore.collection.SupportsCreating?alt=com.microsoft.azure.management.resources.fluentcore.collection.SupportsCreating&text=SupportsCreating\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.microsoft.azure.management.keyvault.Vault.DefinitionStages.Blank?alt=com.microsoft.azure.management.keyvault.Vault.DefinitionStages.Blank&text=Blank\" data-throw-if-not-resolved=\"False\" />&gt;"
- "<xref href=\"com.microsoft.azure.management.resources.fluentcore.collection.SupportsDeletingById?alt=com.microsoft.azure.management.resources.fluentcore.collection.SupportsDeletingById&text=SupportsDeletingById\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.management.resources.fluentcore.model.HasInner?alt=com.microsoft.azure.management.resources.fluentcore.model.HasInner&text=HasInner\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.microsoft.azure.management.keyvault.implementation.VaultsInner?alt=com.microsoft.azure.management.keyvault.implementation.VaultsInner&text=VaultsInner\" data-throw-if-not-resolved=\"False\" />&gt;"
metadata: {}
package: "com.microsoft.azure.management.keyvault"
artifact: com.microsoft.azure:azure-mgmt-keyvault:1.41.4