github_owners

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

Overview

Name	github_owners
Type	Resource
Id	azure.security.github_owners

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.
gitHubInternalId	string	Gets or sets internal GitHub id.
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)
ownerUrl	string	Gets or sets GitHub Owner url.
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.
gitHubInternalId	string	Gets or sets internal GitHub id.
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)
ownerUrl	string	Gets or sets GitHub Owner url.
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, owner_name, subscription_id		Returns a monitored GitHub owner. Returns a monitored GitHub owner.
list	select	resource_group_name, security_connector_name, subscription_id		Returns a list of GitHub owners onboarded to the connector. Returns a list of GitHub owners onboarded to the connector.
list_available	exec	resource_group_name, security_connector_name, subscription_id		Returns a list of all GitHub owners accessible by the user token consumed by the connector. Returns a list of all GitHub owners 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
owner_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 GitHub owner. Returns a monitored GitHub owner.

SELECT
id,
name,
gitHubInternalId,
onboardingState,
ownerUrl,
provisioningState,
provisioningStatusMessage,
provisioningStatusUpdateTimeUtc,
systemData,
type
FROM azure.security.github_owners
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND security_connector_name = '{{ security_connector_name }}' -- required
AND owner_name = '{{ owner_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Returns a list of GitHub owners onboarded to the connector. Returns a list of GitHub owners onboarded to the connector.

SELECT
id,
name,
gitHubInternalId,
onboardingState,
ownerUrl,
provisioningState,
provisioningStatusMessage,
provisioningStatusUpdateTimeUtc,
systemData,
type
FROM azure.security.github_owners
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_available

Returns a list of all GitHub owners accessible by the user token consumed by the connector. Returns a list of all GitHub owners accessible by the user token consumed by the connector.

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