Check Configurations - Get

Referenz

Service:: Approvals And Checks

API Version:: 7.1-preview.1

Abrufen der Überprüfung der Konfiguration nach ID

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

With optional parameters:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
id	path	True	integer int32
organization	path	True	string	Der Name der Azure DevOps-Organisation.
project	path	True	string	Projekt-ID oder Projektname
api-version	query	True	string	Version der zu verwendenden API. Dies sollte auf "7.1-preview.1" festgelegt werden, um diese Version der API zu verwenden.
$expand	query		CheckConfigurationExpandParameter

Antworten

Name	Typ	Beschreibung
200 OK	CheckConfiguration	Erfolgreicher Vorgang

Sicherheit

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	Beschreibung
vso.build	Ermöglicht den Zugriff auf Buildartefakte, einschließlich Buildergebnissen, Definitionen und Anforderungen, sowie die Möglichkeit, Benachrichtigungen über Buildereignisse über Diensthooks zu empfangen.

Beispiele

Sample Request

HTTP

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

Sample Response

Status code:: 200

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

Response Body

{
  "createdBy": {
    "displayName": "User Name",
    "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
    "uniqueName": "uniqueName",
    "descriptor": "Descriptor"
  },
  "createdOn": "2020-11-19T10:28:46.4136508Z",
  "modifiedBy": {
    "displayName": "User Name",
    "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
    "uniqueName": "uniqueName",
    "descriptor": "Descriptor"
  },
  "modifiedOn": "2020-11-19T10:28:46.4136508Z",
  "timeout": 43200,
  "_links": {
    "self": {
      "href": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/checks/configurations/16"
    }
  },
  "id": 16,
  "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/16",
  "resource": {
    "type": "environment",
    "id": "1",
    "name": "SampleEnv"
  }
}

Definitionen

Name	Beschreibung
CheckConfiguration
CheckConfigurationExpandParameter
CheckIssue	Ein Problem (Fehler, Warnung), das einer Überprüfungskonfiguration zugeordnet ist.
CheckIssueType	Der Typ (Fehler, Warnung) des Problems.
CheckType
IdentityRef
ReferenceLinks	Die -Klasse, die eine Auflistung von REST-Verweislinks darstellt.
Resource

CheckConfiguration

Name	Typ	Beschreibung
_links	ReferenceLinks	Referenzlinks.
createdBy	IdentityRef	Identität der Person, die die Überprüfung konfiguriert hat.
createdOn	string	Zeitpunkt, zu dem die Überprüfung konfiguriert wurde.
id	integer	Überprüfen Sie die Konfigurations-ID.
isDisabled	boolean	Ist die Überprüfung deaktiviert.
issue	CheckIssue	Problem verbunden, um die Konfiguration zu überprüfen.
modifiedBy	IdentityRef	Identität der Person, die die konfigurierte Überprüfung geändert hat.
modifiedOn	string	Zeitpunkt, zu dem die konfigurierte Überprüfung geändert wurde.
resource	Resource	Ressource, für die die Überprüfung konfiguriert wird.
timeout	integer	Timeout in Minuten für die Überprüfung.
type	CheckType	Überprüfen des Konfigurationstyps
url	string	Die URL, aus der die konfigurierte Überprüfung abgerufen werden kann.

CheckConfigurationExpandParameter

Name	Typ	Beschreibung
none	string
settings	string

CheckIssue

Ein Problem (Fehler, Warnung), das einer Überprüfungskonfiguration zugeordnet ist.

Name	Typ	Beschreibung
description	string	Kurze Zusammenfassung der Überprüfung : Name und Ressource.
detailedMessage	string	Eine ausführlichere Beschreibung des Problems.
message	string	Eine Beschreibung des Problems.
type	CheckIssueType	Der Typ (Fehler, Warnung) des Problems.

CheckIssueType

Der Typ (Fehler, Warnung) des Problems.

Name	Typ	Beschreibung
error	string
warning	string

CheckType

Name	Typ	Beschreibung
id	string	Ruft die Überprüfungstyp-ID ab oder legt diese fest.
name	string	Name des Überprüfungstyps.

IdentityRef

Name	Typ	Beschreibung
_links	ReferenceLinks	Dieses Feld enthält null oder interessantere Links zum Graphthema. Diese Links können aufgerufen werden, um zusätzliche Beziehungen oder ausführlichere Informationen zu diesem Graphthema zu erhalten.
descriptor	string	Der Deskriptor ist die primäre Methode, um auf den Graph-Betreff zu verweisen, während das System ausgeführt wird. In diesem Feld wird derselbe Graph-Betreff sowohl für Konten als auch für Organisationen eindeutig identifiziert.
directoryAlias	string	Veraltet: Kann abgerufen werden, indem der Graph-Benutzer abgefragt wird, auf den im Eintrag "self" des IdentityRef-Wörterbuchs "_links" verwiesen wird.
displayName	string	Dies ist der nicht eindeutige Anzeigename des Graph-Betreffs. Um dieses Feld zu ändern, müssen Sie seinen Wert im Quellanbieter ändern.
id	string
imageUrl	string	Veraltet: Im Eintrag "avatar" des IdentityRef-Wörterbuchs "_links" verfügbar
inactive	boolean	Veraltet: Kann abgerufen werden, indem der Graph-Mitgliedschaftsstatus abgefragt wird, auf den im Eintrag "membershipState" des GraphUser-Wörterbuchs "_links" verwiesen wird.
isAadIdentity	boolean	Veraltet: Kann vom Betrefftyp des Deskriptors abgeleitet werden (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Veraltet: Kann vom Betrefftyp des Deskriptors abgeleitet werden (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Veraltet– wird in den meisten vorhandenen Implementierungen von ToIdentityRef nicht verwendet.
uniqueName	string	Veraltet: Verwenden Sie stattdessen Domain+PrincipalName.
url	string	Diese URL ist die vollständige Route zur Quellressource dieses Graph-Betreffs.

ReferenceLinks

Die -Klasse, die eine Auflistung von REST-Verweislinks darstellt.

Name	Typ	Beschreibung
links	object	Die schreibgeschützte Ansicht der Links. Da Verweislinks schreibgeschützter Sind, möchten wir sie nur als schreibgeschützter Link verfügbar machen.

Resource

Name	Typ	Beschreibung
id	string	ID der Ressource.
name	string	Der Name der Ressource.
type	string	Der Typ der Ressource.

Freigeben über