azure_dev_ops_orgs

Creates, updates, deletes, gets or lists an azure_dev_ops_orgs resource.

Overview

Name	azure_dev_ops_orgs
Type	Resource
Id	azure.security.azure_dev_ops_orgs

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.
actionableRemediation	object	Configuration payload for PR Annotations.
onboardingState	string	Details about resource onboarding status across all connectors. OnboardedByOtherConnector - this resource has already been onboarded to another connector. This is only applicable to top-level resources. Onboarded - this resource has already been onboarded by the specified connector. NotOnboarded - this resource has not been onboarded to any connector. NotApplicable - the onboarding state is not applicable to the current endpoint. Known values are: "NotApplicable", "OnboardedByOtherConnector", "Onboarded", and "NotOnboarded". (NotApplicable, OnboardedByOtherConnector, Onboarded, NotOnboarded)
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.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

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.
actionableRemediation	object	Configuration payload for PR Annotations.
onboardingState	string	Details about resource onboarding status across all connectors. OnboardedByOtherConnector - this resource has already been onboarded to another connector. This is only applicable to top-level resources. Onboarded - this resource has already been onboarded by the specified connector. NotOnboarded - this resource has not been onboarded to any connector. NotApplicable - the onboarding state is not applicable to the current endpoint. Known values are: "NotApplicable", "OnboardedByOtherConnector", "Onboarded", and "NotOnboarded". (NotApplicable, OnboardedByOtherConnector, Onboarded, NotOnboarded)
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.
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, org_name, subscription_id		Returns a monitored Azure DevOps organization resource. Returns a monitored Azure DevOps organization resource.
list	select	resource_group_name, security_connector_name, subscription_id		Returns a list of Azure DevOps organizations onboarded to the connector. Returns a list of Azure DevOps organizations onboarded to the connector.
create_or_update	insert	resource_group_name, security_connector_name, org_name, subscription_id		Creates or updates monitored Azure DevOps organization details. Creates or updates monitored Azure DevOps organization details.
update	update	resource_group_name, security_connector_name, org_name, subscription_id		Updates monitored Azure DevOps organization details. Updates monitored Azure DevOps organization details.
create_or_update	replace	resource_group_name, security_connector_name, org_name, subscription_id		Creates or updates monitored Azure DevOps organization details. Creates or updates monitored Azure DevOps organization details.
list_available	exec	resource_group_name, security_connector_name, subscription_id		Returns a list of all Azure DevOps organizations accessible by the user token consumed by the connector. Returns a list of all Azure DevOps organizations accessible by the user token consumed by the connector.

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
org_name	string	Required.
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

Returns a monitored Azure DevOps organization resource. Returns a monitored Azure DevOps organization resource.

SELECT
id,
name,
actionableRemediation,
onboardingState,
provisioningState,
provisioningStatusMessage,
provisioningStatusUpdateTimeUtc,
systemData,
type
FROM azure.security.azure_dev_ops_orgs
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND security_connector_name = '{{ security_connector_name }}' -- required
AND org_name = '{{ org_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Returns a list of Azure DevOps organizations onboarded to the connector. Returns a list of Azure DevOps organizations onboarded to the connector.

SELECT
id,
name,
actionableRemediation,
onboardingState,
provisioningState,
provisioningStatusMessage,
provisioningStatusUpdateTimeUtc,
systemData,
type
FROM azure.security.azure_dev_ops_orgs
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 monitored Azure DevOps organization details. Creates or updates monitored Azure DevOps organization details.

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

Manifest

# Description fields are for documentation purposes
- name: azure_dev_ops_orgs
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the azure_dev_ops_orgs resource.
  - name: security_connector_name
    value: "{{ security_connector_name }}"
    description: Required parameter for the azure_dev_ops_orgs resource.
  - name: org_name
    value: "{{ org_name }}"
    description: Required parameter for the azure_dev_ops_orgs resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the azure_dev_ops_orgs resource.
  - name: properties
    description: |
      Azure DevOps Organization properties.
    value:
      provisioningStatusMessage: "{{ provisioningStatusMessage }}"
      provisioningStatusUpdateTimeUtc: "{{ provisioningStatusUpdateTimeUtc }}"
      provisioningState: "{{ provisioningState }}"
      onboardingState: "{{ onboardingState }}"
      actionableRemediation:
        state: "{{ state }}"
        categoryConfigurations:
          - minimumSeverityLevel: "{{ minimumSeverityLevel }}"
            category: "{{ category }}"
        branchConfiguration:
          branchNames:
            - "{{ branchNames }}"
          annotateDefaultBranch: "{{ annotateDefaultBranch }}"
        inheritFromParentState: "{{ inheritFromParentState }}"

UPDATE examples

update

Updates monitored Azure DevOps organization details. Updates monitored Azure DevOps organization details.

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

REPLACE examples

create_or_update

Creates or updates monitored Azure DevOps organization details. Creates or updates monitored Azure DevOps organization details.

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

Lifecycle Methods

list_available

Returns a list of all Azure DevOps organizations accessible by the user token consumed by the connector. Returns a list of all Azure DevOps organizations accessible by the user token consumed by the connector.

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