Compartilhar via


Set-AzApiManagementBackend

Atualiza um back-end.

Sintaxe

ContextParameterSet (Default)

Set-AzApiManagementBackend
    -Context <PsApiManagementContext>
    -BackendId <String>
    [-Protocol <String>]
    [-Url <String>]
    [-ResourceId <String>]
    [-Title <String>]
    [-Description <String>]
    [-SkipCertificateChainValidation <Boolean>]
    [-SkipCertificateNameValidation <Boolean>]
    [-Credential <PsApiManagementBackendCredential>]
    [-Proxy <PsApiManagementBackendProxy>]
    [-ServiceFabricCluster <PsApiManagementServiceFabric>]
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByInputObject

Set-AzApiManagementBackend
    -InputObject <PsApiManagementBackend>
    [-Protocol <String>]
    [-Url <String>]
    [-ResourceId <String>]
    [-Title <String>]
    [-Description <String>]
    [-SkipCertificateChainValidation <Boolean>]
    [-SkipCertificateNameValidation <Boolean>]
    [-Credential <PsApiManagementBackendCredential>]
    [-Proxy <PsApiManagementBackendProxy>]
    [-ServiceFabricCluster <PsApiManagementServiceFabric>]
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Atualiza um back-end existente no Gerenciamento de API.

Exemplos

Exemplo 1: atualiza a descrição do back-end 123

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Set-AzApiManagementBackend -Context $apimContext -BackendId 123 -Description "updated description" -PassThru

Exemplo 2

Atualiza um back-end. (autogenerated)

Set-AzApiManagementBackend -BackendId 123 -Context <PsApiManagementContext> -Credential <PsApiManagementBackendCredential> -Protocol http -ResourceId /subscriptions/subid/resourceGroups/Api-Default-West-US/providers/Microsoft.ApiManagement/service/contoso -Url 'https://contoso.com/awesomeapi'

Parâmetros

-BackendId

Identificador do novo back-end. Este parâmetro é obrigatório.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

ContextParameterSet
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-Confirm

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

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:cf

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Context

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

Propriedades do parâmetro

Tipo:PsApiManagementContext
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

ContextParameterSet
Cargo:Named
Obrigatório:True
Valor do pipeline:True
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-Credential

Detalhes de credencial que devem ser usados ao falar com o Back-end. Esse parâmetro é opcional.

Propriedades do parâmetro

Tipo:PsApiManagementBackendCredential
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-DefaultProfile

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

Propriedades do parâmetro

Tipo:IAzureContextContainer
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Description

Descrição do back-end. Esse parâmetro é opcional.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-InputObject

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

Propriedades do parâmetro

Tipo:PsApiManagementBackend
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

ByInputObject
Cargo:Named
Obrigatório:True
Valor do pipeline:True
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-PassThru

Indica que esse cmdlet retorna o PsApiManagementBackend que este cmdlet modifica.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-Protocol

Protocolo de comunicação de back-end (http ou sabão). Esse parâmetro é opcional

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Valores aceitos:http, soap
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-Proxy

Detalhes do Servidor Proxy a serem usados durante o envio da solicitação para o back-end. Esse parâmetro é opcional.

Propriedades do parâmetro

Tipo:PsApiManagementBackendProxy
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-ResourceId

Uri de gerenciamento do recurso no sistema externo. A URL http absoluta do Recurso do Azure. Esse parâmetro é opcional.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-ServiceFabricCluster

Detalhes do back-end do cluster do Service Fabric. Esse parâmetro é opcional.

Propriedades do parâmetro

Tipo:PsApiManagementServiceFabric
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-SkipCertificateChainValidation

Se deseja ignorar a validação da cadeia de certificados ao falar com o back-end. Esse parâmetro é opcional.

Propriedades do parâmetro

Tipo:

Nullable<T>[Boolean]

Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-SkipCertificateNameValidation

Se deseja ignorar a validação de nome de certificado ao falar com o back-end. Esse parâmetro é opcional.

Propriedades do parâmetro

Tipo:

Nullable<T>[Boolean]

Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-Title

Título de back-end. Esse parâmetro é opcional.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-Url

Url de runtime para o back-end. Esse parâmetro é opcional.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-WhatIf

Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:wi

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

CommonParameters

Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.

Entradas

PsApiManagementContext

String

Nullable<T>

PsApiManagementBackendCredential

PsApiManagementBackendProxy

PsApiManagementServiceFabric

SwitchParameter

Saídas

PsApiManagementBackend