Revoke-DbaAgPermission


Author	Chrissy LeMaire (@cl), netnerds.net
Availability	Windows, Linux, macOS

Want to see the source code for this command? Check out Revoke-DbaAgPermission on GitHub.
Want to see the Bill Of Health for this command? Check out Revoke-DbaAgPermission.

Synopsis

Revokes endpoint and availability group permissions to a login.

Description

Revokes endpoint and availability group permissions to a login.

Syntax

Revoke-DbaAgPermission
    [[-SqlInstance] <DbaInstanceParameter[]>]
    [[-SqlCredential] <PSCredential>]
    [[-Login] <String[]>]
    [[-AvailabilityGroup] <String[]>]
    [-Type] <String[]>
    [[-Permission] <String[]>]
    [[-InputObject] <Login[]>]
    [-EnableException]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Examples

Example: 1

PS C:\> Revoke-DbaAgPermission -SqlInstance sql2017a -Type AvailabilityGroup -AvailabilityGroup SharePoint -Login ad\spservice -Permission CreateAnyDatabase

Removes CreateAnyDatabase permissions from ad\spservice on the SharePoint availability group on sql2017a. Does not prompt for confirmation.

Example: 2

PS C:\> Revoke-DbaAgPermission -SqlInstance sql2017a -Type AvailabilityGroup -AvailabilityGroup ag1, ag2 -Login ad\spservice -Permission CreateAnyDatabase -Confirm

Removes CreateAnyDatabase permissions from ad\spservice on the ag1 and ag2 availability groups on sql2017a. Prompts for confirmation.

Example: 3

PS C:\> Get-DbaLogin -SqlInstance sql2017a | Out-GridView -Passthru | Revoke-DbaAgPermission -Type EndPoint

Revokes the selected logins Connect permissions on the DatabaseMirroring endpoint for sql2017a.

Required Parameters

-Type

Specify type: Endpoint or AvailabilityGroup. Endpoint will modify the DatabaseMirror endpoint type.


Alias
Required	True
Pipeline	false
Default Value
Accepted Values	Endpoint,AvailabilityGroup

Optional Parameters

-SqlInstance

The target SQL Server instance or instances. Server version must be SQL Server version 2012 or higher.


Alias
Required	False
Pipeline	false
Default Value

-SqlCredential

Login to the target instance using alternative credentials. Accepts PowerShell credentials (Get-Credential).
Windows Authentication, SQL Server Authentication, Active Directory - Password, and Active Directory - Integrated are all supported.
For MFA support, please use Connect-DbaInstance.


Alias
Required	False
Pipeline	false
Default Value

The login or logins to modify.


Alias
Required	False
Pipeline	false
Default Value

-AvailabilityGroup

Only modify specific availability groups.


Alias
Required	False
Pipeline	false
Default Value

-Permission

Revokes one or more permissions:
Alter
Connect
Control
CreateAnyDatabase
CreateSequence
Delete
Execute
Impersonate
Insert
Receive
References
Select
Send
TakeOwnership
Update
ViewChangeTracking
ViewDefinition
Connect is default.


Alias
Required	False
Pipeline	false
Default Value	Connect
Accepted Values	Alter,Connect,Control,CreateAnyDatabase,CreateSequence,Delete,Execute,Impersonate,Insert,Receive,References,Select,Send,TakeOwnership,Update,ViewChangeTracking,ViewDefinition

-InputObject

Enables piping from Get-DbaLogin.


Alias
Required	False
Pipeline	true (ByValue)
Default Value

-EnableException

By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.
This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting.
Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.


Alias
Required	False
Pipeline	false
Default Value	False

-WhatIf

Shows what would happen if the command were to run. No actions are actually performed.


Alias	wi
Required	False
Pipeline	false
Default Value

-Confirm

Prompts you for confirmation before executing any changing operations within the command.


Alias	cf
Required	False
Pipeline	false
Default Value