Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Secrets

Package version

Class representing a Secrets.

Hierarchy

  • Secrets

Index

Constructors

Methods

Constructors

constructor

Methods

beginCreateOrUpdate

  • beginCreateOrUpdate(resourceGroupName: string, labName: string, userName: string, name: string, secret: Secret, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

  • Create or replace an existing secret. This operation can take a while to complete.

    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.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

createOrUpdate

  • createOrUpdate(resourceGroupName: string, labName: string, userName: string, name: string, secret: Secret, options?: msRest.RequestOptionsBase): Promise<Models.SecretsCreateOrUpdateResponse>

  • Create or replace an existing secret. This operation can take a while to complete.

    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.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.SecretsCreateOrUpdateResponse>

    Promise<Models.SecretsCreateOrUpdateResponse>

deleteMethod

  • deleteMethod(resourceGroupName: string, labName: string, userName: string, name: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>
  • deleteMethod(resourceGroupName: string, labName: string, userName: string, name: string, callback: msRest.ServiceCallback<void>): void
  • deleteMethod(resourceGroupName: string, labName: string, userName: string, name: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<void>): void

  • Delete 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.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRest.RestResponse>

    Promise<msRest.RestResponse>

  • 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.

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns 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: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

get

  • get(resourceGroupName: string, labName: string, userName: string, name: string, options?: Models.SecretsGetOptionalParams): Promise<Models.SecretsGetResponse>
  • get(resourceGroupName: string, labName: string, userName: string, name: string, callback: msRest.ServiceCallback<Secret>): void
  • get(resourceGroupName: string, labName: string, userName: string, name: string, options: SecretsGetOptionalParams, callback: msRest.ServiceCallback<Secret>): void

  • Get 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.

    • Optional options: Models.SecretsGetOptionalParams

    Returns Promise<Models.SecretsGetResponse>

    Promise<Models.SecretsGetResponse>

  • 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.

    • callback: msRest.ServiceCallback<Secret>

      The callback

    Returns 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: SecretsGetOptionalParams

      The optional parameters

    • callback: msRest.ServiceCallback<Secret>

      The callback

    Returns void

list

  • list(resourceGroupName: string, labName: string, userName: string, options?: Models.SecretsListOptionalParams): Promise<Models.SecretsListResponse>
  • list(resourceGroupName: string, labName: string, userName: string, callback: msRest.ServiceCallback<SecretList>): void
  • list(resourceGroupName: string, labName: string, userName: string, options: SecretsListOptionalParams, callback: msRest.ServiceCallback<SecretList>): void

  • List secrets in a given user profile.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • labName: string

      The name of the lab.

    • userName: string

      The name of the user profile.

    • Optional options: Models.SecretsListOptionalParams

    Returns Promise<Models.SecretsListResponse>

    Promise<Models.SecretsListResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • labName: string

      The name of the lab.

    • userName: string

      The name of the user profile.

    • callback: msRest.ServiceCallback<SecretList>

      The callback

    Returns 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.

    • options: SecretsListOptionalParams

      The optional parameters

    • callback: msRest.ServiceCallback<SecretList>

      The callback

    Returns void

listNext

  • listNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.SecretsListNextResponse>
  • listNext(nextPageLink: string, callback: msRest.ServiceCallback<SecretList>): void
  • listNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<SecretList>): void

  • List secrets in a given user profile.

    Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.SecretsListNextResponse>

    Promise<Models.SecretsListNextResponse>

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • callback: msRest.ServiceCallback<SecretList>

      The callback

    Returns void

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<SecretList>

      The callback

    Returns void

update

  • update(resourceGroupName: string, labName: string, userName: string, name: string, secret: SecretFragment, options?: msRest.RequestOptionsBase): Promise<Models.SecretsUpdateResponse>
  • update(resourceGroupName: string, labName: string, userName: string, name: string, secret: SecretFragment, callback: msRest.ServiceCallback<Secret>): void
  • update(resourceGroupName: string, labName: string, userName: string, name: string, secret: SecretFragment, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<Secret>): void

  • Modify properties of secrets.

    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.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.SecretsUpdateResponse>

    Promise<Models.SecretsUpdateResponse>

  • 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.

    • callback: msRest.ServiceCallback<Secret>

      The callback

    Returns 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.

    • secret: SecretFragment

      A secret.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<Secret>

      The callback

    Returns void

Generated using TypeDoc