SecretAsyncClient Klasse

Referenz

Paket:: com.azure.security.keyvault.secrets

Maven-Artefakt:: com.azure:azure-security-keyvault-secrets:4.8.3

java.lang.Object
- com.azure.security.keyvault.secrets.SecretAsyncClient

public final class SecretAsyncClient

SecretAsyncClient stellt asynchrone Methoden zur Verwaltung KeyVaultSecret im Azure-Key Vault bereit. Der Client unterstützt das Erstellen, Abrufen, Aktualisieren, Löschen, Löschen, Sichern, Wiederherstellen und Auflisten von KeyVaultSecret. Der Client unterstützt auch die Auflistung DeletedSecret eines Schlüsseltresors mit vorläufigem Löschen.

Erste Schritte

Um mit dem Azure Key Vault-Dienst interagieren zu können, müssen Sie eine instance der SecretAsyncClient Klasse, eine Tresor-URL und ein Anmeldeinformationsobjekt erstellen.

Die in diesem Dokument gezeigten Beispiele verwenden ein Anmeldeinformationsobjekt namens DefaultAzureCredential für die Authentifizierung, das für die meisten Szenarien geeignet ist, einschließlich lokaler Entwicklungs- und Produktionsumgebungen. Darüber hinaus wird die Verwendung einer verwalteten Identität für die Authentifizierung in Produktionsumgebungen empfohlen. Weitere Informationen zu verschiedenen Authentifizierungsmethoden und den entsprechenden Anmeldeinformationstypen finden Sie in der Azure Identity-Dokumentation.

Beispiel: Erstellen eines asynchronen geheimen Clients

SecretAsyncClient secretAsyncClient = new SecretClientBuilder()
     .credential(new DefaultAzureCredentialBuilder().build())
     .vaultUrl("<your-key-vault-url>")
     .buildAsyncClient();

Erstellen eines Geheimnisses

Kann SecretAsyncClient verwendet werden, um ein Geheimnis im Schlüsseltresor zu erstellen.

Codebeispiel:

Im folgenden Codebeispiel wird veranschaulicht, wie sie mithilfe der setSecret(String name, String value) API ein Geheimnis im Schlüsseltresor erstellen und speichern.

secretAsyncClient.setSecret("secretName", "secretValue")
     .subscribe(secretResponse ->
         System.out.printf("Secret is created with name %s and value %s%n",
             secretResponse.getName(), secretResponse.getValue()));

Hinweis: Das synchrone Beispiel finden Sie unter SecretClient.

Abrufen eines Geheimnisses

Die SecretAsyncClient kann verwendet werden, um ein Geheimnis aus dem Schlüsseltresor abzurufen.

Codebeispiel:

Im folgenden Codebeispiel wird veranschaulicht, wie ein zuvor gespeichertes Geheimnis mithilfe der getSecret(String name) API synchron aus dem Schlüsseltresor abgerufen wird.

secretAsyncClient.getSecret("secretName")
     .subscribe(secretWithVersion ->
         System.out.printf("Secret is returned with name %s and value %s %n",
             secretWithVersion.getName(), secretWithVersion.getValue()));

Hinweis: Das synchrone Beispiel finden Sie unter SecretClient.

Löschen eines Geheimnisses

Die SecretAsyncClient kann verwendet werden, um ein Geheimnis aus dem Schlüsseltresor zu löschen.

Codebeispiel:

Im folgenden Codebeispiel wird veranschaulicht, wie ein Geheimnis mithilfe der API aus dem beginDeleteSecret(String name) Schlüsseltresor gelöscht wird.

secretAsyncClient.beginDeleteSecret("secretName")
     .subscribe(pollResponse -> {
         System.out.println("Delete Status: " + pollResponse.getStatus().toString());
         System.out.println("Deleted Secret Name: " + pollResponse.getValue().getName());
         System.out.println("Deleted Secret Value: " + pollResponse.getValue().getValue());
     });

Hinweis: Das synchrone Beispiel finden Sie unter SecretClient.

