Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/keyvault-secrets

Package version

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

ApiVersion73

ApiVersion73: string

Defines values for ApiVersion73.
KnownApiVersion73 can be used interchangeably with ApiVersion73, this enum contains the known values that the service supports.

Known values supported by the service

7.3: Api Version '7.3'

BackupSecretResponse

BackupSecretResponse: BackupSecretResult

Contains response data for the backupSecret operation.

DeleteSecretResponse

DeleteSecretResponse: DeletedSecretBundle

Contains response data for the deleteSecret operation.

DeletedSecretBundle

DeletedSecretBundle: SecretBundle & { deletedDate?: Date; recoveryId?: undefined | string; scheduledPurgeDate?: Date }

A Deleted Secret consisting of its previous id, attributes and its tags, as well as information on when it will be purged.

DeletedSecretItem

DeletedSecretItem: SecretItem & { deletedDate?: Date; recoveryId?: undefined | string; scheduledPurgeDate?: Date }

The deleted secret item containing metadata about the deleted secret.

DeletionRecoveryLevel

DeletionRecoveryLevel: string

Defines values for DeletionRecoveryLevel.
KnownDeletionRecoveryLevel can be used interchangeably with DeletionRecoveryLevel, this enum contains the known values that the service supports.

Known values supported by the service

Purgeable: Denotes a vault state in which deletion is an irreversible operation, without the possibility for recovery. This level corresponds to no protection being available against a Delete operation; the data is irretrievably lost upon accepting a Delete operation at the entity level or higher (vault, resource group, subscription etc.)
Recoverable+Purgeable: Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days), unless a Purge operation is requested, or the subscription is cancelled. System wil permanently delete it after 90 days, if not recovered
Recoverable: Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval(90 days) and while the subscription is still available. System wil permanently delete it after 90 days, if not recovered
Recoverable+ProtectedSubscription: Denotes a vault and subscription state in which deletion is recoverable within retention interval (90 days), immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled. System wil permanently delete it after 90 days, if not recovered
CustomizedRecoverable+Purgeable: Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge when 7<= SoftDeleteRetentionInDays < 90). This level guarantees the recoverability of the deleted entity during the retention interval, unless a Purge operation is requested, or the subscription is cancelled.
CustomizedRecoverable: Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge when 7<= SoftDeleteRetentionInDays < 90).This level guarantees the recoverability of the deleted entity during the retention interval and while the subscription is still available.
CustomizedRecoverable+ProtectedSubscription: Denotes a vault and subscription state in which deletion is recoverable, immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled when 7<= SoftDeleteRetentionInDays < 90. This level guarantees the recoverability of the deleted entity during the retention interval, and also reflects the fact that the subscription itself cannot be cancelled.

GetDeletedSecretResponse

GetDeletedSecretResponse: DeletedSecretBundle

Contains response data for the getDeletedSecret operation.

GetDeletedSecretsNextResponse

GetDeletedSecretsNextResponse: DeletedSecretListResult

Contains response data for the getDeletedSecretsNext operation.

GetDeletedSecretsResponse

GetDeletedSecretsResponse: DeletedSecretListResult

Contains response data for the getDeletedSecrets operation.

GetSecretResponse

GetSecretResponse: SecretBundle

Contains response data for the getSecret operation.

GetSecretVersionsNextResponse

GetSecretVersionsNextResponse: SecretListResult

Contains response data for the getSecretVersionsNext operation.

GetSecretVersionsResponse

GetSecretVersionsResponse: SecretListResult

Contains response data for the getSecretVersions operation.

GetSecretsNextResponse

GetSecretsNextResponse: SecretListResult

Contains response data for the getSecretsNext operation.

GetSecretsResponse

GetSecretsResponse: SecretListResult

Contains response data for the getSecrets operation.

RecoverDeletedSecretResponse

RecoverDeletedSecretResponse: SecretBundle

Contains response data for the recoverDeletedSecret operation.

RestoreSecretResponse

RestoreSecretResponse: SecretBundle

Contains response data for the restoreSecret operation.

