Partager via


Set-AzApiManagementBackend

Met à jour un serveur principal.

Syntaxe

ContextParameterSet (Par défaut)

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

Met à jour un back-end existant dans gestion des API.

Exemples

Exemple 1 : Met à jour la description du back-end 123

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

Exemple 2

Met à jour un serveur principal. (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'

Paramètres

-BackendId

Identificateur du nouveau back-end. Ce paramètre est obligatoire.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

ContextParameterSet
Position:Named
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-Confirm

Vous invite à confirmer avant d’exécuter l’applet de commande.

Propriétés du paramètre

Type:SwitchParameter
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False
Alias:cf

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Context

Instance de PsApiManagementContext. Ce paramètre est obligatoire.

Propriétés du paramètre

Type:PsApiManagementContext
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

ContextParameterSet
Position:Named
Obligatoire:True
Valeur du pipeline:True
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-Credential

Détails des informations d’identification qui doivent être utilisés lors de la conversation avec le serveur principal. Ce paramètre est facultatif.

Propriétés du paramètre

Type:PsApiManagementBackendCredential
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-DefaultProfile

Informations d’identification, compte, locataire et abonnement utilisés pour la communication avec Azure.

Propriétés du paramètre

Type:IAzureContextContainer
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False
Alias:AzContext, AzureRmContext, AzureCredential

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Description

Description du back-end. Ce paramètre est facultatif.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-InputObject

Instance de PsApiManagementBackend. Ce paramètre est obligatoire.

Propriétés du paramètre

Type:PsApiManagementBackend
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

ByInputObject
Position:Named
Obligatoire:True
Valeur du pipeline:True
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-PassThru

Indique que cette applet de commande retourne le PsApiManagementBackend modifié par cette applet de commande.

Propriétés du paramètre

Type:SwitchParameter
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-Protocol

Protocole de communication back-end (http ou soap). Ce paramètre est facultatif

Propriétés du paramètre

Type:String
Valeur par défaut:None
Valeurs acceptées:http, soap
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-Proxy

Détails du serveur proxy à utiliser lors de l’envoi d’une demande au serveur principal. Ce paramètre est facultatif.

Propriétés du paramètre

Type:PsApiManagementBackendProxy
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-ResourceId

URI de gestion de la ressource dans le système externe. URL http absolue de la ressource Azure. Ce paramètre est facultatif.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-ServiceFabricCluster

Détails du serveur principal du cluster Service Fabric. Ce paramètre est facultatif.

Propriétés du paramètre

Type:PsApiManagementServiceFabric
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-SkipCertificateChainValidation

Indique s’il faut ignorer la validation de la chaîne de certificats lors de la conversation avec le serveur principal. Ce paramètre est facultatif.

Propriétés du paramètre

Type:

Nullable<T>[Boolean]

Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-SkipCertificateNameValidation

Indique s’il faut ignorer la validation du nom du certificat lors de la conversation avec le serveur principal. Ce paramètre est facultatif.

Propriétés du paramètre

Type:

Nullable<T>[Boolean]

Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-Title

Titre du back-end. Ce paramètre est facultatif.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-Url

URL du runtime pour le back-end. Ce paramètre est facultatif.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-WhatIf

Affiche ce qui se passerait si l’applet de commande s’exécute. L’applet de commande ne s’exécute pas.

Propriétés du paramètre

Type:SwitchParameter
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False
Alias:Wi

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

CommonParameters

Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters.

Entrées

PsApiManagementContext

String

Nullable<T>

PsApiManagementBackendCredential

PsApiManagementBackendProxy

PsApiManagementServiceFabric

SwitchParameter

Sorties

PsApiManagementBackend