Note

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

Access to this page requires authorization. You can try .

Enable-AzSqlInstanceActiveDirectoryOnlyAuthentication

Module:
Az.Sql Module

Enables Microsoft Entra-only authentication for a specific SQL Managed Instance.

Syntax

UseResourceGroupAndInstanceNameParameterSet (Default) 

Enable-AzSqlInstanceActiveDirectoryOnlyAuthentication
 [-ResourceGroupName] <String>
 [-InstanceName] <String>
 [-DefaultProfile <IAzureContextContainer>]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

UseInputObjectParameterSet 

Enable-AzSqlInstanceActiveDirectoryOnlyAuthentication
 -InputObject <AzureSqlManagedInstanceModel>
 [-DefaultProfile <IAzureContextContainer>]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

UserResourceIdParameterSet 

Enable-AzSqlInstanceActiveDirectoryOnlyAuthentication
 [-ResourceId] <String>
 [-DefaultProfile <IAzureContextContainer>]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

Description

The Enable-AzSqlInstanceActiveDirectoryOnlyAuthentication cmdlet enables Microsoft Entra-only authentication requirement for an AzureSQL Managed Instance in the current subscription.

Examples

Example 1

Enable-AzSqlInstanceActiveDirectoryOnlyAuthentication -ResourceGroupName "ResourceGroup01" -InstanceName "ManagedInstance01"

ResourceGroupName InstanceName AzureADOnlyAuthentication
----------------- ---------- ----------- -------- -----------
ResourceGroup01 ManagedInstance01 True

This command enables Microsoft Entra-only authentication requirement for an AzureSQL Managed Instance named ManagedInstance01 that is associated with a resource group named ResourceGroup01.

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

-InputObject

The managed instance object to use.

Parameter properties

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

Parameter sets

-InstanceName

The name of the Azure SQL Managed Instance the Microsoft Entra-only authentication is in.

Parameter properties

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

Parameter sets

-ResourceGroupName

The name of the resource group.

Parameter properties

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

Parameter sets

-ResourceId

The resource id of instance to use

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

AzureSqlInstanceActiveDirectoryOnlyAuthenticationModel

Related Links

Feedback

Was this page helpful?