Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Secrets

Package version

Class representing a Secrets.

Hierarchy

  • Secrets

Index

Constructors

Methods

Constructors

constructor

Methods

createOrUpdate

  • createOrUpdate(resourceGroupName: string, vaultName: string, secretName: string, parameters: SecretCreateOrUpdateParameters, options?: msRest.RequestOptionsBase): Promise<Models.SecretsCreateOrUpdateResponse>
  • createOrUpdate(resourceGroupName: string, vaultName: string, secretName: string, parameters: SecretCreateOrUpdateParameters, callback: msRest.ServiceCallback<Secret>): void
  • createOrUpdate(resourceGroupName: string, vaultName: string, secretName: string, parameters: SecretCreateOrUpdateParameters, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<Secret>): void

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

    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

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.SecretsCreateOrUpdateResponse>

    Promise<Models.SecretsCreateOrUpdateResponse>

  • 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

    • callback: msRest.ServiceCallback<Secret>

      The callback

    Returns void

  • 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

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<Secret>

      The callback

    Returns void

get

  • get(resourceGroupName: string, vaultName: string, secretName: string, options?: msRest.RequestOptionsBase): Promise<Models.SecretsGetResponse>
  • get(resourceGroupName: string, vaultName: string, secretName: string, callback: msRest.ServiceCallback<Secret>): void
  • get(resourceGroupName: string, vaultName: string, secretName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<Secret>): void

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

    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.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.SecretsGetResponse>

    Promise<Models.SecretsGetResponse>

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

    • callback: msRest.ServiceCallback<Secret>

      The callback

    Returns void

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

      The optional parameters

    • callback: msRest.ServiceCallback<Secret>

      The callback

    Returns void

list

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

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

    Parameters

    • resourceGroupName: string

      The name of the Resource Group to which the vault belongs.

    • vaultName: string

      The name of the vault.

    • Optional options: Models.SecretsListOptionalParams

    Returns Promise<Models.SecretsListResponse>

    Promise<Models.SecretsListResponse>

  • Parameters

    • resourceGroupName: string

      The name of the Resource Group to which the vault belongs.

    • vaultName: string

      The name of the vault.

    • callback: msRest.ServiceCallback<SecretListResult>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the Resource Group to which the vault belongs.

    • vaultName: string

      The name of the vault.

    • options: SecretsListOptionalParams

      The optional parameters

    • callback: msRest.ServiceCallback<SecretListResult>

      The callback

    Returns void

listNext

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

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

    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<SecretListResult>

      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<SecretListResult>

      The callback

    Returns void

update

  • update(resourceGroupName: string, vaultName: string, secretName: string, parameters: SecretPatchParameters, options?: msRest.RequestOptionsBase): Promise<Models.SecretsUpdateResponse>
  • update(resourceGroupName: string, vaultName: string, secretName: string, parameters: SecretPatchParameters, callback: msRest.ServiceCallback<Secret>): void
  • update(resourceGroupName: string, vaultName: string, secretName: string, parameters: SecretPatchParameters, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<Secret>): void

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

    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

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.SecretsUpdateResponse>

    Promise<Models.SecretsUpdateResponse>

  • 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

    • callback: msRest.ServiceCallback<Secret>

      The callback

    Returns void

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

      The optional parameters

    • callback: msRest.ServiceCallback<Secret>

      The callback

    Returns void

Generated using TypeDoc