Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/keyvault-keys

Package version

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

ActionType

ActionType: "Rotate" | "Notify"

Defines values for ActionType.

AesCbcEncryptionAlgorithm

AesCbcEncryptionAlgorithm: "A128CBC" | "A192CBC" | "A256CBC" | "A128CBCPAD" | "A192CBCPAD" | "A256CBCPAD"

A union type representing all supported AES-CBC encryption algorithms.

AesGcmEncryptionAlgorithm

AesGcmEncryptionAlgorithm: "A128GCM" | "A192GCM" | "A256GCM"

A union type representing all supported AES-GCM encryption algorithms.

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'

BackupKeyResponse

BackupKeyResponse: BackupKeyResult

Contains response data for the backupKey operation.

CreateKeyResponse

CreateKeyResponse: KeyBundle

Contains response data for the createKey operation.

CryptographyClientKey

CryptographyClientKey: { kind: "identifier"; value: string } | { kind: "KeyVaultKey"; value: KeyVaultKey } | { kind: "JsonWebKey"; value: JsonWebKey }

The various key types a CryptographyClient can hold. The key may be an identifier (URL) to a KeyVault key, the actual KeyVault key, or a local-only JsonWebKey.

If an identifier is used, it will be exchanged for a KeyVaultKey during the first operation call.

DecryptParameters

DecryptParameters: RsaDecryptParameters | AesGcmDecryptParameters | AesCbcDecryptParameters

A type representing all currently supported decryption parameters as they apply to different encryption algorithms.

DecryptResponse

DecryptResponse: KeyOperationResult

Contains response data for the decrypt operation.

DeleteKeyResponse

DeleteKeyResponse: DeletedKeyBundle

Contains response data for the deleteKey operation.

DeletedKeyBundle

DeletedKeyBundle: KeyBundle & { deletedDate?: Date; recoveryId?: undefined | string; scheduledPurgeDate?: Date }

A DeletedKeyBundle consisting of a WebKey plus its Attributes and deletion info

DeletedKeyItem

DeletedKeyItem: KeyItem & { deletedDate?: Date; recoveryId?: undefined | string; scheduledPurgeDate?: Date }

The deleted key item containing the deleted key metadata and information about deletion.

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.

EncryptParameters

EncryptParameters: RsaEncryptParameters | AesGcmEncryptParameters | AesCbcEncryptParameters

A type representing all currently supported encryption parameters as they apply to different encryption algorithms.

EncryptResponse

EncryptResponse: KeyOperationResult

Contains response data for the encrypt operation.

GetDeletedKeyResponse

GetDeletedKeyResponse: DeletedKeyBundle

Contains response data for the getDeletedKey operation.

GetDeletedKeysNextResponse

GetDeletedKeysNextResponse: DeletedKeyListResult

Contains response data for the getDeletedKeysNext operation.

GetDeletedKeysResponse

GetDeletedKeysResponse: DeletedKeyListResult

Contains response data for the getDeletedKeys operation.

GetKeyResponse

GetKeyResponse: KeyBundle

Contains response data for the getKey operation.

GetKeyRotationPolicyResponse

GetKeyRotationPolicyResponse: KeyRotationPolicy

Contains response data for the getKeyRotationPolicy operation.

GetKeyVersionsNextResponse

GetKeyVersionsNextResponse: KeyListResult

Contains response data for the getKeyVersionsNext operation.

GetKeyVersionsResponse

GetKeyVersionsResponse: KeyListResult

Contains response data for the getKeyVersions operation.

GetKeysNextResponse

GetKeysNextResponse: KeyListResult

Contains response data for the getKeysNext operation.

GetKeysResponse

GetKeysResponse: KeyListResult

Contains response data for the getKeys operation.

GetRandomBytesResponse

GetRandomBytesResponse: RandomBytes

Contains response data for the getRandomBytes operation.

ImportKeyResponse

ImportKeyResponse: KeyBundle

Contains response data for the importKey operation.

JsonWebKeyCurveName

JsonWebKeyCurveName: string

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

Known values supported by the service

P-256: The NIST P-256 elliptic curve, AKA SECG curve SECP256R1.
P-384: The NIST P-384 elliptic curve, AKA SECG curve SECP384R1.
P-521: The NIST P-521 elliptic curve, AKA SECG curve SECP521R1.
P-256K: The SECG SECP256K1 elliptic curve.

JsonWebKeyEncryptionAlgorithm

JsonWebKeyEncryptionAlgorithm: string

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

Known values supported by the service

RSA-OAEP
RSA-OAEP-256
RSA1_5
A128GCM
A192GCM
A256GCM
A128KW
A192KW
A256KW
A128CBC
A192CBC
A256CBC
A128CBCPAD
A192CBCPAD
A256CBCPAD

