Azure DevOps Projects - Update

Reference

Service:: Defender for Cloud

API Version:: 2024-05-15-preview

Updates a monitored Azure DevOps project resource.

PATCH 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

URI Parameters

Name	In	Required	Type	Description
orgName	path	True	string	The Azure DevOps organization name.
projectName	path	True	string	The project 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	AzureDevOpsProjectProperties	Azure DevOps Project properties.

Responses

Name	Type	Description
200 OK	AzureDevOpsProject	OK
202 Accepted	AzureDevOpsProject	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_AzureDevOpsProjects

PATCH 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.AzureDevOpsProject;
import com.azure.resourcemanager.security.models.AzureDevOpsProjectProperties;
import com.azure.resourcemanager.security.models.OnboardingState;

/**
 * Samples for AzureDevOpsProjects Update.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/preview/2024-05-15-preview/examples/
     * SecurityConnectorsDevOps/UpdateAzureDevOpsProjects_example.json
     */
    /**
     * Sample code: Update_AzureDevOpsProjects.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void updateAzureDevOpsProjects(com.azure.resourcemanager.security.SecurityManager manager) {
        AzureDevOpsProject resource = manager.azureDevOpsProjects().getWithResponse("myRg", "mySecurityConnectorName",
            "myAzDevOpsOrg", "myAzDevOpsProject", com.azure.core.util.Context.NONE).getValue();
        resource.update()
            .withProperties(new AzureDevOpsProjectProperties().withOnboardingState(OnboardingState.NOT_APPLICABLE)
                .withActionableRemediation(new ActionableRemediation().withState(ActionableRemediationState.ENABLED)))
            .apply();
    }
}

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

Sample response

Status code:: 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"
}

Status code:: 202

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"
}

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.
AzureDevOpsProject	Azure DevOps Project resource.
AzureDevOpsProjectProperties	Azure DevOps Project 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

AzureDevOpsProject

Azure DevOps Project 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	AzureDevOpsProjectProperties	Azure DevOps Project 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"

AzureDevOpsProjectProperties

Azure DevOps Project 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.
parentOrgName	string	Gets or sets parent Azure DevOps Organization name.
projectId	string	Gets or sets Azure DevOps Project id.
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 the resource status message.
provisioningStatusUpdateTimeUtc	string	Gets the 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.

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.

Share via

Azure DevOps Projects - Update

URI Parameters

Request Body

Responses

Security

azure_auth

Scopes

Examples

Update_AzureDevOpsProjects

Sample request

Sample response

Definitions

ActionableRemediation

ActionableRemediationState

AnnotateDefaultBranchState

AzureDevOpsProject

AzureDevOpsProjectProperties

CategoryConfiguration

createdByType

DevOpsProvisioningState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

InheritFromParentState

OnboardingState

RuleCategory

systemData

TargetBranchConfiguration

Additional resources