Partager via

Update-AzApiManagementRegion

  • Référence
Module:
Az.ApiManagement

Met à jour la région de déploiement existante dans l’instance PsApiManagement.

Syntaxe

Update-AzApiManagementRegion
      -ApiManagement <PsApiManagement>
      -Location <String>
      -Sku <string>
      -Capacity <Int32>
      [-VirtualNetwork <PsApiManagementVirtualNetwork>]
      [-Zone <String[]>]
      [-DisableGateway <Boolean>]
      [-PublicIpAddressId <String>]
      [-DefaultProfile <IAzureContextContainer>]
      [<CommonParameters>]

Description

La cmdlet Update-AzApiManagementRegion met à jour une instance existante de type Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementRegion dans une collection d’objets AdditionalRegions d’une instance fournie de type Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement. Cette applet de commande ne déploie rien, mais met à jour une instance de PsApiManagement en mémoire. Pour mettre à jour un déploiement d’une gestion des API, utilisez le PsApiManagementInstance modifié à l’applet de commande Set-AzApiManagement.

Exemples

Exemple 1 : Augmente la capacité de la région supplémentaire dans une instance PsApiManagement

$apimService = Get-AzApiManagement -ResourceGroupName $resourceGroupName -Name $apiManagementName
$apimService = Update-AzApiManagementRegion -ApiManagement $apimService -Location "North Central US" -Capacity 2 -Sku Premium
$apimService = Set-AzApiManagement -InputObject $apimService -PassThru

Cette commande obtient le service de référence SKU Premium Gestion des API, avec des régions situées dans les régions USA Centre Sud et USA Centre Nord. Il augmente ensuite la capacité de la région USA Centre Nord à 2 à l’aide du Set-AzApiManagement. L’applet de commande suivante Set-AzApiManagement applique la modification de configuration au service Gestion des API.

Exemple 2

Met à jour la région de déploiement existante dans l’instance PsApiManagement. (généré automatiquement)

Update-AzApiManagementRegion -ApiManagement <PsApiManagement> -Capacity 2 -Location 'North Central US' -Sku Developer -VirtualNetwork <PsApiManagementVirtualNetwork>

Paramètres

-ApiManagement

Spécifie l’instance PsApiManagement pour mettre à jour une région de déploiement existante.

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

-Capacity

Spécifie la nouvelle valeur de capacité de référence SKU pour la région de déploiement.

Type:Int32
Position:Named
Valeur par défaut:None
Obligatoire:True
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

-DisableGateway

Indicateur destiné uniquement à être utilisé pour les déploiements de service ApiManagement de référence SKU Premium et de réseaux virtuels non internes. Cela est utile dans le cas où nous voulons retirer une région de passerelle de la rotation. Cela peut également être utilisé pour standupiser une nouvelle région en mode passif, la tester, puis la rendre live ultérieurement.

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

-Location

Spécifie l’emplacement de la région de déploiement à mettre à jour. Spécifie l’emplacement de la nouvelle région de déploiement parmi la région prise en charge pour le service Gestion des API. Pour obtenir des emplacements valides, utilisez l’applet de commande Get-AzResourceProvider -ProviderNamespace « Microsoft.ApiManagement » | où {$_. ResourceTypes[0]. ResourceTypeName -eq « service"} | emplacements Select-Object

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

-PublicIpAddressId

Référence SKU Standard PublicIpAddress ResoureId pour l’intégration aux déploiements de réseau virtuel stv2

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

-Sku

Spécifie la nouvelle valeur de niveau pour la région de déploiement. Les valeurs valides sont les suivantes :

  • Promoteur
  • Standard
  • Prime
Type:PsApiManagementSku
Valeurs acceptées:Developer, Standard, Premium, Basic, Consumption, Isolated
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-VirtualNetwork

Spécifie une configuration de réseau virtuel pour la région de déploiement. La transmission de $null supprime la configuration du réseau virtuel pour la région.

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

-Zone

Liste des zones de disponibilité indiquant où le service de gestion des API est déployé.

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

Entrées

PsApiManagement

String

PsApiManagementSku

Int32

PsApiManagementVirtualNetwork

Sorties

PsApiManagement