Microsoft.ApiManagement サービス/certificates 2022-04-01-preview
Bicep リソース定義
サービス/証明書のリソースの種類は、次を対象とする操作でデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドに関するページを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.ApiManagement/service/certificates リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.ApiManagement/service/certificates@2022-04-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
data: 'string'
keyVault: {
identityClientId: 'string'
secretIdentifier: 'string'
}
password: 'string'
}
}
プロパティ値
service/certificates
| 名前 | 説明 | 値 |
|---|---|---|
| name | リソース名 Bicep で子リソースの名前と型を設定する方法を参照してください。 |
string (必須) 文字数制限: 1 から 80 有効な文字: 英数字とハイフン。 先頭は文字、末尾は英数字にします。 |
| parent | Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。 詳細については、「 親リソースの外部にある子リソース」を参照してください。 |
種類のリソースのシンボル名: service |
| properties | 証明書の作成または更新のプロパティの詳細。 | CertificateCreateOrUpdatePropertiesOrCertificateCont... |
CertificateCreateOrUpdatePropertiesOrCertificateCont...
| 名前 | 説明 | 値 |
|---|---|---|
| data | アプリケーション/x-pkcs12 表現を使用して、Base 64 でエンコードされた証明書。 | string |
| keyVault | 証明書の KeyVault の場所の詳細。 | KeyVaultContractCreatePropertiesOrKeyVaultContractPr... |
| password | 証明書のパスワード | string |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
| 名前 | 説明 | 値 |
|---|---|---|
| identityClientId | Key Vault シークレットへのアクセスに使用される、SystemAssignedIdentity の場合は Null、UserAssignedIdentity の場合はクライアント ID。 | string |
| secretIdentifier | シークレットをフェッチするためのキー コンテナー シークレット識別子。 バージョン管理されたシークレットを指定すると、自動更新ができなくなります。 これには、API Management サービスを aka.ms/apimmsi で構成する必要があります | string |
クイック スタート テンプレート
次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。
| Template | 説明 |
|---|---|
テンプレートを使用して API Management インスタンスとそのすべてのサブリソースを作成する |
このテンプレートでは、API Management サービスを作成し、サブエンティティを構成する方法を示します |
ARM テンプレート リソース定義
サービス/証明書のリソースの種類は、次を対象とする操作でデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドに関するページを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.ApiManagement/service/certificates リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.ApiManagement/service/certificates",
"apiVersion": "2022-04-01-preview",
"name": "string",
"properties": {
"data": "string",
"keyVault": {
"identityClientId": "string",
"secretIdentifier": "string"
},
"password": "string"
}
}
プロパティ値
service/certificates
| 名前 | 説明 | 値 |
|---|---|---|
| type | リソースの種類 | 'Microsoft.ApiManagement/service/certificates' |
| apiVersion | リソース API のバージョン | '2022-04-01-preview' |
| name | リソース名 JSON ARM テンプレートで子リソースの名前と型を設定する方法を参照してください。 |
string (必須) 文字数制限: 1 から 80 有効な文字: 英数字とハイフン。 先頭は文字、末尾は英数字にします。 |
| properties | 証明書の作成または更新のプロパティの詳細。 | CertificateCreateOrUpdatePropertiesOrCertificateCont... |
CertificateCreateOrUpdatePropertiesOrCertificateCont...
| 名前 | 説明 | 値 |
|---|---|---|
| data | アプリケーション/x-pkcs12 表現を使用して Base 64 でエンコードされた証明書。 | string |
| keyVault | 証明書の KeyVault の場所の詳細。 | KeyVaultContractCreatePropertiesOrKeyVaultContractPr... |
| password | 証明書のパスワード | string |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
| 名前 | 説明 | 値 |
|---|---|---|
| identityClientId | SystemAssignedIdentity の場合は Null、UserAssignedIdentity の場合はクライアント ID で、キー コンテナーシークレットへのアクセスに使用されます。 | string |
| secretIdentifier | シークレットをフェッチするためのキー コンテナー シークレット識別子。 バージョン管理されたシークレットを指定すると、自動更新が防止されます。 これには、API Management サービスを aka.ms/apimmsi で構成する必要があります | string |
クイック スタート テンプレート
次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。
| Template | 説明 |
|---|---|
| テンプレートを使用して API Management インスタンスとそのすべてのサブリソースを作成する |
このテンプレートでは、API Management サービスを作成し、サブエンティティを構成する方法を示します |
Terraform (AzAPI プロバイダー) リソース定義
サービス/証明書リソースの種類は、次を対象とする操作でデプロイできます。
- リソース グループ
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.ApiManagement/service/certificates リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/certificates@2022-04-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
data = "string"
keyVault = {
identityClientId = "string"
secretIdentifier = "string"
}
password = "string"
}
})
}
プロパティ値
service/certificates
| 名前 | 説明 | 値 |
|---|---|---|
| type | リソースの種類 | "Microsoft.ApiManagement/service/certificates@2022-04-01-preview" |
| name | リソース名 | string (必須) 文字制限: 1 から 80 有効な文字: 英数字とハイフン。 先頭は文字、末尾は英数字にします。 |
| parent_id | このリソースの親であるリソースの ID。 | 種類のリソースの ID: サービス |
| properties | 証明書の作成または更新のプロパティの詳細。 | CertificateCreateOrUpdatePropertiesOrCertificateCont... |
CertificateCreateOrUpdatePropertiesOrCertificateCont...
| 名前 | 説明 | 値 |
|---|---|---|
| data | アプリケーション/x-pkcs12 表現を使用して Base 64 でエンコードされた証明書。 | string |
| keyVault | 証明書の KeyVault の場所の詳細。 | KeyVaultContractCreatePropertiesOrKeyVaultContractPr... |
| password | 証明書のパスワード | string |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
| 名前 | 説明 | 値 |
|---|---|---|
| identityClientId | SystemAssignedIdentity の場合は Null、UserAssignedIdentity の場合はクライアント ID で、キー コンテナーシークレットへのアクセスに使用されます。 | string |
| secretIdentifier | シークレットをフェッチするためのキー コンテナー シークレット識別子。 バージョン管理されたシークレットを指定すると、自動更新が防止されます。 これには、API Management サービスを aka.ms/apimmsi で構成する必要があります | string |