你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

DevOps Configurations - Create Or Update

Service:

Defender for Cloud

API Version:

2024-04-01

Creates or updates a DevOps Configuration.

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

URI Parameters

Name	In	Required	Type	Description
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	DevOpsConfigurationProperties	DevOps Configuration properties.

Responses

Name	Type	Description
200 OK	DevOpsConfiguration	Creates or updates a DevOps Configuration
201 Created	DevOpsConfiguration	Created
202 Accepted	DevOpsConfiguration	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

CreateOrUpdate_DevOpsConfigurations_OnboardCurrentAndFuture

CreateOrUpdate_DevOpsConfigurations_OnboardCurrentOnly

CreateOrUpdate_DevOpsConfigurations_OnboardSelected

CreateOrUpdate_DevOpsConfigurations_OnboardCurrentAndFuture

Sample request

HTTP

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

{
  "properties": {
    "authorization": {
      "code": "00000000000000000000"
    },
    "autoDiscovery": "Enabled"
  }
}

Java

import com.azure.resourcemanager.security.fluent.models.DevOpsConfigurationInner;
import com.azure.resourcemanager.security.models.Authorization;
import com.azure.resourcemanager.security.models.AutoDiscovery;
import com.azure.resourcemanager.security.models.DevOpsConfigurationProperties;
import java.util.Arrays;

