你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Set-AzApiManagementApiSchema

  • 参考
模块:
Az.ApiManagement

修改 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 cmdlet 修改 Azure API 管理 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

提示你在运行 cmdlet 之前进行确认。

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

如果指定，则指定 Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApi 类型的实例，表示设置 API。

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

显示运行该 cmdlet 时会发生什么情况。 cmdlet 未运行。

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

输入

PsApiManagementContext

String

PsApiManagementApiSchema

SwitchParameter

输出

PsApiManagementApi