Methodenzusammenfassung

Modifizierer und Typ	Methode und Beschreibung
Mono<byte[]>	backupSecret(String name) Fordert eine Sicherung des Geheimnisses auf den Client an.
Mono<Response<byte[]>>	backupSecretWithResponse(String name) Fordert eine Sicherung des Geheimnisses auf den Client an.
PollerFlux<DeletedSecret,Void>	beginDeleteSecret(String name) Löscht ein Geheimnis aus dem Schlüsseltresor.
PollerFlux<KeyVaultSecret,Void>	beginRecoverDeletedSecret(String name) Stellt das gelöschte Geheimnis im Schlüsseltresor auf die neueste Version zurück.
Mono<DeletedSecret>	getDeletedSecret(String name) Ruft ein Geheimnis ab, das für einen vorläufig gelöschten Schlüsseltresor gelöscht wurde.
Mono<Response<DeletedSecret>>	getDeletedSecretWithResponse(String name) Ruft ein Geheimnis ab, das für einen vorläufig gelöschten Schlüsseltresor gelöscht wurde.
Mono<KeyVaultSecret>	getSecret(String name) Ruft die neueste Version des angegebenen Geheimnisses aus dem Schlüsseltresor ab.
Mono<KeyVaultSecret>	getSecret(String name, String version) Ruft das angegebene Geheimnis mit der angegebenen Version aus dem Schlüsseltresor ab.
Mono<Response<KeyVaultSecret>>	getSecretWithResponse(String name, String version) Ruft das angegebene Geheimnis mit der angegebenen Version aus dem Schlüsseltresor ab.
String	getVaultUrl() Ruft die Tresorendpunkt-URL ab, an die Dienstanforderungen gesendet werden.
PagedFlux<DeletedSecret>	listDeletedSecrets() Listen DeletedSecret des Schlüsseltresors, wenn er das vorläufige Löschen aktiviert hat.
PagedFlux<SecretProperties>	listPropertiesOfSecretVersions(String name) Listet alle Versionen des angegebenen Geheimnisses auf.
PagedFlux<SecretProperties>	listPropertiesOfSecrets() Listet Geheimnisse im Schlüsseltresor auf.
Mono<Void>	purgeDeletedSecret(String name) Entfernt dauerhaft ein gelöschtes Geheimnis, ohne die Möglichkeit der Wiederherstellung.
Mono<Response<Void>>	purgeDeletedSecretWithResponse(String name) Entfernt dauerhaft ein gelöschtes Geheimnis, ohne die Möglichkeit der Wiederherstellung.
Mono<KeyVaultSecret>	restoreSecretBackup(byte[] backup) Stellt ein gesichertes Geheimnis und alle zugehörigen Versionen in einem Tresor wieder her.
Mono<Response<KeyVaultSecret>>	restoreSecretBackupWithResponse(byte[] backup) Stellt ein gesichertes Geheimnis und alle zugehörigen Versionen in einem Tresor wieder her.
Mono<KeyVaultSecret>	setSecret(KeyVaultSecret secret) Fügt dem Schlüsseltresor ein Geheimnis hinzu, wenn es nicht vorhanden ist.
Mono<KeyVaultSecret>	setSecret(String name, String value) Fügt dem Schlüsseltresor ein Geheimnis hinzu, wenn es nicht vorhanden ist.
Mono<Response<KeyVaultSecret>>	setSecretWithResponse(KeyVaultSecret secret) Fügt dem Schlüsseltresor ein Geheimnis hinzu, wenn es nicht vorhanden ist.
Mono<SecretProperties>	updateSecretProperties(SecretProperties secretProperties) Updates die Attribute, die dem Geheimnis zugeordnet sind.
Mono<Response<SecretProperties>>	updateSecretPropertiesWithResponse(SecretProperties secretProperties) Updates die Attribute, die dem Geheimnis zugeordnet sind.

Geerbte Methoden von java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Details zur Methode

backupSecret

public Mono backupSecret(String name)

