Azure DevOps Projects - Create Or Update

Reference

Služba:: Defender for Cloud

Verze rozhraní API:: 2024-05-15-preview

Vytvoří nebo aktualizuje monitorovaný prostředek projektu 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 identifikátoru URI

Name	V	Vyžadováno	Typ	Description
orgName	path	True	string	Název organizace Azure DevOps
projectName	path	True	string	Název projektu.
resourceGroupName	path	True	string	Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
securityConnectorName	path	True	string	Název konektoru zabezpečení.
subscriptionId	path	True	string	ID cílového předplatného.
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name	Typ	Description
properties	AzureDevOpsProjectProperties	Vlastnosti projektu Azure DevOps

Odpovědi

Name	Typ	Description
200 OK	AzureDevOpsProject	Vytvoří nebo aktualizuje monitorovaný prostředek projektu Azure DevOps.
201 Created	AzureDevOpsProject	Vytvořil
Other Status Codes	ErrorResponse	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

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

Ukázková odpověď

Stavový kód:: 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"
}

Stavový kód:: 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"
}

Definice

Name	Description
ActionableRemediation	Datová část konfigurace pro poznámky k žádosti o přijetí změn
ActionableRemediationState	Nastavení akceableRemediation. Žádné – nastavení nebylo nikdy nastaveno. Povoleno – AkceableRemediation je povolená. Zakázáno – AkceableRemediation je zakázaná.
AnnotateDefaultBranchState	Konfigurace poznámek k žádosti o přijetí změn ve výchozí větvi Povoleno – Poznámky k žádosti o přijetí změn jsou povolené ve výchozí větvi prostředku. Zakázáno – Poznámky k žádosti o přijetí změn jsou ve výchozí větvi prostředku zakázané.
AzureDevOpsProject	Prostředek projektu Azure DevOps
AzureDevOpsProjectProperties	Vlastnosti projektu Azure DevOps
CategoryConfiguration	Úroveň závažnosti na konfiguraci kategorií pro poznámky k žádosti o přijetí změn
createdByType	Typ identity, která prostředek vytvořila.
DevOpsProvisioningState	Stav zřizování prostředku. Čeká se na vyřízení – Čeká se na zřízení. Selhalo – Zřizování se nezdařilo. Úspěšné – úspěšné zřizování. Zrušeno – Zřizování bylo zrušeno. PendingDeletion – Čeká na odstranění. OdstraněníSuccess – Odstranění bylo úspěšné. OdstraněníFailure – Chyba odstranění
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
InheritFromParentState	Aktualizovat nastavení Povoleno – Prostředek by měl dědit konfigurace z nadřazeného objektu. Zakázáno – Prostředek by neměl dědit konfigurace z nadřazeného objektu.
OnboardingState	Podrobnosti o stavu onboardingu prostředků napříč všemi konektory OnboardedByOtherConnector – tento prostředek už byl onboardován k jinému konektoru. To platí jenom pro prostředky nejvyšší úrovně. Onboarded – tento prostředek už byl onboardován zadaným konektorem. NotOnboarded – tento prostředek nebyl onboardován k žádnému konektoru. NotApplicable – stav onboardingu se nevztahuje na aktuální koncový bod.
RuleCategory	Kategorie pravidel Kód – výsledky kontroly kódu Výsledky prohledávání artefaktů Výsledky kontroly závislostí Výsledky IaC. Výsledky prohledávání tajných kódů. Výsledky prohledávání kontejnerů
systemData	Metadata týkající se vytvoření a poslední změny prostředku.
TargetBranchConfiguration	Konfigurace větve úložiště pro poznámky k žádosti o přijetí změn

ActionableRemediation

Datová část konfigurace pro poznámky k žádosti o přijetí změn

Name	Typ	Description
branchConfiguration	TargetBranchConfiguration	Konfigurace větve úložiště pro poznámky k žádosti o přijetí změn
categoryConfigurations	CategoryConfiguration[]	Získá nebo nastaví seznam kategorií a úrovní závažnosti.
inheritFromParentState	InheritFromParentState	Aktualizovat nastavení Povoleno – Prostředek by měl dědit konfigurace z nadřazeného objektu. Zakázáno – Prostředek by neměl dědit konfigurace z nadřazeného objektu.
state	ActionableRemediationState	Nastavení akceableRemediation. Žádné – nastavení nebylo nikdy nastaveno. Povoleno – AkceableRemediation je povolená. Zakázáno – AkceableRemediation je zakázaná.

ActionableRemediationState

Nastavení akceableRemediation. Žádné – nastavení nebylo nikdy nastaveno. Povoleno – AkceableRemediation je povolená. Zakázáno – AkceableRemediation je zakázaná.

Name	Typ	Description
Disabled	string
Enabled	string
None	string

AnnotateDefaultBranchState

Konfigurace poznámek k žádosti o přijetí změn ve výchozí větvi

Povoleno – Poznámky k žádosti o přijetí změn jsou povolené ve výchozí větvi prostředku. Zakázáno – Poznámky k žádosti o přijetí změn jsou ve výchozí větvi prostředku zakázané.

Name	Typ	Description
Disabled	string
Enabled	string

AzureDevOpsProject

Prostředek projektu Azure DevOps

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku pro prostředek. Příklad : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Název prostředku
properties	AzureDevOpsProjectProperties	Vlastnosti projektu Azure DevOps
systemData	systemData	Metadata týkající se vytvoření a poslední změny prostředku.
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

AzureDevOpsProjectProperties

