Feed Management - Get Feed
取得特定摘要的設定。
如果在專案中建立摘要,則必須提供專案參數。 如果摘要未與任何專案相關聯,請省略要求中的專案參數。
GET https://feeds.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId}?api-version=7.1-preview.1
GET https://feeds.dev.azure.com/{organization}/{project}/_apis/packaging/feeds/{feedId}?includeDeletedUpstreams={includeDeletedUpstreams}&api-version=7.1-preview.1
URI 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
feed
|
path | True |
string |
摘要的名稱或識別碼。 |
organization
|
path | True |
string |
Azure DevOps 組織的名稱。 |
project
|
path |
string |
專案識別碼或專案名稱 |
|
api-version
|
query | True |
string |
要使用的 API 版本。 這應該設定為 '7.1-preview.1' 以使用此版本的 API。 |
include
|
query |
boolean |
包含已在回應中刪除的上游。 |
回應
名稱 | 類型 | 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
名稱 | Description |
---|---|
vso.packaging | 授與讀取摘要和套件的能力。 同時授與搜尋套件的能力。 |
定義
名稱 | Description |
---|---|
Feed |
成品的容器。 |
Feed |
摘要的支援功能。 |
Feed |
摘要的許可權。 |
Feed |
此身分識別在摘要上的角色。 |
Feed |
摘要頂端的檢視。 |
Feed |
檢視的類型。 |
Feed |
檢視的可見度狀態。 |
Identity |
身分識別描述元是識別類型的包裝函式, (Windows SID、Passport) 以及 SID 或 PUID 等唯一識別碼。 |
Project |
|
Reference |
表示 REST 參考連結集合的類別。 |
Upstream |
上游來源定義,包括其身分識別、套件類型和其他相關資訊。 |
Upstream |
來源類型,例如公用或內部。 |
Upstream |
指定上游的狀態。 |
Upstream |
Feed
成品的容器。
名稱 | 類型 | Description |
---|---|---|
_links |
相關的 REST 連結。 |
|
badgesEnabled |
boolean |
如果設定,此摘要支援產生套件徽章。 |
capabilities |
摘要的支援功能。 |
|
defaultViewId |
string |
摘要管理員指出的檢視是讀者的預設體驗。 |
deletedDate |
string |
刪除此摘要的日期。 |
description |
string |
摘要的描述。 描述不能超過 255 個字元。 |
fullyQualifiedId |
string |
這會是摘要 GUID 或摘要 GUID,並根據摘要的存取方式來檢視 GUID。 |
fullyQualifiedName |
string |
檢視的完整名稱,格式為 feed@view。 |
hideDeletedPackageVersions |
boolean |
如果設定,摘要將會隱藏所有已刪除/未發佈的版本 |
id |
string |
可唯一識別此摘要的 GUID。 |
isReadOnly |
boolean |
如果設定,摘要中的所有套件都是不可變的。 請務必注意摘要檢視是不可變的;因此,這個旗標一律會針對檢視設定。 |
name |
string |
摘要的名稱。 摘要名稱必須遵循這些規則:不得超過 64 個字元 不得包含空格 符不得以底線開頭,或句點不得以句 號 結尾不得包含下列任何不合法的字元: 、|、/、\\、?、:、&、$、*、\「、#、[、] ]]> |
permanentDeletedDate |
string |
永久刪除此摘要的日期。 |
permissions |
摘要的明確許可權。 |
|
project |
與此摘要相關聯的專案。 |
|
scheduledPermanentDeleteDate |
string |
排定永久刪除此摘要的日期。 |
upstreamEnabled |
boolean |
這應該一律為 true。 將 設定為 false 將會覆寫 UpstreamSources 中的所有來源。 |
upstreamEnabledChangedDate |
string |
如果已設定,則表示 UpstreamEnabled 屬性已變更的時間。 如果在建立摘要之後從未變更 UpstreamEnabled,則為 null。 |
upstreamSources |
此摘要會從中擷取套件的來源清單。 空白清單表示此摘要不會搜尋套件的任何其他來源。 |
|
url |
string |
GUID 格式之基底摘要的 URL。 |
view |
檢視的定義。 |
|
viewId |
string |
檢視識別碼。 |
viewName |
string |
檢視名稱。 |
FeedCapabilities
摘要的支援功能。
名稱 | 類型 | Description |
---|---|---|
defaultCapabilities |
string |
提供給新建立摘要的功能 |
none |
string |
此摘要沒有任何旗標存在 |
underMaintenance |
string |
此摘要目前正在維護中,且功能可能降低 |
upstreamV2 |
string |
此摘要可以提供上游來源的套件上游套件必須手動升級至檢視 |
FeedPermission
摘要的許可權。
名稱 | 類型 | Description |
---|---|---|
displayName |
string |
身分識別的顯示名稱。 |
identityDescriptor |
與此角色相關聯的身分識別。 |
|
identityId |
string |
與此角色相關聯的身分識別識別碼。 |
isInheritedRole |
boolean |
布林值,指出角色是繼承還是直接設定。 |
role |
此身分識別在摘要上的角色。 |
FeedRole
此身分識別在摘要上的角色。
名稱 | 類型 | Description |
---|---|---|
administrator |
string |
系統管理員可完全控制摘要。 |
collaborator |
string |
共同作業者具有與讀取器相同的許可權,但也可以從設定的上游來源內嵌套件。 |
contributor |
string |
參與者可以對摘要中的套件執行任何動作,包括新增套件,但可能不會修改摘要設定。 |
custom |
string |
不支援。 |
none |
string |
不支援。 |
reader |
string |
讀取器只能讀取套件和檢視設定。 |
FeedView
摘要頂端的檢視。
名稱 | 類型 | Description |
---|---|---|
_links |
相關的 REST 連結。 |
|
id |
string |
檢視的識別碼。 |
name |
string |
檢視表名稱。 |
type |
檢視的類型。 |
|
url |
string |
檢視的 URL。 |
visibility |
檢視的可見度狀態。 |
FeedViewType
檢視的類型。
名稱 | 類型 | Description |
---|---|---|
implicit |
string |
由系統自動建立和管理的內部檢視類型。 |
none |
string |
預設、未指定的檢視類型。 |
release |
string |
用來分類已發行成品的升階目的地檢視。 |
FeedVisibility
檢視的可見度狀態。
名稱 | 類型 | Description |
---|---|---|
aadTenant |
string |
摘要可供存在於 Azure Active Directory 租使用者中的所有有效使用者存取。 |
collection |
string |
摘要可供存在於組織中 (的所有有效使用者存取,例如在 'dev.azure.com/myorg') |
organization |
string |
摘要可供存在於摘要所在企業中的所有有效使用者存取。 請注意,舊版命名和回溯相容性會讓此值的名稱與新意義不同步。 |
private |
string |
只有摘要管理員明確設定的許可權才能存取。 |
IdentityDescriptor
身分識別描述元是識別類型的包裝函式, (Windows SID、Passport) 以及 SID 或 PUID 等唯一識別碼。
名稱 | 類型 | Description |
---|---|---|
identifier |
string |
此身分識別的唯一識別碼,不超過 256 個字元,將會保存。 |
identityType |
string |
描述項的類型 (例如 Windows、Passport 等) 。 |
ProjectReference
名稱 | 類型 | Description |
---|---|---|
id |
string |
取得或設定專案的識別碼。 |
name |
string |
取得或設定專案的名稱。 |
visibility |
string |
取得或設定專案的可見度。 |
ReferenceLinks
表示 REST 參考連結集合的類別。
名稱 | 類型 | Description |
---|---|---|
links |
object |
連結的唯讀檢視。 因為參考連結是唯讀的,所以我們只想要將它們公開為唯讀。 |
UpstreamSource
上游來源定義,包括其身分識別、套件類型和其他相關資訊。
名稱 | 類型 | Description |
---|---|---|
deletedDate |
string |
刪除此上游的 UTC 日期。 |
displayLocation |
string |
以使用者易記格式連線到上游來源的定位器,這可能會隨著時間而變更 |
id |
string |
上游來源的身分識別。 |
internalUpstreamCollectionId |
string |
針對內部上游類型,追蹤包含它的 Azure DevOps 組織。 |
internalUpstreamFeedId |
string |
針對內部上游類型,追蹤所參考的摘要識別碼。 |
internalUpstreamProjectId |
string |
針對內部上游類型,追蹤所參考摘要的專案。 |
internalUpstreamViewId |
string |
針對內部上游類型,追蹤所參考摘要的檢視。 |
location |
string |
連線到上游來源的一致定位器。 |
name |
string |
顯示名稱。 |
protocol |
string |
與上游來源相關聯的封裝類型。 |
serviceEndpointId |
string |
服務端點的身分識別,保存存取上游時要使用的認證。 |
serviceEndpointProjectId |
string |
指定服務端點的 projectId。 |
status |
指定上游的狀態。 |
|
statusDetails |
提供上游狀態的人類可讀原因。 |
|
upstreamSourceType |
來源類型,例如公用或內部。 |
UpstreamSourceType
來源類型,例如公用或內部。
名稱 | 類型 | Description |
---|---|---|
internal |
string |
Azure DevOps 上游來源。 |
public |
string |
公開可用的來源。 |
UpstreamStatus
指定上游的狀態。
名稱 | 類型 | Description |
---|---|---|
disabled |
string |
上游來源已停用。 |
ok |
string |
上游來源正常。 |
UpstreamStatusDetail
名稱 | 類型 | Description |
---|---|---|
reason |
string |
提供上游狀態的人類可讀原因。 |