Fordert eine Sicherung des Geheimnisses auf den Client an. Alle Versionen des Geheimnisses werden heruntergeladen. Für diesen Vorgang ist die secrets/backup Berechtigung erforderlich.

Codebeispiel

Sichert das Geheimnis aus dem Schlüsseltresor. Abonniert den Aufruf asynchron und gibt die Länge des Sicherungsbytearrays des Geheimnisses aus, das in der Antwort zurückgegeben wird.

secretAsyncClient.backupSecret("secretName")
     .subscribe(secretBackupResponse ->
         System.out.printf("Secret's Backup Byte array's length %s%n", secretBackupResponse.length));

Parameters:

name - Der Name des Geheimnisses.

Returns:

Eine Mono , die das gesicherte Geheimblob enthält.

backupSecretWithResponse

public Mono> backupSecretWithResponse(String name)

Fordert eine Sicherung des Geheimnisses auf den Client an. Alle Versionen des Geheimnisses werden heruntergeladen. Für diesen Vorgang ist die secrets/backup Berechtigung erforderlich.

Codebeispiel

Sichert das Geheimnis aus dem Schlüsseltresor. Abonniert den Aufruf asynchron und gibt die Länge des Sicherungsbytearrays des Geheimnisses aus, das in der Antwort zurückgegeben wird.

secretAsyncClient.backupSecretWithResponse("secretName")
     .subscribe(secretBackupResponse ->
         System.out.printf("Secret's Backup Byte array's length %s%n", secretBackupResponse.getValue().length));

Parameters:

name - Der Name des Geheimnisses.

Returns:

Ein Mono , der ein Response<T> enthält, dessen value das gesicherte Geheimblob enthält.

beginDeleteSecret

public PollerFlux beginDeleteSecret(String name)

Löscht ein Geheimnis aus dem Schlüsseltresor. Wenn vorläufiges Löschen für den Schlüsseltresor aktiviert ist, wird das Geheimnis in den Zustand gelöscht versetzt und muss für das dauerhafte Löschen gelöscht werden. Andernfalls wird das Geheimnis endgültig gelöscht. Alle Versionen eines Geheimnisses werden gelöscht. Dies kann nicht auf einzelne Versionen eines Geheimnisses angewendet werden. Für diesen Vorgang ist die secrets/delete Berechtigung erforderlich.

Codebeispiel

Löscht das Geheimnis im Azure-Key Vault. Abonniert den Aufruf asynchron und druckt die gelöschten Geheimnisdetails aus, wenn eine Antwort empfangen wird.

secretAsyncClient.beginDeleteSecret("secretName")
     .subscribe(pollResponse -> {
         System.out.println("Delete Status: " + pollResponse.getStatus().toString());
         System.out.println("Deleted Secret Name: " + pollResponse.getValue().getName());
         System.out.println("Deleted Secret Value: " + pollResponse.getValue().getValue());
     });

Parameters:

name - Der Name des zu löschenden Geheimnisses.

Returns:

Ein PollerFlux<T,U> zum Abfragen und Abrufen DeletedSecretvon .

beginRecoverDeletedSecret

public PollerFlux beginRecoverDeletedSecret(String name)

Stellt das gelöschte Geheimnis im Schlüsseltresor auf die neueste Version zurück. Kann nur für einen Tresor mit vorläufigem Löschen ausgeführt werden. Für diesen Vorgang ist die secrets/recover Berechtigung erforderlich.

Codebeispiel

Stellt das gelöschte Geheimnis aus dem Schlüsseltresor wieder her, der für vorläufiges Löschen aktiviert ist. Abonniert den Aufruf asynchron und druckt die wiederhergestellten Geheimdetails aus, wenn eine Antwort empfangen wird.

secretAsyncClient.beginRecoverDeletedSecret("deletedSecretName")
     .subscribe(pollResponse -> {
         System.out.println("Recovery Status: " + pollResponse.getStatus().toString());
         System.out.println("Recovered Secret Name: " + pollResponse.getValue().getName());
         System.out.println("Recovered Secret Value: " + pollResponse.getValue().getValue());
     });

