Skip to content

Commit 412fc08

Browse files
jeffreyavenjeffreyaven
authored
Merge pull request #207 from stackql/feature/doc-updates
updated confluent
2 parents a76c366 + 7e67d77 commit 412fc08

File tree

136 files changed

+8298
-1914
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

136 files changed

+8298
-1914
lines changed

‎docs/confluent-docs/index.md‎

Lines changed: 45 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -1,82 +1,57 @@
1-
---
2-
title: confluent
3-
hide_title: false
4-
hide_table_of_contents: false
5-
keywords:
6-
- confluent
7-
- stackql
8-
- infrastructure-as-code
9-
- configuration-as-data
10-
- cloud inventory
11-
description: Query, deploy, and manage Confluent Cloud resources using SQL.
12-
custom_edit_url: null
13-
image: /img/providers/confluent/stackql-confluent-provider-featured-image.png
14-
id: confluent-doc
15-
slug: /providers/confluent
16-
---
17-
18-
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
19-
20-
Confluent Cloud for managing Kafka clusters, topics, and streaming services in a scalable cloud environment.
21-
22-
:::info Provider Summary (v24.11.00272)
1+
---
2+
title: azure
3+
hide_title: false
4+
hide_table_of_contents: false
5+
keywords:
6+
- azure
7+
- microsoft azure
8+
- stackql
9+
- infrastructure-as-code
10+
- configuration-as-data
11+
- cloud inventory
12+
description: Query, deploy and manage Microsoft Azure resources using SQL
13+
custom_edit_url: null
14+
image: /img/providers/azure/stackql-azure-provider-featured-image.png
15+
id: azure-doc
16+
slug: /providers/azure
17+
18+
---
19+
20+
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
21+
22+
Core cloud services from Microsoft Azure.
23+
24+
:::info Provider Summary
2325

2426
<div class="row">
2527
<div class="providerDocColumn">
2628
<span>total services:&nbsp;<b>22</b></span><br />
27-
<span>total methods:&nbsp;<b>391</b></span><br />
28-
</div>
29-
<div class="providerDocColumn">
30-
<span>total resources:&nbsp;<b>113</b></span><br />
31-
<span>total selectable resources:&nbsp;<b>104</b></span><br />
29+
<span>total resources:&nbsp;<b>132</b></span><br />
3230
</div>
3331
</div>
3432

3533
:::
3634