SecretAttributes

SecretAttributes: Attributes & { recoverableDays?: undefined | number; recoveryLevel?: DeletionRecoveryLevel }

The secret management attributes.

SetSecretResponse

SetSecretResponse: SecretBundle

Contains response data for the setSecret operation.

UpdateSecretResponse

UpdateSecretResponse: SecretBundle

Contains response data for the updateSecret operation.

Variables

Const LATEST_API_VERSION

LATEST_API_VERSION: "7.3" = "7.3"

The latest supported KeyVault service API version

Const SDK_VERSION

SDK_VERSION: string = "4.5.0-beta.1"

Const logger

logger: any = createClientLogger("keyvault-secrets")

The @azure/logger configuration for this package.

Const serializer

serializer: any = coreClient.createSerializer(Mappers, /* isXml */ false)

Const tracingClient

tracingClient: any = createTracingClient({namespace: "Microsoft.KeyVault",packageName: "@azure/keyvault-secrets",packageVersion: SDK_VERSION,})

Functions

parseKeyVaultSecretIdentifier

  • Parses the given Key Vault Secret Id. An example is:

    https://.vault.azure.net/secrets//

    On parsing the above Id, this function returns:

      {
     sourceId: "https://<keyvault-name>.vault.azure.net/secrets/<secret-name>/<unique-version-id>",
     vaultUrl: "https://<keyvault-name>.vault.azure.net",
     version: "<unique-version-id>",
     name: "<secret-name>"
  }

    Parameters

    • id: string

      The Id of the Key Vault Secret.

    Returns KeyVaultSecretIdentifier

parseKeyvaultIdentifier

parseWWWAuthenticate

  • parseWWWAuthenticate(wwwAuthenticate: string): ParsedWWWAuthenticate

  • Parses an WWW-Authenticate response. This transforms a string value like: Bearer authorization="https://some.url/tenantId", resource="https://some.url" into an object like: { authorization: "https://some.url/tenantId", resource: "https://some.url" }

    Parameters

    • wwwAuthenticate: string

      String value in the WWW-Authenticate header

    Returns ParsedWWWAuthenticate

Object literals

Const Attributes

Attributes: object

type

type: object

className

className: string = "Attributes"

name

name: string = "Composite"

modelProperties

modelProperties: object

created

created: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "created"

type

type: object

name

name: string = "UnixTime"

enabled

enabled: object

serializedName

serializedName: string = "enabled"

type

type: object

name

name: string = "Boolean"

expires

expires: object

serializedName

serializedName: string = "exp"

type

type: object

name

name: string = "UnixTime"

notBefore

notBefore: object

serializedName

serializedName: string = "nbf"

type

type: object

name

name: string = "UnixTime"

updated

updated: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "updated"

type

type: object

name

name: string = "UnixTime"

Const BackupSecretResult

BackupSecretResult: object

type

type: object

className

className: string = "BackupSecretResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

value

value: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "value"

type

type: object

name

name: string = "Base64Url"

Const DeletedSecretBundle

DeletedSecretBundle: object

type

type: object

className

className: string = "DeletedSecretBundle"

name

name: string = "Composite"

modelProperties

modelProperties: object

deletedDate

deletedDate: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "deletedDate"

type

type: object

name

name: string = "UnixTime"

recoveryId

recoveryId: object

serializedName

serializedName: string = "recoveryId"

type

type: object

name

name: string = "String"

scheduledPurgeDate

scheduledPurgeDate: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "scheduledPurgeDate"

type

type: object

name

name: string = "UnixTime"

Const DeletedSecretItem

DeletedSecretItem: object

type

type: object

className

className: string = "DeletedSecretItem"

name

name: string = "Composite"

modelProperties

modelProperties: object

deletedDate

deletedDate: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "deletedDate"

type

type: object

name

name: string = "UnixTime"

recoveryId

recoveryId: object

serializedName

serializedName: string = "recoveryId"

type

type: object

name

name: string = "String"

scheduledPurgeDate

scheduledPurgeDate: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "scheduledPurgeDate"

