Skip to content

Latest commit

 

History

History
403 lines (275 loc) · 12.9 KB

Get-ADOPermission.md

File metadata and controls

403 lines (275 loc) · 12.9 KB
Raw

Get-ADOPermission

Synopsis

Gets Azure DevOps Permissions

Description

Gets Azure DevOps security permissions.

Related Links

Examples

EXAMPLE 1

Get-ADOPermission -Organization MyOrganization -Project MyProject -PersonalAccessToken $pat

EXAMPLE 2

Get-ADOProject -Organization MyOrganization -Project MyProject | # Get the project
    Get-ADOTeam | # get the teams within the project
    Get-ADOPermission -Dashboard # get the dashboard permissions of each team within the project.

Parameters

Organization

The Organization.

Type Requried Postion PipelineInput
[String] true named true (ByPropertyName)

PermissionType

If set, will list the type of permisssions.

Type Requried Postion PipelineInput
[Switch] false named false

NamespaceID

The Security Namespace ID. For details about each namespace, see: https://docs.microsoft.com/en-us/azure/devops/organizations/security/namespace-reference

Type Requried Postion PipelineInput
[String] true named true (ByPropertyName)

SecurityToken

The Security Token.

Type Requried Postion PipelineInput
[String] false named true (ByPropertyName)

ProjectID

The Project ID. If this is provided without anything else, will get permissions for the projectID

Type Requried Postion PipelineInput
[String] true named true (ByPropertyName)

TeamID

If provided, will get permissions related to a given teamID. ( see Get-ADOTeam)

Type Requried Postion PipelineInput
[String] false named true (ByPropertyName)

AreaPath

If provided, will get permissions related to an Area Path. ( see Get-ADOAreaPath )

Type Requried Postion PipelineInput
[String] true named true (ByPropertyName)

IterationPath

If provided, will get permissions related to an Iteration Path. ( see Get-ADOIterationPath )

Type Requried Postion PipelineInput
[String] true named true (ByPropertyName)

Overview

If set, will get common permissions related to a project. These are:

  • Builds
  • Boards
  • Dashboards
  • Git Repositories
  • ServiceEndpoints
  • Project Permissions
  • Service Endpoints
  • ServiceHooks
Type Requried Postion PipelineInput
[Switch] true named true (ByPropertyName)

Tagging

If set, will get permissions for tagging related to the current project.

Type Requried Postion PipelineInput
[Switch] true named true (ByPropertyName)

Analytics

If set, will get permissions for analytics related to the current project.

Type Requried Postion PipelineInput
[Switch] true named true (ByPropertyName)

ManageTFVC

If set, will get permissions for Team Foundation Version Control related to the current project.

Type Requried Postion PipelineInput
[Switch] true named true (ByPropertyName)

Plan

If set, will get permissions for Delivery Plans.

Type Requried Postion PipelineInput
[Switch] true named true (ByPropertyName)

Dashboard

If set, will get dashboard permissions related to the current project.

Type Requried Postion PipelineInput
[Switch] true named true (ByPropertyName)

ServiceEndpoint

If set, will get all service endpoints permissions.

Type Requried Postion PipelineInput
[Switch] true named true (ByPropertyName)

EndpointID

If set, will get endpoint permissions related to a particular endpoint.

Type Requried Postion PipelineInput
[String] true named true (ByPropertyName)

DefinitionID

The Build Definition ID

Type Requried Postion PipelineInput
[String] true named true (ByPropertyName)

BuildPath

The path to the build.

Type Requried Postion PipelineInput
[String] false named true (ByPropertyName)

BuildPermission

If set, will get build and release permissions for a given project.

Type Requried Postion PipelineInput
[Switch] true named true (ByPropertyName)

RepositoryID

If provided, will get build and release permissions for a given project's repositoryID

Type Requried Postion PipelineInput
[String] true named true (ByPropertyName)

BranchName

If provided, will get permissions for a given branch within a repository

Type Requried Postion PipelineInput
[String] false named true (ByPropertyName)

ProjectRepository

If set, will get permissions for repositories within a project

Type Requried Postion PipelineInput
[Switch] true named true (ByPropertyName)

AllRepository

If set, will get permissions for repositories within a project

Type Requried Postion PipelineInput
[Switch] true named true (ByPropertyName)

Descriptor

The Descriptor

Type Requried Postion PipelineInput
[String[]] false named true (ByPropertyName)

Recurse

If set and this is a hierarchical namespace, return child ACLs of the specified token.

Type Requried Postion PipelineInput
[Switch] false named true (ByPropertyName)

IncludeExtendedInfo

If set, populate the extended information properties for the access control entries in the returned lists.

Type Requried Postion PipelineInput
[Switch] false named true (ByPropertyName)

ExpandACL

If set, will expand the ACE dictionary returned

Type Requried Postion PipelineInput
[Switch] false named false

Server

The server. By default https://dev.azure.com/. To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs).

Type Requried Postion PipelineInput
[Uri] false named true (ByPropertyName)

ApiVersion

The api version. By default, 5.1-preview. If targeting TFS, this will need to change to match your server version. See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-versioning?view=azure-devops

