sites_by_subscription

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

Overview

Name	sites_by_subscription
Type	Resource
Id	azure.site_manager.sites_by_subscription

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

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	site_name, subscription_id		Get a Site.
list	select	subscription_id		List Site resources by subscription ID.
create_or_update	insert	site_name, subscription_id		Create a Site.
update	update	site_name, subscription_id		Update a Site.
create_or_update	replace	site_name, subscription_id		Create a Site.
delete	delete	site_name, subscription_id		Delete a 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
site_name	string	Name of Site resource. Required.
subscription_id	string

SELECT examples

get

Get a Site.

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

list

List Site resources by subscription ID.

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

INSERT examples

create_or_update

Create a Site.

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

Manifest

# Description fields are for documentation purposes
- name: sites_by_subscription
props:
  - name: site_name
    value: "{{ site_name }}"
    description: Required parameter for the sites_by_subscription resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the sites_by_subscription 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 a Site.

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

REPLACE examples

create_or_update

Create a Site.

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

DELETE examples

delete

Delete a Site.

DELETE FROM azure.site_manager.sites_by_subscription
WHERE site_name = '{{ site_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;