@azure/arm-keyvault package

クラス

KeyVaultManagementClient

インターフェイス

AccessPolicyEntry	キー コンテナーにアクセスできる ID。 配列内のすべての ID は、キー コンテナーのテナント ID と同じテナント ID を使用する必要があります。
Action	モデルインターフェースアクション
Attributes	KeyVault サービスによって管理されるオブジェクト属性。
CheckMhsmNameAvailabilityParameters	マネージド HSM 名の可用性を確認するために使用されるパラメーター。
CheckMhsmNameAvailabilityResult	CheckMhsmNameAvailability 操作応答。
CheckNameAvailabilityResult	CheckNameAvailability 操作の応答。
CloudError	Key Vault リソース プロバイダーからのエラー応答
CloudErrorBody	Key Vault リソース プロバイダーからのエラー応答
DeletedManagedHsm	具体的なプロキシ リソースの種類は、特定のプロパティ型を使用してこの型にエイリアスを設定することで作成できます。
DeletedManagedHsmProperties	削除されたマネージド HSM のプロパティ。
DeletedVault	詳細を含むコンテナー情報を削除しました。
DeletedVaultProperties	削除されたコンテナーのプロパティ。
DimensionProperties	操作の種類: 取得、読み取り、削除など。
ErrorModel	サーバー エラー。
IPRule	特定の IP アドレスまたは IP 範囲からのコンテナーのアクセシビリティを制御する規則。
Key	キー リソース。
KeyAttributes	Azure Key Vault サービスによって管理されるオブジェクト属性。
KeyCreateParameters	キーの作成に使用するパラメーター。
KeyProperties	キーのプロパティ。
KeyReleasePolicy	モデルインターフェースKeyReleasePolicy
KeyRotationPolicyAttributes	モデルインターフェース KeyRotationPolicyAttributes
KeyVaultManagementClientOptionalParams	クライアントの省略可能なパラメーター。
KeysCreateIfNotExistOptionalParams	省略可能なパラメーター。
KeysGetOptionalParams	省略可能なパラメーター。
KeysGetVersionOptionalParams	省略可能なパラメーター。
KeysListOptionalParams	省略可能なパラメーター。
KeysListVersionsOptionalParams	省略可能なパラメーター。
KeysOperations	キー操作を表すインターフェース。
LifetimeAction	モデルインターフェースLifetimeAction
LogSpecification	操作のログ指定。
ManagedHSMSecurityDomainProperties	マネージド HSM のセキュリティ ドメインプロパティ。
ManagedHsm	詳細が拡張されたリソース情報。
ManagedHsmAction	model interface ManagedHsmAction
ManagedHsmError	エラー例外。
ManagedHsmKey	キー リソース。
ManagedHsmKeyAttributes	Azure Key Vault サービスによって管理されるオブジェクト属性。
ManagedHsmKeyCreateParameters	キーの作成に使用するパラメーター。
ManagedHsmKeyProperties	キーのプロパティ。
ManagedHsmKeyReleasePolicy	model interface ManagedHsmKeyReleasePolicy
ManagedHsmKeyRotationPolicyAttributes	model interface ManagedHsmKeyRotationPolicyAttributes
ManagedHsmKeysCreateIfNotExistOptionalParams	省略可能なパラメーター。
ManagedHsmKeysGetOptionalParams	省略可能なパラメーター。
ManagedHsmKeysGetVersionOptionalParams	省略可能なパラメーター。
ManagedHsmKeysListOptionalParams	省略可能なパラメーター。
ManagedHsmKeysListVersionsOptionalParams	省略可能なパラメーター。
ManagedHsmKeysOperations	ManagedHsmKeys操作を表すインターフェース。
ManagedHsmLifetimeAction	model interface ManagedHsmLifetimeAction
ManagedHsmProperties	マネージド HSM プールのプロパティ
ManagedHsmRotationPolicy	モデルインターフェースManagedHsmRotationPolicy
ManagedHsmSku	SKU の詳細
ManagedHsmTrigger	model interface ManagedHsmTrigger
ManagedHsmsCheckMhsmNameAvailabilityOptionalParams	省略可能なパラメーター。
ManagedHsmsCreateOrUpdateOptionalParams	省略可能なパラメーター。
ManagedHsmsDeleteOptionalParams	省略可能なパラメーター。
ManagedHsmsGetDeletedOptionalParams	省略可能なパラメーター。
ManagedHsmsGetOptionalParams	省略可能なパラメーター。
ManagedHsmsListByResourceGroupOptionalParams	省略可能なパラメーター。
ManagedHsmsListBySubscriptionOptionalParams	省略可能なパラメーター。
ManagedHsmsListDeletedOptionalParams	省略可能なパラメーター。
ManagedHsmsOperations	ManagedHsms操作を表すインターフェース。
ManagedHsmsPurgeDeletedOptionalParams	省略可能なパラメーター。
ManagedHsmsUpdateOptionalParams	省略可能なパラメーター。
ManagedServiceIdentity	マネージド サービス ID (システム割り当て ID またはユーザー割り当て ID)
MetricSpecification	操作のメトリック仕様。
MhsmGeoReplicatedRegion	このマネージド HSM プールが拡張されたリージョン。
MhsmNetworkRuleSet	マネージド HSM プールのネットワーク アクセシビリティを制御する一連の規則。
MhsmPrivateEndpoint	プライベート エンドポイント オブジェクトのプロパティ。
MhsmPrivateEndpointConnection	プライベート エンドポイント接続リソース。
MhsmPrivateEndpointConnectionItem	プライベート エンドポイント接続項目。
MhsmPrivateEndpointConnectionProperties	プライベートエンドポイント接続リソースのプロパティ。
MhsmPrivateEndpointConnectionsDeleteOptionalParams	省略可能なパラメーター。
MhsmPrivateEndpointConnectionsGetOptionalParams	省略可能なパラメーター。
MhsmPrivateEndpointConnectionsListByResourceOptionalParams	省略可能なパラメーター。
MhsmPrivateEndpointConnectionsOperations	MhsmPrivateEndpointConnections操作を表すインターフェース。
MhsmPrivateEndpointConnectionsPutOptionalParams	省略可能なパラメーター。
MhsmPrivateLinkResource	プライベート リンク リソース
MhsmPrivateLinkResourceListResult	プライベート リンク リソースの一覧
MhsmPrivateLinkResourceProperties	プライベート リンク リソースのプロパティ。
MhsmPrivateLinkResourcesListByMhsmResourceOptionalParams	省略可能なパラメーター。
MhsmPrivateLinkResourcesOperations	MhsmPrivateLinkResources操作を表すインターフェース。
MhsmPrivateLinkServiceConnectionState	プライベート リンク接続の承認状態を表すオブジェクト。
MhsmRegionsListByResourceOptionalParams	省略可能なパラメーター。
MhsmRegionsOperations	MhsmRegions操作を表すインターフェース。
MhsmServiceTagRule	特定のサービスタグから管理されたHSMプールへのアクセスを規定するルール。
MhsmVirtualNetworkRule	特定の仮想ネットワークからのマネージド HSM プールのアクセシビリティを制御する規則。
MhsmipRule	特定の IP アドレスまたは IP 範囲からのマネージド HSM プールのアクセシビリティを制御する規則。
NetworkRuleSet	コンテナーのネットワーク アクセシビリティを制御する一連の規則。
Operation	Key Vault REST API 操作の定義。
OperationDisplay	操作に関連付けられているメタデータを表示します。
OperationProperties	操作のプロパティには、メトリック仕様が含まれます。
OperationsListOptionalParams	省略可能なパラメーター。
OperationsOperations	操作操作を表すインターフェイス。
PageSettings	byPage メソッドのオプション
PagedAsyncIterableIterator	完了とページごとの非同期反復を可能にするインターフェイス。
Permissions	ID がキー、シークレット、証明書、ストレージに対して持つアクセス許可。
PrivateEndpoint	プライベート エンドポイント オブジェクトのプロパティ。
PrivateEndpointConnection	プライベート エンドポイント接続リソース。
PrivateEndpointConnectionItem	プライベート エンドポイント接続項目。
PrivateEndpointConnectionProperties	プライベートエンドポイント接続リソースのプロパティ。
PrivateEndpointConnectionsDeleteOptionalParams	省略可能なパラメーター。
PrivateEndpointConnectionsGetOptionalParams	省略可能なパラメーター。
PrivateEndpointConnectionsListByResourceOptionalParams	省略可能なパラメーター。
PrivateEndpointConnectionsOperations	PrivateEndpointConnections 操作を表すインターフェイス。
PrivateEndpointConnectionsPutOptionalParams	省略可能なパラメーター。
PrivateLinkResource	プライベート リンク リソース
PrivateLinkResourceListResult	プライベート リンク リソースの一覧
PrivateLinkResourceProperties	プライベート リンク リソースのプロパティ。
PrivateLinkResourcesListByVaultOptionalParams	省略可能なパラメーター。
PrivateLinkResourcesOperations	PrivateLinkResources 操作を表すインターフェイス。
PrivateLinkServiceConnectionState	プライベート リンク接続の承認状態を表すオブジェクト。
ProxyResource	Azure Resource Manager プロキシ リソースのリソース モデル定義。 タグと場所はありません
Resource	すべての Azure Resource Manager リソースの応答で返される共通フィールド
RestorePollerOptions
RotationPolicy	モデルインターフェース回転方針
Secret	詳細が拡張されたリソース情報。
SecretAttributes	シークレット管理属性。
SecretCreateOrUpdateParameters	シークレットを作成または更新するためのパラメーター
SecretPatchParameters	シークレットにパッチを適用するためのパラメーター
SecretPatchProperties	シークレットのプロパティ
SecretProperties	シークレットのプロパティ
SecretsCreateOrUpdateOptionalParams	省略可能なパラメーター。
SecretsGetOptionalParams	省略可能なパラメーター。
SecretsListOptionalParams	省略可能なパラメーター。
SecretsOperations	シークレット操作を表すインターフェース。
SecretsUpdateOptionalParams	省略可能なパラメーター。
ServiceSpecification	操作の 1 つのプロパティには、ログの仕様が含まれます。
SimplePollerLike	実行時間の長い操作をポーリングするために使用できる単純なポーリングツール。
Sku	SKU の詳細
SystemData	リソースの作成と最後の変更に関連するメタデータ。
TrackedResource	Azure Resource Manager のリソース モデル定義は、"タグ" と "場所" を持つ最上位リソースを追跡しました
Trigger	モデルインターフェーストリガー
UserAssignedIdentity	ユーザー割り当て ID プロパティ
Vault	詳細が拡張されたリソース情報。
VaultAccessPolicyParameters	コンテナー内のアクセス ポリシーを更新するためのパラメーター
VaultAccessPolicyProperties	コンテナー アクセス ポリシーのプロパティ
VaultCheckNameAvailabilityParameters	コンテナー名の可用性を確認するために使用されるパラメーター。
VaultCreateOrUpdateParameters	コンテナーを作成または更新するためのパラメーター
VaultPatchParameters	コンテナーを作成または更新するためのパラメーター
VaultPatchProperties	コンテナーのプロパティ
VaultProperties	コンテナーのプロパティ
VaultsCheckNameAvailabilityOptionalParams	省略可能なパラメーター。
VaultsCreateOrUpdateOptionalParams	省略可能なパラメーター。
VaultsDeleteOptionalParams	省略可能なパラメーター。
VaultsGetDeletedOptionalParams	省略可能なパラメーター。
VaultsGetOptionalParams	省略可能なパラメーター。
VaultsListByResourceGroupOptionalParams	省略可能なパラメーター。
VaultsListBySubscriptionOptionalParams	省略可能なパラメーター。
VaultsListDeletedOptionalParams	省略可能なパラメーター。
VaultsListOptionalParams	省略可能なパラメーター。
VaultsOperations	Vault 操作を表すインターフェイス。
VaultsPurgeDeletedOptionalParams	省略可能なパラメーター。
VaultsUpdateAccessPolicyOptionalParams	省略可能なパラメーター。
VaultsUpdateOptionalParams	省略可能なパラメーター。
VirtualNetworkRule	特定の仮想ネットワークからのコンテナーのアクセシビリティを制御するルール。

