Assert-AzSqlVMEntraAuth

Reference

Module:: Az.SqlVirtualMachine

Validates a SQL virtual machine Entra Authentication.

Syntax

Assert-AzSqlVMEntraAuth
      -Name <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      -IdentityType <String>
      [-ManagedIdentityClientId <String>]
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Assert-AzSqlVMEntraAuth
      -InputObject <ISqlVirtualMachineIdentity>
      -IdentityType <String>
      [-ManagedIdentityClientId <String>]
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Validates a SQL virtual machine Entra Authentication.

Examples

Example 1:

Assert-AzSqlVMEntraAuth -ResourceGroupName 'ResourceGroup01' -Name 'sqlvm1' -IdentityType 'SystemAssigned'

Sql virtual machine veppala-sqlvm1 is valid for Azure AD authentication.

Validates system assigned managed identity for enabling Entra authentication on Sql VM

Example 2:

Assert-AzSqlVMEntraAuth -ResourceGroupName 'ResourceGroup01' -Name 'sqlvm1' -IdentityType 'UserAssigned' -ManagedIdentityClientId '11111111-2222-3333-4444-555555555555'

Sql virtual machine veppala-sqlvm1 is valid for Azure AD authentication.

validates user assigned managed identity for enabling Entra authentication on Sql VM

Example 3:

$sqlVM = Get-AzSqlVM -ResourceGroupName 'ResourceGroup01' -Name 'sqlvm1'
$sqlVM | Assert-AzSqlVMEntraAuth -ResourceGroupName 'ResourceGroup01' -Name 'sqlvm1' -IdentityType 'SystemAssigned'

Sql virtual machine veppala-sqlvm1 is valid for Azure AD authentication.

Validates system assigned managed identity for enabling Entra authentication on Sql VM

Example 4:

$sqlVM = Get-AzSqlVM -ResourceGroupName 'ResourceGroup01' -Name 'sqlvm1'
$sqlVM | Assert-AzSqlVMEntraAuth -ResourceGroupName 'ResourceGroup01' -Name 'sqlvm1' -IdentityType 'UserAssigned' -ManagedIdentityClientId '11111111-2222-3333-4444-555555555555'

Sql virtual machine veppala-sqlvm1 is valid for Azure AD authentication.

validates user assigned managed identity for enabling Entra authentication on Sql VM

Parameters

-AsJob

Run the command as a job

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-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:	PSObject
Aliases:	AzureRMContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-IdentityType

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Type:	ISqlVirtualMachineIdentity
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-ManagedIdentityClientId

The client Id of the Managed Identity to query Microsoft Graph API.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

Name of the SQL virtual machine.

Type:	String
Aliases:	SqlVirtualMachineName, SqlVMName
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-NoWait

Run the command asynchronously

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceGroupName

Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-SubscriptionId

Subscription ID that identifies an Azure subscription.

Type:	String
Position:	Named
Default value:	(Get-AzContext).Subscription.Id
Required:	False
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

Inputs

ISqlVirtualMachineIdentity

Outputs

Boolean

Share via