storage_sync_services

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

Overview

Name	storage_sync_services
Type	Resource
Id	azure.storage_sync.storage_sync_services

Fields

The following fields are returned by SELECT queries:

check_name_availability

Name	Datatype	Description
message	string	Gets an error message explaining the Reason value in more detail.
nameAvailable	boolean	Gets a boolean value that indicates whether the name is available for you to use. If true, the name is available. If false, the name has already been taken or invalid and cannot be used.
reason	string	Gets the reason that a Storage Sync Service name could not be used. The Reason element is only returned if NameAvailable is false. Known values are: "Invalid" and "AlreadyExists".

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.
incomingTrafficPolicy	string	Incoming Traffic Policy. Known values are: "AllowAllTraffic" and "AllowVirtualNetworksOnly".
lastOperationName	string	Resource Last Operation Name.
lastWorkflowId	string	StorageSyncService lastWorkflowId.
location	string	The geo-location where the resource lives. Required.
privateEndpointConnections	array	List of private endpoint connection associated with the specified storage sync service.
provisioningState	string	StorageSyncService Provisioning State.
storageSyncServiceStatus	integer	Storage Sync service status.
storageSyncServiceUid	string	Storage Sync service Uid.
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.
incomingTrafficPolicy	string	Incoming Traffic Policy. Known values are: "AllowAllTraffic" and "AllowVirtualNetworksOnly".
lastOperationName	string	Resource Last Operation Name.
lastWorkflowId	string	StorageSyncService lastWorkflowId.
location	string	The geo-location where the resource lives. Required.
privateEndpointConnections	array	List of private endpoint connection associated with the specified storage sync service.
provisioningState	string	StorageSyncService Provisioning State.
storageSyncServiceStatus	integer	Storage Sync service status.
storageSyncServiceUid	string	Storage Sync service Uid.
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.
incomingTrafficPolicy	string	Incoming Traffic Policy. Known values are: "AllowAllTraffic" and "AllowVirtualNetworksOnly".
lastOperationName	string	Resource Last Operation Name.
lastWorkflowId	string	StorageSyncService lastWorkflowId.
location	string	The geo-location where the resource lives. Required.
privateEndpointConnections	array	List of private endpoint connection associated with the specified storage sync service.
provisioningState	string	StorageSyncService Provisioning State.
storageSyncServiceStatus	integer	Storage Sync service status.
storageSyncServiceUid	string	Storage Sync service Uid.
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
check_name_availability	select	location_name, subscription_id		Check the give namespace name availability.
get	select	resource_group_name, storage_sync_service_name, subscription_id		Get a given StorageSyncService.
list_by_resource_group	select	resource_group_name, subscription_id		Get a StorageSyncService list by Resource group name.
list_by_subscription	select	subscription_id		Get a StorageSyncService list by subscription.
create	insert	resource_group_name, storage_sync_service_name, subscription_id, location		Create a new StorageSyncService.
update	update	resource_group_name, storage_sync_service_name, subscription_id		Patch a given StorageSyncService.
delete	delete	resource_group_name, storage_sync_service_name, subscription_id		Delete a given StorageSyncService.

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
location_name	string	The desired region for the name check. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
storage_sync_service_name	string	Name of Storage Sync Service resource. Required.
subscription_id	string

SELECT examples

check_name_availability

Check the give namespace name availability.

SELECT
message,
nameAvailable,
reason
FROM azure.storage_sync.storage_sync_services
WHERE location_name = '{{ location_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get

Get a given StorageSyncService.

SELECT
id,
name,
incomingTrafficPolicy,
lastOperationName,
lastWorkflowId,
location,
privateEndpointConnections,
provisioningState,
storageSyncServiceStatus,
storageSyncServiceUid,
systemData,
tags,
type
FROM azure.storage_sync.storage_sync_services
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND storage_sync_service_name = '{{ storage_sync_service_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Get a StorageSyncService list by Resource group name.

SELECT
id,
name,
incomingTrafficPolicy,
lastOperationName,
lastWorkflowId,
location,
privateEndpointConnections,
provisioningState,
storageSyncServiceStatus,
storageSyncServiceUid,
systemData,
tags,
type
FROM azure.storage_sync.storage_sync_services
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Get a StorageSyncService list by subscription.

SELECT
id,
name,
incomingTrafficPolicy,
lastOperationName,
lastWorkflowId,
location,
privateEndpointConnections,
provisioningState,
storageSyncServiceStatus,
storageSyncServiceUid,
systemData,
tags,
type
FROM azure.storage_sync.storage_sync_services
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Create a new StorageSyncService.

INSERT INTO azure.storage_sync.storage_sync_services (
location,
tags,
properties,
resource_group_name,
storage_sync_service_name,
subscription_id
)
SELECT 
'{{ location }}' /* required */,
'{{ tags }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ storage_sync_service_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: storage_sync_services
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the storage_sync_services resource.
  - name: storage_sync_service_name
    value: "{{ storage_sync_service_name }}"
    description: Required parameter for the storage_sync_services resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the storage_sync_services resource.
  - name: location
    value: "{{ location }}"
    description: |
      Required. Gets or sets the location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update, the request will succeed. Required.
  - name: tags
    value: "{{ tags }}"
    description: |
      Gets or sets a list of key value pairs that describe the resource. These tags can be used for viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key with a length no greater than 128 characters and a value with a length no greater than 256 characters.
  - name: properties
    value:
      incomingTrafficPolicy: "{{ incomingTrafficPolicy }}"

UPDATE examples

update

Patch a given StorageSyncService.

UPDATE azure.storage_sync.storage_sync_services
SET 
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND storage_sync_service_name = '{{ storage_sync_service_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete a given StorageSyncService.

DELETE FROM azure.storage_sync.storage_sync_services
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND storage_sync_service_name = '{{ storage_sync_service_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;