Azure DevOps Repos - Create Or Update

Riferimento

Servizio:: Defender for Cloud

Versione API:: 2024-05-15-preview

Crea o aggiorna una risorsa del repository Azure DevOps monitorata.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
orgName	path	True	string	Nome dell'organizzazione di Azure DevOps.
projectName	path	True	string	Nome del progetto.
repoName	path	True	string	Nome del repository.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.
securityConnectorName	path	True	string	Nome del connettore di sicurezza.
subscriptionId	path	True	string minLength: 1	ID della sottoscrizione di destinazione.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome	Tipo	Descrizione
properties	AzureDevOpsRepositoryProperties	Proprietà del repository Azure DevOps.

Risposte

Nome	Tipo	Descrizione
200 OK	AzureDevOpsRepository	Crea o aggiorna una risorsa del repository Azure DevOps monitorata
201 Created	AzureDevOpsRepository	Creato
Other Status Codes	ErrorResponse	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

CreateOrUpdate_AzureDevOpsRepos

PUT https://management.azure.com/subscriptions/0806e1cd-cfda-4ff8-b99c-2b0af42cffd3/resourceGroups/myRg/providers/Microsoft.Security/securityConnectors/mySecurityConnectorName/devops/default/azureDevOpsOrgs/myAzDevOpsOrg/projects/myAzDevOpsProject/repos/myAzDevOpsRepo?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.AzureDevOpsRepositoryProperties;
import com.azure.resourcemanager.security.models.OnboardingState;

