Microsoft.DevOps (preview:2020-07-13)

2025/10/23 • 8 new, 8 deleted methods

Operations_List (new)
Description :  Lists all the operations supported by Microsoft.DevOps resource provider.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.DevOps/operations
{
api-version:
{
Description: API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by Microsoft.DevOps resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Name of the operation. ,
Required: False ,
}
string ,
isDataAction:
{
Description: Indicates whether the operation applies to data-plane. ,
Required: False ,
}
string ,
display:
{
Description: Display information of the operation. ,
Required: False ,
}
{
operation:
{
Description: Friendly name of the operation. ,
Required: False ,
}
string ,
resource:
{
Description: Friendly name of the resource type the operation applies to. ,
Required: False ,
}
string ,
description:
{
Description: Friendly description of the operation. ,
Required: False ,
}
string ,
provider:
{
Description: Friendly name of the resource provider. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of operations, if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Details of the error from the Pipelines Resource Provider. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error or the method where the error occurred. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
PipelineTemplateDefinitions_List (new)
Description :  Lists all pipeline templates which can be used to configure a Pipeline.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.DevOps/pipelineTemplateDefinitions
{
api-version:
{
Description: API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of pipeline template definitions. ,
Required: False ,
}
[
{
id:
{
Description: Unique identifier of the pipeline template. ,
Required: True ,
}
string ,
description:
{
Description: Description of the pipeline enabled by the template. ,
Required: False ,
}
string ,
inputs:
{
Description: List of input parameters required by the template to create a pipeline. ,
Required: False ,
}
[
{
id:
{
Description: Identifier of the input parameter. ,
Required: True ,
}
string ,
description:
{
Description: Description of the input parameter. ,
Required: False ,
}
string ,
type:
{
Description: Data type of the value of the input parameter. ,
Enum:
{
String: No description available. ,
SecureString: No description available. ,
Int: No description available. ,
Bool: No description available. ,
Authorization: No description available. ,
}
,
Required: True ,
}
enum ,
possibleValues:
{
Description: List of possible values for the input parameter. ,
Required: False ,
}
[
{
value:
{
Description: Value of an input parameter. ,
Required: False ,
}
string ,
displayValue:
{
Description: Description of the input parameter value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of pipeline template definitions, if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Details of the error from the Pipelines Resource Provider. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error or the method where the error occurred. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Pipelines_CreateOrUpdate (new)
Description :  Creates or updates a Pipeline.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevOps/pipelines/{pipelineName}
{
subscriptionId:
{
Description: Unique identifier of the Azure subscription. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to be used with the HTTP request. ,
Required: True ,
}
string ,
pipelineName:
{
Description: The name of the Pipeline resource in ARM. ,
Required: True ,
}
string ,
createOperationParameters:
{
Description: The request payload to create the Pipeline. ,
Required: True ,
}
{
properties:
{
Description: Custom properties of the Pipeline. ,
Required: True ,
}
{
pipelineId:
{
Description: Unique identifier of the Pipeline ,
Required: False ,
}
integer ,
pipelineType:
{
Description: Specifies which CI/CD provider to use. Valid options are 'azurePipeline', 'githubWorkflow'. ,
Enum:
{
githubWorkflow: No description available. ,
azurePipeline: No description available. ,
}
,
Required: True ,
}
enum ,
bootstrapConfiguration:
{
Description: Configuration used to bootstrap the Pipeline. ,
Required: True ,
}
{
sourceRepository:
{
Description: Repository containing the source code for the pipeline. Currently only 'azurePipeline' pipeline type supports this. ,
Required: False ,
}
{
repositoryType:
{
Description: Type of code repository. ,
Enum:
{
gitHub: No description available. ,
vstsGit: No description available. ,
}
,
Required: True ,
}
enum ,
id:
{
Description: Unique immutable identifier of the code repository. ,
Required: True ,
}
string ,
defaultBranch:
{
Description: Default branch used to configure Continuous Integration (CI) in the pipeline. ,
Required: True ,
}
string ,
authorization:
{
Description: Authorization info to access the code repository. ,
Required: False ,
}
{
authorizationType:
{
Description: Type of authorization. ,
Enum:
{
personalAccessToken: No description available. ,
}
,
Required: True ,
}
enum ,
parameters:
{
Description: Authorization parameters corresponding to the authorization type. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Repository-specific properties. ,
Required: False ,
}
object ,
}
,
template:
{
Description: Template used to bootstrap the pipeline. ,
Required: True ,
}
{
id:
{
Description: Unique identifier of the pipeline template. ,
Required: True ,
}
string ,
parameters:
{
Description: Dictionary of input parameters used in the pipeline template. ,
Required: False ,
}
object ,
}
,
}
,
}
,
systemData:
{
Description: The system metadata pertaining to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: Custom properties of the Pipeline. ,
Required: True ,
}
{
pipelineId:
{
Description: Unique identifier of the Pipeline ,
Required: False ,
}
integer ,
pipelineType:
{
Description: Specifies which CI/CD provider to use. Valid options are 'azurePipeline', 'githubWorkflow'. ,
Enum:
{
githubWorkflow: No description available. ,
azurePipeline: No description available. ,
}
,
Required: True ,
}
enum ,
bootstrapConfiguration:
{
Description: Configuration used to bootstrap the Pipeline. ,
Required: True ,
}
{
sourceRepository:
{
Description: Repository containing the source code for the pipeline. Currently only 'azurePipeline' pipeline type supports this. ,
Required: False ,
}
{
repositoryType:
{
Description: Type of code repository. ,
Enum:
{
gitHub: No description available. ,
vstsGit: No description available. ,
}
,
Required: True ,
}
enum ,
id:
{
Description: Unique immutable identifier of the code repository. ,
Required: True ,
}
string ,
defaultBranch:
{
Description: Default branch used to configure Continuous Integration (CI) in the pipeline. ,
Required: True ,
}
string ,
authorization:
{
Description: Authorization info to access the code repository. ,
Required: False ,
}
{
authorizationType:
{
Description: Type of authorization. ,
Enum:
{
personalAccessToken: No description available. ,
}
,
Required: True ,
}
enum ,
parameters:
{
Description: Authorization parameters corresponding to the authorization type. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Repository-specific properties. ,
Required: False ,
}
object ,
}
,
template:
{
Description: Template used to bootstrap the pipeline. ,
Required: True ,
}
{
id:
{
Description: Unique identifier of the pipeline template. ,
Required: True ,
}
string ,
parameters:
{
Description: Dictionary of input parameters used in the pipeline template. ,
Required: False ,
}
object ,
}
,
}
,
}
,
systemData:
{
Description: The system metadata pertaining to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Details of the error from the Pipelines Resource Provider. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error or the method where the error occurred. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Pipelines_Get (new)
Description :  Gets an existing Pipeline.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevOps/pipelines/{pipelineName}
{
subscriptionId:
{
Description: Unique identifier of the Azure subscription. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to be used with the HTTP request. ,
Required: True ,
}
string ,
pipelineName:
{
Description: The name of the Pipeline resource in ARM. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Custom properties of the Pipeline. ,
Required: True ,
}
{
pipelineId:
{
Description: Unique identifier of the Pipeline ,
Required: False ,
}
integer ,
pipelineType:
{
Description: Specifies which CI/CD provider to use. Valid options are 'azurePipeline', 'githubWorkflow'. ,
Enum:
{
githubWorkflow: No description available. ,
azurePipeline: No description available. ,
}
,
Required: True ,
}
enum ,
bootstrapConfiguration:
{
Description: Configuration used to bootstrap the Pipeline. ,
Required: True ,
}
{
sourceRepository:
{
Description: Repository containing the source code for the pipeline. Currently only 'azurePipeline' pipeline type supports this. ,
Required: False ,
}
{
repositoryType:
{
Description: Type of code repository. ,
Enum:
{
gitHub: No description available. ,
vstsGit: No description available. ,
}
,
Required: True ,
}
enum ,
id:
{
Description: Unique immutable identifier of the code repository. ,
Required: True ,
}
string ,
defaultBranch:
{
Description: Default branch used to configure Continuous Integration (CI) in the pipeline. ,
Required: True ,
}
string ,
authorization:
{
Description: Authorization info to access the code repository. ,
Required: False ,
}
{
authorizationType:
{
Description: Type of authorization. ,
Enum:
{
personalAccessToken: No description available. ,
}
,
Required: True ,
}
enum ,
parameters:
{
Description: Authorization parameters corresponding to the authorization type. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Repository-specific properties. ,
Required: False ,
}
object ,
}
,
template:
{
Description: Template used to bootstrap the pipeline. ,
Required: True ,
}
{
id:
{
Description: Unique identifier of the pipeline template. ,
Required: True ,
}
string ,
parameters:
{
Description: Dictionary of input parameters used in the pipeline template. ,
Required: False ,
}
object ,
}
,
}
,
}
,
systemData:
{
Description: The system metadata pertaining to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Details of the error from the Pipelines Resource Provider. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error or the method where the error occurred. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Pipelines_Update (new)
Description :  Updates the properties of an Azure Pipeline. Currently, it is not supported on 'githubWorkflow' pipeline type and only tags can be updated for 'azurePipeline' pipeline type.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevOps/pipelines/{pipelineName}
{
subscriptionId:
{
Description: Unique identifier of the Azure subscription. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to be used with the HTTP request. ,
Required: True ,
}
string ,
pipelineName:
{
Description: The name of the Azure Pipeline resource. ,
Required: True ,
}
string ,
updateOperationParameters:
{
Description: The request payload containing the properties to update in the Azure Pipeline. ,
Required: True ,
}
{
tags:
{
Description: Dictionary of key-value pairs to be set as tags on the Azure Pipeline. This will overwrite any existing tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Custom properties of the Pipeline. ,
Required: True ,
}
{
pipelineId:
{
Description: Unique identifier of the Pipeline ,
Required: False ,
}
integer ,
pipelineType:
{
Description: Specifies which CI/CD provider to use. Valid options are 'azurePipeline', 'githubWorkflow'. ,
Enum:
{
githubWorkflow: No description available. ,
azurePipeline: No description available. ,
}
,
Required: True ,
}
enum ,
bootstrapConfiguration:
{
Description: Configuration used to bootstrap the Pipeline. ,
Required: True ,
}
{
sourceRepository:
{
Description: Repository containing the source code for the pipeline. Currently only 'azurePipeline' pipeline type supports this. ,
Required: False ,
}
{
repositoryType:
{
Description: Type of code repository. ,
Enum:
{
gitHub: No description available. ,
vstsGit: No description available. ,
}
,
Required: True ,
}
enum ,
id:
{
Description: Unique immutable identifier of the code repository. ,
Required: True ,
}
string ,
defaultBranch:
{
Description: Default branch used to configure Continuous Integration (CI) in the pipeline. ,
Required: True ,
}
string ,
authorization:
{
Description: Authorization info to access the code repository. ,
Required: False ,
}
{
authorizationType:
{
Description: Type of authorization. ,
Enum:
{
personalAccessToken: No description available. ,
}
,
Required: True ,
}
enum ,
parameters:
{
Description: Authorization parameters corresponding to the authorization type. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Repository-specific properties. ,
Required: False ,
}
object ,
}
,
template:
{
Description: Template used to bootstrap the pipeline. ,
Required: True ,
}
{
id:
{
Description: Unique identifier of the pipeline template. ,
Required: True ,
}
string ,
parameters:
{
Description: Dictionary of input parameters used in the pipeline template. ,
Required: False ,
}
object ,
}
,
}
,
}
,
systemData:
{
Description: The system metadata pertaining to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Details of the error from the Pipelines Resource Provider. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error or the method where the error occurred. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Pipelines_Delete (new)
Description :  Deletes a Pipeline.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevOps/pipelines/{pipelineName}
{
subscriptionId:
{
Description: Unique identifier of the Azure subscription. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to be used with the HTTP request. ,
Required: True ,
}
string ,
pipelineName:
{
Description: The name of the Pipeline resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Details of the error from the Pipelines Resource Provider. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error or the method where the error occurred. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Pipelines_ListByResourceGroup (new)
Description :  Lists all Pipelines under the specified resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevOps/pipelines
{
subscriptionId:
{
Description: Unique identifier of the Azure subscription. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of pipelines. ,
Required: False ,
}
[
{
properties:
{
Description: Custom properties of the Pipeline. ,
Required: True ,
}
{
pipelineId:
{
Description: Unique identifier of the Pipeline ,
Required: False ,
}
integer ,
pipelineType:
{
Description: Specifies which CI/CD provider to use. Valid options are 'azurePipeline', 'githubWorkflow'. ,
Enum:
{
githubWorkflow: No description available. ,
azurePipeline: No description available. ,
}
,
Required: True ,
}
enum ,
bootstrapConfiguration:
{
Description: Configuration used to bootstrap the Pipeline. ,
Required: True ,
}
{
sourceRepository:
{
Description: Repository containing the source code for the pipeline. Currently only 'azurePipeline' pipeline type supports this. ,
Required: False ,
}
{
repositoryType:
{
Description: Type of code repository. ,
Enum:
{
gitHub: No description available. ,
vstsGit: No description available. ,
}
,
Required: True ,
}
enum ,
id:
{
Description: Unique immutable identifier of the code repository. ,
Required: True ,
}
string ,
defaultBranch:
{
Description: Default branch used to configure Continuous Integration (CI) in the pipeline. ,
Required: True ,
}
string ,
authorization:
{
Description: Authorization info to access the code repository. ,
Required: False ,
}
{
authorizationType:
{
Description: Type of authorization. ,
Enum:
{
personalAccessToken: No description available. ,
}
,
Required: True ,
}
enum ,
parameters:
{
Description: Authorization parameters corresponding to the authorization type. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Repository-specific properties. ,
Required: False ,
}
object ,
}
,
template:
{
Description: Template used to bootstrap the pipeline. ,
Required: True ,
}
{
id:
{
Description: Unique identifier of the pipeline template. ,
Required: True ,
}
string ,
parameters:
{
Description: Dictionary of input parameters used in the pipeline template. ,
Required: False ,
}
object ,
}
,
}
,
}
,
systemData:
{
Description: The system metadata pertaining to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of Pipelines, if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Details of the error from the Pipelines Resource Provider. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error or the method where the error occurred. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Pipelines_ListBySubscription (new)
Description :  Lists all Pipelines under the specified subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DevOps/pipelines
{
subscriptionId:
{
Description: Unique identifier of the Azure subscription. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of pipelines. ,
Required: False ,
}
[
{
properties:
{
Description: Custom properties of the Pipeline. ,
Required: True ,
}
{
pipelineId:
{
Description: Unique identifier of the Pipeline ,
Required: False ,
}
integer ,
pipelineType:
{
Description: Specifies which CI/CD provider to use. Valid options are 'azurePipeline', 'githubWorkflow'. ,
Enum:
{
githubWorkflow: No description available. ,
azurePipeline: No description available. ,
}
,
Required: True ,
}
enum ,
bootstrapConfiguration:
{
Description: Configuration used to bootstrap the Pipeline. ,
Required: True ,
}
{
sourceRepository:
{
Description: Repository containing the source code for the pipeline. Currently only 'azurePipeline' pipeline type supports this. ,
Required: False ,
}
{
repositoryType:
{
Description: Type of code repository. ,
Enum:
{
gitHub: No description available. ,
vstsGit: No description available. ,
}
,
Required: True ,
}
enum ,
id:
{
Description: Unique immutable identifier of the code repository. ,
Required: True ,
}
string ,
defaultBranch:
{
Description: Default branch used to configure Continuous Integration (CI) in the pipeline. ,
Required: True ,
}
string ,
authorization:
{
Description: Authorization info to access the code repository. ,
Required: False ,
}
{
authorizationType:
{
Description: Type of authorization. ,
Enum:
{
personalAccessToken: No description available. ,
}
,
Required: True ,
}
enum ,
parameters:
{
Description: Authorization parameters corresponding to the authorization type. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Repository-specific properties. ,
Required: False ,
}
object ,
}
,
template:
{
Description: Template used to bootstrap the pipeline. ,
Required: True ,
}
{
id:
{
Description: Unique identifier of the pipeline template. ,
Required: True ,
}
string ,
parameters:
{
Description: Dictionary of input parameters used in the pipeline template. ,
Required: False ,
}
object ,
}
,
}
,
}
,
systemData:
{
Description: The system metadata pertaining to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of Pipelines, if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Details of the error from the Pipelines Resource Provider. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error or the method where the error occurred. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Operations_List (removed)
Description :  Lists all the operations supported by Microsoft.DevOps resource provider.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.DevOps/operations
{
api-version:
{
Description: API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by Microsoft.DevOps resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Name of the operation. ,
Required: False ,
}
string ,
isDataAction:
{
Description: Indicates whether the operation applies to data-plane. ,
Required: False ,
}
string ,
display:
{
Description: Display information of the operation. ,
Required: False ,
}
{
operation:
{
Description: Friendly name of the operation. ,
Required: False ,
}
string ,
resource:
{
Description: Friendly name of the resource type the operation applies to. ,
Required: False ,
}
string ,
description:
{
Description: Friendly description of the operation. ,
Required: False ,
}
string ,
provider:
{
Description: Friendly name of the resource provider. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of operations, if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Details of the error from the Pipelines Resource Provider. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error or the method where the error occurred. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
PipelineTemplateDefinitions_List (removed)
Description :  Lists all pipeline templates which can be used to configure a Pipeline.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.DevOps/pipelineTemplateDefinitions
{
api-version:
{
Description: API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of pipeline template definitions. ,
Required: False ,
}
[
{
id:
{
Description: Unique identifier of the pipeline template. ,
Required: True ,
}
string ,
description:
{
Description: Description of the pipeline enabled by the template. ,
Required: False ,
}
string ,
inputs:
{
Description: List of input parameters required by the template to create a pipeline. ,
Required: False ,
}
[
{
id:
{
Description: Identifier of the input parameter. ,
Required: True ,
}
string ,
description:
{
Description: Description of the input parameter. ,
Required: False ,
}
string ,
type:
{
Description: Data type of the value of the input parameter. ,
Enum:
{
String: No description available. ,
SecureString: No description available. ,
Int: No description available. ,
Bool: No description available. ,
Authorization: No description available. ,
}
,
Required: True ,
}
enum ,
possibleValues:
{
Description: List of possible values for the input parameter. ,
Required: False ,
}
[
{
value:
{
Description: Value of an input parameter. ,
Required: False ,
}
string ,
displayValue:
{
Description: Description of the input parameter value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of pipeline template definitions, if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Details of the error from the Pipelines Resource Provider. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error or the method where the error occurred. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Pipelines_CreateOrUpdate (removed)
Description :  Creates or updates a Pipeline.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevOps/pipelines/{pipelineName}
{
subscriptionId:
{
Description: Unique identifier of the Azure subscription. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to be used with the HTTP request. ,
Required: True ,
}
string ,
pipelineName:
{
Description: The name of the Pipeline resource in ARM. ,
Required: True ,
}
string ,
createOperationParameters:
{
Description: The request payload to create the Pipeline. ,
Required: True ,
}
{
properties:
{
Description: Custom properties of the Pipeline. ,
Required: True ,
}
{
pipelineId:
{
Description: Unique identifier of the Pipeline ,
Required: False ,
}
integer ,
pipelineType:
{
Description: Specifies which CI/CD provider to use. Valid options are 'azurePipeline', 'githubWorkflow'. ,
Enum:
{
githubWorkflow: No description available. ,
azurePipeline: No description available. ,
}
,
Required: True ,
}
enum ,
bootstrapConfiguration:
{
Description: Configuration used to bootstrap the Pipeline. ,
Required: True ,
}
{
sourceRepository:
{
Description: Repository containing the source code for the pipeline. Currently only 'azurePipeline' pipeline type supports this. ,
Required: False ,
}
{
repositoryType:
{
Description: Type of code repository. ,
Enum:
{
gitHub: No description available. ,
vstsGit: No description available. ,
}
,
Required: True ,
}
enum ,
id:
{
Description: Unique immutable identifier of the code repository. ,
Required: True ,
}
string ,
defaultBranch:
{
Description: Default branch used to configure Continuous Integration (CI) in the pipeline. ,
Required: True ,
}
string ,
authorization:
{
Description: Authorization info to access the code repository. ,
Required: False ,
}
{
authorizationType:
{
Description: Type of authorization. ,
Enum:
{
personalAccessToken: No description available. ,
}
,
Required: True ,
}
enum ,
parameters:
{
Description: Authorization parameters corresponding to the authorization type. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Repository-specific properties. ,
Required: False ,
}
object ,
}
,
template:
{
Description: Template used to bootstrap the pipeline. ,
Required: True ,
}
{
id:
{
Description: Unique identifier of the pipeline template. ,
Required: True ,
}
string ,
parameters:
{
Description: Dictionary of input parameters used in the pipeline template. ,
Required: False ,
}
object ,
}
,
}
,
}
,
systemData:
{
Description: The system metadata pertaining to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (200)

{
properties:
{
Description: Custom properties of the Pipeline. ,
Required: True ,
}
{
pipelineId:
{
Description: Unique identifier of the Pipeline ,
Required: False ,
}
integer ,
pipelineType:
{
Description: Specifies which CI/CD provider to use. Valid options are 'azurePipeline', 'githubWorkflow'. ,
Enum:
{
githubWorkflow: No description available. ,
azurePipeline: No description available. ,
}
,
Required: True ,
}
enum ,
bootstrapConfiguration:
{
Description: Configuration used to bootstrap the Pipeline. ,
Required: True ,
}
{
sourceRepository:
{
Description: Repository containing the source code for the pipeline. Currently only 'azurePipeline' pipeline type supports this. ,
Required: False ,
}
{
repositoryType:
{
Description: Type of code repository. ,
Enum:
{
gitHub: No description available. ,
vstsGit: No description available. ,
}
,
Required: True ,
}
enum ,
id:
{
Description: Unique immutable identifier of the code repository. ,
Required: True ,
}
string ,
defaultBranch:
{
Description: Default branch used to configure Continuous Integration (CI) in the pipeline. ,
Required: True ,
}
string ,
authorization:
{
Description: Authorization info to access the code repository. ,
Required: False ,
}
{
authorizationType:
{
Description: Type of authorization. ,
Enum:
{
personalAccessToken: No description available. ,
}
,
Required: True ,
}
enum ,
parameters:
{
Description: Authorization parameters corresponding to the authorization type. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Repository-specific properties. ,
Required: False ,
}
object ,
}
,
template:
{
Description: Template used to bootstrap the pipeline. ,
Required: True ,
}
{
id:
{
Description: Unique identifier of the pipeline template. ,
Required: True ,
}
string ,
parameters:
{
Description: Dictionary of input parameters used in the pipeline template. ,
Required: False ,
}
object ,
}
,
}
,
}
,
systemData:
{
Description: The system metadata pertaining to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Details of the error from the Pipelines Resource Provider. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error or the method where the error occurred. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Pipelines_Get (removed)
Description :  Gets an existing Pipeline.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevOps/pipelines/{pipelineName}
{
subscriptionId:
{
Description: Unique identifier of the Azure subscription. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to be used with the HTTP request. ,
Required: True ,
}
string ,
pipelineName:
{
Description: The name of the Pipeline resource in ARM. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Custom properties of the Pipeline. ,
Required: True ,
}
{
pipelineId:
{
Description: Unique identifier of the Pipeline ,
Required: False ,
}
integer ,
pipelineType:
{
Description: Specifies which CI/CD provider to use. Valid options are 'azurePipeline', 'githubWorkflow'. ,
Enum:
{
githubWorkflow: No description available. ,
azurePipeline: No description available. ,
}
,
Required: True ,
}
enum ,
bootstrapConfiguration:
{
Description: Configuration used to bootstrap the Pipeline. ,
Required: True ,
}
{
sourceRepository:
{
Description: Repository containing the source code for the pipeline. Currently only 'azurePipeline' pipeline type supports this. ,
Required: False ,
}
{
repositoryType:
{
Description: Type of code repository. ,
Enum:
{
gitHub: No description available. ,
vstsGit: No description available. ,
}
,
Required: True ,
}
enum ,
id:
{
Description: Unique immutable identifier of the code repository. ,
Required: True ,
}
string ,
defaultBranch:
{
Description: Default branch used to configure Continuous Integration (CI) in the pipeline. ,
Required: True ,
}
string ,
authorization:
{
Description: Authorization info to access the code repository. ,
Required: False ,
}
{
authorizationType:
{
Description: Type of authorization. ,
Enum:
{
personalAccessToken: No description available. ,
}
,
Required: True ,
}
enum ,
parameters:
{
Description: Authorization parameters corresponding to the authorization type. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Repository-specific properties. ,
Required: False ,
}
object ,
}
,
template:
{
Description: Template used to bootstrap the pipeline. ,
Required: True ,
}
{
id:
{
Description: Unique identifier of the pipeline template. ,
Required: True ,
}
string ,
parameters:
{
Description: Dictionary of input parameters used in the pipeline template. ,
Required: False ,
}
object ,
}
,
}
,
}
,
systemData:
{
Description: The system metadata pertaining to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Details of the error from the Pipelines Resource Provider. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error or the method where the error occurred. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Pipelines_Update (removed)
Description :  Updates the properties of an Azure Pipeline. Currently, it is not supported on 'githubWorkflow' pipeline type and only tags can be updated for 'azurePipeline' pipeline type.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevOps/pipelines/{pipelineName}
{
subscriptionId:
{
Description: Unique identifier of the Azure subscription. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to be used with the HTTP request. ,
Required: True ,
}
string ,
pipelineName:
{
Description: The name of the Azure Pipeline resource. ,
Required: True ,
}
string ,
updateOperationParameters:
{
Description: The request payload containing the properties to update in the Azure Pipeline. ,
Required: True ,
}
{
tags:
{
Description: Dictionary of key-value pairs to be set as tags on the Azure Pipeline. This will overwrite any existing tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Custom properties of the Pipeline. ,
Required: True ,
}
{
pipelineId:
{
Description: Unique identifier of the Pipeline ,
Required: False ,
}
integer ,
pipelineType:
{
Description: Specifies which CI/CD provider to use. Valid options are 'azurePipeline', 'githubWorkflow'. ,
Enum:
{
githubWorkflow: No description available. ,
azurePipeline: No description available. ,
}
,
Required: True ,
}
enum ,
bootstrapConfiguration:
{
Description: Configuration used to bootstrap the Pipeline. ,
Required: True ,
}
{
sourceRepository:
{
Description: Repository containing the source code for the pipeline. Currently only 'azurePipeline' pipeline type supports this. ,
Required: False ,
}
{
repositoryType:
{
Description: Type of code repository. ,
Enum:
{
gitHub: No description available. ,
vstsGit: No description available. ,
}
,
Required: True ,
}
enum ,
id:
{
Description: Unique immutable identifier of the code repository. ,
Required: True ,
}
string ,
defaultBranch:
{
Description: Default branch used to configure Continuous Integration (CI) in the pipeline. ,
Required: True ,
}
string ,
authorization:
{
Description: Authorization info to access the code repository. ,
Required: False ,
}
{
authorizationType:
{
Description: Type of authorization. ,
Enum:
{
personalAccessToken: No description available. ,
}
,
Required: True ,
}
enum ,
parameters:
{
Description: Authorization parameters corresponding to the authorization type. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Repository-specific properties. ,
Required: False ,
}
object ,
}
,
template:
{
Description: Template used to bootstrap the pipeline. ,
Required: True ,
}
{
id:
{
Description: Unique identifier of the pipeline template. ,
Required: True ,
}
string ,
parameters:
{
Description: Dictionary of input parameters used in the pipeline template. ,
Required: False ,
}
object ,
}
,
}
,
}
,
systemData:
{
Description: The system metadata pertaining to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Details of the error from the Pipelines Resource Provider. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error or the method where the error occurred. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Pipelines_Delete (removed)
Description :  Deletes a Pipeline.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevOps/pipelines/{pipelineName}
{
subscriptionId:
{
Description: Unique identifier of the Azure subscription. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to be used with the HTTP request. ,
Required: True ,
}
string ,
pipelineName:
{
Description: The name of the Pipeline resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Details of the error from the Pipelines Resource Provider. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error or the method where the error occurred. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Pipelines_ListByResourceGroup (removed)
Description :  Lists all Pipelines under the specified resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevOps/pipelines
{
subscriptionId:
{
Description: Unique identifier of the Azure subscription. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of pipelines. ,
Required: False ,
}
[
{
properties:
{
Description: Custom properties of the Pipeline. ,
Required: True ,
}
{
pipelineId:
{
Description: Unique identifier of the Pipeline ,
Required: False ,
}
integer ,
pipelineType:
{
Description: Specifies which CI/CD provider to use. Valid options are 'azurePipeline', 'githubWorkflow'. ,
Enum:
{
githubWorkflow: No description available. ,
azurePipeline: No description available. ,
}
,
Required: True ,
}
enum ,
bootstrapConfiguration:
{
Description: Configuration used to bootstrap the Pipeline. ,
Required: True ,
}
{
sourceRepository:
{
Description: Repository containing the source code for the pipeline. Currently only 'azurePipeline' pipeline type supports this. ,
Required: False ,
}
{
repositoryType:
{
Description: Type of code repository. ,
Enum:
{
gitHub: No description available. ,
vstsGit: No description available. ,
}
,
Required: True ,
}
enum ,
id:
{
Description: Unique immutable identifier of the code repository. ,
Required: True ,
}
string ,
defaultBranch:
{
Description: Default branch used to configure Continuous Integration (CI) in the pipeline. ,
Required: True ,
}
string ,
authorization:
{
Description: Authorization info to access the code repository. ,
Required: False ,
}
{
authorizationType:
{
Description: Type of authorization. ,
Enum:
{
personalAccessToken: No description available. ,
}
,
Required: True ,
}
enum ,
parameters:
{
Description: Authorization parameters corresponding to the authorization type. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Repository-specific properties. ,
Required: False ,
}
object ,
}
,
template:
{
Description: Template used to bootstrap the pipeline. ,
Required: True ,
}
{
id:
{
Description: Unique identifier of the pipeline template. ,
Required: True ,
}
string ,
parameters:
{
Description: Dictionary of input parameters used in the pipeline template. ,
Required: False ,
}
object ,
}
,
}
,
}
,
systemData:
{
Description: The system metadata pertaining to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of Pipelines, if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Details of the error from the Pipelines Resource Provider. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error or the method where the error occurred. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Pipelines_ListBySubscription (removed)
Description :  Lists all Pipelines under the specified subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DevOps/pipelines
{
subscriptionId:
{
Description: Unique identifier of the Azure subscription. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of pipelines. ,
Required: False ,
}
[
{
properties:
{
Description: Custom properties of the Pipeline. ,
Required: True ,
}
{
pipelineId:
{
Description: Unique identifier of the Pipeline ,
Required: False ,
}
integer ,
pipelineType:
{
Description: Specifies which CI/CD provider to use. Valid options are 'azurePipeline', 'githubWorkflow'. ,
Enum:
{
githubWorkflow: No description available. ,
azurePipeline: No description available. ,
}
,
Required: True ,
}
enum ,
bootstrapConfiguration:
{
Description: Configuration used to bootstrap the Pipeline. ,
Required: True ,
}
{
sourceRepository:
{
Description: Repository containing the source code for the pipeline. Currently only 'azurePipeline' pipeline type supports this. ,
Required: False ,
}
{
repositoryType:
{
Description: Type of code repository. ,
Enum:
{
gitHub: No description available. ,
vstsGit: No description available. ,
}
,
Required: True ,
}
enum ,
id:
{
Description: Unique immutable identifier of the code repository. ,
Required: True ,
}
string ,
defaultBranch:
{
Description: Default branch used to configure Continuous Integration (CI) in the pipeline. ,
Required: True ,
}
string ,
authorization:
{
Description: Authorization info to access the code repository. ,
Required: False ,
}
{
authorizationType:
{
Description: Type of authorization. ,
Enum:
{
personalAccessToken: No description available. ,
}
,
Required: True ,
}
enum ,
parameters:
{
Description: Authorization parameters corresponding to the authorization type. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Repository-specific properties. ,
Required: False ,
}
object ,
}
,
template:
{
Description: Template used to bootstrap the pipeline. ,
Required: True ,
}
{
id:
{
Description: Unique identifier of the pipeline template. ,
Required: True ,
}
string ,
parameters:
{
Description: Dictionary of input parameters used in the pipeline template. ,
Required: False ,
}
object ,
}
,
}
,
}
,
systemData:
{
Description: The system metadata pertaining to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of Pipelines, if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Details of the error from the Pipelines Resource Provider. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error or the method where the error occurred. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}