Partilhar via

Set-AzApiManagementApiVersionSet

  • Referência
Módulo:
Az.ApiManagement

Atualiza uma versão da API definida no contexto de gerenciamento da API.

Sintaxe

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

O cmdlet Set-AzApiManagementApiVersionSet modifica um Conjunto de Versões da API de Gerenciamento de API do Azure.

Exemplos

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

Este comando atualiza um conjunto de versões da API existente com esquema Header de controle de versão e parâmetro api-versionHeader.

Parâmetros

-ApiVersionSetId

Identificador do novo conjunto de versões da API.

Tipo:String
Position:Named
Default value:None
Necessário:True
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-Confirm

Solicita a sua confirmação antes de executar o cmdlet.

Tipo:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-Context

Instância de PsApiManagementContext. Este parâmetro é obrigatório.

Tipo:PsApiManagementContext
Position:Named
Default value:None
Necessário:True
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-DefaultProfile

As credenciais, a conta, o locatário e a assinatura usados para comunicação com o Azure.

Tipo:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-Description

Descrição do conjunto de versões da api.

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-HeaderName

O valor Header que conterá as informações de controle de versão. Se o versionamento Scheme HEADER for escolhido, esse valor deverá ser especificado.

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-InputObject

Instância de PsApiManagementApiVersionSet. Este parâmetro é obrigatório.

Tipo:PsApiManagementApiVersionSet
Position:Named
Default value:None
Necessário:True
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-Name

O nome do conjunto ApiVersion. Este parâmetro é opcional.

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-PassThru

Se especificado, a instância de Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiVersionSet, tipo que representa o apiVersionSet modificado, será gravada na saída.

Tipo:SwitchParameter
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-QueryName

O valor Query que conterá as informações de controle de versão. Se a Consulta de Esquema de Controle de Versão for escolhida, esse valor deverá ser especificado.

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-Scheme

Esquema de versionamento a ser selecionado para o conjunto de versionamento de api. Este parâmetro é opcional.

Tipo:PsApiManagementVersioningScheme
Valores aceites:Segment, Query, Header
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-WhatIf

Apresenta o que aconteceria mediante a execução do cmdlet. O cmdlet não é executado.

Tipo:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

Entradas

PsApiManagementContext

PsApiManagementApiVersionSet

String

PsApiManagementVersioningScheme

Saídas

PsApiManagementApiVersionSet