JsonWebKeyOperation

JsonWebKeyOperation: string

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

Known values supported by the service

encrypt
decrypt
sign
verify
wrapKey
unwrapKey
import
export

JsonWebKeySignatureAlgorithm

JsonWebKeySignatureAlgorithm: string

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

Known values supported by the service

PS256: RSASSA-PSS using SHA-256 and MGF1 with SHA-256, as described in https://tools.ietf.org/html/rfc7518
PS384: RSASSA-PSS using SHA-384 and MGF1 with SHA-384, as described in https://tools.ietf.org/html/rfc7518
PS512: RSASSA-PSS using SHA-512 and MGF1 with SHA-512, as described in https://tools.ietf.org/html/rfc7518
RS256: RSASSA-PKCS1-v1_5 using SHA-256, as described in https://tools.ietf.org/html/rfc7518
RS384: RSASSA-PKCS1-v1_5 using SHA-384, as described in https://tools.ietf.org/html/rfc7518
RS512: RSASSA-PKCS1-v1_5 using SHA-512, as described in https://tools.ietf.org/html/rfc7518
RSNULL: Reserved
ES256: ECDSA using P-256 and SHA-256, as described in https://tools.ietf.org/html/rfc7518.
ES384: ECDSA using P-384 and SHA-384, as described in https://tools.ietf.org/html/rfc7518
ES512: ECDSA using P-521 and SHA-512, as described in https://tools.ietf.org/html/rfc7518
ES256K: ECDSA using P-256K and SHA-256, as described in https://tools.ietf.org/html/rfc7518

JsonWebKeyType

JsonWebKeyType: string

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

Known values supported by the service

EC: Elliptic Curve.
EC-HSM: Elliptic Curve with a private key which is stored in the HSM.
RSA: RSA (https://tools.ietf.org/html/rfc3447)
RSA-HSM: RSA with a private key which is stored in the HSM.
oct: Octet sequence (used to represent symmetric keys)
oct-HSM: Octet sequence (used to represent symmetric keys) which is stored the HSM.

KeyAttributes

KeyAttributes: Attributes & { exportable?: undefined | false | true; recoverableDays?: undefined | number; recoveryLevel?: DeletionRecoveryLevel }

The attributes of a key managed by the key vault service.

KeyEncryptionAlgorithm

KeyEncryptionAlgorithm: string

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

Known values supported by the service

CKM_RSA_AES_KEY_WRAP
RSA_AES_KEY_WRAP_256
RSA_AES_KEY_WRAP_384

KeyExportEncryptionAlgorithm

KeyExportEncryptionAlgorithm: string

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

Known values supported by the service

CKM_RSA_AES_KEY_WRAP
RSA_AES_KEY_WRAP_256
RSA_AES_KEY_WRAP_384

KeyRotationPolicyAction

KeyRotationPolicyAction: "Rotate" | "Notify"

The action that will be executed.

KeyWrapAlgorithm

KeyWrapAlgorithm: "A128KW" | "A192KW" | "A256KW" | "RSA-OAEP" | "RSA-OAEP-256" | "RSA1_5"

Supported algorithms for key wrapping/unwrapping

RecoverDeletedKeyResponse

RecoverDeletedKeyResponse: KeyBundle

Contains response data for the recoverDeletedKey operation.

ReleaseResponse

ReleaseResponse: KeyReleaseResult

Contains response data for the release operation.

RestoreKeyResponse

RestoreKeyResponse: KeyBundle

Contains response data for the restoreKey operation.

RotateKeyResponse

RotateKeyResponse: KeyBundle

Contains response data for the rotateKey operation.

RsaEncryptionAlgorithm

RsaEncryptionAlgorithm: "RSA1_5" | "RSA-OAEP" | "RSA-OAEP-256"

A union type representing all supported RSA encryption algorithms.

SignResponse

SignResponse: KeyOperationResult

Contains response data for the sign operation.

UnwrapKeyResponse

UnwrapKeyResponse: KeyOperationResult

Contains response data for the unwrapKey operation.

UpdateKeyResponse

UpdateKeyResponse: KeyBundle

Contains response data for the updateKey operation.

UpdateKeyRotationPolicyResponse

UpdateKeyRotationPolicyResponse: KeyRotationPolicy

Contains response data for the updateKeyRotationPolicy operation.

VerifyResponse

VerifyResponse: KeyVerifyResult

Contains response data for the verify operation.

WrapKeyResponse

WrapKeyResponse: KeyOperationResult

Contains response data for the wrapKey operation.

Variables

Const LATEST_API_VERSION

LATEST_API_VERSION: "7.3" = "7.3"

The latest supported Key Vault service API version

Const SDK_VERSION

SDK_VERSION: string = "4.5.0-beta.1"

Const logger

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

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-keys",packageVersion: SDK_VERSION,})

Functions

formatBase64Sequence

  • formatBase64Sequence(base64Sequence: string): string

  • Fill in the PEM with 64 character lines as per RFC:

    "To represent the encapsulated text of a PEM message, the encoding function's output is delimited into text lines (using local conventions), with each line except the last containing exactly 64 printable characters and the final line containing 64 or fewer printable characters."

    Parameters

    • base64Sequence: string

    Returns string

makeSequence

  • makeSequence(encodedParts: Uint8Array[]): string

parseKeyVaultKeyIdentifier

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

    https://.vault.azure.net/keys//

    On parsing the above Id, this function returns:

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

    Parameters

    • id: string

      The Id of the Key Vault Key.

    Returns KeyVaultKeyIdentifier

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 BackupKeyResult

BackupKeyResult: object

type

type: object

className

className: string = "BackupKeyResult"

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 DeletedKeyBundle

DeletedKeyBundle: object

type

type: object

className

className: string = "DeletedKeyBundle"

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 DeletedKeyItem

DeletedKeyItem: object

type

type: object

className

className: string = "DeletedKeyItem"

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 DeletedKeyListResult

DeletedKeyListResult: object

type

type: object

className

className: string = "DeletedKeyListResult"

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 = "DeletedKeyItem"

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 GetRandomBytesRequest

GetRandomBytesRequest: object

type

type: object

className

className: string = "GetRandomBytesRequest"

name

name: string = "Composite"

modelProperties

modelProperties: object

count

count: object

required

required: boolean = true

serializedName

serializedName: string = "count"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 128

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

name: string = "Number"

Const JsonWebKey

JsonWebKey: object

type

type: object

className

className: string = "JsonWebKey"

name

name: string = "Composite"

modelProperties

modelProperties: object

crv

crv: object

serializedName

serializedName: string = "crv"

type

type: object

name

name: string = "String"

d

d: object

serializedName

serializedName: string = "d"

type

type: object

name

name: string = "Base64Url"

dp

dp: object

serializedName

serializedName: string = "dp"

type

type: object

name

name: string = "Base64Url"

dq

dq: object

serializedName

serializedName: string = "dq"

type

type: object

name

name: string = "Base64Url"

e

e: object

serializedName

serializedName: string = "e"

type

type: object

name

name: string = "Base64Url"

k

k: object

serializedName

serializedName: string = "k"

type

type: object

name

name: string = "Base64Url"

keyOps

keyOps: object

serializedName

serializedName: string = "key_ops"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

kid

kid: object

serializedName

serializedName: string = "kid"

type

type: object

name

name: string = "String"

kty

kty: object

serializedName

serializedName: string = "kty"

type

type: object

name

name: string = "String"

n

n: object

serializedName

serializedName: string = "n"

type

type: object

name

name: string = "Base64Url"

p

p: object

serializedName

serializedName: string = "p"

type

type: object

name

name: string = "Base64Url"

q

q: object

serializedName

serializedName: string = "q"

type

type: object

name

name: string = "Base64Url"

qi

qi: object

serializedName

serializedName: string = "qi"

type

type: object

name

name: string = "Base64Url"

t

t: object

serializedName

serializedName: string = "key_hsm"

type

type: object

name

name: string = "Base64Url"

x

x: object

serializedName

serializedName: string = "x"

type

type: object

name

name: string = "Base64Url"

y

y: object

serializedName

serializedName: string = "y"

type

type: object

name

name: string = "Base64Url"

Const KeyAttributes

KeyAttributes: object

type

type: object

className

className: string = "KeyAttributes"

name

name: string = "Composite"

modelProperties

modelProperties: object

exportable

exportable: object

serializedName

serializedName: string = "exportable"

type

type: object

name

name: string = "Boolean"

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 KeyBundle

KeyBundle: object

type

type: object

className

className: string = "KeyBundle"

name

name: string = "Composite"

modelProperties

modelProperties: object

attributes

attributes: object

serializedName

serializedName: string = "attributes"

type

type: object

className

className: string = "KeyAttributes"

name

name: string = "Composite"

key

key: object

serializedName

serializedName: string = "key"

type

type: object

className

className: string = "JsonWebKey"

name

name: string = "Composite"

managed

managed: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "managed"

type

type: object

name

name: string = "Boolean"

releasePolicy

releasePolicy: object

serializedName

serializedName: string = "release_policy"

type

type: object

className

className: string = "KeyReleasePolicy"

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 KeyCreateParameters

KeyCreateParameters: object

type

type: object

className

className: string = "KeyCreateParameters"

name

name: string = "Composite"

modelProperties

modelProperties: object

curve

curve: object

serializedName

serializedName: string = "crv"

type

type: object

name

name: string = "String"

keyAttributes

keyAttributes: object

serializedName

serializedName: string = "attributes"

type

type: object

className

className: string = "KeyAttributes"

name

name: string = "Composite"

keyOps

keyOps: object

serializedName

serializedName: string = "key_ops"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

keySize

keySize: object

serializedName

serializedName: string = "key_size"

type

type: object

name

name: string = "Number"

kty

kty: object

required

required: boolean = true

serializedName

serializedName: string = "kty"

type

type: object

name

name: string = "String"

publicExponent

publicExponent: object

serializedName

serializedName: string = "public_exponent"

type

type: object

name

name: string = "Number"

releasePolicy

releasePolicy: object

serializedName

serializedName: string = "release_policy"

type

type: object

className

className: string = "KeyReleasePolicy"

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 KeyExportParameters

KeyExportParameters: object

type

type: object

className

className: string = "KeyExportParameters"

name

name: string = "Composite"

modelProperties

modelProperties: object

enc

enc: object

serializedName

serializedName: string = "enc"

type

type: object

name

name: string = "String"

wrappingKey

wrappingKey: object

serializedName

serializedName: string = "wrappingKey"

type

type: object

className

className: string = "JsonWebKey"

name

name: string = "Composite"

wrappingKid

wrappingKid: object

serializedName

serializedName: string = "wrappingKid"

type

type: object

name

name: string = "String"

Const KeyImportParameters

KeyImportParameters: object

type

type: object

className

className: string = "KeyImportParameters"

name

name: string = "Composite"

modelProperties

modelProperties: object

hsm

hsm: object

serializedName

serializedName: string = "Hsm"

type

type: object

name

name: string = "Boolean"

key

key: object

serializedName

serializedName: string = "key"

type

type: object

className

className: string = "JsonWebKey"

name

name: string = "Composite"

keyAttributes

keyAttributes: object

serializedName

serializedName: string = "attributes"

type

type: object

className

className: string = "KeyAttributes"

name

name: string = "Composite"

releasePolicy

releasePolicy: object

serializedName

serializedName: string = "release_policy"

type

type: object

className

className: string = "KeyReleasePolicy"

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 KeyItem

KeyItem: object

type

type: object

className

className: string = "KeyItem"

name

name: string = "Composite"

modelProperties

modelProperties: object

attributes

attributes: object

serializedName

serializedName: string = "attributes"

type

type: object

className

className: string = "KeyAttributes"

name

name: string = "Composite"

kid

kid: object

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"

Const KeyListResult

KeyListResult: object

type

type: object

className

className: string = "KeyListResult"

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 = "KeyItem"

name

name: string = "Composite"

Const KeyOperationResult

KeyOperationResult: object

type

type: object

className

className: string = "KeyOperationResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

additionalAuthenticatedData

additionalAuthenticatedData: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "aad"

type

type: object

name

name: string = "Base64Url"

authenticationTag

authenticationTag: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "tag"

type

type: object

name

name: string = "Base64Url"

iv

iv: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "iv"

type

type: object

name

name: string = "Base64Url"

kid

kid: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "kid"

type

type: object

name

name: string = "String"

result

result: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "value"

type

type: object

name

name: string = "Base64Url"

Const KeyOperationsParameters

KeyOperationsParameters: object

type

type: object

className

className: string = "KeyOperationsParameters"

name

name: string = "Composite"

modelProperties

modelProperties: object

additionalAuthenticatedData

additionalAuthenticatedData: object

serializedName

serializedName: string = "aad"

type

type: object

name

name: string = "Base64Url"

algorithm

algorithm: object

required

required: boolean = true

serializedName

serializedName: string = "alg"

type

type: object

name

name: string = "String"

authenticationTag

authenticationTag: object

serializedName

serializedName: string = "tag"

type

type: object

name

name: string = "Base64Url"

iv

iv: object

serializedName

serializedName: string = "iv"

type

type: object

name

name: string = "Base64Url"

value

value: object

required

required: boolean = true

serializedName

serializedName: string = "value"

type

type: object

name

name: string = "Base64Url"

Const KeyProperties

KeyProperties: object

type

type: object

className

className: string = "KeyProperties"

name

name: string = "Composite"

modelProperties

modelProperties: object

curve

curve: object

serializedName

serializedName: string = "crv"

type

type: object

name

name: string = "String"

exportable

exportable: object

serializedName

serializedName: string = "exportable"

type

type: object

name

name: string = "Boolean"

keySize

keySize: object

serializedName

serializedName: string = "key_size"

type

type: object

name

name: string = "Number"

keyType

keyType: object

serializedName

serializedName: string = "kty"

type

type: object

name

name: string = "String"

reuseKey

reuseKey: object

serializedName

serializedName: string = "reuse_key"

type

type: object

name

name: string = "Boolean"

Const KeyReleaseParameters

KeyReleaseParameters: object

type

type: object

className

className: string = "KeyReleaseParameters"

name

name: string = "Composite"

modelProperties

modelProperties: object

enc

enc: object

serializedName

serializedName: string = "enc"

type

type: object

name

name: string = "String"

nonce

nonce: object

serializedName

serializedName: string = "nonce"

type

type: object

name

name: string = "String"

targetAttestationToken

targetAttestationToken: object

required

required: boolean = true

serializedName

serializedName: string = "target"

constraints

constraints: object

MinLength

MinLength: number = 1

type

type: object

name

name: string = "String"

Const KeyReleasePolicy

KeyReleasePolicy: object

type

type: object

className

className: string = "KeyReleasePolicy"

name

name: string = "Composite"

modelProperties

modelProperties: object

contentType

contentType: object

defaultValue

defaultValue: string = "application/json; charset=utf-8"

serializedName

serializedName: string = "contentType"

type

type: object

name

name: string = "String"

encodedPolicy

encodedPolicy: object

serializedName

serializedName: string = "data"

type

type: object

name

name: string = "Base64Url"

immutable

immutable: object

serializedName

serializedName: string = "immutable"

type

type: object

name

name: string = "Boolean"

Const KeyReleaseResult

KeyReleaseResult: object

type

type: object

className

className: string = "KeyReleaseResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

value

value: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "value"

type

type: object

name

name: string = "String"

Const KeyRestoreParameters

KeyRestoreParameters: object

type

type: object

className

className: string = "KeyRestoreParameters"

name

name: string = "Composite"

modelProperties

modelProperties: object

keyBundleBackup

keyBundleBackup: object

required

required: boolean = true

serializedName

serializedName: string = "value"

type

type: object

name

name: string = "Base64Url"

Const KeyRotationPolicy

KeyRotationPolicy: object

type

type: object

className

className: string = "KeyRotationPolicy"

name

name: string = "Composite"

modelProperties

modelProperties: object

attributes

attributes: object

serializedName

serializedName: string = "attributes"

type

type: object

className

className: string = "KeyRotationPolicyAttributes"

name

name: string = "Composite"

id

id: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "id"

type

type: object

name

name: string = "String"

lifetimeActions

lifetimeActions: object

serializedName

serializedName: string = "lifetimeActions"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "LifetimeActions"

name

name: string = "Composite"

Const KeyRotationPolicyAttributes

KeyRotationPolicyAttributes: object

type

type: object

className

className: string = "KeyRotationPolicyAttributes"

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"

expiryTime

expiryTime: object

serializedName

serializedName: string = "expiryTime"

type

type: object

name

name: string = "String"

updated

updated: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "updated"

type

type: object

name

name: string = "UnixTime"

Const KeySignParameters

KeySignParameters: object

type

type: object

className

className: string = "KeySignParameters"

name

name: string = "Composite"

modelProperties

modelProperties: object

algorithm

algorithm: object

required

required: boolean = true

serializedName

serializedName: string = "alg"

type

type: object

name

name: string = "String"

value

value: object

required

required: boolean = true

serializedName

serializedName: string = "value"

type

type: object

name

name: string = "Base64Url"

Const KeyUpdateParameters

KeyUpdateParameters: object

type

type: object

className

className: string = "KeyUpdateParameters"

name

name: string = "Composite"

modelProperties

modelProperties: object

keyAttributes

keyAttributes: object

serializedName

serializedName: string = "attributes"

type

type: object

className

className: string = "KeyAttributes"

name

name: string = "Composite"

keyOps

keyOps: object

serializedName

serializedName: string = "key_ops"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

releasePolicy

releasePolicy: object

serializedName

serializedName: string = "release_policy"

type

type: object

className

className: string = "KeyReleasePolicy"

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

KeyVerifyParameters: object

type

type: object

className

className: string = "KeyVerifyParameters"

name

name: string = "Composite"

modelProperties

modelProperties: object

algorithm

algorithm: object

required

required: boolean = true

serializedName

serializedName: string = "alg"

type

type: object

name

name: string = "String"

digest

digest: object

required

required: boolean = true

serializedName

serializedName: string = "digest"

type

type: object

name

name: string = "Base64Url"

signature

signature: object

required

required: boolean = true

serializedName

serializedName: string = "value"

type

type: object

name

name: string = "Base64Url"

Const KeyVerifyResult

KeyVerifyResult: object

type

type: object

className

className: string = "KeyVerifyResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

value

value: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "value"

type

type: object

name

name: string = "Boolean"

Const LifetimeActions

LifetimeActions: object

type

type: object

className

className: string = "LifetimeActions"

name

name: string = "Composite"

modelProperties

modelProperties: object

action

action: object

serializedName

serializedName: string = "action"

type

type: object

className

className: string = "LifetimeActionsType"

name

name: string = "Composite"

trigger

trigger: object

serializedName

serializedName: string = "trigger"

type

type: object

className

className: string = "LifetimeActionsTrigger"

name

name: string = "Composite"

Const LifetimeActionsTrigger

LifetimeActionsTrigger: object

type

type: object

className

className: string = "LifetimeActionsTrigger"

name

name: string = "Composite"

modelProperties

modelProperties: object

timeAfterCreate

timeAfterCreate: object

serializedName

serializedName: string = "timeAfterCreate"

type

type: object

name

name: string = "String"

timeBeforeExpiry

timeBeforeExpiry: object

serializedName

serializedName: string = "timeBeforeExpiry"

type

type: object

name

name: string = "String"

Const LifetimeActionsType

LifetimeActionsType: object

type

type: object

className

className: string = "LifetimeActionsType"

name

name: string = "Composite"

modelProperties

modelProperties: object

type

type: object

serializedName

serializedName: string = "type"

type

type: object

allowedValues

allowedValues: string[] = ["Rotate", "Notify"]

name

name: string = "Enum"

Const RandomBytes

RandomBytes: object

type

type: object

className

className: string = "RandomBytes"

name

name: string = "Composite"

modelProperties

modelProperties: object

value

value: object

required

required: boolean = true

serializedName

serializedName: string = "value"

type

type: object

name

name: string = "Base64Url"

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 additionalAuthenticatedData

additionalAuthenticatedData: object

mapper

mapper: any = KeyOperationsParametersMapper

parameterPath

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

Const algorithm

algorithm: object

mapper

mapper: any = KeyOperationsParametersMapper

parameterPath

parameterPath: string = "algorithm"

Const algorithm1

algorithm1: object

mapper

mapper: any = KeySignParametersMapper

parameterPath

parameterPath: string = "algorithm"

Const algorithm2

algorithm2: object

mapper

mapper: any = KeyVerifyParametersMapper

parameterPath

parameterPath: string = "algorithm"

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 authenticationTag

authenticationTag: object

mapper

mapper: any = KeyOperationsParametersMapper

parameterPath

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

Const backupKeyOperationSpec

backupKeyOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "POST"

path

path: string = "/keys/{key-name}/backup"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

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

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.BackupKeyResult

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 count

count: object

mapper

mapper: any = GetRandomBytesRequestMapper

parameterPath

parameterPath: string = "count"

Const createKeyOperationSpec

createKeyOperationSpec: object

headerParameters

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

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/keys/{key-name}/create"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

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

requestBody

requestBody: object

mapper

mapper: object

required

required: boolean = true

parameterPath

parameterPath: object

curve

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

keyAttributes

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

keyOps

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

keySize

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

kty

kty: string[] = ["kty"]

publicExponent

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

releasePolicy

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

tags

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

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.KeyBundle

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const curve

curve: object

mapper

mapper: any = KeyCreateParametersMapper

parameterPath

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

Const decryptOperationSpec

decryptOperationSpec: object

headerParameters

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

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/keys/{key-name}/{key-version}/decrypt"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.vaultBaseUrl,Parameters.keyName1,Parameters.keyVersion]

requestBody

requestBody: object

mapper

mapper: object

required

required: boolean = true

parameterPath

parameterPath: object

additionalAuthenticatedData

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

algorithm

algorithm: string[] = ["algorithm"]

authenticationTag

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

iv

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

value

value: string[] = ["value"]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.KeyOperationResult

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const deleteKeyOperationSpec

deleteKeyOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "DELETE"

path

path: string = "/keys/{key-name}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

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

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.DeletedKeyBundle

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const digest

digest: object

mapper

mapper: any = KeyVerifyParametersMapper

parameterPath

parameterPath: string = "digest"

Const enc

enc: object

mapper

mapper: any = KeyReleaseParametersMapper

parameterPath

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

Const encryptOperationSpec

encryptOperationSpec: object

headerParameters

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

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/keys/{key-name}/{key-version}/encrypt"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.vaultBaseUrl,Parameters.keyName1,Parameters.keyVersion]

requestBody

requestBody: object

mapper

mapper: object

required

required: boolean = true

parameterPath

parameterPath: object

additionalAuthenticatedData

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

algorithm

algorithm: string[] = ["algorithm"]

authenticationTag

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

iv

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

value

value: string[] = ["value"]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.KeyOperationResult

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const getDeletedKeyOperationSpec

getDeletedKeyOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/deletedkeys/{key-name}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

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

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.DeletedKeyBundle

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const getDeletedKeysNextOperationSpec

getDeletedKeysNextOperationSpec: 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.DeletedKeyListResult

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const getDeletedKeysOperationSpec

getDeletedKeysOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/deletedkeys"

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

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const getKeyOperationSpec

getKeyOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/keys/{key-name}/{key-version}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.vaultBaseUrl,Parameters.keyName1,Parameters.keyVersion]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.KeyBundle

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const getKeyRotationPolicyOperationSpec

getKeyRotationPolicyOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/keys/{key-name}/rotationpolicy"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

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

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.KeyRotationPolicy

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const getKeyVersionsNextOperationSpec

getKeyVersionsNextOperationSpec: 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.keyName1,Parameters.nextLink]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.KeyListResult

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const getKeyVersionsOperationSpec

getKeyVersionsOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/keys/{key-name}/versions"

queryParameters

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

serializer

serializer: any

urlParameters

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

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.KeyListResult

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const getKeysNextOperationSpec

getKeysNextOperationSpec: 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.KeyListResult

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const getKeysOperationSpec

getKeysOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/keys"

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

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const getRandomBytesOperationSpec

getRandomBytesOperationSpec: object

headerParameters

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

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/rng"

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

count

count: string[] = ["count"]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.RandomBytes

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const hsm

hsm: object

mapper

mapper: any = KeyImportParametersMapper

parameterPath

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

Const importKeyOperationSpec

importKeyOperationSpec: object

headerParameters

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

httpMethod

httpMethod: string = "PUT"

mediaType

mediaType: string = "json"

path

path: string = "/keys/{key-name}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

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

requestBody

requestBody: object

mapper

mapper: object

required

required: boolean = true

parameterPath

parameterPath: object

hsm

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

key

key: string[] = ["key"]

