Azure DevOps Projects - List

Referenz

Dienst:: Defender for Cloud

API-Version:: 2024-04-01

Gibt eine Liste der Azure DevOps-Projekte zurück, die in den Connector integriert sind.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/azureDevOpsOrgs/{orgName}/projects?api-version=2024-04-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
orgName	path	True	string	Der Name der Azure DevOps-Organisation.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
securityConnectorName	path	True	string	Der Name des Sicherheitsconnectors.
subscriptionId	path	True	string minLength: 1	Die ID des Zielabonnements.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	AzureDevOpsProjectListResponse	Stellt eine Liste der Azure DevOps-Projektdetails bereit.
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

List_AzureDevOpsProjects

Beispielanforderung

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


/**
 * Samples for AzureDevOpsProjects List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/stable/2024-04-01/examples/SecurityConnectorsDevOps/
     * ListAzureDevOpsProjects_example.json
     */
    /**
     * Sample code: List_AzureDevOpsProjects.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void listAzureDevOpsProjects(com.azure.resourcemanager.security.SecurityManager manager) {
        manager.azureDevOpsProjects().list("myRg", "mySecurityConnectorName", "myAzDevOpsOrg",
            com.azure.core.util.Context.NONE);
    }
}

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.security import SecurityCenter

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-security
# USAGE
    python list_azure_dev_ops_projects_example.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SecurityCenter(
        credential=DefaultAzureCredential(),
        subscription_id="0806e1cd-cfda-4ff8-b99c-2b0af42cffd3",
    )

    response = client.azure_dev_ops_projects.list(
        resource_group_name="myRg",
        security_connector_name="mySecurityConnectorName",
        org_name="myAzDevOpsOrg",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/security/resource-manager/Microsoft.Security/stable/2024-04-01/examples/SecurityConnectorsDevOps/ListAzureDevOpsProjects_example.json
if __name__ == "__main__":
    main()

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

Beispiel für eine Antwort

Statuscode:: 200

{
  "value": [
    {
      "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"
    }
  ]
}

Definitionen

Name	Beschreibung
ActionableRemediation	Konfigurationsnutzlast für PR-Anmerkungen.
ActionableRemediationState	ActionableRemediation Setting. Keine – die Einstellung wurde nie festgelegt. Aktiviert – ActionableRemediation ist aktiviert. Deaktiviert – ActionableRemediation ist deaktiviert.
AnnotateDefaultBranchState	Konfiguration von PR-Anmerkungen auf Standardverzweigung. Aktiviert – PR-Anmerkungen sind in der Standardverzweigung der Ressource aktiviert. Deaktiviert – PR-Anmerkungen sind in der Standardverzweigung der Ressource deaktiviert.
AzureDevOpsProject	Azure DevOps-Projektressource.
AzureDevOpsProjectListResponse	Liste der RP-Ressourcen, die die Paginierung unterstützen.
AzureDevOpsProjectProperties	Azure DevOps-Projekteigenschaften.
CategoryConfiguration	Schweregrad pro Kategoriekonfiguration für PR-Anmerkungen.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
DevOpsProvisioningState	Der Bereitstellungsstatus der Ressource. Ausstehend – Bereitstellung steht aus. Fehler: Fehler bei der Bereitstellung. Erfolgreich – Erfolgreiche Bereitstellung. Abgebrochen – Bereitstellung abgebrochen. PendingDeletion – Löschvorgang steht aus. DeleteSuccess - Löschvorgang erfolgreich. DeleteFailure - Löschfehler.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
InheritFromParentState	Einstellungen aktualisieren. Aktiviert – Ressource sollte Konfigurationen vom übergeordneten Element erben. Deaktiviert – Ressource sollte keine Konfigurationen vom übergeordneten Element erben.
OnboardingState	Details zum Ressourcen-Onboarding-Status über alle Connectors hinweg. OnboardedByOtherConnector – diese Ressource wurde bereits in einen anderen Connector integriert. Dies gilt nur für Ressourcen der obersten Ebene. Integriert – diese Ressource wurde bereits vom angegebenen Connector integriert. NotOnboarded – diese Ressource wurde nicht in einen Connector integriert. NotApplicable – der Onboardingstatus gilt nicht für den aktuellen Endpunkt.
RuleCategory	Regelkategorien. Code – Ergebnisse der Codeüberprüfung. Ergebnisse der Artefaktüberprüfung. Die Ergebnisse der Überprüfung von Abhängigkeiten werden überprüft. IaC-Ergebnisse. Ergebnisse der Überprüfung geheimer Schlüssel. Ergebnisse des Containerscans.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
TargetBranchConfiguration	Repository branch configuration for PR Annotations.

ActionableRemediation

Objekt

Konfigurationsnutzlast für PR-Anmerkungen.

Name	Typ	Beschreibung
branchConfiguration	TargetBranchConfiguration	Repository branch configuration for PR Annotations.
categoryConfigurations	CategoryConfiguration[]	Dient zum Abrufen oder Festlegen einer Liste von Kategorien und Schweregraden.
inheritFromParentState	InheritFromParentState	Einstellungen aktualisieren. Aktiviert – Ressource sollte Konfigurationen vom übergeordneten Element erben. Deaktiviert – Ressource sollte keine Konfigurationen vom übergeordneten Element erben.
state	ActionableRemediationState	ActionableRemediation Setting. Keine – die Einstellung wurde nie festgelegt. Aktiviert – ActionableRemediation ist aktiviert. Deaktiviert – ActionableRemediation ist deaktiviert.

ActionableRemediationState

Enumeration

ActionableRemediation Setting. Keine – die Einstellung wurde nie festgelegt. Aktiviert – ActionableRemediation ist aktiviert. Deaktiviert – ActionableRemediation ist deaktiviert.

Wert	Beschreibung
Disabled
Enabled
None

AnnotateDefaultBranchState

Enumeration

Konfiguration von PR-Anmerkungen auf Standardverzweigung.

Aktiviert – PR-Anmerkungen sind in der Standardverzweigung der Ressource aktiviert. Deaktiviert – PR-Anmerkungen sind in der Standardverzweigung der Ressource deaktiviert.

Wert	Beschreibung
Disabled
Enabled

AzureDevOpsProject

Objekt

Azure DevOps-Projektressource.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Der Name der Ressource
properties	AzureDevOpsProjectProperties	Azure DevOps-Projekteigenschaften.
systemData	systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

AzureDevOpsProjectListResponse

Objekt

Liste der RP-Ressourcen, die die Paginierung unterstützen.

Name	Typ	Beschreibung
nextLink	string	Ruft den nächsten Link ab, um über die Ergebnisse zu scrollen, oder legt diesen fest.
value	AzureDevOpsProject[]	Dient zum Abrufen oder Festlegen einer Liste von Ressourcen.

AzureDevOpsProjectProperties

Objekt

Azure DevOps-Projekteigenschaften.

Name	Typ	Beschreibung
actionableRemediation	ActionableRemediation	Konfigurationsnutzlast für PR-Anmerkungen.
onboardingState	OnboardingState	Details zum Ressourcen-Onboarding-Status über alle Connectors hinweg. OnboardedByOtherConnector – diese Ressource wurde bereits in einen anderen Connector integriert. Dies gilt nur für Ressourcen der obersten Ebene. Integriert – diese Ressource wurde bereits vom angegebenen Connector integriert. NotOnboarded – diese Ressource wurde nicht in einen Connector integriert. NotApplicable – der Onboardingstatus gilt nicht für den aktuellen Endpunkt.
parentOrgName	string	Ruft den namen der übergeordneten Azure DevOps-Organisation ab oder legt diesen fest.
projectId	string	Ruft die Azure DevOps-Projekt-ID ab oder legt sie fest.
provisioningState	DevOpsProvisioningState	Der Bereitstellungsstatus der Ressource. Ausstehend – Bereitstellung steht aus. Fehler: Fehler bei der Bereitstellung. Erfolgreich – Erfolgreiche Bereitstellung. Abgebrochen – Bereitstellung abgebrochen. PendingDeletion – Löschvorgang steht aus. DeleteSuccess - Löschvorgang erfolgreich. DeleteFailure - Löschfehler.
provisioningStatusMessage	string	Ruft die Ressourcenstatusmeldung ab oder legt sie fest.
provisioningStatusUpdateTimeUtc	string (date-time)	Ruft die Zeit ab, zu der die Ressource zuletzt überprüft wurde, oder legt sie fest.

CategoryConfiguration

Objekt

Schweregrad pro Kategoriekonfiguration für PR-Anmerkungen.

Name	Typ	Beschreibung
category	RuleCategory	Regelkategorien. Code – Ergebnisse der Codeüberprüfung. Ergebnisse der Artefaktüberprüfung. Die Ergebnisse der Überprüfung von Abhängigkeiten werden überprüft. IaC-Ergebnisse. Ergebnisse der Überprüfung geheimer Schlüssel. Ergebnisse des Containerscans.
minimumSeverityLevel	string	Ruft den Mindestschweregrad für eine bestimmte Kategorie ab oder legt diese fest.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
Application
Key
ManagedIdentity
User

DevOpsProvisioningState

Enumeration

Der Bereitstellungsstatus der Ressource.

Ausstehend – Bereitstellung steht aus. Fehler: Fehler bei der Bereitstellung. Erfolgreich – Erfolgreiche Bereitstellung. Abgebrochen – Bereitstellung abgebrochen. PendingDeletion – Löschvorgang steht aus. DeleteSuccess - Löschvorgang erfolgreich. DeleteFailure - Löschfehler.

Wert	Beschreibung
Canceled
DeletionFailure
DeletionSuccess
Failed
Pending
PendingDeletion
Succeeded

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

InheritFromParentState

Enumeration

Einstellungen aktualisieren.

Aktiviert – Ressource sollte Konfigurationen vom übergeordneten Element erben. Deaktiviert – Ressource sollte keine Konfigurationen vom übergeordneten Element erben.

Wert	Beschreibung
Disabled
Enabled

OnboardingState

Enumeration

Details zum Ressourcen-Onboarding-Status über alle Connectors hinweg.

OnboardedByOtherConnector – diese Ressource wurde bereits in einen anderen Connector integriert. Dies gilt nur für Ressourcen der obersten Ebene. Integriert – diese Ressource wurde bereits vom angegebenen Connector integriert. NotOnboarded – diese Ressource wurde nicht in einen Connector integriert. NotApplicable – der Onboardingstatus gilt nicht für den aktuellen Endpunkt.

Wert	Beschreibung
NotApplicable
NotOnboarded
Onboarded
OnboardedByOtherConnector

RuleCategory

Enumeration

Regelkategorien. Code – Ergebnisse der Codeüberprüfung. Ergebnisse der Artefaktüberprüfung. Die Ergebnisse der Überprüfung von Abhängigkeiten werden überprüft. IaC-Ergebnisse. Ergebnisse der Überprüfung geheimer Schlüssel. Ergebnisse des Containerscans.

Wert	Beschreibung
Artifacts
Code
Containers
Dependencies
IaC
Secrets

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

TargetBranchConfiguration

Objekt

Repository branch configuration for PR Annotations.

Name	Typ	Beschreibung
annotateDefaultBranch	AnnotateDefaultBranchState	Konfiguration von PR-Anmerkungen auf Standardverzweigung. Aktiviert – PR-Anmerkungen sind in der Standardverzweigung der Ressource aktiviert. Deaktiviert – PR-Anmerkungen sind in der Standardverzweigung der Ressource deaktiviert.
branchNames	string[]	Dient zum Abrufen oder Festlegen von Verzweigungen, die Anmerkungen enthalten sollen.

Name

Typ

Beschreibung

annotateDefaultBranch

AnnotateDefaultBranchState

Konfiguration von PR-Anmerkungen auf Standardverzweigung.

Aktiviert – PR-Anmerkungen sind in der Standardverzweigung der Ressource aktiviert. Deaktiviert – PR-Anmerkungen sind in der Standardverzweigung der Ressource deaktiviert.

branchNames

string[]

Dient zum Abrufen oder Festlegen von Verzweigungen, die Anmerkungen enthalten sollen.

Freigeben über

Azure DevOps Projects - List

URI-Parameter

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

List_AzureDevOpsProjects

Beispielanforderung

Beispiel für eine Antwort

Definitionen

ActionableRemediation

ActionableRemediationState

AnnotateDefaultBranchState

AzureDevOpsProject

AzureDevOpsProjectListResponse

AzureDevOpsProjectProperties

CategoryConfiguration

createdByType

DevOpsProvisioningState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

InheritFromParentState

OnboardingState

RuleCategory

systemData

TargetBranchConfiguration