Interface Vault
- All Superinterfaces:
GroupableResource<KeyVaultManager,,VaultInner> HasId,HasInnerModel<VaultInner>,HasManager<KeyVaultManager>,HasName,HasResourceGroup,Indexable,Refreshable<Vault>,Resource,SupportsListingPrivateLinkResource,SupportsUpdatingPrivateEndpointConnection,Updatable<Vault.Update>
public interface Vault
extends GroupableResource<KeyVaultManager,VaultInner>, Refreshable<Vault>, Updatable<Vault.Update>, SupportsListingPrivateLinkResource, SupportsUpdatingPrivateEndpointConnection
An immutable client-side representation of an Azure Key Vault.
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic interfaceContainer interface for all the definitions that need to be implemented.static interfaceGrouping of all the key vault definition stages.static interfaceThe template for a key vault update operation, containing all the settings that can be modified.static interfaceGrouping of all the key vault update stages.Nested classes/interfaces inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.Resource
Resource.DefinitionWithRegion<T>, Resource.DefinitionWithTags<T>, Resource.UpdateWithTags<T> -
Field Summary
-
Method Summary
Modifier and TypeMethodDescriptionGets an array of 0 to 16 identities that have access to the key vault.Get the createMode value.booleanChecks whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault.booleanChecks whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys.booleanChecks whether Azure Resource Manager is permitted to retrieve secrets from the key vault.com.azure.security.keyvault.keys.KeyAsyncClientGets an authenticated Key Vault key client.keys()Gets the Key Vault key API entry point.Get the networkAcls value.Whether the vault can be accessed from public network.booleanChecks whether purge protection is enabled for this key vault.booleanChecks whether role based access control (RBAC) for authorization of data access is enabled.com.azure.security.keyvault.secrets.SecretAsyncClientGets an authenticated Key Vault secret client.secrets()Gets the Key Vault secret API entry point.sku()Gets SKU details.booleanGets whether soft delete is enabled for this key vault.tenantId()Gets the Azure Active Directory tenant ID that should be used for authenticating requests to the key vault.com.azure.core.http.HttpPipelineGets an authenticated Key Vault rest client.vaultUri()Gets the URI of the vault for performing operations on keys and secrets.Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.HasInnerModel
innerModelMethods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasManager
managerMethods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasName
nameMethods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasResourceGroup
resourceGroupNameMethods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.Refreshable
refresh, refreshAsyncMethods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.Resource
region, regionName, tags, typeMethods inherited from interface com.azure.resourcemanager.resources.fluentcore.collection.SupportsListingPrivateLinkResource
listPrivateLinkResources, listPrivateLinkResourcesAsyncMethods inherited from interface com.azure.resourcemanager.resources.fluentcore.collection.SupportsUpdatingPrivateEndpointConnection
approvePrivateEndpointConnection, approvePrivateEndpointConnectionAsync, rejectPrivateEndpointConnection, rejectPrivateEndpointConnectionAsync
-
Method Details
-
secretClient
com.azure.security.keyvault.secrets.SecretAsyncClient secretClient()Gets an authenticated Key Vault secret client.- Returns:
- an authenticated Key Vault secret client
-
keyClient
com.azure.security.keyvault.keys.KeyAsyncClient keyClient()Gets an authenticated Key Vault key client.- Returns:
- an authenticated Key Vault key client
-
vaultHttpPipeline
com.azure.core.http.HttpPipeline vaultHttpPipeline()Gets an authenticated Key Vault rest client.- Returns:
- an authenticated Key Vault rest client
-
keys
Keys keys()Gets the Key Vault key API entry point.- Returns:
- the Key Vault key API entry point
-
secrets
Secrets secrets()Gets the Key Vault secret API entry point.- Returns:
- the Key Vault secret API entry point
-
vaultUri
String vaultUri()Gets the URI of the vault for performing operations on keys and secrets.- Returns:
- the URI of the vault for performing operations on keys and secrets.
-
tenantId
String tenantId()Gets the Azure Active Directory tenant ID that should be used for authenticating requests to the key vault.- Returns:
- the Azure Active Directory tenant ID that should be used for authenticating requests to the key vault.
-
sku
Sku sku()Gets SKU details.- Returns:
- SKU details.
-
accessPolicies
List<AccessPolicy> accessPolicies()Gets an array of 0 to 16 identities that have access to the key vault.- Returns:
- an array of 0 to 16 identities that have access to the key vault. All identities in the array must use the same tenant ID as the key vault's tenant ID.
-
roleBasedAccessControlEnabled
boolean roleBasedAccessControlEnabled()Checks whether role based access control (RBAC) for authorization of data access is enabled.- Returns:
- whether role based access control (RBAC) for authorization of data access is enabled.
-
publicNetworkAccess
PublicNetworkAccess publicNetworkAccess()Whether the vault can be accessed from public network.- Returns:
- whether the vault can be accessed from public network.
-
enabledForDeployment
boolean enabledForDeployment()Checks whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault.- Returns:
- whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault.
-
enabledForDiskEncryption
boolean enabledForDiskEncryption()Checks whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys.- Returns:
- whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys.
-
enabledForTemplateDeployment
boolean enabledForTemplateDeployment()Checks whether Azure Resource Manager is permitted to retrieve secrets from the key vault.- Returns:
- whether Azure Resource Manager is permitted to retrieve secrets from the key vault.
-
softDeleteEnabled
boolean softDeleteEnabled()Gets whether soft delete is enabled for this key vault.- Returns:
- whether soft delete is enabled for this key vault.
-
purgeProtectionEnabled
boolean purgeProtectionEnabled()Checks whether purge protection is enabled for this key vault.- Returns:
- whether purge protection is enabled for this key vault. Purge protection can only be enabled if soft delete is enabled.
-
createMode
CreateMode createMode()Get the createMode value.- Returns:
- the createMode value
-
networkRuleSet
NetworkRuleSet networkRuleSet()Get the networkAcls value.- Returns:
- the networkAcls value
-