StorageSyncServicesOperations Class

StorageSyncServicesOperations 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
StorageSyncServicesOperations

Constructor

StorageSyncServicesOperations(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

begin_create

Create a new StorageSyncService.

begin_delete

Delete a given StorageSyncService.

begin_update

Patch a given StorageSyncService.

check_name_availability

Check the give namespace name availability.

get

Get a given StorageSyncService.

list_by_resource_group

Get a StorageSyncService list by Resource group name.

list_by_subscription

Get a StorageSyncService list by subscription.

begin_create

Create a new StorageSyncService.

begin_create(resource_group_name: str, storage_sync_service_name: str, parameters: _models.StorageSyncServiceCreateParameters, **kwargs: Any) -> LROPoller[_models.StorageSyncService]

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.

parameters
StorageSyncServiceCreateParameters
Required

Storage Sync Service resource name.

cls
callable

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

continuation_token
str

A continuation token to restart a poller from a saved state.

polling
bool or PollingMethod

Pass in True if you'd like the ARMPolling polling method, False for no polling, or your own initialized polling object for a personal polling strategy.

polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either StorageSyncService or the result of cls(response)

Return type

Exceptions

begin_delete

Delete a given StorageSyncService.

begin_delete(resource_group_name: str, storage_sync_service_name: str, **kwargs: Any) -> LROPoller[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.

cls
callable

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

continuation_token
str

A continuation token to restart a poller from a saved state.

polling
bool or PollingMethod

Pass in True if you'd like the ARMPolling polling method, False for no polling, or your own initialized polling object for a personal polling strategy.

polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

Exceptions

begin_update

Patch a given StorageSyncService.

begin_update(resource_group_name: str, storage_sync_service_name: str, parameters: Optional[_models.StorageSyncServiceUpdateParameters] = None, **kwargs: Any) -> LROPoller[_models.StorageSyncService]

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.

parameters
StorageSyncServiceUpdateParameters
default value: None

Storage Sync Service resource.

cls
callable

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

continuation_token
str

A continuation token to restart a poller from a saved state.

polling
bool or PollingMethod

Pass in True if you'd like the ARMPolling polling method, False for no polling, or your own initialized polling object for a personal polling strategy.

polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either StorageSyncService or the result of cls(response)

Return type

Exceptions

check_name_availability

Check the give namespace name availability.

check_name_availability(location_name: str, parameters: _models.CheckNameAvailabilityParameters, **kwargs: Any) -> _models.CheckNameAvailabilityResult

Parameters

location_name
str
Required

The desired region for the name check.

parameters
CheckNameAvailabilityParameters
Required

Parameters to check availability of the given namespace name.

cls
callable

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

Returns

CheckNameAvailabilityResult, or the result of cls(response)

Return type

Exceptions

get

Get a given StorageSyncService.

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

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

StorageSyncService, or the result of cls(response)

Return type

Exceptions

list_by_resource_group

Get a StorageSyncService list by Resource group name.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[_models.StorageSyncServiceArray]

Parameters

resource_group_name
str
Required

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

cls
callable

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

Returns

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

Return type

Exceptions

list_by_subscription

Get a StorageSyncService list by subscription.

list_by_subscription(**kwargs: Any) -> Iterable[_models.StorageSyncServiceArray]

Parameters

cls
callable

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

Returns

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

Return type

Exceptions

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'>