Dela via


Azure DevOps Orgs - Create Or Update

Skapar eller uppdaterar övervakad Azure DevOps-organisationsinformation.

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

URI-parametrar

Name I Obligatorisk Typ Description
orgName
path True

string

Namnet på Azure DevOps-organisationen.

resourceGroupName
path True

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

securityConnectorName
path True

string

Namnet på säkerhetsanslutningsappen.

subscriptionId
path True

string

ID för målprenumerationen.

api-version
query True

string

DEN API-version som ska användas för den här åtgärden.

Begärandetext

Name Typ Description
properties

AzureDevOpsOrgProperties

Egenskaper för Azure DevOps-organisationen.

Svar

Name Typ Description
200 OK

AzureDevOpsOrg

Skapar eller uppdaterar övervakad Azure DevOps-organisationsinformation

201 Created

AzureDevOpsOrg

Skapad

Other Status Codes

ErrorResponse

Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

CreateOrUpdate_AzureDevOpsOrgs

Exempelbegäran

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

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

Exempelsvar

{
  "properties": {
    "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",
  "name": "myAzDevOpsOrg",
  "type": "Microsoft.Security/securityConnectors/devops/azureDevOpsOrgs"
}
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": {
    "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",
  "name": "myAzDevOpsOrg",
  "type": "Microsoft.Security/securityConnectors/devops/azureDevOpsOrgs"
}

Definitioner

Name Description
ActionableRemediation

Konfigurationsnyttolast för PR-anteckningar.

ActionableRemediationState

ActionableRemediation-inställning. Ingen – inställningen har aldrig angetts. Aktiverad – ActionableRemediation är aktiverat. Inaktiverad – ActionableRemediation är inaktiverad.

AnnotateDefaultBranchState

Konfiguration av PR-anteckningar på standardgrenen.

Aktiverad – PR-anteckningar är aktiverade på resursens standardgren. Inaktiverad – PR-anteckningar är inaktiverade på resursens standardgren.

AzureDevOpsOrg

Azure DevOps Organisationsresurs.

AzureDevOpsOrgProperties

Egenskaper för Azure DevOps-organisationen.

CategoryConfiguration

Allvarlighetsgrad per kategorikonfiguration för PR-anteckningar.

createdByType

Den typ av identitet som skapade resursen.

DevOpsProvisioningState

Resursens etableringstillstånd.

Väntar – etablering väntar. Misslyckades – etableringen misslyckades. Lyckades – etableringen lyckades. Avbröts – Etableringen avbröts. PendingDeletion – Väntar på borttagning. DeletionSuccess – Borttagningen lyckades. DeletionFailure – Borttagningsfel.

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

ErrorDetail

Felinformationen.

ErrorResponse

Felsvar

InheritFromParentState

Uppdateringsinställningar.

Aktiverad – Resursen ska ärva konfigurationer från överordnad. Inaktiverad – Resursen ska inte ärva konfigurationer från överordnad.

OnboardingState

Information om status för resursregistrering för alla anslutningsappar.

OnboardedByOtherConnector – den här resursen har redan registrerats för en annan anslutningsapp. Detta gäller endast för resurser på den översta nivån. Registrerad – den här resursen har redan registrerats av den angivna anslutningsappen. NotOnboarded – den här resursen har inte registrerats för någon anslutningsapp. NotApplicable – registreringstillståndet gäller inte för den aktuella slutpunkten.

RuleCategory

Regelkategorier. Kod – resultat av kodgenomsökning. Resultat av artefaktgenomsökning. Genomsökningsresultat för beroenden. IaC-resultat. Resultat av genomsökning av hemligheter. Resultat av containergenomsökning.

systemData

Metadata som rör skapande och senaste ändring av resursen.

TargetBranchConfiguration

Konfiguration av lagringsplatsgren för PR-anteckningar.

ActionableRemediation

Konfigurationsnyttolast för PR-anteckningar.

Name Typ Description
branchConfiguration

TargetBranchConfiguration

Konfiguration av lagringsplatsgren för PR-anteckningar.

categoryConfigurations

CategoryConfiguration[]

Hämtar eller anger en lista över kategorier och allvarlighetsnivåer.

inheritFromParentState

InheritFromParentState

Uppdateringsinställningar.

Aktiverad – Resursen ska ärva konfigurationer från överordnad. Inaktiverad – Resursen ska inte ärva konfigurationer från överordnad.

state

ActionableRemediationState

ActionableRemediation-inställning. Ingen – inställningen har aldrig angetts. Aktiverad – ActionableRemediation är aktiverat. Inaktiverad – ActionableRemediation är inaktiverad.

ActionableRemediationState

ActionableRemediation-inställning. Ingen – inställningen har aldrig angetts. Aktiverad – ActionableRemediation är aktiverat. Inaktiverad – ActionableRemediation är inaktiverad.

Name Typ Description
Disabled

string

Enabled

string

None

string

AnnotateDefaultBranchState

Konfiguration av PR-anteckningar på standardgrenen.

Aktiverad – PR-anteckningar är aktiverade på resursens standardgren. Inaktiverad – PR-anteckningar är inaktiverade på resursens standardgren.

Name Typ Description
Disabled

string

Enabled

string

AzureDevOpsOrg

Azure DevOps Organisationsresurs.

