github_repo

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

Overview

Name	github_repo
Type	Resource
Id	azure.security_devops.github_repo

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.
accountId	integer	Gets or sets gitHub repo account id.
ownerName	string	Gets or sets GitHub Owner Name.
provisioningState	string	Known values are: "Succeeded", "Failed", and "Canceled".
repoUrl	string	Gets or sets gitHub repo url.
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.
accountId	integer	Gets or sets gitHub repo account id.
ownerName	string	Gets or sets GitHub Owner Name.
provisioningState	string	Known values are: "Succeeded", "Failed", and "Canceled".
repoUrl	string	Gets or sets gitHub repo url.
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_by_connector

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.
accountId	integer	Gets or sets gitHub repo account id.
ownerName	string	Gets or sets GitHub Owner Name.
provisioningState	string	Known values are: "Succeeded", "Failed", and "Canceled".
repoUrl	string	Gets or sets gitHub repo url.
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, git_hub_connector_name, git_hub_owner_name, git_hub_repo_name, subscription_id		Returns a monitored GitHub repository. Returns a monitored GitHub repository.
list	select	resource_group_name, git_hub_connector_name, git_hub_owner_name, subscription_id		Returns a list of monitored GitHub repositories. Returns a list of monitored GitHub repositories.
list_by_connector	select	resource_group_name, git_hub_connector_name, subscription_id		Returns a list of monitored GitHub repositories. Returns a list of monitored GitHub repositories.
create_or_update	insert	resource_group_name, git_hub_connector_name, git_hub_owner_name, git_hub_repo_name, subscription_id		Create or update a monitored GitHub repository. Create or update a monitored GitHub repository.
update	update	resource_group_name, git_hub_connector_name, git_hub_owner_name, git_hub_repo_name, subscription_id		Update a monitored GitHub repository. Update a monitored GitHub repository.
create_or_update	replace	resource_group_name, git_hub_connector_name, git_hub_owner_name, git_hub_repo_name, subscription_id		Create or update a monitored GitHub repository. Create or update a monitored GitHub repository.

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.
git_hub_owner_name	string	Name of the GitHub Owner. Required.
git_hub_repo_name	string	Name of the GitHub Repo. 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 repository. Returns a monitored GitHub repository.

SELECT
id,
name,
accountId,
ownerName,
provisioningState,
repoUrl,
systemData,
type
FROM azure.security_devops.github_repo
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND git_hub_connector_name = '{{ git_hub_connector_name }}' -- required
AND git_hub_owner_name = '{{ git_hub_owner_name }}' -- required
AND git_hub_repo_name = '{{ git_hub_repo_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Returns a list of monitored GitHub repositories. Returns a list of monitored GitHub repositories.

SELECT
id,
name,
accountId,
ownerName,
provisioningState,
repoUrl,
systemData,
type
FROM azure.security_devops.github_repo
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND git_hub_connector_name = '{{ git_hub_connector_name }}' -- required
AND git_hub_owner_name = '{{ git_hub_owner_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_connector

Returns a list of monitored GitHub repositories. Returns a list of monitored GitHub repositories.

SELECT
id,
name,
accountId,
ownerName,
provisioningState,
repoUrl,
systemData,
type
FROM azure.security_devops.github_repo
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND git_hub_connector_name = '{{ git_hub_connector_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update a monitored GitHub repository. Create or update a monitored GitHub repository.

INSERT INTO azure.security_devops.github_repo (
properties,
resource_group_name,
git_hub_connector_name,
git_hub_owner_name,
git_hub_repo_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ git_hub_connector_name }}',
'{{ git_hub_owner_name }}',
'{{ git_hub_repo_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: github_repo
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the github_repo resource.
  - name: git_hub_connector_name
    value: "{{ git_hub_connector_name }}"
    description: Required parameter for the github_repo resource.
  - name: git_hub_owner_name
    value: "{{ git_hub_owner_name }}"
    description: Required parameter for the github_repo resource.
  - name: git_hub_repo_name
    value: "{{ git_hub_repo_name }}"
    description: Required parameter for the github_repo resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the github_repo resource.
  - name: properties
    description: |
      GitHub Repo properties.
    value:
      provisioningState: "{{ provisioningState }}"
      accountId: {{ accountId }}
      repoUrl: "{{ repoUrl }}"
      ownerName: "{{ ownerName }}"

UPDATE examples

update

Update a monitored GitHub repository. Update a monitored GitHub repository.

UPDATE azure.security_devops.github_repo
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND git_hub_connector_name = '{{ git_hub_connector_name }}' --required
AND git_hub_owner_name = '{{ git_hub_owner_name }}' --required
AND git_hub_repo_name = '{{ git_hub_repo_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

REPLACE examples

create_or_update

Create or update a monitored GitHub repository. Create or update a monitored GitHub repository.

REPLACE azure.security_devops.github_repo
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND git_hub_connector_name = '{{ git_hub_connector_name }}' --required
AND git_hub_owner_name = '{{ git_hub_owner_name }}' --required
AND git_hub_repo_name = '{{ git_hub_repo_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;