Microsoft.KeyVault コンテナー/シークレット 2016-10-01
Bicep リソース定義
コンテナー/シークレットリソースの種類は、次を対象とする操作でデプロイできます。
- リソース グループの - リソース グループのデプロイ コマンド 参照
各 API バージョンで変更されたプロパティの一覧については、変更ログの
備考
セキュリティで保護された値にキー コンテナーを使用する方法については、「Bicepを使用してシークレットを管理する」を参照してください。
シークレットの作成に関するクイック スタートについては、「クイックスタート: ARM テンプレートを使用して Azure Key Vault からシークレットを設定および取得する」を参照してください。
キーの作成に関するクイック スタートについては、「クイックスタート: ARM テンプレートを使用して Azure キー コンテナーとキーを作成する」を参照してください。
リソースの形式
Microsoft.KeyVault/vaults/secrets リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.KeyVault/vaults/secrets@2016-10-01' = {
name: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
parent: resourceSymbolicName
properties: {
attributes: {
enabled: bool
exp: int
nbf: int
}
contentType: 'string'
value: 'string'
}
}
プロパティ値
vaults/secrets
| 名前 | 形容 | 価値 |
|---|---|---|
| 名前 | リソース名 Bicepで子リソースの名前と種類 |
string (必須) 文字数制限: 1 ~ 127 有効な文字: 英数字とハイフン。 |
| タグ | シークレットに割り当てられるタグ。 | タグ名と値のディクショナリ。 テンプレート の |
| 親 | Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。 詳細については、「親リソースの外部 |
種類のリソースのシンボリック名: コンテナー |
| プロパティ | シークレットのプロパティ | SecretProperties (必須) |
SecretProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| 属性 | シークレットの属性。 | SecretAttributes |
| contentType | シークレットのコンテンツ タイプ。 | 糸 |
| 価値 | シークレットの値。 注: このモデルを使用する API は ARM デプロイでの内部使用を目的とするため、サービスから 'value' は返されません。 ユーザーは、コンテナー シークレットとの対話にデータ プレーン REST サービスを使用する必要があります。 | 糸 |
SecretAttributes
| 名前 | 形容 | 価値 |
|---|---|---|
| 有効 | オブジェクトが有効かどうかを判断します。 | bool |
| exp | 1970-01-01T00:00:00Z 以降の有効期限 (秒)。 | int |
| nbf | 1970-01-01T00:00:00Z 以降の日付 (秒)。 | int |
クイック スタート テンプレート
次のクイック スタート テンプレートでは、このリソースの種類をデプロイします。
| テンプレート | 形容 |
|---|---|
|
KeyVault から SSL を使用して API Management サービスを作成する Azure にデプロイする |
このテンプレートは、ユーザー割り当て ID で構成された API Management サービスをデプロイします。 この ID を使用して KeyVault から SSL 証明書をフェッチし、4 時間ごとにチェックすることで更新を維持します。 |
|
Azure Stack HCI 23H2 クラスター を作成します Azure にデプロイする |
このテンプレートは、ARM テンプレートを使用して Azure Stack HCI 23H2 クラスターを作成します。 |
|
Azure Stack HCI 23H2 クラスター を作成します Azure にデプロイする |
このテンプレートは、カスタム ストレージ IP を使用して ARM テンプレートを使用して Azure Stack HCI 23H2 クラスターを作成します |
|
スイッチレス デュアルリンク ネットワーク モードで Azure Stack HCI 23H2 クラスターを作成 Azure にデプロイする |
このテンプレートは、ARM テンプレートを使用して Azure Stack HCI 23H2 クラスターを作成します。 |
|
ネットワーク モードで Azure Stack HCI 23H2 クラスター Switchless-SingleLink 作成 Azure にデプロイする |
このテンプレートは、ARM テンプレートを使用して Azure Stack HCI 23H2 クラスターを作成します。 |
|
Azure Key Vault とシークレット を作成する Azure にデプロイする |
このテンプレートでは、Azure Key Vault とシークレットが作成されます。 |
|
RBAC とシークレット を使用して Azure Key Vault を作成する Azure にデプロイする |
このテンプレートでは、Azure Key Vault とシークレットが作成されます。 アクセス ポリシーに依存する代わりに、Azure RBAC を利用してシークレットの承認を管理します |
|
プライベート エンドポイントを使用して Key Vault に接続 Azure にデプロイする |
このサンプルでは、仮想ネットワークとプライベート DNS ゾーンを構成して、プライベート エンドポイント経由で Key Vault にアクセスする方法を示します。 |
|
Key Vault とシークレットの一覧を作成 Azure にデプロイする |
このテンプレートでは、パラメーターと共に渡された Key Vault とキー コンテナー内のシークレットの一覧が作成されます。 |
|
Azure Key Vault に格納されている Azure Maps SAS トークンを作成する Azure にデプロイする |
このテンプレートは、Azure Maps アカウントをデプロイし、Azure Key Vault シークレットに格納する指定されたユーザー割り当て ID に基づいて Sas トークンを一覧表示します。 |
| Key Vault を使用して Application Gateway V2 を作成する Azure |
このテンプレートは、Application Gateway V2 を仮想ネットワークにデプロイし、ユーザー定義 ID、Key Vault、シークレット (証明書データ)、Key Vault と Application Gateway のアクセス ポリシーをデプロイします。 |
|
Azure Firewall Premium のテスト環境 Azure にデプロイする |
このテンプレートでは、侵入検査検出 (IDPS)、TLS 検査、Web カテゴリのフィルター処理などの Premium 機能を備えた Azure Firewall Premium とファイアウォール ポリシーを作成します |
|
ssh キーを作成して KeyVault に格納する Azure にデプロイする |
このテンプレートでは、deploymentScript リソースを使用して ssh キーを生成し、秘密キーを keyVault に格納します。 |
| Azure 関数アプリと HTTP によってトリガーされる関数 を Azure |
この例では、Azure 関数アプリと HTTP によってトリガーされる関数をテンプレートにインラインでデプロイします。 また、Key Vault をデプロイし、シークレットに関数アプリのホスト キーを設定します。 |
| 内部 API Management と Web App を使用した Application Gateway の Azure |
Azure Web アプリでホストされている Web API にサービスを提供する仮想ネットワーク (内部モード) API Management インスタンスにインターネット トラフィックをルーティングする Application Gateway。 |
ARM テンプレート リソース定義
コンテナー/シークレットリソースの種類は、次を対象とする操作でデプロイできます。
- リソース グループの - リソース グループのデプロイ コマンド 参照
各 API バージョンで変更されたプロパティの一覧については、変更ログの
備考
セキュリティで保護された値にキー コンテナーを使用する方法については、「Bicepを使用してシークレットを管理する」を参照してください。
シークレットの作成に関するクイック スタートについては、「クイックスタート: ARM テンプレートを使用して Azure Key Vault からシークレットを設定および取得する」を参照してください。
キーの作成に関するクイック スタートについては、「クイックスタート: ARM テンプレートを使用して Azure キー コンテナーとキーを作成する」を参照してください。
リソースの形式
Microsoft.KeyVault/vaults/secrets リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.KeyVault/vaults/secrets",
"apiVersion": "2016-10-01",
"name": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"properties": {
"attributes": {
"enabled": "bool",
"exp": "int",
"nbf": "int"
},
"contentType": "string",
"value": "string"
}
}
プロパティ値
vaults/secrets
| 名前 | 形容 | 価値 |
|---|---|---|
| 種類 | リソースの種類 | 'Microsoft.KeyVault/vaults/secrets' |
| apiVersion | リソース API のバージョン | '2016-10-01' |
| 名前 | リソース名 JSON ARM テンプレートで子リソースの名前と型 |
string (必須) 文字数制限: 1 ~ 127 有効な文字: 英数字とハイフン。 |
| タグ | シークレットに割り当てられるタグ。 | タグ名と値のディクショナリ。 テンプレート の |
| プロパティ | シークレットのプロパティ | SecretProperties (必須) |
SecretProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| 属性 | シークレットの属性。 | SecretAttributes |
| contentType | シークレットのコンテンツ タイプ。 | 糸 |
| 価値 | シークレットの値。 注: このモデルを使用する API は ARM デプロイでの内部使用を目的とするため、サービスから 'value' は返されません。 ユーザーは、コンテナー シークレットとの対話にデータ プレーン REST サービスを使用する必要があります。 | 糸 |
SecretAttributes
| 名前 | 形容 | 価値 |
|---|---|---|
| 有効 | オブジェクトが有効かどうかを判断します。 | bool |
| exp | 1970-01-01T00:00:00Z 以降の有効期限 (秒)。 | int |
| nbf | 1970-01-01T00:00:00Z 以降の日付 (秒)。 | int |
クイック スタート テンプレート
次のクイック スタート テンプレートでは、このリソースの種類をデプロイします。
| テンプレート | 形容 |
|---|---|
|
KeyVault から SSL を使用して API Management サービスを作成する Azure にデプロイする |
このテンプレートは、ユーザー割り当て ID で構成された API Management サービスをデプロイします。 この ID を使用して KeyVault から SSL 証明書をフェッチし、4 時間ごとにチェックすることで更新を維持します。 |
|
Azure Stack HCI 23H2 クラスター を作成します Azure にデプロイする |
このテンプレートは、ARM テンプレートを使用して Azure Stack HCI 23H2 クラスターを作成します。 |
|
Azure Stack HCI 23H2 クラスター を作成します Azure にデプロイする |
このテンプレートは、カスタム ストレージ IP を使用して ARM テンプレートを使用して Azure Stack HCI 23H2 クラスターを作成します |
|
スイッチレス デュアルリンク ネットワーク モードで Azure Stack HCI 23H2 クラスターを作成 Azure にデプロイする |
このテンプレートは、ARM テンプレートを使用して Azure Stack HCI 23H2 クラスターを作成します。 |
|
ネットワーク モードで Azure Stack HCI 23H2 クラスター Switchless-SingleLink 作成 Azure にデプロイする |
このテンプレートは、ARM テンプレートを使用して Azure Stack HCI 23H2 クラスターを作成します。 |
|
Azure Key Vault とシークレット を作成する Azure にデプロイする |
このテンプレートでは、Azure Key Vault とシークレットが作成されます。 |
|
RBAC とシークレット を使用して Azure Key Vault を作成する Azure にデプロイする |
このテンプレートでは、Azure Key Vault とシークレットが作成されます。 アクセス ポリシーに依存する代わりに、Azure RBAC を利用してシークレットの承認を管理します |
|
プライベート エンドポイントを使用して Key Vault に接続 Azure にデプロイする |
このサンプルでは、仮想ネットワークとプライベート DNS ゾーンを構成して、プライベート エンドポイント経由で Key Vault にアクセスする方法を示します。 |
|
Key Vault とシークレットの一覧を作成 Azure にデプロイする |
このテンプレートでは、パラメーターと共に渡された Key Vault とキー コンテナー内のシークレットの一覧が作成されます。 |
|
Azure Key Vault に格納されている Azure Maps SAS トークンを作成する Azure にデプロイする |
このテンプレートは、Azure Maps アカウントをデプロイし、Azure Key Vault シークレットに格納する指定されたユーザー割り当て ID に基づいて Sas トークンを一覧表示します。 |
| Key Vault を使用して Application Gateway V2 を作成する Azure |
このテンプレートは、Application Gateway V2 を仮想ネットワークにデプロイし、ユーザー定義 ID、Key Vault、シークレット (証明書データ)、Key Vault と Application Gateway のアクセス ポリシーをデプロイします。 |
|
Azure Firewall Premium のテスト環境 Azure にデプロイする |
このテンプレートでは、侵入検査検出 (IDPS)、TLS 検査、Web カテゴリのフィルター処理などの Premium 機能を備えた Azure Firewall Premium とファイアウォール ポリシーを作成します |
|
ssh キーを作成して KeyVault に格納する Azure にデプロイする |
このテンプレートでは、deploymentScript リソースを使用して ssh キーを生成し、秘密キーを keyVault に格納します。 |
| Azure 関数アプリと HTTP によってトリガーされる関数 を Azure |
この例では、Azure 関数アプリと HTTP によってトリガーされる関数をテンプレートにインラインでデプロイします。 また、Key Vault をデプロイし、シークレットに関数アプリのホスト キーを設定します。 |
| 内部 API Management と Web App を使用した Application Gateway の Azure |
Azure Web アプリでホストされている Web API にサービスを提供する仮想ネットワーク (内部モード) API Management インスタンスにインターネット トラフィックをルーティングする Application Gateway。 |
Terraform (AzAPI プロバイダー) リソース定義
コンテナー/シークレットリソースの種類は、次を対象とする操作でデプロイできます。
- リソース グループの
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソースの形式
Microsoft.KeyVault/vaults/secrets リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.KeyVault/vaults/secrets@2016-10-01"
name = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
attributes = {
enabled = bool
exp = int
nbf = int
}
contentType = "string"
value = "string"
}
})
}
プロパティ値
vaults/secrets
| 名前 | 形容 | 価値 |
|---|---|---|
| 種類 | リソースの種類 | "Microsoft.KeyVault/vaults/secrets@2016-10-01" |
| 名前 | リソース名 | string (必須) 文字数制限: 1 ~ 127 有効な文字: 英数字とハイフン。 |
| parent_id | このリソースの親であるリソースの ID。 | 種類のリソースの ID: コンテナー |
| タグ | シークレットに割り当てられるタグ。 | タグ名と値のディクショナリ。 |
| プロパティ | シークレットのプロパティ | SecretProperties (必須) |
SecretProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| 属性 | シークレットの属性。 | SecretAttributes |
| contentType | シークレットのコンテンツ タイプ。 | 糸 |
| 価値 | シークレットの値。 注: このモデルを使用する API は ARM デプロイでの内部使用を目的とするため、サービスから 'value' は返されません。 ユーザーは、コンテナー シークレットとの対話にデータ プレーン REST サービスを使用する必要があります。 | 糸 |
SecretAttributes
| 名前 | 形容 | 価値 |
|---|---|---|
| 有効 | オブジェクトが有効かどうかを判断します。 | bool |
| exp | 1970-01-01T00:00:00Z 以降の有効期限 (秒)。 | int |
| nbf | 1970-01-01T00:00:00Z 以降の日付 (秒)。 | int |