Condividi tramite

Set-AzApiManagementApiVersionSet

  • Riferimento
Modulo:
Az.ApiManagement

Aggiorna un set di versioni dell'API nel contesto di Gestione API.

Sintassi

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

Descrizione

Il cmdlet Set-AzApiManagementApiVersionSet modifica un set di versioni dell'API di Gestione API di Azure.

Esempio

Esempio 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"

Questo comando aggiorna un set di versioni dell'API esistente con lo schema di controllo delle versioni Header e il parametro Header api-version.

Parametri

-ApiVersionSetId

Identificatore per il nuovo set di versioni dell'API.

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:True
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-Confirm

Richiede conferma prima di eseguire il cmdlet.

Tipo:SwitchParameter
Alias:cf
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-Context

Istanza di PsApiManagementContext. Questo parametro è obbligatorio.

Tipo:PsApiManagementContext
Posizione:Named
Valore predefinito:None
Necessario:True
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-DefaultProfile

Credenziali, account, tenant e sottoscrizione usati per la comunicazione con Azure.

Tipo:IAzureContextContainer
Alias:AzContext, AzureRmContext, AzureCredential
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-Description

Descrizione del set di versioni dell'API.

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-HeaderName

Valore header che conterrà le informazioni sul controllo delle versioni. Se si seleziona l'intestazione dello schema di controllo delle versioni, è necessario specificare questo valore.

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-InputObject

Istanza di PsApiManagementApiVersionSet. Questo parametro è obbligatorio.

Tipo:PsApiManagementApiVersionSet
Posizione:Named
Valore predefinito:None
Necessario:True
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-Name

Nome del set ApiVersion. Questo parametro è facoltativo.

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-PassThru

Se specificato, l'istanza di Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiVersionSet che rappresenta l'apiVersionSet modificato verrà scritta nell'output.

Tipo:SwitchParameter
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-QueryName

Valore query che conterrà le informazioni sul controllo delle versioni. Se si seleziona Query schema di controllo delle versioni, è necessario specificare questo valore.

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-Scheme

Schema di controllo delle versioni da selezionare per il set di versioni api. Questo parametro è facoltativo.

Tipo:PsApiManagementVersioningScheme
Valori accettati:Segment, Query, Header
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-WhatIf

Mostra cosa accadrebbe se il cmdlet viene eseguito. Il cmdlet non viene eseguito.

Tipo:SwitchParameter
Alias:wi
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

Input

PsApiManagementContext

PsApiManagementApiVersionSet

String

PsApiManagementVersioningScheme

Output

PsApiManagementApiVersionSet