Type Requried Postion PipelineInput
[String] false named false

Outputs

PSDevOps.SecurityNamespace

PSDevOps.AccessControlList

Syntax

Get-ADOPermission -Organization <String> [-PermissionType] [-Descriptor <String[]>] [-Recurse] [-IncludeExtendedInfo] [-ExpandACL] [-Server <Uri>] [-ApiVersion <String>] [<CommonParameters>]
Get-ADOPermission -Organization <String> -NamespaceID <String> [-SecurityToken <String>] [-Descriptor <String[]>] [-Recurse] [-IncludeExtendedInfo] [-ExpandACL] [-Server <Uri>] [-ApiVersion <String>] [<CommonParameters>]
Get-ADOPermission -Organization <String> -ProjectID <String> -Overview [-Descriptor <String[]>] [-Recurse] [-IncludeExtendedInfo] [-ExpandACL] [-Server <Uri>] [-ApiVersion <String>] [<CommonParameters>]
Get-ADOPermission -Organization <String> -ProjectID <String> -ProjectRepository [-Descriptor <String[]>] [-Recurse] [-IncludeExtendedInfo] [-ExpandACL] [-Server <Uri>] [-ApiVersion <String>] [<CommonParameters>]
Get-ADOPermission -Organization <String> -ProjectID <String> -RepositoryID <String> [-BranchName <String>] [-Descriptor <String[]>] [-Recurse] [-IncludeExtendedInfo] [-ExpandACL] [-Server <Uri>] [-ApiVersion <String>] [<CommonParameters>]
Get-ADOPermission -Organization <String> -ProjectID <String> -IterationPath <String> [-Descriptor <String[]>] [-Recurse] [-IncludeExtendedInfo] [-ExpandACL] [-Server <Uri>] [-ApiVersion <String>] [<CommonParameters>]
Get-ADOPermission -Organization <String> -ProjectID <String> -BuildPermission [-Descriptor <String[]>] [-Recurse] [-IncludeExtendedInfo] [-ExpandACL] [-Server <Uri>] [-ApiVersion <String>] [<CommonParameters>]
Get-ADOPermission -Organization <String> -ProjectID <String> -DefinitionID <String> [-BuildPath <String>] [-Descriptor <String[]>] [-Recurse] [-IncludeExtendedInfo] [-ExpandACL] [-Server <Uri>] [-ApiVersion <String>] [<CommonParameters>]
Get-ADOPermission -Organization <String> -ProjectID <String> -ManageTFVC [-Descriptor <String[]>] [-Recurse] [-IncludeExtendedInfo] [-ExpandACL] [-Server <Uri>] [-ApiVersion <String>] [<CommonParameters>]
Get-ADOPermission -Organization <String> -ProjectID <String> -Tagging [-Descriptor <String[]>] [-Recurse] [-IncludeExtendedInfo] [-ExpandACL] [-Server <Uri>] [-ApiVersion <String>] [<CommonParameters>]
Get-ADOPermission -Organization <String> -ProjectID <String> [-TeamID <String>] -Dashboard [-Descriptor <String[]>] [-Recurse] [-IncludeExtendedInfo] [-ExpandACL] [-Server <Uri>] [-ApiVersion <String>] [<CommonParameters>]
Get-ADOPermission -Organization <String> -ProjectID <String> -AreaPath <String> [-Descriptor <String[]>] [-Recurse] [-IncludeExtendedInfo] [-ExpandACL] [-Server <Uri>] [-ApiVersion <String>] [<CommonParameters>]
Get-ADOPermission -Organization <String> [-ProjectID <String>] -EndpointID <String> [-Descriptor <String[]>] [-Recurse] [-IncludeExtendedInfo] [-ExpandACL] [-Server <Uri>] [-ApiVersion <String>] [<CommonParameters>]
Get-ADOPermission -Organization <String> [-ProjectID <String>] -Analytics [-Descriptor <String[]>] [-Recurse] [-IncludeExtendedInfo] [-ExpandACL] [-Server <Uri>] [-ApiVersion <String>] [<CommonParameters>]
Get-ADOPermission -Organization <String> -ProjectID <String> [-Descriptor <String[]>] [-Recurse] [-IncludeExtendedInfo] [-ExpandACL] [-Server <Uri>] [-ApiVersion <String>] [<CommonParameters>]
Get-ADOPermission -Organization <String> -Plan [-Descriptor <String[]>] [-Recurse] [-IncludeExtendedInfo] [-ExpandACL] [-Server <Uri>] [-ApiVersion <String>] [<CommonParameters>]
Get-ADOPermission -Organization <String> -ServiceEndpoint [-Descriptor <String[]>] [-Recurse] [-IncludeExtendedInfo] [-ExpandACL] [-Server <Uri>] [-ApiVersion <String>] [<CommonParameters>]
Get-ADOPermission -Organization <String> [-BranchName <String>] -AllRepository [-Descriptor <String[]>] [-Recurse] [-IncludeExtendedInfo] [-ExpandACL] [-Server <Uri>] [-ApiVersion <String>] [<CommonParameters>]