SyncGroupsOperations Class

SyncGroupsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance

builtins.object

SyncGroupsOperations

Constructor

SyncGroupsOperations(client, config, serializer, deserializer)

Parameters

client

Required

Client for service requests.

config

Required

Configuration of service client.

serializer

Required

An object model serializer.

deserializer

Required

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

Methods

create	Create a new SyncGroup.
delete	Delete a given SyncGroup.
get	Get a given SyncGroup.
list_by_storage_sync_service	Get a SyncGroup List.

create

Create a new SyncGroup.

create(resource_group_name: str, storage_sync_service_name: str, sync_group_name: str, parameters: _models.SyncGroupCreateParameters, **kwargs: Any) -> _models.SyncGroup

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

storage_sync_service_name

str

Required

Name of Storage Sync Service resource.

sync_group_name

str

Required

Name of Sync Group resource.

parameters

SyncGroupCreateParameters

Required

Sync Group Body.

cls

callable

A custom type or function that will be passed the direct response

Returns

SyncGroup, or the result of cls(response)

Return type

SyncGroup

Exceptions

HttpResponseError

delete

Delete a given SyncGroup.

delete(resource_group_name: str, storage_sync_service_name: str, sync_group_name: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

storage_sync_service_name

str

Required

Name of Storage Sync Service resource.

sync_group_name

str

Required

Name of Sync Group resource.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

get

Get a given SyncGroup.

get(resource_group_name: str, storage_sync_service_name: str, sync_group_name: str, **kwargs: Any) -> _models.SyncGroup

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

storage_sync_service_name

str

Required

Name of Storage Sync Service resource.

sync_group_name

str

Required

Name of Sync Group resource.

cls

callable

A custom type or function that will be passed the direct response

Returns

SyncGroup, or the result of cls(response)

Return type

SyncGroup

Exceptions

HttpResponseError

list_by_storage_sync_service

Get a SyncGroup List.

list_by_storage_sync_service(resource_group_name: str, storage_sync_service_name: str, **kwargs: Any) -> Iterable[_models.SyncGroupArray]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

storage_sync_service_name

str

Required

Name of Storage Sync Service resource.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either SyncGroupArray or the result of cls(response)

Return type

ItemPaged[SyncGroupArray]

Exceptions

HttpResponseError

Attributes

models

models = <module 'azure.mgmt.storagesync.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\storagesync\\models\\__init__.py'>