Secrets | @azure/arm-keyvault

Interface representing a Secrets.

Hierarchy

Secrets

Implemented by

SecretsImpl

Index

Methods

createOrUpdate

createOrUpdate(resourceGroupName: string, vaultName: string, secretName: string, parameters: SecretCreateOrUpdateParameters, options?: SecretsCreateOrUpdateOptionalParams): Promise<SecretsCreateOrUpdateResponse>

- Defined in operationsInterfaces/secrets.ts:49
Create or update a secret in a key vault in the specified subscription. NOTE: This API is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.

Parameters
- resourceGroupName: string
  
  The name of the Resource Group to which the vault belongs.
- vaultName: string
  
  Name of the vault
- secretName: string
  
  Name of the secret
- parameters: SecretCreateOrUpdateParameters
  
  Parameters to create or update the secret
- Optional options: SecretsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<SecretsCreateOrUpdateResponse>

get

get(resourceGroupName: string, vaultName: string, secretName: string, options?: SecretsGetOptionalParams): Promise<SecretsGetResponse>

- Defined in operationsInterfaces/secrets.ts:80
Gets the specified secret. NOTE: This API is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.

Parameters
- resourceGroupName: string
  
  The name of the Resource Group to which the vault belongs.
- vaultName: string
  
  The name of the vault.
- secretName: string
  
  The name of the secret.
- Optional options: SecretsGetOptionalParams
  
  The options parameters.
Returns Promise<SecretsGetResponse>

list

list(resourceGroupName: string, vaultName: string, options?: SecretsListOptionalParams): PagedAsyncIterableIterator<Secret>

- Defined in operationsInterfaces/secrets.ts:34
The List operation gets information about the secrets in a vault. NOTE: This API is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.

Parameters
- resourceGroupName: string
  
  The name of the Resource Group to which the vault belongs.
- vaultName: string
  
  The name of the vault.
- Optional options: SecretsListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Secret>

update

update(resourceGroupName: string, vaultName: string, secretName: string, parameters: SecretPatchParameters, options?: SecretsUpdateOptionalParams): Promise<SecretsUpdateResponse>

- Defined in operationsInterfaces/secrets.ts:65
Update a secret in the specified subscription. NOTE: This API is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.

Parameters
- resourceGroupName: string
  
  The name of the Resource Group to which the vault belongs.
- vaultName: string
  
  Name of the vault
- secretName: string
  
  Name of the secret
- parameters: SecretPatchParameters
  
  Parameters to patch the secret
- Optional options: SecretsUpdateOptionalParams
  
  The options parameters.
Returns Promise<SecretsUpdateResponse>

Hierarchy

Implemented by

Index

Methods

Methods

createOrUpdate

Parameters

resourceGroupName: string

vaultName: string

secretName: string

parameters: SecretCreateOrUpdateParameters

Optional options: SecretsCreateOrUpdateOptionalParams

Returns Promise<SecretsCreateOrUpdateResponse>

get

Parameters

resourceGroupName: string

vaultName: string

secretName: string

Optional options: SecretsGetOptionalParams

Returns Promise<SecretsGetResponse>

list

Parameters

resourceGroupName: string

vaultName: string

Optional options: SecretsListOptionalParams

Returns PagedAsyncIterableIterator<Secret>

update

Parameters

resourceGroupName: string

vaultName: string

secretName: string

parameters: SecretPatchParameters

Optional options: SecretsUpdateOptionalParams

Returns Promise<SecretsUpdateResponse>