Microsoft.ApiManagement service/apis/schemas 2021-12-01-preview
Bicep リソース定義
service/apis/schemas リソースの種類は、次をターゲットとする操作でデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.ApiManagement/service/apis/schemas リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.ApiManagement/service/apis/schemas@2021-12-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
contentType: 'string'
document: {
components: any()
definitions: any()
value: 'string'
}
}
}
プロパティ値
service/apis/schemas
| 名前 | 説明 | 値 |
|---|---|---|
| name | リソース名 Bicep で子リソースの名前と型を設定する方法を参照してください。 |
string (必須) 文字制限: 1 から 80 有効な文字: 英数字とハイフン。 先頭は文字、末尾は英数字にします。 |
| parent | Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。 詳細については、「 親リソースの外部の子リソース」を参照してください。 |
型のリソースのシンボル名: apis |
| properties | API スキーマのプロパティ。 | SchemaContractProperties |
SchemaContractProperties
| 名前 | 説明 | 値 |
|---|---|---|
| contentType | RFC 2616 で定義されている Content-Type ヘッダーで使用される有効なメディアの種類である必要があります。 スキーマ ドキュメントのメディアの種類 (application/json、application/xml など)。 - Swagger スキーマの使用 application/vnd.ms-azure-apim.swagger.definitions+json - WSDL スキーマの使用 application/vnd.ms-azure-apim.xsd+xml - OpenApi スキーマの使用 application/vnd.oai.openapi.components+json - WADL Schema を使用します application/vnd.ms-azure-apim.wadl.grammars+xml。 |
string (必須) |
| ドキュメント | API スキーマ ドキュメントのプロパティを作成または更新します。 | SchemaDocumentProperties |
SchemaDocumentProperties
| 名前 | 説明 | 値 |
|---|---|---|
| components | 型の定義。 Swagger/OpenAPI v2/v3 スキーマでのみ使用され、それ以外の場合は null。 | Bicep の場合は、 any() 関数を使用できます。 |
| definitions | 型の定義。 Swagger/OpenAPI v1 スキーマでのみ使用され、それ以外の場合は null。 | Bicep の場合は、 any() 関数を使用できます。 |
| value | スキーマを表すドキュメントを定義する Json エスケープ文字列。 Swagger/OpenAPI 以外のスキーマに使用されます。 | string |
ARM テンプレート リソース定義
service/apis/schemas リソースの種類は、次をターゲットとする操作でデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.ApiManagement/service/apis/schemas リソースを作成するには、テンプレートに次の JSON を追加します。
{
"type": "Microsoft.ApiManagement/service/apis/schemas",
"apiVersion": "2021-12-01-preview",
"name": "string",
"properties": {
"contentType": "string",
"document": {
"components": {},
"definitions": {},
"value": "string"
}
}
}
プロパティ値
service/apis/schemas
| 名前 | 説明 | 値 |
|---|---|---|
| type | リソースの種類 | 'Microsoft.ApiManagement/service/apis/schemas' |
| apiVersion | リソース API のバージョン | '2021-12-01-preview' |
| name | リソース名 JSON ARM テンプレートで子リソースの名前と型を設定する方法を参照してください。 |
string (必須) 文字制限: 1 から 80 有効な文字: 英数字とハイフン。 先頭は文字、末尾は英数字にします。 |
| properties | API スキーマのプロパティ。 | SchemaContractProperties |
SchemaContractProperties
| 名前 | 説明 | 値 |
|---|---|---|
| contentType | RFC 2616 で定義されている Content-Type ヘッダーで使用される有効なメディアの種類である必要があります。 スキーマ ドキュメントのメディアの種類 (application/json、application/xml など)。 - Swagger スキーマの使用 application/vnd.ms-azure-apim.swagger.definitions+json - WSDL スキーマの使用 application/vnd.ms-azure-apim.xsd+xml - OpenApi スキーマの使用 application/vnd.oai.openapi.components+json - WADL Schema を使用します application/vnd.ms-azure-apim.wadl.grammars+xml。 |
string (必須) |
| ドキュメント | API スキーマ ドキュメントのプロパティを作成または更新します。 | SchemaDocumentProperties |
SchemaDocumentProperties
| 名前 | 説明 | 値 |
|---|---|---|
| components | 型の定義。 Swagger/OpenAPI v2/v3 スキーマでのみ使用され、それ以外の場合は null。 | |
| definitions | 型の定義。 Swagger/OpenAPI v1 スキーマでのみ使用され、それ以外の場合は null。 | |
| value | スキーマを表すドキュメントを定義する Json エスケープ文字列。 Swagger/OpenAPI 以外のスキーマに使用されます。 | string |
Terraform (AzAPI プロバイダー) リソース定義
service/apis/schemas リソースの種類は、次をターゲットとする操作でデプロイできます。
- リソース グループ
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.ApiManagement/service/apis/schemas リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/apis/schemas@2021-12-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
contentType = "string"
document = {
value = "string"
}
}
})
}
プロパティ値
service/apis/schemas
| 名前 | 説明 | 値 |
|---|---|---|
| type | リソースの種類 | "Microsoft.ApiManagement/service/apis/schemas@2021-12-01-preview" |
| name | リソース名 | string (必須) 文字制限: 1 から 80 有効な文字: 英数字とハイフン。 先頭は文字、末尾は英数字にします。 |
| parent_id | このリソースの親であるリソースの ID。 | 種類のリソースの ID: apis |
| properties | API スキーマのプロパティ。 | SchemaContractProperties |
SchemaContractProperties
| 名前 | 説明 | 値 |
|---|---|---|
| contentType | RFC 2616 で定義されている Content-Type ヘッダーで使用される有効なメディアの種類である必要があります。 スキーマ ドキュメントのメディアの種類 (application/json、application/xml など)。 - Swagger スキーマの使用 application/vnd.ms-azure-apim.swagger.definitions+json - WSDL スキーマの使用 application/vnd.ms-azure-apim.xsd+xml - OpenApi スキーマの使用 application/vnd.oai.openapi.components+json - WADL Schema を使用します application/vnd.ms-azure-apim.wadl.grammars+xml。 |
string (必須) |
| ドキュメント | API スキーマ ドキュメントのプロパティを作成または更新します。 | SchemaDocumentProperties |
SchemaDocumentProperties
| 名前 | 説明 | 値 |
|---|---|---|
| components | 型の定義。 Swagger/OpenAPI v2/v3 スキーマでのみ使用され、それ以外の場合は null。 | |
| definitions | 型の定義。 Swagger/OpenAPI v1 スキーマでのみ使用され、それ以外の場合は null。 | |
| value | スキーマを表すドキュメントを定義する Json エスケープ文字列。 Swagger/OpenAPI 以外のスキーマに使用されます。 | string |