Edit

Share via

Remove-AzSqlServerDnsAlias

Module:
Az.Sql Module

Removes Azure SQL Server DNS Alias.

Syntax

Remove a Server Dns Alias from cmdlet input parameters 

Remove-AzSqlServerDnsAlias
    [-ResourceGroupName] <String>
    -Name <String>
    -ServerName <String>
    [-Force]
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Remove a Server Dns Alias from AzureSqlServerDnsAliasModel instance definition 

Remove-AzSqlServerDnsAlias
    -InputObject <AzureSqlServerDnsAliasModel>
    [-Force]
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Remove a Server Dns Alias from an Azure resource id 

Remove-AzSqlServerDnsAlias
    -ResourceId <String>
    [-Force]
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

This commands remove Azure SQL Server DNS Alias from the server leaving server intact.

Examples

Example 1

Remove-AzSqlServerDnsAlias -DnsAliasName aliasName -ServerName serverName -ResourceGroupName rg

Removes Azure SQL Server DNS Alias with the name aliasName from the server with the name serverName

Parameters

-AsJob

Run cmdlet in the background

Parameter properties

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

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-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

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-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

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Force

Skip confirmation message for performing the action

Parameter properties

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

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

The Server Dns Alias object to remove

Parameter properties

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

Parameter sets

Remove a Server Dns Alias from AzureSqlServerDnsAliasModel instance definition
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

Azure Sql Server Dns Alias name

Parameter properties

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

Parameter sets

Remove a Server Dns Alias from cmdlet input parameters
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResourceGroupName

The name of the resource group.

Parameter properties

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

Parameter sets

Remove a Server Dns Alias from cmdlet input parameters
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResourceId

The resource id of Server Dns Alias object to remove

Parameter properties

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

Parameter sets

Remove a Server Dns Alias from an Azure resource id
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-ServerName

The Azure Sql Server name.

Parameter properties

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

Parameter sets

Remove a Server Dns Alias from cmdlet input parameters
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-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

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

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

AzureSqlServerDnsAliasModel

String

Outputs

AzureSqlServerDnsAliasModel