keyAttributes

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

releasePolicy

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

tags

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

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.KeyBundle

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const iv

iv: object

mapper

mapper: any = KeyOperationsParametersMapper

parameterPath

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

Const key

key: object

mapper

mapper: any = KeyImportParametersMapper

parameterPath

parameterPath: string = "key"

Const keyAttributes

keyAttributes: object

mapper

mapper: any = KeyCreateParametersMapper

parameterPath

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

Const keyAttributes1

keyAttributes1: object

mapper

mapper: any = KeyImportParametersMapper

parameterPath

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

Const keyAttributes2

keyAttributes2: object

mapper

mapper: any = KeyUpdateParametersMapper

parameterPath

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

Const keyBundleBackup

keyBundleBackup: object

mapper

mapper: any = KeyRestoreParametersMapper

parameterPath

parameterPath: string = "keyBundleBackup"

Const keyName

keyName: object

parameterPath

parameterPath: string = "keyName"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "key-name"

constraints

constraints: object

Pattern

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

type

type: object

name

name: string = "String"

Const keyName1

keyName1: object

parameterPath

parameterPath: string = "keyName"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "key-name"

type

type: object

name

name: string = "String"

Const keyOps

keyOps: object

mapper

mapper: any = KeyCreateParametersMapper

parameterPath

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