Parameters:

name - Der Name des wiederherzustellenden gelöschten Geheimnisses.

Returns:

Ein PollerFlux<T,U> , um die abzurufen und abzurufen KeyVaultSecret.

getDeletedSecret

public Mono getDeletedSecret(String name)

Ruft ein Geheimnis ab, das für einen vorläufig gelöschten Schlüsseltresor gelöscht wurde. Für diesen Vorgang ist die secrets/list Berechtigung erforderlich.

Codebeispiel

Ruft das gelöschte Geheimnis aus dem Schlüsseltresor ab, der für vorläufiges Löschen aktiviert ist. Abonniert den Aufruf asynchron und druckt die gelöschten Geheimnisdetails aus, wenn eine Antwort empfangen wird.

secretAsyncClient.getDeletedSecret("secretName")
     .subscribe(deletedSecretResponse ->
         System.out.printf("Deleted Secret's Recovery Id %s %n", deletedSecretResponse.getRecoveryId()));

Parameters:

name - Der Name des gelöschten Geheimnisses.

Returns:

Ein Mono , der den DeletedSecretenthält.

getDeletedSecretWithResponse

public Mono> getDeletedSecretWithResponse(String name)

Ruft ein Geheimnis ab, das für einen vorläufig gelöschten Schlüsseltresor gelöscht wurde. Für diesen Vorgang ist die secrets/list Berechtigung erforderlich.

Codebeispiel

secretAsyncClient.getDeletedSecretWithResponse("secretName")
     .subscribe(deletedSecretResponse ->
         System.out.printf("Deleted Secret's Recovery Id %s %n",
             deletedSecretResponse.getValue().getRecoveryId()));

Parameters:

name - Der Name des gelöschten Geheimnisses.

Returns:

EineMono, die ein Response<T> enthält, dessen value enthält.DeletedSecret

getSecret

public Mono getSecret(String name)

Ruft die neueste Version des angegebenen Geheimnisses aus dem Schlüsseltresor ab. Für diesen Vorgang ist die secrets/get Berechtigung erforderlich.

Codebeispiel

Ruft die neueste Version des Geheimnisses im Schlüsseltresor ab. Abonniert den Aufruf asynchron und gibt die zurückgegebenen Geheimnisdetails aus, wenn eine Antwort empfangen wird.

secretAsyncClient.getSecret("secretName")
     .subscribe(secretWithVersion ->
         System.out.printf("Secret is returned with name %s and value %s %n",
             secretWithVersion.getName(), secretWithVersion.getValue()));

Parameters:

name - Der Name des Geheimnisses.

Returns:

Eine Mono , die den angeforderten KeyVaultSecretenthält.

getSecret

public Mono getSecret(String name, String version)

Ruft das angegebene Geheimnis mit der angegebenen Version aus dem Schlüsseltresor ab. Für diesen Vorgang ist die secrets/get Berechtigung erforderlich.

Codebeispiel

Ruft eine bestimmte Version des Geheimnisses im Schlüsseltresor ab. Abonniert den Aufruf asynchron und gibt die zurückgegebenen Geheimnisdetails aus, wenn eine Antwort empfangen wird.

String secretVersion = "6A385B124DEF4096AF1361A85B16C204";
 secretAsyncClient.getSecret("secretName", secretVersion)
     // Passing a Context is optional and useful if you want a set of data to flow through the request.
     // Otherwise, the line below can be removed.
     .contextWrite(Context.of(key1, value1, key2, value2))
     .subscribe(secretWithVersion ->
         System.out.printf("Secret is returned with name %s and value %s %n",
             secretWithVersion.getName(), secretWithVersion.getValue()));

Parameters:

name - Der Name des Geheimnisses darf nicht NULL sein.

version - Die Version des abzurufenden Geheimnisses. Wenn dies eine leere Zeichenfolge oder NULL ist, entspricht dieser Aufruf dem Aufrufen getSecret(String name)von , wobei die neueste Version abgerufen wird.

Returns:

Ein Mono , das ein Response<T> enthält, dessen value das angeforderte KeyVaultSecretenthält.

getSecretWithResponse

public Mono> getSecretWithResponse(String name, String version)

Ruft das angegebene Geheimnis mit der angegebenen Version aus dem Schlüsseltresor ab. Für diesen Vorgang ist die secrets/get Berechtigung erforderlich.

Codebeispiel

Ruft eine bestimmte Version des Geheimnisses im Schlüsseltresor ab. Abonniert den Aufruf asynchron und gibt die zurückgegebenen Geheimnisdetails aus, wenn eine Antwort empfangen wird.

String secretVersion = "6A385B124DEF4096AF1361A85B16C204";
 secretAsyncClient.getSecretWithResponse("secretName", secretVersion)
     // Passing a Context is optional and useful if you want a set of data to flow through the request.
     // Otherwise, the line below can be removed.
     .contextWrite(Context.of(key1, value1, key2, value2))
     .subscribe(secretWithVersion ->
         System.out.printf("Secret is returned with name %s and value %s %n",
             secretWithVersion.getValue().getName(), secretWithVersion.getValue().getValue()));

Parameters:

name - Der Name des Geheimnisses darf nicht NULL sein.

Returns:

Ein Mono , das ein Response<T> enthält, dessen value das angeforderte KeyVaultSecretenthält.

getVaultUrl

public String getVaultUrl()

Ruft die Tresorendpunkt-URL ab, an die Dienstanforderungen gesendet werden.

Returns:

die Tresorendpunkt-URL.

listDeletedSecrets

public PagedFlux listDeletedSecrets()

Listen DeletedSecret des Schlüsseltresors, wenn er das vorläufige Löschen aktiviert hat. Für diesen Vorgang ist die secrets/list Berechtigung erforderlich.

Codebeispiel

Listet die gelöschten Geheimnisse im Schlüsseltresor auf. abonniert den Aufruf asynchron und gibt die Wiederherstellungs-ID jedes gelöschten Geheimnisses aus, wenn eine Antwort empfangen wird.

secretAsyncClient.listDeletedSecrets()
     .subscribe(deletedSecretResponse -> System.out.printf("Deleted Secret's Recovery Id %s %n",
         deletedSecretResponse.getRecoveryId()));

Returns:

Eine Flux , die alle DeletedSecret im Tresor enthält.

listPropertiesOfSecretVersions

public PagedFlux listPropertiesOfSecretVersions(String name)

Listet alle Versionen des angegebenen Geheimnisses auf. Für jede SecretProperties zurückgegebene Datei werden nur ihre Bezeichner und Attribute aufgefüllt. Die Geheimwerte und Geheimversionen werden in der Antwort nicht aufgeführt. Für diesen Vorgang ist die secrets/list Berechtigung erforderlich.

Codebeispiel

Im folgenden Beispiel werden alle Versionen des angegebenen Geheimnisses abgerufen. Führt für jede abgerufene Version einen Aufruf von aus, um getSecret(String name, String version) den Wert der Version abzurufen, und gibt ihn dann aus.

secretAsyncClient.listPropertiesOfSecretVersions("secretName")
     .flatMap(secretProperties -> {
         System.out.println("Get secret value for version: " + secretProperties.getVersion());
         return secretAsyncClient.getSecret(secretProperties.getName(), secretProperties.getVersion());
     })
     .subscribe(secret -> System.out.printf("Received secret with name %s and type %s%n",
         secret.getName(), secret.getValue()));

Parameters:

name - Der Name des Geheimnisses.

Returns:

Ein PagedFlux<T> , der alle Versionen des angegebenen Geheimnisses im Tresor enthält SecretProperties . Flux ist leer, wenn das Geheimnis mit name im Schlüsseltresor nicht vorhanden ist

listPropertiesOfSecrets

public PagedFlux listPropertiesOfSecrets()

