Dela via

Set-AzApiManagementApiVersionSet

  • Referens
Modul:
Az.ApiManagement

Uppdaterar en API-versionsuppsättning i API Management-kontexten.

Syntax

Set-AzApiManagementApiVersionSet
   -Context <PsApiManagementContext>
   -ApiVersionSetId <String>
   [-Name <String>]
   [-Scheme <PsApiManagementVersioningScheme>]
   [-HeaderName <String>]
   [-QueryName <String>]
   [-Description <String>]
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzApiManagementApiVersionSet
   -InputObject <PsApiManagementApiVersionSet>
   [-Name <String>]
   [-Scheme <PsApiManagementVersioningScheme>]
   [-HeaderName <String>]
   [-QueryName <String>]
   [-Description <String>]
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Cmdleten Set-AzApiManagementApiVersionSet ändrar en Versionsuppsättning för Azure API Management API.

Exempel

Exempel 1

$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Set-AzApiManagementApiVersionSet -Context $ApiMgmtContext -ApiVersionSetId "query-verion-set" -Scheme Header -HeaderName "api-version" -Description "Azure version header string"

Det här kommandot uppdaterar en befintlig API-versionsuppsättning med versionsschemat Header och rubrikparametern api-version.

Parametrar

-ApiVersionSetId

Identifierare för ny API-versionsuppsättning.

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

-Description

Beskrivning av api-versionsuppsättningen.

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

-HeaderName

Rubrikvärdet som innehåller versionsinformationen. Om du väljer rubrik för versionsschemat måste det här värdet anges.

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

-InputObject

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

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

-Name

Namnet på ApiVersion-uppsättningen. Den här parametern är valfri.

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

-PassThru

Om det anges skrivs instansen av typen Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiVersionSet som representerar den ändrade apiVersionSet till utdata.

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

-QueryName

Frågevärdet som innehåller versionsinformationen. Om du väljer schemafråga för versionshantering måste det här värdet anges.

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

-Scheme

Versionsschema som ska väljas för api-versionsuppsättningen. Den här parametern är valfri.

Typ:PsApiManagementVersioningScheme
Godkända värden:Segment, Query, Header
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-WhatIf

Visar vad som skulle hända om kommandot 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

Utdata