型エイリアス

AccessPolicyUpdateKind	アクセスポリシー更新の種類
ActionsRequired	サービス プロバイダーの変更にコンシューマーの更新が必要かどうかを示すメッセージ。 KnownActionsRequired ActionsRequired と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。 サービスでサポートされている既知の値 なし
ActivationStatus	活性化状況 KnownActivationStatus を ActivationStatus と同じ意味で使用できる、この列挙型には、サービスがサポートする既知の値が含まれています。 サービスでサポートされている既知の値 アクティブな: マネージド HSM プールがアクティブです。 NotActivated: マネージド HSM プールはまだアクティブ化されていません。 不明な: マネージド HSM のアクティブ化中に不明なエラーが発生しました。 失敗した: マネージド HSM のアクティブ化に失敗しました。
AzureSupportedClouds	文字列リテラル型としてのクラウド設定でサポートされている値
CertificatePermissions	証明書権限の種類
ContinuablePage	結果のページを記述するインターフェイス。
CreateMode	コンテナーを復旧する必要があるかどうかを示すコンテナーの作成モード。
CreatedByType	リソースを作成したエンティティの種類。 KnownCreatedByType を CreatedByType と同じ意味で使用できる、この列挙型には、サービスがサポートする既知の値が含まれています。 サービスでサポートされている既知の値 ユーザー: エンティティはユーザーによって作成されました。 アプリケーション: エンティティはアプリケーションによって作成されました。 ManagedIdentity: エンティティはマネージド ID によって作成されました。 キー: エンティティはキーによって作成されました。
DeletionRecoveryLevel	現在有効な削除回復レベルです。 「Purgeable」が含まれている場合、特権ユーザーによってオブジェクトを永久に削除することができます。そうでなければ、保持間隔の終わりにオブジェクトを消去できるのはシステムだけです。 KnownDeletionRecoveryLevel 、DeletionRecoveryLevel と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。 サービスでサポートされている既知の値 消去可能な の 回復可能 + 消去可能な 回復可能な の 回復可能 + ProtectedSubscription の
GeoReplicationRegionProvisioningState	現在のプロビジョニング状態。 KnownGeoReplicationRegionProvisioningState GeoReplicationRegionProvisioningState と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。 サービスでサポートされている既知の値 プロビジョニング前 の プロビジョニング 成功した の 失敗した の削除 クリーンアップ
JsonWebKeyCurveName	楕円曲線の名前。 有効な値については、JsonWebKeyCurveName を参照してください。 ECキーと EC-HSM キーのデフォルトはP-256です KnownJsonWebKeyCurveName JsonWebKeyCurveName と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。 サービスでサポートされている既知の値 P-256 P-384 P-521 P-256K
JsonWebKeyOperation	キーの許可されたJSONウェブキー操作。 詳細については、「JsonWebKeyOperation」を参照してください。 KnownJsonWebKeyOperation JsonWebKeyOperation と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。 サービスでサポートされている既知の値 暗号化する 復号化 sign 確認する wrapKey を する unwrapKey を する インポートする リリース
JsonWebKeyType	キーの型。 有効な値については、JsonWebKeyType を参照してください。 KnownJsonWebKeyType JsonWebKeyType と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。 サービスでサポートされている既知の値 EC EC-HSM RSA RSA-HSM の
KeyPermissions	キーパーセンテーションの種類
KeyRotationPolicyActionType	アクションの種類。
ManagedHsmSkuFamily	管理型HSMプールのSKUファミリー KnownManagedHsmSkuFamily ManagedHsmSkuFamily と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。 サービスでサポートされている既知の値 B C
ManagedHsmSkuName	マネージド HSM プールの SKU
ManagedServiceIdentityType	マネージド サービス ID の種類 (SystemAssigned 型と UserAssigned 型の両方が許可されます)。 KnownManagedServiceIdentityType ManagedServiceIdentityType と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。 サービスでサポートされている既知の値 なし: マネージド ID はありません。 SystemAssigned: システム割り当てマネージド ID。 UserAssigned: ユーザー割り当てマネージド ID。 SystemAssigned、UserAssigned: システム割り当てマネージド ID とユーザー割り当てマネージド ID。
NetworkRuleAction	ipRules および virtualNetworkRules からのルールが一致しない場合の既定のアクション。 これは、バイパス プロパティが評価された後にのみ使用されます。 KnownNetworkRuleAction を NetworkRuleAction と同じ意味で使用できる、この列挙型には、サービスがサポートする既知の値が含まれています。 サービスでサポートされている既知の値 許可 拒否
NetworkRuleBypassOptions	ネットワーク ルールをバイパスできるトラフィックを指定します。 "AzureServices" または "None" を指定できます。 指定しない場合、既定値は 'AzureServices' です。 KnownNetworkRuleBypassOptions NetworkRuleBypassOptions と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。 サービスでサポートされている既知の値 AzureServices なし
PrivateEndpointConnectionProvisioningState	現在のプロビジョニング状態。 KnownPrivateEndpointConnectionProvisioningState PrivateEndpointConnectionProvisioningState と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。 サービスでサポートされている既知の値 成功した の の作成 更新 の削除 失敗した 切断された を する
PrivateEndpointServiceConnectionStatus	プライベート エンドポイント接続の状態。 KnownPrivateEndpointServiceConnectionStatus PrivateEndpointServiceConnectionStatus と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。 サービスでサポートされている既知の値 保留中の の 承認済み を する 拒否された を する 切断された を する
ProvisioningState	プロビジョニングの状態。 KnownProvisioningState ProvisioningState と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。 サービスでサポートされている既知の値 成功した: マネージド HSM プールが完全にプロビジョニングされました。 プロビジョニング: マネージド HSM プールは現在プロビジョニング中です。 失敗した: マネージド HSM プールのプロビジョニングに失敗しました。 更新: マネージド HSM プールは現在更新中です。 の削除: マネージド HSM プールは現在削除中です。 アクティブ化された: マネージド HSM プールは、通常の使用の準備ができています。 SecurityDomainRestore: マネージド HSM プールは、セキュリティ ドメインの復元アクションを待機しています。 の復元: マネージド HSM プールは、完全な HSM バックアップから復元されています。
PublicNetworkAccess	パブリック ネットワークからマネージド HSM へのアクセス許可を制御します。 KnownPublicNetworkAccess PublicNetworkAccess と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。 サービスでサポートされている既知の値 Enabled Disabled
Reason	ボールト名を使用できなかった理由。 Reason 要素は、NameAvailable が false の場合にのみ返されます。 KnownReason はReasonと同義で使用可能で、このenumはサービスがサポートする既知の値を含む。 サービスでサポートされている既知の値 AccountNameInvalid AlreadyExists を する
SecretPermissions	シークレットパーセンテーションの種類
SkuFamily	SKUの姓 KnownSkuFamily SkuFamily と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。 サービスでサポートされている既知の値 を する
SkuName	キー コンテナーが Standard コンテナーか Premium コンテナーかを指定する SKU 名。
StoragePermissions	ストレージパーセンテージェンシーの種類
VaultProvisioningState	コンテナーのプロビジョニング状態。 KnownVaultProvisioningState VaultProvisioningState と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。 サービスでサポートされている既知の値 成功した の RegisteringDns