Listet Geheimnisse im Schlüsseltresor auf. Für jede SecretProperties zurückgegebene Datei werden nur ihre Bezeichner und Attribute aufgefüllt. Die Geheimwerte und ihre Versionen werden in der Antwort nicht aufgeführt. Für diesen Vorgang ist die secrets/list Berechtigung erforderlich.

Codebeispiel

Im folgenden Beispiel werden alle Geheimeigenschaften im Tresor abgerufen. Führt für jedes abgerufene Geheimnis einen Aufruf von aus, um getSecret(String name, String version) seinen Wert abzurufen, und druckt ihn dann aus.

secretAsyncClient.listPropertiesOfSecrets()
     .flatMap(secretProperties -> {
         String name = secretProperties.getName();
         String version = secretProperties.getVersion();

         System.out.printf("Getting secret name: '%s', version: %s%n", name, version);
         return secretAsyncClient.getSecret(name, version);
     })
     .subscribe(secretResponse -> System.out.printf("Received secret with name %s and type %s",
         secretResponse.getName(), secretResponse.getValue()));

Returns:

Eine PagedFlux<T> , die alle Geheimnisse im Tresor enthält SecretProperties .

purgeDeletedSecret

public Mono purgeDeletedSecret(String name)

Entfernt dauerhaft ein gelöschtes Geheimnis, ohne die Möglichkeit der Wiederherstellung. Dieser Vorgang kann nur bei aktiviertem vorläufigem Löschen ausgeführt werden. Für diesen Vorgang ist die secrets/purge Berechtigung erforderlich.

Codebeispiel

Löscht das gelöschte Geheimnis aus dem Schlüsseltresor, der für vorläufiges Löschen aktiviert ist. abonniert den Aufruf asynchron und gibt den status Code aus der Serverantwort aus, wenn eine Antwort empfangen wird.

secretAsyncClient.purgeDeletedSecret("deletedSecretName")
     .doOnSuccess(purgeResponse ->
         System.out.println("Successfully Purged deleted Secret"))
     .subscribe();

Parameters:

name - Der Name des Geheimnisses.

Returns:

Ein leerer Mono.

purgeDeletedSecretWithResponse

public Mono> purgeDeletedSecretWithResponse(String name)

Entfernt dauerhaft ein gelöschtes Geheimnis, ohne die Möglichkeit der Wiederherstellung. Dieser Vorgang kann nur in einem Tresor mit vorläufigem Löschen aktiviert werden. Für diesen Vorgang ist die secrets/purge Berechtigung erforderlich.

Codebeispiel

Löscht das gelöschte Geheimnis aus dem Schlüsseltresor, der für vorläufiges Löschen aktiviert ist. abonniert den Aufruf asynchron und gibt den status Code aus der Serverantwort aus, wenn eine Antwort empfangen wird.

secretAsyncClient.purgeDeletedSecretWithResponse("deletedSecretName")
     .subscribe(purgeResponse ->
         System.out.printf("Purge Status response %d %n", purgeResponse.getStatusCode()));

Parameters:

name - Der Name des Geheimnisses.

Returns:

Ein Mono mit einer Antwort, die status Code und HTTP-Headern enthält.

restoreSecretBackup

public Mono restoreSecretBackup(byte[] backup)

Stellt ein gesichertes Geheimnis und alle zugehörigen Versionen in einem Tresor wieder her. Für diesen Vorgang ist die secrets/restore -Berechtigung erforderlich.

Codebeispiel

Stellt das Geheimnis im Schlüsseltresor aus seiner Sicherung wieder her. Abonniert den Aufruf asynchron und gibt die wiederhergestellten Geheimnisdetails aus, wenn eine Antwort empfangen wird.

// Pass the secret backup byte array to the restore operation.
 byte[] secretBackupByteArray = {};
 secretAsyncClient.restoreSecretBackup(secretBackupByteArray)
     .subscribe(secretResponse -> System.out.printf("Restored Secret with name %s and value %s %n",
         secretResponse.getName(), secretResponse.getValue()));

Parameters:

backup - Das dem Geheimnis zugeordnete Sicherungsblob.

Returns:

Ein Mono , der den KeyVaultSecretenthält.

