Package version:

Interface Key

The key resource.

interface Key {
    attributes?: KeyAttributes;
    curveName?: string;
    id?: string;
    keyOps?: string[];
    keySize?: number;
    keyUri?: string;
    keyUriWithVersion?: string;
    kty?: string;
    location?: string;
    name?: string;
    releasePolicy?: KeyReleasePolicy;
    rotationPolicy?: RotationPolicy;
    systemData?: SystemData;
    tags?: {
        [propertyName: string]: string;
    };
    type?: string;
}

Hierarchy (view full)

Properties

attributes? curveName? id? keyOps? keySize? keyUri? keyUriWithVersion? kty? location? name? releasePolicy? rotationPolicy? systemData? tags? type?

Properties

Optionalattributes

attributes?: KeyAttributes

The attributes of the key.

OptionalcurveName

curveName?: string

The elliptic curve name. For valid values, see JsonWebKeyCurveName. Default for EC and EC-HSM keys is P-256

Optional Readonlyid

id?: string

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.

OptionalkeyOps

keyOps?: string[]

OptionalkeySize

keySize?: number

The key size in bits. For example: 2048, 3072, or 4096 for RSA. Default for RSA and RSA-HSM keys is 2048. Exception made for bring your own key (BYOK), key exchange keys default to 4096.

Optional ReadonlykeyUri

keyUri?: string

The URI to retrieve the current version of the key. NOTE: This property will not be serialized. It can only be populated by the server.

Optional ReadonlykeyUriWithVersion

keyUriWithVersion?: string

The URI to retrieve the specific version of the key. NOTE: This property will not be serialized. It can only be populated by the server.

Optionalkty

kty?: string

The type of the key. For valid values, see JsonWebKeyType.

Optional Readonlylocation

location?: string

The supported Azure location where the managed HSM Pool should be created. NOTE: This property will not be serialized. It can only be populated by the server.

Optional Readonlyname

name?: string

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

OptionalreleasePolicy

releasePolicy?: KeyReleasePolicy

Key release policy in response. It will be used for both output and input. Omitted if empty

OptionalrotationPolicy

rotationPolicy?: RotationPolicy

Key rotation policy in response. It will be used for both output and input. Omitted if empty

Optional ReadonlysystemData

systemData?: SystemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.

Optional Readonlytags

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

Resource tags NOTE: This property will not be serialized. It can only be populated by the server.

Optional Readonlytype

type?: string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Settings

Member Visibility