/**
 * Samples for DevOpsConfigurations CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/stable/2024-04-01/examples/SecurityConnectorsDevOps/
     * CreateOrUpdateDevOpsConfigurationsOnboardCurrentAndFuture_example.json
     */
    /**
     * Sample code: CreateOrUpdate_DevOpsConfigurations_OnboardCurrentAndFuture.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void createOrUpdateDevOpsConfigurationsOnboardCurrentAndFuture(
        com.azure.resourcemanager.security.SecurityManager manager) {
        manager.devOpsConfigurations().createOrUpdate("myRg", "mySecurityConnectorName",
            new DevOpsConfigurationInner().withProperties(new DevOpsConfigurationProperties()
                .withAuthorization(new Authorization().withCode("fakeTokenPlaceholder"))
                .withAutoDiscovery(AutoDiscovery.ENABLED)),
            com.azure.core.util.Context.NONE);
    }

    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/stable/2024-04-01/examples/SecurityConnectorsDevOps/
     * CreateOrUpdateDevOpsConfigurationsOnboardSelected_example.json
     */
    /**
     * Sample code: CreateOrUpdate_DevOpsConfigurations_OnboardSelected.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void
        createOrUpdateDevOpsConfigurationsOnboardSelected(com.azure.resourcemanager.security.SecurityManager manager) {
        manager.devOpsConfigurations().createOrUpdate("myRg", "mySecurityConnectorName",
            new DevOpsConfigurationInner().withProperties(new DevOpsConfigurationProperties()
                .withAuthorization(new Authorization().withCode("fakeTokenPlaceholder"))
                .withAutoDiscovery(AutoDiscovery.DISABLED).withTopLevelInventoryList(Arrays.asList("org1", "org2"))),
            com.azure.core.util.Context.NONE);
    }
}

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

Python

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 create_or_update_dev_ops_configurations_onboard_current_and_future_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.dev_ops_configurations.begin_create_or_update(
        resource_group_name="myRg",
        security_connector_name="mySecurityConnectorName",
        dev_ops_configuration={
            "properties": {"authorization": {"code": "00000000000000000000"}, "autoDiscovery": "Enabled"}
        },
    ).result()
    print(response)


# x-ms-original-file: specification/security/resource-manager/Microsoft.Security/stable/2024-04-01/examples/SecurityConnectorsDevOps/CreateOrUpdateDevOpsConfigurationsOnboardCurrentAndFuture_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

Sample response

Status code:

200

{
  "properties": {
    "autoDiscovery": "Enabled",
    "provisioningState": "Succeeded"
  },
  "id": "/subscriptions/0806e1cd-cfda-4ff8-b99c-2b0af42cffd3/resourceGroups/myRg/providers/Microsoft.Security/securityConnectors/mySecurityConnectorName/devops/default",
  "name": "default",
  "type": "Microsoft.Security/securityConnectors/devops"
}

Status code:

201

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": {
    "provisioningState": "Accepted"
  },
  "id": "/subscriptions/0806e1cd-cfda-4ff8-b99c-2b0af42cffd3/resourceGroups/myRg/providers/Microsoft.Security/securityConnectors/mySecurityConnectorName/devops/default",
  "name": "default",
  "type": "Microsoft.Security/securityConnectors/devops"
}

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

{
  "properties": {
    "provisioningState": "Accepted"
  },
  "id": "/subscriptions/0806e1cd-cfda-4ff8-b99c-2b0af42cffd3/resourceGroups/myRg/providers/Microsoft.Security/securityConnectors/mySecurityConnectorName/devops/default",
  "name": "default",
  "type": "Microsoft.Security/securityConnectors/devops"
}

CreateOrUpdate_DevOpsConfigurations_OnboardCurrentOnly

Sample request

HTTP

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

{
  "properties": {
    "authorization": {
      "code": "00000000000000000000"
    },
    "autoDiscovery": "Disabled"
  }
}

Java

import com.azure.resourcemanager.security.fluent.models.DevOpsConfigurationInner;
import com.azure.resourcemanager.security.models.Authorization;
import com.azure.resourcemanager.security.models.AutoDiscovery;
import com.azure.resourcemanager.security.models.DevOpsConfigurationProperties;
import java.util.Arrays;

/**
 * Samples for DevOpsConfigurations CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/stable/2024-04-01/examples/SecurityConnectorsDevOps/
     * CreateOrUpdateDevOpsConfigurationsOnboardCurrentOnly_example.json
     */
    /**
     * Sample code: CreateOrUpdate_DevOpsConfigurations_OnboardCurrentOnly.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void createOrUpdateDevOpsConfigurationsOnboardCurrentOnly(
        com.azure.resourcemanager.security.SecurityManager manager) {
        manager.devOpsConfigurations().createOrUpdate("myRg", "mySecurityConnectorName",
            new DevOpsConfigurationInner().withProperties(new DevOpsConfigurationProperties()
                .withAuthorization(new Authorization().withCode("fakeTokenPlaceholder"))
                .withAutoDiscovery(AutoDiscovery.DISABLED)),
            com.azure.core.util.Context.NONE);
    }

    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/stable/2024-04-01/examples/SecurityConnectorsDevOps/
     * CreateOrUpdateDevOpsConfigurationsOnboardSelected_example.json
     */
    /**
     * Sample code: CreateOrUpdate_DevOpsConfigurations_OnboardSelected.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void
        createOrUpdateDevOpsConfigurationsOnboardSelected(com.azure.resourcemanager.security.SecurityManager manager) {
        manager.devOpsConfigurations().createOrUpdate("myRg", "mySecurityConnectorName",
            new DevOpsConfigurationInner().withProperties(new DevOpsConfigurationProperties()
                .withAuthorization(new Authorization().withCode("fakeTokenPlaceholder"))
                .withAutoDiscovery(AutoDiscovery.DISABLED).withTopLevelInventoryList(Arrays.asList("org1", "org2"))),
            com.azure.core.util.Context.NONE);
    }
}

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

Python

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 create_or_update_dev_ops_configurations_onboard_current_only_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.dev_ops_configurations.begin_create_or_update(
        resource_group_name="myRg",
        security_connector_name="mySecurityConnectorName",
        dev_ops_configuration={
            "properties": {"authorization": {"code": "00000000000000000000"}, "autoDiscovery": "Disabled"}
        },
    ).result()
    print(response)


# x-ms-original-file: specification/security/resource-manager/Microsoft.Security/stable/2024-04-01/examples/SecurityConnectorsDevOps/CreateOrUpdateDevOpsConfigurationsOnboardCurrentOnly_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

Sample response

Status code:

200

{
  "properties": {
    "autoDiscovery": "Disabled",
    "provisioningState": "Succeeded"
  },
  "id": "/subscriptions/0806e1cd-cfda-4ff8-b99c-2b0af42cffd3/resourceGroups/myRg/providers/Microsoft.Security/securityConnectors/mySecurityConnectorName/devops/default",
  "name": "default",
  "type": "Microsoft.Security/securityConnectors/devops"
}

Status code:

201

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": {
    "provisioningState": "Accepted"
  },
  "id": "/subscriptions/0806e1cd-cfda-4ff8-b99c-2b0af42cffd3/resourceGroups/myRg/providers/Microsoft.Security/securityConnectors/mySecurityConnectorName/devops/default",
  "name": "default",
  "type": "Microsoft.Security/securityConnectors/devops"
}

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

{
  "properties": {
    "provisioningState": "Accepted"
  },
  "id": "/subscriptions/0806e1cd-cfda-4ff8-b99c-2b0af42cffd3/resourceGroups/myRg/providers/Microsoft.Security/securityConnectors/mySecurityConnectorName/devops/default",
  "name": "default",
  "type": "Microsoft.Security/securityConnectors/devops"
}

CreateOrUpdate_DevOpsConfigurations_OnboardSelected

Sample request

HTTP

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

{
  "properties": {
    "authorization": {
      "code": "00000000000000000000"
    },
    "autoDiscovery": "Disabled",
    "topLevelInventoryList": [
      "org1",
      "org2"
    ]
  }
}

Java

No code sample is available. To request a code sample, open a GitHub issue

Python

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 create_or_update_dev_ops_configurations_onboard_selected_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.dev_ops_configurations.begin_create_or_update(
        resource_group_name="myRg",
        security_connector_name="mySecurityConnectorName",
        dev_ops_configuration={
            "properties": {
                "authorization": {"code": "00000000000000000000"},
                "autoDiscovery": "Disabled",
                "topLevelInventoryList": ["org1", "org2"],
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/security/resource-manager/Microsoft.Security/stable/2024-04-01/examples/SecurityConnectorsDevOps/CreateOrUpdateDevOpsConfigurationsOnboardSelected_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

Sample response

Status code:

200

{
  "properties": {
    "autoDiscovery": "Disabled",
    "topLevelInventoryList": [
      "org1",
      "org2"
    ],
    "provisioningState": "Succeeded"
  },
  "id": "/subscriptions/0806e1cd-cfda-4ff8-b99c-2b0af42cffd3/resourceGroups/myRg/providers/Microsoft.Security/securityConnectors/mySecurityConnectorName/devops/default",
  "name": "default",
  "type": "Microsoft.Security/securityConnectors/devops"
}

Status code:

201

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": {
    "provisioningState": "Accepted"
  },
  "id": "/subscriptions/0806e1cd-cfda-4ff8-b99c-2b0af42cffd3/resourceGroups/myRg/providers/Microsoft.Security/securityConnectors/mySecurityConnectorName/devops/default",
  "name": "default",
  "type": "Microsoft.Security/securityConnectors/devops"
}

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

{
  "properties": {
    "provisioningState": "Accepted"
  },
  "id": "/subscriptions/0806e1cd-cfda-4ff8-b99c-2b0af42cffd3/resourceGroups/myRg/providers/Microsoft.Security/securityConnectors/mySecurityConnectorName/devops/default",
  "name": "default",
  "type": "Microsoft.Security/securityConnectors/devops"
}

Definitions

Name	Description
Authorization	Authorization payload.
AutoDiscovery	AutoDiscovery states.
createdByType	The type of identity that created the resource.
DevOpsCapability	Details about DevOps capability.
DevOpsConfiguration	DevOps Configuration resource.
DevOpsConfigurationProperties	DevOps Configuration properties.
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
systemData	Metadata pertaining to creation and last modification of the resource.

Authorization

Authorization payload.

Name	Type	Description
code	string	Gets or sets one-time OAuth code to exchange for refresh and access tokens. Only used during PUT/PATCH operations. The secret is cleared during GET.

AutoDiscovery

AutoDiscovery states.

Name	Type	Description
Disabled	string
Enabled	string
NotApplicable	string

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DevOpsCapability

Details about DevOps capability.

Name	Type	Description
name	string	Gets the name of the DevOps capability.
value	string	Gets the value of the DevOps capability.

DevOpsConfiguration

DevOps Configuration 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	DevOpsConfigurationProperties	DevOps Configuration 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"

DevOpsConfigurationProperties

DevOps Configuration properties.

Name	Type	Description
authorization	Authorization	Authorization payload.
autoDiscovery	AutoDiscovery	AutoDiscovery states.
capabilities	DevOpsCapability[]	List of capabilities assigned to the DevOps configuration during the discovery process.
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.
topLevelInventoryList	string[]	List of top-level inventory to select when AutoDiscovery is disabled. This field is ignored when AutoDiscovery is enabled.

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.

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.