Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GatewayResourceDescription

Package version

interface

An interface representing GatewayResourceDescription. This type describes a gateway resource.

extends

TrackedResource

Hierarchy

Index

Properties

Properties

Optional description

description: undefined | string
member

{string} [description] User readable description of the gateway.

destinationNetwork

destinationNetwork: NetworkRef
member

{NetworkRef} destinationNetwork Network that the Application is using.

Optional http

http: HttpConfig[]
member

{HttpConfig[]} [http] Configuration for http connectivity for this gateway.

Optional id

id: undefined | string
member

{string} [id] Fully qualified identifier for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

Optional ipAddress

ipAddress: undefined | string
member

{string} [ipAddress] IP address of the gateway. This is populated in the response and is ignored for incoming requests. NOTE: This property will not be serialized. It can only be populated by the server.

location

location: string
member

{string} location The geo-location where the resource lives

Optional name

name: undefined | string
member

{string} [name] The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: undefined | string
member

{string} [provisioningState] State of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

sourceNetwork

sourceNetwork: NetworkRef
member

{NetworkRef} sourceNetwork Network the gateway should listen on for requests.

Optional status

status: ResourceStatus
member

{ResourceStatus} [status] Status of the resource. Possible values include: 'Unknown', 'Ready', 'Upgrading', 'Creating', 'Deleting', 'Failed' NOTE: This property will not be serialized. It can only be populated by the server.

Optional statusDetails

statusDetails: undefined | string
member

{string} [statusDetails] Gives additional information about the current status of the gateway. NOTE: This property will not be serialized. It can only be populated by the server.

Optional tags

tags: undefined | object
member

{{ [propertyName: string]: string }} [tags] Resource tags.

Optional tcp

tcp: TcpConfig[]
member

{TcpConfig[]} [tcp] Configuration for tcp connectivity for this gateway.

Optional type

type: undefined | string
member

{string} [type] The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts. NOTE: This property will not be serialized. It can only be populated by the server.

Generated using TypeDoc