Dela via

Update-AzApiManagementRegion

  • Referens
Modul:
Az.ApiManagement

Uppdaterar befintlig distributionsregion i PsApiManagement-instansen.

Syntax

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

Description

Cmdleten Update-AzApiManagementRegion uppdaterar en befintlig instans av typen Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementRegion i en samling AdditionalRegions-objekt av en angivet instans av typen Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement. Den här cmdleten distribuerar inget annat än uppdaterar en instans av PsApiManagement i minnet. Om du vill uppdatera en distribution av en API Management använder du den ändrade PsApiManagementInstance till cmdleten Set-AzApiManagement.

Exempel

Exempel 1: Ökar kapaciteten för ytterligare region i en PsApiManagement-instans

$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

Det här kommandot hämtar API Management Premium SKU-tjänsten med regioner i USA, södra centrala och USA, norra centrala. Sedan ökar kapaciteten för regionen USA, norra centrala till 2 med set-AzApiManagement. Nästa cmdlet Set-AzApiManagement tillämpar konfigurationsändringen på Api Management-tjänsten.

Exempel 2

Uppdaterar befintlig distributionsregion i PsApiManagement-instansen. (automatiskt genererad)

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

Parametrar

-ApiManagement

Anger den PsApiManagement-instans som en befintlig distributionsregion ska uppdateras i.

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

-Capacity

Anger det nya SKU-kapacitetsvärdet för distributionsregionen.

Typ:Int32
Position:Named
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:True
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.

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 distributionsregionen som ska uppdateras. 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:True
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 det nya nivåvärdet för distributionsregionen. Giltiga värden är:

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

-VirtualNetwork

Anger en konfiguration av virtuellt nätverk för distributionsregionen. Om du skickar $null tas konfigurationen av det virtuella nätverket bort för regionen.

Typ:PsApiManagementVirtualNetwork
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
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

String

PsApiManagementSku

Int32

PsApiManagementVirtualNetwork

Utdata

PsApiManagement