Refs - Update Ref

サービス:: Git

API バージョン:: 7.1

ブランチをロックまたはロック解除します。

PATCH https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/refs?filter={filter}&api-version=7.1

省略可能なパラメーターを含む:

PATCH https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/refs?filter={filter}&projectId={projectId}&api-version=7.1

URI パラメーター

名前	/	必須	型	説明
organization	path	True	string	Azure DevOps 組織の名前。
repositoryId	path	True	string	リポジトリの名前または ID。
project	path		string	プロジェクト ID またはプロジェクト名
api-version	query	True	string	使用する API のバージョン。このバージョンの API を使用するには、これを '7.1' に設定する必要があります。
filter	query	True	string	ロック/ロック解除するブランチの名前
projectId	query		string	チームプロジェクトの ID または名前。リポジトリの ID を指定する場合は省略可能です。

要求本文

名前	型	説明
isLocked	boolean
name	string
newObjectId	string
oldObjectId	string
repositoryId	string (uuid)

応答

名前	型	説明
200 OK	GitRef	成功した操作

セキュリティ

oauth2

型: oauth2
フロー: accessCode
Authorization URL (承認 URL): https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL (トークン 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

スコープ

名前	説明
vso.code_write	ソースコードの読み取り、更新、削除、コミット、変更セット、ブランチ、およびその他のバージョン管理成果物に関するメタデータへのアクセスを許可します。また、プル要求とコードレビューを作成および管理したり、サービスフックを介してバージョン管理イベントに関する通知を受信したりすることもできます。

名前

説明

vso.code_write

ソースコードの読み取り、更新、削除、コミット、変更セット、ブランチ、およびその他のバージョン管理成果物に関するメタデータへのアクセスを許可します。また、プル要求とコードレビューを作成および管理したり、サービスフックを介してバージョン管理イベントに関する通知を受信したりすることもできます。

例

Lock/unlock branch

要求のサンプル

HTTP

PATCH https://dev.azure.com/fabrikam/_apis/git/repositories/{repositoryId}/refs?filter=heads/master&api-version=7.1

{
  "isLocked": true
}

応答のサンプル

状態コード:: 200

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

定義

名前	説明
GitRef
GitRefUpdate
GitStatus	このクラスには、状態を投稿するサービス/拡張機能のメタデータが含まれています。
GitStatusContext	状態を一意に識別する状態コンテキスト。
GitStatusState	状態の状態。
IdentityRef
ReferenceLinks	REST 参照リンクのコレクションを表すクラス。

GitRef

Object

名前	型	説明
_links	ReferenceLinks	REST 参照リンクのコレクションを表すクラス。
creator	IdentityRef
isLocked	boolean
isLockedBy	IdentityRef
name	string
objectId	string
peeledObjectId	string
statuses	GitStatus[]	このクラスには、状態を投稿するサービス/拡張機能のメタデータが含まれています。
url	string

GitRefUpdate

Object

名前	型	説明
isLocked	boolean
name	string
newObjectId	string
oldObjectId	string
repositoryId	string (uuid)

GitStatus

Object

このクラスには、状態を投稿するサービス/拡張機能のメタデータが含まれています。

名前	型	説明
_links	ReferenceLinks	参照リンク。
context	GitStatusContext	状態のコンテキスト。
createdBy	IdentityRef	状態を作成した ID。
creationDate	string (date-time)	状態の作成日時。
description	string	状態の説明。通常、状態の現在の状態について説明します。
id	integer (int32)	状態識別子。
state	GitStatusState	状態の状態。
targetUrl	string	状態の詳細を含む URL。
updatedDate	string (date-time)	状態の最終更新日時。

GitStatusContext

Object

状態を一意に識別する状態コンテキスト。

名前	型	説明
genre	string	ステータスのジャンル。通常、状態を生成するサービス/ツールの名前は空にすることができます。
name	string	状態の名前識別子を null または空にすることはできません。

GitStatusState

列挙

状態の状態。

値	説明
notSet	状態が設定されていません。既定の状態。
pending	保留中の状態。
succeeded	状態が成功しました。
failed	状態が失敗しました。
error	エラーが発生した状態。
notApplicable	状態はターゲットオブジェクトには適用されません。

IdentityRef

Object

名前	型	説明
_links	ReferenceLinks	このフィールドには、グラフの件名に関する興味深いリンクが 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 は、このグラフの件名のソースリソースへの完全なルートです。

ReferenceLinks

Object

REST 参照リンクのコレクションを表すクラス。

名前	型	説明
links	object	リンクの読み取りビュー。参照リンクは読み取り専用であるため、読み取り専用として公開する必要があります。

フィードバック

このページはお役に立ちましたか?