Check Configurations - Update

Referência

Service:: Approvals And Checks

API Version:: 7.1-preview.1

Atualizar marcar configuração

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
id	path	True	integer int32	marcar id de configuração
organization	path	True	string	O nome da organização do Azure DevOps.
project	path	True	string	ID do projeto ou nome do projeto
api-version	query	True	string	Versão da API a ser usada. Isso deve ser definido como '7.1-preview.1' para usar essa versão da api.

Corpo da solicitação

Nome	Tipo	Description
_links	ReferenceLinks	Links de referência.
createdBy	IdentityRef	Identidade da pessoa que configurou marcar.
createdOn	string	Hora em que marcar foi configurado.
id	integer	Verifique a ID de configuração.
isDisabled	boolean	Está marcar desabilitado.
issue	CheckIssue	Problema conectado à configuração de marcar.
modifiedBy	IdentityRef	Identidade da pessoa que modificou o marcar configurado.
modifiedOn	string	A hora em que o marcar foi configurado foi modificado.
resource	Resource	Recurso no qual marcar ser configurado.
timeout	integer	Tempo limite em minutos para o marcar.
type	CheckType	Verificar o tipo de configuração
url	string	A URL da qual é possível buscar o marcar configurado.

Respostas

Nome	Tipo	Description
200 OK	CheckConfiguration	operação bem-sucedida

Segurança

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

Nome	Description
vso.build_execute	Concede a capacidade de acessar artefatos de build, incluindo resultados de build, definições e solicitações e a capacidade de enfileirar um build, atualizar propriedades de build e a capacidade de receber notificações sobre eventos de build por meio de ganchos de serviço.
vso.pipelineresources_manage	Concede a capacidade de gerenciar um recurso protegido ou uma solicitação de pipeline para usar um recurso protegido: pool de agentes, ambiente, fila, repositório, arquivos seguros, conexão de serviço e grupo de variáveis

Exemplos

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

Response Body

{
  "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"
  }
}

Definições

Nome	Description
CheckConfiguration
CheckIssue	Um problema (erro, aviso) associado a uma configuração de marcar.
CheckIssueType	O tipo (erro, aviso) do problema.
CheckType
IdentityRef
ReferenceLinks	A classe para representar uma coleção de links de referência REST.
Resource

CheckConfiguration

Nome	Tipo	Description
_links	ReferenceLinks	Links de referência.
createdBy	IdentityRef	Identidade da pessoa que configurou marcar.
createdOn	string	Hora em que marcar foi configurado.
id	integer	Verifique a ID de configuração.
isDisabled	boolean	Está marcar desabilitado.
issue	CheckIssue	Problema conectado à configuração de marcar.
modifiedBy	IdentityRef	Identidade da pessoa que modificou o marcar configurado.
modifiedOn	string	A hora em que o marcar foi configurado foi modificado.
resource	Resource	Recurso no qual marcar ser configurado.
timeout	integer	Tempo limite em minutos para o marcar.
type	CheckType	Verificar o tipo de configuração
url	string	A URL da qual é possível buscar o marcar configurado.

CheckIssue

Um problema (erro, aviso) associado a uma configuração de marcar.

Nome	Tipo	Description
description	string	Resumo curto do marcar – seu nome e recurso.
detailedMessage	string	Uma descrição mais detalhada do problema.
message	string	Uma descrição do problema.
type	CheckIssueType	O tipo (erro, aviso) do problema.

CheckIssueType

O tipo (erro, aviso) do problema.

Nome	Tipo	Description
error	string
warning	string

CheckType

Nome	Tipo	Description
id	string	Obtém ou define marcar id do tipo.
name	string	Nome do tipo marcar.

IdentityRef

Nome	Tipo	Description
_links	ReferenceLinks	Esse campo contém zero ou mais links interessantes sobre o assunto do grafo. Esses links podem ser invocados para obter relações adicionais ou informações mais detalhadas sobre esse assunto do grafo.
descriptor	string	O descritor é a principal maneira de referenciar o assunto do grafo enquanto o sistema está em execução. Esse campo identificará exclusivamente o mesmo assunto de grafo entre contas e organizações.
directoryAlias	string	Preterido – pode ser recuperado consultando o usuário do Graph referenciado na entrada "self" do dicionário IdentityRef "_links"
displayName	string	Esse é o nome de exibição não exclusivo do assunto do grafo. Para alterar esse campo, você deve alterar seu valor no provedor de origem.
id	string
imageUrl	string	Preterido – Disponível na entrada "avatar" do dicionário IdentityRef "_links"
inactive	boolean	Preterido – pode ser recuperado consultando o estado de associação do Graph referenciado na entrada "membershipState" do dicionário "_links" do GraphUser
isAadIdentity	boolean	Preterido – pode ser inferido do tipo de assunto do descritor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Preterido – pode ser inferido do tipo de assunto do descritor (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Preterido – não em uso na maioria das implementações preexistir de ToIdentityRef
uniqueName	string	Preterido – use Domain+PrincipalName em vez disso
url	string	Essa URL é a rota completa para o recurso de origem desta entidade de grafo.

ReferenceLinks

A classe para representar uma coleção de links de referência REST.

Nome	Tipo	Description
links	object	A exibição somente leitura dos links. Como os links de referência são somente leitura, só queremos expô-los como somente leitura.

Resource

Nome	Tipo	Description
id	string	Id do recurso.
name	string	Nome do recurso.
type	string	Tipo do recurso.

Partilhar via