Gateway interface

Describes an Arc Gateway.

Extends

Properties

allowedFeatures

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

gatewayEndpoint

The endpoint fqdn for the Gateway. NOTE: This property will not be serialized. It can only be populated by the server.

gatewayId

A unique, immutable, identifier for the Gateway. NOTE: This property will not be serialized. It can only be populated by the server.

gatewayType

The type of the Gateway resource.

provisioningState

The provisioning state, which only appears in the response. NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

id

Fully qualified resource ID 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.

location

The geo-location where the resource lives

name

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

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.

tags

Resource tags.

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

allowedFeatures

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

allowedFeatures?: string[]

Property Value

string[]

gatewayEndpoint

The endpoint fqdn for the Gateway. NOTE: This property will not be serialized. It can only be populated by the server.

gatewayEndpoint?: string

Property Value

string

gatewayId

A unique, immutable, identifier for the Gateway. NOTE: This property will not be serialized. It can only be populated by the server.

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. NOTE: This property will not be serialized. It can only be populated by the server.

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} NOTE: This property will not be serialized. It can only be populated by the server.

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 NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From TrackedResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

Inherited From TrackedResource.systemData

tags

Resource tags.

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

Property Value

{[propertyName: string]: string}

Inherited From TrackedResource.tags

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From TrackedResource.type