Index (Azure SDK for Java Reference Documentation)

A B C D E F G H I K L N P R S T U V
All Classes and Interfaces|All Packages

A

Additional documentation - Search tag in Overview: Section
addPolicy(HttpPipelinePolicy) - Method in class com.azure.security.keyvault.secrets.SecretClientBuilder: Adds a pipeline policy to apply on each request sent.
Async API - Search tag in Overview: Section
Authenticate the client - Search tag in Overview: Section
Azure Key Vault Secret client library for Java - Search tag in Overview: Section

B

backupSecret(String) - Method in class com.azure.security.keyvault.secrets.SecretAsyncClient: Requests a backup of the secret be downloaded to the client.
backupSecret(String) - Method in class com.azure.security.keyvault.secrets.SecretClient: Requests a backup of the secret be downloaded to the client.
backupSecretWithResponse(String) - Method in class com.azure.security.keyvault.secrets.SecretAsyncClient: Requests a backup of the secret be downloaded to the client.
backupSecretWithResponse(String, Context) - Method in class com.azure.security.keyvault.secrets.SecretClient: Requests a backup of the secret be downloaded to the client.
beginDeleteSecret(String) - Method in class com.azure.security.keyvault.secrets.SecretAsyncClient: Deletes a secret from the key vault.
beginDeleteSecret(String) - Method in class com.azure.security.keyvault.secrets.SecretClient: Deletes a secret from the key vault.
beginRecoverDeletedSecret(String) - Method in class com.azure.security.keyvault.secrets.SecretAsyncClient: Recovers the deleted secret in the key vault to its latest version.
beginRecoverDeletedSecret(String) - Method in class com.azure.security.keyvault.secrets.SecretClient: Recovers the deleted secret in the key vault to its latest version.
buildAsyncClient() - Method in class com.azure.security.keyvault.secrets.SecretClientBuilder: Creates a SecretAsyncClient based on options set in the builder.
buildClient() - Method in class com.azure.security.keyvault.secrets.SecretClientBuilder: Creates a SecretClient based on options set in the builder.

C

clientOptions(ClientOptions) - Method in class com.azure.security.keyvault.secrets.SecretClientBuilder: Allows for setting common properties such as application ID, headers, proxy configuration, etc.
com.azure.security.keyvault.secrets - package com.azure.security.keyvault.secrets: Azure Key Vault is a cloud-based service provided by Microsoft Azure that allows users to store, manage, and access secrets, such as passwords, certificates, and other sensitive information, securely in the cloud.
com.azure.security.keyvault.secrets.models - package com.azure.security.keyvault.secrets.models: Package containing classes used for representing secrets, deleted secrets and their attributes in Azure Key Vault.
configuration(Configuration) - Method in class com.azure.security.keyvault.secrets.SecretClientBuilder: Sets the configuration store that is used during construction of the service client.
Contributing - Search tag in Overview: Section
Create a secret - Search tag in Overview: Section
Create a Secret - Search tag in class com.azure.security.keyvault.secrets.SecretAsyncClient: Section
Create a Secret - Search tag in class com.azure.security.keyvault.secrets.SecretClient: Section
Create a Secret - Search tag in package com.azure.security.keyvault.secrets: Section
Create a secret asynchronously - Search tag in Overview: Section
Create secret client - Search tag in Overview: Section
credential(TokenCredential) - Method in class com.azure.security.keyvault.secrets.SecretClientBuilder: Sets the TokenCredential used to authorize requests sent to the service.

D

Default HTTP Client - Search tag in Overview: Section
Default SSL library - Search tag in Overview: Section
Delete a secret - Search tag in Overview: Section
Delete a Secret - Search tag in class com.azure.security.keyvault.secrets.SecretAsyncClient: Section
Delete a Secret - Search tag in class com.azure.security.keyvault.secrets.SecretClient: Section
Delete a Secret - Search tag in package com.azure.security.keyvault.secrets: Section
Delete a secret asynchronously - Search tag in Overview: Section
DeletedSecret - Class in com.azure.security.keyvault.secrets.models: Deleted Secret is the resource consisting of name, recovery id, deleted date, scheduled purge date and its attributes inherited from KeyVaultSecret.
DeletedSecret() - Constructor for class com.azure.security.keyvault.secrets.models.DeletedSecret: Creates a new instance of DeletedSecret.
disableChallengeResourceVerification() - Method in class com.azure.security.keyvault.secrets.SecretClientBuilder: Disables verifying if the authentication challenge resource matches the Key Vault domain.

