Skip to content

[CONN-3153] CloudQuery Azure plugin C2C source #4056

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 13 commits into from
May 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
---
id: cloudquery-azure-plugin-source
title: CloudQuery Azure Plugin Source
sidebar_label: CloudQuery
tags:
- cloud-to-cloud
- cloudquery
- azure
description: Learn how to collect inventory from the Azure APIs using CloudQuery SDK and send it to Sumo Logic.
---

<head>
<meta name="robots" content="noindex" />
</head>

<p><a href="/docs/beta"><span className="beta">Beta</span></a></p>

import CodeBlock from '@theme/CodeBlock';
import ExampleJSON from '/files/c2c/cloudquery-azure-plugin/example.json';
import MyComponentSource from '!!raw-loader!/files/c2c/cloudquery-azure-plugin/example.json';
import useBaseUrl from '@docusaurus/useBaseUrl';

<img src={useBaseUrl('img/send-data/cloudquery-logo.png')} alt="cloudquery-icon" width="40" />
<img src={useBaseUrl('img/integrations/microsoft-azure/azure-logo.png')} alt="azure-icon" width="40" />

You can use the CloudQuery integration to pull inventory from Azure APIs using CloudQuery SDK and send it to Sumo Logic.

import FedDeploymentNote from '../../../reuse/fed-deployment-note.md';

<FedDeploymentNote/>

## About Vendor

CloudQuery is an open source CSPM vendor that allows the customer to analyze different vendors (for example, AWS, GCP, Azure) to see possible vulnerabilities.

## Data sources

The Azure Cloud inventory has the following list of tables supported:
https://hub.cloudquery.io/plugins/source/cloudquery/azure/v13.0.0/tables.

Based on the services, we will collect data from the tables as mentioned above.

## User configuration

### JSON configuration

Sources can be configured using UTF-8 encoded JSON files with the Collector Management API. See [Use JSON to configure Sources](/docs/send-data/use-json-configure-sources) for details. 

| Parameter | Type | Required | Description | Access |
|:---|:---|:---|:---|:---|
| config | JSON object | Yes | It contains the configuration parameter for the source. | |
| schemaRef | JSON object | Yes | `{"type":"CloudQuery Azure Inventory"}` | Not modifiable |
| sourceType | string | Yes | Use universal for CloudQuery Azure Inventory. | Not modifiable |


### Configuration parameters

| Parameter | Type | Required | Default | Description | Access |
|:---|:---|:---|:---|:---|:---|
| name | string | No | | Type the desired name of the Source. The name must be unique per Collector. This value is assigned to the metadata field `_source`. | Modifiable |
| description | string | No | | Type a description of the Source. | Modifiable |
| clientId | string | Yes | | It’s a unique identifier assigned to an application that is registered with Azure AD. | Modifiable |
| clientSecret | string | Yes | | It’s a secure password that an application uses to authenticate with Azure services. | Modifiable |
| tenantId | string | Yes | | It’s a unique identifier assigned that represents a specific instance of Azure AD. | Modifiable |
| subscriptionId | array | No | | It’s a unique identifier that ties Azure services to an Azure account. | Modifiable |
| services | array | Yes | | List of services for which the data has to be fetched. Available Options: compute, storage. | Modifiable |
| pollingInterval | string | Yes | 12h | The time interval after the source will check for new data. | Modifiable |

## Config JSON example

:::note
If the subscription ID is not specified, it will use all visible subscriptions.
:::

<CodeBlock language="json">{MyComponentSource}</CodeBlock>

[Download example](/files/c2c/cloudquery-azure-plugin/example.json)

## FAQ

:::info
Click [here](/docs/c2c/info) for more information about Cloud-to-Cloud sources.
:::
23 changes: 23 additions & 0 deletions static/files/c2c/cloudquery-azure-plugin/example.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{
"api.version": "v1",
"source": {
"config": {
"name": "CloudQuery",
"clientId": "8e094def-e10f-495b-99d1-q3442312cfc5",
"clientSecret": "abc94def-e10f-495b-99d1-q3442312cef5",
"tenantId": "c088d126-d692-42ad-a4b6-9a542d28a132",
"subscriptionId": [
"a39bedba-be8f-4c0f-abcd-b8c7913501ea"
],
"services": [
"compute",
"storage"
],
"pollingInterval": 12
},
"schemaRef": {
"type": "CloudQuery Azure Inventory"
},
"sourceType": "Universal"
}
}