New-AzApiManagementApiSchema
ApiManagement サービスに新しい API スキーマを作成します。
構文
New-AzApiManagementApiSchema
-Context <PsApiManagementContext>
-ApiId <String>
[-SchemaId <String>]
-SchemaDocumentContentType <String>
-SchemaDocument <String>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] New-AzApiManagementApiSchema
-Context <PsApiManagementContext>
-ApiId <String>
[-SchemaId <String>]
-SchemaDocumentContentType <String>
-SchemaDocumentFilePath <String>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] 説明
API の新しい API スキーマを作成します。
例
例 1: Swagger Petstore の広範な API の新しいスキーマを作成する
$context = New-AzApiManagementContext -ResourceId /subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.ApiManagement/service/sdktestapim4163
New-AzApiManagementApiSchema -Context $context -ApiId swagger-petstore-extensive -SchemaDocumentContentType swaggerdefinition -SchemaDocumentFilePath C:\Users\sasolank\Downloads\petstoreschema.json
Schema Id Api Id Schema ContentType
--------- ------ ------------------
3e8892eb-98e4-408d-b77a-f424185c1044 swagger-petstore-extensive swaggerdefinitionコマンドレット New-AzApiManagementApiSchema は、aPI のスキーマを swagger-petstore-extensive 作成または更新します。
パラメーター
-ApiId
API の識別子。 このパラメーターは必須です。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Confirm
コマンドレットの実行前に確認を求めるメッセージが表示されます。
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Context
PsApiManagementContext のインスタンス。 このパラメーターは必須です。
| Type: | PsApiManagementContext |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-DefaultProfile
Azure との通信のために使用される資格情報、アカウント、テナント、サブスクリプションです。
| Type: | IAzureContextContainer |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SchemaDocument
文字列としての API スキーマ ドキュメント。 このパラメーターは必須です。-SchemaDocumentFile が指定されていません。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SchemaDocumentContentType
API スキーマの ContentType。 このパラメーターは必須です。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SchemaDocumentFilePath
API スキーマ ドキュメント ファイルのパス。 このパラメーターは必須です。-SchemaDocument が指定されていません。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SchemaId
新しいスキーマの識別子。 このパラメーターは省略可能です。 指定しない場合は生成されます。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-WhatIf
コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |