Key interface

套件:

@azure/arm-keyvault

索引鍵資源。

Extends

ProxyResource

屬性

attributes	索引鍵的屬性。
curveName	橢圓曲線名稱。 如需有效值，請參閱 JsonWebKeyCurveName。 EC 和 EC-HSM 金鑰的預設值為 P-256
keyOps
keySize	位中的金鑰大小。 例如：RSA 的 2048、3072 或 4096。 RSA 和 RSA-HSM 金鑰的預設值為 2048。 針對自備金鑰 （BYOK） 所做的例外狀況，金鑰交換金鑰預設為 4096。
keyUri	要擷取目前密鑰版本的 URI。 注意：這個屬性不會串行化。 它只能由伺服器填入。
keyUriWithVersion	要擷取特定密鑰版本的 URI。 注意：這個屬性不會串行化。 它只能由伺服器填入。
kty	索引鍵的類型。 如需有效值，請參閱 JsonWebKeyType。
location	應該在其中建立受控 HSM 集區的支援 Azure 位置。 注意：這個屬性不會串行化。 它只能由伺服器填入。
releasePolicy	回應中的金鑰發行原則。 其將用於輸出和輸入。 如果空白，則省略
rotationPolicy	回應中的金鑰輪替原則。 其將用於輸出和輸入。 如果空白，則省略
tags	資源標籤注意：此屬性不會被序列化。 它只能由伺服器填入。

繼承的屬性

id	資源的完整資源標識碼。 例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” 附注：此屬性將不會串行化。 它只能由伺服器填入。
name	資源名稱注意：此屬性將不會串行化。 它只能由伺服器填入。
systemData	包含 createdBy 和 modifiedBy 資訊的 Azure Resource Manager 元數據。 注意：這個屬性不會串行化。 它只能由伺服器填入。
type	資源的類型。 例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts” 附注：此屬性將不會串行化。 它只能由伺服器填入。

屬性詳細資料

attributes

索引鍵的屬性。

attributes?: KeyAttributes

屬性值

KeyAttributes

curveName

橢圓曲線名稱。 如需有效值，請參閱 JsonWebKeyCurveName。 EC 和 EC-HSM 金鑰的預設值為 P-256

curveName?: string

屬性值

string

keyOps

keyOps?: string[]

屬性值

string[]

keySize

位中的金鑰大小。 例如：RSA 的 2048、3072 或 4096。 RSA 和 RSA-HSM 金鑰的預設值為 2048。 針對自備金鑰 （BYOK） 所做的例外狀況，金鑰交換金鑰預設為 4096。

keySize?: number

屬性值

number

keyUri

要擷取目前密鑰版本的 URI。 注意：這個屬性不會串行化。 它只能由伺服器填入。

keyUri?: string

屬性值

string

keyUriWithVersion

要擷取特定密鑰版本的 URI。 注意：這個屬性不會串行化。 它只能由伺服器填入。

keyUriWithVersion?: string

屬性值

string

kty

索引鍵的類型。 如需有效值，請參閱 JsonWebKeyType。

kty?: string

屬性值

string

location

應該在其中建立受控 HSM 集區的支援 Azure 位置。 注意：這個屬性不會串行化。 它只能由伺服器填入。

location?: string

屬性值

string

releasePolicy

回應中的金鑰發行原則。 其將用於輸出和輸入。 如果空白，則省略

releasePolicy?: KeyReleasePolicy

屬性值

KeyReleasePolicy

rotationPolicy

回應中的金鑰輪替原則。 其將用於輸出和輸入。 如果空白，則省略

rotationPolicy?: RotationPolicy

屬性值

RotationPolicy

tags

資源標籤注意：此屬性不會被序列化。 它只能由伺服器填入。

tags?: {[propertyName: string]: string}

屬性值

{[propertyName: string]: string}

繼承的屬性詳細資料

id

資源的完整資源標識碼。 例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” 附注：此屬性將不會串行化。 它只能由伺服器填入。

id?: string

屬性值

string

繼承自ProxyResource.id

name

資源名稱注意：此屬性將不會串行化。 它只能由伺服器填入。

name?: string

屬性值

string

繼承自ProxyResource.name

systemData

包含 createdBy 和 modifiedBy 資訊的 Azure Resource Manager 元數據。 注意：這個屬性不會串行化。 它只能由伺服器填入。

systemData?: SystemData

屬性值

SystemData

繼承自ProxyResource.systemData

type

資源的類型。 例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts” 附注：此屬性將不會串行化。 它只能由伺服器填入。

type?: string

屬性值

string

繼承自ProxyResource.type