service_gateways

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

Overview

Name	service_gateways
Type	Resource
Id	azure.network.service_gateways

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}".
name	string	The name of the resource.
etag	string	A unique read-only string that changes whenever the resource is updated.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The provisioning state of the service gateway resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
resourceGuid	string	The resource GUID property of the service gateway resource.
routeTargetAddress	object	Route Target address of Service gateway.
routeTargetAddressV6	object	Route Target address V6 of Service gateway.
sku	object	The service gateway SKU.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
virtualNetwork	object	Reference to an existing virtual network.
zones	array	A list of availability zones denoting the zone in which service gateway should be deployed. * The zone values must be provided as strings representing numeric identifiers like "1", "2", "3" etc.

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}".
name	string	The name of the resource.
etag	string	A unique read-only string that changes whenever the resource is updated.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The provisioning state of the service gateway resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
resourceGuid	string	The resource GUID property of the service gateway resource.
routeTargetAddress	object	Route Target address of Service gateway.
routeTargetAddressV6	object	Route Target address V6 of Service gateway.
sku	object	The service gateway SKU.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
virtualNetwork	object	Reference to an existing virtual network.
zones	array	A list of availability zones denoting the zone in which service gateway should be deployed. * The zone values must be provided as strings representing numeric identifiers like "1", "2", "3" etc.

list_all

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}".
name	string	The name of the resource.
etag	string	A unique read-only string that changes whenever the resource is updated.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The provisioning state of the service gateway resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
resourceGuid	string	The resource GUID property of the service gateway resource.
routeTargetAddress	object	Route Target address of Service gateway.
routeTargetAddressV6	object	Route Target address V6 of Service gateway.
sku	object	The service gateway SKU.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
virtualNetwork	object	Reference to an existing virtual network.
zones	array	A list of availability zones denoting the zone in which service gateway should be deployed. * The zone values must be provided as strings representing numeric identifiers like "1", "2", "3" etc.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, service_gateway_name, subscription_id		Gets the specified service gateway.
list	select	resource_group_name, subscription_id		Gets all the service gateways in a resource group.
list_all	select	subscription_id		Gets all the service gateways in a subscription.
create_or_update	insert	resource_group_name, service_gateway_name, subscription_id, location		Creates or updates a service gateway.
update_tags	update	resource_group_name, service_gateway_name, subscription_id		Updates a service gateway tags.
create_or_update	replace	resource_group_name, service_gateway_name, subscription_id, location		Creates or updates a service gateway.
delete	delete	resource_group_name, service_gateway_name, subscription_id		Deletes the specified service gateway.
get_address_locations	exec	resource_group_name, service_gateway_name, subscription_id		Get address locations in service gateway.
get_services	exec	resource_group_name, service_gateway_name, subscription_id		Get Services in service gateway.
update_address_locations	exec	resource_group_name, service_gateway_name, subscription_id		Creates or updates address locations within the service gateway. The request supports both full and partial update modes at two levels: location and address. Full update replaces all existing data. Partial update modifies only the specified entries: For location-level partial updates, if no address is provided, the existing address will be deleted. For address-level partial updates, if no services are provided, the existing services will be considered for deletion.
update_services	exec	resource_group_name, service_gateway_name, subscription_id		Creates, updates, or deletes services within the service gateway. The request supports both full and partial update modes at the service level. Full update replaces all existing services with the new list provided in the request. Partial update modifies only the specified services.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
service_gateway_name	string	The name of the service gateway. Required.
subscription_id	string

SELECT examples

get

Gets the specified service gateway.

SELECT
id,
name,
etag,
location,
provisioningState,
resourceGuid,
routeTargetAddress,
routeTargetAddressV6,
sku,
systemData,
tags,
type,
virtualNetwork,
zones
FROM azure.network.service_gateways
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_gateway_name = '{{ service_gateway_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets all the service gateways in a resource group.

SELECT
id,
name,
etag,
location,
provisioningState,
resourceGuid,
routeTargetAddress,
routeTargetAddressV6,
sku,
systemData,
tags,
type,
virtualNetwork,
zones
FROM azure.network.service_gateways
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_all

Gets all the service gateways in a subscription.

