Compartilhar via

Get-SqlLogin

Módulo:
SqlServer Module

Retorna objetos de logon em uma instância do SQL Server.

Sintaxe

ByPath (Padrão) 

Get-SqlLogin
    [[-Path] <String>]
    [-LoginName <String>]
    [-Disabled]
    [-Locked]
    [-PasswordExpired]
    [-HasAccess]
    [-RegEx]
    [-Wildcard]
    [-LoginType <LoginType>]
    [-AccessToken <PSObject>]
    [-TrustServerCertificate]
    [-HostNameInCertificate <String>]
    [-Encrypt <String>]
    [<CommonParameters>]

ByObject 

Get-SqlLogin
    [[-InputObject] <Server>]
    [-LoginName <String>]
    [-Disabled]
    [-Locked]
    [-PasswordExpired]
    [-HasAccess]
    [-RegEx]
    [-Wildcard]
    [-LoginType <LoginType>]
    [-AccessToken <PSObject>]
    [-TrustServerCertificate]
    [-HostNameInCertificate <String>]
    [-Encrypt <String>]
    [<CommonParameters>]

ByName 

Get-SqlLogin
    [[-ServerInstance] <String[]>]
    [-LoginName <String>]
    [-Disabled]
    [-Locked]
    [-PasswordExpired]
    [-HasAccess]
    [-RegEx]
    [-Wildcard]
    [-LoginType <LoginType>]
    [-Credential <PSCredential>]
    [-ConnectionTimeout <Int32>]
    [-AccessToken <PSObject>]
    [-TrustServerCertificate]
    [-HostNameInCertificate <String>]
    [-Encrypt <String>]
    [<CommonParameters>]

Description

O cmdlet Get-SqlLogin retorna objetos de logon em uma instância do SQL Server. Se você especificar o nome do objeto Login, o cmdlet removerá esse objeto específico.

Exemplos

Exemplo 1: Obter todos os objetos de logon para uma instância

PS C:\> Get-SqlLogin -ServerInstance "MyServerInstance"

Name                                          Login Type    Created
----                                          ----------    -------
##MS_PolicyEventProcessingLogin##             SqlLogin      4/30/2016 12:46 AM
##MS_PolicyTsqlExecutionLogin##               SqlLogin      4/30/2016 12:46 AM
NT AUTHORITY\SYSTEM                           WindowsUser   6/16/2016 10:29 AM
NT Service\MSSQLSERVER                        WindowsUser   6/16/2016 10:29 AM
NT SERVICE\SQLSERVERAGENT                     WindowsUser   6/16/2016 10:29 AM
NT SERVICE\SQLTELEMETRY                       WindowsUser   6/16/2016 10:29 AM
NT SERVICE\SQLWriter                          WindowsUser   6/16/2016 10:29 AM
NT SERVICE\Winmgmt                            WindowsUser   6/16/2016 10:29 AM
sa                                            SqlLogin      4/8/2003 9:10 AM

Esse comando retorna todos os objetos login na instância do SQL Server chamada MyServerInstance.

Exemplo 2: Obter objetos de logon que correspondam a uma expressão regular

PS C:\> Get-SqlLogin -ServerInstance "MyServerInstance" -LoginName "\bNT.*" -RegEx

Name                                          Login Type    Created
----                                          ----------    -------
NT AUTHORITY\SYSTEM                           WindowsUser   6/16/2016 10:29 AM
NT Service\MSSQLSERVER                        WindowsUser   6/16/2016 10:29 AM
NT SERVICE\SQLSERVERAGENT                     WindowsUser   6/16/2016 10:29 AM
NT SERVICE\SQLTELEMETRY                       WindowsUser   6/16/2016 10:29 AM
NT SERVICE\SQLWriter                          WindowsUser   6/16/2016 10:29 AM
NT SERVICE\Winmgmt                            WindowsUser   6/16/2016 10:29 AM

Esse comando retorna objetos de logon que têm nomes que correspondem à expressão regular "\bNT.*" na instância do SQL Server chamada 'MyServerInstance'.

Exemplo 3: Obter objetos de logon de um tipo

PS C:\> Get-SqlLogin -ServerInstance "MyServerInstance" -LoginType SqlLogin

Name                                          Login Type    Created
----                                          ----------    -------
##MS_PolicyEventProcessingLogin##             SqlLogin      4/30/2016 12:46 AM
##MS_PolicyTsqlExecutionLogin##               SqlLogin      4/30/2016 12:46 AM
sa                                            SqlLogin      4/8/2003 9:10 AM

Este comando retorna objetos de logon do tipo SqlLogin na instância do SQL Server chamada 'MyServerInstance'.

Parâmetros

-AccessToken

