Azure DevOps Repos - Update

リファレンス

サービス:: Defender for Cloud

API バージョン:: 2024-04-01

監視対象の Azure DevOps リポジトリリソースを更新します。

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

URI パラメーター

名前	/	必須	型	説明
orgName	path	True	string	Azure DevOps 組織名。
projectName	path	True	string	プロジェクト名。
repoName	path	True	string	リポジトリ名。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソースグループの名前。名前では大文字と小文字が区別されません。
securityConnectorName	path	True	string	セキュリティコネクタ名。
subscriptionId	path	True	string minLength: 1	ターゲットサブスクリプションの ID。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求本文

名前	型	説明
properties	AzureDevOpsRepositoryProperties	Azure DevOps リポジトリのプロパティ。

応答

名前	型	説明
200 OK	AzureDevOpsRepository	わかりました
202 Accepted	AzureDevOpsRepository	受け入れられる
Other Status Codes	ErrorResponse	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

Update_AzureDevOpsRepos

要求のサンプル

PATCH 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-04-01

{
  "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.AzureDevOpsRepository;
import com.azure.resourcemanager.security.models.AzureDevOpsRepositoryProperties;
import com.azure.resourcemanager.security.models.OnboardingState;

/**
 * Samples for AzureDevOpsRepos Update.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/stable/2024-04-01/examples/SecurityConnectorsDevOps/
     * UpdateAzureDevOpsRepos_example.json
     */
    /**
     * Sample code: Update_AzureDevOpsRepos.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void updateAzureDevOpsRepos(com.azure.resourcemanager.security.SecurityManager manager) {
        AzureDevOpsRepository resource = manager.azureDevOpsRepos().getWithResponse("myRg", "mySecurityConnectorName",
            "myAzDevOpsOrg", "myAzDevOpsProject", "myAzDevOpsRepo", com.azure.core.util.Context.NONE).getValue();
        resource.update()
            .withProperties(new AzureDevOpsRepositoryProperties().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

from typing import Any, IO, Union

from azure.identity import DefaultAzureCredential

from azure.mgmt.security import SecurityCenter

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-security
# USAGE
    python update_azure_dev_ops_repos_example.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SecurityCenter(
        credential=DefaultAzureCredential(),
        subscription_id="0806e1cd-cfda-4ff8-b99c-2b0af42cffd3",
    )

    response = client.azure_dev_ops_repos.begin_update(
        resource_group_name="myRg",
        security_connector_name="mySecurityConnectorName",
        org_name="myAzDevOpsOrg",
        project_name="myAzDevOpsProject",
        repo_name="myAzDevOpsRepo",
        azure_dev_ops_repository={
            "properties": {"actionableRemediation": {"state": "Enabled"}, "onboardingState": "NotApplicable"}
        },
    ).result()
    print(response)


# x-ms-original-file: specification/security/resource-manager/Microsoft.Security/stable/2024-04-01/examples/SecurityConnectorsDevOps/UpdateAzureDevOpsRepos_example.json
if __name__ == "__main__":
    main()

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

状態コード:: 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-04-01

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

定義

名前	説明
ActionableRemediation	PR 注釈の構成ペイロード。
ActionableRemediationState	ActionableRemediation の設定。なし - 設定が設定されませんでした。有効 - ActionableRemediation が有効になっています。無効 - ActionableRemediation が無効です。
AnnotateDefaultBranchState	既定のブランチでの PR 注釈の構成。有効 - リソースの既定のブランチで PR 注釈が有効になります。無効 - リソースの既定のブランチで PR 注釈が無効になります。
AzureDevOpsRepository	Azure DevOps リポジトリリソース。
AzureDevOpsRepositoryProperties	Azure DevOps リポジトリのプロパティ。
CategoryConfiguration	PR 注釈のカテゴリ構成ごとの重大度レベル。
createdByType	リソースを作成した ID の種類。
DevOpsProvisioningState	リソースのプロビジョニング状態。保留中 - プロビジョニングが保留中です。失敗 - プロビジョニングに失敗しました。成功 - プロビジョニングに成功しました。キャンセル済み - プロビジョニングが取り消されました。 PendingDeletion - 削除保留中。 DeletionSuccess - 削除に成功しました。 DeletionFailure - 削除エラー。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
InheritFromParentState	設定を更新します。有効 - リソースは親から構成を継承する必要があります。無効 - リソースは親から構成を継承しないでください。
OnboardingState	すべてのコネクタでのリソースオンボードの状態に関する詳細。 OnboardedByOtherConnector - このリソースは既に別のコネクタにオンボードされています。これは、最上位レベルのリソースにのみ適用されます。オンボード - このリソースは、指定されたコネクタによって既にオンボードされています。 NotOnboarded - このリソースはどのコネクタにもオンボードされていません。 NotApplicable - オンボード状態は現在のエンドポイントには適用されません。
RuleCategory	ルールカテゴリ。コード - コードスキャンの結果。成果物のスキャン結果。依存関係のスキャン結果。 IaC の結果。結果をスキャンするシークレット。コンテナーのスキャン結果。
systemData	リソースの作成と最後の変更に関連するメタデータ。
TargetBranchConfiguration	PR 注釈のリポジトリブランチの構成。

ActionableRemediation

Object

PR 注釈の構成ペイロード。

名前	型	説明
branchConfiguration	TargetBranchConfiguration	PR 注釈のリポジトリブランチの構成。
categoryConfigurations	CategoryConfiguration[]	カテゴリと重大度レベルの一覧を取得または設定します。
inheritFromParentState	InheritFromParentState	設定を更新します。有効 - リソースは親から構成を継承する必要があります。無効 - リソースは親から構成を継承しないでください。
state	ActionableRemediationState	ActionableRemediation の設定。なし - 設定が設定されませんでした。有効 - ActionableRemediation が有効になっています。無効 - ActionableRemediation が無効です。

ActionableRemediationState

列挙

ActionableRemediation の設定。なし - 設定が設定されませんでした。有効 - ActionableRemediation が有効になっています。無効 - ActionableRemediation が無効です。

値	説明
Disabled
Enabled
None

AnnotateDefaultBranchState

列挙

既定のブランチでの PR 注釈の構成。

有効 - リソースの既定のブランチで PR 注釈が有効になります。無効 - リソースの既定のブランチで PR 注釈が無効になります。

値	説明
Disabled
Enabled

AzureDevOpsRepository

Object

Azure DevOps リポジトリリソース。

名前	型	説明
id	string	リソースの完全修飾リソース ID。例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	リソースの名前
properties	AzureDevOpsRepositoryProperties	Azure DevOps リポジトリのプロパティ。
systemData	systemData	リソースの作成と最後の変更に関連するメタデータ。
type	string	リソースの種類。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

AzureDevOpsRepositoryProperties

Object

Azure DevOps リポジトリのプロパティ。

名前	型	説明
actionableRemediation	ActionableRemediation	PR 注釈の構成ペイロード。
onboardingState	OnboardingState	すべてのコネクタでのリソースオンボードの状態に関する詳細。 OnboardedByOtherConnector - このリソースは既に別のコネクタにオンボードされています。これは、最上位レベルのリソースにのみ適用されます。オンボード - このリソースは、指定されたコネクタによって既にオンボードされています。 NotOnboarded - このリソースはどのコネクタにもオンボードされていません。 NotApplicable - オンボード状態は現在のエンドポイントには適用されません。
parentOrgName	string	親 Azure DevOps 組織名を取得または設定します。
parentProjectName	string	親 Azure DevOps プロジェクト名を取得または設定します。
provisioningState	DevOpsProvisioningState	リソースのプロビジョニング状態。保留中 - プロビジョニングが保留中です。失敗 - プロビジョニングに失敗しました。成功 - プロビジョニングに成功しました。キャンセル済み - プロビジョニングが取り消されました。 PendingDeletion - 削除保留中。 DeletionSuccess - 削除に成功しました。 DeletionFailure - 削除エラー。
provisioningStatusMessage	string	リソースの状態メッセージを取得または設定します。
provisioningStatusUpdateTimeUtc	string (date-time)	リソースが最後にチェックされた時刻を取得または設定します。
repoId	string	Azure DevOps リポジトリ ID を取得または設定します。
repoUrl	string	Azure DevOps リポジトリの URL を取得または設定します。
visibility	string	パブリックかプライベートかなど、Azure DevOps リポジトリの可視性を取得または設定します。

CategoryConfiguration

Object

PR 注釈のカテゴリ構成ごとの重大度レベル。

名前	型	説明
category	RuleCategory	ルールカテゴリ。コード - コードスキャンの結果。成果物のスキャン結果。依存関係のスキャン結果。 IaC の結果。結果をスキャンするシークレット。コンテナーのスキャン結果。
minimumSeverityLevel	string	特定のカテゴリの最小重大度レベルを取得または設定します。

createdByType

列挙

リソースを作成した ID の種類。

値	説明
Application
Key
ManagedIdentity
User

DevOpsProvisioningState

列挙

リソースのプロビジョニング状態。

保留中 - プロビジョニングが保留中です。失敗 - プロビジョニングに失敗しました。成功 - プロビジョニングに成功しました。キャンセル済み - プロビジョニングが取り消されました。 PendingDeletion - 削除保留中。 DeletionSuccess - 削除に成功しました。 DeletionFailure - 削除エラー。

値	説明
Canceled
DeletionFailure
DeletionSuccess
Failed
Pending
PendingDeletion
Succeeded

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラーメッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラーオブジェクト。

InheritFromParentState

列挙

設定を更新します。

有効 - リソースは親から構成を継承する必要があります。無効 - リソースは親から構成を継承しないでください。

値	説明
Disabled
Enabled

OnboardingState

列挙

すべてのコネクタでのリソースオンボードの状態に関する詳細。

OnboardedByOtherConnector - このリソースは既に別のコネクタにオンボードされています。これは、最上位レベルのリソースにのみ適用されます。オンボード - このリソースは、指定されたコネクタによって既にオンボードされています。 NotOnboarded - このリソースはどのコネクタにもオンボードされていません。 NotApplicable - オンボード状態は現在のエンドポイントには適用されません。

値	説明
NotApplicable
NotOnboarded
Onboarded
OnboardedByOtherConnector

RuleCategory

列挙

ルールカテゴリ。コード - コードスキャンの結果。成果物のスキャン結果。依存関係のスキャン結果。 IaC の結果。結果をスキャンするシークレット。コンテナーのスキャン結果。

値	説明
Artifacts
Code
Containers
Dependencies
IaC
Secrets

systemData

Object

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string (date-time)	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string (date-time)	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

TargetBranchConfiguration

Object

PR 注釈のリポジトリブランチの構成。

名前	型	説明
annotateDefaultBranch	AnnotateDefaultBranchState	既定のブランチでの PR 注釈の構成。有効 - リソースの既定のブランチで PR 注釈が有効になります。無効 - リソースの既定のブランチで PR 注釈が無効になります。
branchNames	string[]	注釈が必要な分岐を取得または設定します。

名前

型

説明

annotateDefaultBranch

AnnotateDefaultBranchState

既定のブランチでの PR 注釈の構成。

有効 - リソースの既定のブランチで PR 注釈が有効になります。無効 - リソースの既定のブランチで PR 注釈が無効になります。

branchNames

string[]

注釈が必要な分岐を取得または設定します。

次の方法で共有

Azure DevOps Repos - Update

URI パラメーター

要求本文

応答

セキュリティ

azure_auth

スコープ

例

Update_AzureDevOpsRepos

要求のサンプル

応答のサンプル

定義

ActionableRemediation

ActionableRemediationState

AnnotateDefaultBranchState

AzureDevOpsRepository

AzureDevOpsRepositoryProperties

CategoryConfiguration

createdByType

DevOpsProvisioningState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

InheritFromParentState

OnboardingState

RuleCategory

systemData

TargetBranchConfiguration