Azure Transit Gateway

object
namestringrequired

Human-readable name of the transit gateway.

Example:us-east-2 transit gateway

dns_configarray[object]required

List of mappings from remote DNS server IP address sets to proxied internal domains, for a transit gateway
attachment.

* Additional properties are NOT allowed.
Show Child Parameters
transit_gateway_attachment_configobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
idstring(uuid)requiredread-only

Example:0850820b-d153-4a2a-b9be-7d2204779139

statestringrequiredread-only

The current state of the Transit Gateway. Possible values:

  • created - The attachment has been created but is not attached to transit gateway.
  • initializing - The attachment is in the process of being initialized and is setting up necessary resources.
  • pending-acceptance The attachment request is awaiting acceptance in customer VPC.
  • pending-user-action The attachment request is awaiting user action in customer VPC.
  • ready - The transit gateway attachment is fully operational and can route traffic as configured.
  • terminating - The attachment is in the process of being deleted and is no longer accepting new traffic.
  • terminated - The attachment has been fully deleted and is no longer available.
  • error - The attachment is in an error state.

Allowed values:createdinitializingpending-acceptancepending-user-actionreadyterminatingterminatederror

state_metadataobjectread-only

Metadata describing the backing state of the transit gateway and why it may be in an erroneous state.

* Additional properties are NOT allowed.
Show Child Parameters
entity_versionintegerrequiredread-only

Monotonically-increasing version count of the transit gateway, to indicate the order of updates to the
transit gateway.

Example:1

created_atstring(date-time)requiredread-only

An RFC-3339 timestamp representation of transit gateway creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An RFC-3339 timestamp representation of transit gateway update date.

Example:2022-11-04T20:10:06.927Z

Example

Azure Virtual Hub Peering Gateway

object
namestringrequired

Human-readable name of the transit gateway.

Example:us-east-2 transit gateway

dns_configarray[object]required

List of mappings from remote DNS server IP address sets to proxied internal domains, for a transit gateway
attachment.

* Additional properties are NOT allowed.
Show Child Parameters
transit_gateway_attachment_configobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
idstring(uuid)requiredread-only

Example:0850820b-d153-4a2a-b9be-7d2204779139

statestringrequiredread-only

The current state of the Transit Gateway. Possible values:

  • created - The attachment has been created but is not attached to transit gateway.
  • initializing - The attachment is in the process of being initialized and is setting up necessary resources.
  • pending-acceptance The attachment request is awaiting acceptance in customer VPC.
  • pending-user-action The attachment request is awaiting user action in customer VPC.
  • ready - The transit gateway attachment is fully operational and can route traffic as configured.
  • terminating - The attachment is in the process of being deleted and is no longer accepting new traffic.
  • terminated - The attachment has been fully deleted and is no longer available.
  • error - The attachment is in an error state.

Allowed values:createdinitializingpending-acceptancepending-user-actionreadyterminatingterminatederror

state_metadataobjectread-only

Metadata describing the backing state of the transit gateway and why it may be in an erroneous state.

* Additional properties are NOT allowed.
Show Child Parameters
entity_versionintegerrequiredread-only

Monotonically-increasing version count of the transit gateway, to indicate the order of updates to the
transit gateway.

Example:1

created_atstring(date-time)requiredread-only

An RFC-3339 timestamp representation of transit gateway creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An RFC-3339 timestamp representation of transit gateway update date.

Example:2022-11-04T20:10:06.927Z

Example

GCP VPC Peering Transit Gateway

object
namestringrequired

Human-readable name of the transit gateway.

Example:us-east-2 transit gateway

dns_configarray[object]required

List of mappings from remote DNS server IP address sets to proxied internal domains, for a transit gateway
attachment.

* Additional properties are NOT allowed.
Show Child Parameters
transit_gateway_attachment_configobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
idstring(uuid)requiredread-only

Example:0850820b-d153-4a2a-b9be-7d2204779139

statestringrequiredread-only

The current state of the Transit Gateway. Possible values:

  • created - The attachment has been created but is not attached to transit gateway.
  • initializing - The attachment is in the process of being initialized and is setting up necessary resources.
  • pending-acceptance The attachment request is awaiting acceptance in customer VPC.
  • pending-user-action The attachment request is awaiting user action in customer VPC.
  • ready - The transit gateway attachment is fully operational and can route traffic as configured.
  • terminating - The attachment is in the process of being deleted and is no longer accepting new traffic.
  • terminated - The attachment has been fully deleted and is no longer available.
  • error - The attachment is in an error state.

Allowed values:createdinitializingpending-acceptancepending-user-actionreadyterminatingterminatederror

state_metadataobjectread-only

Metadata describing the backing state of the transit gateway and why it may be in an erroneous state.

* Additional properties are NOT allowed.
Show Child Parameters
entity_versionintegerrequiredread-only

Monotonically-increasing version count of the transit gateway, to indicate the order of updates to the
transit gateway.

Example:1

created_atstring(date-time)requiredread-only

An RFC-3339 timestamp representation of transit gateway creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An RFC-3339 timestamp representation of transit gateway update date.

Example:2022-11-04T20:10:06.927Z

Example

TransitGatewayResponse

One Of
namestringrequired

Human-readable name of the transit gateway.

Example:us-east-2 transit gateway

dns_configarray[object]required

List of mappings from remote DNS server IP address sets to proxied internal domains, for a transit gateway
attachment.

* Additional properties are NOT allowed.
Show Child Parameters
cidr_blocksarray[string]required

CIDR blocks for constructing a route table for the transit gateway, when attaching to the owning
network.

Example:10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12

transit_gateway_attachment_configobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
idstring(uuid)requiredread-only

Example:0850820b-d153-4a2a-b9be-7d2204779139

statestringrequiredread-only

The current state of the Transit Gateway. Possible values:

  • created - The attachment has been created but is not attached to transit gateway.
  • initializing - The attachment is in the process of being initialized and is setting up necessary resources.
  • pending-acceptance The attachment request is awaiting acceptance in customer VPC.
  • pending-user-action The attachment request is awaiting user action in customer VPC.
  • ready - The transit gateway attachment is fully operational and can route traffic as configured.
  • terminating - The attachment is in the process of being deleted and is no longer accepting new traffic.
  • terminated - The attachment has been fully deleted and is no longer available.
  • error - The attachment is in an error state.

Allowed values:createdinitializingpending-acceptancepending-user-actionreadyterminatingterminatederror

state_metadataobjectread-only

Metadata describing the backing state of the transit gateway and why it may be in an erroneous state.

* Additional properties are NOT allowed.
Show Child Parameters
entity_versionintegerrequiredread-only

Monotonically-increasing version count of the transit gateway, to indicate the order of updates to the
transit gateway.

Example:1

created_atstring(date-time)requiredread-only

An RFC-3339 timestamp representation of transit gateway creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An RFC-3339 timestamp representation of transit gateway update date.

Example:2022-11-04T20:10:06.927Z

Example

AWS Transit Gateway

object
namestringrequired

Human-readable name of the transit gateway.

Example:us-east-2 transit gateway

dns_configarray[object]

List of mappings from remote DNS server IP address sets to proxied internal domains, for a transit gateway
attachment.

* Additional properties are NOT allowed.
Show Child Parameters
cidr_blocksarray[string]required

CIDR blocks for constructing a route table for the transit gateway, when attaching to the owning
network.

Example:10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12

transit_gateway_attachment_configobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
Example