Set-AzApiManagementApiSchema
API スキーマを変更します
構文
Set-AzApiManagementApiSchema
-Context <PsApiManagementContext>
-ApiId <String>
-SchemaId <String>
[-SchemaDocumentContentType <String>]
[-SchemaDocument <String>]
[-SchemaDocumentFilePath <String>]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-AzApiManagementApiSchema
-InputObject <PsApiManagementApiSchema>
[-SchemaDocumentContentType <String>]
[-SchemaDocument <String>]
[-SchemaDocumentFilePath <String>]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-AzApiManagementApiSchema
-ResourceId <String>
[-SchemaDocumentContentType <String>]
[-SchemaDocument <String>]
[-SchemaDocumentFilePath <String>]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
説明
Set-AzApiManagementApiSchema コマンドレットは、Azure API Management API スキーマを変更します。
例
例 1: API スキーマを変更する
$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Set-AzApiManagementApiSchema -Context $ApiMgmtContext -ApiId "echo-api" -SchemaId "2"
この例では、API スキーマを更新します
例 2
API スキーマを変更します。 (自動生成)
Set-AzApiManagementApiSchema -ApiId 'echo-api' -Context <PsApiManagementContext> -SchemaDocumentContentType swaggerdefinition -SchemaDocumentFilePath C:\Users\sasolank\Downloads\petstoreschema.json -SchemaId '2'
パラメーター
-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 |
-InputObject
PsApiManagementApiSchema のインスタンス。 このパラメーターは必須です。
Type: | PsApiManagementApiSchema |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-PassThru
指定した場合、セット API を表す Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApi 型のインスタンス。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ResourceId
診断スキーマまたは API スキーマの Arm ResourceId。 このパラメーターは必須です。
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-SchemaDocument
文字列としての API スキーマ ドキュメント。 このパラメーターは必須です。-SchemaDocumentFile が指定されていません。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SchemaDocumentContentType
API スキーマの ContentType。 このパラメーターは省略可能です。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SchemaDocumentFilePath
API スキーマ ドキュメント ファイルのパス。 このパラメーターは必須です。-SchemaDocument が指定されていません。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SchemaId
既存のスキーマの識別子。 このパラメーターは必須です。
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
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 |