Azure DevOps Projects - Update

參考

服務:: Defender for Cloud

API 版本:: 2024-05-15-preview

更新受監視的 Azure DevOps 項目資源。

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 參數

名稱	位於	必要	類型	Description
orgName	path	True	string	Azure DevOps 組織名稱。
projectName	path	True	string	專案名稱。
resourceGroupName	path	True	string	資源群組的名稱。名稱不區分大小寫。
securityConnectorName	path	True	string	安全性連接器名稱。
subscriptionId	path	True	string	目標訂用帳戶的標識碼。
api-version	query	True	string	要用於這項作業的 API 版本。

要求本文

名稱	類型	Description
properties	AzureDevOpsProjectProperties	Azure DevOps Project 屬性。

回應

名稱	類型	Description
200 OK	AzureDevOpsProject	還行
202 Accepted	AzureDevOpsProject	接受
Other Status Codes	ErrorResponse	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

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

範例回覆

狀態碼:: 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"
}

狀態碼:: 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"
}

定義

名稱	Description
ActionableRemediation	PR 批注的設定承載。
ActionableRemediationState	ActionableRemediation 設定。無 - 從未設定此設定。 Enabled - 已啟用 ActionableRemediation。 Disabled - 已停用 ActionableRemediation。
AnnotateDefaultBranchState	在預設分支上設定PR批注。已啟用 - 資源的預設分支上會啟用PR批注。已停用 - 資源的預設分支上會停用PR批注。
AzureDevOpsProject	Azure DevOps Project 資源。
AzureDevOpsProjectProperties	Azure DevOps Project 屬性。
CategoryConfiguration	PR 註釋的每個類別設定嚴重性層級。
createdByType	建立資源的身分識別類型。
DevOpsProvisioningState	資源的布建狀態。擱置 - 布建擱置中。失敗 - 布建失敗。成功 - 布建成功。已取消 - 已取消布建。 PendingDeletion - 刪除擱置中。 DeletionSuccess - 刪除成功。 DeletionFailure - 刪除失敗。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
InheritFromParentState	更新設定。已啟用 - 資源應該繼承父系的組態。已停用 - 資源不應該繼承父系的組態。
OnboardingState	所有連接器的資源上線狀態詳細數據。 OnboardedByOtherConnector - 此資源已上線至另一個連接器。這隻適用於最上層資源。上線 - 此資源已由指定的連接器上線。 NotOnboarded - 此資源尚未上線至任何連接器。 NotApplicable - 上線狀態不適用於目前的端點。
RuleCategory	規則類別。程式代碼 - 程式代碼掃描結果。成品掃描結果。相依性掃描結果。 IaC 結果。秘密掃描結果。容器掃描結果。
systemData	與建立和上次修改資源相關的元數據。
TargetBranchConfiguration	PR 批注的存放庫分支組態。

ActionableRemediation

PR 批注的設定承載。

名稱	類型	Description
branchConfiguration	TargetBranchConfiguration	PR 批注的存放庫分支組態。
categoryConfigurations	CategoryConfiguration[]	取得或設定類別和嚴重性層級的清單。
inheritFromParentState	InheritFromParentState	更新設定。已啟用 - 資源應該繼承父系的組態。已停用 - 資源不應該繼承父系的組態。
state	ActionableRemediationState	ActionableRemediation 設定。無 - 從未設定此設定。 Enabled - 已啟用 ActionableRemediation。 Disabled - 已停用 ActionableRemediation。

ActionableRemediationState

ActionableRemediation 設定。無 - 從未設定此設定。 Enabled - 已啟用 ActionableRemediation。 Disabled - 已停用 ActionableRemediation。

名稱	類型	Description
Disabled	string
Enabled	string
None	string

AnnotateDefaultBranchState

在預設分支上設定PR批注。

已啟用 - 資源的預設分支上會啟用PR批注。已停用 - 資源的預設分支上會停用PR批注。

名稱	類型	Description
Disabled	string
Enabled	string

AzureDevOpsProject

Azure DevOps Project 資源。

名稱	類型	Description
id	string	資源的完整資源標識碼。例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	資源的名稱
properties	AzureDevOpsProjectProperties	Azure DevOps Project 屬性。
systemData	systemData	與建立和上次修改資源相關的元數據。
type	string	資源的型別。例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

AzureDevOpsProjectProperties

Azure DevOps Project 屬性。

