VaultProperties クラス

コンテナーのプロパティ。

変数はサーバーによってのみ設定され、要求の送信時には無視されます。

Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。

継承
azure.mgmt.keyvault._serialization.Model
VaultProperties

コンストラクター

VaultProperties(*, tenant_id: str, sku: _models.Sku, access_policies: List[_models.AccessPolicyEntry] | None = None, vault_uri: str | None = None, enabled_for_deployment: bool | None = None, enabled_for_disk_encryption: bool | None = None, enabled_for_template_deployment: bool | None = None, enable_soft_delete: bool = True, soft_delete_retention_in_days: int = 90, enable_rbac_authorization: bool = False, create_mode: str | _models.CreateMode | None = None, enable_purge_protection: bool | None = None, network_acls: _models.NetworkRuleSet | None = None, provisioning_state: str | _models.VaultProvisioningState | None = None, public_network_access: str = 'enabled', **kwargs: Any)

Keyword-Only パラメータ

名前 説明
tenant_id
str

キー コンテナーへの要求を認証するために使用する必要がある Azure Active Directory テナント ID。 必須。

sku
Sku

SKU の詳細。 必須。

access_policies

キー コンテナーにアクセスできる 0 から 1024 の ID の配列。 配列内のすべての ID は、キー コンテナーのテナント ID と同じテナント ID を使用する必要があります。 が にrecover設定されている場合createMode、アクセス ポリシーは必要ありません。 それ以外の場合は、アクセス ポリシーが必要です。

vault_uri
str

キーとシークレットに対して操作を実行するためのコンテナーの URI。

enabled_for_deployment

キー コンテナーからシークレットとして格納されている証明書を Azure Virtual Machinesで取得できるかどうかを指定するプロパティ。

enabled_for_disk_encryption

コンテナーからシークレットを取得してキーのラップを解除することを Azure Disk Encryption に許可するかどうかを指定するプロパティ。

enabled_for_template_deployment

Azure Resource Managerがキー コンテナーからシークレットを取得できるかどうかを指定するプロパティ。

enable_soft_delete

このキー コンテナーに対して "論理的な削除" 機能を有効にするかどうかを指定するプロパティ。 新しいキー コンテナーの作成時に値 (true または false) に設定されていない場合、既定では true に設定されます。 true に設定すると、false に戻すことはできません。

既定値: True
soft_delete_retention_in_days
int

softDelete データ保持日数。 =7 と <=90 を受け入れます>。

既定値: 90
enable_rbac_authorization

データ アクションの承認方法を制御するプロパティ。 true の場合、キー コンテナーはデータ アクションの承認にロール ベースのAccess Control (RBAC) を使用し、コンテナーのプロパティで指定されたアクセス ポリシーは無視されます (警告: これはプレビュー機能です)。 false の場合、キー コンテナーはコンテナーのプロパティで指定されたアクセス ポリシーを使用し、Azure Resource Managerに格納されているすべてのポリシーは無視されます。 null または指定されていない場合、コンテナーは既定値の false で作成されます。 管理アクションは常に RBAC で承認されることに注意してください。

create_mode
str または CreateMode

コンテナーを復旧する必要があるかどうかを示すコンテナーの作成モード。 既知の値は、"recover" と "default" です。

enable_purge_protection

このコンテナーに対して消去に対する保護を有効にするかどうかを指定するプロパティ。 このプロパティを true に設定すると、このコンテナーとそのコンテンツの消去に対する保護がアクティブになります。Key Vault サービスのみが、回復不可能なハード削除を開始する可能性があります。 この設定は、論理的な削除も有効になっている場合にのみ有効です。 この機能を有効にすることは元に戻すことはできません。つまり、 プロパティは false をその値として受け入れません。

network_acls

特定のネットワークの場所からのキー コンテナーのアクセシビリティを管理する規則。

provisioning_state

コンテナーのプロビジョニング状態。 既知の値は、"Succeeded" と "RegisteringDns" です。

public_network_access
str

