github_connector

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

Overview

Name	github_connector
Type	Resource
Id	azure.security_devops.github_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.
code	string	Gets or sets one-time OAuth code to exchange for refresh and access tokens. Only used during PUT operations. The secret is cleared during GET. In general, RPaaS does not return any property marked as a secret.
location	string	The geo-location where the resource lives. Required.
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.
code	string	Gets or sets one-time OAuth code to exchange for refresh and access tokens. Only used during PUT operations. The secret is cleared during GET. In general, RPaaS does not return any property marked as a secret.
location	string	The geo-location where the resource lives. Required.
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.
code	string	Gets or sets one-time OAuth code to exchange for refresh and access tokens. Only used during PUT operations. The secret is cleared during GET. In general, RPaaS does not return any property marked as a secret.
location	string	The geo-location where the resource lives. Required.
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, git_hub_connector_name, subscription_id		Returns a monitored GitHub Connector resource for a given ID. Returns a monitored GitHub 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 GitHub Connectors. Returns a list of monitored GitHub Connectors.
create_or_update	insert	resource_group_name, git_hub_connector_name, subscription_id, location		Create or update a monitored GitHub Connector resource. Create or update a monitored GitHub Connector resource.
update	update	resource_group_name, git_hub_connector_name, subscription_id, location		Update monitored GitHub Connector details. Update monitored GitHub Connector details.
create_or_update	replace	resource_group_name, git_hub_connector_name, subscription_id, location		Create or update a monitored GitHub Connector resource. Create or update a monitored GitHub Connector resource.
delete	delete	resource_group_name, git_hub_connector_name, subscription_id		Delete monitored GitHub Connector details. Delete monitored GitHub 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
git_hub_connector_name	string	Name of the GitHub 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 GitHub Connector resource for a given ID. Returns a monitored GitHub Connector resource for a given ID.

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

list_by_resource_group

list_by_resource_group.

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

list_by_subscription

Returns a list of monitored GitHub Connectors. Returns a list of monitored GitHub Connectors.

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

INSERT examples

create_or_update

Create or update a monitored GitHub Connector resource. Create or update a monitored GitHub Connector resource.

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

Manifest

# Description fields are for documentation purposes
- name: github_connector
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the github_connector resource.
  - name: git_hub_connector_name
    value: "{{ git_hub_connector_name }}"
    description: Required parameter for the github_connector resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the github_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: |
      Properties of the ARM resource for /subscriptions/xxx/resourceGroups/xxx/providers/Microsoft.SecurityDevOps/gitHubConnectors.
    value:
      provisioningState: "{{ provisioningState }}"
      code: "{{ code }}"

UPDATE examples

update

Update monitored GitHub Connector details. Update monitored GitHub Connector details.

UPDATE azure.security_devops.github_connector
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND git_hub_connector_name = '{{ git_hub_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

Create or update a monitored GitHub Connector resource. Create or update a monitored GitHub Connector resource.

REPLACE azure.security_devops.github_connector
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND git_hub_connector_name = '{{ git_hub_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 GitHub Connector details. Delete monitored GitHub Connector details.

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