sites

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

Overview

Name	sites
Type	Resource
Id	azure_extras.hybrid_network.sites

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.
location	string	The geo-location where the resource lives. Required.
nfvis	array	List of NFVIs.
provisioningState	string	The provisioning state of the site resource. TODO\ : Confirm if this is needed. Known values are: "Unknown", "Succeeded", "Accepted", "Deleting", "Failed", "Canceled", "Deleted", and "Converging".
siteNetworkServiceReferences	array	The list of site network services on the site.
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.
location	string	The geo-location where the resource lives. Required.
nfvis	array	List of NFVIs.
provisioningState	string	The provisioning state of the site resource. TODO\ : Confirm if this is needed. Known values are: "Unknown", "Succeeded", "Accepted", "Deleting", "Failed", "Canceled", "Deleted", and "Converging".
siteNetworkServiceReferences	array	The list of site network services on the site.
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.
location	string	The geo-location where the resource lives. Required.
nfvis	array	List of NFVIs.
provisioningState	string	The provisioning state of the site resource. TODO\ : Confirm if this is needed. Known values are: "Unknown", "Succeeded", "Accepted", "Deleting", "Failed", "Canceled", "Deleted", and "Converging".
siteNetworkServiceReferences	array	The list of site network services on the site.
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_name, subscription_id		Gets information about the specified network site.
list_by_resource_group	select	resource_group_name, subscription_id		Lists all sites in the network service.
list_by_subscription	select	subscription_id		Lists all sites in the network service in a subscription.
create_or_update	insert	resource_group_name, site_name, subscription_id, location		Creates or updates a network site.
update_tags	update	resource_group_name, site_name, subscription_id		Updates a site update tags.
create_or_update	replace	resource_group_name, site_name, subscription_id, location		Creates or updates a network site.
delete	delete	resource_group_name, site_name, subscription_id		Deletes the specified network site.

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

SELECT examples

get

Gets information about the specified network site.

SELECT
id,
name,
location,
nfvis,
provisioningState,
siteNetworkServiceReferences,
systemData,
tags,
type
FROM azure_extras.hybrid_network.sites
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND site_name = '{{ site_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Lists all sites in the network service.

SELECT
id,
name,
location,
nfvis,
provisioningState,
siteNetworkServiceReferences,
systemData,
tags,
type
FROM azure_extras.hybrid_network.sites
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,
location,
nfvis,
provisioningState,
siteNetworkServiceReferences,
systemData,
tags,
type
FROM azure_extras.hybrid_network.sites
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a network site.

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

Manifest

# Description fields are for documentation purposes
- name: sites
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the sites resource.
  - name: site_name
    value: "{{ site_name }}"
    description: Required parameter for the sites resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the sites 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 properties.
    value:
      provisioningState: "{{ provisioningState }}"
      nfvis:
        - name: "{{ name }}"
          nfviType: "{{ nfviType }}"
      siteNetworkServiceReferences:
        - id: "{{ id }}"

UPDATE examples

update_tags

Updates a site update tags.

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

REPLACE examples

create_or_update

Creates or updates a network site.

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

DELETE examples

delete

Deletes the specified network site.

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