SELECT
id,
name,
etag,
location,
provisioningState,
resourceGuid,
routeTargetAddress,
routeTargetAddressV6,
sku,
systemData,
tags,
type,
virtualNetwork,
zones
FROM azure.network.service_gateways
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a service gateway.

INSERT INTO azure.network.service_gateways (
tags,
location,
properties,
sku,
zones,
resource_group_name,
service_gateway_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ sku }}',
'{{ zones }}',
'{{ resource_group_name }}',
'{{ service_gateway_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
location,
properties,
sku,
systemData,
tags,
type,
zones
;

Manifest

# Description fields are for documentation purposes
- name: service_gateways
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the service_gateways resource.
  - name: service_gateway_name
    value: "{{ service_gateway_name }}"
    description: Required parameter for the service_gateways resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the service_gateways resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      Properties of service gateway.
    value:
      virtualNetwork:
        id: "{{ id }}"
        name: "{{ name }}"
        type: "{{ type }}"
        location: "{{ location }}"
        tags: "{{ tags }}"
        properties:
          addressSpace:
            addressPrefixes:
              - "{{ addressPrefixes }}"
            ipamPoolPrefixAllocations:
              - pool:
                  id: "{{ id }}"
                numberOfIpAddresses: "{{ numberOfIpAddresses }}"
                allocatedAddressPrefixes: "{{ allocatedAddressPrefixes }}"
          dhcpOptions:
            dnsServers:
              - "{{ dnsServers }}"
          flowTimeoutInMinutes: {{ flowTimeoutInMinutes }}
          subnets:
            - id: "{{ id }}"
              name: "{{ name }}"
              type: "{{ type }}"
              properties:
                addressPrefix: "{{ addressPrefix }}"
                addressPrefixes: "{{ addressPrefixes }}"
                networkSecurityGroup: "{{ networkSecurityGroup }}"
                routeTable: "{{ routeTable }}"
                natGateway: "{{ natGateway }}"
                serviceEndpoints: "{{ serviceEndpoints }}"
                serviceEndpointPolicies: "{{ serviceEndpointPolicies }}"
                privateEndpoints: "{{ privateEndpoints }}"
                ipConfigurations: "{{ ipConfigurations }}"
                ipConfigurationProfiles: "{{ ipConfigurationProfiles }}"
                ipAllocations: "{{ ipAllocations }}"
                resourceNavigationLinks: "{{ resourceNavigationLinks }}"
                serviceAssociationLinks: "{{ serviceAssociationLinks }}"
                delegations: "{{ delegations }}"
                purpose: "{{ purpose }}"
                provisioningState: "{{ provisioningState }}"
                privateEndpointNetworkPolicies: "{{ privateEndpointNetworkPolicies }}"
                privateLinkServiceNetworkPolicies: "{{ privateLinkServiceNetworkPolicies }}"
                applicationGatewayIPConfigurations: "{{ applicationGatewayIPConfigurations }}"
                sharingScope: "{{ sharingScope }}"
                defaultOutboundAccess: {{ defaultOutboundAccess }}
                ipamPoolPrefixAllocations: "{{ ipamPoolPrefixAllocations }}"
                serviceGateway: "{{ serviceGateway }}"
              etag: "{{ etag }}"
          virtualNetworkPeerings:
            - id: "{{ id }}"
              name: "{{ name }}"
              type: "{{ type }}"
              properties:
                allowVirtualNetworkAccess: {{ allowVirtualNetworkAccess }}
                allowForwardedTraffic: {{ allowForwardedTraffic }}
                allowGatewayTransit: {{ allowGatewayTransit }}
                useRemoteGateways: {{ useRemoteGateways }}
                remoteVirtualNetwork: "{{ remoteVirtualNetwork }}"
                localAddressSpace: "{{ localAddressSpace }}"
                localVirtualNetworkAddressSpace: "{{ localVirtualNetworkAddressSpace }}"
                remoteAddressSpace: "{{ remoteAddressSpace }}"
                remoteVirtualNetworkAddressSpace: "{{ remoteVirtualNetworkAddressSpace }}"
                remoteBgpCommunities: "{{ remoteBgpCommunities }}"
                remoteVirtualNetworkEncryption: "{{ remoteVirtualNetworkEncryption }}"
                peeringState: "{{ peeringState }}"
                peeringSyncLevel: "{{ peeringSyncLevel }}"
                provisioningState: "{{ provisioningState }}"
                doNotVerifyRemoteGateways: {{ doNotVerifyRemoteGateways }}
                resourceGuid: "{{ resourceGuid }}"
                peerCompleteVnets: {{ peerCompleteVnets }}
                enableOnlyIPv6Peering: {{ enableOnlyIPv6Peering }}
                localSubnetNames: "{{ localSubnetNames }}"
                remoteSubnetNames: "{{ remoteSubnetNames }}"
              etag: "{{ etag }}"
          resourceGuid: "{{ resourceGuid }}"
          provisioningState: "{{ provisioningState }}"
          enableDdosProtection: {{ enableDdosProtection }}
          enableVmProtection: {{ enableVmProtection }}
          ddosProtectionPlan:
            id: "{{ id }}"
          bgpCommunities:
            virtualNetworkCommunity: "{{ virtualNetworkCommunity }}"
            regionalCommunity: "{{ regionalCommunity }}"
          encryption:
            enabled: {{ enabled }}
            enforcement: "{{ enforcement }}"
          ipAllocations:
            - id: "{{ id }}"
          flowLogs:
            - id: "{{ id }}"
              name: "{{ name }}"
              type: "{{ type }}"
              location: "{{ location }}"
              tags: "{{ tags }}"
              properties:
                targetResourceId: "{{ targetResourceId }}"
                targetResourceGuid: "{{ targetResourceGuid }}"
                storageId: "{{ storageId }}"
                enabledFilteringCriteria: "{{ enabledFilteringCriteria }}"
                recordTypes: "{{ recordTypes }}"
                enabled: {{ enabled }}
                retentionPolicy: "{{ retentionPolicy }}"
                format: "{{ format }}"
                flowAnalyticsConfiguration: "{{ flowAnalyticsConfiguration }}"
                provisioningState: "{{ provisioningState }}"
              etag: "{{ etag }}"
              identity:
                principalId: "{{ principalId }}"
                tenantId: "{{ tenantId }}"
                type: "{{ type }}"
                userAssignedIdentities: "{{ userAssignedIdentities }}"
          privateEndpointVNetPolicies: "{{ privateEndpointVNetPolicies }}"
          defaultPublicNatGateway:
            id: "{{ id }}"
          summarizedGatewayPrefixes:
            addressPrefixes:
              - "{{ addressPrefixes }}"
            ipamPoolPrefixAllocations:
              - pool:
                  id: "{{ id }}"
                numberOfIpAddresses: "{{ numberOfIpAddresses }}"
                allocatedAddressPrefixes: "{{ allocatedAddressPrefixes }}"
        extendedLocation:
          name: "{{ name }}"
          type: "{{ type }}"
        etag: "{{ etag }}"
      routeTargetAddress:
        subnet:
          id: "{{ id }}"
          name: "{{ name }}"
          type: "{{ type }}"
          properties:
            addressPrefix: "{{ addressPrefix }}"
            addressPrefixes:
              - "{{ addressPrefixes }}"
            networkSecurityGroup:
              id: "{{ id }}"
              name: "{{ name }}"
              type: "{{ type }}"
              location: "{{ location }}"
              tags: "{{ tags }}"
              properties: "{{ properties }}"
              etag: "{{ etag }}"
            routeTable:
              id: "{{ id }}"
              name: "{{ name }}"
              type: "{{ type }}"
              location: "{{ location }}"
              tags: "{{ tags }}"
              properties: "{{ properties }}"
              etag: "{{ etag }}"
            natGateway:
              id: "{{ id }}"
            serviceEndpoints:
              - service: "{{ service }}"
                networkIdentifier:
                  id: "{{ id }}"
                locations: "{{ locations }}"
                provisioningState: "{{ provisioningState }}"
            serviceEndpointPolicies:
              - id: "{{ id }}"
                name: "{{ name }}"
                type: "{{ type }}"
                location: "{{ location }}"
                tags: "{{ tags }}"
                properties:
                  serviceEndpointPolicyDefinitions: "{{ serviceEndpointPolicyDefinitions }}"
                  subnets: "{{ subnets }}"
                  resourceGuid: "{{ resourceGuid }}"
                  provisioningState: "{{ provisioningState }}"
                  serviceAlias: "{{ serviceAlias }}"
                  contextualServiceEndpointPolicies: "{{ contextualServiceEndpointPolicies }}"
                etag: "{{ etag }}"
                kind: "{{ kind }}"
            privateEndpoints:
              - id: "{{ id }}"
                name: "{{ name }}"
                type: "{{ type }}"
                location: "{{ location }}"
                tags: "{{ tags }}"
                properties:
                  subnet: "{{ subnet }}"
                  networkInterfaces: "{{ networkInterfaces }}"
                  provisioningState: "{{ provisioningState }}"
                  ipVersionType: "{{ ipVersionType }}"
                  privateLinkServiceConnections: "{{ privateLinkServiceConnections }}"
                  manualPrivateLinkServiceConnections: "{{ manualPrivateLinkServiceConnections }}"
                  customDnsConfigs: "{{ customDnsConfigs }}"
                  applicationSecurityGroups: "{{ applicationSecurityGroups }}"
                  ipConfigurations: "{{ ipConfigurations }}"
                  customNetworkInterfaceName: "{{ customNetworkInterfaceName }}"
                  billingSku: "{{ billingSku }}"
                extendedLocation:
                  name: "{{ name }}"
                  type: "{{ type }}"
                etag: "{{ etag }}"
            ipConfigurations:
              - id: "{{ id }}"
                properties:
                  privateIPAddress: "{{ privateIPAddress }}"
                  privateIPAllocationMethod: "{{ privateIPAllocationMethod }}"
                  subnet: "{{ subnet }}"
                  publicIPAddress: "{{ publicIPAddress }}"
                  provisioningState: "{{ provisioningState }}"
                name: "{{ name }}"
                etag: "{{ etag }}"
            ipConfigurationProfiles:
              - id: "{{ id }}"
                properties:
                  subnet: "{{ subnet }}"
                  provisioningState: "{{ provisioningState }}"
                name: "{{ name }}"
                type: "{{ type }}"
                etag: "{{ etag }}"
            ipAllocations:
              - id: "{{ id }}"
            resourceNavigationLinks:
              - id: "{{ id }}"
                properties:
                  linkedResourceType: "{{ linkedResourceType }}"
                  link: "{{ link }}"
                  provisioningState: "{{ provisioningState }}"
                name: "{{ name }}"
                etag: "{{ etag }}"
                type: "{{ type }}"
            serviceAssociationLinks:
              - id: "{{ id }}"
                properties:
                  linkedResourceType: "{{ linkedResourceType }}"
                  link: "{{ link }}"
                  provisioningState: "{{ provisioningState }}"
                  allowDelete: {{ allowDelete }}
                  locations: "{{ locations }}"
                name: "{{ name }}"
                etag: "{{ etag }}"
                type: "{{ type }}"
            delegations:
              - id: "{{ id }}"
                properties:
                  serviceName: "{{ serviceName }}"
                  actions: "{{ actions }}"
                  provisioningState: "{{ provisioningState }}"
                name: "{{ name }}"
                etag: "{{ etag }}"
                type: "{{ type }}"
            purpose: "{{ purpose }}"
            provisioningState: "{{ provisioningState }}"
            privateEndpointNetworkPolicies: "{{ privateEndpointNetworkPolicies }}"
            privateLinkServiceNetworkPolicies: "{{ privateLinkServiceNetworkPolicies }}"
            applicationGatewayIPConfigurations:
              - id: "{{ id }}"
                properties:
                  subnet: "{{ subnet }}"
                  provisioningState: "{{ provisioningState }}"
                name: "{{ name }}"
                etag: "{{ etag }}"
                type: "{{ type }}"
            sharingScope: "{{ sharingScope }}"
            defaultOutboundAccess: {{ defaultOutboundAccess }}
            ipamPoolPrefixAllocations:
              - pool:
                  id: "{{ id }}"
                numberOfIpAddresses: "{{ numberOfIpAddresses }}"
                allocatedAddressPrefixes: "{{ allocatedAddressPrefixes }}"
            serviceGateway:
              id: "{{ id }}"
          etag: "{{ etag }}"
        privateIPAddress: "{{ privateIPAddress }}"
        privateIPAllocationMethod: "{{ privateIPAllocationMethod }}"
      routeTargetAddressV6:
        subnet:
          id: "{{ id }}"
          name: "{{ name }}"
          type: "{{ type }}"
          properties:
            addressPrefix: "{{ addressPrefix }}"
            addressPrefixes:
              - "{{ addressPrefixes }}"
            networkSecurityGroup:
              id: "{{ id }}"
              name: "{{ name }}"
              type: "{{ type }}"
              location: "{{ location }}"
              tags: "{{ tags }}"
              properties: "{{ properties }}"
              etag: "{{ etag }}"
            routeTable:
              id: "{{ id }}"
              name: "{{ name }}"
              type: "{{ type }}"
              location: "{{ location }}"
              tags: "{{ tags }}"
              properties: "{{ properties }}"
              etag: "{{ etag }}"
            natGateway:
              id: "{{ id }}"
            serviceEndpoints:
              - service: "{{ service }}"
                networkIdentifier:
                  id: "{{ id }}"
                locations: "{{ locations }}"
                provisioningState: "{{ provisioningState }}"
            serviceEndpointPolicies:
              - id: "{{ id }}"
                name: "{{ name }}"
                type: "{{ type }}"
                location: "{{ location }}"
                tags: "{{ tags }}"
                properties:
                  serviceEndpointPolicyDefinitions: "{{ serviceEndpointPolicyDefinitions }}"
                  subnets: "{{ subnets }}"
                  resourceGuid: "{{ resourceGuid }}"
                  provisioningState: "{{ provisioningState }}"
                  serviceAlias: "{{ serviceAlias }}"
                  contextualServiceEndpointPolicies: "{{ contextualServiceEndpointPolicies }}"
                etag: "{{ etag }}"
                kind: "{{ kind }}"
            privateEndpoints:
              - id: "{{ id }}"
                name: "{{ name }}"
                type: "{{ type }}"
                location: "{{ location }}"
                tags: "{{ tags }}"
                properties:
                  subnet: "{{ subnet }}"
                  networkInterfaces: "{{ networkInterfaces }}"
                  provisioningState: "{{ provisioningState }}"
                  ipVersionType: "{{ ipVersionType }}"
                  privateLinkServiceConnections: "{{ privateLinkServiceConnections }}"
                  manualPrivateLinkServiceConnections: "{{ manualPrivateLinkServiceConnections }}"
                  customDnsConfigs: "{{ customDnsConfigs }}"
                  applicationSecurityGroups: "{{ applicationSecurityGroups }}"
                  ipConfigurations: "{{ ipConfigurations }}"
                  customNetworkInterfaceName: "{{ customNetworkInterfaceName }}"
                  billingSku: "{{ billingSku }}"
                extendedLocation:
                  name: "{{ name }}"
                  type: "{{ type }}"
                etag: "{{ etag }}"
            ipConfigurations:
              - id: "{{ id }}"
                properties:
                  privateIPAddress: "{{ privateIPAddress }}"
                  privateIPAllocationMethod: "{{ privateIPAllocationMethod }}"
                  subnet: "{{ subnet }}"
                  publicIPAddress: "{{ publicIPAddress }}"
                  provisioningState: "{{ provisioningState }}"
                name: "{{ name }}"
                etag: "{{ etag }}"
            ipConfigurationProfiles:
              - id: "{{ id }}"
                properties:
                  subnet: "{{ subnet }}"
                  provisioningState: "{{ provisioningState }}"
                name: "{{ name }}"
                type: "{{ type }}"
                etag: "{{ etag }}"
            ipAllocations:
              - id: "{{ id }}"
            resourceNavigationLinks:
              - id: "{{ id }}"
                properties:
                  linkedResourceType: "{{ linkedResourceType }}"
                  link: "{{ link }}"
                  provisioningState: "{{ provisioningState }}"
                name: "{{ name }}"
                etag: "{{ etag }}"
                type: "{{ type }}"
            serviceAssociationLinks:
              - id: "{{ id }}"
                properties:
                  linkedResourceType: "{{ linkedResourceType }}"
                  link: "{{ link }}"
                  provisioningState: "{{ provisioningState }}"
                  allowDelete: {{ allowDelete }}
                  locations: "{{ locations }}"
                name: "{{ name }}"
                etag: "{{ etag }}"
                type: "{{ type }}"
            delegations:
              - id: "{{ id }}"
                properties:
                  serviceName: "{{ serviceName }}"
                  actions: "{{ actions }}"
                  provisioningState: "{{ provisioningState }}"
                name: "{{ name }}"
                etag: "{{ etag }}"
                type: "{{ type }}"
            purpose: "{{ purpose }}"
            provisioningState: "{{ provisioningState }}"
            privateEndpointNetworkPolicies: "{{ privateEndpointNetworkPolicies }}"
            privateLinkServiceNetworkPolicies: "{{ privateLinkServiceNetworkPolicies }}"
            applicationGatewayIPConfigurations:
              - id: "{{ id }}"
                properties:
                  subnet: "{{ subnet }}"
                  provisioningState: "{{ provisioningState }}"
                name: "{{ name }}"
                etag: "{{ etag }}"
                type: "{{ type }}"
            sharingScope: "{{ sharingScope }}"
            defaultOutboundAccess: {{ defaultOutboundAccess }}
            ipamPoolPrefixAllocations:
              - pool:
                  id: "{{ id }}"
                numberOfIpAddresses: "{{ numberOfIpAddresses }}"
                allocatedAddressPrefixes: "{{ allocatedAddressPrefixes }}"
            serviceGateway:
              id: "{{ id }}"
          etag: "{{ etag }}"
        privateIPAddress: "{{ privateIPAddress }}"
        privateIPAllocationMethod: "{{ privateIPAllocationMethod }}"
      resourceGuid: "{{ resourceGuid }}"
      provisioningState: "{{ provisioningState }}"
  - name: sku
    description: |
      The service gateway SKU.
    value:
      name: "{{ name }}"
      tier: "{{ tier }}"
  - name: zones
    value:
      - "{{ zones }}"
    description: |
      A list of availability zones denoting the zone in which service gateway should be deployed. * The zone values must be provided as strings representing numeric identifiers like "1", "2", "3" etc.