Const keyOps1

keyOps1: object

mapper

mapper: any = KeyUpdateParametersMapper

parameterPath

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

Const keyRotationPolicy

keyRotationPolicy: object

mapper

mapper: any = KeyRotationPolicyMapper

parameterPath

parameterPath: string = "keyRotationPolicy"

Const keySize

keySize: object

mapper

mapper: any = KeyCreateParametersMapper

parameterPath

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

Const keyVersion

keyVersion: object

parameterPath

parameterPath: string = "keyVersion"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "key-version"

type

type: object

name

name: string = "String"

Const kty

kty: object

mapper

mapper: any = KeyCreateParametersMapper

parameterPath

parameterPath: string = "kty"

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 nonce

nonce: object

mapper

mapper: any = KeyReleaseParametersMapper

parameterPath

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

Const publicExponent

publicExponent: object

mapper

mapper: any = KeyCreateParametersMapper

parameterPath

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

Const purgeDeletedKeyOperationSpec

purgeDeletedKeyOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "DELETE"

path

path: string = "/deletedkeys/{key-name}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

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

responses

responses: object

204

204: {}

Type declaration

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const recoverDeletedKeyOperationSpec

recoverDeletedKeyOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "POST"

path

path: string = "/deletedkeys/{key-name}/recover"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

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

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.KeyBundle

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const releaseOperationSpec

