Skip to content

Files

Latest commit

b64e5ef · Sep 3, 2019

History

History
57 lines (42 loc) · 2.92 KB
·

azure_sync_group.md

File metadata and controls

57 lines (42 loc) · 2.92 KB
·

Document: "storagesync"

Path: "https://github.com/Azure/azure-rest-api-specs/blob/2fbb5118cd34f412a51d9bc8a274224b216763cf/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2019-03-01/storagesync.json")

SyncGroup

Sync Group object.

azure_sync_group {
  api_version => "api_version",
  parameters => "parameters",
  properties => $azure_sync_group_properties
  resource_group_name => "resource_group_name",
  storage_sync_service_name => "storage_sync_service_name",
  subscription_id => "subscription_id",
}
Name Type Required Description
api_version String true The API version to use for this operation.
parameters Hash true Sync Group Body
properties SyncGroupProperties false SyncGroup properties.
resource_group_name String true The name of the resource group. The name is case insensitive.
storage_sync_service_name String true Name of Storage Sync Service resource.
subscription_id String true The ID of the target subscription.

SyncGroupProperties

SyncGroup Properties object.

$azure_sync_group_properties = {
  uniqueId => "uniqueId (optional)",
}
Name Type Required Description
uniqueId String false Unique Id

CRUD operations

Here is a list of endpoints that we use to create, read, update and delete the SyncGroup

Operation Path Verb Description OperationID
Create /subscriptions/%{subscription_id}/resourceGroups/%{resource_group_name}/providers/Microsoft.StorageSync/storageSyncServices/%{storage_sync_service_name}/syncGroups/%{sync_group_name} Put Create a new SyncGroup. SyncGroups_Create
List - list all ``
List - get one /subscriptions/%{subscription_id}/resourceGroups/%{resource_group_name}/providers/Microsoft.StorageSync/storageSyncServices/%{storage_sync_service_name}/syncGroups/%{sync_group_name} Get Get a given SyncGroup. SyncGroups_Get
List - get list using params /subscriptions/%{subscription_id}/resourceGroups/%{resource_group_name}/providers/Microsoft.StorageSync/storageSyncServices/%{storage_sync_service_name}/syncGroups Get Get a SyncGroup List. SyncGroups_ListByStorageSyncService
Update /subscriptions/%{subscription_id}/resourceGroups/%{resource_group_name}/providers/Microsoft.StorageSync/storageSyncServices/%{storage_sync_service_name}/syncGroups/%{sync_group_name} Put Create a new SyncGroup. SyncGroups_Create
Delete /subscriptions/%{subscription_id}/resourceGroups/%{resource_group_name}/providers/Microsoft.StorageSync/storageSyncServices/%{storage_sync_service_name}/syncGroups/%{sync_group_name} Delete Delete a given SyncGroup. SyncGroups_Delete