Get-AzSqlServerDnsAlias
Gets or lists Azure SQL Server DNS Alias.
Syntax
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.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure.
Type: | IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Name
The Azure Sql Server DNS Alias name.
Type: | String |
Aliases: | DnsAliasName |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | True |
-ResourceGroupName
The name of the resource group.
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ServerName
The Azure Sql Server name.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |