Feed Management - Get Feed

服務:

Artifacts

API 版本:

7.1

取得特定摘要的設定。

如果在專案中建立摘要，則必須提供項目參數。 如果摘要未與任何專案相關聯，請省略要求中的項目參數。

GET https://feeds.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId}?api-version=7.1

含選擇性參數:

GET https://feeds.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId}?includeDeletedUpstreams={includeDeletedUpstreams}&api-version=7.1

URI 參數

名稱	位於	必要	類型	Description
feedId	path	True	string	摘要的名稱或識別碼。
organization	path	True	string	Azure DevOps 組織的名稱。
project	path		string	項目識別碼或項目名稱
api-version	query	True	string	要使用的 API 版本。 這應該設定為 『7.1』 以使用此版本的 API。
includeDeletedUpstreams	query		boolean	包含已在回應中刪除的上游。

回應

名稱	類型	Description
200 OK	Feed	成功作業

安全性

oauth2

類型: oauth2
Flow: accessCode
授權 URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
權杖 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

範圍

名稱	Description
vso.packaging	授與讀取摘要和套件的能力。 同時授與搜尋套件的能力。

定義

名稱	Description
Feed	成品的容器。
FeedCapabilities	摘要的支援功能。
FeedPermission	摘要的許可權。
FeedRole	摘要上此身分識別的角色。
FeedView	摘要頂端的檢視。
FeedViewType	檢視的類型。
FeedVisibility	檢視的可見性狀態。
IdentityDescriptor	身分識別描述元是識別類型 （Windows SID， Passport） 的包裝函式，以及 SID 或 PUID 等唯一識別碼。
ProjectReference
ReferenceLinks	表示 REST 參考連結集合的類別。
UpstreamSource	上游來源定義，包括其身分識別、套件類型和其他相關聯的資訊。
UpstreamSourceType	來源類型，例如公用或內部。
UpstreamStatus	指定上游的狀態。
UpstreamStatusDetail

Feed

Object

成品的容器。

名稱	類型	Description
_links	ReferenceLinks	相關的 REST 連結。
badgesEnabled	boolean	如果設定，此摘要支援產生套件徽章。
capabilities	FeedCapabilities	摘要的支援功能。
defaultViewId	string (uuid)	摘要管理員已指出的檢視是讀取者的默認體驗。
deletedDate	string (date-time)	刪除此摘要的日期。
description	string	摘要的描述。 描述不得超過 255 個字元。
fullyQualifiedId	string	這會是摘要 GUID 或摘要 GUID，並根據摘要的存取方式來檢視 GUID。
fullyQualifiedName	string	檢視的完整名稱，格式為 feed@view。
hideDeletedPackageVersions	boolean	如果設定，摘要將會隱藏所有已刪除/未發佈的版本
id	string (uuid)	可唯一識別此摘要的 GUID。
isReadOnly	boolean	如果設定，摘要中的所有套件都是固定的。 請務必注意摘要檢視是不可變的;因此，一律會針對檢視設定此旗標。
name	string	摘要的名稱。 摘要名稱必須遵循下列規則： <list type=“bullet”><項目><說明> 不得超過 64 個字元 </description></item><item><description> 不得包含空格 </description></item><item><description> 不得以底線或句點<開頭 /description></item><item description> 不得以句點結尾 /description/item item><description 不得以句點<結尾 /description></item><item><description>不得包含下列任何非法字元：、|、/、\\、？、：、&、$、*、\“、#、[、] ]]></description></item></list>
permanentDeletedDate	string (date-time)	永久刪除此摘要的日期。
permissions	FeedPermission[]	摘要的明確許可權。
project	ProjectReference	此摘要相關聯的專案。
scheduledPermanentDeleteDate	string (date-time)	此摘要排定永久刪除的日期。
upstreamEnabled	boolean	這應該一律為 true。 將 設定為 false 將會覆寫 UpstreamSources 中的所有來源。
upstreamEnabledChangedDate	string (date-time)	如果已設定，則為UpstreamEnabled屬性變更的時間。 如果在建立摘要之後從未變更 UpstreamEnabled，則為 Null。
upstreamSources	UpstreamSource[]	此摘要會從中擷取套件的來源清單。 空白清單表示此摘要不會搜尋套件的任何其他來源。
url	string	GUID 表單中基底摘要的 URL。
view	FeedView	檢視的定義。
viewId	string (uuid)	檢視標識碼。
viewName	string	檢視名稱。

FeedCapabilities

列舉型別

摘要的支援功能。

值	Description
none	此摘要沒有旗標
upstreamV2	此摘要可以提供上游來源的套件上游套件必須手動升階為檢視
underMaintenance	此摘要目前處於維護中，且功能可能已降低
defaultCapabilities	提供給新建立摘要的功能

