site_network_services

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

Overview

Name	site_network_services
Type	Resource
Id	azure.hybrid_network.site_network_services

Fields

The following fields are returned by SELECT queries:

get

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

Name	Datatype	Description
identity	object	The managed identity of the Site network service, if configured.
location	string	The geo-location where the resource lives
properties	object	Site network service properties.
sku	object	Sku of the site network service.
tags	object	Resource tags.

list_by_resource_group

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

Name	Datatype	Description
identity	object	The managed identity of the Site network service, if configured.
location	string	The geo-location where the resource lives
properties	object	Site network service properties.
sku	object	Sku of the site network service.
tags	object	Resource tags.

list_by_subscription

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

Name	Datatype	Description
identity	object	The managed identity of the Site network service, if configured.
location	string	The geo-location where the resource lives
properties	object	Site network service properties.
sku	object	Sku of the site network service.
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, siteNetworkServiceName		Gets information about the specified site network service.
list_by_resource_group	select	subscriptionId, resourceGroupName		Lists all site network services.
list_by_subscription	select	subscriptionId		Lists all sites in the network service in a subscription.
create_or_update	insert	subscriptionId, resourceGroupName, siteNetworkServiceName		Creates or updates a network site.
delete	delete	subscriptionId, resourceGroupName, siteNetworkServiceName		Deletes the specified site network service.
update_tags	exec	subscriptionId, resourceGroupName, siteNetworkServiceName		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.
siteNetworkServiceName	string	The name of the site network service.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Gets information about the specified site network service.

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

list_by_resource_group

Lists all site network services.

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

list_by_subscription

Lists all sites in the network service in a subscription.

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

INSERT examples

create_or_update

Creates or updates a network site.

INSERT INTO azure.hybrid_network.site_network_services (
data__properties,
data__identity,
data__sku,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
siteNetworkServiceName
)
SELECT 
'{{ properties }}',
'{{ identity }}',
'{{ sku }}',
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ siteNetworkServiceName }}'
RETURNING
identity,
location,
properties,
sku,
tags
;

Manifest

# Description fields are for documentation purposes
- name: site_network_services
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the site_network_services resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the site_network_services resource.
    - name: siteNetworkServiceName
      value: string
      description: Required parameter for the site_network_services resource.
    - name: properties
      value: object
      description: |
        Site network service properties.
    - name: identity
      value: object
      description: |
        The managed identity of the Site network service, if configured.
    - name: sku
      value: object
      description: |
        Sku of the site network service.
    - 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 site network service.

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

Lifecycle Methods

update_tags

Updates a site update tags.

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