Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

Get-AzSqlServerDnsAlias

Module:
Az.Sql Module

Gets or lists Azure SQL Server DNS Alias.

Syntax

Default (Default) 

Get-AzSqlServerDnsAlias
 [-Name <String>]
 -ServerName <String>
 [-ResourceGroupName] <String>
 [-DefaultProfile <IAzureContextContainer>]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

Description

Get the specific Azure SQL Server DNS Alias or lists all Server DNS Aliases for the server

Examples

Example 1

$serverDNSAliases = Get-AzSqlServerDnsAlias -ServerName servername -ResourceGroupName rgname

ResourceGroupName ServerName DnsAliasName
----------------- ---------- ------------------
rgname servername dnsaliasname
rgname servername dnsaliasname2

Lists all Server DNS Aliases for the specific server

Example 2

$serverDNSAliases = Get-AzSqlServerDnsAlias -DnsAliasName dnsaliasname -ServerName servername -ResourceGroupName rgname

ResourceGroupName ServerName DnsAliasName
----------------- ---------- ------------------
rgname servername dnsaliasname

Gets Server DNS Alias specified by server and alias name

Example 3

$serverDNSAliases = Get-AzSqlServerDnsAlias -ServerName servername -ResourceGroupName rgname -DnsAliasName "dnsaliasname*"

ResourceGroupName ServerName DnsAliasName
----------------- ---------- ------------------
rgname servername dnsaliasname
rgname servername dnsaliasname2

Lists all Server DNS Aliases for the specific server that start with "dnsaliasname".

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure.

Parameter properties

Type:IAzureContextContainer
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

Parameter sets

-Name

The Azure Sql Server DNS Alias name.

Parameter properties

Type:String
Default value:None
Supports wildcards:True
DontShow:False
Aliases:DnsAliasName

Parameter sets

-ResourceGroupName

The name of the resource group.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-ServerName

The Azure Sql Server name.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

String

Outputs

AzureSqlServerDnsAliasModel

Feedback

Was this page helpful?