Share via


UrlSigningKeyParameters Class

Url signing key parameters.

All required parameters must be populated in order to send to server.

Constructor

UrlSigningKeyParameters(*, key_id: str, secret_source: _models.ResourceReference, secret_version: str | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
key_id
str

Defines the customer defined key Id. This id will exist in the incoming request to indicate the key used to form the hash. Required.

secret_source

Resource reference to the Azure Key Vault secret. Expected to be in format of /subscriptions/{​​​​​​​​​subscriptionId}​​​​​​​​​/resourceGroups/{​​​​​​​​​resourceGroupName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​/providers/Microsoft.KeyVault/vaults/{vaultName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​/secrets/{secretName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​. # pylint: disable=line-too-long Required.

secret_version
str

Version of the secret to be used.

Default value: None

Variables

Name Description
type

The type of the secret resource. Required. Known values are: "UrlSigningKey", "CustomerCertificate", "ManagedCertificate", and "AzureFirstPartyManagedCertificate".

key_id
str

Defines the customer defined key Id. This id will exist in the incoming request to indicate the key used to form the hash. Required.

secret_source

Resource reference to the Azure Key Vault secret. Expected to be in format of /subscriptions/{​​​​​​​​​subscriptionId}​​​​​​​​​/resourceGroups/{​​​​​​​​​resourceGroupName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​/providers/Microsoft.KeyVault/vaults/{vaultName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​/secrets/{secretName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​. # pylint: disable=line-too-long Required.

secret_version
str

Version of the secret to be used.