E

Examples - Search tag in Overview: Section

F

fromJson(JsonReader) - Static method in class com.azure.security.keyvault.secrets.models.DeletedSecret: Reads an instance of DeletedSecret from the JsonReader.
fromJson(JsonReader) - Static method in class com.azure.security.keyvault.secrets.models.KeyVaultSecret: Reads an instance of KeyVaultSecret from the JsonReader.
fromJson(JsonReader) - Static method in class com.azure.security.keyvault.secrets.models.SecretProperties: Reads a JSON stream into a SecretProperties.

G

General - Search tag in Overview: Section
Get a Secret - Search tag in class com.azure.security.keyvault.secrets.SecretAsyncClient: Section
Get a Secret - Search tag in class com.azure.security.keyvault.secrets.SecretClient: Section
Get a Secret - Search tag in package com.azure.security.keyvault.secrets: Section
getContentType() - Method in class com.azure.security.keyvault.secrets.models.SecretProperties: Get the content type.
getCreatedOn() - Method in class com.azure.security.keyvault.secrets.models.SecretProperties: Get the the UTC time at which secret was created.
getDeletedOn() - Method in class com.azure.security.keyvault.secrets.models.DeletedSecret: Get the deleted UTC time.
getDeletedSecret(String) - Method in class com.azure.security.keyvault.secrets.SecretAsyncClient: Gets a secret that has been deleted for a soft-delete enabled key vault.
getDeletedSecret(String) - Method in class com.azure.security.keyvault.secrets.SecretClient: Gets a secret that has been deleted for a soft-delete enabled key vault.
getDeletedSecretWithResponse(String) - Method in class com.azure.security.keyvault.secrets.SecretAsyncClient: Gets a secret that has been deleted for a soft-delete enabled key vault.
getDeletedSecretWithResponse(String, Context) - Method in class com.azure.security.keyvault.secrets.SecretClient: Gets a secret that has been deleted for a soft-delete enabled key vault.
getExpiresOn() - Method in class com.azure.security.keyvault.secrets.models.SecretProperties: Get the Secret Expiry time in UTC.
getId() - Method in class com.azure.security.keyvault.secrets.models.KeyVaultSecret: Get the secret identifier.
getId() - Method in class com.azure.security.keyvault.secrets.models.SecretProperties: Get the secret identifier.
getKeyId() - Method in class com.azure.security.keyvault.secrets.models.SecretProperties: Get the keyId identifier.
getLatest() - Static method in enum com.azure.security.keyvault.secrets.SecretServiceVersion: Gets the latest service version supported by this client library
getName() - Method in class com.azure.security.keyvault.secrets.models.KeyVaultSecret: Get the secret name.
getName() - Method in class com.azure.security.keyvault.secrets.models.KeyVaultSecretIdentifier: Gets the name of the secret.
getName() - Method in class com.azure.security.keyvault.secrets.models.SecretProperties: Get the secret name.
getNotBefore() - Method in class com.azure.security.keyvault.secrets.models.SecretProperties: Get the notBefore UTC time.
getProperties() - Method in class com.azure.security.keyvault.secrets.models.KeyVaultSecret: Get the secret properties
getRecoverableDays() - Method in class com.azure.security.keyvault.secrets.models.SecretProperties: Gets the number of days a secret is retained before being deleted for a soft delete-enabled Key Vault.
getRecoveryId() - Method in class com.azure.security.keyvault.secrets.models.DeletedSecret: Get the recoveryId identifier.
getRecoveryLevel() - Method in class com.azure.security.keyvault.secrets.models.SecretProperties: Get the recovery level of the secret.
getScheduledPurgeDate() - Method in class com.azure.security.keyvault.secrets.models.DeletedSecret: Get the scheduled purge UTC time.
getSecret(String) - Method in class com.azure.security.keyvault.secrets.SecretAsyncClient: Gets the latest version of the specified secret from the key vault.
getSecret(String) - Method in class com.azure.security.keyvault.secrets.SecretClient: Gets the latest version of the specified secret from the key vault.
getSecret(String, String) - Method in class com.azure.security.keyvault.secrets.SecretAsyncClient: Gets the specified secret with specified version from the key vault.
getSecret(String, String) - Method in class com.azure.security.keyvault.secrets.SecretClient: Gets the specified secret with specified version from the key vault.
getSecretWithResponse(String, String) - Method in class com.azure.security.keyvault.secrets.SecretAsyncClient: Gets the specified secret with specified version from the key vault.
getSecretWithResponse(String, String, Context) - Method in class com.azure.security.keyvault.secrets.SecretClient: Gets the specified secret with specified version from the key vault.
getSourceId() - Method in class com.azure.security.keyvault.secrets.models.KeyVaultSecretIdentifier: Gets the key identifier used to create this object
getTags() - Method in class com.azure.security.keyvault.secrets.models.SecretProperties: Get the tags associated with the secret.
Getting started - Search tag in Overview: Section
Getting Started - Search tag in class com.azure.security.keyvault.secrets.SecretAsyncClient: Section
Getting Started - Search tag in class com.azure.security.keyvault.secrets.SecretClient: Section
Getting Started - Search tag in package com.azure.security.keyvault.secrets: Section
getUpdatedOn() - Method in class com.azure.security.keyvault.secrets.models.SecretProperties: Get the UTC time at which secret was last updated.
getValue() - Method in class com.azure.security.keyvault.secrets.models.KeyVaultSecret: Get the value of the secret.
getVaultUrl() - Method in class com.azure.security.keyvault.secrets.models.KeyVaultSecretIdentifier: Gets the URL of the Key Vault.
getVaultUrl() - Method in class com.azure.security.keyvault.secrets.SecretAsyncClient: Gets the vault endpoint url to which service requests are sent to.
getVaultUrl() - Method in class com.azure.security.keyvault.secrets.SecretClient: Gets the vault endpoint url to which service requests are sent to.
getVersion() - Method in class com.azure.security.keyvault.secrets.models.KeyVaultSecretIdentifier: Gets the optional version of the secret.
getVersion() - Method in class com.azure.security.keyvault.secrets.models.SecretProperties: Get the version of the secret.
getVersion() - Method in enum com.azure.security.keyvault.secrets.SecretServiceVersion

