Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 0 additions & 9 deletions docs/Add-AdoGroupMember.md
Original file line number Diff line number Diff line change
Expand Up @@ -181,15 +181,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

### PSCustomObject

Returns a custom object with the following properties:
- displayName: The display name of the group that was added
- originId: The Origin ID of the Entra ID group
- principalName: The principal name of the group
- origin: The origin source of the group
- subjectKind: The kind of subject (e.g., group)
- descriptor: The descriptor of the group that was created/added
- collectionUri: The collection URI where the operation was performed

## NOTES

- This cmdlet has a high confirm impact and will prompt for confirmation by default
Expand Down
8 changes: 0 additions & 8 deletions docs/Add-AdoTeamIteration.md
Original file line number Diff line number Diff line change
Expand Up @@ -200,14 +200,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

### PSCustomObject

The cmdlet returns a PSCustomObject with the following properties:
- id: The unique identifier of the iteration
- name: The name of the iteration
- attributes: The iteration attributes including start date, finish date, and time frame
- team: The id or name of the team the iteration was added to
- project: The id or name of the project
- collectionUri: The collection URI

## NOTES

- Requires authentication to Azure DevOps. Use `Set-AdoDefault` to configure default organization and project values.
Expand Down
11 changes: 0 additions & 11 deletions docs/Get-AdoCheckConfiguration.md
Original file line number Diff line number Diff line change
Expand Up @@ -394,17 +394,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

### PSCustomObject

Returns a collection of check configuration objects, each containing:
- id: The ID of the check configuration
- settings: The configuration settings (included when Expands = 'settings')
- timeout: The timeout value for the check
- type: The type information for the check
- resource: The resource information
- createdBy: The ID of the user who created the configuration
- createdOn: The date and time when the configuration was created
- project: The name of the project
- collectionUri: The collection URI

## NOTES

- Requires authentication to Azure DevOps. Use `Set-AdoDefault` to configure default organization and project values.
Expand Down
12 changes: 0 additions & 12 deletions docs/Get-AdoClassificationNode.md
Original file line number Diff line number Diff line change
Expand Up @@ -320,18 +320,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

### PSCustomObject

Returns classification node objects from Azure DevOps with the following properties:
- id: The integer ID of the classification node
- identifier: The GUID identifier of the classification node
- name: The name of the classification node
- structureType: The type of structure (area or iteration)
- path: The full path of the classification node
- hasChildren: Boolean indicating if the node has child nodes
- children: (Optional) Array of child classification nodes if present
- attributes: (Optional) Additional attributes like startDate and finishDate for iterations
- projectName: The name of the project
- collectionUri: The collection URI

## NOTES

- Requires authentication to Azure DevOps. Use `Set-AdoDefault` to configure default organization and project values.
Expand Down
5 changes: 0 additions & 5 deletions docs/Get-AdoDefault.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,11 +64,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

### PSCustomObject

Returns an object with the following properties:
- Organization: The default Azure DevOps organization name
- CollectionUri: The default Azure DevOps collection URI
- ProjectName: The default Azure DevOps project name

## NOTES

This function retrieves the default values from session environment variables set by Set-AdoDefault.
Expand Down
5 changes: 0 additions & 5 deletions docs/Get-AdoDescriptor.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,11 +155,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

### PSCustomObject

Returns a PSCustomObject with the following properties:
- **storageKey**: The storage key that was resolved
- **value**: The descriptor value returned by the API
- **collectionUri**: The collection URI used for the request

## NOTES

- Requires authentication to Azure DevOps. Use `Set-AdoDefault` to configure default organization and project values.
Expand Down
11 changes: 0 additions & 11 deletions docs/Get-AdoEnvironment.md
Original file line number Diff line number Diff line change
Expand Up @@ -259,17 +259,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

### PSCustomObject

