Feed Management - Get Feed

Usługa:

Artifacts

Wersja interfejsu API:

7.1

Pobierz ustawienia dla określonego kanału informacyjnego.

Parametr projektu należy podać, jeśli źródło danych zostało utworzone w projekcie. Jeśli kanał informacyjny nie jest skojarzony z żadnym projektem, pomiń parametr projektu z żądania.

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

Z parametrami opcjonalnymi:

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
feedId	path	True	string	Nazwa lub identyfikator źródła danych.
organization	path	True	string	Nazwa organizacji usługi Azure DevOps.
project	path		string	Identyfikator projektu lub nazwa projektu
api-version	query	True	string	Wersja interfejsu API do użycia. Należy ustawić wartość "7.1", aby używać tej wersji interfejsu API.
includeDeletedUpstreams	query		boolean	Dołącz nadrzędne strumienie, które zostały usunięte w odpowiedzi.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	Feed	operacja zakończona powodzeniem

Zabezpieczenia

oauth2

Typ: oauth2
Flow: accessCode
Adres URL autoryzacji: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Adres URL tokenu: 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

Zakresy

Nazwa	Opis
vso.packaging	Przyznaje możliwość odczytywania kanałów informacyjnych i pakietów. Ponadto umożliwia wyszukiwanie pakietów.

Definicje

Nazwa	Opis
Feed	Kontener dla artefaktów.
FeedCapabilities	Obsługiwane możliwości kanału informacyjnego.
FeedPermission	Uprawnienia do kanału informacyjnego.
FeedRole	Rola dla tej tożsamości w kanale informacyjnym.
FeedView	Widok na wierzchu kanału informacyjnego.
FeedViewType	Typ widoku.
FeedVisibility	Stan widoczności widoku.
IdentityDescriptor	Deskryptor tożsamości to otoka typu tożsamości (identyfikator SID systemu Windows, passport) wraz z unikatowym identyfikatorem, takim jak identyfikator SID lub PUID.
ProjectReference
ReferenceLinks	Klasa reprezentująca kolekcję linków referencyjnych REST.
UpstreamSource	Nadrzędna definicja źródła, w tym jego tożsamość, typ pakietu i inne skojarzone informacje.
UpstreamSourceType	Typ źródła, taki jak Publiczny lub Wewnętrzny.
UpstreamStatus	Określa stan nadrzędnego strumienia.
UpstreamStatusDetail

Feed

Objekt

Kontener dla artefaktów.

Nazwa	Typ	Opis
_links	ReferenceLinks	Powiązane linki REST.
badgesEnabled	boolean	W przypadku ustawienia ten kanał informacyjny obsługuje generowanie znaczków pakietu.
capabilities	FeedCapabilities	Obsługiwane możliwości kanału informacyjnego.
defaultViewId	string (uuid)	Widok wskazany przez administratora kanału informacyjnego jest domyślnym środowiskiem dla czytelników.
deletedDate	string (date-time)	Data usunięcia tego kanału informacyjnego.
description	string	Opis kanału informacyjnego. Opisy nie mogą przekraczać 255 znaków.
fullyQualifiedId	string	Będzie to identyfikator GUID kanału informacyjnego lub identyfikator GUID kanału informacyjnego i wyświetlić identyfikator GUID w zależności od sposobu uzyskiwania dostępu do kanału informacyjnego.
fullyQualifiedName	string	Pełna nazwa widoku w formacie feed@view.
hideDeletedPackageVersions	boolean	W przypadku ustawienia źródło danych spowoduje ukrycie wszystkich usuniętych/nieopublikowanych wersji
id	string (uuid)	Identyfikator GUID, który jednoznacznie identyfikuje ten kanał informacyjny.
isReadOnly	boolean	W przypadku ustawienia wszystkie pakiety w kanale informacyjnym są niezmienne. Należy pamiętać, że widoki kanałów informacyjnych są niezmienne; w związku z tym ta flaga będzie zawsze ustawiana dla widoków.
name	string	Nazwa kanału informacyjnego. Nazwy kanałów informacyjnych muszą być zgodne z następującymi regułami: nie może przekraczać 64 znaków, nie mogą zawierać białych znaków, nie mogą rozpoczynać się od podkreślenia ani kropki, nie może zawierać żadnego z następujących niedozwolonych znaków: , |, /, \\, ?, &, $, *, \", #, [, ] ]>
permanentDeletedDate	string (date-time)	Data trwałego usunięcia tego kanału informacyjnego.
permissions	FeedPermission[]	Jawne uprawnienia kanału informacyjnego.
project	ProjectReference	Projekt, z którymi jest skojarzony ten kanał informacyjny.
scheduledPermanentDeleteDate	string (date-time)	Data trwałego usunięcia tego kanału informacyjnego.
upstreamEnabled	boolean	To zawsze powinno być prawdziwe. Ustawienie wartości false spowoduje zastąpienie wszystkich źródeł w upstreamSources.
upstreamEnabledChangedDate	string (date-time)	W przypadku ustawienia czas zmiany właściwości UpstreamEnabled. Wartość null będzie mieć wartość null, jeśli element UpstreamEnabled nigdy nie został zmieniony po utworzeniu kanału informacyjnego.
upstreamSources	UpstreamSource[]	Lista źródeł, z których ten kanał informacyjny będzie pobierać pakiety. Pusta lista wskazuje, że to źródło danych nie będzie przeszukiwać żadnych dodatkowych źródeł dla pakietów.
url	string	Adres URL podstawowego źródła danych w postaci identyfikatora GUID.
view	FeedView	Definicja widoku.
viewId	string (uuid)	Identyfikator widoku.
viewName	string	Nazwa widoku.

