DevOps Operation Results - Get

Reference

Service:: Defender for Cloud

API Version:: 2024-04-01

Get devops long running operation result.

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

URI Parameters

Name	In	Required	Type	Description
operationResultId	path	True	string	The operation result Id.
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.

Responses

Name	Type	Description
200 OK	OperationStatusResult	OK
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

Get_DevOpsOperationResults_Failed

Get_DevOpsOperationResults_Succeeded

Get_DevOpsOperationResults_Failed

Sample request

GET https://management.azure.com/subscriptions/0806e1cd-cfda-4ff8-b99c-2b0af42cffd3/resourceGroups/myRg/providers/Microsoft.Security/securityConnectors/mySecurityConnectorName/devops/default/operationResults/8d4caace-e7b3-4b3e-af99-73f76829ebcf?api-version=2024-04-01


/**
 * Samples for DevOpsOperationResults Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/stable/2024-04-01/examples/SecurityConnectorsDevOps/
     * GetDevOpsOperationResultsFailed_example.json
     */
    /**
     * Sample code: Get_DevOpsOperationResults_Failed.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void getDevOpsOperationResultsFailed(com.azure.resourcemanager.security.SecurityManager manager) {
        manager.devOpsOperationResults().getWithResponse("myRg", "mySecurityConnectorName",
            "8d4caace-e7b3-4b3e-af99-73f76829ebcf", 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

from azure.identity import DefaultAzureCredential

from azure.mgmt.security import SecurityCenter

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-security
# USAGE
    python get_dev_ops_operation_results_failed_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_operation_results.get(
        resource_group_name="myRg",
        security_connector_name="mySecurityConnectorName",
        operation_result_id="8d4caace-e7b3-4b3e-af99-73f76829ebcf",
    )
    print(response)


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

{
  "id": "/subscriptions/0806e1cd-cfda-4ff8-b99c-2b0af42cffd3/resourceGroups/myRg/providers/Microsoft.Security/securityConnectors/mySecurityConnectorName/devops/default/operationResults/8d4caace-e7b3-4b3e-af99-73f76829ebcf?api-version=2024-04-01",
  "name": "8d4caace-e7b3-4b3e-af99-73f76829ebcf",
  "status": "Failed",
  "startTime": "2023-06-21T03:23:15Z",
  "endTime": "2023-06-21T03:25:15Z",
  "percentComplete": 100,
  "error": {
    "code": "TokenExchangeFailed",
    "message": "AzureDevOps OAuth token exchange failed"
  }
}

Get_DevOpsOperationResults_Succeeded

Sample request

GET 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


/**
 * Samples for DevOpsOperationResults Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/stable/2024-04-01/examples/SecurityConnectorsDevOps/
     * GetDevOpsOperationResultsSucceeded_example.json
     */
    /**
     * Sample code: Get_DevOpsOperationResults_Succeeded.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void getDevOpsOperationResultsSucceeded(com.azure.resourcemanager.security.SecurityManager manager) {
        manager.devOpsOperationResults().getWithResponse("myRg", "mySecurityConnectorName",
            "4e826cf1-5c36-4808-a7d2-fb4f5170978b", 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

from azure.identity import DefaultAzureCredential

from azure.mgmt.security import SecurityCenter

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-security
# USAGE
    python get_dev_ops_operation_results_succeeded_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_operation_results.get(
        resource_group_name="myRg",
        security_connector_name="mySecurityConnectorName",
        operation_result_id="4e826cf1-5c36-4808-a7d2-fb4f5170978b",
    )
    print(response)


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

{
  "id": "/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",
  "name": "4e826cf1-5c36-4808-a7d2-fb4f5170978b",
  "status": "Succeeded",
  "startTime": "2023-06-21T03:23:15Z",
  "endTime": "2023-06-21T03:25:15Z",
  "percentComplete": 100
}

Definitions

Name	Description
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
OperationStatusResult	The current status of an async operation.

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.

OperationStatusResult

The current status of an async operation.

Name	Type	Description
endTime	string	The end time of the operation.
error	ErrorDetail	If present, details of the operation error.
id	string	Fully qualified ID for the async operation.
name	string	Name of the async operation.
operations	OperationStatusResult[]	The operations list.
percentComplete	number	Percent of the operation that is complete.
startTime	string	The start time of the operation.
status	string	Operation status.

Share via

DevOps Operation Results - Get

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

Get_DevOpsOperationResults_Failed

Sample request

Sample response

Get_DevOpsOperationResults_Succeeded

Sample request

Sample response

Definitions

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

OperationStatusResult

Additional resources