37-
See also:
38-
[[` SHOW `]](https://stackql.io/docs/language-spec/show) [[` DESCRIBE `]](https://stackql.io/docs/language-spec/describe) [[` REGISTRY `]](https://stackql.io/docs/language-spec/registry)
39-
* * *
40-
41-
## Installation
42-
43-
To pull the latest version of the `confluent` provider, run the following command:
44-
45-
```bash
46-
REGISTRY PULL confluent;
47-
```
48-
> To view previous provider versions or to pull a specific provider version, see [here](https://stackql.io/docs/language-spec/registry).
49-
50-
## Authentication
51-
52-
The following system environment variables are used for authentication by default:
53-
54-
- <CopyableCode code="CONFLUENT_CLOUD_API_KEY" /> - Confluent Cloud API key (see <a href="https://confluent.cloud/settings/api-keys">Confluent Cloud API keys</a>)
55-
- <CopyableCode code="CONFLUENT_CLOUD_API_SECRET" /> - Confluent Cloud API secret (see <a href="https://confluent.cloud/settings/api-keys">Confluent Cloud API keys</a>)
56-
57-
These variables are sourced at runtime (from the local machine or as CI variables/secrets).
58-
59-
<details>
60-
61-
<summary>Using different environment variables</summary>
62-
63-
To use different environment variables (instead of the defaults), use the `--auth` flag of the `stackql` program. For example:
64-
65-
```bash
66-
67-
AUTH='{ "confluent": { "type": "basic", "username_var": "MY_CONFLUENT_CLOUD_API_KEY_VAR", "password_var": "MY_CONFLUENT_CLOUD_API_SECRET_VAR" }}'
68-
stackql shell --auth="${AUTH}"
69-
70-
```
71-
or using PowerShell:
72-
73-
```powershell
74-
75-
$Auth = "{ 'confluent': { 'type': 'basic', 'username_var': 'MY_CONFLUENT_CLOUD_API_KEY_VAR', 'password_var': 'MY_CONFLUENT_CLOUD_API_SECRET_VAR' }}"
76-
stackql.exe shell --auth=$Auth
77-
78-
```
79-
</details>
35+
See also:
36+
[[` SHOW `]](https://stackql.io/docs/language-spec/show) [[` DESCRIBE `]](https://stackql.io/docs/language-spec/describe) [[` REGISTRY `]](https://stackql.io/docs/language-spec/registry)
37+
* * *
38+
39+
## Installation
40+
41+
To pull the latest version of the `azure` provider, run the following command:
42+
43+
```bash
44+
REGISTRY PULL azure;
45+
```
46+
> To view previous provider versions or to pull a specific provider version, see [here](https://stackql.io/docs/language-spec/registry).
47+
48+
## Authentication
49+
50+
StackQL uses Azure application credentials obtained using the <CopyableCode code="az login" /> command from the Azure SDK. For more information, see <a href="https://learn.microsoft.com/en-us/cli/azure/authenticate-azure-cli">here</a>.
51+
52+
### Authenticating using an Azure Service Principal
53+
54+
To authenticate using an Azure Service Principal, set the following environment variables: <CopyableCode code="AZURE_TENANT_ID" />, <CopyableCode code="AZURE_CLIENT_ID" /> and <CopyableCode code="AZURE_CLIENT_SECRET" />, see [__creating-an-azure-service-principal__](https://learn.microsoft.com/en-us/azure/developer/go/azure-sdk-authentication-service-principal?tabs=azure-cli#2-create-an-azure-service-principal).
8055

8156
## Services
8257
<div class="row">

‎docs/confluent-docs/providers/confluent/billing/costs/index.md‎

Lines changed: 43 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,21 @@ hide_table_of_contents: false
55
keywords:
66
- costs
77
- billing
8-
- confluent
9-
- stackql
8+
- azure
9+
- microsoft azure
1010
- infrastructure-as-code
1111
- configuration-as-data
1212
- cloud inventory
13-
description: Query, deploy, and manage Confluent Cloud resources using SQL.
13+
description: Query, deploy and manage Microsoft Azure infrastructure and resources using SQL
1414
custom_edit_url: null
15-
image: /img/providers/confluent/stackql-confluent-provider-featured-image.png
15+
image: /img/providers/azure/stackql-azure-provider-featured-image.png
1616
---
1717

1818
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
19+
import Tabs from '@theme/Tabs';
20+
import TabItem from '@theme/TabItem';
1921

20-
21-
22+
Creates, updates, deletes, gets or lists a <code>costs</code> resource.
2223

2324
## Overview
2425
<table><tbody>
@@ -46,7 +47,40 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
4647
| <CopyableCode code="resource" /> | `object` | The resource for a given object |
4748
| <CopyableCode code="start_date" /> | `string` | Start date of time period (inclusive) to retrieve billing costs. It is represented in RFC3339 format and is in UTC. |
4849
| <CopyableCode code="unit" /> | `string` | Unit of the line item. |
50+
4951
## Methods
50-
| Name | Accessible by | Required Params |
51-
|:-----|:--------------|:----------------|
52-
| <CopyableCode code="list_billing_v1costs" /> | `SELECT` | <CopyableCode code="end_date, start_date" /> |
52+
| Name | Accessible by | Required Params | Description |
53+
|:-----|:--------------|:----------------|:------------|
54+
| <CopyableCode code="list_billing_v1costs" /> | `SELECT` | <CopyableCode code="end_date, start_date" /> | [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)
55+
56+
Retrieve a sorted, filtered, paginated list of all costs. |
57+
58+
## `SELECT` examples
59+
60+
[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)
61+
62+
Retrieve a sorted, filtered, paginated list of all costs.
63+
64+
65+
```sql
66+
SELECT
67+
id,
68+
amount,
69+
api_version,
70+
discount_amount,
71+
end_date,
72+
granularity,
73+
kind,
74+
line_type,
75+
network_access_type,
76+
original_amount,
77+
price,
78+
product,
79+
quantity,
80+
resource,
81+
start_date,
82+
unit
83+
FROM confluent.billing.costs
84+
WHERE end_date = '{{ end_date }}'
85+
AND start_date = '{{ start_date }}';
86+
```

‎docs/confluent-docs/providers/confluent/billing/index.md‎

Lines changed: 9 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -4,44 +4,35 @@ hide_title: false
44
hide_table_of_contents: false
55
keywords:
66
- billing
7-
- confluent
7+
- azure
8+
- microsoft azure
89
- stackql
910
- infrastructure-as-code
1011
- configuration-as-data
1112
- cloud inventory
12-
description: Query, deploy, and manage Confluent Cloud resources using SQL.
13+
description: Query, deploy and manage Microsoft Azure resources using SQL
1314
custom_edit_url: null
14-
image: /img/providers/confluent/stackql-confluent-provider-featured-image.png
15+
image: /img/providers/azure/stackql-azure-provider-featured-image.png
1516
---
1617

17-
Billing
18-
18+
billing service documentation.
19+
1920
:::info Service Summary
2021

2122
<div class="row">
2223
<div class="providerDocColumn">
2324
<span>total resources:&nbsp;<b>1</b></span><br />
24-
<span>total selectable resources:&nbsp;<b>1</b></span><br />
25-
<span>total methods:&nbsp;<b>1</b></span><br />
2625
</div>
2726
</div>
2827

2928
:::
3029

31-
## Overview
32-
<table><tbody>
33-
<tr><td><b>Name</b></td><td><code>confluent.billing</code></td></tr>
34-
<tr><td><b>Type</b></td><td>Service</td></tr>
35-
<tr><td><b>Title</b></td><td>Confluent Cloud APIs - Billing</td></tr>
36-
<tr><td><b>Description</b></td><td>Billing</td></tr>
37-
<tr><td><b>Id</b></td><td><code>billing:v24.11.00272</code></td></tr>
38-
</tbody></table>
39-
4030
## Resources
4131
<div class="row">
4232
<div class="providerDocColumn">
43-
<a href="/providers/confluent/billing/costs/">costs</a><br />
33+
<a href="/providers/confluent/billing/costs/">costs</a>
4434
</div>
4535
<div class="providerDocColumn">
36+
4637
</div>
47-
</div>
38+
</div>

‎docs/confluent-docs/providers/confluent/catalog/business_metadata/index.md‎

Lines changed: 85 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,21 @@ hide_table_of_contents: false
55
keywords:
66
- business_metadata
77
- catalog
8-
- confluent
9-
- stackql
8+
- azure
9+
- microsoft azure
1010
- infrastructure-as-code
1111
- configuration-as-data
1212
- cloud inventory
13-
description: Query, deploy, and manage Confluent Cloud resources using SQL.
13+
description: Query, deploy and manage Microsoft Azure infrastructure and resources using SQL
1414
custom_edit_url: null
15-
image: /img/providers/confluent/stackql-confluent-provider-featured-image.png
15+
image: /img/providers/azure/stackql-azure-provider-featured-image.png
1616
---
1717

1818
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
19+
import Tabs from '@theme/Tabs';
20+
import TabItem from '@theme/TabItem';
1921

20-
21-
22+
Creates, updates, deletes, gets or lists a <code>business_metadata</code> resource.
2223

2324
## Overview
2425
<table><tbody>
@@ -35,10 +36,84 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
3536
| <CopyableCode code="entityType" /> | `string` | The entity type |
3637
| <CopyableCode code="error" /> | `object` | Error message of this operation |
3738
| <CopyableCode code="typeName" /> | `string` | The business metadata name |
39+
3840
## Methods
3941
| Name | Accessible by | Required Params | Description |
4042
|:-----|:--------------|:----------------|:------------|
41-
| <CopyableCode code="get_business_metadata" /> | `SELECT` | <CopyableCode code="qualifiedName, typeName" /> | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)<br /><br />Gets the list of business metadata for a given entity represented<br />by a qualified name. |
42-
| <CopyableCode code="create_business_metadata" /> | `INSERT` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)<br /><br />Bulk API to create multiple business metadata. |
43-
| <CopyableCode code="delete_business_metadata" /> | `DELETE` | <CopyableCode code="bmName, qualifiedName, typeName" /> | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)<br /><br />Delete a business metadata on an entity. |
44-
| <CopyableCode code="update_business_metadata" /> | `EXEC` | | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)<br /><br />Bulk API to update multiple business metadata. |
43+
| <CopyableCode code="get_business_metadata" /> | `SELECT` | <CopyableCode code="qualifiedName, typeName" /> | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)
44+
45+
Gets the list of business metadata for a given entity represented
46+
by a qualified name. |
47+
| <CopyableCode code="create_business_metadata" /> | `INSERT` | <CopyableCode code="" /> | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)
48+
49+
Bulk API to create multiple business metadata. |
50+
| <CopyableCode code="delete_business_metadata" /> | `DELETE` | <CopyableCode code="bmName, qualifiedName, typeName" /> | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)
51+
52+
Delete a business metadata on an entity. |
53+
| <CopyableCode code="update_business_metadata" /> | `EXEC` | <CopyableCode code="" /> | [![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)
54+
55+
Bulk API to update multiple business metadata. |
56+
57+
## `SELECT` examples
58+
59+
[![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)
60+
61+
Gets the list of business metadata for a given entity represented
62+
by a qualified name.
63+
64+
65+
```sql
66+
SELECT
67+
attributes,
68+
entityName,
69+
entityType,
70+
error,
71+
typeName
72+
FROM confluent.catalog.business_metadata
73+
WHERE qualifiedName = '{{ qualifiedName }}'
74+
AND typeName = '{{ typeName }}';
75+
```
76+
## `INSERT` example
77+
78+
Use the following StackQL query and manifest file to create a new <code>business_metadata</code> resource.
79+
80+
<Tabs
81+
defaultValue="all"
82+
values={[
83+
{ label: 'All Properties', value: 'all', },
84+
{ label: 'Manifest', value: 'manifest', },
85+
]
86+
}>
87+
<TabItem value="all">
88+
89+
```sql
90+
/*+ create */
91+
INSERT INTO confluent.catalog.business_metadata (
92+
93+
)
94+
SELECT
95+
96+
;
97+
```
98+
</TabItem>
99+
<TabItem value="manifest">
100+
101+
```yaml
102+
- name: business_metadata
103+
props: []
104+
105+
```
106+
</TabItem>
107+
</Tabs>
108+
109+
## `DELETE` example
110+
111+
Deletes the specified <code>business_metadata</code> resource.
112+
113+
```sql
114+
/*+ delete */
115+
DELETE FROM confluent.catalog.business_metadata
116+
WHERE bmName = '{{ bmName }}'
117+
AND qualifiedName = '{{ qualifiedName }}'
118+
AND typeName = '{{ typeName }}';
119+
```

0 commit comments

Comments
 (0)