Dela via

Set-AzApiManagementApiSchema

  • Referens
Modul:
Az.ApiManagement

Ändrar ett 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>]

Description

Cmdleten Set-AzApiManagementApiSchema ändrar ett Azure API Management API-schema.

Exempel

Exempel 1: Ändrar ett API-schema

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

I exemplet uppdateras API-schemat

Exempel 2

Ändrar ett API-schema. (automatiskt genererad)

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

Parametrar

-ApiId

Identifierare för befintligt API. Den här parametern krävs.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-Confirm

Uppmanar dig att bekräfta innan du kör cmdleten.

Typ:SwitchParameter
Alias:cf
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-Context

Instans av PsApiManagementContext. Den här parametern krävs.

Typ:PsApiManagementContext
Position:Named
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-DefaultProfile

Autentiseringsuppgifter, konto, klientorganisation och prenumeration som används för kommunikation med Azure.

Typ:IAzureContextContainer
Alias:AzContext, AzureRmContext, AzureCredential
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-InputObject

Instans av PsApiManagementApiSchema. Den här parametern krävs.

Typ:PsApiManagementApiSchema
Position:Named
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-PassThru

Om det anges anger du instansen av typen Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApi som representerar det angivna API:et.

Typ:SwitchParameter
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-ResourceId

Arm ResourceId för diagnostik- eller API-schema. Den här parametern krävs.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-SchemaDocument

Api-schemadokument som en sträng. Den här parametern krävs -SchemaDocumentFile inte har angetts.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-SchemaDocumentContentType

ContentType för api-schemat. Den här parametern är valfri.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-SchemaDocumentFilePath

Sökväg till api-schemadokumentfil. Den här parametern krävs -SchemaDocument inte har angetts.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-SchemaId

Identifierare för befintligt schema. Den här parametern krävs.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-WhatIf

Visar vad som skulle hända om cmdleten körs. Cmdleten körs inte.

Typ:SwitchParameter
Alias:wi
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

Indata

PsApiManagementContext

String

PsApiManagementApiSchema

SwitchParameter

Utdata

PsApiManagementApi