Returns environment objects with the following properties:
- id: The unique identifier of the environment
- name: The name of the environment
- createdBy: ID of the user who created the environment
- createdOn: Date and time when the environment was created
- lastModifiedBy: ID of the user who last modified the environment
- lastModifiedOn: Date and time when the environment was last modified
- projectName: The project name
- collectionUri: The collection URI
- resources: (Only when Expands is 'resourceReferences') Array of resource references

## NOTES

- Requires authentication to Azure DevOps. Use `Set-AdoDefault` to configure default organization and project values.
Expand Down
8 changes: 0 additions & 8 deletions docs/Get-AdoFeatureState.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,14 +150,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

### PSCustomObject

Returns a collection of feature state objects, each containing:
- feature: The feature name (Boards, Repos, Pipelines, TestPlans, Artifacts)
- featureId: The unique identifier for the feature
- state: The state as text ('enabled' or 'disabled')
- projectName: The name of the project
- projectId: The ID of the project
- collectionUri: The collection URI

## NOTES

- Requires authentication to Azure DevOps. Use `Set-AdoDefault` to configure default organization and project values.
Expand Down
12 changes: 0 additions & 12 deletions docs/Get-AdoGroup.md
Original file line number Diff line number Diff line change
Expand Up @@ -259,18 +259,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

### PSCustomObject

Returns one or more group objects with the following properties:
- displayName: The display name of the group
- originId: The origin ID of the group
- principalName: The principal name of the group
- origin: The origin of the group (e.g., 'aad', 'vsts')
- subjectKind: The subject kind (e.g., 'group')
- description: The description of the group
- mailAddress: The mail address of the group
- descriptor: The descriptor of the group
- collectionUri: The collection URI used for the query
- continuationToken: (Optional) Token for retrieving the next page of results

## NOTES

- Retrieves groups in an Azure DevOps organization
Expand Down
2 changes: 0 additions & 2 deletions docs/Get-AdoMembership.md
Original file line number Diff line number Diff line change
Expand Up @@ -172,8 +172,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

### PSCustomObject

An object representing the membership relationship.

## NOTES

- Requires authentication to Azure DevOps. Use `Set-AdoDefault` to configure default organization and project values.
Expand Down
13 changes: 0 additions & 13 deletions docs/Get-AdoPolicyConfiguration.md
Original file line number Diff line number Diff line change
Expand Up @@ -289,19 +289,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

### PSCustomObject

Returns policy configuration objects with the following properties:
- id: The unique identifier of the policy configuration
- type: The policy type object containing the type ID
- revision: The revision number of the configuration
- isEnabled: Whether the policy is enabled
- isBlocking: Whether the policy is blocking
- isDeleted: Whether the policy is deleted
- settings: The policy-specific settings object
- createdBy: The user who created the configuration
- createdDate: The date the configuration was created
- projectName: The project name where the configuration exists
- collectionUri: The collection URI of the Azure DevOps organization

## NOTES

- Requires authentication to Azure DevOps. Use `Set-AdoDefault` to configure default organization and project values.
Expand Down
7 changes: 0 additions & 7 deletions docs/Get-AdoPolicyType.md
Original file line number Diff line number Diff line change
Expand Up @@ -234,13 +234,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

### PSCustomObject

Returns a custom object with the following properties:
- **id**: The unique identifier (GUID) of the policy type
- **displayName**: The friendly display name of the policy type
- **description**: A detailed description of what the policy type does
- **projectName**: The name of the project the policy type belongs to
- **collectionUri**: The collection URI used for the query

## NOTES

- Requires authentication to Azure DevOps. Use `Set-AdoDefault` to configure default organization and project values.
Expand Down
9 changes: 0 additions & 9 deletions docs/Get-AdoProcess.md
Original file line number Diff line number Diff line change
Expand Up @@ -162,15 +162,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

### PSCustomObject

Returns one or more process objects with the following properties:
- id: The unique identifier of the process
- name: The name of the process (Agile, Scrum, CMMI, or Basic)
- description: A description of the process
- url: The REST API URL for the process
- type: The type of the process
- isDefault: Boolean indicating if this is the default process
- collectionUri: The collection URI the process belongs to

