Check Configurations - Update

Reference

Service:: Approvals And Checks

API Version:: 7.1-preview.1

Update check configuration

PATCH https://dev.azure.com/{organization}/{project}/_apis/pipelines/checks/configurations/{id}?api-version=7.1-preview.1

URI Parameters

Name	In	Required	Type	Description
id	path	True	integer int32	check configuration id
organization	path	True	string	The name of the Azure DevOps organization.
project	path	True	string	Project ID or project name
api-version	query	True	string	Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.

Request Body

Name	Type	Description
_links	ReferenceLinks	Reference links.
createdBy	IdentityRef	Identity of person who configured check.
createdOn	string	Time when check got configured.
id	integer	Check configuration id.
isDisabled	boolean	Is check disabled.
issue	CheckIssue	Issue connected to check configuration.
modifiedBy	IdentityRef	Identity of person who modified the configured check.
modifiedOn	string	Time when configured check was modified.
resource	Resource	Resource on which check get configured.
timeout	integer	Timeout in minutes for the check.
type	CheckType	Check configuration type
url	string	The URL from which one can fetch the configured check.

Responses

Name	Type	Description
200 OK	CheckConfiguration	successful operation

Security

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Scopes

Name	Description
vso.build_execute	Grants the ability to access build artifacts, including build results, definitions, and requests, and the ability to queue a build, update build properties, and the ability to receive notifications about build events via service hooks.
vso.pipelineresources_manage	Grants the ability to manage a protected resource or a pipeline's request to use a protected resource: agent pool, environment, queue, repository, secure files, service connection, and variable group

Examples

Sample request

HTTP

PATCH https://dev.azure.com/{organization}/{project}/_apis/pipelines/checks/configurations/{id}?api-version=7.1-preview.1

{
  "settings": {
    "displayName": "Business Hours Updated",
    "definitionRef": {
      "id": "445fde2f-6c39-441c-807f-8a59ff2e075f",
      "name": "evaluateBusinessHours",
      "version": "0.0.1"
    },
    "inputs": {
      "businessDays": "Monday,Tuesday,Wednesday,Thursday,Friday",
      "timeZone": "UTC",
      "startTime": "04:00",
      "endTime": "12:00"
    },
    "retryInterval": 5
  },
  "timeout": 43200,
  "type": {
    "id": "fe1de3ee-a436-41b4-bb20-f6eb4cb879a7",
    "name": "Task Check"
  },
  "resource": {
    "type": "queue",
    "id": "1",
    "name": "Default"
  }
}

Sample response

Status code:: 200

request-Context: appId=cid-v1:a892bfef-0287-4640-9f5e-cffc90fbcf94
access-Control-Expose-Headers: Request-Context

{
  "settings": {
    "displayName": "Business Hours Updated",
    "definitionRef": {
      "id": "445fde2f-6c39-441c-807f-8a59ff2e075f",
      "name": "evaluateBusinessHours",
      "version": "0.0.1"
    },
    "inputs": {
      "businessDays": "Monday,Tuesday,Wednesday,Thursday,Friday",
      "timeZone": "UTC",
      "startTime": "04:00",
      "endTime": "12:00"
    },
    "retryInterval": 5
  },
  "createdBy": {
    "displayName": "User Name",
    "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
    "uniqueName": "uniqueName",
    "descriptor": "Descriptor"
  },
  "createdOn": "2020-11-19T11:50:29.2550665Z",
  "modifiedBy": {
    "displayName": "User Name",
    "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
    "uniqueName": "uniqueName",
    "descriptor": "Descriptor"
  },
  "modifiedOn": "2020-11-19T12:26:25.7610862Z",
  "timeout": 43200,
  "_links": {
    "self": {
      "href": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/checks/configurations/27"
    }
  },
  "id": 27,
  "type": {
    "id": "fe1de3ee-a436-41b4-bb20-f6eb4cb879a7",
    "name": "Task Check"
  },
  "url": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/checks/configurations/27",
  "resource": {
    "type": "queue",
    "id": "1",
    "name": "Default"
  }
}

Definitions

Name	Description
CheckConfiguration
CheckIssue	An issue (error, warning) associated with a check configuration.
CheckIssueType	The type (error, warning) of the issue.
CheckType
IdentityRef
ReferenceLinks	The class to represent a collection of REST reference links.
Resource

CheckConfiguration

Name	Type	Description
_links	ReferenceLinks	Reference links.
createdBy	IdentityRef	Identity of person who configured check.
createdOn	string	Time when check got configured.
id	integer	Check configuration id.
isDisabled	boolean	Is check disabled.
issue	CheckIssue	Issue connected to check configuration.
modifiedBy	IdentityRef	Identity of person who modified the configured check.
modifiedOn	string	Time when configured check was modified.
resource	Resource	Resource on which check get configured.
timeout	integer	Timeout in minutes for the check.
type	CheckType	Check configuration type
url	string	The URL from which one can fetch the configured check.

CheckIssue

An issue (error, warning) associated with a check configuration.

Name	Type	Description
description	string	Short summary of the check - its name and resource.
detailedMessage	string	A more detailed description of issue.
message	string	A description of issue.
type	CheckIssueType	The type (error, warning) of the issue.

CheckIssueType

The type (error, warning) of the issue.

Name	Type	Description
error	string
warning	string

CheckType

Name	Type	Description
id	string	Gets or sets check type id.
name	string	Name of the check type.

IdentityRef

Name	Type	Description
_links	ReferenceLinks	This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject.
descriptor	string	The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.
directoryAlias	string	Deprecated - Can be retrieved by querying the Graph user referenced in the "self" entry of the IdentityRef "_links" dictionary
displayName	string	This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.
id	string
imageUrl	string	Deprecated - Available in the "avatar" entry of the IdentityRef "_links" dictionary
inactive	boolean	Deprecated - Can be retrieved by querying the Graph membership state referenced in the "membershipState" entry of the GraphUser "_links" dictionary
isAadIdentity	boolean	Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Deprecated - not in use in most preexisting implementations of ToIdentityRef
uniqueName	string	Deprecated - use Domain+PrincipalName instead
url	string	This url is the full route to the source resource of this graph subject.

ReferenceLinks

The class to represent a collection of REST reference links.

Name	Type	Description
links	object	The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.

Resource

Name	Type	Description
id	string	Id of the resource.
name	string	Name of the resource.
type	string	Type of the resource.

Share via