名稱	類型	Description
actionableRemediation	ActionableRemediation	PR 批注的設定承載。
onboardingState	OnboardingState	所有連接器的資源上線狀態詳細數據。 OnboardedByOtherConnector - 此資源已上線至另一個連接器。這隻適用於最上層資源。上線 - 此資源已由指定的連接器上線。 NotOnboarded - 此資源尚未上線至任何連接器。 NotApplicable - 上線狀態不適用於目前的端點。
parentOrgName	string	取得或設定父代 Azure DevOps 組織名稱。
projectId	string	取得或設定 Azure DevOps 項目識別碼。
provisioningState	DevOpsProvisioningState	資源的布建狀態。擱置 - 布建擱置中。失敗 - 布建失敗。成功 - 布建成功。已取消 - 已取消布建。 PendingDeletion - 刪除擱置中。 DeletionSuccess - 刪除成功。 DeletionFailure - 刪除失敗。
provisioningStatusMessage	string	取得資源狀態消息。
provisioningStatusUpdateTimeUtc	string	取得上次檢查資源的時間。

CategoryConfiguration

PR 註釋的每個類別設定嚴重性層級。

名稱	類型	Description
category	RuleCategory	規則類別。程式代碼 - 程式代碼掃描結果。成品掃描結果。相依性掃描結果。 IaC 結果。秘密掃描結果。容器掃描結果。
minimumSeverityLevel	string	取得或設定指定類別的最小嚴重性層級。

createdByType

建立資源的身分識別類型。

名稱	類型	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DevOpsProvisioningState

資源的布建狀態。

擱置 - 布建擱置中。失敗 - 布建失敗。成功 - 布建成功。已取消 - 已取消布建。 PendingDeletion - 刪除擱置中。 DeletionSuccess - 刪除成功。 DeletionFailure - 刪除失敗。

名稱	類型	Description
Canceled	string
DeletionFailure	string
DeletionSuccess	string
Failed	string
Pending	string
PendingDeletion	string
Succeeded	string

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細數據。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。

InheritFromParentState

更新設定。

已啟用 - 資源應該繼承父系的組態。已停用 - 資源不應該繼承父系的組態。

名稱	類型	Description
Disabled	string
Enabled	string

OnboardingState

所有連接器的資源上線狀態詳細數據。

OnboardedByOtherConnector - 此資源已上線至另一個連接器。這隻適用於最上層資源。上線 - 此資源已由指定的連接器上線。 NotOnboarded - 此資源尚未上線至任何連接器。 NotApplicable - 上線狀態不適用於目前的端點。

名稱	類型	Description
NotApplicable	string
NotOnboarded	string
Onboarded	string
OnboardedByOtherConnector	string

RuleCategory

規則類別。程式代碼 - 程式代碼掃描結果。成品掃描結果。相依性掃描結果。 IaC 結果。秘密掃描結果。容器掃描結果。

名稱	類型	Description
Artifacts	string
Code	string
Containers	string
Dependencies	string
IaC	string
Secrets	string

systemData

與建立和上次修改資源相關的元數據。

名稱	類型	Description
createdAt	string	資源建立的時間戳（UTC）。
createdBy	string	建立資源的身分識別。
createdByType	createdByType	建立資源的身分識別類型。
lastModifiedAt	string	上次修改的資源時間戳（UTC）
lastModifiedBy	string	上次修改資源的身分識別。
lastModifiedByType	createdByType	上次修改資源的身分識別類型。

TargetBranchConfiguration

PR 批注的存放庫分支組態。

名稱	類型	Description
annotateDefaultBranch	AnnotateDefaultBranchState	在預設分支上設定PR批注。已啟用 - 資源的預設分支上會啟用PR批注。已停用 - 資源的預設分支上會停用PR批注。
branchNames	string[]	取得或設定應該具有註釋的分支。

名稱

類型

Description

annotateDefaultBranch

AnnotateDefaultBranchState

在預設分支上設定PR批注。

已啟用 - 資源的預設分支上會啟用PR批注。已停用 - 資源的預設分支上會停用PR批注。

branchNames

string[]

取得或設定應該具有註釋的分支。

共用方式為

Azure DevOps Projects - Update

URI 參數

要求本文

回應

安全性

azure_auth

範圍

範例

Update_AzureDevOpsProjects

範例要求

範例回覆

定義

ActionableRemediation

ActionableRemediationState

AnnotateDefaultBranchState

AzureDevOpsProject

AzureDevOpsProjectProperties

CategoryConfiguration

createdByType

DevOpsProvisioningState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

InheritFromParentState

OnboardingState

RuleCategory

systemData

TargetBranchConfiguration

其他資源