express_route_circuits

Creates, updates, deletes, gets or lists a express_route_circuits resource.

Overview

Name	express_route_circuits
Type	Resource
Id	azure.network.express_route_circuits

Fields

vw_express_route_circuits

Name	Datatype	Description
id	text	Resource ID.
name	text	Resource name.
allow_classic_operations	text	field from the properties object
authorization_key	text	field from the properties object
authorization_status	text	field from the properties object
authorizations	text	field from the properties object
bandwidth_in_gbps	text	field from the properties object
circuitName	text	field from the properties object
circuit_provisioning_state	text	field from the properties object
enable_direct_port_rate_limit	text	field from the properties object
etag	text	A unique read-only string that changes whenever the resource is updated.
express_route_port	text	field from the properties object
gateway_manager_etag	text	field from the properties object
global_reach_enabled	text	field from the properties object
location	text	Resource location.
peerings	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
service_key	text	field from the properties object
service_provider_notes	text	field from the properties object
service_provider_properties	text	field from the properties object
service_provider_provisioning_state	text	field from the properties object
sku	text	Contains SKU in an ExpressRouteCircuit.
stag	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Resource tags.
type	text	Resource type.

express_route_circuits

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
etag	string	A unique read-only string that changes whenever the resource is updated.
location	string	Resource location.
properties	object	Properties of ExpressRouteCircuit.
sku	object	Contains SKU in an ExpressRouteCircuit.
tags	object	Resource tags.
type	string	Resource type.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	circuitName, resourceGroupName, subscriptionId	Gets information about the specified express route circuit.
list	SELECT	resourceGroupName, subscriptionId	Gets all the express route circuits in a resource group.
list_all	SELECT	subscriptionId	Gets all the express route circuits in a subscription.
create_or_update	INSERT	circuitName, resourceGroupName, subscriptionId	Creates or updates an express route circuit.
delete	DELETE	circuitName, resourceGroupName, subscriptionId	Deletes the specified express route circuit.
update_tags	EXEC	circuitName, resourceGroupName, subscriptionId	Updates an express route circuit tags.

SELECT examples

Gets all the express route circuits in a subscription.

vw_express_route_circuits

SELECT
id,
name,
allow_classic_operations,
authorization_key,
authorization_status,
authorizations,
bandwidth_in_gbps,
circuitName,
circuit_provisioning_state,
enable_direct_port_rate_limit,
etag,
express_route_port,
gateway_manager_etag,
global_reach_enabled,
location,
peerings,
provisioning_state,
resourceGroupName,
service_key,
service_provider_notes,
service_provider_properties,
service_provider_provisioning_state,
sku,
stag,
subscriptionId,
tags,
type
FROM azure.network.vw_express_route_circuits
WHERE subscriptionId = '{{ subscriptionId }}';

express_route_circuits

SELECT
id,
name,
etag,
location,
properties,
sku,
tags,
type
FROM azure.network.express_route_circuits
WHERE subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new express_route_circuits resource.

All Properties

/*+ create */
INSERT INTO azure.network.express_route_circuits (
circuitName,
resourceGroupName,
subscriptionId,
sku,
properties,
id,
location,
tags
)
SELECT 
'{{ circuitName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ sku }}',
'{{ properties }}',
'{{ id }}',
'{{ location }}',
'{{ tags }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: sku
      value:
        - name: name
          value: string
        - name: tier
          value: string
        - name: family
          value: string
    - name: properties
      value:
        - name: allowClassicOperations
          value: boolean
        - name: circuitProvisioningState
          value: string
        - name: serviceProviderProvisioningState
          value: []
        - name: authorizations
          value:
            - - name: properties
                value:
                  - name: authorizationKey
                    value: string
                  - name: authorizationUseStatus
                    value: string
                  - name: connectionResourceUri
                    value: string
                  - name: provisioningState
                    value: []
              - name: name
                value: string
              - name: etag
                value: string
              - name: type
                value: string
              - name: id
                value: string
        - name: peerings
          value:
            - - name: properties
                value:
                  - name: peeringType
                    value: []
                  - name: state
                    value: []
                  - name: azureASN
                    value: integer
                  - name: peerASN
                    value: integer
                  - name: primaryPeerAddressPrefix
                    value: string
                  - name: secondaryPeerAddressPrefix
                    value: string
                  - name: primaryAzurePort
                    value: string
                  - name: secondaryAzurePort
                    value: string
                  - name: sharedKey
                    value: string
                  - name: vlanId
                    value: integer
                  - name: microsoftPeeringConfig
                    value:
                      - name: advertisedPublicPrefixes
                        value:
                          - string
                      - name: advertisedCommunities
                        value:
                          - string
                      - name: advertisedPublicPrefixesState
                        value: string
                      - name: legacyMode
                        value: integer
                      - name: customerASN
                        value: integer
                      - name: routingRegistryName
                        value: string
                  - name: stats
                    value:
                      - name: primarybytesIn
                        value: integer
                      - name: primarybytesOut
                        value: integer
                      - name: secondarybytesIn
                        value: integer
                      - name: secondarybytesOut
                        value: integer
                  - name: gatewayManagerEtag
                    value: string
                  - name: lastModifiedBy
                    value: string
                  - name: routeFilter
                    value:
                      - name: id
                        value: string
                  - name: ipv6PeeringConfig
                    value:
                      - name: primaryPeerAddressPrefix
                        value: string
                      - name: secondaryPeerAddressPrefix
                        value: string
                      - name: state
                        value: string
                  - name: expressRouteConnection
                    value:
                      - name: id
                        value: string
                  - name: connections
                    value:
                      - - name: properties
                          value:
                            - name: addressPrefix
                              value: string
                            - name: authorizationKey
                              value: string
                            - name: ipv6CircuitConnectionConfig
                              value:
                                - name: addressPrefix
                                  value: string
                                - name: circuitConnectionStatus
                                  value: []
                        - name: name
                          value: string
                        - name: etag
                          value: string
                        - name: type
                          value: string
                        - name: id
                          value: string
                  - name: peeredConnections
                    value:
                      - - name: properties
                          value:
                            - name: addressPrefix
                              value: string
                            - name: connectionName
                              value: string
                            - name: authResourceGuid
                              value: string
                        - name: name
                          value: string
                        - name: etag
                          value: string
                        - name: type
                          value: string
                        - name: id
                          value: string
              - name: name
                value: string
              - name: etag
                value: string
              - name: type
                value: string
              - name: id
                value: string
        - name: serviceKey
          value: string
        - name: serviceProviderNotes
          value: string
        - name: serviceProviderProperties
          value:
            - name: serviceProviderName
              value: string
            - name: peeringLocation
              value: string
            - name: bandwidthInMbps
              value: integer
        - name: bandwidthInGbps
          value: number
        - name: stag
          value: integer
        - name: gatewayManagerEtag
          value: string
        - name: globalReachEnabled
          value: boolean
        - name: authorizationKey
          value: string
        - name: authorizationStatus
          value: string
        - name: enableDirectPortRateLimit
          value: boolean
    - name: etag
      value: string
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string
    - name: location
      value: string
    - name: tags
      value: object

DELETE example

Deletes the specified express_route_circuits resource.

/*+ delete */
DELETE FROM azure.network.express_route_circuits
WHERE circuitName = '{{ circuitName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';