H

httpClient(HttpClient) - Method in class com.azure.security.keyvault.secrets.SecretClientBuilder: Sets the HttpClient to use for sending and receiving requests to and from the service.
httpLogOptions(HttpLogOptions) - Method in class com.azure.security.keyvault.secrets.SecretClientBuilder: Sets the logging configuration to use when sending and receiving requests to and from the service.

I

Include direct dependency - Search tag in Overview: Section
Include the BOM file - Search tag in Overview: Section
Include the package - Search tag in Overview: Section
isEnabled() - Method in class com.azure.security.keyvault.secrets.models.SecretProperties: Get the enabled value.
isManaged() - Method in class com.azure.security.keyvault.secrets.models.SecretProperties: Get the managed value.

K

Key concepts - Search tag in Overview: Section
KeyVaultSecret - Class in com.azure.security.keyvault.secrets.models: Secret is the resource consisting of name, value and its attributes specified in SecretProperties.
KeyVaultSecret(String, String) - Constructor for class com.azure.security.keyvault.secrets.models.KeyVaultSecret: Creates a Secret with name and value.
KeyVaultSecretIdentifier - Class in com.azure.security.keyvault.secrets.models: Information about a KeyVaultSecret parsed from the secret URL.
KeyVaultSecretIdentifier(String) - Constructor for class com.azure.security.keyvault.secrets.models.KeyVaultSecretIdentifier: Create a new KeyVaultSecretIdentifier from a given Key Vault identifier.

L