restoreSecretBackupWithResponse

public Mono> restoreSecretBackupWithResponse(byte[] backup)

Stellt ein gesichertes Geheimnis und alle zugehörigen Versionen in einem Tresor wieder her. Für diesen Vorgang ist die secrets/restore -Berechtigung erforderlich.

Codebeispiel

Stellt das Geheimnis im Schlüsseltresor aus seiner Sicherung wieder her. Abonniert den Aufruf asynchron und gibt die wiederhergestellten Geheimnisdetails aus, wenn eine Antwort empfangen wird.

// Pass the secret backup byte array to the restore operation.
 byte[] secretBackupByteArray = {};
 secretAsyncClient.restoreSecretBackupWithResponse(secretBackupByteArray)
     .subscribe(secretResponse -> System.out.printf("Restored Secret with name %s and value %s %n",
         secretResponse.getValue().getName(), secretResponse.getValue().getValue()));

Parameters:

backup - Das dem Geheimnis zugeordnete Sicherungsblob.

Returns:

Ein Mono , das ein Response<T> enthält, dessen value enthält KeyVaultSecret.

setSecret

public Mono setSecret(KeyVaultSecret secret)

Fügt dem Schlüsseltresor ein Geheimnis hinzu, wenn es nicht vorhanden ist. Wenn das benannte Geheimnis vorhanden ist, wird eine neue Version des Geheimnisses erstellt. Für diesen Vorgang ist die secrets/set -Berechtigung erforderlich.

Die getExpiresOn()Werte , getContentType()und getNotBefore() in secret sind optional. Wenn nicht angegeben, isEnabled() wird vom Schlüsseltresor auf TRUE festgelegt.

Codebeispiel

Erstellt ein neues Geheimnis, das an einem Tag aktiviert wird und in einem Jahr abläuft. Abonniert den Aufruf asynchron und gibt die neu erstellten Geheimnisdetails aus, wenn eine Antwort empfangen wird.

SecretProperties properties = new SecretProperties()
     .setExpiresOn(OffsetDateTime.now().plusDays(60));
 KeyVaultSecret newSecret = new KeyVaultSecret("secretName", "secretValue")
     .setProperties(properties);

 secretAsyncClient.setSecret(newSecret)
     .subscribe(secretResponse ->
         System.out.printf("Secret is created with name %s and value %s %n",
             secretResponse.getName(), secretResponse.getValue()));

Parameters:

secret - Das Secret-Objekt, das Informationen über das Geheimnis und seine Eigenschaften enthält. Die Eigenschaften getName() und getValue() dürfen nicht NULL sein.

Returns:

Ein Mono , der den KeyVaultSecretenthält.

setSecret

public Mono setSecret(String name, String value)

Codebeispiel

Erstellt ein neues Geheimnis im Schlüsseltresor. Abonniert den Aufruf asynchron und gibt die neu erstellten Geheimnisdetails aus, wenn eine Antwort empfangen wird.

secretAsyncClient.setSecret("secretName", "secretValue")
     .subscribe(secretResponse ->
         System.out.printf("Secret is created with name %s and value %s%n",
             secretResponse.getName(), secretResponse.getValue()));

Parameters:

name - Der Name des Geheimnisses. Sie ist erforderlich und darf nicht NULL sein.

value - Der Wert des geheimen Schlüssels. Sie ist erforderlich und darf nicht NULL sein.

Returns:

Ein Mono , der den KeyVaultSecretenthält.

setSecretWithResponse

public Mono> setSecretWithResponse(KeyVaultSecret secret)

Die getExpiresOn()Werte , getContentType()und getNotBefore() in secret sind optional. Wenn nicht angegeben, isEnabled() wird vom Schlüsseltresor auf TRUE festgelegt.

Codebeispiel

KeyVaultSecret newSecret = new KeyVaultSecret("secretName", "secretValue").
     setProperties(new SecretProperties().setExpiresOn(OffsetDateTime.now().plusDays(60)));
 secretAsyncClient.setSecretWithResponse(newSecret)
     .subscribe(secretResponse ->
         System.out.printf("Secret is created with name %s and value %s %n",
             secretResponse.getValue().getName(), secretResponse.getValue().getValue()));

