Refs - Update Ref
분기를 잠그거나 잠금 해제합니다.
PATCH https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/refs?filter={filter}&api-version=5.0
PATCH https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/refs?filter={filter}&projectId={projectId}&api-version=5.0
URI 매개 변수
Name | In(다음 안에) | 필수 | 형식 | Description |
---|---|---|---|---|
organization
|
path | True |
string |
Azure DevOps 조직의 이름입니다. |
repository
|
path | True |
string |
리포지토리의 이름 또는 ID입니다. |
project
|
path |
string |
프로젝트 ID 또는 프로젝트 이름 |
|
api-version
|
query | True |
string |
사용할 API의 버전입니다. 이 버전의 api를 사용하려면 '5.0'으로 설정해야 합니다. |
filter
|
query | True |
string |
잠금/잠금 해제할 분기의 이름입니다. |
project
|
query |
string |
팀 프로젝트의 ID 또는 이름입니다. 리포지토리에 대한 ID를 지정하는 경우 선택 사항입니다. |
요청 본문
Name | 형식 | Description |
---|---|---|
isLocked |
boolean |
|
name |
string |
|
newObjectId |
string |
|
oldObjectId |
string |
|
repositoryId |
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.code_write | 소스 코드를 읽고, 업데이트하고, 삭제하고, 커밋, 변경 집합, 분기 및 기타 버전 제어 아티팩트에 대한 메타데이터에 액세스하는 기능을 부여합니다. 또한 끌어오기 요청 및 코드 검토를 만들고 관리하고 서비스 후크를 통해 버전 제어 이벤트에 대한 알림을 받을 수 있는 기능도 부여합니다. |
예제
Lock/unlock branch
Sample Request
PATCH https://dev.azure.com/fabrikam/_apis/git/repositories/{repositoryId}/refs?filter=heads/master&api-version=5.0
{
"isLocked": true
}
Sample Response
{
"name": "refs/heads/master",
"objectId": "ffe9cba521f00d7f60e322845072238635edb451",
"isLockedBy": {
"displayName": "Normal Paulk",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/ac5aaba6-a66a-4e1d-b508-b060ec624fa9",
"_links": {
"avatar": {
"href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YmFjMGYyZDctNDA3ZC03OGRhLTlhMjUtNmJhZjUwMWFjY2U5"
}
},
"id": "ac5aaba6-a66a-4e1d-b508-b060ec624fa9",
"uniqueName": "dev@mailserver.com",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=ac5aaba6-a66a-4e1d-b508-b060ec624fa9",
"descriptor": "aad.YmFjMGYyZDctNDA3ZC03OGRhLTlhMjUtNmJhZjUwMWFjY2U5"
},
"isLocked": true,
"creator": {
"displayName": "Normal Paulk",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/ac5aaba6-a66a-4e1d-b508-b060ec624fa9",
"_links": {
"avatar": {
"href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YmFjMGYyZDctNDA3ZC03OGRhLTlhMjUtNmJhZjUwMWFjY2U5"
}
},
"id": "ac5aaba6-a66a-4e1d-b508-b060ec624fa9",
"uniqueName": "dev@mailserver.com",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=ac5aaba6-a66a-4e1d-b508-b060ec624fa9",
"descriptor": "aad.YmFjMGYyZDctNDA3ZC03OGRhLTlhMjUtNmJhZjUwMWFjY2U5"
},
"url": "https://dev.azure.com/fabrikam/7484f783-66a3-4f27-b7cd-6b08b0b077ed/_apis/git/repositories/d3d1760b-311c-4175-a726-20dfc6a7f885/refs?filter=heads%2Fmaster"
}
정의
Name | Description |
---|---|
Git |
|
Git |
|
Git |
이 클래스에는 상태 게시하는 서비스/확장의 메타데이터가 포함됩니다. |
Git |
상태 고유하게 식별하는 상태 컨텍스트입니다. |
Git |
상태 상태입니다. |
Identity |
|
Reference |
REST 참조 링크의 컬렉션을 나타내는 클래스입니다. |
GitRef
Name | 형식 | Description |
---|---|---|
_links |
REST 참조 링크의 컬렉션을 나타내는 클래스입니다. |
|
creator | ||
isLocked |
boolean |
|
isLockedBy | ||
name |
string |
|
objectId |
string |
|
peeledObjectId |
string |
|
statuses |
이 클래스에는 상태 게시하는 서비스/확장의 메타데이터가 포함됩니다. |
|
url |
string |
GitRefUpdate
Name | 형식 | Description |
---|---|---|
isLocked |
boolean |
|
name |
string |
|
newObjectId |
string |
|
oldObjectId |
string |
|
repositoryId |
string |
GitStatus
이 클래스에는 상태 게시하는 서비스/확장의 메타데이터가 포함됩니다.
Name | 형식 | Description |
---|---|---|
_links |
참조 링크. |
|
context |
상태 컨텍스트입니다. |
|
createdBy |
상태 만든 ID입니다. |
|
creationDate |
string |
상태 생성 날짜 및 시간입니다. |
description |
string |
상태 설명입니다. 일반적으로 상태 현재 상태를 설명합니다. |
id |
integer |
상태 식별자입니다. |
state |
상태 상태입니다. |
|
targetUrl |
string |
상태 세부 정보가 포함된 URL입니다. |
updatedDate |
string |
상태 마지막 업데이트 날짜 및 시간입니다. |
GitStatusContext
상태 고유하게 식별하는 상태 컨텍스트입니다.
Name | 형식 | Description |
---|---|---|
genre |
string |
상태 장르. 일반적으로 상태 생성하는 서비스/도구의 이름은 비어 있을 수 있습니다. |
name |
string |
상태 이름 식별자는 null이거나 비워 둘 수 없습니다. |
GitStatusState
상태 상태입니다.
Name | 형식 | Description |
---|---|---|
error |
string |
오류가 있는 상태입니다. |
failed |
string |
상태가 실패했습니다. |
notApplicable |
string |
상태는 대상 개체에 적용되지 않습니다. |
notSet |
string |
상태 상태가 설정되지 않았습니다. 기본 상태입니다. |
pending |
string |
보류 중인 상태입니다. |
succeeded |
string |
상태가 성공했습니다. |
IdentityRef
Name | 형식 | Description |
---|---|---|
_links |
이 필드에는 그래프 제목에 대한 0개 이상의 흥미로운 링크가 포함되어 있습니다. 이러한 링크를 호출하여 이 그래프 제목에 대한 추가 관계 또는 자세한 정보를 얻을 수 있습니다. |
|
descriptor |
string |
설명자는 시스템이 실행되는 동안 그래프 제목을 참조하는 기본 방법입니다. 이 필드는 계정과 조직 모두에서 동일한 그래프 제목을 고유하게 식별합니다. |
directoryAlias |
string |
|
displayName |
string |
그래프 주체의 고유하지 않은 표시 이름입니다. 이 필드를 변경하려면 원본 공급자에서 해당 값을 변경해야 합니다. |
id |
string |
|
imageUrl |
string |
|
inactive |
boolean |
|
isAadIdentity |
boolean |
|
isContainer |
boolean |
|
isDeletedInOrigin |
boolean |
|
profileUrl |
string |
|
uniqueName |
string |
|
url |
string |
이 URL은 이 그래프 주체의 원본 리소스에 대한 전체 경로입니다. |
ReferenceLinks
REST 참조 링크의 컬렉션을 나타내는 클래스입니다.
Name | 형식 | Description |
---|---|---|
links |
object |
링크의 읽기 전용 보기입니다. 참조 링크는 읽기 전용이므로 읽기 전용으로만 노출하려고 합니다. |