Pipeline Permissions - Update Pipeline Permisions For Resources
Interfejs API usługi Batch do autoryzacji/nieautoryzowania listy definicji dla wielu zasobów.
PATCH https://dev.azure.com/{organization}/{project}/_apis/pipelines/pipelinepermissions?api-version=7.1-preview.1
Parametry identyfikatora URI
Nazwa | W | Wymagane | Typ | Opis |
---|---|---|---|---|
organization
|
path | True |
string |
Nazwa organizacji usługi Azure DevOps. |
project
|
path | True |
string |
Identyfikator projektu lub nazwa projektu |
api-version
|
query | True |
string |
Wersja interfejsu API do użycia. Powinno to być ustawione na wartość "7.1-preview.1", aby używać tej wersji interfejsu API. |
Treść żądania
Nazwa | Typ | Opis |
---|---|---|
body |
Odpowiedzi
Nazwa | Typ | Opis |
---|---|---|
200 OK |
operacja zakończona powodzeniem |
Zabezpieczenia
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
Nazwa | Opis |
---|---|
vso.pipelineresources_manage | Umożliwia zarządzanie chronionym zasobem lub żądaniem potoku w celu użycia chronionego zasobu: puli agentów, środowiska, kolejki, repozytorium, bezpiecznych plików, połączenia z usługą i grupy zmiennych |
Przykłady
Sample Request
PATCH https://dev.azure.com/{organization}/{project}/_apis/pipelines/pipelinepermissions?api-version=7.1-preview.1
[
{
"resource": {
"type": "queue",
"id": "1",
"name": "Default"
},
"pipelines": [
{
"id": 16,
"authorized": true
}
]
},
{
"resource": {
"type": "environment",
"id": "1",
"name": "SampleEnv"
},
"pipelines": [
{
"id": 16,
"authorized": true
}
]
}
]
Sample Response
request-Context: appId=cid-v1:a892bfef-0287-4640-9f5e-cffc90fbcf94
access-Control-Expose-Headers: Request-Context
{
"count": 2,
"value": [
{
"resource": {
"type": "queue",
"id": "1"
},
"pipelines": [
{
"id": 6,
"authorized": true,
"authorizedBy": {
"displayName": "User Name",
"id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
"uniqueName": "uniqueName",
"descriptor": "Descriptor"
},
"authorizedOn": "2020-01-02T08:59:48.77Z"
},
{
"id": 15,
"authorized": true,
"authorizedBy": {
"displayName": "User Name",
"id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
"uniqueName": "uniqueName",
"descriptor": "Descriptor"
},
"authorizedOn": "2020-11-19T08:14:49.26Z"
},
{
"id": 16,
"authorized": true,
"authorizedBy": {
"displayName": "User Name",
"id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
"uniqueName": "uniqueName",
"descriptor": "Descriptor"
},
"authorizedOn": "2020-11-20T15:10:54.187Z"
}
]
},
{
"resource": {
"type": "environment",
"id": "1"
},
"pipelines": [
{
"id": 6,
"authorized": true,
"authorizedBy": {
"displayName": "User Name",
"id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
"uniqueName": "uniqueName",
"descriptor": "Descriptor"
},
"authorizedOn": "2020-04-20T09:31:06.023Z"
},
{
"id": 11,
"authorized": true,
"authorizedBy": {
"displayName": "User Name",
"id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
"uniqueName": "uniqueName",
"descriptor": "Descriptor"
},
"authorizedOn": "2020-07-21T14:07:21.353Z"
},
{
"id": 15,
"authorized": true,
"authorizedBy": {
"displayName": "User Name",
"id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
"uniqueName": "uniqueName",
"descriptor": "Descriptor"
},
"authorizedOn": "2020-11-19T08:14:47.323Z"
},
{
"id": 16,
"authorized": true,
"authorizedBy": {
"displayName": "User Name",
"id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
"uniqueName": "uniqueName",
"descriptor": "Descriptor"
},
"authorizedOn": "2020-11-20T15:33:01.793Z"
}
]
}
]
}
Definicje
Nazwa | Opis |
---|---|
Identity |
|
Permission | |
Pipeline |
|
Reference |
Klasa reprezentująca kolekcję linków referencyjnych REST. |
Resource | |
Resource |
IdentityRef
Nazwa | Typ | Opis |
---|---|---|
_links |
To pole zawiera zero lub więcej interesujących linków dotyczących tematu grafu. Te linki mogą być wywoływane w celu uzyskania dodatkowych relacji lub bardziej szczegółowych informacji na temat tego tematu grafu. |
|
descriptor |
string |
Deskryptor jest podstawowym sposobem odwołowania się do tematu grafu podczas działania systemu. To pole będzie jednoznacznie identyfikować ten sam temat grafu zarówno w ramach kont, jak i organizacji. |
directoryAlias |
string |
Przestarzałe — można pobrać, wysyłając zapytanie do użytkownika programu Graph przywoływanego w wpisie "self" słownika IdentityRef "_links" |
displayName |
string |
Jest to unikatowa nazwa wyświetlana tematu grafu. Aby zmienić to pole, musisz zmienić jego wartość u dostawcy źródłowego. |
id |
string |
|
imageUrl |
string |
Przestarzałe — dostępne w wpisie "avatar" słownika IdentityRef "_links" |
inactive |
boolean |
Przestarzałe — można pobrać, wysyłając zapytanie do stanu członkostwa programu Graph, do których odwołuje się wpis "membershipState" słownika GraphUser "_links" |
isAadIdentity |
boolean |
Przestarzałe — można wywnioskować z typu podmiotu deskryptora (Descriptor.IsAadUserType/Descriptor.IsAadGroupType) |
isContainer |
boolean |
Przestarzałe — można wywnioskować z typu podmiotu deskryptora (Descriptor.IsGroupType) |
isDeletedInOrigin |
boolean |
|
profileUrl |
string |
Przestarzałe — nie jest używane w większości istniejących implementacji toIdentityRef |
uniqueName |
string |
Przestarzałe — zamiast tego użyj nazwy Domain+PrincipalName |
url |
string |
Ten adres URL jest pełną trasą do zasobu źródłowego tego tematu grafu. |
Permission
Nazwa | Typ | Opis |
---|---|---|
authorized |
boolean |
|
authorizedBy | ||
authorizedOn |
string |
PipelinePermission
Nazwa | Typ | Opis |
---|---|---|
authorized |
boolean |
|
authorizedBy | ||
authorizedOn |
string |
|
id |
integer |
ReferenceLinks
Klasa reprezentująca kolekcję linków referencyjnych REST.
Nazwa | Typ | Opis |
---|---|---|
links |
object |
Czytelny widok linków. Ponieważ linki referencyjne są czytelne, chcemy uwidocznić je tylko jako tylko do odczytu. |
Resource
Nazwa | Typ | Opis |
---|---|---|
id |
string |
Identyfikator zasobu. |
name |
string |
Nazwa zasobu. |
type |
string |
Typ zasobu. |
ResourcePipelinePermissions
Nazwa | Typ | Opis |
---|---|---|
allPipelines | ||
pipelines | ||
resource |