Skip to main content

Remove-VSTeamAccessControlList

SYNOPSIS​

Remove access control lists under the specified security namespace.

SYNTAX​

ByNamespace (Default)​

Remove-VSTeamAccessControlList -SecurityNamespace <SecurityNamespace> -Tokens <String[]> [-Recurse] [-Force]
 [-WhatIf] [-Confirm] [<CommonParameters>]

ByNamespaceId​

Remove-VSTeamAccessControlList -SecurityNamespaceId <Guid> -Tokens <String[]> [-Recurse] [-Force] [-WhatIf]
 [-Confirm] [<CommonParameters>]

DESCRIPTION​

Remove access control lists under the specified security namespace.

EXAMPLES​

Example 1​

$namespace = Get-VSTeamSecurityNamespace -NamespaceId "abcdef12-1234-5678-9abc-def123456789"
Remove-VSTeamAccessControlList -SecurityNamespace $namespace -Tokens "token1,token2"

Removes access control lists for the specified tokens "token1" and "token2" from the security namespace retrieved using the provided `NamespaceId`.

Example 2​

Remove-VSTeamAccessControlList -SecurityNamespaceId "abcdef12-1234-5678-9abc-def123456789" -Tokens "token1" -Recurse

Recursively removes the access control list for the specified token "token1" from the security namespace with the given `SecurityNamespaceId`.

Example 3​

Remove-VSTeamAccessControlList -SecurityNamespaceId "abcdef12-1234-5678-9abc-def123456789" -Tokens "token1" -Force

Removes the access control list for the specified token "token1" from the security namespace with the given `SecurityNamespaceId` and forces the removal without any confirmation prompts.

Example 4​

Remove-VSTeamAccessControlList -SecurityNamespaceId "abcdef12-1234-5678-9abc-def123456789" -Tokens "token1" -Recurse -WhatIf

Shows what would happen if the command runs to recursively remove the access control list for the specified token "token1" from the security namespace with the given `SecurityNamespaceId`, without actually executing the command.

PARAMETERS​

-SecurityNamespace​

Security namespace object.

Type: SecurityNamespace
Parameter Sets: ByNamespace
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-SecurityNamespaceId​

Security namespace identifier.

Type: Guid
Parameter Sets: ByNamespaceId
Aliases:

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

-Tokens​

One or more comma-separated security tokens

Type: String[]
Parameter Sets: (All)
Aliases:

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

-Recurse​

If true and this is a hierarchical namespace, also remove child ACLs of the specified tokens.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Force​

Forces the function without confirmation.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-WhatIf​

Shows what would happen if the function runs. The function is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

-Confirm​

Prompts you for confirmation before running the function.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

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

CommonParameters​

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS​

OUTPUTS​

System.Object​

NOTES​

Prerequisites:

Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.

tips:

  • check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo
  • use Set-VSTeamDefaultProject to set default project for every call
  • use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.
  • use Profiles to load an account and the correct version