dev_ops_configurations

Creates, updates, deletes, gets or lists a dev_ops_configurations resource.

Overview

Name	dev_ops_configurations
Type	Resource
Id	azure.security.dev_ops_configurations

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	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.
agentlessConfiguration	object	Details about Agentless configuration.
authorization	object	Authorization payload.
autoDiscovery	string	AutoDiscovery states. Known values are: "Disabled", "Enabled", and "NotApplicable". (Disabled, Enabled, NotApplicable)
capabilities	array	List of capabilities assigned to the DevOps configuration during the discovery process.
provisioningState	string	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. Known values are: "Succeeded", "Failed", "Canceled", "Pending", "PendingDeletion", "DeletionSuccess", and "DeletionFailure". (Succeeded, Failed, Canceled, Pending, PendingDeletion, DeletionSuccess, DeletionFailure)
provisioningStatusMessage	string	Gets the resource status message.
provisioningStatusUpdateTimeUtc	string (date-time)	Gets the time when resource was last checked.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
topLevelInventoryList	array	List of top-level inventory to select when AutoDiscovery is disabled. This field is ignored when AutoDiscovery is enabled.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, security_connector_name, subscription_id		Gets a DevOps Configuration. Gets a DevOps Configuration.
create_or_update	insert	resource_group_name, security_connector_name, subscription_id		Creates or updates a DevOps Configuration. Creates or updates a DevOps Configuration.
update	update	resource_group_name, security_connector_name, subscription_id		Updates a DevOps Configuration. Updates a DevOps Configuration.
create_or_update	replace	resource_group_name, security_connector_name, subscription_id		Creates or updates a DevOps Configuration. Creates or updates a DevOps Configuration.
delete	delete	resource_group_name, security_connector_name, subscription_id		Deletes a DevOps Connector. Deletes a DevOps Connector.
list_raw	exec	resource_group_name, security_connector_name, subscription_id		List DevOps Configurations. List DevOps Configurations.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
security_connector_name	string	The security connector name. Required.
subscription_id	string

SELECT examples

get

Gets a DevOps Configuration. Gets a DevOps Configuration.

SELECT
id,
name,
agentlessConfiguration,
authorization,
autoDiscovery,
capabilities,
provisioningState,
provisioningStatusMessage,
provisioningStatusUpdateTimeUtc,
systemData,
topLevelInventoryList,
type
FROM azure.security.dev_ops_configurations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND security_connector_name = '{{ security_connector_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a DevOps Configuration. Creates or updates a DevOps Configuration.

INSERT INTO azure.security.dev_ops_configurations (
properties,
resource_group_name,
security_connector_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ security_connector_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: dev_ops_configurations
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the dev_ops_configurations resource.
  - name: security_connector_name
    value: "{{ security_connector_name }}"
    description: Required parameter for the dev_ops_configurations resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the dev_ops_configurations resource.
  - name: properties
    description: |
      DevOps Configuration properties.
    value:
      provisioningStatusMessage: "{{ provisioningStatusMessage }}"
      provisioningStatusUpdateTimeUtc: "{{ provisioningStatusUpdateTimeUtc }}"
      provisioningState: "{{ provisioningState }}"
      authorization:
        code: "{{ code }}"
      autoDiscovery: "{{ autoDiscovery }}"
      topLevelInventoryList:
        - "{{ topLevelInventoryList }}"
      capabilities:
        - name: "{{ name }}"
          value: "{{ value }}"
      agentlessConfiguration:
        agentlessEnabled: "{{ agentlessEnabled }}"
        agentlessAutoDiscovery: "{{ agentlessAutoDiscovery }}"
        scanners:
          - "{{ scanners }}"
        inventoryListType: "{{ inventoryListType }}"
        inventoryList:
          - inventoryKind: "{{ inventoryKind }}"
            value: "{{ value }}"

UPDATE examples

update

Updates a DevOps Configuration. Updates a DevOps Configuration.

UPDATE azure.security.dev_ops_configurations
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND security_connector_name = '{{ security_connector_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

REPLACE examples

create_or_update

Creates or updates a DevOps Configuration. Creates or updates a DevOps Configuration.

REPLACE azure.security.dev_ops_configurations
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND security_connector_name = '{{ security_connector_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes a DevOps Connector. Deletes a DevOps Connector.

DELETE FROM azure.security.dev_ops_configurations
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND security_connector_name = '{{ security_connector_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_raw

List DevOps Configurations. List DevOps Configurations.

EXEC azure.security.dev_ops_configurations.list_raw 
@resource_group_name='{{ resource_group_name }}' --required, 
@security_connector_name='{{ security_connector_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;