DevOps Policies - List

Service:: Defender for Cloud

API Version:: 2024-05-15-preview

Returns a list of DevOps Policies.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/policies?api-version=2024-05-15-preview

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/policies?devOpsPolicyType={devOpsPolicyType}&api-version=2024-05-15-preview

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
securityConnectorName	path	True	string	The security connector name.
subscriptionId	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.
devOpsPolicyType	query		string	Optional filter for listing the policies.

Responses

Name	Type	Description
200 OK	DevOpsPolicyListResponse	Provides a list of DevOps Policies.
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

List_DevOpsPolicies

GET https://management.azure.com/subscriptions/0806e1cd-cfda-4ff8-b99c-2b0af42cffd3/resourceGroups/myRg/providers/Microsoft.Security/securityConnectors/mySecurityConnectorName/devops/default/policies?api-version=2024-05-15-preview


/**
 * Samples for DevOpsPolicies List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/preview/2024-05-15-preview/examples/
     * SecurityConnectorsDevOps/ListDevOpsPolicies_example.json
     */
    /**
     * Sample code: List_DevOpsPolicies.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void listDevOpsPolicies(com.azure.resourcemanager.security.SecurityManager manager) {
        manager.devOpsPolicies().list("myRg", "mySecurityConnectorName", null, 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

Sample response

Status code:: 200

{
  "value": [
    {
      "properties": {
        "source": "BuiltIn",
        "policyId": "00000000-0000-0000-0000-000000000000",
        "webUrl": "https://dev.azure.com/contoso/myPolicy",
        "version": "1,0",
        "type": "Pipeline",
        "content": "JSON string of the policy content",
        "provisioningState": "Succeeded"
      },
      "id": "/subscriptions/0806e1cd-cfda-4ff8-b99c-2b0af42cffd3/resourceGroups/myRg/providers/Microsoft.Security/securityConnectors/mySecurityConnectorName/devops/default/policies/myDevOpsPolicy",
      "name": "myDevOpsPolicy",
      "type": "Microsoft.Security/securityConnectors/devops/policies"
    }
  ]
}

Definitions

Name	Description
createdByType	The type of identity that created the resource.
DevOpsPolicy	DevOps Policy Resource.
DevOpsPolicyListResponse	List of RP resources which supports pagination.
DevOpsPolicyProperties	Policy DevOps Resource properties that contain the full definition of a DevOps policy resource.
DevOpsPolicySource	DevOps Policy creation sources.
DevOpsPolicyType	DevOps Policy resource types.
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.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

DevOpsPolicy

Object

DevOps Policy 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	DevOpsPolicyProperties	Policy DevOps Resource properties that contain the full definition of a DevOps policy resource.
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"

DevOpsPolicyListResponse

Object

List of RP resources which supports pagination.

Name	Type	Description
nextLink	string	Gets or sets next link to scroll over the results.
value	DevOpsPolicy[]	Gets or sets list of resources.

DevOpsPolicyProperties

Object

Policy DevOps Resource properties that contain the full definition of a DevOps policy resource.

Name	Type	Description
content	string	Gets or sets the policy definition content JSON string.
policyId	string (uuid)	Gets the policy resource GUID.
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 the resource status message.
provisioningStatusUpdateTimeUtc	string (date-time)	Gets the time when resource was last checked.
source	DevOpsPolicySource	DevOps Policy creation sources.
type	DevOpsPolicyType	DevOps Policy resource types.
version	string	Gets or sets the semantic version.
webUrl	string (url)	Gets the web URL.

DevOpsPolicySource

Enumeration

DevOps Policy creation sources.

Value	Description
Unknown
BuiltIn
UserDefined

DevOpsPolicyType

Enumeration

DevOps Policy resource types.

Value	Description
Unknown
Pipeline

DevOpsProvisioningState

Enumeration

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

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

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

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

systemData

Object

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	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	createdByType	The type of identity that last modified the resource.

Share via

DevOps Policies - List

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

List_DevOpsPolicies

Sample request

Sample response

Definitions

createdByType

DevOpsPolicy

DevOpsPolicyListResponse

DevOpsPolicyProperties

DevOpsPolicySource

DevOpsPolicyType

DevOpsProvisioningState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

systemData