## NOTES

- Requires authentication to Azure DevOps. Use `Set-AdoDefault` to configure default organization and project values.
Expand Down
11 changes: 0 additions & 11 deletions docs/Get-AdoProject.md
Original file line number Diff line number Diff line change
Expand Up @@ -293,17 +293,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

### PSCustomObject

Returns one or more project objects with the following properties:
- id: The unique identifier of the project
- name: The name of the project
- description: The description of the project
- visibility: The visibility of the project (public or private)
- state: The state of the project (wellFormed, createPending, deleted, etc.)
- defaultTeam: Information about the default team for the project
- capabilities: Project capabilities if IncludeCapabilities is specified (source control type, process template, etc.)
- collectionUri: The collection URI the project belongs to
- continuationToken: Token for retrieving next page of results (only present when listing projects with pagination)

## NOTES

- Requires authentication to Azure DevOps. Use `Set-AdoDefault` to configure default organization and project values.
Expand Down
10 changes: 0 additions & 10 deletions docs/Get-AdoRepository.md
Original file line number Diff line number Diff line change
Expand Up @@ -255,16 +255,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

### PSCustomObject

Returns a custom object with the following properties:
- id: The unique identifier of the repository
- name: The name of the repository
- project: The project object containing repository details
- defaultBranch: The default branch of the repository
- url: The URL of the repository
- remoteUrl: The remote URL for cloning the repository
- projectName: The name of the project containing the repository
- collectionUri: The collection URI of the Azure DevOps organization

## NOTES

- Requires authentication to Azure DevOps. Use `Set-AdoDefault` to configure default organization and project values.
Expand Down
14 changes: 0 additions & 14 deletions docs/Get-AdoServiceEndpoint.md
Original file line number Diff line number Diff line change
Expand Up @@ -354,20 +354,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

### PSCustomObject

Service endpoint objects with the following properties:
- id: The unique identifier of the service endpoint
- name: The name of the service endpoint
- type: The type of service endpoint (e.g., AzureRM, GitHub, Docker)
- description: The description of the service endpoint
- authorization: Authorization details including scheme and parameters
- isShared: Whether the endpoint is shared across projects
- isReady: Whether the endpoint is ready for use
- owner: The owner of the endpoint (library or agentcloud)
- data: Additional data associated with the endpoint
- serviceEndpointProjectReferences: Project references for the endpoint
- projectName: The project name
- collectionUri: The collection URI

## NOTES

- If a service endpoint is not found, a warning is displayed instead of throwing an error.
Expand Down
10 changes: 0 additions & 10 deletions docs/Get-AdoTeam.md
Original file line number Diff line number Diff line change
Expand Up @@ -235,16 +235,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

### PSCustomObject

Returns one or more team objects with the following properties:
- id: The unique identifier of the team
- name: The name of the team
- description: The description of the team
- url: The REST API URL for the team
- identityUrl: The identity URL for the team
- projectId: The unique identifier of the project the team belongs to
- projectName: The name of the project the team belongs to
- collectionUri: The collection URI the team belongs to

## NOTES

- Both CollectionUri and ProjectName parameters can be set as environment variables ($env:DefaultAdoCollectionUri and $env:DefaultAdoProject) to avoid specifying them in each call
Expand Down
7 changes: 0 additions & 7 deletions docs/Get-AdoTeamFieldValue.md
Original file line number Diff line number Diff line change
Expand Up @@ -192,13 +192,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

### PSCustomObject

The team field value settings for the specified team with the following properties:
- defaultValue: The default area path value for the team
- field: Object containing the field reference name and URL
- values: Array of area path values with includeChildren settings
- projectName: The project name used in the request
- collectionUri: The collection URI used in the request

## NOTES

