Secret interface
Interface representing a Secret.
Methods
| create(string, string, Secret |
Creates a secret resource with the specified name, description and properties. If a secret resource with the same name exists, then it is updated with the specified description and properties. |
| delete(string, string, Secret |
Deletes the secret resource identified by the name. |
| get(string, string, Secret |
Gets the information about the secret resource with the given name. The information include the description and other properties of the secret. |
| list |
Gets the information about all secret resources in a given resource group. The information include the description and other properties of the Secret. |
| list |
Gets the information about all secret resources in a given resource group. The information include the description and other properties of the secret. |
Method Details
create(string, string, SecretResourceDescription, SecretCreateOptionalParams)
Creates a secret resource with the specified name, description and properties. If a secret resource with the same name exists, then it is updated with the specified description and properties.
function create(resourceGroupName: string, secretResourceName: string, secretResourceDescription: SecretResourceDescription, options?: SecretCreateOptionalParams): Promise<SecretResourceDescription>Parameters
- resourceGroupName
-
string
Azure resource group name
- secretResourceName
-
string
The name of the secret resource.
- secretResourceDescription
- SecretResourceDescription
Description for creating a secret resource.
- options
- SecretCreateOptionalParams
The options parameters.
Returns
Promise<SecretResourceDescription>
delete(string, string, SecretDeleteOptionalParams)
Deletes the secret resource identified by the name.
function delete(resourceGroupName: string, secretResourceName: string, options?: SecretDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
Azure resource group name
- secretResourceName
-
string
The name of the secret resource.
- options
- SecretDeleteOptionalParams
The options parameters.
Returns
Promise<void>
get(string, string, SecretGetOptionalParams)
Gets the information about the secret resource with the given name. The information include the description and other properties of the secret.
function get(resourceGroupName: string, secretResourceName: string, options?: SecretGetOptionalParams): Promise<SecretResourceDescription>Parameters
- resourceGroupName
-
string
Azure resource group name
- secretResourceName
-
string
The name of the secret resource.
- options
- SecretGetOptionalParams
The options parameters.
Returns
Promise<SecretResourceDescription>
listByResourceGroup(string, SecretListByResourceGroupOptionalParams)
Gets the information about all secret resources in a given resource group. The information include the description and other properties of the Secret.
function listByResourceGroup(resourceGroupName: string, options?: SecretListByResourceGroupOptionalParams): PagedAsyncIterableIterator<SecretResourceDescription, SecretResourceDescription[], PageSettings>Parameters
- resourceGroupName
-
string
Azure resource group name
The options parameters.
Returns
listBySubscription(SecretListBySubscriptionOptionalParams)
Gets the information about all secret resources in a given resource group. The information include the description and other properties of the secret.
function listBySubscription(options?: SecretListBySubscriptionOptionalParams): PagedAsyncIterableIterator<SecretResourceDescription, SecretResourceDescription[], PageSettings>Parameters
The options parameters.
Returns
Azure SDK for JavaScript