Secrets interface
Interface representing a Secrets.
Methods
| create |
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. |
| get(string, string, string, Secrets |
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. |
| list(string, string, Secrets |
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. |
| update(string, string, string, 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. |
Method Details
createOrUpdate(string, string, string, SecretCreateOrUpdateParameters, SecretsCreateOrUpdateOptionalParams)
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.
function createOrUpdate(resourceGroupName: string, vaultName: string, secretName: string, parameters: SecretCreateOrUpdateParameters, options?: SecretsCreateOrUpdateOptionalParams): Promise<Secret>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
The options parameters.
Returns
Promise<Secret>
get(string, string, string, SecretsGetOptionalParams)
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.
function get(resourceGroupName: string, vaultName: string, secretName: string, options?: SecretsGetOptionalParams): Promise<Secret>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.
- options
- SecretsGetOptionalParams
The options parameters.
Returns
Promise<Secret>
list(string, string, SecretsListOptionalParams)
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.
function list(resourceGroupName: string, vaultName: string, options?: SecretsListOptionalParams): PagedAsyncIterableIterator<Secret, Secret[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the Resource Group to which the vault belongs.
- vaultName
-
string
The name of the vault.
- options
- SecretsListOptionalParams
The options parameters.
Returns
update(string, string, string, SecretPatchParameters, SecretsUpdateOptionalParams)
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.
function update(resourceGroupName: string, vaultName: string, secretName: string, parameters: SecretPatchParameters, options?: SecretsUpdateOptionalParams): Promise<Secret>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
- options
- SecretsUpdateOptionalParams
The options parameters.
Returns
Promise<Secret>