ServersOperations Class

ServersOperations 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

ServersOperations

Constructor

ServersOperations(client, config, serializer, deserializer)

Parameters

Name	Description
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

Name	Description
models	Alias to model classes used in this operation group.

Methods

begin_create_or_update	Creates or updates a server.
begin_delete	Deletes a server.
begin_import_database	Imports a bacpac into a new database.
begin_update	Updates a server.
check_name_availability	Determines whether a resource can be created with the specified name.
get	Gets a server.
list	Gets a list of all servers in the subscription.
list_by_resource_group	Gets a list of servers in a resource groups.

begin_create_or_update

Creates or updates a server.

async begin_create_or_update(resource_group_name: str, server_name: str, parameters: Server, **kwargs: Any) -> AsyncLROPoller[Server]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name Required	str The name of the server.
parameters Required	Server The requested server resource state.

Keyword-Only Parameters

Name	Description
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 By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in 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

Type	Description
AsyncLROPoller[Server]	An instance of AsyncLROPoller that returns either Server or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes a server.

async begin_delete(resource_group_name: str, server_name: str, **kwargs: Any) -> AsyncLROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name Required	str The name of the server.

Keyword-Only Parameters

Name	Description
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 By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in 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

Type	Description
AsyncLROPoller[None]	An instance of AsyncLROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_import_database

Imports a bacpac into a new database.

async begin_import_database(resource_group_name: str, server_name: str, parameters: ImportNewDatabaseDefinition, **kwargs: Any) -> AsyncLROPoller[ImportExportOperationResult]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name Required	str The name of the server.
parameters Required	ImportNewDatabaseDefinition The database import request parameters.

Keyword-Only Parameters

Name	Description
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 By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in 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

Type	Description
AsyncLROPoller[ImportExportOperationResult]	An instance of AsyncLROPoller that returns either ImportExportOperationResult or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_update

Updates a server.

async begin_update(resource_group_name: str, server_name: str, parameters: ServerUpdate, **kwargs: Any) -> AsyncLROPoller[Server]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name Required	str The name of the server.
parameters Required	ServerUpdate The requested server resource state.

Keyword-Only Parameters

Name	Description
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 By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in 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

Type	Description
AsyncLROPoller[Server]	An instance of AsyncLROPoller that returns either Server or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

check_name_availability

Determines whether a resource can be created with the specified name.

async check_name_availability(parameters: CheckNameAvailabilityRequest, **kwargs: Any) -> CheckNameAvailabilityResponse

Parameters

Name	Description
parameters Required	CheckNameAvailabilityRequest The name availability request parameters.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
CheckNameAvailabilityResponse	CheckNameAvailabilityResponse, or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Gets a server.

async get(resource_group_name: str, server_name: str, expand: str | None = None, **kwargs: Any) -> Server

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name Required	str The name of the server.
expand	str The child resources to include in the response. Default value: None

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
Server	Server, or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list

Gets a list of all servers in the subscription.

list(expand: str | None = None, **kwargs: Any) -> AsyncIterable[ServerListResult]

Parameters

Name	Description
expand	str The child resources to include in the response. Default value: None

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
AsyncItemPaged[ServerListResult]	An iterator like instance of either ServerListResult or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_resource_group

Gets a list of servers in a resource groups.

list_by_resource_group(resource_group_name: str, expand: str | None = None, **kwargs: Any) -> AsyncIterable[ServerListResult]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
expand	str The child resources to include in the response. Default value: None

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
AsyncItemPaged[ServerListResult]	An iterator like instance of either ServerListResult or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.sql.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\sql\\models\\__init__.py'>