type

type: object

name

name: string = "UnixTime"

Const DeletedSecretListResult

DeletedSecretListResult: object

type

type: object

className

className: string = "DeletedSecretListResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: string = "String"

value

value: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "value"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "DeletedSecretItem"

name

name: string = "Composite"

Const ErrorModel

ErrorModel: object

type

type: object

className

className: string = "ErrorModel"

name

name: string = "Composite"

modelProperties

modelProperties: object

code

code: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "code"

type

type: object

name

name: string = "String"

innerError

innerError: object

serializedName

serializedName: string = "innererror"

type

type: object

className

className: string = "ErrorModel"

name

name: string = "Composite"

message

message: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "message"

type

type: object

name

name: string = "String"

Const KeyVaultError

KeyVaultError: object

type

type: object

className

className: string = "KeyVaultError"

name

name: string = "Composite"

modelProperties

modelProperties: object

error

error: object

serializedName

serializedName: string = "error"

type

type: object

className

className: string = "ErrorModel"

name

name: string = "Composite"

Const SecretAttributes

SecretAttributes: object

type

type: object

className

className: string = "SecretAttributes"

name

name: string = "Composite"

modelProperties

modelProperties: object

recoverableDays

recoverableDays: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "recoverableDays"

type

type: object

name

name: string = "Number"

recoveryLevel

recoveryLevel: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "recoveryLevel"

type

type: object

name

name: string = "String"

Const SecretBundle

SecretBundle: object

type

type: object

className

className: string = "SecretBundle"

name

name: string = "Composite"

modelProperties

modelProperties: object

attributes

attributes: object

serializedName

serializedName: string = "attributes"

type

type: object

className

className: string = "SecretAttributes"

name

name: string = "Composite"

contentType

contentType: object

serializedName

serializedName: string = "contentType"

type

type: object

name

name: string = "String"

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: string = "String"

kid

kid: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "kid"

type

type: object

name

name: string = "String"

managed

managed: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "managed"

type

type: object

name

name: string = "Boolean"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: string = "Dictionary"

value

value: object

type

type: object

name

name: string = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: string = "String"

Const SecretItem

SecretItem: object

type

type: object

className

className: string = "SecretItem"

name

name: string = "Composite"

modelProperties

modelProperties: object

attributes

attributes: object

serializedName

serializedName: string = "attributes"

type

type: object

className

className: string = "SecretAttributes"

name

name: string = "Composite"

contentType

contentType: object

serializedName

serializedName: string = "contentType"

type

type: object

name

name: string = "String"

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: string = "String"

managed

managed: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "managed"

type

type: object

name

name: string = "Boolean"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: string = "Dictionary"

value

value: object

type

type: object

name

name: string = "String"

Const SecretListResult

SecretListResult: object

type

type: object

className

className: string = "SecretListResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: string = "String"

value

value: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "value"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "SecretItem"

name

name: string = "Composite"

Const SecretProperties

SecretProperties: object

type

type: object

className

className: string = "SecretProperties"

name

name: string = "Composite"

modelProperties

modelProperties: object

contentType

contentType: object

serializedName

serializedName: string = "contentType"

type

type: object

name

name: string = "String"

Const SecretRestoreParameters

SecretRestoreParameters: object

type

type: object

className

className: string = "SecretRestoreParameters"

name

name: string = "Composite"

modelProperties

modelProperties: object

secretBundleBackup

secretBundleBackup: object

required

required: boolean = true

serializedName

serializedName: string = "value"

type

type: object

name

name: string = "Base64Url"

Const SecretSetParameters

SecretSetParameters: object

type

type: object

className

className: string = "SecretSetParameters"

name

name: string = "Composite"

modelProperties

modelProperties: object

contentType

contentType: object

serializedName

serializedName: string = "contentType"

type

type: object

name

name: string = "String"

secretAttributes

secretAttributes: object

serializedName

serializedName: string = "attributes"

type

type: object

className

className: string = "SecretAttributes"

name

name: string = "Composite"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: string = "Dictionary"

value

value: object

