RegisteredServersOperations Class

RegisteredServersOperations async 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

RegisteredServersOperations

Constructor

RegisteredServersOperations(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	Add a new registered server.
begin_delete	Delete the given registered server.
begin_trigger_rollover	Triggers Server certificate rollover.
get	Get a given registered server.
list_by_storage_sync_service	Get a given registered server list.

begin_create

Add a new registered server.

async begin_create(resource_group_name: str, storage_sync_service_name: str, server_id: str, parameters: azure.mgmt.storagesync.models._models_py3.RegisteredServerCreateParameters, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.storagesync.models._models_py3.RegisteredServer]

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.

server_id

str

Required

GUID identifying the on-premises server.

parameters

RegisteredServerCreateParameters

Required

Body of Registered Server object.

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 AsyncPollingMethod

Pass in True if you'd like the AsyncARMPolling 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 AsyncLROPoller that returns either RegisteredServer or the result of cls(response)

Return type

AsyncLROPoller[RegisteredServer]

Exceptions

HttpResponseError

begin_delete

Delete the given registered server.

async begin_delete(resource_group_name: str, storage_sync_service_name: str, server_id: str, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[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.

server_id

str

Required

GUID identifying the on-premises server.

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 AsyncPollingMethod

Pass in True if you'd like the AsyncARMPolling 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 AsyncLROPoller that returns either None or the result of cls(response)

Return type

AsyncLROPoller[None]

Exceptions

HttpResponseError

begin_trigger_rollover

Triggers Server certificate rollover.

async begin_trigger_rollover(resource_group_name: str, storage_sync_service_name: str, server_id: str, parameters: azure.mgmt.storagesync.models._models_py3.TriggerRolloverRequest, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[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.

server_id

str

Required

Server Id.

parameters

TriggerRolloverRequest

Required

Body of Trigger Rollover request.

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 AsyncPollingMethod

Pass in True if you'd like the AsyncARMPolling 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 AsyncLROPoller that returns either None or the result of cls(response)

Return type

AsyncLROPoller[None]

Exceptions

HttpResponseError

get

Get a given registered server.

async get(resource_group_name: str, storage_sync_service_name: str, server_id: str, **kwargs) -> azure.mgmt.storagesync.models._models_py3.RegisteredServer

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.

server_id

str

Required

GUID identifying the on-premises server.

cls

callable

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

Returns

RegisteredServer, or the result of cls(response)

Return type

RegisteredServer

Exceptions

HttpResponseError

list_by_storage_sync_service

Get a given registered server list.

list_by_storage_sync_service(resource_group_name: str, storage_sync_service_name: str, **kwargs) -> AsyncIterable[azure.mgmt.storagesync.models._models_py3.RegisteredServerArray]

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 RegisteredServerArray or the result of cls(response)

Return type

AsyncItemPaged[RegisteredServerArray]

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