releaseOperationSpec: object

headerParameters

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

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/keys/{key-name}/{key-version}/release"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.vaultBaseUrl,Parameters.keyName1,Parameters.keyVersion]

requestBody

requestBody: object

mapper

mapper: object

required

required: boolean = true

parameterPath

parameterPath: object

enc

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

nonce

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

targetAttestationToken

targetAttestationToken: string[] = ["targetAttestationToken"]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.KeyReleaseResult

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const releasePolicy

releasePolicy: object

mapper

mapper: any = KeyCreateParametersMapper

parameterPath

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

Const releasePolicy1

releasePolicy1: object

mapper

mapper: any = KeyImportParametersMapper

parameterPath

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

Const releasePolicy2

releasePolicy2: object

mapper

mapper: any = KeyUpdateParametersMapper

parameterPath

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

Const restoreKeyOperationSpec

restoreKeyOperationSpec: object

headerParameters

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

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/keys/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

keyBundleBackup

keyBundleBackup: string[] = ["keyBundleBackup"]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.KeyBundle

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const rotateKeyOperationSpec

rotateKeyOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "POST"

path

path: string = "/keys/{key-name}/rotate"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

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

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.KeyBundle

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const signOperationSpec

signOperationSpec: object

headerParameters

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

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/keys/{key-name}/{key-version}/sign"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.vaultBaseUrl,Parameters.keyName1,Parameters.keyVersion]

