Git Lab Projects - Get

Service:: Defender for Cloud

API Version:: 2024-04-01

Returns a monitored GitLab Project resource for a given fully-qualified group name and project name.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/gitLabGroups/{groupFQName}/projects/{projectName}?api-version=2024-04-01

URI Parameters

Name	In	Required	Type	Description
groupFQName	path	True	string	The GitLab group fully-qualified name.
projectName	path	True	string	The project 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	GitLabProject	Provides GitLab Project details
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

Get_GitLabProjects

Sample request

GET https://management.azure.com/subscriptions/0806e1cd-cfda-4ff8-b99c-2b0af42cffd3/resourceGroups/myRg/providers/Microsoft.Security/securityConnectors/mySecurityConnectorName/devops/default/gitLabGroups/myGitLabGroup$mySubGroup/projects/myGitLabProject?api-version=2024-04-01


/**
 * Samples for GitLabProjects Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/stable/2024-04-01/examples/SecurityConnectorsDevOps/
     * GetGitLabProjects_example.json
     */
    /**
     * Sample code: Get_GitLabProjects.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void getGitLabProjects(com.azure.resourcemanager.security.SecurityManager manager) {
        manager.gitLabProjects().getWithResponse("myRg", "mySecurityConnectorName", "myGitLabGroup$mySubGroup",
            "myGitLabProject", 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

from azure.identity import DefaultAzureCredential

from azure.mgmt.security import SecurityCenter

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-security
# USAGE
    python get_git_lab_projects_example.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SecurityCenter(
        credential=DefaultAzureCredential(),
        subscription_id="0806e1cd-cfda-4ff8-b99c-2b0af42cffd3",
    )

    response = client.git_lab_projects.get(
        resource_group_name="myRg",
        security_connector_name="mySecurityConnectorName",
        group_fq_name="myGitLabGroup$mySubGroup",
        project_name="myGitLabProject",
    )
    print(response)


# x-ms-original-file: specification/security/resource-manager/Microsoft.Security/stable/2024-04-01/examples/SecurityConnectorsDevOps/GetGitLabProjects_example.json
if __name__ == "__main__":
    main()

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

{
  "properties": {
    "fullyQualifiedName": "myGitLabGroup$mySubGroup$myGitLabProject",
    "fullyQualifiedParentGroupName": "myGitLabGroup$mySubGroup",
    "url": "https://gitlab.example.com/myGitLabGroup/mySubGroup/myGitLabProject",
    "onboardingState": "Onboarded",
    "provisioningState": "Succeeded"
  },
  "id": "/subscriptions/0806e1cd-cfda-4ff8-b99c-2b0af42cffd3/resourceGroups/myRg/providers/Microsoft.Security/securityConnectors/mySecurityConnectorName/devops/default/gitLabGroups/myGitLabGroup$mySubGroup/projects/myGitLabProject",
  "name": "myGitLabProject",
  "type": "Microsoft.Security/securityConnectors/devops/gitLabGroups/projects"
}

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
GitLabProject	GitLab Project resource.
GitLabProjectProperties	GitLab Project 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.

GitLabProject

Object

GitLab Project 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	GitLabProjectProperties	GitLab Project 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"

GitLabProjectProperties

Object

GitLab Project properties.

Name	Type	Description
fullyQualifiedFriendlyName	string	Gets or sets the human readable fully-qualified name of the Project object. This contains the entire namespace hierarchy as seen on GitLab UI where entities are separated by the '/' character.
fullyQualifiedName	string	Gets or sets the fully-qualified name of the project object. This contains the entire hierarchy where entities are separated by the '$' character.
fullyQualifiedParentGroupName	string	Gets or sets the fully-qualified name of the project's parent group object. This contains the entire hierarchy where namespaces are separated by the '$' character.
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.
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 or sets resource status message.
provisioningStatusUpdateTimeUtc	string (date-time)	Gets or sets time when resource was last checked.
url	string	Gets or sets the url of the GitLab Project.

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 Lab Projects - Get

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

Get_GitLabProjects

Sample request

Sample response

Definitions

createdByType

DevOpsProvisioningState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GitLabProject

GitLabProjectProperties

OnboardingState

systemData