ServerDnsAliasesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

SqlManagementClient's

<xref:server_dns_aliases> attribute.

Constructor

ServerDnsAliasesOperations(*args, **kwargs)

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, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.ServerDnsAlias]

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. Required.
server_name Required	str The name of the server that the alias is pointing to. Required.
dns_alias_name Required	str The name of the server dns alias. Required.
parameters Required	ServerDnsAliasAcquisition or IO[bytes] Is either a ServerDnsAliasAcquisition type or a IO[bytes] type. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

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[ServerDnsAlias]

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. Required.
server_name Required	str The name of the server that the alias is pointing to. Required.
dns_alias_name Required	str The name of the server dns alias. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

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

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. Required.
server_name Required	str The name of the server that the alias is pointing to. Required.
dns_alias_name Required	str The name of the server dns alias. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

get

Gets a server DNS alias.

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

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. Required.
server_name Required	str The name of the server that the alias is pointing to. Required.
dns_alias_name Required	str The name of the server dns alias. Required.

Returns

Type	Description
ServerDnsAlias	ServerDnsAlias or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

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) -> ItemPaged[ServerDnsAlias]

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. Required.
server_name Required	str The name of the server that the alias is pointing to. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.sql.models' from 'C:\\ToolCache\\Python\\3.12.10\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv268\\Lib\\site-packages\\azure\\mgmt\\sql\\models\\__init__.py'>