azure-docs-sdk-java/docs-ref-autogen/com.azure.resourcemanager.k...

195 строки
18 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.resourcemanager.keyvault.models.Vaults"
fullName: "com.azure.resourcemanager.keyvault.models.Vaults"
name: "Vaults"
nameWithType: "Vaults"
summary: "Entry point for key vaults management API."
syntax: "public interface **Vaults**</br> extends <xref href=\"com.azure.resourcemanager.resources.fluentcore.collection.SupportsCreating?alt=com.azure.resourcemanager.resources.fluentcore.collection.SupportsCreating&text=SupportsCreating\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.keyvault.models.Vault.DefinitionStages.Blank?alt=com.azure.resourcemanager.keyvault.models.Vault.DefinitionStages.Blank&text=Blank\" data-throw-if-not-resolved=\"False\" />&gt;, <xref href=\"com.azure.resourcemanager.resources.fluentcore.collection.SupportsDeletingById?alt=com.azure.resourcemanager.resources.fluentcore.collection.SupportsDeletingById&text=SupportsDeletingById\" data-throw-if-not-resolved=\"False\" />, <xref href=\"com.azure.resourcemanager.resources.fluentcore.arm.collection.SupportsListingByResourceGroup?alt=com.azure.resourcemanager.resources.fluentcore.arm.collection.SupportsListingByResourceGroup&text=SupportsListingByResourceGroup\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.keyvault.models.Vault?alt=com.azure.resourcemanager.keyvault.models.Vault&text=Vault\" data-throw-if-not-resolved=\"False\" />&gt;, <xref href=\"com.azure.resourcemanager.resources.fluentcore.arm.collection.SupportsGettingByResourceGroup?alt=com.azure.resourcemanager.resources.fluentcore.arm.collection.SupportsGettingByResourceGroup&text=SupportsGettingByResourceGroup\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.keyvault.models.Vault?alt=com.azure.resourcemanager.keyvault.models.Vault&text=Vault\" data-throw-if-not-resolved=\"False\" />&gt;, <xref href=\"com.azure.resourcemanager.resources.fluentcore.arm.collection.SupportsGettingById?alt=com.azure.resourcemanager.resources.fluentcore.arm.collection.SupportsGettingById&text=SupportsGettingById\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.keyvault.models.Vault?alt=com.azure.resourcemanager.keyvault.models.Vault&text=Vault\" data-throw-if-not-resolved=\"False\" />&gt;, <xref href=\"com.azure.resourcemanager.resources.fluentcore.arm.collection.SupportsDeletingByResourceGroup?alt=com.azure.resourcemanager.resources.fluentcore.arm.collection.SupportsDeletingByResourceGroup&text=SupportsDeletingByResourceGroup\" data-throw-if-not-resolved=\"False\" />, <xref href=\"com.azure.resourcemanager.resources.fluentcore.arm.models.HasManager?alt=com.azure.resourcemanager.resources.fluentcore.arm.models.HasManager&text=HasManager\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.keyvault.KeyVaultManager?alt=com.azure.resourcemanager.keyvault.KeyVaultManager&text=KeyVaultManager\" data-throw-if-not-resolved=\"False\" />&gt;"
methods:
- uid: "com.azure.resourcemanager.keyvault.models.Vaults.checkNameAvailability(java.lang.String)"
fullName: "com.azure.resourcemanager.keyvault.models.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: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
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.azure.resourcemanager.keyvault.models.CheckNameAvailabilityResult?alt=com.azure.resourcemanager.keyvault.models.CheckNameAvailabilityResult&text=CheckNameAvailabilityResult\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.keyvault.models.Vaults.checkNameAvailabilityAsync(java.lang.String)"
fullName: "com.azure.resourcemanager.keyvault.models.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: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract Mono<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: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.resourcemanager.keyvault.models.CheckNameAvailabilityResult?alt=com.azure.resourcemanager.keyvault.models.CheckNameAvailabilityResult&text=CheckNameAvailabilityResult\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.keyvault.models.Vaults.getDeleted(java.lang.String,java.lang.String)"
fullName: "com.azure.resourcemanager.keyvault.models.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: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The location of the deleted vault."
name: "location"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
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.azure.resourcemanager.keyvault.models.DeletedVault?alt=com.azure.resourcemanager.keyvault.models.DeletedVault&text=DeletedVault\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.keyvault.models.Vaults.getDeletedAsync(java.lang.String,java.lang.String)"
fullName: "com.azure.resourcemanager.keyvault.models.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: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The location of the deleted vault."
name: "location"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract Mono<DeletedVault> getDeletedAsync(String vaultName, String location)"
desc: "Gets the deleted Azure key vault."
returns:
description: "the <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> object"
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.resourcemanager.keyvault.models.DeletedVault?alt=com.azure.resourcemanager.keyvault.models.DeletedVault&text=DeletedVault\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.keyvault.models.Vaults.listDeleted()"
fullName: "com.azure.resourcemanager.keyvault.models.Vaults.listDeleted()"
name: "listDeleted()"
nameWithType: "Vaults.listDeleted()"
summary: "Gets information about the deleted vaults in a subscription."
modifiers:
- "abstract"
syntax: "public abstract PagedIterable<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.azure.core.http.rest.PagedIterable?alt=com.azure.core.http.rest.PagedIterable&text=PagedIterable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.keyvault.models.DeletedVault?alt=com.azure.resourcemanager.keyvault.models.DeletedVault&text=DeletedVault\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.keyvault.models.Vaults.listDeletedAsync()"
fullName: "com.azure.resourcemanager.keyvault.models.Vaults.listDeletedAsync()"
name: "listDeletedAsync()"
nameWithType: "Vaults.listDeletedAsync()"
summary: "Gets information about the deleted vaults in a subscription."
modifiers:
- "abstract"
syntax: "public abstract PagedFlux<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=\"com.azure.core.http.rest.PagedFlux?alt=com.azure.core.http.rest.PagedFlux&text=PagedFlux\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.keyvault.models.DeletedVault?alt=com.azure.resourcemanager.keyvault.models.DeletedVault&text=DeletedVault\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.keyvault.models.Vaults.purgeDeleted(java.lang.String,java.lang.String)"
fullName: "com.azure.resourcemanager.keyvault.models.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: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The location of the soft-deleted vault."
name: "location"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract void purgeDeleted(String vaultName, String location)"
desc: "Permanently deletes the specified vault. aka Purges the deleted Azure key vault."
- uid: "com.azure.resourcemanager.keyvault.models.Vaults.purgeDeletedAsync(java.lang.String,java.lang.String)"
fullName: "com.azure.resourcemanager.keyvault.models.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: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The location of the soft-deleted vault."
name: "location"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract Mono<Void> 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: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>&gt;"
- uid: "com.azure.resourcemanager.keyvault.models.Vaults.recoverSoftDeletedVault(java.lang.String,java.lang.String,java.lang.String)"
fullName: "com.azure.resourcemanager.keyvault.models.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: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Name of the vault"
name: "vaultName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The location of the deleted vault."
name: "location"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
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.azure.resourcemanager.keyvault.models.Vault?alt=com.azure.resourcemanager.keyvault.models.Vault&text=Vault\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.keyvault.models.Vaults.recoverSoftDeletedVaultAsync(java.lang.String,java.lang.String,java.lang.String)"
fullName: "com.azure.resourcemanager.keyvault.models.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: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Name of the vault"
name: "vaultName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The location of the deleted vault."
name: "location"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract Mono<Vault> recoverSoftDeletedVaultAsync(String resourceGroupName, String vaultName, String location)"
desc: "Recovers a soft deleted vault."
returns:
description: "the recovered Vault object if successful"
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.resourcemanager.keyvault.models.Vault?alt=com.azure.resourcemanager.keyvault.models.Vault&text=Vault\" data-throw-if-not-resolved=\"False\" />&gt;"
type: "interface"
desc: "Entry point for key vaults management API."
implements:
- "<xref href=\"com.azure.resourcemanager.resources.fluentcore.arm.collection.SupportsDeletingByResourceGroup?alt=com.azure.resourcemanager.resources.fluentcore.arm.collection.SupportsDeletingByResourceGroup&text=SupportsDeletingByResourceGroup\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.resourcemanager.resources.fluentcore.arm.collection.SupportsGettingById?alt=com.azure.resourcemanager.resources.fluentcore.arm.collection.SupportsGettingById&text=SupportsGettingById\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.keyvault.models.Vault?alt=com.azure.resourcemanager.keyvault.models.Vault&text=Vault\" data-throw-if-not-resolved=\"False\" />&gt;"
- "<xref href=\"com.azure.resourcemanager.resources.fluentcore.arm.collection.SupportsGettingByResourceGroup?alt=com.azure.resourcemanager.resources.fluentcore.arm.collection.SupportsGettingByResourceGroup&text=SupportsGettingByResourceGroup\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.keyvault.models.Vault?alt=com.azure.resourcemanager.keyvault.models.Vault&text=Vault\" data-throw-if-not-resolved=\"False\" />&gt;"
- "<xref href=\"com.azure.resourcemanager.resources.fluentcore.arm.collection.SupportsListingByResourceGroup?alt=com.azure.resourcemanager.resources.fluentcore.arm.collection.SupportsListingByResourceGroup&text=SupportsListingByResourceGroup\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.keyvault.models.Vault?alt=com.azure.resourcemanager.keyvault.models.Vault&text=Vault\" data-throw-if-not-resolved=\"False\" />&gt;"
- "<xref href=\"com.azure.resourcemanager.resources.fluentcore.arm.models.HasManager?alt=com.azure.resourcemanager.resources.fluentcore.arm.models.HasManager&text=HasManager\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.keyvault.KeyVaultManager?alt=com.azure.resourcemanager.keyvault.KeyVaultManager&text=KeyVaultManager\" data-throw-if-not-resolved=\"False\" />&gt;"
- "<xref href=\"com.azure.resourcemanager.resources.fluentcore.collection.SupportsCreating?alt=com.azure.resourcemanager.resources.fluentcore.collection.SupportsCreating&text=SupportsCreating\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.keyvault.models.Vault.DefinitionStages.Blank?alt=com.azure.resourcemanager.keyvault.models.Vault.DefinitionStages.Blank&text=Blank\" data-throw-if-not-resolved=\"False\" />&gt;"
- "<xref href=\"com.azure.resourcemanager.resources.fluentcore.collection.SupportsDeletingById?alt=com.azure.resourcemanager.resources.fluentcore.collection.SupportsDeletingById&text=SupportsDeletingById\" data-throw-if-not-resolved=\"False\" />"
metadata: {}
package: "com.azure.resourcemanager.keyvault.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-keyvault:2.24.0