/**
 * Samples for AzureDevOpsRepos CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/preview/2024-05-15-preview/examples/
     * SecurityConnectorsDevOps/CreateOrUpdateAzureDevOpsRepos_example.json
     */
    /**
     * Sample code: CreateOrUpdate_AzureDevOpsRepos.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void createOrUpdateAzureDevOpsRepos(com.azure.resourcemanager.security.SecurityManager manager) {
        manager.azureDevOpsRepos().define("myAzDevOpsRepo")
            .withExistingProject("myRg", "mySecurityConnectorName", "myAzDevOpsOrg", "myAzDevOpsProject")
            .withProperties(new AzureDevOpsRepositoryProperties().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

Risposta di esempio

Codice di stato:: 200

{
  "properties": {
    "parentOrgName": "myAzDevOpsOrg",
    "parentProjectName": "myAzDevOpsProject",
    "repoId": "cb64ab91-c9ba-46df-b44c-c769358bccdf",
    "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/repos/myAzDevOpsRepo",
  "name": "myAzDevOpsRepo",
  "type": "Microsoft.Security/securityConnectors/devops/azureDevOpsOrgs/projects/repos"
}

Codice di stato:: 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",
    "parentProjectName": "myAzDevOpsProject",
    "repoId": "cb64ab91-c9ba-46df-b44c-c769358bccdf",
    "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/repos/myAzDevOpsRepo",
  "name": "myAzDevOpsRepo",
  "type": "Microsoft.Security/securityConnectors/devops/azureDevOpsOrgs/projects/repos"
}

Definizioni

Nome	Descrizione
ActionableRemediation	Payload di configurazione per le annotazioni pull.
ActionableRemediationState	Impostazione actionableRemediation. Nessuno: l'impostazione non è mai stata impostata. Abilitato: actionableRemediation è abilitato. Disabilitato: actionableRemediation è disabilitato.
AnnotateDefaultBranchState	Configurazione delle annotazioni pull nel ramo predefinito. Abilitato: le annotazioni pull sono abilitate nel ramo predefinito della risorsa. Disabilitato: le annotazioni pull sono disabilitate nel ramo predefinito della risorsa.
AzureDevOpsRepository	Risorsa del repository DevOps di Azure.
AzureDevOpsRepositoryProperties	Proprietà del repository Azure DevOps.
CategoryConfiguration	Livello di gravità per ogni configurazione di categoria per le annotazioni pull.
createdByType	Tipo di identità che ha creato la risorsa.
DevOpsProvisioningState	Stato di provisioning della risorsa. In sospeso: provisioning in sospeso. Operazione non riuscita: il provisioning non è riuscito. Operazione riuscita: provisioning riuscito. Annullata: provisioning annullato. PendingDeletion : eliminazione in sospeso. DeletionSuccess - Eliminazione completata. DeletionFailure - Errore di eliminazione.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
InheritFromParentState	Aggiorna impostazioni. Abilitato: la risorsa deve ereditare le configurazioni dall'elemento padre. Disabilitato: la risorsa non deve ereditare le configurazioni dall'elemento padre.
OnboardingState	Informazioni dettagliate sullo stato di onboarding delle risorse in tutti i connettori. OnboardedByOtherConnector: questa risorsa è già stata sottoposta a onboarding in un altro connettore. Questo è applicabile solo alle risorse di primo livello. Onboarding: questa risorsa è già stata caricati dal connettore specificato. NotOnboarded: questa risorsa non è stata caricati in alcun connettore. NotApplicable: lo stato di onboarding non è applicabile all'endpoint corrente.
RuleCategory	Categorie di regole. Codice: risultati dell'analisi del codice. Risultati dell'analisi degli artefatti. Risultati dell'analisi delle dipendenze. Risultati IaC. Risultati dell'analisi dei segreti. Risultati dell'analisi dei contenitori.
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.
TargetBranchConfiguration	Configurazione del ramo del repository per le annotazioni pull.

ActionableRemediation

Object

Payload di configurazione per le annotazioni pull.

Nome	Tipo	Descrizione
branchConfiguration	TargetBranchConfiguration	Configurazione del ramo del repository per le annotazioni pull.
categoryConfigurations	CategoryConfiguration[]	Ottiene o imposta un elenco di categorie e livelli di gravità.
inheritFromParentState	InheritFromParentState	Aggiorna impostazioni. Abilitato: la risorsa deve ereditare le configurazioni dall'elemento padre. Disabilitato: la risorsa non deve ereditare le configurazioni dall'elemento padre.
state	ActionableRemediationState	Impostazione actionableRemediation. Nessuno: l'impostazione non è mai stata impostata. Abilitato: actionableRemediation è abilitato. Disabilitato: actionableRemediation è disabilitato.

ActionableRemediationState

Enumerazione

Impostazione actionableRemediation. Nessuno: l'impostazione non è mai stata impostata. Abilitato: actionableRemediation è abilitato. Disabilitato: actionableRemediation è disabilitato.

Valore	Descrizione
Disabled
Enabled
None

AnnotateDefaultBranchState

Enumerazione

Configurazione delle annotazioni pull nel ramo predefinito.

Abilitato: le annotazioni pull sono abilitate nel ramo predefinito della risorsa. Disabilitato: le annotazioni pull sono disabilitate nel ramo predefinito della risorsa.

Valore	Descrizione
Disabled
Enabled

AzureDevOpsRepository

Object

Risorsa del repository DevOps di Azure.

Nome	Tipo	Descrizione
id	string	ID risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nome della risorsa
properties	AzureDevOpsRepositoryProperties	Proprietà del repository Azure DevOps.
systemData	systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.
type	string	Tipo della risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

AzureDevOpsRepositoryProperties

Object

Proprietà del repository Azure DevOps.

Nome	Tipo	Descrizione
actionableRemediation	ActionableRemediation	Payload di configurazione per le annotazioni pull.
onboardingState	OnboardingState	Informazioni dettagliate sullo stato di onboarding delle risorse in tutti i connettori. OnboardedByOtherConnector: questa risorsa è già stata sottoposta a onboarding in un altro connettore. Questo è applicabile solo alle risorse di primo livello. Onboarding: questa risorsa è già stata caricati dal connettore specificato. NotOnboarded: questa risorsa non è stata caricati in alcun connettore. NotApplicable: lo stato di onboarding non è applicabile all'endpoint corrente.
parentOrgName	string	Ottiene o imposta il nome dell'organizzazione di Azure DevOps padre.
parentProjectName	string	Ottiene o imposta il nome del progetto Azure DevOps padre.
provisioningState	DevOpsProvisioningState	Stato di provisioning della risorsa. In sospeso: provisioning in sospeso. Operazione non riuscita: il provisioning non è riuscito. Operazione riuscita: provisioning riuscito. Annullata: provisioning annullato. PendingDeletion : eliminazione in sospeso. DeletionSuccess - Eliminazione completata. DeletionFailure - Errore di eliminazione.
provisioningStatusMessage	string	Ottiene il messaggio di stato della risorsa.
provisioningStatusUpdateTimeUtc	string (date-time)	Ottiene l'ora dell'ultima verifica della risorsa.
repoId	string	Ottiene o imposta l'ID del repository Di Azure DevOps.
repoUrl	string	Ottiene o imposta l'URL del repository Di Azure DevOps.
visibility	string	Ottiene o imposta la visibilità del repository Di Azure DevOps, sia pubblica che privata e così via.

CategoryConfiguration

Object

Livello di gravità per ogni configurazione di categoria per le annotazioni pull.

Nome	Tipo	Descrizione
category	RuleCategory	Categorie di regole. Codice: risultati dell'analisi del codice. Risultati dell'analisi degli artefatti. Risultati dell'analisi delle dipendenze. Risultati IaC. Risultati dell'analisi dei segreti. Risultati dell'analisi dei contenitori.
minimumSeverityLevel	string	Ottiene o imposta il livello di gravità minimo per una determinata categoria.

createdByType

Enumerazione

Tipo di identità che ha creato la risorsa.

Valore	Descrizione
Application
Key
ManagedIdentity
User

DevOpsProvisioningState

Enumerazione

Stato di provisioning della risorsa.

In sospeso: provisioning in sospeso. Operazione non riuscita: il provisioning non è riuscito. Operazione riuscita: provisioning riuscito. Annullata: provisioning annullato. PendingDeletion : eliminazione in sospeso. DeletionSuccess - Eliminazione completata. DeletionFailure - Errore di eliminazione.

Valore	Descrizione
Canceled
DeletionFailure
DeletionSuccess
Failed
Pending
PendingDeletion
Succeeded

ErrorAdditionalInfo

Object

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Object

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Object

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

InheritFromParentState

Enumerazione

Aggiorna impostazioni.

Abilitato: la risorsa deve ereditare le configurazioni dall'elemento padre. Disabilitato: la risorsa non deve ereditare le configurazioni dall'elemento padre.

Valore	Descrizione
Disabled
Enabled

OnboardingState

Enumerazione

Informazioni dettagliate sullo stato di onboarding delle risorse in tutti i connettori.

OnboardedByOtherConnector: questa risorsa è già stata sottoposta a onboarding in un altro connettore. Questo è applicabile solo alle risorse di primo livello. Onboarding: questa risorsa è già stata caricati dal connettore specificato. NotOnboarded: questa risorsa non è stata caricati in alcun connettore. NotApplicable: lo stato di onboarding non è applicabile all'endpoint corrente.

Valore	Descrizione
NotApplicable
NotOnboarded
Onboarded
OnboardedByOtherConnector

RuleCategory

Enumerazione

Categorie di regole. Codice: risultati dell'analisi del codice. Risultati dell'analisi degli artefatti. Risultati dell'analisi delle dipendenze. Risultati IaC. Risultati dell'analisi dei segreti. Risultati dell'analisi dei contenitori.

Valore	Descrizione
Artifacts
Code
Containers
Dependencies
IaC
Secrets

systemData

Object

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string (date-time)	Timestamp della creazione della risorsa (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string (date-time)	Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima volta la risorsa.

TargetBranchConfiguration

Object

Configurazione del ramo del repository per le annotazioni pull.

Nome	Tipo	Descrizione
annotateDefaultBranch	AnnotateDefaultBranchState	Configurazione delle annotazioni pull nel ramo predefinito. Abilitato: le annotazioni pull sono abilitate nel ramo predefinito della risorsa. Disabilitato: le annotazioni pull sono disabilitate nel ramo predefinito della risorsa.
branchNames	string[]	Ottiene o imposta rami che devono avere annotazioni.

Nome

Tipo

Descrizione

annotateDefaultBranch

AnnotateDefaultBranchState

Configurazione delle annotazioni pull nel ramo predefinito.

Abilitato: le annotazioni pull sono abilitate nel ramo predefinito della risorsa. Disabilitato: le annotazioni pull sono disabilitate nel ramo predefinito della risorsa.

branchNames

string[]

Ottiene o imposta rami che devono avere annotazioni.

Condividi tramite

Azure DevOps Repos - Create Or Update

Parametri dell'URI

Corpo della richiesta

Risposte

Sicurezza

azure_auth

Ambiti

Esempio

CreateOrUpdate_AzureDevOpsRepos

Esempio di richiesta

Risposta di esempio

Definizioni

ActionableRemediation

ActionableRemediationState

AnnotateDefaultBranchState

AzureDevOpsRepository

AzureDevOpsRepositoryProperties

CategoryConfiguration

createdByType

DevOpsProvisioningState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

InheritFromParentState

OnboardingState

RuleCategory

systemData

TargetBranchConfiguration

Risorse aggiuntive