你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
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 swaggerdefinitioncmdlet New-AzApiManagementApiSchema 创建或更新 swagger-petstore-extensive aPI 的架构。
参数
-ApiId
API 的标识符。 此参数是必需的。
| 类型: | String |
| Position: | Named |
| 默认值: | None |
| 必需: | True |
| 接受管道输入: | True |
| 接受通配符: | False |
-Confirm
在运行 cmdlet 之前，提示你进行确认。
| 类型: | SwitchParameter |
| 别名: | cf |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-Context
PsApiManagementContext 的实例。 此参数是必需的。
| 类型: | PsApiManagementContext |
| Position: | Named |
| 默认值: | None |
| 必需: | True |
| 接受管道输入: | True |
| 接受通配符: | False |
-DefaultProfile
用于与 Azure 通信的凭据、帐户、租户和订阅。
| 类型: | IAzureContextContainer |
| 别名: | AzContext, AzureRmContext, AzureCredential |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-SchemaDocument
API 架构文档作为字符串。 未指定此参数 -SchemaDocumentFile 是必需的。
| 类型: | String |
| Position: | Named |
| 默认值: | None |
| 必需: | True |
| 接受管道输入: | True |
| 接受通配符: | False |
-SchemaDocumentContentType
API 架构的 ContentType。 此参数是必需的。
| 类型: | String |
| Position: | Named |
| 默认值: | None |
| 必需: | True |
| 接受管道输入: | True |
| 接受通配符: | False |
-SchemaDocumentFilePath
Api 架构文档文件路径。 未指定此参数 -SchemaDocument 是必需的。
| 类型: | String |
| Position: | Named |
| 默认值: | None |
| 必需: | True |
| 接受管道输入: | True |
| 接受通配符: | False |
-SchemaId
新架构的标识符。 此参数是可选的。 如果未指定，将生成。
| 类型: | String |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | True |
| 接受通配符: | False |
-WhatIf
显示 cmdlet 运行时会发生什么情况。 cmdlet 未运行。
| 类型: | SwitchParameter |
| 别名: | wi |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