listDeletedSecrets() - Method in class com.azure.security.keyvault.secrets.SecretAsyncClient: Lists deleted secrets of the key vault if it has enabled soft-delete.
listDeletedSecrets() - Method in class com.azure.security.keyvault.secrets.SecretClient: Lists deleted secrets of the key vault if it has enabled soft-delete.
listDeletedSecrets(Context) - Method in class com.azure.security.keyvault.secrets.SecretClient: Lists deleted secrets of the key vault if it has enabled soft-delete.
listPropertiesOfSecrets() - Method in class com.azure.security.keyvault.secrets.SecretAsyncClient: Lists secrets in the key vault.
listPropertiesOfSecrets() - Method in class com.azure.security.keyvault.secrets.SecretClient: Lists secrets in the key vault.
listPropertiesOfSecrets(Context) - Method in class com.azure.security.keyvault.secrets.SecretClient: Lists secrets in the key vault.
listPropertiesOfSecretVersions(String) - Method in class com.azure.security.keyvault.secrets.SecretAsyncClient: Lists all versions of the specified secret.
listPropertiesOfSecretVersions(String) - Method in class com.azure.security.keyvault.secrets.SecretClient: Lists all versions of the specified secret.
listPropertiesOfSecretVersions(String, Context) - Method in class com.azure.security.keyvault.secrets.SecretClient: Lists all versions of the specified secret.
List secrets - Search tag in Overview: Section
List secrets asynchronously - Search tag in Overview: Section

N

Next steps - Search tag in Overview: Section
Next steps samples - Search tag in Overview: Section

P

pipeline(HttpPipeline) - Method in class com.azure.security.keyvault.secrets.SecretClientBuilder: Sets the HttpPipeline to use for the service client.
Prerequisites - Search tag in Overview: Section
purgeDeletedSecret(String) - Method in class com.azure.security.keyvault.secrets.SecretAsyncClient: Permanently removes a deleted secret, without the possibility of recovery.
purgeDeletedSecret(String) - Method in class com.azure.security.keyvault.secrets.SecretClient: Permanently removes a deleted secret, without the possibility of recovery.
purgeDeletedSecretWithResponse(String) - Method in class com.azure.security.keyvault.secrets.SecretAsyncClient: Permanently removes a deleted secret, without the possibility of recovery.
purgeDeletedSecretWithResponse(String, Context) - Method in class com.azure.security.keyvault.secrets.SecretClient: Permanently removes a deleted secret, without the possibility of recovery.

R

restoreSecretBackup(byte[]) - Method in class com.azure.security.keyvault.secrets.SecretAsyncClient: Restores a backed up secret, and all its versions, to a vault.
restoreSecretBackup(byte[]) - Method in class com.azure.security.keyvault.secrets.SecretClient: Restores a backed up secret, and all its versions, to a vault.
restoreSecretBackupWithResponse(byte[]) - Method in class com.azure.security.keyvault.secrets.SecretAsyncClient: Restores a backed up secret, and all its versions, to a vault.
restoreSecretBackupWithResponse(byte[], Context) - Method in class com.azure.security.keyvault.secrets.SecretClient: Restores a backed up secret, and all its versions, to a vault.
Retrieve a secret - Search tag in Overview: Section
Retrieve a secret asynchronously - Search tag in Overview: Section
retryOptions(RetryOptions) - Method in class com.azure.security.keyvault.secrets.SecretClientBuilder: Sets the RetryOptions for all the requests made through the client.
retryPolicy(RetryPolicy) - Method in class com.azure.security.keyvault.secrets.SecretClientBuilder: Sets the RetryPolicy that is used when each request is sent.

S

Secret - Search tag in Overview: Section
SecretAsyncClient - Class in com.azure.security.keyvault.secrets: The SecretAsyncClient provides asynchronous methods to manage secrets in the Azure Key Vault.
SecretClient - Class in com.azure.security.keyvault.secrets: The SecretClient provides synchronous methods to manage secrets in the Azure Key Vault.
Secret client: - Search tag in Overview: Section
SecretClientBuilder - Class in com.azure.security.keyvault.secrets: This class provides a fluent builder API to help aid the configuration and instantiation of the secret async client and secret client, by calling buildAsyncClient and buildClient respectively.
SecretClientBuilder() - Constructor for class com.azure.security.keyvault.secrets.SecretClientBuilder: The constructor with defaults.
SecretProperties - Class in com.azure.security.keyvault.secrets.models: SecretProperties is the resource containing all the properties of the secret except its value.
SecretProperties() - Constructor for class com.azure.security.keyvault.secrets.models.SecretProperties: Creates empty instance of SecretProperties.
SecretServiceVersion - Enum in com.azure.security.keyvault.secrets: The versions of Azure Key Vault Secret supported by this client library.
serviceVersion(SecretServiceVersion) - Method in class com.azure.security.keyvault.secrets.SecretClientBuilder: Sets the SecretServiceVersion that is used when making API requests.
setContentType(String) - Method in class com.azure.security.keyvault.secrets.models.SecretProperties: Set the contentType.
setEnabled(Boolean) - Method in class com.azure.security.keyvault.secrets.models.SecretProperties: Set the enabled value.
setExpiresOn(OffsetDateTime) - Method in class com.azure.security.keyvault.secrets.models.SecretProperties: Set the expires UTC time.
setNotBefore(OffsetDateTime) - Method in class com.azure.security.keyvault.secrets.models.SecretProperties: Set the notBefore UTC time.
setProperties(SecretProperties) - Method in class com.azure.security.keyvault.secrets.models.KeyVaultSecret: Set the secret properties
setSecret(KeyVaultSecret) - Method in class com.azure.security.keyvault.secrets.SecretAsyncClient: Adds a secret to the key vault if it does not exist.
setSecret(KeyVaultSecret) - Method in class com.azure.security.keyvault.secrets.SecretClient: Adds a secret to the key vault if it does not exist.
setSecret(String, String) - Method in class com.azure.security.keyvault.secrets.SecretAsyncClient: Adds a secret to the key vault if it does not exist.
setSecret(String, String) - Method in class com.azure.security.keyvault.secrets.SecretClient: Adds a secret to the key vault if it does not exist.
setSecretWithResponse(KeyVaultSecret) - Method in class com.azure.security.keyvault.secrets.SecretAsyncClient: Adds a secret to the key vault if it does not exist.
setSecretWithResponse(KeyVaultSecret, Context) - Method in class com.azure.security.keyvault.secrets.SecretClient: Adds a secret to the key vault if it does not exist.
setTags(Map<String, String>) - Method in class com.azure.security.keyvault.secrets.models.SecretProperties: Set the tags to be associated with the secret.
Sync API - Search tag in Overview: Section

T

toJson(JsonWriter) - Method in class com.azure.security.keyvault.secrets.models.DeletedSecret
toJson(JsonWriter) - Method in class com.azure.security.keyvault.secrets.models.KeyVaultSecret
toJson(JsonWriter) - Method in class com.azure.security.keyvault.secrets.models.SecretProperties
Troubleshooting - Search tag in Overview: Section

U

Update an existing secret - Search tag in Overview: Section
Update an existing secret asynchronously - Search tag in Overview: Section
updateSecretProperties(SecretProperties) - Method in class com.azure.security.keyvault.secrets.SecretAsyncClient: Updates the attributes associated with the secret.
updateSecretProperties(SecretProperties) - Method in class com.azure.security.keyvault.secrets.SecretClient: Updates the attributes associated with the secret.
updateSecretPropertiesWithResponse(SecretProperties) - Method in class com.azure.security.keyvault.secrets.SecretAsyncClient: Updates the attributes associated with the secret.
updateSecretPropertiesWithResponse(SecretProperties, Context) - Method in class com.azure.security.keyvault.secrets.SecretClient: Updates the attributes associated with the secret.

V

V7_0 - Enum constant in enum com.azure.security.keyvault.secrets.SecretServiceVersion: Service version 7.0.
V7_1 - Enum constant in enum com.azure.security.keyvault.secrets.SecretServiceVersion: Service version 7.1.
V7_2 - Enum constant in enum com.azure.security.keyvault.secrets.SecretServiceVersion: Service version 7.2.
V7_3 - Enum constant in enum com.azure.security.keyvault.secrets.SecretServiceVersion: Service version 7.3.
V7_4 - Enum constant in enum com.azure.security.keyvault.secrets.SecretServiceVersion: Service version 7.4.
V7_5 - Enum constant in enum com.azure.security.keyvault.secrets.SecretServiceVersion: Service version 7.5.
valueOf(String) - Static method in enum com.azure.security.keyvault.secrets.SecretServiceVersion: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.azure.security.keyvault.secrets.SecretServiceVersion: 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.secrets.SecretClientBuilder: Sets the vault endpoint URL to send HTTP requests to.

A B C D E F G H I K L N P R S T U V
All Classes and Interfaces|All Packages