SecretValueOperations interface
Interface representing a SecretValueOperations.
Methods
| create(string, string, string, Secret |
Creates a new value of the specified secret resource. The name of the value is typically the version identifier. Once created the value cannot be changed. |
| delete(string, string, string, Secret |
Deletes the secret value resource identified by the name. The name of the resource is typically the version associated with that value. Deletion will fail if the specified value is in use. |
| get(string, string, string, Secret |
Get the information about the specified named secret value resources. The information does not include the actual value of the secret. |
| list(string, string, Secret |
Gets information about all secret value resources of the specified secret resource. The information includes the names of the secret value resources, but not the actual values. |
| list |
Lists the decrypted value of the specified named value of the secret resource. This is a privileged operation. |
Method Details
create(string, string, string, SecretValueResourceDescription, SecretValueCreateOptionalParams)
Creates a new value of the specified secret resource. The name of the value is typically the version identifier. Once created the value cannot be changed.
function create(resourceGroupName: string, secretResourceName: string, secretValueResourceName: string, secretValueResourceDescription: SecretValueResourceDescription, options?: SecretValueCreateOptionalParams): Promise<SecretValueResourceDescription>Parameters
- resourceGroupName
-
string
Azure resource group name
- secretResourceName
-
string
The name of the secret resource.
- secretValueResourceName
-
string
The name of the secret resource value which is typically the version identifier for the value.
- secretValueResourceDescription
- SecretValueResourceDescription
Description for creating a value of a secret resource.
- options
- SecretValueCreateOptionalParams
The options parameters.
Returns
Promise<SecretValueResourceDescription>
delete(string, string, string, SecretValueDeleteOptionalParams)
Deletes the secret value resource identified by the name. The name of the resource is typically the version associated with that value. Deletion will fail if the specified value is in use.
function delete(resourceGroupName: string, secretResourceName: string, secretValueResourceName: string, options?: SecretValueDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
Azure resource group name
- secretResourceName
-
string
The name of the secret resource.
- secretValueResourceName
-
string
The name of the secret resource value which is typically the version identifier for the value.
- options
- SecretValueDeleteOptionalParams
The options parameters.
Returns
Promise<void>
get(string, string, string, SecretValueGetOptionalParams)
Get the information about the specified named secret value resources. The information does not include the actual value of the secret.
function get(resourceGroupName: string, secretResourceName: string, secretValueResourceName: string, options?: SecretValueGetOptionalParams): Promise<SecretValueResourceDescription>Parameters
- resourceGroupName
-
string
Azure resource group name
- secretResourceName
-
string
The name of the secret resource.
- secretValueResourceName
-
string
The name of the secret resource value which is typically the version identifier for the value.
- options
- SecretValueGetOptionalParams
The options parameters.
Returns
Promise<SecretValueResourceDescription>
list(string, string, SecretValueListOptionalParams)
Gets information about all secret value resources of the specified secret resource. The information includes the names of the secret value resources, but not the actual values.
function list(resourceGroupName: string, secretResourceName: string, options?: SecretValueListOptionalParams): PagedAsyncIterableIterator<SecretValueResourceDescription, SecretValueResourceDescription[], PageSettings>Parameters
- resourceGroupName
-
string
Azure resource group name
- secretResourceName
-
string
The name of the secret resource.
- options
- SecretValueListOptionalParams
The options parameters.
Returns
listValue(string, string, string, SecretValueListValueOptionalParams)
Lists the decrypted value of the specified named value of the secret resource. This is a privileged operation.
function listValue(resourceGroupName: string, secretResourceName: string, secretValueResourceName: string, options?: SecretValueListValueOptionalParams): Promise<SecretValue>Parameters
- resourceGroupName
-
string
Azure resource group name
- secretResourceName
-
string
The name of the secret resource.
- secretValueResourceName
-
string
The name of the secret resource value which is typically the version identifier for the value.
The options parameters.
Returns
Promise<SecretValue>
Azure SDK for JavaScript