Partager via

Add-AzApiManagementRegion

  • Référence
Module:
Az.ApiManagement

Ajoute de nouvelles régions de déploiement à une instance PsApiManagement.

Syntaxe

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

Description

L’applet de commande Add-AzApiManagementRegion ajoute une nouvelle instance de type PsApiManagementRegion à la collection de AdditionalRegions de l’instance fournie de type Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement. Cette applet de commande ne déploie rien en soi, mais met à jour l’instance de PsApiManagement en mémoire. Pour mettre à jour un déploiement d’une gestion des API, passez la modification PsApiManagement Instance à Set-AzApiManagement.

Exemples

Exemple 1 : Ajouter de nouvelles régions de déploiement à une instance PsApiManagement

Add-AzApiManagementRegion -ApiManagement $ApiManagement -Location "East US" -Sku "Premium" -Capacity 2

Cette commande ajoute deux unités de référence SKU Premium et la région nommée USA Est à l’instance PsApiManagement.

Exemple 2 : Ajouter de nouvelles régions de déploiement à une instance PsApiManagement, puis mettre à jour le déploiement

$service = Get-AzApiManagement -ResourceGroupName "Contoso" -Name "ContosoApi"
$service = Add-AzApiManagementRegion -ApiManagement $service -Location $secondarylocation -VirtualNetwork $additionalRegionVirtualNetwork
$service = Set-AzApiManagement -InputObject $service -PassThru

Cette commande obtient un objet PsApiManagement, ajoute deux unités de référence SKU Premium pour la région nommée USA Est, puis met à jour le déploiement.

Paramètres

-ApiManagement

Spécifie l’instance PsApiManagement à laquelle cette applet de commande ajoute des régions de déploiement supplémentaires.

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 capacité de référence SKU de la région de déploiement.

Type:Nullable<T>[Int32]
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
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. Le comportement par défaut consiste à rendre la région active immédiatement.

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 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:False
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 le niveau de la région de déploiement. Les valeurs valides sont les suivantes :

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

-VirtualNetwork

Spécifie une configuration de réseau virtuel.

Type:PsApiManagementVirtualNetwork
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
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

Sorties

Notes

  • L’applet de commande écrit mis à jour instance psApiManagement dans le pipeline.