Microsoft.ApiManagement service/workspaces/apis/schemas 2023-03-01-preview
Bicep リソース定義
サービス/ワークスペース/apis/schemas リソースの種類は、次を対象とする操作と共にデプロイできます。
- リソース グループの - リソース グループのデプロイ コマンド 参照
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソースの形式
Microsoft.ApiManagement/service/workspaces/apis/schemas リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.ApiManagement/service/workspaces/apis/schemas@2023-03-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
contentType: 'string'
document: {
components: any(Azure.Bicep.Types.Concrete.AnyType)
definitions: any(Azure.Bicep.Types.Concrete.AnyType)
value: 'string'
}
}
}
プロパティ値
Microsoft.ApiManagement/service/workspaces/apis/schemas
| 名前 | 形容 | 価値 |
|---|---|---|
| 名前 | リソース名 | 糸 制約： 最小長 = 1 最大長 = 80 (必須) |
| 親 | Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。 詳細については、「親リソースの外部 |
種類のリソースのシンボリック名: service/workspaces/apis |
| プロパティ | API スキーマのプロパティ。 | SchemaContractProperties |
SchemaContractProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| contentType | RFC 2616 で定義されている Content-Type ヘッダーで使用される有効なメディア タイプである必要があります。 スキーマ ドキュメントのメディアの種類 (application/json、application/xml など)。 - Swagger Schema use application/vnd.ms-azure-apim.swagger.definitions+json - WSDL Schema use application/vnd.ms-azure-apim.xsd+xml - OpenApi Schema use application/vnd.oai.openapi.components+json - WADL Schema
application/vnd.ms-azure-apim.wadl.grammars+xml 使用する - を使用 OData Schemaapplication/vnd.ms-azure-apim.odata.schema。 |
string (必須) |
| 文書 | API スキーマ ドキュメントのプロパティを作成または更新します。 | SchemaDocumentProperties (必須) |
SchemaDocumentProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| コンポーネント | 型の定義。 Swagger/OpenAPI v2/v3 スキーマでのみ使用され、それ以外の場合は null。 | 任意 |
| 定義 | 型の定義。 Swagger/OpenAPI v1 スキーマにのみ使用され、それ以外の場合は null。 | 任意 |
| 価値 | スキーマを表すドキュメントを定義する Json エスケープ文字列。 Swagger/OpenAPI 以外のスキーマに使用されます。 | 糸 |
ARM テンプレート リソース定義
サービス/ワークスペース/apis/schemas リソースの種類は、次を対象とする操作と共にデプロイできます。
- リソース グループの - リソース グループのデプロイ コマンド 参照
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソースの形式
Microsoft.ApiManagement/service/workspaces/apis/schemas リソースを作成するには、テンプレートに次の JSON を追加します。
{
"type": "Microsoft.ApiManagement/service/workspaces/apis/schemas",
"apiVersion": "2023-03-01-preview",
"name": "string",
"properties": {
"contentType": "string",
"document": {
"components": {},
"definitions": {},
"value": "string"
}
}
}
プロパティ値
Microsoft.ApiManagement/service/workspaces/apis/schemas
| 名前 | 形容 | 価値 |
|---|---|---|
| apiVersion | API のバージョン | '2023-03-01-preview' |
| 名前 | リソース名 | 糸 制約： 最小長 = 1 最大長 = 80 (必須) |
| プロパティ | API スキーマのプロパティ。 | SchemaContractProperties |
| 種類 | リソースの種類 | 'Microsoft.ApiManagement/service/workspaces/apis/schemas' |
SchemaContractProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| contentType | RFC 2616 で定義されている Content-Type ヘッダーで使用される有効なメディア タイプである必要があります。 スキーマ ドキュメントのメディアの種類 (application/json、application/xml など)。 - Swagger Schema use application/vnd.ms-azure-apim.swagger.definitions+json - WSDL Schema use application/vnd.ms-azure-apim.xsd+xml - OpenApi Schema use application/vnd.oai.openapi.components+json - WADL Schema
application/vnd.ms-azure-apim.wadl.grammars+xml 使用する - を使用 OData Schemaapplication/vnd.ms-azure-apim.odata.schema。 |
string (必須) |
| 文書 | API スキーマ ドキュメントのプロパティを作成または更新します。 | SchemaDocumentProperties (必須) |
SchemaDocumentProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| コンポーネント | 型の定義。 Swagger/OpenAPI v2/v3 スキーマでのみ使用され、それ以外の場合は null。 | 任意 |
| 定義 | 型の定義。 Swagger/OpenAPI v1 スキーマにのみ使用され、それ以外の場合は null。 | 任意 |
| 価値 | スキーマを表すドキュメントを定義する Json エスケープ文字列。 Swagger/OpenAPI 以外のスキーマに使用されます。 | 糸 |
Terraform (AzAPI プロバイダー) リソース定義
サービス/ワークスペース/apis/schemas リソースの種類は、次を対象とする操作と共にデプロイできます。
- リソース グループの
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソースの形式
Microsoft.ApiManagement/service/workspaces/apis/schemas リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/workspaces/apis/schemas@2023-03-01-preview"
name = "string"
body = jsonencode({
properties = {
contentType = "string"
document = {
components = ?
definitions = ?
value = "string"
}
}
})
}
プロパティ値
Microsoft.ApiManagement/service/workspaces/apis/schemas
| 名前 | 形容 | 価値 |
|---|---|---|
| 名前 | リソース名 | 糸 制約： 最小長 = 1 最大長 = 80 (必須) |
| parent_id | このリソースの親であるリソースの ID。 | 種類のリソースの ID: service/workspaces/apis |
| プロパティ | API スキーマのプロパティ。 | SchemaContractProperties |
| 種類 | リソースの種類 | "Microsoft.ApiManagement/service/workspaces/apis/schemas@2023-03-01-preview" |
SchemaContractProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| contentType | RFC 2616 で定義されている Content-Type ヘッダーで使用される有効なメディア タイプである必要があります。 スキーマ ドキュメントのメディアの種類 (application/json、application/xml など)。 - Swagger Schema use application/vnd.ms-azure-apim.swagger.definitions+json - WSDL Schema use application/vnd.ms-azure-apim.xsd+xml - OpenApi Schema use application/vnd.oai.openapi.components+json - WADL Schema
application/vnd.ms-azure-apim.wadl.grammars+xml 使用する - を使用 OData Schemaapplication/vnd.ms-azure-apim.odata.schema。 |
string (必須) |
| 文書 | API スキーマ ドキュメントのプロパティを作成または更新します。 | SchemaDocumentProperties (必須) |
SchemaDocumentProperties
| 名前 | 形容 | 価値 |
|---|---|---|
| コンポーネント | 型の定義。 Swagger/OpenAPI v2/v3 スキーマでのみ使用され、それ以外の場合は null。 | 任意 |
| 定義 | 型の定義。 Swagger/OpenAPI v1 スキーマにのみ使用され、それ以外の場合は null。 | 任意 |
| 価値 | スキーマを表すドキュメントを定義する Json エスケープ文字列。 Swagger/OpenAPI 以外のスキーマに使用されます。 | 糸 |