gateways

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

Overview

Name	gateways
Type	Resource
Id	azure.hybrid_compute.gateways

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
allowedFeatures	array	Specifies the list of features that are enabled for this Gateway.
gatewayEndpoint	string	The endpoint fqdn for the Gateway.
gatewayId	string	A unique, immutable, identifier for the Gateway.
gatewayType	string	The type of the Gateway resource. "Public" (Public)
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The provisioning state, which only appears in the response. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Failed", "Accepted", "Canceled", and "Deleted". (Creating, Updating, Deleting, Succeeded, Failed, Accepted, Canceled, Deleted)
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".

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
allowedFeatures	array	Specifies the list of features that are enabled for this Gateway.
gatewayEndpoint	string	The endpoint fqdn for the Gateway.
gatewayId	string	A unique, immutable, identifier for the Gateway.
gatewayType	string	The type of the Gateway resource. "Public" (Public)
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The provisioning state, which only appears in the response. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Failed", "Accepted", "Canceled", and "Deleted". (Creating, Updating, Deleting, Succeeded, Failed, Accepted, Canceled, Deleted)
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".

list_by_subscription

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
allowedFeatures	array	Specifies the list of features that are enabled for this Gateway.
gatewayEndpoint	string	The endpoint fqdn for the Gateway.
gatewayId	string	A unique, immutable, identifier for the Gateway.
gatewayType	string	The type of the Gateway resource. "Public" (Public)
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The provisioning state, which only appears in the response. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Failed", "Accepted", "Canceled", and "Deleted". (Creating, Updating, Deleting, Succeeded, Failed, Accepted, Canceled, Deleted)
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".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, gateway_name, subscription_id		Retrieves information about the view of a gateway.
list_by_resource_group	select	resource_group_name, subscription_id		The operation to get all gateways of a non-Azure machine.
list_by_subscription	select	subscription_id		The operation to get all gateways of a non-Azure machine.
create_or_update	insert	resource_group_name, gateway_name, subscription_id, location		The operation to create or update a gateway.
update	update	resource_group_name, gateway_name, subscription_id		The operation to update a gateway.
create_or_update	replace	resource_group_name, gateway_name, subscription_id, location		The operation to create or update a gateway.
delete	delete	resource_group_name, gateway_name, subscription_id		The operation to delete a gateway.

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
gateway_name	string	The name of the Gateway. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Retrieves information about the view of a gateway.

SELECT
id,
name,
allowedFeatures,
gatewayEndpoint,
gatewayId,
gatewayType,
location,
provisioningState,
systemData,
tags,
type
FROM azure.hybrid_compute.gateways
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND gateway_name = '{{ gateway_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

The operation to get all gateways of a non-Azure machine.

SELECT
id,
name,
allowedFeatures,
gatewayEndpoint,
gatewayId,
gatewayType,
location,
provisioningState,
systemData,
tags,
type
FROM azure.hybrid_compute.gateways
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

The operation to get all gateways of a non-Azure machine.

SELECT
id,
name,
allowedFeatures,
gatewayEndpoint,
gatewayId,
gatewayType,
location,
provisioningState,
systemData,
tags,
type
FROM azure.hybrid_compute.gateways
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

The operation to create or update a gateway.

INSERT INTO azure.hybrid_compute.gateways (
tags,
location,
properties,
resource_group_name,
gateway_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ gateway_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: gateways
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the gateways resource.
  - name: gateway_name
    value: "{{ gateway_name }}"
    description: Required parameter for the gateways resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the 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: |
      Hybrid Compute Gateway properties.
    value:
      provisioningState: "{{ provisioningState }}"
      gatewayId: "{{ gatewayId }}"
      gatewayType: "{{ gatewayType }}"
      gatewayEndpoint: "{{ gatewayEndpoint }}"
      allowedFeatures:
        - "{{ allowedFeatures }}"

UPDATE examples

update

The operation to update a gateway.

UPDATE azure.hybrid_compute.gateways
SET 
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND gateway_name = '{{ gateway_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

The operation to create or update a gateway.

REPLACE azure.hybrid_compute.gateways
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND gateway_name = '{{ gateway_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

The operation to delete a gateway.

DELETE FROM azure.hybrid_compute.gateways
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND gateway_name = '{{ gateway_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;