你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Key interface

密钥资源。

扩展

属性

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

资源的完全限定资源 ID。 示例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

资源的名称

systemData

包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。

type

资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

属性详细信息

attributes

键的属性。

attributes?: 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

属性值

rotationPolicy

响应中的密钥轮换策略。 它将用于输出和输入。 如果为空,则省略

rotationPolicy?: RotationPolicy

属性值

tags

资源标记

tags?: Record<string, string>

属性值

Record<string, string>

继承属性详细信息

id

资源的完全限定资源 ID。 示例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

id?: string

属性值

string

继承自 ProxyResource.id

name

资源的名称

name?: string

属性值

string

继承自 ProxyResource.name

systemData

包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。

systemData?: SystemData

属性值

继承自ProxyResource.systemData

type

资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

type?: string

属性值

string

继承自ProxyResource.type