Compartir a través de

New-AzApiManagementApiSchema

  • Referencia
Módulo:
Az.ApiManagement

Crea el nuevo esquema de API en el servicio ApiManagement.

Syntax

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>]

Description

Crea el nuevo esquema de API de la API.

Ejemplos

Ejemplo 1: Creación de un nuevo esquema para Swagger Petstore Extensive 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

El cmdlet New-AzApiManagementApiSchema crea o actualiza el esquema de aPI swagger-petstore-extensive .

Parámetros

-ApiId

Identificador de api. Este parámetro es obligatorio.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Confirm

Le solicita su confirmación antes de ejecutar el cmdlet.

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

-Context

Instancia de PsApiManagementContext. Este parámetro es obligatorio.

Type:PsApiManagementContext
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-DefaultProfile

Credenciales, cuenta, inquilino y suscripción usados para la comunicación con Azure.

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SchemaDocument

Documento de esquema de API como una cadena. Este parámetro es obligatorio: no se especifica SchemaDocumentFile.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-SchemaDocumentContentType

ContentType del esquema de api. Este parámetro es obligatorio.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-SchemaDocumentFilePath

Ruta de acceso del archivo del documento de esquema de API. Este parámetro es obligatorio: no se especifica SchemaDocument.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-SchemaId

Identificador del nuevo esquema. Este parámetro es opcional. Si no se especifica, se generará.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Muestra lo que sucedería si se ejecutara el cmdlet. El cmdlet no se ejecuta.

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

Entradas

PsApiManagementContext

String

Salidas

PsApiManagementApiSchema