Dela via

Add-AzApiManagementRegion

  • Referens
Modul:
Az.ApiManagement

Lägger till nya distributionsregioner i en PsApiManagement-instans.

Syntax

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

Description

Cmdleten Add-AzApiManagementRegion lägger till en ny instans av typen PsApiManagementRegion i samlingen AdditionalRegions av den angivna instansen av typen Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement. Den här cmdleten distribuerar inte något självt utan uppdaterar instansen av PsApiManagement i minnet. Om du vill uppdatera en distribution av en API Management skickar du den ändrade PsApiManagement-instansen till Set-AzApiManagement.

Exempel

Exempel 1: Lägga till nya distributionsregioner i en PsApiManagement-instans

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

Det här kommandot lägger till två Premium SKU-enheter och regionen med namnet USA, östra till PsApiManagement-instansen.

Exempel 2: Lägg till nya distributionsregioner i en PsApiManagement-instans och uppdatera sedan distributionen

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

Det här kommandot hämtar ett PsApiManagement-objekt , lägger till två Premium SKU-enheter för regionen med namnet USA, östra och uppdaterar sedan distributionen.

Parametrar

-ApiManagement

Anger den PsApiManagement-instans som den här cmdleten lägger till ytterligare distributionsregioner i.

Typ:PsApiManagement
Position:Named
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-Capacity

Anger SKU-kapaciteten i distributionsregionen.

Typ:Nullable<T>[Int32]
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-DefaultProfile

Autentiseringsuppgifter, konto, klientorganisation och prenumeration som används för kommunikation med Azure.

Typ:IAzureContextContainer
Alias:AzContext, AzureRmContext, AzureCredential
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-DisableGateway

Flaggan är endast avsedd att användas för Premium SKU ApiManagement Service och icke-interna VNET-distributioner. Detta är användbart om vi vill ta bort en gateway-region från rotationen. Detta kan också användas för att ställa upp en ny region i passivt läge, testa den och sedan göra den live senare. Standardbeteendet är att göra regionen live omedelbart.

Typ:Nullable<T>[Boolean]
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-Location

Anger platsen för den nya distributionsregionen mellan den region som stöds för Api Management-tjänsten. Om du vill hämta giltiga platser använder du cmdleten Get-AzResourceProvider -ProviderNamespace "Microsoft.ApiManagement" | där {$_. ResourceTypes[0]. ResourceTypeName -eq "service"} | Platser för select-object

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-PublicIpAddressId

Standard SKU PublicIpAddress ResoureId för integrering i Stv2 Virtual Network Deployments

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-Sku

Anger nivån för distributionsregionen. Giltiga värden är:

  • Utvecklare
  • Standard
  • Premium
Typ:Nullable<T>[PsApiManagementSku]
Godkända värden:Developer, Standard, Premium, Basic, Consumption, Isolated
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-VirtualNetwork

Anger en konfiguration av virtuellt nätverk.

Typ:PsApiManagementVirtualNetwork
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-Zone

En lista över tillgänglighetszoner som anger var API-hanteringstjänsten distribueras till.

Typ:String[]
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

Indata

PsApiManagement

Utdata

PsApiManagement

Kommentarer

  • Cmdleten skriver uppdaterad PsApiManagement-instans till pipeline.