FeedPermission

Object

摘要的許可權。

名稱	類型	Description
displayName	string	識別的顯示名稱。
identityDescriptor	IdentityDescriptor	與此角色相關聯的身分識別。
identityId	string (uuid)	與此角色相關聯的身分識別標識碼。
isInheritedRole	boolean	布爾值，指出角色是繼承還是直接設定。
role	FeedRole	摘要上此身分識別的角色。

FeedRole

列舉型別

摘要上此身分識別的角色。

值	Description
custom	支援。
none	支援。
reader	讀取器只能讀取套件和檢視設定。
contributor	參與者可以對摘要中的套件執行任何動作，包括新增套件，但可能不會修改摘要設定。
administrator	系統管理員可以完全控制摘要。
collaborator	共同作業者具有與讀取者相同的許可權，但也可以從已設定的上游來源內嵌套件。

FeedView

Object

摘要頂端的檢視。

名稱	類型	Description
_links	ReferenceLinks	相關的 REST 連結。
id	string (uuid)	檢視的標識碼。
name	string	檢視的名稱。
type	FeedViewType	檢視的類型。
url	string	檢視的 URL。
visibility	FeedVisibility	檢視的可見性狀態。

FeedViewType

列舉型別

檢視的類型。

值	Description
none	預設、未指定的檢視類型。
release	用來分類已發行成品的升階目的地檢視。
implicit	系統自動建立和管理的內部檢視類型。

FeedVisibility

列舉型別

檢視的可見性狀態。

值	Description
private	只有摘要管理員明確設定的許可權才能存取。
collection	摘要可供存在於摘要所在組織中的所有有效使用者存取（例如，跨組織 'myorg' 在 'dev.azure.com/myorg' ）
organization	摘要可供存在於摘要所在企業中的所有有效使用者存取。 請注意，舊版命名和備份相容性會讓此值的名稱與其新意義不同步。
aadTenant	摘要可供存在於 Azure Active Directory 租使用者中的所有有效使用者存取。

IdentityDescriptor

Object

身分識別描述元是識別類型 （Windows SID， Passport） 的包裝函式，以及 SID 或 PUID 等唯一識別碼。

名稱	類型	Description
identifier	string	此身分識別的唯一標識符，不超過 256 個字元，這會保存。
identityType	string	描述項的類型（例如 Windows、Passport 等）。

ProjectReference

Object

名稱	類型	Description
id	string (uuid)	取得或設定項目的標識碼。
name	string	取得或設定項目的名稱。
visibility	string	取得或設定項目的可見性。

ReferenceLinks

Object

表示 REST 參考連結集合的類別。

名稱	類型	Description
links	object	連結的只讀檢視。 因為參考連結是只讀的，所以我們只想要將其公開為只讀。

UpstreamSource

Object

上游來源定義，包括其身分識別、套件類型和其他相關聯的資訊。

名稱	類型	Description
deletedDate	string (date-time)	刪除此上游的 UTC 日期。
displayLocation	string	以使用者易記格式連線到上游來源的定位器，可能會隨著時間而變更
id	string (uuid)	上游來源的身分識別。
internalUpstreamCollectionId	string (uuid)	針對內部上游類型，追蹤包含它的 Azure DevOps 組織。
internalUpstreamFeedId	string (uuid)	針對內部上游類型，追蹤所參考的摘要標識符。
internalUpstreamProjectId	string (uuid)	針對內部上游類型，追蹤所參考摘要的專案。
internalUpstreamViewId	string (uuid)	針對內部上游類型，追蹤所參考摘要的檢視。
location	string	線上到上游來源的一致定位器。
name	string	顯示名稱。
protocol	string	與上游來源相關聯的封裝類型。
serviceEndpointId	string (uuid)	服務端點的身分識別，保存存取上游時要使用的認證。
serviceEndpointProjectId	string (uuid)	指定服務端點的 projectId。
status	UpstreamStatus	指定上游的狀態。
statusDetails	UpstreamStatusDetail[]	提供上游狀態的人類可讀取原因。
upstreamSourceType	UpstreamSourceType	來源類型，例如公用或內部。

UpstreamSourceType

列舉型別

來源類型，例如公用或內部。

值	Description
public	公開可用的來源。
internal	Azure DevOps 上游來源。

UpstreamStatus

列舉型別

指定上游的狀態。

值	Description
ok	上游來源正常。
disabled	上游來源已停用。

UpstreamStatusDetail

Object

名稱	類型	Description
reason	string	提供上游狀態的人類可讀取原因。