Partager via

Set-AzApiManagementBackend

  • Référence
Module:
Az.ApiManagement

Met à jour un serveur principal.

Syntaxe

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>]
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. (généré automatiquement)

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.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-Confirm

Vous demande une confirmation avant d’exécuter l’applet de commande.

Type:SwitchParameter
Alias:cf
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Context

Instance de PsApiManagementContext. Ce paramètre est obligatoire.

Type:PsApiManagementContext
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques: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.

Type:PsApiManagementBackendCredential
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-DefaultProfile

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

Type:IAzureContextContainer
Alias:AzContext, AzureRmContext, AzureCredential
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Description

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

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-InputObject

Instance de PsApiManagementBackend. Ce paramètre est obligatoire.

Type:PsApiManagementBackend
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-PassThru

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

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-Protocol

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

Type:String
Valeurs acceptées:http, soap
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-Proxy

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

Type:PsApiManagementBackendProxy
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques: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.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-ServiceFabricCluster

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

Type:PsApiManagementServiceFabric
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques: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.

Type:Nullable<T>[Boolean]
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques: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.

Type:Nullable<T>[Boolean]
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-Title

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

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-Url

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

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-WhatIf

Montre ce qui se passe en cas d’exécution de l’applet de commande. L’applet de commande n’est pas exécutée.

Type:SwitchParameter
Alias:wi
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

Entrées

PsApiManagementContext

String

Nullable<T>[[System.Boolean, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

PsApiManagementBackendCredential

PsApiManagementBackendProxy

PsApiManagementServiceFabric

SwitchParameter

Sorties

PsApiManagementBackend