Git Lab Subgroups - List

Szolgáltatás:: Defender for Cloud

API-verzió:: 2024-04-01

Lekéri az összekötőbe előkészített adott GitLab-csoport beágyazott alcsoportjait.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
groupFQName	path	True	string	A GitLab-csoport teljes neve.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
securityConnectorName	path	True	string	A biztonsági összekötő neve.
subscriptionId	path	True	string minLength: 1	A cél-előfizetés azonosítója.
api-version	query	True	string minLength: 1	A művelethez használni kívánt API-verzió.

Válaszok

Name	Típus	Description
200 OK	GitLabGroupListResponse	Az alcsoportok GitLab-csoportadatainak listáját tartalmazza
Other Status Codes	ErrorResponse	Hibaválasz, amely leírja, hogy miért nem sikerült a művelet.

Biztonság

azure_auth

Azure Active Directory OAuth2-folyamat

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

List_GitLabSubgroups

Mintakérelem

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


/**
 * Samples for GitLabSubgroups List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/stable/2024-04-01/examples/SecurityConnectorsDevOps/
     * ListGitLabSubgroups_example.json
     */
    /**
     * Sample code: List_GitLabSubgroups.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void listGitLabSubgroups(com.azure.resourcemanager.security.SecurityManager manager) {
        manager.gitLabSubgroups().listWithResponse("myRg", "mySecurityConnectorName", "myGitLabGroup",
            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 list_git_lab_subgroups_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_subgroups.list(
        resource_group_name="myRg",
        security_connector_name="mySecurityConnectorName",
        group_fq_name="myGitLabGroup",
    )
    print(response)


# x-ms-original-file: specification/security/resource-manager/Microsoft.Security/stable/2024-04-01/examples/SecurityConnectorsDevOps/ListGitLabSubgroups_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

Mintaválasz

Állapotkód:: 200

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

Definíciók

Name	Description
createdByType	Az erőforrást létrehozó identitás típusa.
DevOpsProvisioningState	Az erőforrás kiépítési állapota. Függőben – Kiépítés függőben. Sikertelen – A kiépítés nem sikerült. Sikeres – Sikeres kiépítés. Megszakítva – A kiépítés megszakítva. PendingDeletion – Törlés függőben. DeletionSuccess – Sikeres törlés. DeletionFailure – Törlési hiba.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
GitLabGroup	GitLab-csoport erőforrás.
GitLabGroupListResponse	A lapozást támogató RP-erőforrások listája.
GitLabGroupProperties	GitLab-csoport tulajdonságai.
OnboardingState	Az összes összekötő erőforrás-előkészítési állapotának részletei. OnboardedByOtherConnector – ezt az erőforrást már előkészítették egy másik összekötőbe. Ez csak a legfelső szintű erőforrásokra vonatkozik. Előkészítés – ezt az erőforrást már előkészítette a megadott összekötő. NotOnboarded – ez az erőforrás nem lett előkészítve egyetlen összekötőbe sem. NotApplicable – az előkészítési állapot nem alkalmazható az aktuális végpontra.
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

createdByType

Enumerálás

Az erőforrást létrehozó identitás típusa.

Érték	Description
User
Application
ManagedIdentity
Key

DevOpsProvisioningState

Enumerálás

Az erőforrás kiépítési állapota.

Függőben – Kiépítés függőben. Sikertelen – A kiépítés nem sikerült. Sikeres – Sikeres kiépítés. Megszakítva – A kiépítés megszakítva. PendingDeletion – Törlés függőben. DeletionSuccess – Sikeres törlés. DeletionFailure – Törlési hiba.

Érték	Description
Succeeded
Failed
Canceled
Pending
PendingDeletion
DeletionSuccess
DeletionFailure

ErrorAdditionalInfo

Objektum

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorDetail

Objektum

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

ErrorResponse

Objektum

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

GitLabGroup

Objektum

GitLab-csoport erőforrás.

Name	Típus	Description
id	string	Az erőforrás teljes erőforrás-azonosítója. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Az erőforrás neve
properties	GitLabGroupProperties	GitLab-csoport tulajdonságai.
systemData	systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.
type	string	Az erőforrás típusa. Pl. "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

GitLabGroupListResponse

Objektum

A lapozást támogató RP-erőforrások listája.

Name	Típus	Description
nextLink	string	Lekéri vagy beállítja a következő hivatkozást az eredmények görgetéséhez.
value	GitLabGroup[]	Lekéri vagy beállítja az erőforrások listáját.

GitLabGroupProperties

Objektum

GitLab-csoport tulajdonságai.

Name	Típus	Description
fullyQualifiedFriendlyName	string	Lekéri vagy beállítja a csoportobjektum emberi olvasható teljes nevét. Ez a GitLab felhasználói felületén látható teljes névtérhierarchiát tartalmazza, ahol a névterek "/" karakterrel vannak elválasztva.
fullyQualifiedName	string	Lekéri vagy beállítja a csoportobjektum teljes nevét. Ez a teljes névtérhierarchiát tartalmazza, ahol a névterek "$" karakterrel vannak elválasztva.
onboardingState	OnboardingState	Az összes összekötő erőforrás-előkészítési állapotának részletei. OnboardedByOtherConnector – ezt az erőforrást már előkészítették egy másik összekötőbe. Ez csak a legfelső szintű erőforrásokra vonatkozik. Előkészítés – ezt az erőforrást már előkészítette a megadott összekötő. NotOnboarded – ez az erőforrás nem lett előkészítve egyetlen összekötőbe sem. NotApplicable – az előkészítési állapot nem alkalmazható az aktuális végpontra.
provisioningState	DevOpsProvisioningState	Az erőforrás kiépítési állapota. Függőben – Kiépítés függőben. Sikertelen – A kiépítés nem sikerült. Sikeres – Sikeres kiépítés. Megszakítva – A kiépítés megszakítva. PendingDeletion – Törlés függőben. DeletionSuccess – Sikeres törlés. DeletionFailure – Törlési hiba.
provisioningStatusMessage	string	Lekéri vagy beállítja az erőforrás állapotüzenetét.
provisioningStatusUpdateTimeUtc	string (date-time)	Lekéri vagy beállítja az erőforrás utolsó ellenőrzésének időpontját.
url	string	Lekéri vagy beállítja a GitLab-csoport URL-címét.

OnboardingState

Enumerálás

Az összes összekötő erőforrás-előkészítési állapotának részletei.

OnboardedByOtherConnector – ezt az erőforrást már előkészítették egy másik összekötőbe. Ez csak a legfelső szintű erőforrásokra vonatkozik. Előkészítés – ezt az erőforrást már előkészítette a megadott összekötő. NotOnboarded – ez az erőforrás nem lett előkészítve egyetlen összekötőbe sem. NotApplicable – az előkészítési állapot nem alkalmazható az aktuális végpontra.

Érték	Description
NotApplicable
OnboardedByOtherConnector
Onboarded
NotOnboarded

systemData

Objektum

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name	Típus	Description
createdAt	string (date-time)	Az erőforrás-létrehozás időbélyege (UTC).
createdBy	string	Az erőforrást létrehozó identitás.
createdByType	createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedAt	string (date-time)	Az erőforrás utolsó módosításának időbélyege (UTC)
lastModifiedBy	string	Az erőforrást legutóbb módosító identitás.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.

Megosztás:

Git Lab Subgroups - List

URI-paraméterek

Válaszok

Biztonság

azure_auth

Hatókörök

Példák

List_GitLabSubgroups

Mintakérelem

Mintaválasz

Definíciók

createdByType

DevOpsProvisioningState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GitLabGroup

GitLabGroupListResponse

GitLabGroupProperties

OnboardingState

systemData