Vlastnosti projektu Azure DevOps

Name	Typ	Description
actionableRemediation	ActionableRemediation	Datová část konfigurace pro poznámky k žádosti o přijetí změn
onboardingState	OnboardingState	Podrobnosti o stavu onboardingu prostředků napříč všemi konektory OnboardedByOtherConnector – tento prostředek už byl onboardován k jinému konektoru. To platí jenom pro prostředky nejvyšší úrovně. Onboarded – tento prostředek už byl onboardován zadaným konektorem. NotOnboarded – tento prostředek nebyl onboardován k žádnému konektoru. NotApplicable – stav onboardingu se nevztahuje na aktuální koncový bod.
parentOrgName	string	Získá nebo nastaví nadřazený název organizace Azure DevOps.
projectId	string	Získá nebo nastaví ID projektu Azure DevOps.
provisioningState	DevOpsProvisioningState	Stav zřizování prostředku. Čeká se na vyřízení – Čeká se na zřízení. Selhalo – Zřizování se nezdařilo. Úspěšné – úspěšné zřizování. Zrušeno – Zřizování bylo zrušeno. PendingDeletion – Čeká na odstranění. OdstraněníSuccess – Odstranění bylo úspěšné. OdstraněníFailure – Chyba odstranění
provisioningStatusMessage	string	Získá zprávu o stavu prostředku.
provisioningStatusUpdateTimeUtc	string	Získá čas poslední kontroly prostředku.

CategoryConfiguration

Úroveň závažnosti na konfiguraci kategorií pro poznámky k žádosti o přijetí změn

Name	Typ	Description
category	RuleCategory	Kategorie pravidel Kód – výsledky kontroly kódu Výsledky prohledávání artefaktů Výsledky kontroly závislostí Výsledky IaC. Výsledky prohledávání tajných kódů. Výsledky prohledávání kontejnerů
minimumSeverityLevel	string	Získá nebo nastaví minimální úroveň závažnosti pro danou kategorii.

createdByType

Typ identity, která prostředek vytvořila.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DevOpsProvisioningState

Stav zřizování prostředku.

Čeká se na vyřízení – Čeká se na zřízení. Selhalo – Zřizování se nezdařilo. Úspěšné – úspěšné zřizování. Zrušeno – Zřizování bylo zrušeno. PendingDeletion – Čeká na odstranění. OdstraněníSuccess – Odstranění bylo úspěšné. OdstraněníFailure – Chyba odstranění

Name	Typ	Description
Canceled	string
DeletionFailure	string
DeletionSuccess	string
Failed	string
Pending	string
PendingDeletion	string
Succeeded	string

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

InheritFromParentState

Aktualizovat nastavení

Povoleno – Prostředek by měl dědit konfigurace z nadřazeného objektu. Zakázáno – Prostředek by neměl dědit konfigurace z nadřazeného objektu.

Name	Typ	Description
Disabled	string
Enabled	string

OnboardingState

Podrobnosti o stavu onboardingu prostředků napříč všemi konektory

OnboardedByOtherConnector – tento prostředek už byl onboardován k jinému konektoru. To platí jenom pro prostředky nejvyšší úrovně. Onboarded – tento prostředek už byl onboardován zadaným konektorem. NotOnboarded – tento prostředek nebyl onboardován k žádnému konektoru. NotApplicable – stav onboardingu se nevztahuje na aktuální koncový bod.

Name	Typ	Description
NotApplicable	string
NotOnboarded	string
Onboarded	string
OnboardedByOtherConnector	string

RuleCategory

Kategorie pravidel Kód – výsledky kontroly kódu Výsledky prohledávání artefaktů Výsledky kontroly závislostí Výsledky IaC. Výsledky prohledávání tajných kódů. Výsledky prohledávání kontejnerů

Name	Typ	Description
Artifacts	string
Code	string
Containers	string
Dependencies	string
IaC	string
Secrets	string

systemData

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string	Časové razítko vytvoření prostředku (UTC).
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string	Časové razítko poslední změny zdroje (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.

TargetBranchConfiguration

Konfigurace větve úložiště pro poznámky k žádosti o přijetí změn

Name	Typ	Description
annotateDefaultBranch	AnnotateDefaultBranchState	Konfigurace poznámek k žádosti o přijetí změn ve výchozí větvi Povoleno – Poznámky k žádosti o přijetí změn jsou povolené ve výchozí větvi prostředku. Zakázáno – Poznámky k žádosti o přijetí změn jsou ve výchozí větvi prostředku zakázané.
branchNames	string[]	Získá nebo nastaví větve, které by měly mít poznámky.

Name

Typ

Description

annotateDefaultBranch

AnnotateDefaultBranchState

Konfigurace poznámek k žádosti o přijetí změn ve výchozí větvi

branchNames

string[]

Získá nebo nastaví větve, které by měly mít poznámky.

Sdílet prostřednictvím

Azure DevOps Projects - Create Or Update

Parametry identifikátoru URI

Text požadavku

Odpovědi

Zabezpečení

azure_auth

Rozsahy

Příklady

CreateOrUpdate_AzureDevOpsProjects

Ukázkový požadavek

Ukázková odpověď

Definice

ActionableRemediation

ActionableRemediationState

AnnotateDefaultBranchState

AzureDevOpsProject

AzureDevOpsProjectProperties

CategoryConfiguration

createdByType

DevOpsProvisioningState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

InheritFromParentState

OnboardingState

RuleCategory

systemData

TargetBranchConfiguration

Další materiály