resource_sync_rules

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

Overview

Name	resource_sync_rules
Type	Resource
Id	azure.custom_locations.resource_sync_rules

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	The set of properties specific to a Resource Sync Rule
systemData	object	Metadata pertaining to creation and last modification of the resource
tags	object	Resource tags.

list_by_custom_location_id

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	The set of properties specific to a Resource Sync Rule
systemData	object	Metadata pertaining to creation and last modification of the resource
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, resourceName, childResourceName		Gets the details of the resourceSyncRule with a specified resource group, subscription id Custom Location resource name and Resource Sync Rule name.
list_by_custom_location_id	select	subscriptionId, resourceGroupName, resourceName		Gets a list of Resource Sync Rules in the specified subscription. The operation returns properties of each Resource Sync Rule
create_or_update	insert	subscriptionId, resourceGroupName, resourceName, childResourceName		Creates or updates a Resource Sync Rule in the parent Custom Location, Subscription Id and Resource Group
update	update	subscriptionId, resourceGroupName, resourceName, childResourceName		Updates a Resource Sync Rule with the specified Resource Sync Rule name in the specified Resource Group, Subscription and Custom Location name.
delete	delete	subscriptionId, resourceGroupName, resourceName, childResourceName		Deletes the Resource Sync Rule with the specified Resource Sync Rule Name, Custom Location Resource Name, Resource Group, and Subscription Id.

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
childResourceName	string	Resource Sync Rule name.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
resourceName	string	Custom Locations name.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Gets the details of the resourceSyncRule with a specified resource group, subscription id Custom Location resource name and Resource Sync Rule name.

SELECT
location,
properties,
systemData,
tags
FROM azure.custom_locations.resource_sync_rules
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND resourceName = '{{ resourceName }}' -- required
AND childResourceName = '{{ childResourceName }}' -- required
;

list_by_custom_location_id

Gets a list of Resource Sync Rules in the specified subscription. The operation returns properties of each Resource Sync Rule

SELECT
location,
properties,
systemData,
tags
FROM azure.custom_locations.resource_sync_rules
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND resourceName = '{{ resourceName }}' -- required
;

INSERT examples

create_or_update

Creates or updates a Resource Sync Rule in the parent Custom Location, Subscription Id and Resource Group

INSERT INTO azure.custom_locations.resource_sync_rules (
data__properties,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
resourceName,
childResourceName
)
SELECT 
'{{ properties }}',
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ resourceName }}',
'{{ childResourceName }}'
RETURNING
location,
properties,
systemData,
tags
;

Manifest

# Description fields are for documentation purposes
- name: resource_sync_rules
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the resource_sync_rules resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the resource_sync_rules resource.
    - name: resourceName
      value: string
      description: Required parameter for the resource_sync_rules resource.
    - name: childResourceName
      value: string
      description: Required parameter for the resource_sync_rules resource.
    - name: properties
      value: object
      description: |
        The set of properties specific to a Resource Sync Rule
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

Updates a Resource Sync Rule with the specified Resource Sync Rule name in the specified Resource Group, Subscription and Custom Location name.

UPDATE azure.custom_locations.resource_sync_rules
SET 
data__properties = '{{ properties }}',
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND resourceName = '{{ resourceName }}' --required
AND childResourceName = '{{ childResourceName }}' --required
RETURNING
location,
properties,
systemData,
tags;

DELETE examples

delete

Deletes the Resource Sync Rule with the specified Resource Sync Rule Name, Custom Location Resource Name, Resource Group, and Subscription Id.

DELETE FROM azure.custom_locations.resource_sync_rules
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND resourceName = '{{ resourceName }}' --required
AND childResourceName = '{{ childResourceName }}' --required
;