type

type: object

name

name: string = "String"

value

value: object

required

required: boolean = true

serializedName

serializedName: string = "value"

type

type: object

name

name: string = "String"

Const SecretUpdateParameters

SecretUpdateParameters: object

type

type: object

className

className: string = "SecretUpdateParameters"

name

name: string = "Composite"

modelProperties

modelProperties: object

contentType

contentType: object

serializedName

serializedName: string = "contentType"

type

type: object

name

name: string = "String"

secretAttributes

secretAttributes: object

serializedName

serializedName: string = "attributes"

type

type: object

className

className: string = "SecretAttributes"

name

name: string = "Composite"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: string = "Dictionary"

value

value: object

type

type: object

name

name: string = "String"

Const accept

accept: object

parameterPath

parameterPath: string = "accept"

mapper

mapper: object

defaultValue

defaultValue: string = "application/json"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "Accept"

type

type: object

name

name: string = "String"

Const apiVersion

apiVersion: object

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: string = "String"

Const backupSecretOperationSpec

backupSecretOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "POST"

path

path: string = "/secrets/{secret-name}/backup"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.vaultBaseUrl, Parameters.secretName1]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.BackupSecretResult

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const contentType

contentType: object

parameterPath

parameterPath: string[] = ["options", "contentType"]

mapper

mapper: object

defaultValue

defaultValue: string = "application/json"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "Content-Type"

type

type: object

name

name: string = "String"

Const contentType1

contentType1: object

mapper

mapper: any = SecretSetParametersMapper

parameterPath

parameterPath: string[] = ["options", "contentType"]

Const contentType2

contentType2: object

mapper

mapper: any = SecretUpdateParametersMapper

parameterPath

parameterPath: string[] = ["options", "contentType"]

Const deleteSecretOperationSpec

deleteSecretOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "DELETE"

path

path: string = "/secrets/{secret-name}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.vaultBaseUrl, Parameters.secretName1]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.DeletedSecretBundle

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const getDeletedSecretOperationSpec

getDeletedSecretOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/deletedsecrets/{secret-name}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.vaultBaseUrl, Parameters.secretName1]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.DeletedSecretBundle

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const getDeletedSecretsNextOperationSpec

getDeletedSecretsNextOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "{nextLink}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion, Parameters.maxresults]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.vaultBaseUrl, Parameters.nextLink]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.DeletedSecretListResult

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const getDeletedSecretsOperationSpec

getDeletedSecretsOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/deletedsecrets"

queryParameters

queryParameters: any[] = [Parameters.apiVersion, Parameters.maxresults]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.vaultBaseUrl]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.DeletedSecretListResult

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const getSecretOperationSpec

getSecretOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/secrets/{secret-name}/{secret-version}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.vaultBaseUrl,Parameters.secretName1,Parameters.secretVersion]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.SecretBundle

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const getSecretVersionsNextOperationSpec

getSecretVersionsNextOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "{nextLink}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion, Parameters.maxresults]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.vaultBaseUrl,Parameters.secretName1,Parameters.nextLink]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.SecretListResult

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const getSecretVersionsOperationSpec

getSecretVersionsOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/secrets/{secret-name}/versions"

queryParameters

queryParameters: any[] = [Parameters.apiVersion, Parameters.maxresults]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.vaultBaseUrl, Parameters.secretName1]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.SecretListResult

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const getSecretsNextOperationSpec

getSecretsNextOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "{nextLink}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion, Parameters.maxresults]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.vaultBaseUrl, Parameters.nextLink]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.SecretListResult

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const getSecretsOperationSpec

getSecretsOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/secrets"

queryParameters

queryParameters: any[] = [Parameters.apiVersion, Parameters.maxresults]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.vaultBaseUrl]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.SecretListResult

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const maxresults

maxresults: object

parameterPath

parameterPath: string[] = ["options", "maxresults"]

mapper

mapper: object

serializedName

serializedName: string = "maxresults"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 25

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

name: string = "Number"

Const nextLink

nextLink: object

parameterPath