requestBody

requestBody: object

mapper

mapper: object

required

required: boolean = true

parameterPath

parameterPath: object

algorithm

algorithm: string[] = ["algorithm"]

value

value: string[] = ["value"]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.KeyOperationResult

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const signature

signature: object

mapper

mapper: any = KeyVerifyParametersMapper

parameterPath

parameterPath: string = "signature"

Const tags

tags: object

mapper

mapper: any = KeyCreateParametersMapper

parameterPath

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

Const tags1

tags1: object

mapper

mapper: any = KeyImportParametersMapper

parameterPath

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

Const tags2

tags2: object

mapper

mapper: any = KeyUpdateParametersMapper

parameterPath

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

Const targetAttestationToken

targetAttestationToken: object

mapper

mapper: any = KeyReleaseParametersMapper

parameterPath

parameterPath: string = "targetAttestationToken"

Const unwrapKeyOperationSpec

unwrapKeyOperationSpec: object

headerParameters

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

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/keys/{key-name}/{key-version}/unwrapkey"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.vaultBaseUrl,Parameters.keyName1,Parameters.keyVersion]

requestBody

requestBody: object

mapper

mapper: object

required

required: boolean = true

parameterPath

parameterPath: object

additionalAuthenticatedData

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

algorithm

algorithm: string[] = ["algorithm"]

authenticationTag

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

iv

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

value

value: string[] = ["value"]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.KeyOperationResult

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const updateKeyOperationSpec

updateKeyOperationSpec: object

headerParameters

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

httpMethod

httpMethod: string = "PATCH"

mediaType

mediaType: string = "json"

path

path: string = "/keys/{key-name}/{key-version}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.vaultBaseUrl,Parameters.keyName1,Parameters.keyVersion]

requestBody

requestBody: object

mapper

mapper: object

required

required: boolean = true

parameterPath

parameterPath: object

keyAttributes

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

keyOps

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

releasePolicy

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

tags

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

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.KeyBundle

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const updateKeyRotationPolicyOperationSpec

updateKeyRotationPolicyOperationSpec: object

headerParameters

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

httpMethod

httpMethod: string = "PUT"

mediaType

mediaType: string = "json"

path

path: string = "/keys/{key-name}/rotationpolicy"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

requestBody

requestBody: any = Parameters.keyRotationPolicy

serializer

serializer: any

urlParameters

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

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.KeyRotationPolicy

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const value

value: object

mapper

mapper: any = KeyOperationsParametersMapper

parameterPath

parameterPath: string = "value"

Const value1

value1: object

mapper

mapper: any = KeySignParametersMapper

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"

Const verifyOperationSpec

verifyOperationSpec: object

headerParameters

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

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/keys/{key-name}/{key-version}/verify"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.vaultBaseUrl,Parameters.keyName1,Parameters.keyVersion]

requestBody

requestBody: object

mapper

mapper: object

required

required: boolean = true

parameterPath

parameterPath: object

algorithm

algorithm: string[] = ["algorithm"]

digest

digest: string[] = ["digest"]

signature

signature: string[] = ["signature"]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.KeyVerifyResult

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Const wrapKeyOperationSpec

wrapKeyOperationSpec: object

headerParameters

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

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/keys/{key-name}/{key-version}/wrapkey"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.vaultBaseUrl,Parameters.keyName1,Parameters.keyVersion]

requestBody

requestBody: object

mapper

mapper: object

required

required: boolean = true

parameterPath

parameterPath: object

additionalAuthenticatedData

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

algorithm

algorithm: string[] = ["algorithm"]

authenticationTag

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

iv

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

value

value: string[] = ["value"]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.KeyOperationResult

default

default: object

bodyMapper

bodyMapper: any = Mappers.KeyVaultError

Generated using TypeDoc