Skip to content

Commit

Permalink
fix: Updating Checkout Step to v4 ( Fixes #191 )
Browse files Browse the repository at this point in the history
Updating workflow
  • Loading branch information
StartAutomating authored and StartAutomating committed Sep 15, 2024
1 parent cdef81c commit 6aaf6a5
Showing 1 changed file with 36 additions and 127 deletions.
163 changes: 36 additions & 127 deletions docs/Get-ADOAgentPool.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
Get-ADOAgentPool
----------------

### Synopsis
Gets Azure DevOps Agent Pools

---

### Description

Gets Agent Pools and their associated queues from Azure DevOps.
Expand All @@ -15,191 +17,99 @@ Thus providing a project will return the queues associated with the project,
and just providing the organization will return all of the common pools.

---

### Related Links
* [https://docs.microsoft.com/en-us/rest/api/azure/devops/distributedtask/pools/get%20agent%20pools](https://docs.microsoft.com/en-us/rest/api/azure/devops/distributedtask/pools/get%20agent%20pools)



* [https://docs.microsoft.com/en-us/rest/api/azure/devops/distributedtask/queues/get%20agent%20queues](https://docs.microsoft.com/en-us/rest/api/azure/devops/distributedtask/queues/get%20agent%20queues)



* [https://docs.microsoft.com/en-us/rest/api/azure/devops/distributedtask/agents/list](https://docs.microsoft.com/en-us/rest/api/azure/devops/distributedtask/agents/list)



---

### Examples
#### EXAMPLE 1
> EXAMPLE 1
```PowerShell
Get-ADOAgentPool -Organization MyOrganization -PersonalAccessToken $pat
```

---

### Parameters
#### **Organization**

The Organization

|Type |Required|Position|PipelineInput |Aliases|
|----------|--------|--------|---------------------|-------|
|`[String]`|true |named |true (ByPropertyName)|Org |


> **Type**: ```[String]```
> **Required**: true
> **Position**: named
> **PipelineInput**:true (ByPropertyName)


---
#### **PoolID**

The Pool ID. When this is provided, will return agents associated with a given pool ID.

|Type |Required|Position|PipelineInput |
|----------|--------|--------|---------------------|
|`[String]`|true |named |true (ByPropertyName)|


> **Type**: ```[String]```
> **Required**: true
> **Position**: named
> **PipelineInput**:true (ByPropertyName)


---
#### **AgentName**

If provided, will return agents of a given name.

|Type |Required|Position|PipelineInput |
|----------|--------|--------|---------------------|
|`[String]`|false |named |true (ByPropertyName)|


> **Type**: ```[String]```
> **Required**: false
> **Position**: named
> **PipelineInput**:true (ByPropertyName)


---
#### **IncludeCapability**

If set, will return the capabilities of each returned agent.

|Type |Required|Position|PipelineInput |Aliases |
|----------|--------|--------|---------------------|-------------------------------------------|
|`[Switch]`|false |named |true (ByPropertyName)|Capability<br/>Capabilities<br/>Environment|


> **Type**: ```[Switch]```
> **Required**: false
> **Position**: named
> **PipelineInput**:true (ByPropertyName)


---
#### **IncludeLastCompletedRequest**

If set, will return the last completed request of each returned agent.

|Type |Required|Position|PipelineInput |Aliases |
|----------|--------|--------|---------------------|----------------------------------------------------|
|`[Switch]`|false |named |true (ByPropertyName)|IncludeLastCompleted<br/>LastCompleted<br/>Completed|


> **Type**: ```[Switch]```
> **Required**: false
> **Position**: named
> **PipelineInput**:true (ByPropertyName)


---
#### **IncludeAssignedRequest**

If set, will return the requests queued for an agent.

|Type |Required|Position|PipelineInput |Aliases |
|----------|--------|--------|---------------------|-------------------------------------------|
|`[Switch]`|false |named |true (ByPropertyName)|IncludeAssigned<br/>IncludeQueue<br/>Queued|


> **Type**: ```[Switch]```
> **Required**: false
> **Position**: named
> **PipelineInput**:true (ByPropertyName)


---
#### **Project**

The project name or identifier. When this is provided, will return queues associated with the project.

|Type |Required|Position|PipelineInput |
|----------|--------|--------|---------------------|
|`[String]`|true |named |true (ByPropertyName)|


> **Type**: ```[String]```
> **Required**: true
> **Position**: named
> **PipelineInput**:true (ByPropertyName)


---
#### **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 |Required|Position|PipelineInput |
|-------|--------|--------|---------------------|
|`[Uri]`|false |named |true (ByPropertyName)|


> **Type**: ```[Uri]```
> **Required**: false
> **Position**: named
> **PipelineInput**:true (ByPropertyName)


---
#### **ApiVersion**

The api version. By default, 5.1.
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**: ```[String]```
> **Required**: false
> **Position**: named
> **PipelineInput**:false

|Type |Required|Position|PipelineInput|
|----------|--------|--------|-------------|
|`[String]`|false |named |false |

---

### Outputs
* PSDevops.Pool




---

### Syntax
```PowerShell
Get-ADOAgentPool -Organization <String> -PoolID <String> [-AgentName <String>] [-IncludeCapability] [-IncludeLastCompletedRequest] [-IncludeAssignedRequest] [-Server <Uri>] [-ApiVersion <String>] [<CommonParameters>]
Expand All @@ -210,4 +120,3 @@ Get-ADOAgentPool -Organization <String> -Project <String> [-Server <Uri>] [-ApiV
```PowerShell
Get-ADOAgentPool -Organization <String> [-Server <Uri>] [-ApiVersion <String>] [<CommonParameters>]
```
---

0 comments on commit 6aaf6a5

Please sign in to comment.