Parameters:

secret - Das Secret-Objekt, das Informationen über das Geheimnis und seine Eigenschaften enthält. Die Eigenschaften getName() und getValue() dürfen nicht NULL sein.

Returns:

Ein Mono , das ein Response<T> enthält, dessen value enthält KeyVaultSecret.

updateSecretProperties

public Mono updateSecretProperties(SecretProperties secretProperties)

Updates die Attribute, die dem Geheimnis zugeordnet sind. Der Wert des Geheimnisses im Schlüsseltresor kann nicht geändert werden. Nur Attribute, die in secretProperties aufgefüllt werden, werden geändert. Attribute, die nicht in der Anforderung angegeben sind, werden nicht geändert. Für diesen Vorgang ist die secrets/set -Berechtigung erforderlich.

Ist secret und seine Felder getName() erforderlich und getVersion() darf nicht NULL sein.

Codebeispiel

Ruft die neueste Version des Geheimnisses ab, ändert seine setNotBefore(OffsetDateTime notBefore) Zeit und aktualisiert es dann im Azure-Key Vault. Abonniert den Aufruf asynchron und gibt die zurückgegebenen Geheimnisdetails aus, wenn eine Antwort empfangen wird.

secretAsyncClient.getSecret("secretName")
     .subscribe(secretResponseValue -> {
         SecretProperties secretProperties = secretResponseValue.getProperties();
         //Update the not before time of the secret.
         secretProperties.setNotBefore(OffsetDateTime.now().plusDays(50));
         secretAsyncClient.updateSecretProperties(secretProperties)
             .subscribe(secretResponse ->
                 System.out.printf("Secret's updated not before time %s %n",
                     secretResponse.getNotBefore().toString()));
     });

Parameters:

secretProperties - Das SecretProperties -Objekt mit aktualisierten Eigenschaften.

Returns:

Ein Mono , der den SecretPropertiesenthält.

updateSecretPropertiesWithResponse

public Mono> updateSecretPropertiesWithResponse(SecretProperties secretProperties)

Codebeispiel

secretAsyncClient.getSecret("secretName")
     .subscribe(secretResponseValue -> {
         SecretProperties secretProperties = secretResponseValue.getProperties();
         //Update the not before time of the secret.
         secretProperties.setNotBefore(OffsetDateTime.now().plusDays(50));
         secretAsyncClient.updateSecretPropertiesWithResponse(secretProperties)
             .subscribe(secretResponse ->
                 System.out.printf("Secret's updated not before time %s %n",
                     secretResponse.getValue().getNotBefore().toString()));
     });

Ist secret und seine Felder getName() erforderlich und getVersion() darf nicht NULL sein.

Parameters:

secretProperties - Das SecretProperties -Objekt mit aktualisierten Eigenschaften.

Returns:

Ein Mono , das ein Response<T> enthält, dessen value enthält SecretProperties.

Gilt für:

Feedback

War diese Seite hilfreich?

Freigeben über

SecretAsyncClient Klasse

Erste Schritte

Erstellen eines Geheimnisses

Abrufen eines Geheimnisses

Löschen eines Geheimnisses

Methodenzusammenfassung

Geerbte Methoden von java.lang.Object

Details zur Methode

backupSecret

backupSecretWithResponse

beginDeleteSecret

beginRecoverDeletedSecret

getDeletedSecret

getDeletedSecretWithResponse

getSecret

getSecret

getSecretWithResponse

getVaultUrl

listDeletedSecrets

listPropertiesOfSecretVersions

listPropertiesOfSecrets

purgeDeletedSecret

purgeDeletedSecretWithResponse

restoreSecretBackup

restoreSecretBackupWithResponse

setSecret

setSecret

setSecretWithResponse

updateSecretProperties

updateSecretPropertiesWithResponse

Gilt für:

Feedback