Name Typ Description
id

string

Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Namnet på resursen

properties

AzureDevOpsOrgProperties

Egenskaper för Azure DevOps-organisationen.

systemData

systemData

Metadata som rör skapande och senaste ändring av resursen.

type

string

Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

AzureDevOpsOrgProperties

Egenskaper för Azure DevOps-organisationen.

Name Typ Description
actionableRemediation

ActionableRemediation

Konfigurationsnyttolast för PR-anteckningar.

onboardingState

OnboardingState

Information om status för resursregistrering för alla anslutningsappar.

OnboardedByOtherConnector – den här resursen har redan registrerats för en annan anslutningsapp. Detta gäller endast för resurser på den översta nivån. Registrerad – den här resursen har redan registrerats av den angivna anslutningsappen. NotOnboarded – den här resursen har inte registrerats för någon anslutningsapp. NotApplicable – registreringstillståndet gäller inte för den aktuella slutpunkten.

provisioningState

DevOpsProvisioningState

Resursens etableringstillstånd.

Väntar – etablering väntar. Misslyckades – etableringen misslyckades. Lyckades – etableringen lyckades. Avbröts – Etableringen avbröts. PendingDeletion – Väntar på borttagning. DeletionSuccess – Borttagningen lyckades. DeletionFailure – Borttagningsfel.

provisioningStatusMessage

string

Hämtar meddelandet om resursstatus.

provisioningStatusUpdateTimeUtc

string

Hämtar den tid då resursen senast kontrollerades.

CategoryConfiguration

Allvarlighetsgrad per kategorikonfiguration för PR-anteckningar.

Name Typ Description
category

RuleCategory

Regelkategorier. Kod – resultat av kodgenomsökning. Resultat av artefaktgenomsökning. Genomsökningsresultat för beroenden. IaC-resultat. Resultat av genomsökning av hemligheter. Resultat av containergenomsökning.

minimumSeverityLevel

string

Hämtar eller anger lägsta allvarlighetsgrad för en viss kategori.

createdByType

Den typ av identitet som skapade resursen.

Name Typ Description
Application

string

Key

string

ManagedIdentity

string

User

string

DevOpsProvisioningState

Resursens etableringstillstånd.

Väntar – etablering väntar. Misslyckades – etableringen misslyckades. Lyckades – etableringen lyckades. Avbröts – Etableringen avbröts. PendingDeletion – Väntar på borttagning. DeletionSuccess – Borttagningen lyckades. DeletionFailure – Borttagningsfel.

Name Typ Description
Canceled

string

DeletionFailure

string

DeletionSuccess

string

Failed

string

Pending

string

PendingDeletion

string

Succeeded

string

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name Typ Description
info

object

Ytterligare information.

type

string

Ytterligare informationstyp.

ErrorDetail

Felinformationen.

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Ytterligare information om felet.

code

string

Felkoden.

details

ErrorDetail[]

Felinformationen.

message

string

Felmeddelandet.

target

string

Felmålet.

ErrorResponse

Felsvar

Name Typ Description
error

ErrorDetail

Felobjektet.

InheritFromParentState

Uppdateringsinställningar.

Aktiverad – Resursen ska ärva konfigurationer från överordnad. Inaktiverad – Resursen ska inte ärva konfigurationer från överordnad.

Name Typ Description
Disabled

string

Enabled

string

OnboardingState

Information om status för resursregistrering för alla anslutningsappar.

OnboardedByOtherConnector – den här resursen har redan registrerats för en annan anslutningsapp. Detta gäller endast för resurser på den översta nivån. Registrerad – den här resursen har redan registrerats av den angivna anslutningsappen. NotOnboarded – den här resursen har inte registrerats för någon anslutningsapp. NotApplicable – registreringstillståndet gäller inte för den aktuella slutpunkten.

Name Typ Description
NotApplicable

string

NotOnboarded

string

Onboarded

string

OnboardedByOtherConnector

string

RuleCategory

Regelkategorier. Kod – resultat av kodgenomsökning. Resultat av artefaktgenomsökning. Genomsökningsresultat för beroenden. IaC-resultat. Resultat av genomsökning av hemligheter. Resultat av containergenomsökning.

Name Typ Description
Artifacts

string

Code

string

Containers

string

Dependencies

string

IaC

string

Secrets

string

systemData

Metadata som rör skapande och senaste ändring av resursen.

Name Typ Description
createdAt

string

Tidsstämpeln för resursskapande (UTC).

createdBy

string

Identiteten som skapade resursen.

createdByType

createdByType

Den typ av identitet som skapade resursen.

lastModifiedAt

string

Tidsstämpeln för resursens senaste ändring (UTC)

lastModifiedBy

string

Identiteten som senast ändrade resursen.

lastModifiedByType

createdByType

Den typ av identitet som senast ändrade resursen.

TargetBranchConfiguration

Konfiguration av lagringsplatsgren för PR-anteckningar.

Name Typ Description
annotateDefaultBranch

AnnotateDefaultBranchState

Konfiguration av PR-anteckningar på standardgrenen.

Aktiverad – PR-anteckningar är aktiverade på resursens standardgren. Inaktiverad – PR-anteckningar är inaktiverade på resursens standardgren.

branchNames

string[]

Hämtar eller anger grenar som ska ha anteckningar.