UPDATE examples

update_tags

Updates a service gateway tags.

UPDATE azure.network.service_gateways
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND service_gateway_name = '{{ service_gateway_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
location,
properties,
sku,
systemData,
tags,
type,
zones;

REPLACE examples

create_or_update

Creates or updates a service gateway.

REPLACE azure.network.service_gateways
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
sku = '{{ sku }}',
zones = '{{ zones }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND service_gateway_name = '{{ service_gateway_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
etag,
location,
properties,
sku,
systemData,
tags,
type,
zones;

DELETE examples

delete

Deletes the specified service gateway.

DELETE FROM azure.network.service_gateways
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND service_gateway_name = '{{ service_gateway_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

get_address_locations

Get address locations in service gateway.

EXEC azure.network.service_gateways.get_address_locations 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_gateway_name='{{ service_gateway_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_services

Get Services in service gateway.

EXEC azure.network.service_gateways.get_services 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_gateway_name='{{ service_gateway_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

update_address_locations

Creates or updates address locations within the service gateway. The request supports both full and partial update modes at two levels: location and address. Full update replaces all existing data. Partial update modifies only the specified entries: For location-level partial updates, if no address is provided, the existing address will be deleted. For address-level partial updates, if no services are provided, the existing services will be considered for deletion.

EXEC azure.network.service_gateways.update_address_locations 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_gateway_name='{{ service_gateway_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"action": "{{ action }}", 
"addressLocations": "{{ addressLocations }}"
}'
;

update_services

Creates, updates, or deletes services within the service gateway. The request supports both full and partial update modes at the service level. Full update replaces all existing services with the new list provided in the request. Partial update modifies only the specified services.

EXEC azure.network.service_gateways.update_services 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_gateway_name='{{ service_gateway_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"action": "{{ action }}", 
"serviceRequests": "{{ serviceRequests }}"
}'
;