AdditionalLocation interface

Package:

@azure/arm-apimanagement

Description of an additional API Management resource location.

Properties

disableGateway	Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in this additional location.
gatewayRegionalUrl	Gateway URL of the API Management service in the Region. NOTE: This property will not be serialized. It can only be populated by the server.
location	The location name of the additional region among Azure Data center regions.
natGatewayState	Property can be used to enable NAT Gateway for this API Management service.
outboundPublicIPAddresses	Outbound public IPV4 address prefixes associated with NAT Gateway deployed service. Available only for Premium SKU on stv2 platform. NOTE: This property will not be serialized. It can only be populated by the server.
platformVersion	Compute Platform Version running the service. NOTE: This property will not be serialized. It can only be populated by the server.
privateIPAddresses	Private Static Load Balanced IP addresses of the API Management service which is deployed in an Internal Virtual Network in a particular additional location. Available only for Basic, Standard, Premium and Isolated SKU. NOTE: This property will not be serialized. It can only be populated by the server.
publicIPAddresses	Public Static Load Balanced IP addresses of the API Management service in the additional location. Available only for Basic, Standard, Premium and Isolated SKU. NOTE: This property will not be serialized. It can only be populated by the server.
publicIpAddressId	Public Standard SKU IP V4 based IP address to be associated with Virtual Network deployed service in the location. Supported only for Premium SKU being deployed in Virtual Network.
sku	SKU properties of the API Management service.
virtualNetworkConfiguration	Virtual network configuration for the location.
zones	A list of availability zones denoting where the resource needs to come from.

Property Details

disableGateway

Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in this additional location.

disableGateway?: boolean

Property Value

boolean

gatewayRegionalUrl

Gateway URL of the API Management service in the Region. NOTE: This property will not be serialized. It can only be populated by the server.

gatewayRegionalUrl?: string

Property Value

string

location

The location name of the additional region among Azure Data center regions.

location: string

Property Value

string

natGatewayState

Property can be used to enable NAT Gateway for this API Management service.

natGatewayState?: string

Property Value

string

outboundPublicIPAddresses

Outbound public IPV4 address prefixes associated with NAT Gateway deployed service. Available only for Premium SKU on stv2 platform. NOTE: This property will not be serialized. It can only be populated by the server.

outboundPublicIPAddresses?: string[]

Property Value

string[]

platformVersion

Compute Platform Version running the service. NOTE: This property will not be serialized. It can only be populated by the server.

platformVersion?: string

Property Value

string

privateIPAddresses

Private Static Load Balanced IP addresses of the API Management service which is deployed in an Internal Virtual Network in a particular additional location. Available only for Basic, Standard, Premium and Isolated SKU. NOTE: This property will not be serialized. It can only be populated by the server.

privateIPAddresses?: string[]

Property Value

string[]

publicIPAddresses

Public Static Load Balanced IP addresses of the API Management service in the additional location. Available only for Basic, Standard, Premium and Isolated SKU. NOTE: This property will not be serialized. It can only be populated by the server.

publicIPAddresses?: string[]

Property Value

string[]

publicIpAddressId

Public Standard SKU IP V4 based IP address to be associated with Virtual Network deployed service in the location. Supported only for Premium SKU being deployed in Virtual Network.

publicIpAddressId?: string

Property Value

string

sku

SKU properties of the API Management service.

sku: ApiManagementServiceSkuProperties

Property Value

ApiManagementServiceSkuProperties

virtualNetworkConfiguration

Virtual network configuration for the location.

virtualNetworkConfiguration?: VirtualNetworkConfiguration

Property Value

VirtualNetworkConfiguration

zones

A list of availability zones denoting where the resource needs to come from.

zones?: string[]

Property Value

string[]