Share via

ApiManagementGatewayUpdateParameters interface

Package:
@azure/arm-apimanagement

Parameter supplied to Update API Management gateway.

Extends
ApimResource

Properties

backend

Information regarding how the gateway should integrate with backend systems.
configurationApi

Information regarding the Configuration API of the API Management gateway. This is only applicable for API gateway with Standard SKU.
createdAtUtc

Creation UTC date of the API Management gateway.The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard. NOTE: This property will not be serialized. It can only be populated by the server.
etag

ETag of the resource. NOTE: This property will not be serialized. It can only be populated by the server.
frontend

Information regarding how the gateway should be exposed.
provisioningState

The current provisioning state of the API Management gateway which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted. NOTE: This property will not be serialized. It can only be populated by the server.
sku

SKU properties of the API Management gateway.
targetProvisioningState

The provisioning state of the API Management gateway, which is targeted by the long running operation started on the gateway. NOTE: This property will not be serialized. It can only be populated by the server.
virtualNetworkType

The type of VPN in which API Management gateway needs to be configured in.

Inherited Properties

id

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.
name

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.
tags

Resource tags.
type

Resource type for API Management resource is set to Microsoft.ApiManagement. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

backend

Information regarding how the gateway should integrate with backend systems.

backend?: BackendConfiguration

Property Value

BackendConfiguration

configurationApi

Information regarding the Configuration API of the API Management gateway. This is only applicable for API gateway with Standard SKU.

configurationApi?: GatewayConfigurationApi

Property Value

GatewayConfigurationApi

createdAtUtc

Creation UTC date of the API Management gateway.The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard. NOTE: This property will not be serialized. It can only be populated by the server.

createdAtUtc?: Date

Property Value

Date

etag

ETag of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

etag?: string

Property Value

string

frontend

Information regarding how the gateway should be exposed.

frontend?: FrontendConfiguration

Property Value

FrontendConfiguration

provisioningState

The current provisioning state of the API Management gateway which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

sku

SKU properties of the API Management gateway.

sku?: ApiManagementGatewaySkuPropertiesForPatch

Property Value

ApiManagementGatewaySkuPropertiesForPatch

targetProvisioningState

The provisioning state of the API Management gateway, which is targeted by the long running operation started on the gateway. NOTE: This property will not be serialized. It can only be populated by the server.

targetProvisioningState?: string

Property Value

string

virtualNetworkType

The type of VPN in which API Management gateway needs to be configured in.

virtualNetworkType?: string

Property Value

string

Inherited Property Details

id

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ApimResource.id

name

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ApimResource.name

tags

Resource tags.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From ApimResource.tags

type

Resource type for API Management resource is set to Microsoft.ApiManagement. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ApimResource.type