FeedCapabilities

Wyliczanie

Obsługiwane możliwości kanału informacyjnego.

Wartość	Opis
defaultCapabilities	Możliwości przekazane nowo utworzonemu kanałowi informacyjnemu
none	Brak flag dla tego kanału informacyjnego
underMaintenance	To źródło danych jest obecnie w trakcie konserwacji i może mieć ograniczoną funkcjonalność
upstreamV2	To źródło danych może obsługiwać pakiety z nadrzędnych źródeł Pakiety nadrzędne muszą być ręcznie promowane do widoków

FeedPermission

Objekt

Uprawnienia do kanału informacyjnego.

Nazwa	Typ	Opis
displayName	string	Nazwa wyświetlana tożsamości.
identityDescriptor	IdentityDescriptor	Tożsamość skojarzona z tą rolą.
identityId	string (uuid)	Identyfikator tożsamości skojarzonej z tą rolą.
isInheritedRole	boolean	Wartość logiczna wskazująca, czy rola jest dziedziczona, czy ustawiana bezpośrednio.
role	FeedRole	Rola dla tej tożsamości w kanale informacyjnym.

FeedRole

Wyliczanie

Rola dla tej tożsamości w kanale informacyjnym.

Wartość	Opis
administrator	Administratorzy mają całkowitą kontrolę nad kanałem informacyjnym.
collaborator	Współpracownicy mają takie same uprawnienia jak czytelnicy, ale mogą również pozyskiwać pakiety ze skonfigurowanych źródeł nadrzędnych.
contributor	Współautorzy mogą wykonywać wszystkie czynności w pakietach w kanale informacyjnym, w tym dodawać nowe pakiety, ale mogą nie modyfikować ustawień kanału informacyjnego.
custom	Nieobsługiwane.
none	Nieobsługiwane.
reader	Czytelnicy mogą odczytywać tylko pakiety i wyświetlać ustawienia.

FeedView

Objekt

Widok na wierzchu kanału informacyjnego.

Nazwa	Typ	Opis
_links	ReferenceLinks	Powiązane linki REST.
id	string (uuid)	Identyfikator widoku.
name	string	Nazwa widoku.
type	FeedViewType	Typ widoku.
url	string	Adres URL widoku.
visibility	FeedVisibility	Stan widoczności widoku.

FeedViewType

Wyliczanie

Typ widoku.

Wartość	Opis
implicit	Typ widoku wewnętrznego, który jest automatycznie tworzony i zarządzany przez system.
none	Domyślny, nieokreślony typ widoku.
release	Wyświetl używany jako miejsce docelowe podwyższania poziomu do klasyfikowania zwolnionych artefaktów.

FeedVisibility

Wyliczanie

Stan widoczności widoku.

