DevOps Configurations - Create Or Update
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-05-15-preview
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
The name of the resource group. The name is case insensitive. |
|
security
|
path | True |
string |
The security connector name. |
|
subscription
|
path | True |
string minLength: 1 |
The ID of the target subscription. |
|
api-version
|
query | True |
string minLength: 1 |
The API version to use for this operation. |
Request Body
| Name | Type | Description |
|---|---|---|
| properties |
DevOps Configuration properties. |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK |
Creates or updates a DevOps Configuration |
|
| 201 Created |
Created |
|
| 202 Accepted |
Accepted |
|
| Other Status Codes |
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
|
Create |
|
Create |
|
Create |
CreateOrUpdate_DevOpsConfigurations_OnboardCurrentAndFuture
Sample request
PUT https://management.azure.com/subscriptions/0806e1cd-cfda-4ff8-b99c-2b0af42cffd3/resourceGroups/myRg/providers/Microsoft.Security/securityConnectors/mySecurityConnectorName/devops/default?api-version=2024-05-15-preview
{
"properties": {
"authorization": {
"code": "00000000000000000000"
},
"autoDiscovery": "Enabled"
}
}
Sample response
{
"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"
}
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": {
"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"
}
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": {
"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
PUT https://management.azure.com/subscriptions/0806e1cd-cfda-4ff8-b99c-2b0af42cffd3/resourceGroups/myRg/providers/Microsoft.Security/securityConnectors/mySecurityConnectorName/devops/default?api-version=2024-05-15-preview
{
"properties": {
"authorization": {
"code": "00000000000000000000"
},
"autoDiscovery": "Disabled"
}
}
Sample response
{
"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"
}
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": {
"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"
}
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": {
"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
PUT https://management.azure.com/subscriptions/0806e1cd-cfda-4ff8-b99c-2b0af42cffd3/resourceGroups/myRg/providers/Microsoft.Security/securityConnectors/mySecurityConnectorName/devops/default?api-version=2024-05-15-preview
{
"properties": {
"authorization": {
"code": "00000000000000000000"
},
"autoDiscovery": "Disabled",
"topLevelInventoryList": [
"org1",
"org2"
]
}
}
Sample response
{
"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"
}
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": {
"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"
}
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": {
"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. |
|
Auto |
AutoDiscovery states. |
|
created |
The type of identity that created the resource. |
|
Dev |
Details about DevOps capability. |
|
Dev |
DevOps Configuration resource. |
|
Dev |
DevOps Configuration properties. |
|
Dev |
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. |
|
Error |
The resource management error additional info. |
|
Error |
The error detail. |
|
Error |
Error response |
|
system |
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.
| Value | Description |
|---|---|
| Disabled | |
| Enabled | |
| NotApplicable |
createdByType
The type of identity that created the resource.
| Value | Description |
|---|---|
| User | |
| Application | |
| ManagedIdentity | |
| Key |
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 |
DevOps Configuration properties. |
|
| 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 payload. |
|
| autoDiscovery |
AutoDiscovery states. |
|
| capabilities |
List of capabilities assigned to the DevOps configuration during the discovery process. |
|
| provisioningState |
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 (date-time) |
Gets the 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.
| Value | Description |
|---|---|
| Succeeded | |
| Failed | |
| Canceled | |
| Pending | |
| PendingDeletion | |
| DeletionSuccess | |
| DeletionFailure |
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 |
The error additional info. |
|
| code |
string |
The error code. |
| details |
The error details. |
|
| message |
string |
The error message. |
| target |
string |
The error target. |
ErrorResponse
Error response
| Name | Type | Description |
|---|---|---|
| error |
The error object. |
systemData
Metadata pertaining to creation and last modification of the resource.
| Name | Type | Description |
|---|---|---|
| createdAt |
string (date-time) |
The timestamp of resource creation (UTC). |
| createdBy |
string |
The identity that created the resource. |
| createdByType |
The type of identity that created the resource. |
|
| lastModifiedAt |
string (date-time) |
The timestamp of resource last modification (UTC) |
| lastModifiedBy |
string |
The identity that last modified the resource. |
| lastModifiedByType |
The type of identity that last modified the resource. |