Vaults interface

Paket:

@azure/arm-keyvault

Schnittstelle, die einen Tresor darstellt.

Methoden

beginCreateOrUpdate(string, string, VaultCreateOrUpdateParameters, VaultsCreateOrUpdateOptionalParams)	Erstellen oder Aktualisieren eines Schlüsseltresors im angegebenen Abonnement.
beginCreateOrUpdateAndWait(string, string, VaultCreateOrUpdateParameters, VaultsCreateOrUpdateOptionalParams)	Erstellen oder Aktualisieren eines Schlüsseltresors im angegebenen Abonnement.
beginPurgeDeleted(string, string, VaultsPurgeDeletedOptionalParams)	Löscht den angegebenen Tresor endgültig. aka Löscht den gelöschten Azure Key Vault.
beginPurgeDeletedAndWait(string, string, VaultsPurgeDeletedOptionalParams)	Löscht den angegebenen Tresor endgültig. aka Löscht den gelöschten Azure Key Vault.
checkNameAvailability(VaultCheckNameAvailabilityParameters, VaultsCheckNameAvailabilityOptionalParams)	Überprüft, ob der Tresorname gültig ist und noch nicht verwendet wird.
delete(string, string, VaultsDeleteOptionalParams)	Löscht den angegebenen Azure Key Vault.
get(string, string, VaultsGetOptionalParams)	Ruft den angegebenen Azure Key Vault ab.
getDeleted(string, string, VaultsGetDeletedOptionalParams)	Ruft den gelöschten Azure Key Vault ab.
list(VaultsListOptionalParams)	Der Listenvorgang ruft Informationen zu den Tresoren ab, die dem Abonnement zugeordnet sind.
listByResourceGroup(string, VaultsListByResourceGroupOptionalParams)	Der Listenvorgang ruft Informationen zu den Tresoren ab, die dem Abonnement und innerhalb der angegebenen Ressourcengruppe zugeordnet sind.
listBySubscription(VaultsListBySubscriptionOptionalParams)	Der Listenvorgang ruft Informationen zu den Tresoren ab, die dem Abonnement zugeordnet sind.
listDeleted(VaultsListDeletedOptionalParams)	Ruft Informationen zu den gelöschten Tresoren in einem Abonnement ab.
update(string, string, VaultPatchParameters, VaultsUpdateOptionalParams)	Aktualisieren eines Schlüsseltresors im angegebenen Abonnement.
updateAccessPolicy(string, string, AccessPolicyUpdateKind, VaultAccessPolicyParameters, VaultsUpdateAccessPolicyOptionalParams)	Aktualisieren Sie Zugriffsrichtlinien in einem Schlüsseltresor im angegebenen Abonnement.

Details zur Methode

beginCreateOrUpdate(string, string, VaultCreateOrUpdateParameters, VaultsCreateOrUpdateOptionalParams)

Erstellen oder Aktualisieren eines Schlüsseltresors im angegebenen Abonnement.

