sites_by_service_group

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

Overview

Name	sites_by_service_group
Type	Resource
Id	azure.site_manager.sites_by_service_group

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.
description	string	Description of Site resource.
displayName	string	displayName of Site resource.
labels	object	Key-value pairs for labeling the site resource.
provisioningState	string	Provisioning state of last operation. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
siteAddress	object	Physical address of the site.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_service_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.
description	string	Description of Site resource.
displayName	string	displayName of Site resource.
labels	object	Key-value pairs for labeling the site resource.
provisioningState	string	Provisioning state of last operation. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
siteAddress	object	Physical address of the site.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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	servicegroup_name, site_name		Get Site at SG scope.
list_by_service_group	select	servicegroup_name		list Site at SG scope.
create_or_update	insert	servicegroup_name, site_name		create or update Site at SG scope.
update	update	servicegroup_name, site_name		update Site at SG scope.
create_or_update	replace	servicegroup_name, site_name		create or update Site at SG scope.
delete	delete	servicegroup_name, site_name		delete Site at SG scope.

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
servicegroup_name	string	The name of the service group. Required.
site_name	string	The name of the site. Required.

SELECT examples

get

Get Site at SG scope.

SELECT
id,
name,
description,
displayName,
labels,
provisioningState,
siteAddress,
systemData,
type
FROM azure.site_manager.sites_by_service_group
WHERE servicegroup_name = '{{ servicegroup_name }}' -- required
AND site_name = '{{ site_name }}' -- required
;

list_by_service_group

list Site at SG scope.

SELECT
id,
name,
description,
displayName,
labels,
provisioningState,
siteAddress,
systemData,
type
FROM azure.site_manager.sites_by_service_group
WHERE servicegroup_name = '{{ servicegroup_name }}' -- required
;

INSERT examples

create_or_update

create or update Site at SG scope.

INSERT INTO azure.site_manager.sites_by_service_group (
properties,
servicegroup_name,
site_name
)
SELECT 
'{{ properties }}',
'{{ servicegroup_name }}',
'{{ site_name }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: sites_by_service_group
props:
  - name: servicegroup_name
    value: "{{ servicegroup_name }}"
    description: Required parameter for the sites_by_service_group resource.
  - name: site_name
    value: "{{ site_name }}"
    description: Required parameter for the sites_by_service_group resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      displayName: "{{ displayName }}"
      description: "{{ description }}"
      siteAddress:
        streetAddress1: "{{ streetAddress1 }}"
        streetAddress2: "{{ streetAddress2 }}"
        city: "{{ city }}"
        stateOrProvince: "{{ stateOrProvince }}"
        country: "{{ country }}"
        postalCode: "{{ postalCode }}"
      labels: "{{ labels }}"
      provisioningState: "{{ provisioningState }}"

UPDATE examples

update

update Site at SG scope.

UPDATE azure.site_manager.sites_by_service_group
SET 
properties = '{{ properties }}'
WHERE 
servicegroup_name = '{{ servicegroup_name }}' --required
AND site_name = '{{ site_name }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

REPLACE examples

create_or_update

create or update Site at SG scope.

REPLACE azure.site_manager.sites_by_service_group
SET 
properties = '{{ properties }}'
WHERE 
servicegroup_name = '{{ servicegroup_name }}' --required
AND site_name = '{{ site_name }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

delete Site at SG scope.

DELETE FROM azure.site_manager.sites_by_service_group
WHERE servicegroup_name = '{{ servicegroup_name }}' --required
AND site_name = '{{ site_name }}' --required
;