Git Hub Repos - List

Service:: Defender for Cloud

API Version:: 2024-05-15-preview

Returns a list of GitHub repositories onboarded to the connector.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/gitHubOwners/{ownerName}/repos?api-version=2024-05-15-preview

URI Parameters

Name	In	Required	Type	Description
ownerName	path	True	string	The GitHub owner name.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
securityConnectorName	path	True	string	The security connector name.
subscriptionId	path	True	string minLength: 1	The ID of the target subscription.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	GitHubRepositoryListResponse	Provides list of GitHub repository resources
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

List_GitHubRepos

GET https://management.azure.com/subscriptions/0806e1cd-cfda-4ff8-b99c-2b0af42cffd3/resourceGroups/myRg/providers/Microsoft.Security/securityConnectors/mySecurityConnectorName/devops/default/gitHubOwners/myGitHubOwner/repos?api-version=2024-05-15-preview


/**
 * Samples for GitHubRepos List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/preview/2024-05-15-preview/examples/
     * SecurityConnectorsDevOps/ListGitHubRepos_example.json
     */
    /**
     * Sample code: List_GitHubRepos.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void listGitHubRepos(com.azure.resourcemanager.security.SecurityManager manager) {
        manager.gitHubRepos().list("myRg", "mySecurityConnectorName", "myGitHubOwner",
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 200

{
  "value": [
    {
      "properties": {
        "repoName": "myGitHubRepo",
        "repoFullName": "myGitHubOwner/myGitHubRepo",
        "onboardingState": "Onboarded",
        "repoUrl": "https://github.com/myGitHubOwner/myGitHubRepo",
        "parentOwnerName": "myGitHubOwner",
        "provisioningState": "Succeeded"
      },
      "id": "/subscriptions/0806e1cd-cfda-4ff8-b99c-2b0af42cffd3/resourceGroups/myRg/providers/Microsoft.Security/securityConnectors/mySecurityConnectorName/devops/default/gitHubOwners/myGitHubOwner/repos/myGitHubRepo",
      "name": "myGitHubRepo",
      "type": "Microsoft.Security/securityConnectors/devops/gitHubOwners/repos"
    }
  ]
}

Definitions

Name	Description
createdByType	The type of identity that created the resource.
DevOpsProvisioningState	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.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
GitHubRepository	GitHub Repository resource.
GitHubRepositoryListResponse	List of RP resources which supports pagination.
GitHubRepositoryProperties	GitHub Repository properties.
OnboardingState	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.
systemData	Metadata pertaining to creation and last modification of the resource.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

DevOpsProvisioningState

Enumeration

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.

Value	Description
Succeeded
Failed
Canceled
Pending
PendingDeletion
DeletionSuccess
DeletionFailure

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

GitHubRepository

Object

GitHub Repository resource.

Name	Type	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
properties	GitHubRepositoryProperties	GitHub Repository properties.
systemData	systemData	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

GitHubRepositoryListResponse

Object

List of RP resources which supports pagination.

Name	Type	Description
nextLink	string	Gets or sets next link to scroll over the results.
value	GitHubRepository[]	Gets or sets list of resources.

GitHubRepositoryProperties

Object

GitHub Repository properties.

Name	Type	Description
onboardingState	OnboardingState	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.
parentOwnerName	string	Gets or sets parent GitHub Owner name.
provisioningState	DevOpsProvisioningState	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.
provisioningStatusMessage	string	Gets the resource status message.
provisioningStatusUpdateTimeUtc	string (date-time)	Gets the time when resource was last checked.
repoFullName	string	Gets or sets GitHub Full Name. Repository name, prefixed with Owner name. Eg: "my-org/new-repo-1".
repoId	string	Gets or sets GitHub Repository id. This is a numeric id defined by Github. Eg: "123456".
repoName	string	Gets or sets GitHub Repository name. Eg: "new-repo-1".
repoUrl	string	Gets or sets GitHub Repository url.

OnboardingState

Enumeration

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.

Value	Description
NotApplicable
OnboardedByOtherConnector
Onboarded
NotOnboarded

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

Share via

Git Hub Repos - List

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

List_GitHubRepos

Sample request

Sample response

Definitions

createdByType

DevOpsProvisioningState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GitHubRepository

GitHubRepositoryListResponse

GitHubRepositoryProperties

OnboardingState

systemData