列挙型

AzureClouds	Azure クラウド環境を記述する列挙型。
KnownActionsRequired	サービス プロバイダーの変更にコンシューマーの更新が必要かどうかを示すメッセージ。
KnownActivationStatus	アクティベーションステータス
KnownCertificatePermissions	CertificatePermissions の既知の値は、サービスが受け入れる。
KnownCreatedByType	リソースを作成したエンティティの種類。
KnownDeletionRecoveryLevel	現在有効な削除回復レベルです。 「Purgeable」が含まれている場合、特権ユーザーによってオブジェクトを永久に削除することができます。そうでなければ、保持間隔の終わりにオブジェクトを消去できるのはシステムだけです。
KnownGeoReplicationRegionProvisioningState	現在のプロビジョニング状態。
KnownJsonWebKeyCurveName	楕円曲線の名前。 有効な値については、JsonWebKeyCurveName を参照してください。 EC キーと EC-HSM キーの既定値は P-256 です
KnownJsonWebKeyOperation	キーの許可されたJSONウェブキー操作。 詳細については、「JsonWebKeyOperation」を参照してください。
KnownJsonWebKeyType	キーの型。 有効な値については、JsonWebKeyType を参照してください。
KnownKeyPermissions	KeyPermissions の既知の値は、サービスが受け入れる。
KnownManagedHsmSkuFamily	マネージド HSM プールの SKU ファミリ
KnownManagedServiceIdentityType	マネージド サービス ID の種類 (SystemAssigned 型と UserAssigned 型の両方が許可されます)。
KnownNetworkRuleAction	ipRules および virtualNetworkRules からのルールが一致しない場合の既定のアクション。 これは、バイパス プロパティが評価された後にのみ使用されます。
KnownNetworkRuleBypassOptions	ネットワーク ルールをバイパスできるトラフィックを指定します。 "AzureServices" または "None" を指定できます。 指定しない場合、既定値は 'AzureServices' です。
KnownPrivateEndpointConnectionProvisioningState	現在のプロビジョニング状態。
KnownPrivateEndpointServiceConnectionStatus	プライベート エンドポイント接続の状態。
KnownProvisioningState	プロビジョニングの状態。
KnownPublicNetworkAccess	パブリック ネットワークからマネージド HSM へのアクセス許可を制御します。
KnownReason	ボールト名を使用できなかった理由。 Reason 要素は、NameAvailable が false の場合にのみ返されます。
KnownSecretPermissions	SecretPermissions の既知の値は、サービスが受け入れる。
KnownSkuFamily	SKU ファミリ名
KnownStoragePermissions	StoragePermissions の既知の値は、サービスが受け入れる。
KnownVaultProvisioningState	コンテナーのプロビジョニング状態。
KnownVersions	使用可能な API バージョン。

関数

restorePoller<TResponse, TResult>(KeyVaultManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

別のポーラーのシリアル化された状態からポーリングャーを作成します。 これは、別のホストに投票者を作成する場合や、元のホストがスコープ内にない後にポーリングャーを構築する必要がある場合に便利です。

関数の詳細

restorePoller<TResponse, TResult>(KeyVaultManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

別のポーラーのシリアル化された状態からポーリングャーを作成します。 これは、別のホストに投票者を作成する場合や、元のホストがスコープ内にない後にポーリングャーを構築する必要がある場合に便利です。

function restorePoller<TResponse, TResult>(client: KeyVaultManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

パラメーター

client

KeyVaultManagementClient

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

options

RestorePollerOptions<TResult, PathUncheckedResponse>

戻り値

PollerLike<OperationState<TResult>, TResult>