O token de acesso usado para autenticar no SQL Server, como uma alternativa ao usuário/senha ou à Autenticação do Windows.

Isso pode ser usado, por exemplo, para se conectar SQL Azure DB e SQL Azure Managed Instance usar um Service Principal ou um Managed Identity.

O parâmetro a ser usado pode ser uma cadeia de caracteres que representa o token ou um PSAccessToken objeto conforme retornado executando Get-AzAccessToken -ResourceUrl https://database.windows.net.

Esse parâmetro é novo na v22 do módulo.

Propriedades do parâmetro

Tipo:PSObject
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-ConnectionTimeout

Especifica o número de segundos para aguardar uma conexão de servidor antes de uma falha de tempo limite. O valor de tempo limite deve ser um inteiro entre 0 e 65534. Se 0 for especificado, as tentativas de conexão não chegarão ao tempo limite.

Propriedades do parâmetro

Tipo:Int32
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

ByName
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Credential

Especifica um objeto PSCredential para a conexão com o SQL Server. Para obter um objeto de credencial, use o cmdlet Get-Credential. Para obter mais informações, digite Get-Help Get-Credential.

Propriedades do parâmetro

Tipo:PSCredential
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

ByName
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Disabled

Indica que esse cmdlet só obtém objetos de logon desabilitados.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Encrypt

O tipo de criptografia a ser usado ao se conectar ao SQL Server.

Esse valor é mapeado para a Encrypt propriedade SqlConnectionEncryptOption no objeto SqlConnection do driver Microsoft.Data.SqlClient.

Na v22 do módulo, o padrão é Optional (para compatibilidade com v21). Na v23+ do módulo, o valor padrão será 'Obrigatório', o que pode criar uma alteração significativa para scripts existentes.

Esse parâmetro é novo na v22 do módulo.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Valores aceitos:Mandatory, Optional, Strict
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-HasAccess

Indica que esse cmdlet obtém apenas objetos de logon que têm acesso à instância do SQL Server.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-HostNameInCertificate

O nome do host a ser usado na validação do certificado TLS/SSL do SQL Server. Você deve passar esse parâmetro se a instância do SQL Server estiver habilitada para o Force Encryption e quiser se conectar a uma instância usando nome de host/nome curto. Se esse parâmetro for omitido, passar o FQDN (Nome de Domínio Totalmente Qualificado) para -ServerInstance será necessário para se conectar a uma instância do SQL Server habilitada para o Force Encryption.

Esse parâmetro é novo na v22 do módulo.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-InputObject

Especifica um objeto SMO (SQL Server Management Objects) para o SQL Server para o qual esse cmdlet obtém objetos de logon.

Propriedades do parâmetro

Tipo:Server
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

ByObject
Cargo:1
Obrigatório:False
Valor do pipeline:True
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Locked

Indica que esse cmdlet só obtém objetos de logon bloqueados.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-LoginName

Especifica uma matriz de nomes de objetos de logon que este cmdlet obtém. A confidencialidade de maiúsculas e minúsculas é a mesma da instância do SQL Server.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:Nome

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-LoginType

Especifica o tipo de objetos de logon que esse cmdlet obtém.

Propriedades do parâmetro

Tipo:LoginType
Valor padrão:None
Valores aceitos:WindowsUser, WindowsGroup, SqlLogin, Certificate, AsymmetricKey, ExternalUser, ExternalGroup
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-PasswordExpired

Indica que esse cmdlet obtém apenas objetos de logon que têm senhas expiradas.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Path

Especifica o caminho do SQL Server no qual esse cmdlet executa a operação. O valor padrão é o diretório de trabalho atual.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

ByPath
Cargo:1
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-RegEx

Indica que esse cmdlet trata o valor do parâmetro LoginName como uma expressão regular.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-ServerInstance

Especifica o nome de uma instância do SQL Server. Para a instância padrão, especifique o nome do computador. Para instâncias nomeadas, use o formato ComputerName\InstanceName.

Propriedades do parâmetro

Tipo:

String[]

Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

ByName
Cargo:1
Obrigatório:False
Valor do pipeline:True
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-TrustServerCertificate

Indica se o canal será criptografado ao ignorar a cadeia de certificados para validar a confiança.

Na v22 do módulo, o padrão é $true (para compatibilidade com v21). Na v23+ do módulo, o valor padrão será "$false", o que pode criar uma alteração significativa para scripts existentes.

Esse parâmetro é novo na v22 do módulo.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Wildcard

Indica que esse cmdlet interpreta caracteres curinga no valor do parâmetro LoginName.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:Gostar

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

CommonParameters

Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.

Entradas

Microsoft.SqlServer.Management.Smo.Server

System.String