コンテナーがパブリック インターネットからのトラフィックを受け入れるかどうかを指定するプロパティ。 プライベート エンドポイント トラフィックを除くすべてのトラフィックを "無効" に設定した場合、信頼されたサービスから送信されたトラフィックはブロックされます。 これにより、設定されたファイアウォール規則がオーバーライドされます。つまり、ファイアウォール規則が存在する場合でも、規則は適用されません。

既定値: enabled

変数

名前 説明
tenant_id
str

キー コンテナーへの要求を認証するために使用する必要がある Azure Active Directory テナント ID。 必須。

sku
Sku

SKU の詳細。 必須です。

access_policies

キー コンテナーにアクセスできる 0 から 1024 の ID の配列。 配列内のすべての ID は、キー コンテナーのテナント ID と同じテナント ID を使用する必要があります。 が にrecover設定されている場合createMode、アクセス ポリシーは必要ありません。 それ以外の場合は、アクセス ポリシーが必要です。

vault_uri
str

キーとシークレットに対して操作を実行するためのコンテナーの URI。

hsm_pool_resource_id
str

HSM プールのリソース ID。

enabled_for_deployment

キー コンテナーからシークレットとして格納されている証明書を Azure Virtual Machinesで取得できるかどうかを指定するプロパティ。

enabled_for_disk_encryption

コンテナーからシークレットを取得してキーのラップを解除することを Azure Disk Encryption に許可するかどうかを指定するプロパティ。

enabled_for_template_deployment

Azure Resource Managerがキー コンテナーからシークレットを取得できるかどうかを指定するプロパティ。

enable_soft_delete

このキー コンテナーに対して "論理的な削除" 機能を有効にするかどうかを指定するプロパティ。 新しいキー コンテナーの作成時に値 (true または false) に設定されていない場合、既定では true に設定されます。 true に設定すると、false に戻すことはできません。

soft_delete_retention_in_days
int

softDelete データ保持日数。 =7 と <=90 を受け入れます>。

enable_rbac_authorization

データ アクションの承認方法を制御するプロパティ。 true の場合、キー コンテナーはデータ アクションの承認にロール ベースのAccess Control (RBAC) を使用し、コンテナーのプロパティで指定されたアクセス ポリシーは無視されます (警告: これはプレビュー機能です)。 false の場合、キー コンテナーはコンテナーのプロパティで指定されたアクセス ポリシーを使用し、Azure Resource Managerに格納されているすべてのポリシーは無視されます。 null または指定されていない場合、コンテナーは既定値の false で作成されます。 管理アクションは常に RBAC で承認されることに注意してください。

create_mode
str または CreateMode

コンテナーを復旧する必要があるかどうかを示すコンテナーの作成モード。 既知の値は、"recover" と "default" です。

enable_purge_protection

このコンテナーに対して消去に対する保護を有効にするかどうかを指定するプロパティ。 このプロパティを true に設定すると、このコンテナーとそのコンテンツの消去に対する保護がアクティブになります。Key Vault サービスのみが、回復不可能なハード削除を開始する可能性があります。 この設定は、論理的な削除も有効になっている場合にのみ有効です。 この機能を有効にすることは元に戻すことはできません。つまり、 プロパティは false をその値として受け入れません。

network_acls

特定のネットワークの場所からのキー コンテナーのアクセシビリティを管理する規則。

provisioning_state

コンテナーのプロビジョニング状態。 既知の値は、"Succeeded" と "RegisteringDns" です。

private_endpoint_connections

キー コンテナーに関連付けられているプライベート エンドポイント接続の一覧。

public_network_access
str

コンテナーがパブリック インターネットからのトラフィックを受け入れるかどうかを指定するプロパティ。 プライベート エンドポイント トラフィックを除くすべてのトラフィックを "無効" に設定した場合、信頼されたサービスから送信されたトラフィックはブロックされます。 これにより、設定されたファイアウォール規則がオーバーライドされます。つまり、ファイアウォール規則が存在する場合でも、規則は適用されません。