Wartość	Opis
aadTenant	Kanał informacyjny jest dostępny dla wszystkich prawidłowych użytkowników znajdujących się w dzierżawie usługi Azure Active Directory.
collection	Kanał informacyjny jest dostępny dla wszystkich prawidłowych użytkowników obecnych w organizacji, w której znajduje się kanał informacyjny (na przykład w organizacji "myorg" pod adresem "dev.azure.com/myorg")
organization	Kanał informacyjny jest dostępny dla wszystkich prawidłowych użytkowników znajdujących się w przedsiębiorstwie, w którym znajduje się kanał informacyjny. Należy pamiętać, że starsze nazewnictwo i wsteczne z powrotem pozostawia nazwę tej wartości poza synchronizacją z nowym znaczeniem.
private	Dostępne tylko przez uprawnienia jawnie ustawione przez administratora kanału informacyjnego.

IdentityDescriptor

Objekt

Deskryptor tożsamości to otoka typu tożsamości (identyfikator SID systemu Windows, passport) wraz z unikatowym identyfikatorem, takim jak identyfikator SID lub PUID.

Nazwa	Typ	Opis
identifier	string	Unikatowy identyfikator tej tożsamości, który nie przekracza 256 znaków, które będą utrwalane.
identityType	string	Typ deskryptora (na przykład Windows, Passport itp.).

ProjectReference

Objekt

Nazwa	Typ	Opis
id	string (uuid)	Pobiera lub ustawia identyfikator projektu.
name	string	Pobiera lub ustawia nazwę projektu.
visibility	string	Pobiera lub ustawia widoczność projektu.

ReferenceLinks

Objekt

Klasa reprezentująca kolekcję linków referencyjnych REST.

Nazwa	Typ	Opis
links	object	Czytelny widok linków. Ponieważ linki odwołania są tylko do odczytu, chcemy uwidocznić je tylko jako tylko do odczytu.

UpstreamSource

Objekt

Nadrzędna definicja źródła, w tym jego tożsamość, typ pakietu i inne skojarzone informacje.

Nazwa	Typ	Opis
deletedDate	string (date-time)	Data UTC usunięcia tego nadrzędnego strumienia.
displayLocation	string	Lokalizator do nawiązywania połączenia ze źródłem nadrzędnym w przyjaznym dla użytkownika formacie, który może ulec zmianie w czasie
id	string (uuid)	Tożsamość nadrzędnego źródła.
internalUpstreamCollectionId	string (uuid)	W przypadku wewnętrznego typu nadrzędnego śledź organizację usługi Azure DevOps, która ją zawiera.
internalUpstreamFeedId	string (uuid)	W przypadku wewnętrznego typu nadrzędnego śledź identyfikator kanału informacyjnego, do których się odwołujesz.
internalUpstreamProjectId	string (uuid)	W przypadku wewnętrznego typu nadrzędnego śledź projekt przywoływanego kanału informacyjnego.
internalUpstreamViewId	string (uuid)	W przypadku wewnętrznego typu nadrzędnego śledź widok przywoływanego kanału informacyjnego.
location	string	Spójny lokalizator do nawiązywania połączenia ze źródłem nadrzędnym.
name	string	Nazwa wyświetlana.
protocol	string	Typ pakietu skojarzony ze źródłem nadrzędnym.
serviceEndpointId	string (uuid)	Tożsamość punktu końcowego usługi, który przechowuje poświadczenia do użycia podczas uzyskiwania dostępu do nadrzędnego punktu końcowego.
serviceEndpointProjectId	string (uuid)	Określa identyfikator projectId punktu końcowego usługi.
status	UpstreamStatus	Określa stan nadrzędnego strumienia.
statusDetails	UpstreamStatusDetail[]	Zapewnia czytelny dla człowieka powód stanu nadrzędnego.
upstreamSourceType	UpstreamSourceType	Typ źródła, taki jak Publiczny lub Wewnętrzny.

UpstreamSourceType

Wyliczanie

Typ źródła, taki jak Publiczny lub Wewnętrzny.

Wartość	Opis
internal	Nadrzędne źródło usługi Azure DevOps.
public	Publicznie dostępne źródło.

UpstreamStatus

Wyliczanie

Określa stan nadrzędnego strumienia.

Wartość	Opis
disabled	Źródło nadrzędne jest wyłączone.
ok	Nadrzędne źródło jest prawidłowe.

UpstreamStatusDetail

Objekt

Nazwa	Typ	Opis
reason	string	Zapewnia czytelny dla człowieka powód stanu nadrzędnego.