function beginCreateOrUpdate(resourceGroupName: string, vaultName: string, parameters: VaultCreateOrUpdateParameters, options?: VaultsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Vault>, Vault>>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe, zu der der Server gehört.

vaultName

string

Name des Tresors

parameters

VaultCreateOrUpdateParameters

Parameter zum Erstellen oder Aktualisieren des Tresors

options

VaultsCreateOrUpdateOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<@azure/core-lro.SimplePollerLike<OperationState<Vault>, Vault>>

beginCreateOrUpdateAndWait(string, string, VaultCreateOrUpdateParameters, VaultsCreateOrUpdateOptionalParams)

Erstellen oder Aktualisieren eines Schlüsseltresors im angegebenen Abonnement.

function beginCreateOrUpdateAndWait(resourceGroupName: string, vaultName: string, parameters: VaultCreateOrUpdateParameters, options?: VaultsCreateOrUpdateOptionalParams): Promise<Vault>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe, zu der der Server gehört.

vaultName

string

Name des Tresors

parameters

VaultCreateOrUpdateParameters

Parameter zum Erstellen oder Aktualisieren des Tresors

options

VaultsCreateOrUpdateOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<Vault>

beginPurgeDeleted(string, string, VaultsPurgeDeletedOptionalParams)

Löscht den angegebenen Tresor endgültig. aka Löscht den gelöschten Azure Key Vault.

function beginPurgeDeleted(vaultName: string, location: string, options?: VaultsPurgeDeletedOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameter

vaultName

string

Der Name des vorläufig gelöschten Tresors.

location

string

Der Speicherort des vorläufig gelöschten Tresors.

options

VaultsPurgeDeletedOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginPurgeDeletedAndWait(string, string, VaultsPurgeDeletedOptionalParams)

Löscht den angegebenen Tresor endgültig. aka Löscht den gelöschten Azure Key Vault.

function beginPurgeDeletedAndWait(vaultName: string, location: string, options?: VaultsPurgeDeletedOptionalParams): Promise<void>

Parameter

vaultName

string

Der Name des vorläufig gelöschten Tresors.

location

string

Der Speicherort des vorläufig gelöschten Tresors.

options

VaultsPurgeDeletedOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<void>

checkNameAvailability(VaultCheckNameAvailabilityParameters, VaultsCheckNameAvailabilityOptionalParams)

Überprüft, ob der Tresorname gültig ist und noch nicht verwendet wird.

function checkNameAvailability(vaultName: VaultCheckNameAvailabilityParameters, options?: VaultsCheckNameAvailabilityOptionalParams): Promise<CheckNameAvailabilityResult>

Parameter

vaultName

VaultCheckNameAvailabilityParameters

Der Name des Tresors.

options

VaultsCheckNameAvailabilityOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<CheckNameAvailabilityResult>

delete(string, string, VaultsDeleteOptionalParams)

Löscht den angegebenen Azure Key Vault.

function delete(resourceGroupName: string, vaultName: string, options?: VaultsDeleteOptionalParams): Promise<void>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe, zu der der Tresor gehört.

vaultName

string

Der Name des zu löschenden Tresors

options

VaultsDeleteOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<void>

get(string, string, VaultsGetOptionalParams)

Ruft den angegebenen Azure Key Vault ab.

function get(resourceGroupName: string, vaultName: string, options?: VaultsGetOptionalParams): Promise<Vault>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe, zu der der Tresor gehört.

vaultName

string

Der Name des Tresors.

options

VaultsGetOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<Vault>

getDeleted(string, string, VaultsGetDeletedOptionalParams)

Ruft den gelöschten Azure Key Vault ab.

function getDeleted(vaultName: string, location: string, options?: VaultsGetDeletedOptionalParams): Promise<DeletedVault>

Parameter

vaultName

string

Der Name des Tresors.

location

string

Der Speicherort des gelöschten Tresors.

options

VaultsGetDeletedOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<DeletedVault>

list(VaultsListOptionalParams)

Der Listenvorgang ruft Informationen zu den Tresoren ab, die dem Abonnement zugeordnet sind.

function list(options?: VaultsListOptionalParams): PagedAsyncIterableIterator<Resource, Resource[], PageSettings>

Parameter

options

VaultsListOptionalParams

Die Optionsparameter.

Gibt zurück

PagedAsyncIterableIterator<Resource, Resource[], PageSettings>

listByResourceGroup(string, VaultsListByResourceGroupOptionalParams)

Der Listenvorgang ruft Informationen zu den Tresoren ab, die dem Abonnement und innerhalb der angegebenen Ressourcengruppe zugeordnet sind.

function listByResourceGroup(resourceGroupName: string, options?: VaultsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Vault, Vault[], PageSettings>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe, zu der der Tresor gehört.

options

VaultsListByResourceGroupOptionalParams

Die Optionsparameter.

Gibt zurück

PagedAsyncIterableIterator<Vault, Vault[], PageSettings>

listBySubscription(VaultsListBySubscriptionOptionalParams)

Der Listenvorgang ruft Informationen zu den Tresoren ab, die dem Abonnement zugeordnet sind.

function listBySubscription(options?: VaultsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<Vault, Vault[], PageSettings>

Parameter

options

VaultsListBySubscriptionOptionalParams

Die Optionsparameter.

Gibt zurück

PagedAsyncIterableIterator<Vault, Vault[], PageSettings>

listDeleted(VaultsListDeletedOptionalParams)

Ruft Informationen zu den gelöschten Tresoren in einem Abonnement ab.

function listDeleted(options?: VaultsListDeletedOptionalParams): PagedAsyncIterableIterator<DeletedVault, DeletedVault[], PageSettings>

Parameter

options

VaultsListDeletedOptionalParams

Die Optionsparameter.

Gibt zurück

PagedAsyncIterableIterator<DeletedVault, DeletedVault[], PageSettings>

update(string, string, VaultPatchParameters, VaultsUpdateOptionalParams)

Aktualisieren eines Schlüsseltresors im angegebenen Abonnement.

function update(resourceGroupName: string, vaultName: string, parameters: VaultPatchParameters, options?: VaultsUpdateOptionalParams): Promise<Vault>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe, zu der der Server gehört.

vaultName

string

Name des Tresors

parameters

VaultPatchParameters

Parameter zum Patchen des Tresors

options

VaultsUpdateOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<Vault>

updateAccessPolicy(string, string, AccessPolicyUpdateKind, VaultAccessPolicyParameters, VaultsUpdateAccessPolicyOptionalParams)

Aktualisieren Sie Zugriffsrichtlinien in einem Schlüsseltresor im angegebenen Abonnement.

function updateAccessPolicy(resourceGroupName: string, vaultName: string, operationKind: AccessPolicyUpdateKind, parameters: VaultAccessPolicyParameters, options?: VaultsUpdateAccessPolicyOptionalParams): Promise<VaultAccessPolicyParameters>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe, zu der der Tresor gehört.

vaultName

string

Name des Tresors

operationKind

AccessPolicyUpdateKind

Name des Vorgangs

parameters

VaultAccessPolicyParameters

Zugriffsrichtlinie zum Zusammenführen in den Tresor

options

VaultsUpdateAccessPolicyOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<VaultAccessPolicyParameters>