parameterPath: string = "nextLink"

skipEncoding

skipEncoding: boolean = true

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: string = "String"

Const purgeDeletedSecretOperationSpec

purgeDeletedSecretOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "DELETE"

path

path: string = "/deletedsecrets/{secret-name}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.vaultBaseUrl, Parameters.secretName1]

responses

responses: object

204

204: {}

Type declaration

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const recoverDeletedSecretOperationSpec

recoverDeletedSecretOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "POST"

path

path: string = "/deletedsecrets/{secret-name}/recover"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.vaultBaseUrl, Parameters.secretName1]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.SecretBundle

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const restoreSecretOperationSpec

restoreSecretOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.contentType, Parameters.accept]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/secrets/restore"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.vaultBaseUrl]

requestBody

requestBody: object

mapper

mapper: object

required

required: boolean = true

parameterPath

parameterPath: object

secretBundleBackup

secretBundleBackup: string[] = ["secretBundleBackup"]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.SecretBundle

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const secretAttributes

secretAttributes: object

mapper

mapper: any = SecretSetParametersMapper

parameterPath

parameterPath: string[] = ["options", "secretAttributes"]

Const secretAttributes1

secretAttributes1: object

mapper

mapper: any = SecretUpdateParametersMapper

parameterPath

parameterPath: string[] = ["options", "secretAttributes"]

Const secretBundleBackup

secretBundleBackup: object

mapper

mapper: any = SecretRestoreParametersMapper

parameterPath

parameterPath: string = "secretBundleBackup"

Const secretName

secretName: object

parameterPath

parameterPath: string = "secretName"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "secret-name"

constraints

constraints: object

Pattern

Pattern: any = new RegExp("^[0-9a-zA-Z-]+$")

type

type: object

name

name: string = "String"

Const secretName1

secretName1: object

parameterPath

parameterPath: string = "secretName"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "secret-name"

type

type: object

name

name: string = "String"

Const secretVersion

secretVersion: object

parameterPath

parameterPath: string = "secretVersion"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "secret-version"

type

type: object

name

name: string = "String"

Const setSecretOperationSpec

setSecretOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.contentType, Parameters.accept]

httpMethod

httpMethod: string = "PUT"

mediaType

mediaType: string = "json"

path

path: string = "/secrets/{secret-name}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.vaultBaseUrl, Parameters.secretName]

requestBody

requestBody: object

mapper

mapper: object

required

required: boolean = true

parameterPath

parameterPath: object

contentType

contentType: string[] = ["options", "contentType"]

secretAttributes

secretAttributes: string[] = ["options", "secretAttributes"]

tags

tags: string[] = ["options", "tags"]

value

value: string[] = ["value"]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.SecretBundle

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const tags

tags: object

mapper

mapper: any = SecretSetParametersMapper

parameterPath

parameterPath: string[] = ["options", "tags"]

Const tags1

tags1: object

mapper

mapper: any = SecretUpdateParametersMapper

parameterPath

parameterPath: string[] = ["options", "tags"]

Const updateSecretOperationSpec

updateSecretOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.contentType, Parameters.accept]

httpMethod

httpMethod: string = "PATCH"

mediaType

mediaType: string = "json"

path

path: string = "/secrets/{secret-name}/{secret-version}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.vaultBaseUrl,Parameters.secretName1,Parameters.secretVersion]

requestBody

requestBody: object

mapper

mapper: object

required

required: boolean = true

parameterPath

parameterPath: object

contentType

contentType: string[] = ["options", "contentType"]

secretAttributes

secretAttributes: string[] = ["options", "secretAttributes"]

tags

tags: string[] = ["options", "tags"]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.SecretBundle

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const value

value: object

mapper

mapper: any = SecretSetParametersMapper

parameterPath

parameterPath: string = "value"

Const vaultBaseUrl

vaultBaseUrl: object

parameterPath

parameterPath: string = "vaultBaseUrl"

skipEncoding

skipEncoding: boolean = true

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "vaultBaseUrl"

type

type: object

name

name: string = "String"

Generated using TypeDoc