Udostępnij za pośrednictwem

Project Enablement - Get

  • Odwołanie
Usługa:
Advanced Security
Wersja interfejsu API:
7.2-preview.1

Pobieranie bieżącego stanu usługi Advanced Security dla projektu

GET https://advsec.dev.azure.com/{organization}/{project}/_apis/management/enablement?api-version=7.2-preview.1
Z parametrami opcjonalnymi: 
GET https://advsec.dev.azure.com/{organization}/{project}/_apis/management/enablement?includeAllProperties={includeAllProperties}&api-version=7.2-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. Należy ustawić wartość "7.2-preview.1", aby używać tej wersji interfejsu API.
includeAllProperties
 query

boolean

W przypadku wartości true ustal również, czy wypchnięcia są blokowane, jeśli zawierają wpisy tajne

Odpowiedzi

Nazwa Typ Opis
200 OK

AdvSecEnablementSettings

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.advsec Przyznaje możliwość odczytywania alertów, wystąpień wyników, wystąpień wyników analizy

Definicje

Nazwa Opis
AdvSecEnablementFeatures
AdvSecEnablementSettings
AdvSecEnablementStatus

AdvSecEnablementFeatures

Nazwa Typ Opis
codeQLEnabled

boolean

Stan włączania codeQL jest ustawiony na Wartość Fałsz, gdy jest wyłączona i Prawda po włączeniu; Wartość null nigdy nie jest jawnie ustawiana.
dependencyScanningInjectionEnabled

boolean

Stan włączania iniekcji skanowania zależności ma wartość False, gdy jest wyłączona i prawda po włączeniu; Wartość null nigdy nie jest jawnie ustawiana.
Jeśli zabezpieczenia zaawansowane nie są jeszcze włączone, zachowanie będzie zależeć od tego, czy usługa Advanced Security ma być włączona/wyłączona. DependencyScanningInjectionEnabled nie wpłynie na nic w tym scenariuszu.
Jeśli usługa Advanced Security ma zostać wyłączona, wartość DependencyScanningInjectionEnabled nie będzie działać.
Ustawienie stanu włączania skanowania zależności jest obsługiwane tylko w przypadku włączania repozytorium, a nie dla włączania organizacji lub projektu w tej chwili.

AdvSecEnablementSettings

Nazwa Typ Opis
enableOnCreate

boolean

Automatyczne włączanie usługi Advanced Security w nowo utworzonych repozytoriach.
reposEnablementStatus

AdvSecEnablementStatus[]

AdvSecEnablementStatus

Nazwa Typ Opis
advSecEnabled

boolean

Stan włączania zabezpieczeń zaawansowanych ma wartość Fałsz, gdy jest wyłączona i Prawda po włączeniu; Wartość null nigdy nie jest jawnie ustawiana.
advSecEnablementFeatures

AdvSecEnablementFeatures

Zawiera dodatkowe funkcje, które można włączyć wraz z zabezpieczeniami zaawansowanymi.
advSecEnablementLastChangedDate

string

Ostatni raz stan usługi Advanced Security dla tego repozytorium został zaktualizowany
blockPushes

boolean

Jeśli wartość true, wypchnięcia zawierające wpisy tajne zostaną zablokowane.
W przypadku wartości false wypychania są skanowane pod kątem wpisów tajnych i nie są blokowane.
Jeśli właściwość includeAllProperties w żądaniu ma wartość false, ta wartość będzie mieć wartość null.
projectId

string

repositoryId

string