site_network_services

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

Overview

Name	site_network_services
Type	Resource
Id	azure_extras.hybrid_network.site_network_services

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.
desiredStateConfigurationGroupValueReferences	object	The goal state of the site network service resource. This has references to the configuration group value objects that describe the desired state of the site network service.
identity	object	The managed identity of the Site network service, if configured.
lastStateConfigurationGroupValueReferences	object	The last state of the site network service resource.
lastStateNetworkServiceDesignVersionName	string	The network service design version for the site network service.
location	string	The geo-location where the resource lives. Required.
managedResourceGroupConfiguration	object	Managed resource group configuration.
networkServiceDesignGroupName	string	The network service design group name for the site network service.
networkServiceDesignVersionName	string	The network service design version for the site network service.
networkServiceDesignVersionOfferingLocation	string	The location of the network service design offering.
networkServiceDesignVersionResourceReference	object	The network service design version resource reference.
provisioningState	string	The provisioning state of the site network service resource. Known values are: "Unknown", "Succeeded", "Accepted", "Deleting", "Failed", "Canceled", "Deleted", and "Converging".
publisherName	string	The publisher name for the site network service.
publisherScope	string	The scope of the publisher. Known values are: "Unknown" and "Private".
siteReference	object	The site details.
sku	object	Sku of the site network service.
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.
desiredStateConfigurationGroupValueReferences	object	The goal state of the site network service resource. This has references to the configuration group value objects that describe the desired state of the site network service.
identity	object	The managed identity of the Site network service, if configured.
lastStateConfigurationGroupValueReferences	object	The last state of the site network service resource.
lastStateNetworkServiceDesignVersionName	string	The network service design version for the site network service.
location	string	The geo-location where the resource lives. Required.
managedResourceGroupConfiguration	object	Managed resource group configuration.
networkServiceDesignGroupName	string	The network service design group name for the site network service.
networkServiceDesignVersionName	string	The network service design version for the site network service.
networkServiceDesignVersionOfferingLocation	string	The location of the network service design offering.
networkServiceDesignVersionResourceReference	object	The network service design version resource reference.
provisioningState	string	The provisioning state of the site network service resource. Known values are: "Unknown", "Succeeded", "Accepted", "Deleting", "Failed", "Canceled", "Deleted", and "Converging".
publisherName	string	The publisher name for the site network service.
publisherScope	string	The scope of the publisher. Known values are: "Unknown" and "Private".
siteReference	object	The site details.
sku	object	Sku of the site network service.
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.
desiredStateConfigurationGroupValueReferences	object	The goal state of the site network service resource. This has references to the configuration group value objects that describe the desired state of the site network service.
identity	object	The managed identity of the Site network service, if configured.
lastStateConfigurationGroupValueReferences	object	The last state of the site network service resource.
lastStateNetworkServiceDesignVersionName	string	The network service design version for the site network service.
location	string	The geo-location where the resource lives. Required.
managedResourceGroupConfiguration	object	Managed resource group configuration.
networkServiceDesignGroupName	string	The network service design group name for the site network service.
networkServiceDesignVersionName	string	The network service design version for the site network service.
networkServiceDesignVersionOfferingLocation	string	The location of the network service design offering.
networkServiceDesignVersionResourceReference	object	The network service design version resource reference.
provisioningState	string	The provisioning state of the site network service resource. Known values are: "Unknown", "Succeeded", "Accepted", "Deleting", "Failed", "Canceled", "Deleted", and "Converging".
publisherName	string	The publisher name for the site network service.
publisherScope	string	The scope of the publisher. Known values are: "Unknown" and "Private".
siteReference	object	The site details.
sku	object	Sku of the site network service.
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, site_network_service_name, subscription_id		Gets information about the specified site network service.
list_by_resource_group	select	resource_group_name, subscription_id		Lists all site network services.
list_by_subscription	select	subscription_id		Lists all sites in the network service in a subscription.
create_or_update	insert	resource_group_name, site_network_service_name, subscription_id, location		Creates or updates a network site.
update_tags	update	resource_group_name, site_network_service_name, subscription_id		Updates a site update tags.
create_or_update	replace	resource_group_name, site_network_service_name, subscription_id, location		Creates or updates a network site.
delete	delete	resource_group_name, site_network_service_name, subscription_id		Deletes the specified site network service.

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.
site_network_service_name	string	The name of the site network service. Required.
subscription_id	string

