SchemaContract interface
API スキーマ コントラクトの詳細。
- Extends
プロパティ
components | 型の定義。 Swagger/OpenAPI v2/v3 スキーマにのみ使用され、それ以外の場合は null。 |
content |
RFC 2616 で定義されている Content-Type ヘッダーで使用される有効なメディアの種類である必要があります。 スキーマ ドキュメントのメディアの種類 (application/json、application/xml など)。
|
definitions | 型の定義。 Swagger/OpenAPI v1 スキーマにのみ使用され、それ以外の場合は null。 |
value | スキーマを表すドキュメントを定義する Json エスケープ文字列。 Swagger/OpenAPI 以外のスキーマに使用されます。 |
継承されたプロパティ
id | リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} 注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。 |
name | リソース名注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。 |
type | リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts" 注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。 |
プロパティの詳細
components
型の定義。 Swagger/OpenAPI v2/v3 スキーマにのみ使用され、それ以外の場合は null。
components?: Record<string, unknown>
プロパティ値
Record<string, unknown>
contentType
RFC 2616 で定義されている Content-Type ヘッダーで使用される有効なメディアの種類である必要があります。 スキーマ ドキュメントのメディアの種類 (application/json、application/xml など)。
-
Swagger
スキーマを使用application/vnd.ms-azure-apim.swagger.definitions+json
- WSDL
するスキーマ使用OpenApi
- application/vnd.ms-azure-apim.xsd+xml
スキーマを使用して を使用application/vnd.ms-azure-apim.wadl.grammars+xml
application/vnd.oai.openapi.components+json
- WADL Schema
します。
contentType?: string
プロパティ値
string
definitions
型の定義。 Swagger/OpenAPI v1 スキーマにのみ使用され、それ以外の場合は null。
definitions?: Record<string, unknown>
プロパティ値
Record<string, unknown>
value
スキーマを表すドキュメントを定義する Json エスケープ文字列。 Swagger/OpenAPI 以外のスキーマに使用されます。
value?: string
プロパティ値
string
継承されたプロパティの詳細
id
リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} 注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。
id?: string
プロパティ値
string
name
リソース名注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。
name?: string
プロパティ値
string
type
リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts" 注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。
type?: string
プロパティ値
string