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 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
feed
|
path | True |
string |
源的名称或 ID。 |
organization
|
path | True |
string |
Azure DevOps 组织的名称。 |
project
|
path |
string |
项目 ID 或项目名称 |
|
api-version
|
query | True |
string |
要使用的 API 版本。 这应设置为“7.1-preview.1”才能使用此版本的 API。 |
include
|
query |
boolean |
包括响应中已删除的上游。 |
响应
名称 | 类型 | 说明 |
---|---|---|
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
名称 | 说明 |
---|---|
vso.packaging | 授予读取源和包的能力。 此外,还授予搜索包的能力。 |
定义
名称 | 说明 |
---|---|
Feed |
项目的容器。 |
Feed |
源支持的功能。 |
Feed |
源的权限。 |
Feed |
此标识在源上的角色。 |
Feed |
源顶部的视图。 |
Feed |
视图的类型。 |
Feed |
视图的可见性状态。 |
Identity |
标识描述符是标识类型 (Windows SID、Passport) 以及唯一标识符(如 SID 或 PUID)的包装器。 |
Project |
|
Reference |
表示 REST 引用链接集合的类。 |
Upstream |
上游源定义,包括其标识、包类型和其他相关信息。 |
Upstream |
源类型,例如“公共”或“内部”。 |
Upstream |
指定上游的状态。 |
Upstream |
Feed
项目的容器。
名称 | 类型 | 说明 |
---|---|---|
_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 |
这应该始终正确。 将 设置为 false 将替代 UpstreamSources 中的所有源。 |
upstreamEnabledChangedDate |
string |
如果设置,则为 UpstreamEnabled 属性更改的时间。 如果在源创建后从未更改 UpstreamEnabled,则为 null。 |
upstreamSources |
此源将从中提取包的源列表。 空列表指示此源不会搜索包的任何其他源。 |
|
url |
string |
GUID 格式的基本源的 URL。 |
view |
视图的定义。 |
|
viewId |
string |
视图 ID。 |
viewName |
string |
视图名。 |
FeedCapabilities
源支持的功能。
名称 | 类型 | 说明 |
---|---|---|
defaultCapabilities |
string |
为新创建的源提供的功能 |
none |
string |
此源不存在标志 |
underMaintenance |
string |
此源当前处于维护状态,功能可能已减少 |
upstreamV2 |
string |
此源可以提供来自上游源的包,上游包必须手动提升为视图 |
FeedPermission
源的权限。
名称 | 类型 | 说明 |
---|---|---|
displayName |
string |
标识的显示名称。 |
identityDescriptor |
与此角色关联的标识。 |
|
identityId |
string |
与此角色关联的标识的 ID。 |
isInheritedRole |
boolean |
指示是直接继承还是设置角色的布尔值。 |
role |
此标识在源上的角色。 |
FeedRole
此标识在源上的角色。
名称 | 类型 | 说明 |
---|---|---|
administrator |
string |
管理员可以完全控制源。 |
collaborator |
string |
协作者具有与读取者相同的权限,但也可以从配置的上游源引入包。 |
contributor |
string |
参与者可以对源中的包执行任何操作,包括添加新包,但他们不能修改源设置。 |
custom |
string |
不支持。 |
none |
string |
不支持。 |
reader |
string |
读者只能读取包和查看设置。 |
FeedView
源顶部的视图。
名称 | 类型 | 说明 |
---|---|---|
_links |
相关 REST 链接。 |
|
id |
string |
视图的 ID。 |
name |
string |
视图的名称。 |
type |
视图的类型。 |
|
url |
string |
视图的 URL。 |
visibility |
视图的可见性状态。 |
FeedViewType
视图的类型。
名称 | 类型 | 说明 |
---|---|---|
implicit |
string |
由系统自动创建和管理的内部视图类型。 |
none |
string |
默认的未指定视图类型。 |
release |
string |
用作升级目标的视图,用于对已发布的项目进行分类。 |
FeedVisibility
视图的可见性状态。
名称 | 类型 | 说明 |
---|---|---|
aadTenant |
string |
Azure Active Directory 租户中的所有有效用户访问源。 |
collection |
string |
源所在的组织中存在的所有有效用户都可以访问源 (例如,跨组织“myorg”访问“dev.azure.com/myorg”) |
organization |
string |
源所在的企业中的所有有效用户访问源。 请注意,旧命名和后向兼容性会使此值的名称与其新含义不同步。 |
private |
string |
只能由源管理员显式设置的权限访问。 |
IdentityDescriptor
标识描述符是标识类型 (Windows SID、Passport) 以及唯一标识符(如 SID 或 PUID)的包装器。
名称 | 类型 | 说明 |
---|---|---|
identifier |
string |
此标识的唯一标识符,不超过 256 个字符,将持久保存。 |
identityType |
string |
描述符的类型 (,例如 Windows、Passport 等) 。 |
ProjectReference
名称 | 类型 | 说明 |
---|---|---|
id |
string |
获取或设置项目的 ID。 |
name |
string |
获取或设置项目的名称。 |
visibility |
string |
获取或设置项目的可见性。 |
ReferenceLinks
表示 REST 引用链接集合的类。
名称 | 类型 | 说明 |
---|---|---|
links |
object |
链接的只读视图。 由于引用链接是只读的,因此我们只想将其公开为只读。 |
UpstreamSource
上游源定义,包括其标识、包类型和其他相关信息。
名称 | 类型 | 说明 |
---|---|---|
deletedDate |
string |
删除此上游的 UTC 日期。 |
displayLocation |
string |
用于以用户友好格式连接到上游源的定位符,该定位符可能会随时间推移而变化 |
id |
string |
上游源的标识。 |
internalUpstreamCollectionId |
string |
对于内部上游类型,请跟踪包含它的 Azure DevOps 组织。 |
internalUpstreamFeedId |
string |
对于内部上游类型,跟踪所引用的源 ID。 |
internalUpstreamProjectId |
string |
对于内部上游类型,跟踪所引用源的项目。 |
internalUpstreamViewId |
string |
对于内部上游类型,跟踪所引用源的视图。 |
location |
string |
用于连接到上游源的一致定位符。 |
name |
string |
显示名称。 |
protocol |
string |
与上游源关联的包类型。 |
serviceEndpointId |
string |
保存访问上游时要使用的凭据的服务终结点的标识。 |
serviceEndpointProjectId |
string |
指定服务终结点的 projectId。 |
status |
指定上游的状态。 |
|
statusDetails |
提供上游状态的可读原因。 |
|
upstreamSourceType |
源类型,例如“公共”或“内部”。 |
UpstreamSourceType
源类型,例如“公共”或“内部”。
名称 | 类型 | 说明 |
---|---|---|
internal |
string |
Azure DevOps 上游源。 |
public |
string |
公开可用的源。 |
UpstreamStatus
指定上游的状态。
名称 | 类型 | 说明 |
---|---|---|
disabled |
string |
上游源已禁用。 |
ok |
string |
上游源正常。 |
UpstreamStatusDetail
名称 | 类型 | 说明 |
---|---|---|
reason |
string |
提供上游状态的可读原因。 |
反馈
https://aka.ms/ContentUserFeedback。
即将发布:在整个 2024 年,我们将逐步淘汰作为内容反馈机制的“GitHub 问题”,并将其取代为新的反馈系统。 有关详细信息,请参阅:提交和查看相关反馈