DevOps Policies - List
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
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 |
---|---|---|---|---|
resource
|
path | True |
string |
The name of the resource group. The name is case insensitive. |
security
|
path | True |
string |
The security connector name. |
subscription
|
path | True |
string |
The ID of the target subscription. |
api-version
|
query | True |
string |
The API version to use for this operation. |
dev
|
query |
string |
Optional filter for listing the policies. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
Provides a list of DevOps Policies. |
|
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
List_DevOpsPolicies
Sample request
Sample response
{
"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 |
---|---|
created |
The type of identity that created the resource. |
Dev |
DevOps Policy Resource. |
Dev |
List of RP resources which supports pagination. |
Dev |
Policy DevOps Resource properties that contain the full definition of a DevOps policy resource. |
Dev |
DevOps Policy creation sources. |
Dev |
DevOps Policy resource types. |
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. |
createdByType
The type of identity that created the resource.
Name | Type | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
DevOpsPolicy
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 |
Policy DevOps Resource properties that contain the full definition of a DevOps policy resource. |
|
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
List of RP resources which supports pagination.
Name | Type | Description |
---|---|---|
nextLink |
string |
Gets or sets next link to scroll over the results. |
value |
Gets or sets list of resources. |
DevOpsPolicyProperties
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 |
Gets the policy resource GUID. |
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 |
Gets the time when resource was last checked. |
source |
DevOps Policy creation sources. |
|
type |
DevOps Policy resource types. |
|
version |
string |
Gets or sets the semantic version. |
webUrl |
string |
Gets the web URL. |
DevOpsPolicySource
DevOps Policy creation sources.
Name | Type | Description |
---|---|---|
BuiltIn |
string |
|
Unknown |
string |
|
UserDefined |
string |
DevOpsPolicyType
DevOps Policy resource types.
Name | Type | Description |
---|---|---|
Pipeline |
string |
|
Unknown |
string |
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 |
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 |
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 |
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. |