Azure DevOps Projects - Create Or Update

Odwołanie

Usługa:: Defender for Cloud

Wersja interfejsu API:: 2024-05-15-preview

Tworzy lub aktualizuje monitorowany zasób projektu usługi Azure DevOps.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/azureDevOpsOrgs/{orgName}/projects/{projectName}?api-version=2024-05-15-preview

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
orgName	path	True	string	Nazwa organizacji usługi Azure DevOps.
projectName	path	True	string	Nazwa projektu.
resourceGroupName	path	True	string	Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
securityConnectorName	path	True	string	Nazwa łącznika zabezpieczeń.
subscriptionId	path	True	string	Identyfikator subskrypcji docelowej.
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwa	Typ	Opis
properties	AzureDevOpsProjectProperties	Właściwości projektu usługi Azure DevOps.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	AzureDevOpsProject	Tworzy lub aktualizuje monitorowany zasób projektu usługi Azure DevOps
201 Created	AzureDevOpsProject	Utworzono
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

CreateOrUpdate_AzureDevOpsProjects

PUT https://management.azure.com/subscriptions/0806e1cd-cfda-4ff8-b99c-2b0af42cffd3/resourceGroups/myRg/providers/Microsoft.Security/securityConnectors/mySecurityConnectorName/devops/default/azureDevOpsOrgs/myAzDevOpsOrg/projects/myAzDevOpsProject?api-version=2024-05-15-preview

{
  "properties": {
    "onboardingState": "NotApplicable",
    "actionableRemediation": {
      "state": "Enabled"
    }
  }
}


import com.azure.resourcemanager.security.models.ActionableRemediation;
import com.azure.resourcemanager.security.models.ActionableRemediationState;
import com.azure.resourcemanager.security.models.AzureDevOpsProjectProperties;
import com.azure.resourcemanager.security.models.OnboardingState;

