Gateway interface

Describes an Arc Gateway.

Extends

Properties

allowedFeatures

Specifies the list of features that are enabled for this Gateway.

gatewayBypass

Specifies the list of domain names that should bypass the gateway. Each entry must be a valid DNS hostname.

gatewayEndpoint

The endpoint fqdn for the Gateway.

gatewayId

A unique, immutable, identifier for the Gateway.

gatewayType

The type of the Gateway resource.

provisioningState

The provisioning state, which only appears in the response.

Inherited Properties

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location

The geo-location where the resource lives

name

The name of the resource

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

tags

Resource tags.

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Property Details

allowedFeatures

Specifies the list of features that are enabled for this Gateway.

allowedFeatures?: string[]

Property Value

string[]

gatewayBypass

Specifies the list of domain names that should bypass the gateway. Each entry must be a valid DNS hostname.

gatewayBypass?: string[]

Property Value

string[]

gatewayEndpoint

The endpoint fqdn for the Gateway.

gatewayEndpoint?: string

Property Value

string

gatewayId

A unique, immutable, identifier for the Gateway.

gatewayId?: string

Property Value

string

gatewayType

The type of the Gateway resource.

gatewayType?: string

Property Value

string

provisioningState

The provisioning state, which only appears in the response.

provisioningState?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

id?: string

Property Value

string

Inherited From TrackedResource.id

location

The geo-location where the resource lives

location: string

Property Value

string

Inherited From TrackedResource.location

name

The name of the resource

name?: string

Property Value

string

Inherited From TrackedResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

systemData?: SystemData

Property Value

Inherited From TrackedResource.systemData

tags

Resource tags.

tags?: Record<string, string>

Property Value

Record<string, string>

Inherited From TrackedResource.tags

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

type?: string

Property Value

string

Inherited From TrackedResource.type