Package version:

Interface ServerDnsAliases

Interface representing a ServerDnsAliases.

Hierarchy

ServerDnsAliases

Index

Methods

beginAcquire beginAcquireAndWait beginCreateOrUpdate beginCreateOrUpdateAndWait beginDelete beginDeleteAndWait get listByServer

Methods

beginAcquire

beginAcquire(resourceGroupName: string, serverName: string, dnsAliasName: string, parameters: ServerDnsAliasAcquisition, options?: ServerDnsAliasesAcquireOptionalParams): Promise<SimplePollerLike<OperationState<ServerDnsAlias>, ServerDnsAlias>>
Acquires server DNS alias from another server.
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serverName: string
  
  The name of the server that the alias is pointing to.
- dnsAliasName: string
  
  The name of the server dns alias.
- parameters: ServerDnsAliasAcquisition
  
  A server dns alias acquisition request.
- Optional options: ServerDnsAliasesAcquireOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<ServerDnsAlias>, ServerDnsAlias>>
- Defined in operationsInterfaces/serverDnsAliases.ts:123

beginAcquireAndWait

beginAcquireAndWait(resourceGroupName: string, serverName: string, dnsAliasName: string, parameters: ServerDnsAliasAcquisition, options?: ServerDnsAliasesAcquireOptionalParams): Promise<ServerDnsAlias>
Acquires server DNS alias from another server.
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serverName: string
  
  The name of the server that the alias is pointing to.
- dnsAliasName: string
  
  The name of the server dns alias.
- parameters: ServerDnsAliasAcquisition
  
  A server dns alias acquisition request.
- Optional options: ServerDnsAliasesAcquireOptionalParams
  
  The options parameters.
Returns Promise<ServerDnsAlias>
- Defined in operationsInterfaces/serverDnsAliases.ts:144

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, serverName: string, dnsAliasName: string, options?: ServerDnsAliasesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ServerDnsAlias>, ServerDnsAlias>>
Creates a server DNS alias.
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serverName: string
  
  The name of the server that the alias is pointing to.
- dnsAliasName: string
  
  The name of the server dns alias.
- Optional options: ServerDnsAliasesCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<ServerDnsAlias>, ServerDnsAlias>>
- Defined in operationsInterfaces/serverDnsAliases.ts:61

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, serverName: string, dnsAliasName: string, options?: ServerDnsAliasesCreateOrUpdateOptionalParams): Promise<ServerDnsAlias>
Creates a server DNS alias.
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serverName: string
  
  The name of the server that the alias is pointing to.
- dnsAliasName: string
  
  The name of the server dns alias.
- Optional options: ServerDnsAliasesCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<ServerDnsAlias>
- Defined in operationsInterfaces/serverDnsAliases.ts:80

beginDelete

beginDelete(resourceGroupName: string, serverName: string, dnsAliasName: string, options?: ServerDnsAliasesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
Deletes the server DNS alias with the given name.
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serverName: string
  
  The name of the server that the alias is pointing to.
- dnsAliasName: string
  
  The name of the server dns alias.
- Optional options: ServerDnsAliasesDeleteOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/serverDnsAliases.ts:94

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, serverName: string, dnsAliasName: string, options?: ServerDnsAliasesDeleteOptionalParams): Promise<void>
Deletes the server DNS alias with the given name.
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serverName: string
  
  The name of the server that the alias is pointing to.
- dnsAliasName: string
  
  The name of the server dns alias.
- Optional options: ServerDnsAliasesDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/serverDnsAliases.ts:108

get

get(resourceGroupName: string, serverName: string, dnsAliasName: string, options?: ServerDnsAliasesGetOptionalParams): Promise<ServerDnsAlias>
Gets a server DNS alias.
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serverName: string
  
  The name of the server that the alias is pointing to.
- dnsAliasName: string
  
  The name of the server dns alias.
- Optional options: ServerDnsAliasesGetOptionalParams
  
  The options parameters.
Returns Promise<ServerDnsAlias>
- Defined in operationsInterfaces/serverDnsAliases.ts:47

listByServer

listByServer(resourceGroupName: string, serverName: string, options?: ServerDnsAliasesListByServerOptionalParams): PagedAsyncIterableIterator<ServerDnsAlias>
Gets a list of server DNS aliases for a server.
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serverName: string
  
  The name of the server that the alias is pointing to.
- Optional options: ServerDnsAliasesListByServerOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<ServerDnsAlias>
- Defined in operationsInterfaces/serverDnsAliases.ts:34

Interface ServerDnsAliases

Hierarchy

Index

Methods

Methods

beginAcquire

Parameters

resourceGroupName: string

serverName: string

dnsAliasName: string

parameters: ServerDnsAliasAcquisition

Optional options: ServerDnsAliasesAcquireOptionalParams

Returns Promise<SimplePollerLike<OperationState<ServerDnsAlias>, ServerDnsAlias>>

beginAcquireAndWait

Parameters

resourceGroupName: string

serverName: string

dnsAliasName: string

parameters: ServerDnsAliasAcquisition

Optional options: ServerDnsAliasesAcquireOptionalParams

Returns Promise<ServerDnsAlias>

beginCreateOrUpdate

Parameters

resourceGroupName: string

serverName: string

dnsAliasName: string

Optional options: ServerDnsAliasesCreateOrUpdateOptionalParams

Returns Promise<SimplePollerLike<OperationState<ServerDnsAlias>, ServerDnsAlias>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

serverName: string

dnsAliasName: string

Optional options: ServerDnsAliasesCreateOrUpdateOptionalParams

Returns Promise<ServerDnsAlias>

beginDelete

Parameters

resourceGroupName: string

serverName: string

dnsAliasName: string

Optional options: ServerDnsAliasesDeleteOptionalParams

Returns Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Parameters

resourceGroupName: string

serverName: string

dnsAliasName: string

Optional options: ServerDnsAliasesDeleteOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

serverName: string

dnsAliasName: string

Optional options: ServerDnsAliasesGetOptionalParams

Returns Promise<ServerDnsAlias>

listByServer

Parameters

resourceGroupName: string

serverName: string

Optional options: ServerDnsAliasesListByServerOptionalParams

Returns PagedAsyncIterableIterator<ServerDnsAlias>

Settings

Member Visibility

Theme

`Optional` options: ServerDnsAliasesAcquireOptionalParams

`Optional` options: ServerDnsAliasesAcquireOptionalParams

`Optional` options: ServerDnsAliasesCreateOrUpdateOptionalParams

`Optional` options: ServerDnsAliasesCreateOrUpdateOptionalParams

`Optional` options: ServerDnsAliasesDeleteOptionalParams

`Optional` options: ServerDnsAliasesDeleteOptionalParams

`Optional` options: ServerDnsAliasesGetOptionalParams

`Optional` options: ServerDnsAliasesListByServerOptionalParams