SELECT examples

get

Gets information about the specified site network service.

SELECT
id,
name,
desiredStateConfigurationGroupValueReferences,
identity,
lastStateConfigurationGroupValueReferences,
lastStateNetworkServiceDesignVersionName,
location,
managedResourceGroupConfiguration,
networkServiceDesignGroupName,
networkServiceDesignVersionName,
networkServiceDesignVersionOfferingLocation,
networkServiceDesignVersionResourceReference,
provisioningState,
publisherName,
publisherScope,
siteReference,
sku,
systemData,
tags,
type
FROM azure_extras.hybrid_network.site_network_services
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND site_network_service_name = '{{ site_network_service_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Lists all site network services.

SELECT
id,
name,
desiredStateConfigurationGroupValueReferences,
identity,
lastStateConfigurationGroupValueReferences,
lastStateNetworkServiceDesignVersionName,
location,
managedResourceGroupConfiguration,
networkServiceDesignGroupName,
networkServiceDesignVersionName,
networkServiceDesignVersionOfferingLocation,
networkServiceDesignVersionResourceReference,
provisioningState,
publisherName,
publisherScope,
siteReference,
sku,
systemData,
tags,
type
FROM azure_extras.hybrid_network.site_network_services
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Lists all sites in the network service in a subscription.

SELECT
id,
name,
desiredStateConfigurationGroupValueReferences,
identity,
lastStateConfigurationGroupValueReferences,
lastStateNetworkServiceDesignVersionName,
location,
managedResourceGroupConfiguration,
networkServiceDesignGroupName,
networkServiceDesignVersionName,
networkServiceDesignVersionOfferingLocation,
networkServiceDesignVersionResourceReference,
provisioningState,
publisherName,
publisherScope,
siteReference,
sku,
systemData,
tags,
type
FROM azure_extras.hybrid_network.site_network_services
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a network site.

INSERT INTO azure_extras.hybrid_network.site_network_services (
tags,
location,
properties,
identity,
sku,
resource_group_name,
site_network_service_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ identity }}',
'{{ sku }}',
'{{ resource_group_name }}',
'{{ site_network_service_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
location,
properties,
sku,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: site_network_services
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the site_network_services resource.
  - name: site_network_service_name
    value: "{{ site_network_service_name }}"
    description: Required parameter for the site_network_services resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the site_network_services resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      Site network service properties.
    value:
      provisioningState: "{{ provisioningState }}"
      managedResourceGroupConfiguration:
        name: "{{ name }}"
        location: "{{ location }}"
      siteReference:
        id: "{{ id }}"
      publisherName: "{{ publisherName }}"
      publisherScope: "{{ publisherScope }}"
      networkServiceDesignGroupName: "{{ networkServiceDesignGroupName }}"
      networkServiceDesignVersionName: "{{ networkServiceDesignVersionName }}"
      networkServiceDesignVersionOfferingLocation: "{{ networkServiceDesignVersionOfferingLocation }}"
      networkServiceDesignVersionResourceReference:
        idType: "{{ idType }}"
      desiredStateConfigurationGroupValueReferences: "{{ desiredStateConfigurationGroupValueReferences }}"
      lastStateNetworkServiceDesignVersionName: "{{ lastStateNetworkServiceDesignVersionName }}"
      lastStateConfigurationGroupValueReferences: "{{ lastStateConfigurationGroupValueReferences }}"
  - name: identity
    description: |
      The managed identity of the Site network service, if configured.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"
  - name: sku
    description: |
      Sku of the site network service.
    value:
      name: "{{ name }}"
      tier: "{{ tier }}"

UPDATE examples

update_tags

Updates a site update tags.

UPDATE azure_extras.hybrid_network.site_network_services
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND site_network_service_name = '{{ site_network_service_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
location,
properties,
sku,
systemData,
tags,
type;

REPLACE examples

create_or_update

Creates or updates a network site.

REPLACE azure_extras.hybrid_network.site_network_services
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
identity = '{{ identity }}',
sku = '{{ sku }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND site_network_service_name = '{{ site_network_service_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
identity,
location,
properties,
sku,
systemData,
tags,
type;

DELETE examples

delete

Deletes the specified site network service.

DELETE FROM azure_extras.hybrid_network.site_network_services
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND site_network_service_name = '{{ site_network_service_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;