Subscriptions - Create Subscriptions Query
서비스 후크 구독에 대한 쿼리입니다.
POST https://dev.azure.com/{organization}/_apis/hooks/subscriptionsquery?api-version=7.1-preview.1URI 매개 변수
| Name | In(다음 안에) | 필수 | 형식 | Description |
|---|---|---|---|---|
|
organization
|
path | True |
string |
Azure DevOps 조직의 이름입니다. |
|
api-version
|
query | True |
string |
사용할 API의 버전입니다. 이 버전의 api를 사용하려면 '7.1-preview.1'로 설정해야 합니다. |
요청 본문
| Name | 형식 | Description |
|---|---|---|
| consumerActionId |
string |
결과를 제한하는 선택적 소비자 작업 ID입니다(모든 항목의 경우 null). |
| consumerId |
string |
결과를 제한하는 선택적 소비자 ID입니다(모든 항목의 경우 null). |
| consumerInputFilters |
구독 소비자 입력에 대한 필터 |
|
| eventType |
string |
결과를 제한하는 선택적 이벤트 유형 ID입니다(모든 경우 null). |
| publisherId |
string |
결과를 제한하는 선택적 게시자 ID입니다(모든 경우 null). |
| publisherInputFilters |
구독 게시자 입력에 대한 필터 |
|
| results |
쿼리 결과 |
|
| subscriberId |
string |
선택적 구독자 필터입니다. |
응답
| Name | 형식 | Description |
|---|---|---|
| 200 OK |
성공한 작업 |
보안
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.work | 작업 항목, 쿼리, 보드, 영역 및 반복 경로 및 기타 작업 항목 추적 관련 메타데이터를 읽을 수 있는 기능을 부여합니다. 또한 쿼리를 실행하고, 작업 항목을 검색하고, 서비스 후크를 통해 작업 항목 이벤트에 대한 알림을 받을 수 있는 기능을 부여합니다. |
| vso.build | 빌드 결과, 정의 및 요청을 포함하여 빌드 아티팩트 액세스 기능과 서비스 후크를 통해 빌드 이벤트에 대한 알림을 받을 수 있는 기능을 부여합니다. |
| vso.code | 커밋, 변경 집합, 분기 및 기타 버전 제어 아티팩트에 대한 소스 코드 및 메타데이터를 읽을 수 있는 기능을 부여합니다. 또한 서비스 후크를 통해 코드를 검색하고 버전 제어 이벤트에 대한 알림을 받을 수 있는 기능도 부여합니다. |
정의
| Name | Description |
|---|---|
|
Identity |
|
|
Input |
구독 입력에 대한 필터를 정의합니다. 필터는 그룹의 하나 이상이 true로 평가되는 경우 입력 집합과 일치합니다. |
|
Input |
구독 입력 목록을 필터링하기 위해 적용할 수 있는 식입니다. |
|
Input |
예상된 입력 값과 실제 입력 값 사이에 적용된 연산자 |
|
Reference |
REST 참조 링크의 컬렉션을 나타내는 클래스입니다. |
| Subscription |
이벤트 구독을 캡슐화합니다. |
|
Subscriptions |
서비스 후크 구독에 대한 쿼리를 정의합니다. |
|
Subscription |
IdentityRef
| Name | 형식 | Description |
|---|---|---|
| _links |
이 필드에는 그래프 제목에 대한 0개 이상의 흥미로운 링크가 포함되어 있습니다. 이러한 링크를 호출하여 이 그래프 제목에 대한 추가 관계 또는 자세한 정보를 얻을 수 있습니다. |
|
| descriptor |
string |
설명자는 시스템이 실행되는 동안 그래프 제목을 참조하는 기본 방법입니다. 이 필드는 계정과 조직 모두에서 동일한 그래프 제목을 고유하게 식별합니다. |
| directoryAlias |
string |
사용되지 않음 - IdentityRef "_links" 사전의 "자체" 항목에서 참조된 Graph 사용자를 쿼리하여 검색할 수 있습니다. |
| displayName |
string |
그래프 주체의 고유하지 않은 표시 이름입니다. 이 필드를 변경하려면 원본 공급자에서 해당 값을 변경해야 합니다. |
| id |
string |
|
| imageUrl |
string |
사용되지 않음 - IdentityRef "_links" 사전의 "아바타" 항목에서 사용할 수 있습니다. |
| inactive |
boolean |
사용되지 않음 - GraphUser "_links" 사전의 "membershipState" 항목에서 참조되는 Graph 멤버 자격 상태를 쿼리하여 검색할 수 있습니다. |
| isAadIdentity |
boolean |
사용되지 않음 - 설명자의 주체 형식(Descriptor.IsAadUserType/Descriptor.IsAadGroupType)에서 유추할 수 있습니다. |
| isContainer |
boolean |
사용되지 않음 - 설명자의 주체 형식에서 유추할 수 있음(Descriptor.IsGroupType) |
| isDeletedInOrigin |
boolean |
|
| profileUrl |
string |
사용되지 않음 - ToIdentityRef의 대부분의 기존 구현에서 사용되지 않음 |
| uniqueName |
string |
사용되지 않음 - 대신 Domain+PrincipalName 사용 |
| url |
string |
이 URL은 이 그래프 주체의 원본 리소스에 대한 전체 경로입니다. |
InputFilter
구독 입력에 대한 필터를 정의합니다. 필터는 그룹의 하나 이상이 true로 평가되는 경우 입력 집합과 일치합니다.
| Name | 형식 | Description |
|---|---|---|
| conditions |
입력 필터 식의 그룹입니다. 이 필터는 그룹의 하나 이상이 true로 평가되는 경우 입력 집합과 일치합니다. |
InputFilterCondition
구독 입력 목록을 필터링하기 위해 적용할 수 있는 식입니다.
| Name | 형식 | Description |
|---|---|---|
| caseSensitive |
boolean |
대/소문자 구분 일치를 수행할지 여부 |
| inputId |
string |
필터링할 입력의 ID |
| inputValue |
string |
실제 입력 값과 비교할 "예상" 입력 값입니다. |
| operator |
예상된 입력 값과 실제 입력 값 사이에 적용된 연산자 |
InputFilterOperator
예상된 입력 값과 실제 입력 값 사이에 적용된 연산자
| Name | 형식 | Description |
|---|---|---|
| equals |
string |
|
| notEquals |
string |
ReferenceLinks
REST 참조 링크의 컬렉션을 나타내는 클래스입니다.
| Name | 형식 | Description |
|---|---|---|
| links |
object |
링크의 읽기 전용 보기입니다. 참조 링크는 읽기 전용이므로 읽기 전용으로만 노출하려고 합니다. |
Subscription
이벤트 구독을 캡슐화합니다.
| Name | 형식 | Description |
|---|---|---|
| _links |
참조 링크 |
|
| actionDescription |
string |
|
| consumerActionId |
string |
|
| consumerId |
string |
|
| consumerInputs |
object |
소비자 입력 값 |
| createdBy | ||
| createdDate |
string |
|
| eventDescription |
string |
|
| eventType |
string |
|
| id |
string |
|
| lastProbationRetryDate |
string |
|
| modifiedBy | ||
| modifiedDate |
string |
|
| probationRetries |
string |
|
| publisherId |
string |
|
| publisherInputs |
object |
게시자 입력 값 |
| resourceVersion |
string |
|
| status | ||
| subscriber | ||
| url |
string |
SubscriptionsQuery
서비스 후크 구독에 대한 쿼리를 정의합니다.
| Name | 형식 | Description |
|---|---|---|
| consumerActionId |
string |
결과를 제한하는 선택적 소비자 작업 ID입니다(모든 항목의 경우 null). |
| consumerId |
string |
결과를 제한하는 선택적 소비자 ID입니다(모든 항목의 경우 null). |
| consumerInputFilters |
구독 소비자 입력에 대한 필터 |
|
| eventType |
string |
결과를 제한하는 선택적 이벤트 유형 ID입니다(모든 경우 null). |
| publisherId |
string |
결과를 제한하는 선택적 게시자 ID입니다(모든 경우 null). |
| publisherInputFilters |
구독 게시자 입력에 대한 필터 |
|
| results |
쿼리 결과 |
|
| subscriberId |
string |
선택적 구독자 필터입니다. |
SubscriptionStatus
| Name | 형식 | Description |
|---|---|---|
| disabledByInactiveIdentity |
string |
소유자가 비활성 상태이거나 권한이 없으므로 구독을 사용할 수 없습니다. |
| disabledBySystem |
string |
시스템에서 구독을 사용할 수 없습니다. |
| disabledByUser |
string |
사용자가 구독을 사용할 수 없습니다. |
| enabled |
string |
구독을 사용할 수 있습니다. |
| onProbation |
string |
구독은 시스템에서 일시적으로 보호 관찰 중입니다. |