azure_dev_ops_connector

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

Overview

Name	azure_dev_ops_connector
Type	Resource
Id	azure.security_devops.azure_dev_ops_connector

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.
authorization	object	:vartype authorization: ~azure.mgmt.securitydevops.models.AuthorizationInfo
location	string	The geo-location where the resource lives. Required.
orgs	array	Gets or sets org onboarding information.
provisioningState	string	Known values are: "Succeeded", "Failed", and "Canceled".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_group

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.
authorization	object	:vartype authorization: ~azure.mgmt.securitydevops.models.AuthorizationInfo
location	string	The geo-location where the resource lives. Required.
orgs	array	Gets or sets org onboarding information.
provisioningState	string	Known values are: "Succeeded", "Failed", and "Canceled".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_subscription

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.
authorization	object	:vartype authorization: ~azure.mgmt.securitydevops.models.AuthorizationInfo
location	string	The geo-location where the resource lives. Required.
orgs	array	Gets or sets org onboarding information.
provisioningState	string	Known values are: "Succeeded", "Failed", and "Canceled".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
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, azure_dev_ops_connector_name, subscription_id		Returns a monitored AzureDevOps Connector resource for a given ID. Returns a monitored AzureDevOps Connector resource for a given ID.
list_by_resource_group	select	resource_group_name, subscription_id		list_by_resource_group.
list_by_subscription	select	subscription_id		Returns a list of monitored AzureDevOps Connectors. Returns a list of monitored AzureDevOps Connectors.
create_or_update	insert	resource_group_name, azure_dev_ops_connector_name, subscription_id, location		Creates or updates an Azure DevOps Connector. Creates or updates an Azure DevOps Connector.
update	update	resource_group_name, azure_dev_ops_connector_name, subscription_id, location		Update monitored AzureDevOps Connector details. Update monitored AzureDevOps Connector details.
create_or_update	replace	resource_group_name, azure_dev_ops_connector_name, subscription_id, location		Creates or updates an Azure DevOps Connector. Creates or updates an Azure DevOps Connector.
delete	delete	resource_group_name, azure_dev_ops_connector_name, subscription_id		Delete monitored AzureDevOps Connector details. Delete monitored AzureDevOps Connector details.

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
azure_dev_ops_connector_name	string	Name of the AzureDevOps Connector. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Returns a monitored AzureDevOps Connector resource for a given ID. Returns a monitored AzureDevOps Connector resource for a given ID.

SELECT
id,
name,
authorization,
location,
orgs,
provisioningState,
systemData,
tags,
type
FROM azure.security_devops.azure_dev_ops_connector
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND azure_dev_ops_connector_name = '{{ azure_dev_ops_connector_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

list_by_resource_group.

SELECT
id,
name,
authorization,
location,
orgs,
provisioningState,
systemData,
tags,
type
FROM azure.security_devops.azure_dev_ops_connector
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Returns a list of monitored AzureDevOps Connectors. Returns a list of monitored AzureDevOps Connectors.

SELECT
id,
name,
authorization,
location,
orgs,
provisioningState,
systemData,
tags,
type
FROM azure.security_devops.azure_dev_ops_connector
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates an Azure DevOps Connector. Creates or updates an Azure DevOps Connector.

INSERT INTO azure.security_devops.azure_dev_ops_connector (
tags,
location,
properties,
resource_group_name,
azure_dev_ops_connector_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ azure_dev_ops_connector_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: azure_dev_ops_connector
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the azure_dev_ops_connector resource.
  - name: azure_dev_ops_connector_name
    value: "{{ azure_dev_ops_connector_name }}"
    description: Required parameter for the azure_dev_ops_connector resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the azure_dev_ops_connector resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      :vartype properties: ~azure.mgmt.securitydevops.models.AzureDevOpsConnectorProperties
    value:
      provisioningState: "{{ provisioningState }}"
      authorization:
        code: "{{ code }}"
      orgs:
        - name: "{{ name }}"
          autoDiscovery: "{{ autoDiscovery }}"
          projects: "{{ projects }}"

UPDATE examples

update

Update monitored AzureDevOps Connector details. Update monitored AzureDevOps Connector details.

UPDATE azure.security_devops.azure_dev_ops_connector
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND azure_dev_ops_connector_name = '{{ azure_dev_ops_connector_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Creates or updates an Azure DevOps Connector. Creates or updates an Azure DevOps Connector.

REPLACE azure.security_devops.azure_dev_ops_connector
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND azure_dev_ops_connector_name = '{{ azure_dev_ops_connector_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete monitored AzureDevOps Connector details. Delete monitored AzureDevOps Connector details.

DELETE FROM azure.security_devops.azure_dev_ops_connector
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND azure_dev_ops_connector_name = '{{ azure_dev_ops_connector_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;