Git Lab Subgroups - List

リファレンス

サービス:: Defender for Cloud

API バージョン:: 2024-04-01

コネクタにオンボードされている特定の GitLab グループの入れ子になったサブグループを取得します。

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 パラメーター

名前	/	必須	型	説明
groupFQName	path	True	string	GitLab グループの完全修飾名。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソースグループの名前。名前では大文字と小文字が区別されません。
securityConnectorName	path	True	string	セキュリティコネクタ名。
subscriptionId	path	True	string minLength: 1	ターゲットサブスクリプションの ID。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	GitLabGroupListResponse	サブグループの GitLab グループの詳細の一覧を提供します
Other Status Codes	ErrorResponse	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

List_GitLabSubgroups

要求のサンプル

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

応答のサンプル

状態コード:: 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"
    }
  ]
}

定義

名前	説明
createdByType	リソースを作成した ID の種類。
DevOpsProvisioningState	リソースのプロビジョニング状態。保留中 - プロビジョニングが保留中です。失敗 - プロビジョニングに失敗しました。成功 - プロビジョニングに成功しました。キャンセル済み - プロビジョニングが取り消されました。 PendingDeletion - 削除保留中。 DeletionSuccess - 削除に成功しました。 DeletionFailure - 削除エラー。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
GitLabGroup	GitLab グループリソース。
GitLabGroupListResponse	改ページ位置をサポートする RP リソースの一覧。
GitLabGroupProperties	GitLab グループのプロパティ。
OnboardingState	すべてのコネクタでのリソースオンボードの状態に関する詳細。 OnboardedByOtherConnector - このリソースは既に別のコネクタにオンボードされています。これは、最上位レベルのリソースにのみ適用されます。オンボード - このリソースは、指定されたコネクタによって既にオンボードされています。 NotOnboarded - このリソースはどのコネクタにもオンボードされていません。 NotApplicable - オンボード状態は現在のエンドポイントには適用されません。
systemData	リソースの作成と最後の変更に関連するメタデータ。

createdByType

列挙

リソースを作成した ID の種類。

値	説明
Application
Key
ManagedIdentity
User

DevOpsProvisioningState

列挙

リソースのプロビジョニング状態。

保留中 - プロビジョニングが保留中です。失敗 - プロビジョニングに失敗しました。成功 - プロビジョニングに成功しました。キャンセル済み - プロビジョニングが取り消されました。 PendingDeletion - 削除保留中。 DeletionSuccess - 削除に成功しました。 DeletionFailure - 削除エラー。

値	説明
Canceled
DeletionFailure
DeletionSuccess
Failed
Pending
PendingDeletion
Succeeded

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラーメッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラーオブジェクト。

GitLabGroup

Object

GitLab グループリソース。

名前	型	説明
id	string	リソースの完全修飾リソース ID。例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	リソースの名前
properties	GitLabGroupProperties	GitLab グループのプロパティ。
systemData	systemData	リソースの作成と最後の変更に関連するメタデータ。
type	string	リソースの種類。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

GitLabGroupListResponse

Object

改ページ位置をサポートする RP リソースの一覧。

名前	型	説明
nextLink	string	結果をスクロールする次のリンクを取得または設定します。
value	GitLabGroup[]	リソースの一覧を取得または設定します。

GitLabGroupProperties

Object

GitLab グループのプロパティ。

名前	型	説明
fullyQualifiedFriendlyName	string	Group オブジェクトの人間が判読できる完全修飾名を取得または設定します。これには、名前空間が '/' 文字で区切られている GitLab UI に表示される名前空間階層全体が含まれます。
fullyQualifiedName	string	Group オブジェクトの完全修飾名を取得または設定します。これには、名前空間が '$' 文字で区切られている名前空間階層全体が含まれます。
onboardingState	OnboardingState	すべてのコネクタでのリソースオンボードの状態に関する詳細。 OnboardedByOtherConnector - このリソースは既に別のコネクタにオンボードされています。これは、最上位レベルのリソースにのみ適用されます。オンボード - このリソースは、指定されたコネクタによって既にオンボードされています。 NotOnboarded - このリソースはどのコネクタにもオンボードされていません。 NotApplicable - オンボード状態は現在のエンドポイントには適用されません。
provisioningState	DevOpsProvisioningState	リソースのプロビジョニング状態。保留中 - プロビジョニングが保留中です。失敗 - プロビジョニングに失敗しました。成功 - プロビジョニングに成功しました。キャンセル済み - プロビジョニングが取り消されました。 PendingDeletion - 削除保留中。 DeletionSuccess - 削除に成功しました。 DeletionFailure - 削除エラー。
provisioningStatusMessage	string	リソースの状態メッセージを取得または設定します。
provisioningStatusUpdateTimeUtc	string (date-time)	リソースが最後にチェックされた時刻を取得または設定します。
url	string	GitLab グループの URL を取得または設定します。

OnboardingState

列挙

すべてのコネクタでのリソースオンボードの状態に関する詳細。

OnboardedByOtherConnector - このリソースは既に別のコネクタにオンボードされています。これは、最上位レベルのリソースにのみ適用されます。オンボード - このリソースは、指定されたコネクタによって既にオンボードされています。 NotOnboarded - このリソースはどのコネクタにもオンボードされていません。 NotApplicable - オンボード状態は現在のエンドポイントには適用されません。

値	説明
NotApplicable
NotOnboarded
Onboarded
OnboardedByOtherConnector

systemData

Object

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string (date-time)	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string (date-time)	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

次の方法で共有

Git Lab Subgroups - List

URI パラメーター

応答

セキュリティ

azure_auth

スコープ

例

List_GitLabSubgroups

要求のサンプル

応答のサンプル

定義

createdByType

DevOpsProvisioningState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GitLabGroup

GitLabGroupListResponse

GitLabGroupProperties

OnboardingState

systemData