/**
 * Samples for AzureDevOpsProjects CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/preview/2024-05-15-preview/examples/
     * SecurityConnectorsDevOps/CreateOrUpdateAzureDevOpsProjects_example.json
     */
    /**
     * Sample code: CreateOrUpdate_AzureDevOpsProjects.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void createOrUpdateAzureDevOpsProjects(com.azure.resourcemanager.security.SecurityManager manager) {
        manager.azureDevOpsProjects().define("myAzDevOpsProject")
            .withExistingAzureDevOpsOrg("myRg", "mySecurityConnectorName", "myAzDevOpsOrg")
            .withProperties(new AzureDevOpsProjectProperties().withOnboardingState(OnboardingState.NOT_APPLICABLE)
                .withActionableRemediation(new ActionableRemediation().withState(ActionableRemediationState.ENABLED)))
            .create();
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Przykładowa odpowiedź

Kod stanu:: 200

{
  "properties": {
    "parentOrgName": "myAzDevOpsOrg",
    "projectId": "9ebbed8f-a9cc-405f-a647-b235e22179de",
    "onboardingState": "Onboarded",
    "actionableRemediation": {
      "state": "Enabled"
    },
    "provisioningState": "Succeeded"
  },
  "id": "/subscriptions/0806e1cd-cfda-4ff8-b99c-2b0af42cffd3/resourceGroups/myRg/providers/Microsoft.Security/securityConnectors/mySecurityConnectorName/devops/default/azureDevOpsOrgs/myAzDevOpsOrg/projects/myAzDevOpsProject",
  "name": "myAzDevOpsProject",
  "type": "Microsoft.Security/securityConnectors/devops/azureDevOpsOrgs/projects"
}

Kod stanu:: 201

Azure-AsyncOperation: https://management.azure.com/subscriptions/0806e1cd-cfda-4ff8-b99c-2b0af42cffd3/resourceGroups/myRg/providers/Microsoft.Security/securityConnectors/mySecurityConnectorName/devops/default/operationResults/4e826cf1-5c36-4808-a7d2-fb4f5170978b?api-version=2024-05-15-preview

{
  "properties": {
    "parentOrgName": "myAzDevOpsOrg",
    "projectId": "9ebbed8f-a9cc-405f-a647-b235e22179de",
    "onboardingState": "NotApplicable",
    "actionableRemediation": {
      "state": "None"
    },
    "provisioningState": "Accepted"
  },
  "id": "/subscriptions/0806e1cd-cfda-4ff8-b99c-2b0af42cffd3/resourceGroups/myRg/providers/Microsoft.Security/securityConnectors/mySecurityConnectorName/devops/default/azureDevOpsOrgs/myAzDevOpsOrg/projects/myAzDevOpsProject",
  "name": "myAzDevOpsProject",
  "type": "Microsoft.Security/securityConnectors/devops/azureDevOpsOrgs/projects"
}

Definicje

Nazwa	Opis
ActionableRemediation	Ładunek konfiguracji adnotacji żądania ściągnięcia.
ActionableRemediationState	Ustawienie actionableRemediation. Brak — ustawienie nigdy nie zostało ustawione. Włączone — włączono funkcję ActionableRemediation. Wyłączone — funkcja ActionableRemediation jest wyłączona.
AnnotateDefaultBranchState	Konfiguracja adnotacji żądania ściągnięcia w gałęzi domyślnej. Włączone — adnotacje żądania ściągnięcia są włączone w domyślnej gałęzi zasobu. Wyłączone — adnotacje żądania ściągnięcia są wyłączone w domyślnej gałęzi zasobu.
AzureDevOpsProject	Zasób projektu usługi Azure DevOps.
AzureDevOpsProjectProperties	Właściwości projektu usługi Azure DevOps.
CategoryConfiguration	Poziom ważności dla konfiguracji kategorii adnotacji żądania ściągnięcia.
createdByType	Typ tożsamości, która utworzyła zasób.
DevOpsProvisioningState	Stan aprowizacji zasobu. Oczekujące — oczekiwanie na aprowizację. Niepowodzenie — inicjowanie obsługi administracyjnej nie powiodło się. Powodzenie — pomyślna aprowizacja. Anulowano — aprowizowanie anulowane. PendingDeletion — oczekiwanie na usunięcie. DeletionSuccess — usuwanie powiodło się. DeletionFailure — niepowodzenie usuwania.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
InheritFromParentState	Aktualizuj ustawienia. Włączone — zasób powinien dziedziczyć konfiguracje z elementu nadrzędnego. Wyłączone — zasób nie powinien dziedziczyć konfiguracji z elementu nadrzędnego.
OnboardingState	Szczegółowe informacje o stanie dołączania zasobów we wszystkich łącznikach. OnboardedByOtherConnector — ten zasób został już dołączony do innego łącznika. Dotyczy to tylko zasobów najwyższego poziomu. Dołączone — ten zasób został już dołączony przez określony łącznik. NotOnboarded — ten zasób nie został dołączony do żadnego łącznika. NotApplicable — stan dołączania nie ma zastosowania do bieżącego punktu końcowego.
RuleCategory	Kategorie reguł. Kod — wyniki skanowania kodu. Wyniki skanowania artefaktów. Wyniki skanowania zależności. Wyniki IaC. Wpisy tajne skanują wyniki. Wyniki skanowania kontenerów.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
TargetBranchConfiguration	Konfiguracja gałęzi repozytorium dla adnotacji żądania ściągnięcia.

ActionableRemediation

Ładunek konfiguracji adnotacji żądania ściągnięcia.

Nazwa	Typ	Opis
branchConfiguration	TargetBranchConfiguration	Konfiguracja gałęzi repozytorium dla adnotacji żądania ściągnięcia.
categoryConfigurations	CategoryConfiguration[]	Pobiera lub ustawia listę kategorii i poziomów ważności.
inheritFromParentState	InheritFromParentState	Aktualizuj ustawienia. Włączone — zasób powinien dziedziczyć konfiguracje z elementu nadrzędnego. Wyłączone — zasób nie powinien dziedziczyć konfiguracji z elementu nadrzędnego.
state	ActionableRemediationState	Ustawienie actionableRemediation. Brak — ustawienie nigdy nie zostało ustawione. Włączone — włączono funkcję ActionableRemediation. Wyłączone — funkcja ActionableRemediation jest wyłączona.

ActionableRemediationState

Ustawienie actionableRemediation. Brak — ustawienie nigdy nie zostało ustawione. Włączone — włączono funkcję ActionableRemediation. Wyłączone — funkcja ActionableRemediation jest wyłączona.

Nazwa	Typ	Opis
Disabled	string
Enabled	string
None	string

AnnotateDefaultBranchState

Konfiguracja adnotacji żądania ściągnięcia w gałęzi domyślnej.

Włączone — adnotacje żądania ściągnięcia są włączone w domyślnej gałęzi zasobu. Wyłączone — adnotacje żądania ściągnięcia są wyłączone w domyślnej gałęzi zasobu.

Nazwa	Typ	Opis
Disabled	string
Enabled	string

AzureDevOpsProject

Zasób projektu usługi Azure DevOps.

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nazwa zasobu
properties	AzureDevOpsProjectProperties	Właściwości projektu usługi Azure DevOps.
systemData	systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

AzureDevOpsProjectProperties

Właściwości projektu usługi Azure DevOps.

Nazwa	Typ	Opis
actionableRemediation	ActionableRemediation	Ładunek konfiguracji adnotacji żądania ściągnięcia.
onboardingState	OnboardingState	Szczegółowe informacje o stanie dołączania zasobów we wszystkich łącznikach. OnboardedByOtherConnector — ten zasób został już dołączony do innego łącznika. Dotyczy to tylko zasobów najwyższego poziomu. Dołączone — ten zasób został już dołączony przez określony łącznik. NotOnboarded — ten zasób nie został dołączony do żadnego łącznika. NotApplicable — stan dołączania nie ma zastosowania do bieżącego punktu końcowego.
parentOrgName	string	Pobiera lub ustawia nadrzędną nazwę organizacji usługi Azure DevOps.
projectId	string	Pobiera lub ustawia identyfikator projektu usługi Azure DevOps.
provisioningState	DevOpsProvisioningState	Stan aprowizacji zasobu. Oczekujące — oczekiwanie na aprowizację. Niepowodzenie — inicjowanie obsługi administracyjnej nie powiodło się. Powodzenie — pomyślna aprowizacja. Anulowano — aprowizowanie anulowane. PendingDeletion — oczekiwanie na usunięcie. DeletionSuccess — usuwanie powiodło się. DeletionFailure — niepowodzenie usuwania.
provisioningStatusMessage	string	Pobiera komunikat o stanie zasobu.
provisioningStatusUpdateTimeUtc	string	Pobiera czas ostatniego sprawdzenia zasobu.

CategoryConfiguration

Poziom ważności dla konfiguracji kategorii adnotacji żądania ściągnięcia.

Nazwa	Typ	Opis
category	RuleCategory	Kategorie reguł. Kod — wyniki skanowania kodu. Wyniki skanowania artefaktów. Wyniki skanowania zależności. Wyniki IaC. Wpisy tajne skanują wyniki. Wyniki skanowania kontenerów.
minimumSeverityLevel	string	Pobiera lub ustawia minimalny poziom ważności dla danej kategorii.

createdByType

Typ tożsamości, która utworzyła zasób.

Nazwa	Typ	Opis
Application	string
Key	string
ManagedIdentity	string
User	string

DevOpsProvisioningState

Stan aprowizacji zasobu.

Oczekujące — oczekiwanie na aprowizację. Niepowodzenie — inicjowanie obsługi administracyjnej nie powiodło się. Powodzenie — pomyślna aprowizacja. Anulowano — aprowizowanie anulowane. PendingDeletion — oczekiwanie na usunięcie. DeletionSuccess — usuwanie powiodło się. DeletionFailure — niepowodzenie usuwania.

Nazwa	Typ	Opis
Canceled	string
DeletionFailure	string
DeletionSuccess	string
Failed	string
Pending	string
PendingDeletion	string
Succeeded	string

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

InheritFromParentState

Aktualizuj ustawienia.

Włączone — zasób powinien dziedziczyć konfiguracje z elementu nadrzędnego. Wyłączone — zasób nie powinien dziedziczyć konfiguracji z elementu nadrzędnego.

Nazwa	Typ	Opis
Disabled	string
Enabled	string

OnboardingState

Szczegółowe informacje o stanie dołączania zasobów we wszystkich łącznikach.

OnboardedByOtherConnector — ten zasób został już dołączony do innego łącznika. Dotyczy to tylko zasobów najwyższego poziomu. Dołączone — ten zasób został już dołączony przez określony łącznik. NotOnboarded — ten zasób nie został dołączony do żadnego łącznika. NotApplicable — stan dołączania nie ma zastosowania do bieżącego punktu końcowego.

Nazwa	Typ	Opis
NotApplicable	string
NotOnboarded	string
Onboarded	string
OnboardedByOtherConnector	string

RuleCategory

Kategorie reguł. Kod — wyniki skanowania kodu. Wyniki skanowania artefaktów. Wyniki skanowania zależności. Wyniki IaC. Wpisy tajne skanują wyniki. Wyniki skanowania kontenerów.

Nazwa	Typ	Opis
Artifacts	string
Code	string
Containers	string
Dependencies	string
IaC	string
Secrets	string

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string	Znacznik czasu ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.

TargetBranchConfiguration

Konfiguracja gałęzi repozytorium dla adnotacji żądania ściągnięcia.

Nazwa	Typ	Opis
annotateDefaultBranch	AnnotateDefaultBranchState	Konfiguracja adnotacji żądania ściągnięcia w gałęzi domyślnej. Włączone — adnotacje żądania ściągnięcia są włączone w domyślnej gałęzi zasobu. Wyłączone — adnotacje żądania ściągnięcia są wyłączone w domyślnej gałęzi zasobu.
branchNames	string[]	Pobiera lub ustawia gałęzie, które powinny mieć adnotacje.

Nazwa

Typ

Opis

annotateDefaultBranch

AnnotateDefaultBranchState

Konfiguracja adnotacji żądania ściągnięcia w gałęzi domyślnej.

Włączone — adnotacje żądania ściągnięcia są włączone w domyślnej gałęzi zasobu. Wyłączone — adnotacje żądania ściągnięcia są wyłączone w domyślnej gałęzi zasobu.

branchNames

string[]

Pobiera lub ustawia gałęzie, które powinny mieć adnotacje.

Udostępnij za pośrednictwem

Azure DevOps Projects - Create Or Update

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Zabezpieczenia

azure_auth

Zakresy

Przykłady

CreateOrUpdate_AzureDevOpsProjects

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

ActionableRemediation

ActionableRemediationState

AnnotateDefaultBranchState

AzureDevOpsProject

AzureDevOpsProjectProperties

CategoryConfiguration

createdByType

DevOpsProvisioningState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

InheritFromParentState

OnboardingState

RuleCategory

systemData

TargetBranchConfiguration

Dodatkowe zasoby