New-AzApiManagementApiSchema

  • Referenz
Modul:
Az.ApiManagement

Erstellt das neue API-Schema im ApiManagement-Dienst

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

Beschreibung

Erstellt das neue API-Schema der API.

Beispiele

Beispiel 1: Erstellen eines neuen Schemas für die umfangreiche API für Swagger Petstore

$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

Das Cmdlet New-AzApiManagementApiSchema erstellt oder aktualisiert das Schema des swagger-petstore-extensive aPI.

Parameter

-ApiId

Bezeichner der API. Dieser Parameter ist erforderlich.

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

-Confirm

Hiermit werden Sie vor der Ausführung des Cmdlets zur Bestätigung aufgefordert.

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

-Context

Instanz von PsApiManagementContext. Dieser Parameter ist erforderlich.

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

-DefaultProfile

Anmeldeinformationen, Konto, Mandant und Abonnement für die Kommunikation mit Azure

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

-SchemaDocument

API-Schemadokument als Zeichenfolge. Dieser Parameter ist "-SchemaDocumentFile" ist nicht angegeben.

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

-SchemaDocumentContentType

ContentType des API-Schemas. Dieser Parameter ist erforderlich.

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

-SchemaDocumentFilePath

Api-Schema-Dokumentdateipfad. Dieser Parameter ist "-SchemaDocument" ist nicht angegeben.

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

-SchemaId

Bezeichner des neuen Schemas. Dieser Parameter ist optional. Wenn nicht angegeben, wird dies generiert.

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

-WhatIf

Zeigt, was geschieht, wenn das Cmdlet ausgeführt wird. Das Cmdlet wird nicht ausgeführt.

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

Eingaben

PsApiManagementContext

String

Ausgaben

PsApiManagementApiSchema