Set-AzApiManagementApiSchema

  • Referenz
Modul:
Az.ApiManagement

Ändert ein API-Schema

Syntax

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

Beschreibung

Das Cmdlet Set-AzApiManagementApiSchema ändert ein Azure API-Verwaltungs-API-Schema.

Beispiele

Beispiel 1: Ändert ein API-Schema

$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Set-AzApiManagementApiSchema -Context $ApiMgmtContext -ApiId "echo-api" -SchemaId "2"

Im Beispiel wird das API-Schema aktualisiert.

Beispiel 2

Ändert ein API-Schema. (automatisch generiert)

Set-AzApiManagementApiSchema -ApiId 'echo-api' -Context <PsApiManagementContext> -SchemaDocumentContentType swaggerdefinition -SchemaDocumentFilePath C:\Users\sasolank\Downloads\petstoreschema.json -SchemaId '2'

Parameter

-ApiId

Bezeichner vorhandener 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

-InputObject

Instanz von PsApiManagementApiSchema. Dieser Parameter ist erforderlich.

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

-PassThru

Wenn angegeben, wird die Instanz von Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApi-Typ, der die Set-API darstellt.

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

-ResourceId

Arm ResourceId des Diagnose- oder API-Schemas. Dieser Parameter ist erforderlich.

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

-SchemaDocument

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

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

-SchemaDocumentContentType

ContentType des API-Schemas. Dieser Parameter ist optional.

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

-SchemaDocumentFilePath

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

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

-SchemaId

Bezeichner des vorhandenen Schemas. Dieser Parameter ist erforderlich.

Type:String
Position:Named
Default value:None
Required:True
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

PsApiManagementApiSchema

SwitchParameter

Ausgaben

PsApiManagementApi