sites

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

Overview

Name	sites
Type	Resource
Id	azure.hybrid_network.sites

Fields

The following fields are returned by SELECT queries:

get

Request successful. The operation returns the resulting network site resource.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Site properties.
tags	object	Resource tags.

list_by_resource_group

Request successful. The operation returns a list of network site resources.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Site properties.
tags	object	Resource tags.

list_by_subscription

Request is successful. The operation returns a list of hybrid network site resources.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Site properties.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, siteName		Gets information about the specified network site.
list_by_resource_group	select	subscriptionId, resourceGroupName		Lists all sites in the network service.
list_by_subscription	select	subscriptionId		Lists all sites in the network service in a subscription.
create_or_update	insert	subscriptionId, resourceGroupName, siteName		Creates or updates a network site.
delete	delete	subscriptionId, resourceGroupName, siteName		Deletes the specified network site.
update_tags	exec	subscriptionId, resourceGroupName, siteName		Updates a site update tags.

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
resourceGroupName	string	The name of the resource group. The name is case insensitive.
siteName	string	The name of the network service site.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Gets information about the specified network site.

SELECT
location,
properties,
tags
FROM azure.hybrid_network.sites
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND siteName = '{{ siteName }}' -- required
;

list_by_resource_group

Lists all sites in the network service.

SELECT
location,
properties,
tags
FROM azure.hybrid_network.sites
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_subscription

Lists all sites in the network service in a subscription.

SELECT
location,
properties,
tags
FROM azure.hybrid_network.sites
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates a network site.

INSERT INTO azure.hybrid_network.sites (
data__properties,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
siteName
)
SELECT 
'{{ properties }}',
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ siteName }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: sites
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the sites resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the sites resource.
    - name: siteName
      value: string
      description: Required parameter for the sites resource.
    - name: properties
      value: object
      description: |
        Site properties.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

DELETE examples

delete

Deletes the specified network site.

DELETE FROM azure.hybrid_network.sites
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND siteName = '{{ siteName }}' --required
;

Lifecycle Methods

update_tags

Updates a site update tags.

EXEC azure.hybrid_network.sites.update_tags 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@siteName='{{ siteName }}' --required 
@@json=
'{
"tags": "{{ tags }}"
}'
;