Freigeben über


Azure DevOps Orgs - Update

Updates monitored Azure DevOps organization details.

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

URI Parameters

Name In Required Type Description
orgName
path True

string

The Azure DevOps organization name.

resourceGroupName
path True

string

The name of the resource group. The name is case insensitive.

securityConnectorName
path True

string

The security connector name.

subscriptionId
path True

string

The ID of the target subscription.

api-version
query True

string

The API version to use for this operation.

Request Body

Name Type Description
properties

AzureDevOpsOrgProperties

Azure DevOps Organization properties.

Responses

Name Type Description
200 OK

AzureDevOpsOrg

OK

202 Accepted

AzureDevOpsOrg

Accepted

Other Status Codes

ErrorResponse

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

Update_AzureDevOpsOrgs

Sample request

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

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

Sample response

{
  "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-04-01
{
  "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"
}

Definitions

Name Description
ActionableRemediation

Configuration payload for PR Annotations.

ActionableRemediationState

ActionableRemediation Setting. None - the setting was never set. Enabled - ActionableRemediation is enabled. Disabled - ActionableRemediation is disabled.

AnnotateDefaultBranchState

Configuration of PR Annotations on default branch.

Enabled - PR Annotations are enabled on the resource's default branch. Disabled - PR Annotations are disabled on the resource's default branch.

AzureDevOpsOrg

Azure DevOps Organization resource.

AzureDevOpsOrgProperties

Azure DevOps Organization properties.

CategoryConfiguration

Severity level per category configuration for PR Annotations.

createdByType

The type of identity that created the resource.

DevOpsProvisioningState

The provisioning state of the resource.

Pending - Provisioning pending. Failed - Provisioning failed. Succeeded - Successful provisioning. Canceled - Provisioning canceled. PendingDeletion - Deletion pending. DeletionSuccess - Deletion successful. DeletionFailure - Deletion failure.

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response

InheritFromParentState

Update Settings.

Enabled - Resource should inherit configurations from parent. Disabled - Resource should not inherit configurations from parent.

OnboardingState

Details about resource onboarding status across all connectors.

OnboardedByOtherConnector - this resource has already been onboarded to another connector. This is only applicable to top-level resources. Onboarded - this resource has already been onboarded by the specified connector. NotOnboarded - this resource has not been onboarded to any connector. NotApplicable - the onboarding state is not applicable to the current endpoint.

RuleCategory

Rule categories. Code - code scanning results. Artifact scanning results. Dependencies scanning results. IaC results. Secrets scanning results. Container scanning results.

systemData

Metadata pertaining to creation and last modification of the resource.

TargetBranchConfiguration

Repository branch configuration for PR Annotations.

ActionableRemediation

Configuration payload for PR Annotations.

Name Type Description
branchConfiguration

TargetBranchConfiguration

Repository branch configuration for PR Annotations.

categoryConfigurations

CategoryConfiguration[]

Gets or sets list of categories and severity levels.

inheritFromParentState

InheritFromParentState

Update Settings.

Enabled - Resource should inherit configurations from parent. Disabled - Resource should not inherit configurations from parent.

state

ActionableRemediationState

ActionableRemediation Setting. None - the setting was never set. Enabled - ActionableRemediation is enabled. Disabled - ActionableRemediation is disabled.

ActionableRemediationState

ActionableRemediation Setting. None - the setting was never set. Enabled - ActionableRemediation is enabled. Disabled - ActionableRemediation is disabled.

Name Type Description
Disabled

string

Enabled

string

None

string

AnnotateDefaultBranchState

Configuration of PR Annotations on default branch.

Enabled - PR Annotations are enabled on the resource's default branch. Disabled - PR Annotations are disabled on the resource's default branch.

Name Type Description
Disabled

string

Enabled

string

AzureDevOpsOrg

Azure DevOps Organization resource.

Name Type Description
id

string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

The name of the resource

properties

AzureDevOpsOrgProperties

Azure DevOps Organization properties.

systemData

systemData

Metadata pertaining to creation and last modification of the resource.

type

string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

AzureDevOpsOrgProperties

Azure DevOps Organization properties.

Name Type Description
actionableRemediation

ActionableRemediation

Configuration payload for PR Annotations.

onboardingState

OnboardingState

Details about resource onboarding status across all connectors.

OnboardedByOtherConnector - this resource has already been onboarded to another connector. This is only applicable to top-level resources. Onboarded - this resource has already been onboarded by the specified connector. NotOnboarded - this resource has not been onboarded to any connector. NotApplicable - the onboarding state is not applicable to the current endpoint.

provisioningState

DevOpsProvisioningState

The provisioning state of the resource.

Pending - Provisioning pending. Failed - Provisioning failed. Succeeded - Successful provisioning. Canceled - Provisioning canceled. PendingDeletion - Deletion pending. DeletionSuccess - Deletion successful. DeletionFailure - Deletion failure.

provisioningStatusMessage

string

Gets or sets resource status message.

provisioningStatusUpdateTimeUtc

string

Gets or sets time when resource was last checked.

CategoryConfiguration

Severity level per category configuration for PR Annotations.

Name Type Description
category

RuleCategory

Rule categories. Code - code scanning results. Artifact scanning results. Dependencies scanning results. IaC results. Secrets scanning results. Container scanning results.

minimumSeverityLevel

string

Gets or sets minimum severity level for a given category.

createdByType

The type of identity that created the resource.

Name Type Description
Application

string

Key

string

ManagedIdentity

string

User

string

DevOpsProvisioningState

The provisioning state of the resource.

Pending - Provisioning pending. Failed - Provisioning failed. Succeeded - Successful provisioning. Canceled - Provisioning canceled. PendingDeletion - Deletion pending. DeletionSuccess - Deletion successful. DeletionFailure - Deletion failure.

Name Type Description
Canceled

string

DeletionFailure

string

DeletionSuccess

string

Failed

string

Pending

string

PendingDeletion

string

Succeeded

string

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.

type

string

The additional info type.

ErrorDetail

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.

code

string

The error code.

details

ErrorDetail[]

The error details.

message

string

The error message.

target

string

The error target.

ErrorResponse

Error response

Name Type Description
error

ErrorDetail

The error object.

InheritFromParentState

Update Settings.

Enabled - Resource should inherit configurations from parent. Disabled - Resource should not inherit configurations from parent.

Name Type Description
Disabled

string

Enabled

string

OnboardingState

Details about resource onboarding status across all connectors.

OnboardedByOtherConnector - this resource has already been onboarded to another connector. This is only applicable to top-level resources. Onboarded - this resource has already been onboarded by the specified connector. NotOnboarded - this resource has not been onboarded to any connector. NotApplicable - the onboarding state is not applicable to the current endpoint.

Name Type Description
NotApplicable

string

NotOnboarded

string

Onboarded

string

OnboardedByOtherConnector

string

RuleCategory

Rule categories. Code - code scanning results. Artifact scanning results. Dependencies scanning results. IaC results. Secrets scanning results. Container scanning results.

Name Type Description
Artifacts

string

Code

string

Containers

string

Dependencies

string

IaC

string

Secrets

string

systemData

Metadata pertaining to creation and last modification of the resource.

Name Type Description
createdAt

string

The timestamp of resource creation (UTC).

createdBy

string

The identity that created the resource.

createdByType

createdByType

The type of identity that created the resource.

lastModifiedAt

string

The timestamp of resource last modification (UTC)

lastModifiedBy

string

The identity that last modified the resource.

lastModifiedByType

createdByType

The type of identity that last modified the resource.

TargetBranchConfiguration

Repository branch configuration for PR Annotations.

Name Type Description
annotateDefaultBranch

AnnotateDefaultBranchState

Configuration of PR Annotations on default branch.

Enabled - PR Annotations are enabled on the resource's default branch. Disabled - PR Annotations are disabled on the resource's default branch.

branchNames

string[]

Gets or sets branches that should have annotations.