ServerEndpointsOperations Class

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

Constructor

ServerEndpointsOperations(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 ServerEndpoint.

begin_delete

Delete a given ServerEndpoint.

begin_recall_action

Recall a server endpoint.

begin_update

Patch a given ServerEndpoint.

get

Get a ServerEndpoint.

list_by_sync_group

Get a ServerEndpoint list.

begin_create

Create a new ServerEndpoint.

async begin_create(resource_group_name: str, storage_sync_service_name: str, sync_group_name: str, server_endpoint_name: str, parameters: azure.mgmt.storagesync.models._models_py3.ServerEndpointCreateParameters, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.storagesync.models._models_py3.ServerEndpoint]

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.

server_endpoint_name
str
Required

Name of Server Endpoint object.

parameters
ServerEndpointCreateParameters
Required

Body of Server Endpoint 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 ServerEndpoint or the result of cls(response)

Return type

Exceptions

begin_delete

Delete a given ServerEndpoint.

async begin_delete(resource_group_name: str, storage_sync_service_name: str, sync_group_name: str, server_endpoint_name: 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.

sync_group_name
str
Required

Name of Sync Group resource.

server_endpoint_name
str
Required

Name of Server Endpoint 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 None or the result of cls(response)

Return type

Exceptions

begin_recall_action

Recall a server endpoint.

async begin_recall_action(resource_group_name: str, storage_sync_service_name: str, sync_group_name: str, server_endpoint_name: str, parameters: azure.mgmt.storagesync.models._models_py3.RecallActionParameters, **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.

sync_group_name
str
Required

Name of Sync Group resource.

server_endpoint_name
str
Required

Name of Server Endpoint object.

parameters
RecallActionParameters
Required

Body of Recall Action 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 None or the result of cls(response)

Return type

Exceptions

begin_update

Patch a given ServerEndpoint.

async begin_update(resource_group_name: str, storage_sync_service_name: str, sync_group_name: str, server_endpoint_name: str, parameters: Optional[azure.mgmt.storagesync.models._models_py3.ServerEndpointUpdateParameters] = None, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.storagesync.models._models_py3.ServerEndpoint]

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.

server_endpoint_name
str
Required

Name of Server Endpoint object.

parameters
ServerEndpointUpdateParameters
default value: None

Any of the properties applicable in PUT 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 ServerEndpoint or the result of cls(response)

Return type

Exceptions

get

Get a ServerEndpoint.

async get(resource_group_name: str, storage_sync_service_name: str, sync_group_name: str, server_endpoint_name: str, **kwargs) -> azure.mgmt.storagesync.models._models_py3.ServerEndpoint

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.

server_endpoint_name
str
Required

Name of Server Endpoint object.

cls
callable

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

Returns

ServerEndpoint, or the result of cls(response)

Return type

Exceptions

list_by_sync_group

Get a ServerEndpoint list.

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

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

An iterator like instance of either ServerEndpointArray 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'>