ServerDnsAliasesOperations Class

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

Constructor

ServerDnsAliasesOperations(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_acquire

Acquires server DNS alias from another server.

begin_create_or_update

Creates a server DNS alias.

begin_delete

Deletes the server DNS alias with the given name.

get

Gets a server DNS alias.

list_by_server

Gets a list of server DNS aliases for a server.

begin_acquire

Acquires server DNS alias from another server.

begin_acquire(resource_group_name: str, server_name: str, dns_alias_name: str, parameters: _models.ServerDnsAliasAcquisition, **kwargs: Any) -> LROPoller[_models.ServerDnsAlias]

Parameters

resource_group_name
str
Required

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
str
Required

The name of the server that the alias is pointing to.

dns_alias_name
str
Required

The name of the server dns alias.

parameters
ServerDnsAliasAcquisition
Required
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

By default, your polling method will be ARMPolling. 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

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

Return type

Exceptions

begin_create_or_update

Creates a server DNS alias.

begin_create_or_update(resource_group_name: str, server_name: str, dns_alias_name: str, **kwargs: Any) -> LROPoller[_models.ServerDnsAlias]

Parameters

resource_group_name
str
Required

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
str
Required

The name of the server that the alias is pointing to.

dns_alias_name
str
Required

The name of the server dns alias.

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

By default, your polling method will be ARMPolling. 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

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

Return type

Exceptions

begin_delete

Deletes the server DNS alias with the given name.

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

Parameters

resource_group_name
str
Required

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
str
Required

The name of the server that the alias is pointing to.

dns_alias_name
str
Required

The name of the server dns alias.

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

By default, your polling method will be ARMPolling. 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

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

Return type

Exceptions

get

Gets a server DNS alias.

get(resource_group_name: str, server_name: str, dns_alias_name: str, **kwargs: Any) -> _models.ServerDnsAlias

Parameters

resource_group_name
str
Required

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
str
Required

The name of the server that the alias is pointing to.

dns_alias_name
str
Required

The name of the server dns alias.

cls
callable

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

Returns

ServerDnsAlias, or the result of cls(response)

Return type

Exceptions

list_by_server

Gets a list of server DNS aliases for a server.

list_by_server(resource_group_name: str, server_name: str, **kwargs: Any) -> Iterable[_models.ServerDnsAliasListResult]

Parameters

resource_group_name
str
Required

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
str
Required

The name of the server that the alias is pointing to.

cls
callable

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

Returns

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

Return type

Exceptions

Attributes

models

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