Secrets interface
Interface representing a Secrets.
Methods
| begin |
Create or replace an existing secret. This operation can take a while to complete. |
| begin |
Create or replace an existing secret. This operation can take a while to complete. |
| delete(string, string, string, string, Secrets |
Delete secret. |
| get(string, string, string, string, Secrets |
Get secret. |
| list(string, string, string, Secrets |
List secrets in a given user profile. |
| update(string, string, string, string, Secret |
Allows modifying tags of secrets. All other properties will be ignored. |
Method Details
beginCreateOrUpdate(string, string, string, string, Secret, SecretsCreateOrUpdateOptionalParams)
Create or replace an existing secret. This operation can take a while to complete.
function beginCreateOrUpdate(resourceGroupName: string, labName: string, userName: string, name: string, secret: Secret, options?: SecretsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<Secret>, Secret>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- labName
-
string
The name of the lab.
- userName
-
string
The name of the user profile.
- name
-
string
The name of the secret.
- secret
- Secret
A secret.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<Secret>, Secret>>
beginCreateOrUpdateAndWait(string, string, string, string, Secret, SecretsCreateOrUpdateOptionalParams)
Create or replace an existing secret. This operation can take a while to complete.
function beginCreateOrUpdateAndWait(resourceGroupName: string, labName: string, userName: string, name: string, secret: Secret, options?: SecretsCreateOrUpdateOptionalParams): Promise<Secret>Parameters
- resourceGroupName
-
string
The name of the resource group.
- labName
-
string
The name of the lab.
- userName
-
string
The name of the user profile.
- name
-
string
The name of the secret.
- secret
- Secret
A secret.
The options parameters.
Returns
Promise<Secret>
delete(string, string, string, string, SecretsDeleteOptionalParams)
Delete secret.
function delete(resourceGroupName: string, labName: string, userName: string, name: string, options?: SecretsDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group.
- labName
-
string
The name of the lab.
- userName
-
string
The name of the user profile.
- name
-
string
The name of the secret.
- options
- SecretsDeleteOptionalParams
The options parameters.
Returns
Promise<void>
get(string, string, string, string, SecretsGetOptionalParams)
Get secret.
function get(resourceGroupName: string, labName: string, userName: string, name: string, options?: SecretsGetOptionalParams): Promise<Secret>Parameters
- resourceGroupName
-
string
The name of the resource group.
- labName
-
string
The name of the lab.
- userName
-
string
The name of the user profile.
- name
-
string
The name of the secret.
- options
- SecretsGetOptionalParams
The options parameters.
Returns
Promise<Secret>
list(string, string, string, SecretsListOptionalParams)
List secrets in a given user profile.
function list(resourceGroupName: string, labName: string, userName: string, options?: SecretsListOptionalParams): PagedAsyncIterableIterator<Secret, Secret[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group.
- labName
-
string
The name of the lab.
- userName
-
string
The name of the user profile.
- options
- SecretsListOptionalParams
The options parameters.
Returns
update(string, string, string, string, SecretFragment, SecretsUpdateOptionalParams)
Allows modifying tags of secrets. All other properties will be ignored.
function update(resourceGroupName: string, labName: string, userName: string, name: string, secret: SecretFragment, options?: SecretsUpdateOptionalParams): Promise<Secret>Parameters
- resourceGroupName
-
string
The name of the resource group.
- labName
-
string
The name of the lab.
- userName
-
string
The name of the user profile.
- name
-
string
The name of the secret.
- secret
- SecretFragment
A secret.
- options
- SecretsUpdateOptionalParams
The options parameters.
Returns
Promise<Secret>