Package version:

Interface Secrets

Interface representing a Secrets.

interface Secrets {
    createOrUpdate(resourceGroupName: string, vaultName: string, secretName: string, parameters: SecretCreateOrUpdateParameters, options?: SecretsCreateOrUpdateOptionalParams): Promise<Secret>;
    get(resourceGroupName: string, vaultName: string, secretName: string, options?: SecretsGetOptionalParams): Promise<Secret>;
    list(resourceGroupName: string, vaultName: string, options?: SecretsListOptionalParams): PagedAsyncIterableIterator<Secret>;
    update(resourceGroupName: string, vaultName: string, secretName: string, parameters: SecretPatchParameters, options?: SecretsUpdateOptionalParams): Promise<Secret>;
}

Methods

createOrUpdate(resourceGroupName, vaultName, secretName, parameters, options?): Promise<Secret>
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. The name is case insensitive.
- vaultName: string
  The name of the vault.
- secretName: string
  The name of the secret.
- parameters: SecretCreateOrUpdateParameters
  Parameters to create or update the secret
- Optionaloptions: SecretsCreateOrUpdateOptionalParams
  The options parameters.
Returns Promise<Secret>
- Defined in operationsInterfaces/secrets.ts:61

list(resourceGroupName, vaultName, options?): PagedAsyncIterableIterator<Secret>
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. The name is case insensitive.
- vaultName: string
  The name of the vault.
- Optionaloptions: SecretsListOptionalParams
  The options parameters.
Returns PagedAsyncIterableIterator<Secret>
- Defined in operationsInterfaces/secrets.ts:32

update(resourceGroupName, vaultName, secretName, parameters, options?): Promise<Secret>
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. The name is case insensitive.
- vaultName: string
  The name of the vault.
- secretName: string
  The name of the secret.
- parameters: SecretPatchParameters
  Parameters to patch the secret
- Optionaloptions: SecretsUpdateOptionalParams
  The options parameters.
Returns Promise<Secret>
- Defined in operationsInterfaces/secrets.ts:77