- Requires authentication to Azure DevOps. Use `Set-AdoDefault` to configure default organization and project values.
Expand Down
8 changes: 0 additions & 8 deletions docs/Get-AdoTeamIteration.md
Original file line number Diff line number Diff line change
Expand Up @@ -246,14 +246,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

### PSCustomObject

The cmdlet returns a PSCustomObject with the following properties:
- id: The unique identifier of the iteration
- name: The name of the iteration
- attributes: The iteration attributes including start date, finish date, and time frame
- team: The id or name of the team
- project: The id or name of the project
- collectionUri: The collection URI

## NOTES

- Requires authentication to Azure DevOps. Use `Set-AdoDefault` to configure default organization and project values.
Expand Down
11 changes: 0 additions & 11 deletions docs/Get-AdoTeamSettings.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,17 +180,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

### PSCustomObject

Returns a team settings object containing:
- backlogIteration: The backlog iteration configuration
- backlogVisibilities: Hashtable of backlog level visibilities (Epic, Feature, Requirement categories)
- bugsBehavior: How bugs are treated ('off', 'asRequirements', or 'asTasks')
- defaultIteration: The default iteration configuration
- defaultIterationMacro: Default iteration macro (e.g., '@currentIteration')
- workingDays: Array of working days for the team
- url: API URL for the team settings
- projectName: The name of the project
- collectionUri: The collection URI

## NOTES

- Requires authentication to Azure DevOps. Use `Set-AdoDefault` to configure default organization and project values.
Expand Down
11 changes: 0 additions & 11 deletions docs/Get-AdoUserEntitlement.md
Original file line number Diff line number Diff line change
Expand Up @@ -253,17 +253,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

### PSCustomObject

The dictionary contains user entitlements:
- `accessLevel`: User's access level denoted by a license.
- `extensions`: User's extensions.
- `groupAssigments`: [Readonly] GroupEntitlements that this user belongs to.
- `id`: The unique identifier which matches the Id of the Identity associated with the GraphMember.
- `dateCreated`: [Readonly] Date the member was added to the collection.
- `lastAccessedDate`: [Readonly] Date the user last accessed the collection.
- `projectEntitlements`: Relation between a project and the user's effective permissions in that project.
- `user`: User reference.
- `collectionUri`: The collection URI.

## NOTES

- N/A
Expand Down
18 changes: 0 additions & 18 deletions docs/New-AdoCheckApproval.md
Original file line number Diff line number Diff line change
Expand Up @@ -450,24 +450,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

### PSCustomObject

Returns a custom object representing the approval check configuration:
- id: The unique identifier of the check configuration
- settings: The approval settings object containing:
- approvers: Array of approver objects with id property
- minRequiredApprovers: Minimum number of required approvers (0 = all)
- executionOrder: Order in which approvers must approve (anyOrder or inSequence)
- requesterCannotBeApprover: Whether the requester can be an approver
- instructions: Instructions for the approvers
- blockedApprovers: Array of blocked approvers
- definitionRef: Reference to the approval definition with id property
- timeout: The timeout value in minutes
- type: The check type object with name and id properties
- resource: The resource object with type and id properties
- createdBy: The ID of the user who created the check
- createdOn: The timestamp when the check was created
- project: The project name
- collectionUri: The collection URI

## NOTES

- When an approval check with the same configuration already exists, the existing check is returned with a warning
Expand Down
11 changes: 0 additions & 11 deletions docs/New-AdoCheckBranchControl.md
Original file line number Diff line number Diff line change
Expand Up @@ -372,17 +372,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

### PSCustomObject

Returns a custom object representing the branch control check configuration:
- id: The unique identifier of the check configuration
- settings: The branch control settings including display name, definition reference, and inputs
- timeout: The timeout value in minutes
- type: The type of check (Task Check)
- resource: The resource details (type and id)
- createdBy: The ID of the user who created the check
- createdOn: The timestamp when the check was created
- project: The project name
- collectionUri: The collection URI

## NOTES

- When a branch control check with the same configuration already exists, the existing check is returned with a warning
Expand Down
Loading