Index
All Classes and Interfaces|All Packages|Serialized Form
A
- addPolicy(HttpPipelinePolicy) - Method in class com.azure.security.keyvault.administration.KeyVaultAccessControlClientBuilder
-
Adds a
pipeline policy
to apply on each request sent. - addPolicy(HttpPipelinePolicy) - Method in class com.azure.security.keyvault.administration.KeyVaultBackupClientBuilder
-
Adds a
pipeline policy
to apply on each request sent. - addPolicy(HttpPipelinePolicy) - Method in class com.azure.security.keyvault.administration.KeyVaultSettingsClientBuilder
-
Adds a
pipeline policy
to apply on each request sent. - asBoolean() - Method in class com.azure.security.keyvault.administration.models.KeyVaultSetting
-
Get the value of the
KeyVaultSetting
as aBoolean
. - asString() - Method in class com.azure.security.keyvault.administration.models.KeyVaultSetting
-
Get the value of the
KeyVaultSetting
as aString
.
B
- BACKUP_HSM_KEYS - Static variable in class com.azure.security.keyvault.administration.models.KeyVaultDataAction
-
Static value Microsoft.KeyVault/managedHsm/keys/backup/action for
KeyVaultDataAction
. - beginBackup(String, String) - Method in class com.azure.security.keyvault.administration.KeyVaultBackupAsyncClient
-
Initiates a full backup of the Key Vault.
- beginBackup(String, String) - Method in class com.azure.security.keyvault.administration.KeyVaultBackupClient
-
Initiates a full backup of the Key Vault.
- beginRestore(String, String) - Method in class com.azure.security.keyvault.administration.KeyVaultBackupAsyncClient
-
Initiates a full restore of the Key Vault.
- beginRestore(String, String) - Method in class com.azure.security.keyvault.administration.KeyVaultBackupClient
-
Initiates a full restore of the Key Vault.
- beginSelectiveKeyRestore(String, String, String) - Method in class com.azure.security.keyvault.administration.KeyVaultBackupAsyncClient
-
Restores all versions of a given key using the supplied SAS token pointing to a previously stored Azure Blob storage backup folder.
- beginSelectiveKeyRestore(String, String, String) - Method in class com.azure.security.keyvault.administration.KeyVaultBackupClient
-
Restores all versions of a given key using the supplied SAS token pointing to a previously stored Azure Blob storage backup folder.
- BOOLEAN - Static variable in class com.azure.security.keyvault.administration.models.KeyVaultSettingType
-
Static value boolean for
KeyVaultSettingType
. - buildAsyncClient() - Method in class com.azure.security.keyvault.administration.KeyVaultAccessControlClientBuilder
-
Creates a
KeyVaultAccessControlAsyncClient
based on options set in the Builder. - buildAsyncClient() - Method in class com.azure.security.keyvault.administration.KeyVaultBackupClientBuilder
-
Creates a
KeyVaultBackupAsyncClient
based on options set in the Builder. - buildAsyncClient() - Method in class com.azure.security.keyvault.administration.KeyVaultSettingsClientBuilder
-
Builds an instance of KeyVaultSettingsAsyncClient class.
- buildClient() - Method in class com.azure.security.keyvault.administration.KeyVaultAccessControlClientBuilder
-
Creates an
KeyVaultAccessControlClient
based on options set in the Builder. - buildClient() - Method in class com.azure.security.keyvault.administration.KeyVaultBackupClientBuilder
-
Creates an
KeyVaultBackupClient
based on options set in the Builder. - buildClient() - Method in class com.azure.security.keyvault.administration.KeyVaultSettingsClientBuilder
-
Builds an instance of KeyVaultSettingsClient class.
- BUILT_IN_ROLE - Static variable in class com.azure.security.keyvault.administration.models.KeyVaultRoleType
-
Static value AKVBuiltInRole for
KeyVaultRoleType
.
C
- clientOptions(ClientOptions) - Method in class com.azure.security.keyvault.administration.KeyVaultAccessControlClientBuilder
-
Allows for setting common properties such as application ID, headers, proxy configuration, etc.
- clientOptions(ClientOptions) - Method in class com.azure.security.keyvault.administration.KeyVaultBackupClientBuilder
-
Allows for setting common properties such as application ID, headers, proxy configuration, etc.
- clientOptions(ClientOptions) - Method in class com.azure.security.keyvault.administration.KeyVaultSettingsClientBuilder
-
Allows for setting common properties such as application ID, headers, proxy configuration, etc.
- com.azure.security.keyvault.administration - package com.azure.security.keyvault.administration
-
Package containing classes for creating clients
KeyVaultAccessControlAsyncClient
andKeyVaultAccessControlClient
that perform access control operations on Azure Key Vault resources, as well as clientsKeyVaultBackupAsyncClient
andKeyVaultBackupClient
that perform backup and restore operations on Azure Key Vault keys. - com.azure.security.keyvault.administration.models - package com.azure.security.keyvault.administration.models
-
Package containing classes used by
KeyVaultAccessControlAsyncClient
andKeyVaultAccessControlClient
to perform access control operations on Azure Key Vault resources, as well as classes used byKeyVaultBackupAsyncClient
andKeyVaultBackupClient
to perform backup and restore operations on on Azure Key Vault keys. - configuration(Configuration) - Method in class com.azure.security.keyvault.administration.KeyVaultAccessControlClientBuilder
-
Sets the configuration store that is used during construction of the service client.
- configuration(Configuration) - Method in class com.azure.security.keyvault.administration.KeyVaultBackupClientBuilder
-
Sets the configuration store that is used during construction of the service client.
- configuration(Configuration) - Method in class com.azure.security.keyvault.administration.KeyVaultSettingsClientBuilder
-
Sets the configuration store that is used during construction of the service client.
- CREATE_HSM_KEY - Static variable in class com.azure.security.keyvault.administration.models.KeyVaultDataAction
-
Static value Microsoft.KeyVault/managedHsm/keys/create for
KeyVaultDataAction
. - createRoleAssignment(KeyVaultRoleScope, String, String) - Method in class com.azure.security.keyvault.administration.KeyVaultAccessControlAsyncClient
-
Creates a
role assignment
with a randomly generated name. - createRoleAssignment(KeyVaultRoleScope, String, String) - Method in class com.azure.security.keyvault.administration.KeyVaultAccessControlClient
-
Creates a
role assignment
with a randomly generated name. - createRoleAssignment(KeyVaultRoleScope, String, String, String) - Method in class com.azure.security.keyvault.administration.KeyVaultAccessControlAsyncClient
-
Creates a
role assignment
. - createRoleAssignment(KeyVaultRoleScope, String, String, String) - Method in class com.azure.security.keyvault.administration.KeyVaultAccessControlClient
-
Creates a
role assignment
. - createRoleAssignmentWithResponse(KeyVaultRoleScope, String, String, String) - Method in class com.azure.security.keyvault.administration.KeyVaultAccessControlAsyncClient
-
Creates a
role assignment
. - createRoleAssignmentWithResponse(KeyVaultRoleScope, String, String, String, Context) - Method in class com.azure.security.keyvault.administration.KeyVaultAccessControlClient
-
Creates a
role assignment
. - credential(TokenCredential) - Method in class com.azure.security.keyvault.administration.KeyVaultAccessControlClientBuilder
-
Sets the
TokenCredential
used to authorize requests sent to the service. - credential(TokenCredential) - Method in class com.azure.security.keyvault.administration.KeyVaultBackupClientBuilder
-
Sets the
TokenCredential
used to authorize requests sent to the service. - credential(TokenCredential) - Method in class com.azure.security.keyvault.administration.KeyVaultSettingsClientBuilder
-
Sets the
TokenCredential
used to authorize requests sent to the service. - CUSTOM_ROLE - Static variable in class com.azure.security.keyvault.administration.models.KeyVaultRoleType
-
Static value CustomRole for
KeyVaultRoleType
.
D
- DECRYPT_HSM_KEY - Static variable in class com.azure.security.keyvault.administration.models.KeyVaultDataAction
-
Static value Microsoft.KeyVault/managedHsm/keys/decrypt/action for
KeyVaultDataAction
. - DELETE_HSM_KEY - Static variable in class com.azure.security.keyvault.administration.models.KeyVaultDataAction
-
Static value Microsoft.KeyVault/managedHsm/keys/delete for
KeyVaultDataAction
. - DELETE_ROLE_ASSIGNMENT - Static variable in class com.azure.security.keyvault.administration.models.KeyVaultDataAction
-
Static value Microsoft.KeyVault/managedHsm/roleAssignments/delete/action for
KeyVaultDataAction
. - DELETE_ROLE_DEFINITION - Static variable in class com.azure.security.keyvault.administration.models.KeyVaultDataAction
-
Static value Microsoft.KeyVault/managedHsm/roleDefinitions/delete/action for DataAction.
- deleteRoleAssignment(KeyVaultRoleScope, String) - Method in class com.azure.security.keyvault.administration.KeyVaultAccessControlAsyncClient
-
Deletes a
role assignment
. - deleteRoleAssignment(KeyVaultRoleScope, String) - Method in class com.azure.security.keyvault.administration.KeyVaultAccessControlClient
-
Deletes a
role assignment
. - deleteRoleAssignmentWithResponse(KeyVaultRoleScope, String) - Method in class com.azure.security.keyvault.administration.KeyVaultAccessControlAsyncClient
-
Deletes a
role assignment
. - deleteRoleAssignmentWithResponse(KeyVaultRoleScope, String, Context) - Method in class com.azure.security.keyvault.administration.KeyVaultAccessControlClient
-
Deletes a
role assignment
. - deleteRoleDefinition(KeyVaultRoleScope, String) - Method in class com.azure.security.keyvault.administration.KeyVaultAccessControlAsyncClient
-
Deletes a
role definition
. - deleteRoleDefinition(KeyVaultRoleScope, String) - Method in class com.azure.security.keyvault.administration.KeyVaultAccessControlClient
-
Deletes a
role definition
. - deleteRoleDefinitionWithResponse(KeyVaultRoleScope, String) - Method in class com.azure.security.keyvault.administration.KeyVaultAccessControlAsyncClient
-
Deletes a
role definition
. - deleteRoleDefinitionWithResponse(KeyVaultRoleScope, String, Context) - Method in class com.azure.security.keyvault.administration.KeyVaultAccessControlClient
-
Deletes a
role definition
. - disableChallengeResourceVerification() - Method in class com.azure.security.keyvault.administration.KeyVaultAccessControlClientBuilder
-
Disables verifying if the authentication challenge resource matches the Key Vault or Managed HSM domain.
- disableChallengeResourceVerification() - Method in class com.azure.security.keyvault.administration.KeyVaultBackupClientBuilder
-
Disables verifying if the authentication challenge resource matches the Key Vault or Managed HSM domain.
- disableChallengeResourceVerification() - Method in class com.azure.security.keyvault.administration.KeyVaultSettingsClientBuilder
-
Disables verifying if the authentication challenge resource matches the Key Vault or Managed HSM domain.
- DOWNLOAD_HSM_SECURITY_DOMAIN - Static variable in class com.azure.security.keyvault.administration.models.KeyVaultDataAction
-
Static value Microsoft.KeyVault/managedHsm/securitydomain/download/action for
KeyVaultDataAction
. - DOWNLOAD_HSM_SECURITY_DOMAIN_STATUS - Static variable in class com.azure.security.keyvault.administration.models.KeyVaultDataAction
-
Static value Microsoft.KeyVault/managedHsm/securitydomain/download/read for DataAction.
E
- ENCRYPT_HSM_KEY - Static variable in class com.azure.security.keyvault.administration.models.KeyVaultDataAction
-
Static value Microsoft.KeyVault/managedHsm/keys/encrypt/action for
KeyVaultDataAction
. - EXPORT_HSM_KEY - Static variable in class com.azure.security.keyvault.administration.models.KeyVaultDataAction
-
Static value Microsoft.KeyVault/managedHsm/keys/export/action for
KeyVaultDataAction
.
F
- fromString(String) - Static method in class com.azure.security.keyvault.administration.models.KeyVaultDataAction
-
Creates or finds a
KeyVaultDataAction
from its string representation. - fromString(String) - Static method in class com.azure.security.keyvault.administration.models.KeyVaultRoleDefinitionType
-
Creates or finds a
KeyVaultRoleDefinitionType
from its string representation. - fromString(String) - Static method in class com.azure.security.keyvault.administration.models.KeyVaultRoleScope
-
Creates or finds a
KeyVaultRoleScope
from its string representation. - fromString(String) - Static method in class com.azure.security.keyvault.administration.models.KeyVaultRoleType
-
Creates or finds a
KeyVaultRoleType
from its string representation. - fromString(String) - Static method in class com.azure.security.keyvault.administration.models.KeyVaultSettingType
-
Creates or finds a
KeyVaultSettingType
from its string representation. - fromUrl(String) - Static method in class com.azure.security.keyvault.administration.models.KeyVaultRoleScope
-
Creates or finds a
KeyVaultRoleScope
from its string representation. - fromUrl(URL) - Static method in class com.azure.security.keyvault.administration.models.KeyVaultRoleScope
-
Creates or finds a
KeyVaultRoleScope
from its string representation.
G
- GET_ROLE_ASSIGNMENT - Static variable in class com.azure.security.keyvault.administration.models.KeyVaultDataAction
-
Static value Microsoft.KeyVault/managedHsm/roleAssignments/read/action for
KeyVaultDataAction
. - getActions() - Method in class com.azure.security.keyvault.administration.models.KeyVaultPermission
-
Get the action permissions that are granted.
- getAssignableScopes() - Method in class com.azure.security.keyvault.administration.models.KeyVaultRoleDefinition
-
Get the
role definition
's assignable scopes. - getAssignableScopes() - Method in class com.azure.security.keyvault.administration.models.SetRoleDefinitionOptions
-
Get the
role definition
's assignable scopes. - getAzureStorageBlobContainerUrl() - Method in class com.azure.security.keyvault.administration.models.KeyVaultBackupOperation
-
Get the Azure Blob Storage container URI where the backup resides.
- getCode() - Method in class com.azure.security.keyvault.administration.models.KeyVaultAdministrationError
-
Get the error code.
- getDataActions() - Method in class com.azure.security.keyvault.administration.models.KeyVaultPermission
-
Get the data action permissions that are granted.
- getDescription() - Method in class com.azure.security.keyvault.administration.models.KeyVaultRoleDefinition
-
Get the role description.
- getDescription() - Method in class com.azure.security.keyvault.administration.models.SetRoleDefinitionOptions
-
Get the role description.
- getEndTime() - Method in class com.azure.security.keyvault.administration.models.KeyVaultLongRunningOperation
-
Get the end time of the
KeyVaultLongRunningOperation
. - getError() - Method in class com.azure.security.keyvault.administration.models.KeyVaultLongRunningOperation
-
Get the error encountered, if any, during the
KeyVaultLongRunningOperation
. - getId() - Method in class com.azure.security.keyvault.administration.models.KeyVaultRoleAssignment
-
Get the
role assignment
ID. - getId() - Method in class com.azure.security.keyvault.administration.models.KeyVaultRoleDefinition
-
Get the
role definition
ID. - getInnerError() - Method in class com.azure.security.keyvault.administration.models.KeyVaultAdministrationError
-
Get the Key Vault server-side error.
- getLatest() - Static method in enum com.azure.security.keyvault.administration.KeyVaultAdministrationServiceVersion
-
Gets the latest service version supported by this client library.
- getMessage() - Method in class com.azure.security.keyvault.administration.models.KeyVaultAdministrationError
-
Get the error message.
- getName() - Method in class com.azure.security.keyvault.administration.models.KeyVaultRoleAssignment
-
Get the
role assignment
name. - getName() - Method in class com.azure.security.keyvault.administration.models.KeyVaultRoleDefinition
-
Get the
role definition
name. - getName() - Method in class com.azure.security.keyvault.administration.models.KeyVaultSetting
-
Gets the name of the
KeyVaultSetting
. - getNotActions() - Method in class com.azure.security.keyvault.administration.models.KeyVaultPermission
-
Get the action permissions that are excluded but not denied.
- getNotDataActions() - Method in class com.azure.security.keyvault.administration.models.KeyVaultPermission
-
Get the data action permissions that are excluded but not denied.
- getOperationId() - Method in class com.azure.security.keyvault.administration.models.KeyVaultLongRunningOperation
-
Get the identifier for the
KeyVaultLongRunningOperation
. - getPermissions() - Method in class com.azure.security.keyvault.administration.models.KeyVaultRoleDefinition
-
Get the
role definition
'spermissions
. - getPermissions() - Method in class com.azure.security.keyvault.administration.models.SetRoleDefinitionOptions
-
Get the
role definition
'spermissions
. - getPrincipalId() - Method in class com.azure.security.keyvault.administration.models.KeyVaultRoleAssignmentProperties
-
Get the principal ID assigned to the role.
- getProperties() - Method in class com.azure.security.keyvault.administration.models.KeyVaultRoleAssignment
-
Get the
role assignment
properties
. - getRoleAssignment(KeyVaultRoleScope, String) - Method in class com.azure.security.keyvault.administration.KeyVaultAccessControlAsyncClient
-
Gets a
role assignment
. - getRoleAssignment(KeyVaultRoleScope, String) - Method in class com.azure.security.keyvault.administration.KeyVaultAccessControlClient
-
Gets a
role assignment
. - getRoleAssignmentWithResponse(KeyVaultRoleScope, String) - Method in class com.azure.security.keyvault.administration.KeyVaultAccessControlAsyncClient
-
Gets a
role assignment
. - getRoleAssignmentWithResponse(KeyVaultRoleScope, String, Context) - Method in class com.azure.security.keyvault.administration.KeyVaultAccessControlClient
-
Gets a
role assignment
. - getRoleDefinition(KeyVaultRoleScope, String) - Method in class com.azure.security.keyvault.administration.KeyVaultAccessControlAsyncClient
-
Gets a
role definition
. - getRoleDefinition(KeyVaultRoleScope, String) - Method in class com.azure.security.keyvault.administration.KeyVaultAccessControlClient
-
Gets a
role definition
. - getRoleDefinitionId() - Method in class com.azure.security.keyvault.administration.models.KeyVaultRoleAssignmentProperties
-
Get the
role definition
ID used in therole assignment
. - getRoleDefinitionName() - Method in class com.azure.security.keyvault.administration.models.SetRoleDefinitionOptions
-
Get the name of the
KeyVaultRoleDefinition
to create or update. - getRoleDefinitionWithResponse(KeyVaultRoleScope, String) - Method in class com.azure.security.keyvault.administration.KeyVaultAccessControlAsyncClient
-
Gets a
role definition
. - getRoleDefinitionWithResponse(KeyVaultRoleScope, String, Context) - Method in class com.azure.security.keyvault.administration.KeyVaultAccessControlClient
-
Gets a
role definition
. - getRoleName() - Method in class com.azure.security.keyvault.administration.models.KeyVaultRoleDefinition
-
Get the role name.
- getRoleName() - Method in class com.azure.security.keyvault.administration.models.SetRoleDefinitionOptions
-
Get the role name.
- getRoleScope() - Method in class com.azure.security.keyvault.administration.models.SetRoleDefinitionOptions
-
Get the
role scope
of theKeyVaultRoleDefinition
to create or update. - getRoleType() - Method in class com.azure.security.keyvault.administration.models.KeyVaultRoleDefinition
-
Get the role type.
- getScope() - Method in class com.azure.security.keyvault.administration.models.KeyVaultRoleAssignmentProperties
-
Get the
role assignment
scope
. - getSetting(String) - Method in class com.azure.security.keyvault.administration.KeyVaultSettingsAsyncClient
-
Get the value of a specific account setting.
- getSetting(String) - Method in class com.azure.security.keyvault.administration.KeyVaultSettingsClient
-
Get the value of a specific account setting.
- getSettingWithResponse(String) - Method in class com.azure.security.keyvault.administration.KeyVaultSettingsAsyncClient
-
Get the value of a specific account setting.
- getSettingWithResponse(String, Context) - Method in class com.azure.security.keyvault.administration.KeyVaultSettingsClient
-
Get the value of a specific account setting.
- getStartTime() - Method in class com.azure.security.keyvault.administration.models.KeyVaultLongRunningOperation
-
Get the start time of the
KeyVaultLongRunningOperation
. - getStatus() - Method in class com.azure.security.keyvault.administration.models.KeyVaultLongRunningOperation
-
Get the status of the
KeyVaultLongRunningOperation
. - getStatusDetails() - Method in class com.azure.security.keyvault.administration.models.KeyVaultLongRunningOperation
-
Get the status details of the
KeyVaultLongRunningOperation
. - getType() - Method in class com.azure.security.keyvault.administration.models.KeyVaultRoleAssignment
-
Get the
role assignment
type. - getType() - Method in class com.azure.security.keyvault.administration.models.KeyVaultRoleDefinition
-
Get the
role definition type
. - getType() - Method in class com.azure.security.keyvault.administration.models.KeyVaultSetting
-
Get the type of the
KeyVaultSetting
's value. - getValue() - Method in exception com.azure.security.keyvault.administration.models.KeyVaultAdministrationException
- getValue() - Method in class com.azure.security.keyvault.administration.models.KeyVaultListSettingsResult
-
Get the list of
settings
for the account. - getVaultUrl() - Method in class com.azure.security.keyvault.administration.KeyVaultAccessControlAsyncClient
-
Gets the URL for the Key Vault this client is associated with.
- getVaultUrl() - Method in class com.azure.security.keyvault.administration.KeyVaultAccessControlClient
-
Gets the URL for the Key Vault this client is associated with.
- getVaultUrl() - Method in class com.azure.security.keyvault.administration.KeyVaultBackupAsyncClient
-
Gets the URL for the Key Vault this client is associated with.
- getVaultUrl() - Method in class com.azure.security.keyvault.administration.KeyVaultBackupClient
-
Get the vault endpoint URL.
- getVersion() - Method in enum com.azure.security.keyvault.administration.KeyVaultAdministrationServiceVersion
- GLOBAL - Static variable in class com.azure.security.keyvault.administration.models.KeyVaultRoleScope
-
Global role scope.
H
- httpClient(HttpClient) - Method in class com.azure.security.keyvault.administration.KeyVaultAccessControlClientBuilder
-
Sets the
HttpClient
to use for sending and receiving requests to and from the service. - httpClient(HttpClient) - Method in class com.azure.security.keyvault.administration.KeyVaultBackupClientBuilder
-
Sets the
HttpClient
to use for sending and receiving requests to and from the service. - httpClient(HttpClient) - Method in class com.azure.security.keyvault.administration.KeyVaultSettingsClientBuilder
-
Sets the
HttpClient
to use for sending and receiving requests to and from the service. - httpLogOptions(HttpLogOptions) - Method in class com.azure.security.keyvault.administration.KeyVaultAccessControlClientBuilder
-
Sets the
logging configuration
to use when sending and receiving requests to and from the service. - httpLogOptions(HttpLogOptions) - Method in class com.azure.security.keyvault.administration.KeyVaultBackupClientBuilder
-
Sets the
logging configuration
to use when sending and receiving requests to and from the service. - httpLogOptions(HttpLogOptions) - Method in class com.azure.security.keyvault.administration.KeyVaultSettingsClientBuilder
-
Sets the
logging configuration
to use when sending and receiving requests to and from the service.
I
- IMPORT_HSM_KEY - Static variable in class com.azure.security.keyvault.administration.models.KeyVaultDataAction
-
Static value Microsoft.KeyVault/managedHsm/keys/import/action for
KeyVaultDataAction
.
K
- KEYS - Static variable in class com.azure.security.keyvault.administration.models.KeyVaultRoleScope
-
Keys role scope.
- KeyVaultAccessControlAsyncClient - Class in com.azure.security.keyvault.administration
-
The
KeyVaultAccessControlAsyncClient
provides asynchronous methods to view and manage Role Based Access for the Azure Key Vault. - KeyVaultAccessControlClient - Class in com.azure.security.keyvault.administration
-
The
KeyVaultAccessControlClient
provides synchronous methods to view and manage Role Based Access for the Azure Key Vault. - KeyVaultAccessControlClientBuilder - Class in com.azure.security.keyvault.administration
-
This class provides a fluent builder API to help aid the configuration and instantiation of the
KeyVaultAccessControlAsyncClient
andKeyVaultAccessControlClient
, by callingKeyVaultAccessControlClientBuilder.buildAsyncClient()
andKeyVaultAccessControlClientBuilder.buildClient()
respectively. - KeyVaultAccessControlClientBuilder() - Constructor for class com.azure.security.keyvault.administration.KeyVaultAccessControlClientBuilder
-
Creates a
KeyVaultAccessControlClientBuilder
instance that is able to configure and construct instances ofKeyVaultAccessControlClient
andKeyVaultAccessControlAsyncClient
. - KeyVaultAdministrationError - Class in com.azure.security.keyvault.administration.models
-
A class that represents an error occurred in a Key Vault operation.
- KeyVaultAdministrationError(String, String, KeyVaultAdministrationError) - Constructor for class com.azure.security.keyvault.administration.models.KeyVaultAdministrationError
-
Creates an object that represents an error occurred in a Key Vault operation.
- KeyVaultAdministrationException - Exception in com.azure.security.keyvault.administration.models
-
Exception thrown for an invalid response with
KeyVaultAdministrationError
information. - KeyVaultAdministrationException(String, HttpResponse) - Constructor for exception com.azure.security.keyvault.administration.models.KeyVaultAdministrationException
-
Creates a new instance of the
KeyVaultAdministrationException
class. - KeyVaultAdministrationException(String, HttpResponse, KeyVaultAdministrationError) - Constructor for exception com.azure.security.keyvault.administration.models.KeyVaultAdministrationException
-
Creates a new instance of
KeyVaultAdministrationException
. - KeyVaultAdministrationServiceVersion - Enum in com.azure.security.keyvault.administration
-
The versions of Azure Key Vault Administration service supported by this client library.
- KeyVaultBackupAsyncClient - Class in com.azure.security.keyvault.administration
-
The
KeyVaultBackupAsyncClient
provides asynchronous methods to perform full backup and restore of an Azure Key Vault. - KeyVaultBackupClient - Class in com.azure.security.keyvault.administration
-
The
KeyVaultBackupClient
provides synchronous methods to perform backup and restore operations of an Azure Key Vault. - KeyVaultBackupClientBuilder - Class in com.azure.security.keyvault.administration
-
This class provides a fluent builder API to help aid the configuration and instantiation of the
KeyVaultBackupAsyncClient
andKeyVaultBackupClient
, by callingKeyVaultBackupClientBuilder.buildAsyncClient()
andKeyVaultBackupClientBuilder.buildClient()
respectively. - KeyVaultBackupClientBuilder() - Constructor for class com.azure.security.keyvault.administration.KeyVaultBackupClientBuilder
-
Creates a
KeyVaultBackupClientBuilder
instance that is able to configure and construct instances ofKeyVaultBackupClient
andKeyVaultBackupAsyncClient
. - KeyVaultBackupOperation - Class in com.azure.security.keyvault.administration.models
-
A class that contains the details of a backup operation.
- KeyVaultBackupOperation(String, String, KeyVaultAdministrationError, String, OffsetDateTime, OffsetDateTime, String) - Constructor for class com.azure.security.keyvault.administration.models.KeyVaultBackupOperation
-
Creates an object containing the details of a
KeyVaultBackupOperation
. - KeyVaultDataAction - Class in com.azure.security.keyvault.administration.models
-
Defines values for
KeyVaultDataAction
. - KeyVaultDataAction() - Constructor for class com.azure.security.keyvault.administration.models.KeyVaultDataAction
- KeyVaultListSettingsResult - Class in com.azure.security.keyvault.administration.models
-
A result model containing the list of
settings
for a given account. - KeyVaultListSettingsResult(List<KeyVaultSetting>) - Constructor for class com.azure.security.keyvault.administration.models.KeyVaultListSettingsResult
-
Creates an instance of
KeyVaultListSettingsResult
class. - KeyVaultLongRunningOperation - Class in com.azure.security.keyvault.administration.models
-
A class that contains the details of a long running operation.
- KeyVaultLongRunningOperation(String, String, KeyVaultAdministrationError, String, OffsetDateTime, OffsetDateTime) - Constructor for class com.azure.security.keyvault.administration.models.KeyVaultLongRunningOperation
-
Creates an object containing the details of a
KeyVaultLongRunningOperation
. - KeyVaultPermission - Class in com.azure.security.keyvault.administration.models
-
A class describing allowed and forbidden actions and data actions of a
KeyVaultRoleDefinition
. - KeyVaultPermission(List<String>, List<String>, List<KeyVaultDataAction>, List<KeyVaultDataAction>) - Constructor for class com.azure.security.keyvault.administration.models.KeyVaultPermission
-
Creates a new
KeyVaultPermission
with the specified allowed and forbidden actions and data actions. - KeyVaultRestoreOperation - Class in com.azure.security.keyvault.administration.models
-
A class that contains the details of a restore operation.
- KeyVaultRestoreOperation(String, String, KeyVaultAdministrationError, String, OffsetDateTime, OffsetDateTime) - Constructor for class com.azure.security.keyvault.administration.models.KeyVaultRestoreOperation
-
Creates an object containing the details of a
KeyVaultRestoreOperation
. - KeyVaultRestoreResult - Class in com.azure.security.keyvault.administration.models
-
A class that represents the result of a Restore operation.
- KeyVaultRestoreResult() - Constructor for class com.azure.security.keyvault.administration.models.KeyVaultRestoreResult
- KeyVaultRoleAssignment - Class in com.azure.security.keyvault.administration.models
-
A class that defines a role assignment.
- KeyVaultRoleAssignment(String, String, String, KeyVaultRoleAssignmentProperties) - Constructor for class com.azure.security.keyvault.administration.models.KeyVaultRoleAssignment
-
Creates a new
role assignment
with the specified details. - KeyVaultRoleAssignmentProperties - Class in com.azure.security.keyvault.administration.models
-
A class that defines a role assignment's properties.
- KeyVaultRoleAssignmentProperties(String, String, KeyVaultRoleScope) - Constructor for class com.azure.security.keyvault.administration.models.KeyVaultRoleAssignmentProperties
-
Creates a new
role assignment properties
object with the specified details. - KeyVaultRoleDefinition - Class in com.azure.security.keyvault.administration.models
-
A class that defines a role.
- KeyVaultRoleDefinition(String, String, KeyVaultRoleDefinitionType, String, String, KeyVaultRoleType, List<KeyVaultPermission>, List<KeyVaultRoleScope>) - Constructor for class com.azure.security.keyvault.administration.models.KeyVaultRoleDefinition
-
Creates a new
role definition
with the specified details. - KeyVaultRoleDefinitionType - Class in com.azure.security.keyvault.administration.models
-
Defines values for
KeyVaultRoleDefinitionType
. - KeyVaultRoleDefinitionType() - Constructor for class com.azure.security.keyvault.administration.models.KeyVaultRoleDefinitionType
- KeyVaultRoleScope - Class in com.azure.security.keyvault.administration.models
-
A class that defines the scope of a role.
- KeyVaultRoleScope() - Constructor for class com.azure.security.keyvault.administration.models.KeyVaultRoleScope
- KeyVaultRoleType - Class in com.azure.security.keyvault.administration.models
-
Defines values for
KeyVaultRoleType
. - KeyVaultRoleType() - Constructor for class com.azure.security.keyvault.administration.models.KeyVaultRoleType
- KeyVaultSelectiveKeyRestoreOperation - Class in com.azure.security.keyvault.administration.models
-
A class that contains the details of a selective key restore operation.
- KeyVaultSelectiveKeyRestoreOperation(String, String, KeyVaultAdministrationError, String, OffsetDateTime, OffsetDateTime) - Constructor for class com.azure.security.keyvault.administration.models.KeyVaultSelectiveKeyRestoreOperation
-
Creates an object containing the details of a
KeyVaultSelectiveKeyRestoreOperation
. - KeyVaultSelectiveKeyRestoreResult - Class in com.azure.security.keyvault.administration.models
-
A class that represents the result of a SelectiveKeyRestore operation.
- KeyVaultSelectiveKeyRestoreResult() - Constructor for class com.azure.security.keyvault.administration.models.KeyVaultSelectiveKeyRestoreResult
- KeyVaultSetting - Class in com.azure.security.keyvault.administration.models
-
The
KeyVaultSetting
model. - KeyVaultSetting(String, Boolean) - Constructor for class com.azure.security.keyvault.administration.models.KeyVaultSetting
-
Creates a new
setting
with the specified details. - KeyVaultSetting(String, String, KeyVaultSettingType) - Constructor for class com.azure.security.keyvault.administration.models.KeyVaultSetting
-
Creates a new
setting
with the specified details. - KeyVaultSettingsAsyncClient - Class in com.azure.security.keyvault.administration
-
The
KeyVaultSettingsAsyncClient
provides asynchronous methods to create, update, get and listsettings
for the Azure Key Vault. - KeyVaultSettingsClient - Class in com.azure.security.keyvault.administration
-
The
KeyVaultSettingsClient
provides asynchronous methods to create, update, get and listsettings
for the Azure Key Vault. - KeyVaultSettingsClientBuilder - Class in com.azure.security.keyvault.administration
-
This class provides a fluent builder API to help aid the configuration and instantiation of the
KeyVaultSettingsAsyncClient
andKeyVaultSettingsClient
, by callingbuildAsyncClient()
andbuildImplClient()
respectively. - KeyVaultSettingsClientBuilder() - Constructor for class com.azure.security.keyvault.administration.KeyVaultSettingsClientBuilder
-
Create an instance of the KeyVaultSettingsClientBuilder.
- KeyVaultSettingType - Class in com.azure.security.keyvault.administration.models
-
Defines values for
KeyVaultSettingType
. - KeyVaultSettingType() - Constructor for class com.azure.security.keyvault.administration.models.KeyVaultSettingType
L
- listRoleAssignments(KeyVaultRoleScope) - Method in class com.azure.security.keyvault.administration.KeyVaultAccessControlAsyncClient
-
Lists all
role assignments
that are applicable at the givenrole scope
and above. - listRoleAssignments(KeyVaultRoleScope) - Method in class com.azure.security.keyvault.administration.KeyVaultAccessControlClient
-
Get all
role assignments
that are applicable at the givenrole scope
and above. - listRoleAssignments(KeyVaultRoleScope, Context) - Method in class com.azure.security.keyvault.administration.KeyVaultAccessControlClient
-
Get all
role assignments
that are applicable at the givenrole scope
and above. - listRoleDefinitions(KeyVaultRoleScope) - Method in class com.azure.security.keyvault.administration.KeyVaultAccessControlAsyncClient
-
Lists all
role definitions
that are applicable at the givenrole scope
and above. - listRoleDefinitions(KeyVaultRoleScope) - Method in class com.azure.security.keyvault.administration.KeyVaultAccessControlClient
-
Get all
role definitions
that are applicable at the givenrole scope
and above. - listRoleDefinitions(KeyVaultRoleScope, Context) - Method in class com.azure.security.keyvault.administration.KeyVaultAccessControlClient
-
Get all
role definitions
that are applicable at the givenrole scope
and above. - listSettings() - Method in class com.azure.security.keyvault.administration.KeyVaultSettingsAsyncClient
-
List the account's settings.
- listSettings() - Method in class com.azure.security.keyvault.administration.KeyVaultSettingsClient
-
List the account's settings.
- listSettingsWithResponse() - Method in class com.azure.security.keyvault.administration.KeyVaultSettingsAsyncClient
-
List the account's settings.
- listSettingsWithResponse(Context) - Method in class com.azure.security.keyvault.administration.KeyVaultSettingsClient
-
List the account's settings.
M
- MICROSOFT_AUTHORIZATION_ROLE_DEFINITIONS - Static variable in class com.azure.security.keyvault.administration.models.KeyVaultRoleDefinitionType
-
Static value Microsoft.Authorization/roleDefinitions for
KeyVaultRoleDefinitionType
.
P
- pipeline(HttpPipeline) - Method in class com.azure.security.keyvault.administration.KeyVaultAccessControlClientBuilder
-
Sets the
HttpPipeline
to use for the service client. - pipeline(HttpPipeline) - Method in class com.azure.security.keyvault.administration.KeyVaultBackupClientBuilder
-
Sets the
HttpPipeline
to use for the service client. - pipeline(HttpPipeline) - Method in class com.azure.security.keyvault.administration.KeyVaultSettingsClientBuilder
-
Sets the
HttpPipeline
to use for the service client. - PURGE_DELETED_HSM_KEY - Static variable in class com.azure.security.keyvault.administration.models.KeyVaultDataAction
-
Static value Microsoft.KeyVault/managedHsm/keys/deletedKeys/delete for
KeyVaultDataAction
.
R
- RANDOM_NUMBERS_GENERATE - Static variable in class com.azure.security.keyvault.administration.models.KeyVaultDataAction
-
Static value Microsoft.KeyVault/managedHsm/rng/action for DataAction.
- READ_DELETED_HSM_KEY - Static variable in class com.azure.security.keyvault.administration.models.KeyVaultDataAction
-
Static value Microsoft.KeyVault/managedHsm/keys/deletedKeys/read/action for
KeyVaultDataAction
. - READ_HSM_BACKUP_STATUS - Static variable in class com.azure.security.keyvault.administration.models.KeyVaultDataAction
-
Static value Microsoft.KeyVault/managedHsm/backup/status/action for
KeyVaultDataAction
. - READ_HSM_KEY - Static variable in class com.azure.security.keyvault.administration.models.KeyVaultDataAction
-
Static value Microsoft.KeyVault/managedHsm/keys/read/action for
KeyVaultDataAction
. - READ_HSM_RESTORE_STATUS - Static variable in class com.azure.security.keyvault.administration.models.KeyVaultDataAction
-
Static value Microsoft.KeyVault/managedHsm/restore/status/action for
KeyVaultDataAction
. - READ_HSM_SECURITY_DOMAIN_STATUS - Static variable in class com.azure.security.keyvault.administration.models.KeyVaultDataAction
-
Static value Microsoft.KeyVault/managedHsm/securitydomain/upload/read for
KeyVaultDataAction
. - READ_HSM_SECURITY_DOMAIN_TRANSFER_KEY - Static variable in class com.azure.security.keyvault.administration.models.KeyVaultDataAction
-
Static value Microsoft.KeyVault/managedHsm/securitydomain/transferkey/read for
KeyVaultDataAction
. - READ_ROLE_DEFINITION - Static variable in class com.azure.security.keyvault.administration.models.KeyVaultDataAction
-
Static value Microsoft.KeyVault/managedHsm/roleDefinitions/read/action for
KeyVaultDataAction
. - RECOVER_DELETED_HSM_KEY - Static variable in class com.azure.security.keyvault.administration.models.KeyVaultDataAction
-
Static value Microsoft.KeyVault/managedHsm/keys/deletedKeys/recover/action for
KeyVaultDataAction
. - RELEASE_KEY - Static variable in class com.azure.security.keyvault.administration.models.KeyVaultDataAction
-
Static value Microsoft.KeyVault/managedHsm/keys/release/action for DataAction.
- RESTORE_HSM_KEYS - Static variable in class com.azure.security.keyvault.administration.models.KeyVaultDataAction
-
Static value Microsoft.KeyVault/managedHsm/keys/restore/action for
KeyVaultDataAction
. - retryOptions(RetryOptions) - Method in class com.azure.security.keyvault.administration.KeyVaultAccessControlClientBuilder
-
Sets the
RetryOptions
for all the requests made through the client. - retryOptions(RetryOptions) - Method in class com.azure.security.keyvault.administration.KeyVaultBackupClientBuilder
-
Sets the
RetryOptions
for all the requests made through the client. - retryOptions(RetryOptions) - Method in class com.azure.security.keyvault.administration.KeyVaultSettingsClientBuilder
-
Sets the
RetryOptions
for all the requests made through the client. - retryPolicy(RetryPolicy) - Method in class com.azure.security.keyvault.administration.KeyVaultAccessControlClientBuilder
-
Sets the
RetryPolicy
that is used when each request is sent. - retryPolicy(RetryPolicy) - Method in class com.azure.security.keyvault.administration.KeyVaultBackupClientBuilder
-
Sets the
RetryPolicy
that is used when each request is sent. - retryPolicy(RetryPolicy) - Method in class com.azure.security.keyvault.administration.KeyVaultSettingsClientBuilder
-
Sets the
RetryPolicy
that is used when each request is sent.
S
- serviceVersion(KeyVaultAdministrationServiceVersion) - Method in class com.azure.security.keyvault.administration.KeyVaultAccessControlClientBuilder
-
Sets the
KeyVaultAdministrationServiceVersion
that is used when making API requests. - serviceVersion(KeyVaultAdministrationServiceVersion) - Method in class com.azure.security.keyvault.administration.KeyVaultBackupClientBuilder
-
Sets the
KeyVaultAdministrationServiceVersion
that is used when making API requests. - serviceVersion(KeyVaultAdministrationServiceVersion) - Method in class com.azure.security.keyvault.administration.KeyVaultSettingsClientBuilder
-
Sets the
KeyVaultAdministrationServiceVersion
that is used when making API requests. - setAssignableScopes(List<KeyVaultRoleScope>) - Method in class com.azure.security.keyvault.administration.models.SetRoleDefinitionOptions
-
Set the
role definition
's assignable scopes. - setDescription(String) - Method in class com.azure.security.keyvault.administration.models.SetRoleDefinitionOptions
-
Set the role description.
- setPermissions(List<KeyVaultPermission>) - Method in class com.azure.security.keyvault.administration.models.SetRoleDefinitionOptions
-
Set the
role definition
'spermissions
. - setRoleDefinition(KeyVaultRoleScope) - Method in class com.azure.security.keyvault.administration.KeyVaultAccessControlAsyncClient
-
Creates or updates a
role definition
with a randomly generated name. - setRoleDefinition(KeyVaultRoleScope) - Method in class com.azure.security.keyvault.administration.KeyVaultAccessControlClient
-
Creates a
role definition
with a randomly generated name. - setRoleDefinition(KeyVaultRoleScope, String) - Method in class com.azure.security.keyvault.administration.KeyVaultAccessControlAsyncClient
-
Creates or updates a
role definition
. - setRoleDefinition(KeyVaultRoleScope, String) - Method in class com.azure.security.keyvault.administration.KeyVaultAccessControlClient
-
Creates or updates a
role definition
with a given name. - SetRoleDefinitionOptions - Class in com.azure.security.keyvault.administration.models
-
Represents the configurable options to create or update a
role definition
. - SetRoleDefinitionOptions(KeyVaultRoleScope) - Constructor for class com.azure.security.keyvault.administration.models.SetRoleDefinitionOptions
-
Creates an instance of
SetRoleDefinitionOptions
with an automatically generated name. - SetRoleDefinitionOptions(KeyVaultRoleScope, String) - Constructor for class com.azure.security.keyvault.administration.models.SetRoleDefinitionOptions
-
Creates an instance of
SetRoleDefinitionOptions
. - setRoleDefinitionWithResponse(SetRoleDefinitionOptions) - Method in class com.azure.security.keyvault.administration.KeyVaultAccessControlAsyncClient
-
Creates or updates a
role definition
. - setRoleDefinitionWithResponse(SetRoleDefinitionOptions, Context) - Method in class com.azure.security.keyvault.administration.KeyVaultAccessControlClient
-
Creates or updates a
role definition
. - setRoleName(String) - Method in class com.azure.security.keyvault.administration.models.SetRoleDefinitionOptions
-
Set the role name.
- SIGN_HSM_KEY - Static variable in class com.azure.security.keyvault.administration.models.KeyVaultDataAction
-
Static value Microsoft.KeyVault/managedHsm/keys/sign/action for
KeyVaultDataAction
. - START_HSM_BACKUP - Static variable in class com.azure.security.keyvault.administration.models.KeyVaultDataAction
-
Static value Microsoft.KeyVault/managedHsm/backup/start/action for
KeyVaultDataAction
. - START_HSM_RESTORE - Static variable in class com.azure.security.keyvault.administration.models.KeyVaultDataAction
-
Static value Microsoft.KeyVault/managedHsm/restore/start/action for
KeyVaultDataAction
.
U
- UNWRAP_HSM_KEY - Static variable in class com.azure.security.keyvault.administration.models.KeyVaultDataAction
-
Static value Microsoft.KeyVault/managedHsm/keys/unwrap/action for
KeyVaultDataAction
. - updateSetting(KeyVaultSetting) - Method in class com.azure.security.keyvault.administration.KeyVaultSettingsAsyncClient
-
Updates a given
account setting
. - updateSetting(KeyVaultSetting) - Method in class com.azure.security.keyvault.administration.KeyVaultSettingsClient
-
Updates a given
account setting
. - updateSettingWithResponse(KeyVaultSetting) - Method in class com.azure.security.keyvault.administration.KeyVaultSettingsAsyncClient
-
Updates a given
account setting
. - updateSettingWithResponse(KeyVaultSetting, Context) - Method in class com.azure.security.keyvault.administration.KeyVaultSettingsClient
-
Updates a given
account setting
. - UPLOAD_HSM_SECURITY_DOMAIN - Static variable in class com.azure.security.keyvault.administration.models.KeyVaultDataAction
-
Static value Microsoft.KeyVault/managedHsm/securitydomain/upload/action for
KeyVaultDataAction
.
V
- V7_2 - Enum constant in enum com.azure.security.keyvault.administration.KeyVaultAdministrationServiceVersion
-
Service version
7.2
. - V7_3 - Enum constant in enum com.azure.security.keyvault.administration.KeyVaultAdministrationServiceVersion
-
Service version
7.3
. - V7_4_PREVIEW_1 - Enum constant in enum com.azure.security.keyvault.administration.KeyVaultAdministrationServiceVersion
-
Service version
7.3
. - valueOf(String) - Static method in enum com.azure.security.keyvault.administration.KeyVaultAdministrationServiceVersion
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum com.azure.security.keyvault.administration.KeyVaultAdministrationServiceVersion
-
Returns an array containing the constants of this enum type, in the order they are declared.
- vaultUrl(String) - Method in class com.azure.security.keyvault.administration.KeyVaultAccessControlClientBuilder
-
Sets the URL to the Key Vault on which the client operates.
- vaultUrl(String) - Method in class com.azure.security.keyvault.administration.KeyVaultBackupClientBuilder
-
Sets the URL to the Key Vault on which the client operates.
- vaultUrl(String) - Method in class com.azure.security.keyvault.administration.KeyVaultSettingsClientBuilder
-
Sets the URL to the Key Vault on which the client operates.
- VERIFY_HSM_KEY - Static variable in class com.azure.security.keyvault.administration.models.KeyVaultDataAction
-
Static value Microsoft.KeyVault/managedHsm/keys/verify/action for
KeyVaultDataAction
.
W
- WRAP_HSM_KEY - Static variable in class com.azure.security.keyvault.administration.models.KeyVaultDataAction
-
Static value Microsoft.KeyVault/managedHsm/keys/wrap/action for
KeyVaultDataAction
. - WRITE_HSM_KEY - Static variable in class com.azure.security.keyvault.administration.models.KeyVaultDataAction
-
Static value Microsoft.KeyVault/managedHsm/keys/write/action for
KeyVaultDataAction
. - WRITE_ROLE_ASSIGNMENT - Static variable in class com.azure.security.keyvault.administration.models.KeyVaultDataAction
-
Static value Microsoft.KeyVault/managedHsm/roleAssignments/write/action for
KeyVaultDataAction
. - WRITE_ROLE_DEFINITION - Static variable in class com.azure.security.keyvault.administration.models.KeyVaultDataAction
-
Static value Microsoft.KeyVault/managedHsm/roleDefinitions/write/action for DataAction.
All Classes and Interfaces|All Packages|Serialized Form