Skip to content

Commit 8eb0d8e

Browse files
jeffreyavenjeffreyaven
authored
Merge pull request #197 from stackql/feature/doc-updates
resources doc fix
2 parents 7e7297a + 38f97d4 commit 8eb0d8e

File tree

25 files changed

+1178
-491
lines changed

25 files changed

+1178
-491
lines changed

‎docs/azure-docs/providers/azure/resources/changes/index.md

Lines changed: 96 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@ hide_table_of_contents: false
55
keywords:
66
- changes
77
- resources
8-
- google
9-
- stackql
8+
- azure
9+
- microsoft azure
1010
- infrastructure-as-code
1111
- configuration-as-data
1212
- cloud inventory
13-
description: Query, deploy and manage Google Cloud Platform (GCP) infrastructure and 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/google/stackql-google-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';
@@ -29,9 +29,100 @@ Creates, updates, deletes, gets or lists a <code>changes</code> resource.
2929
</tbody></table>
3030

3131
## Fields
32-
`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource.
32+
<Tabs
33+
defaultValue="view"
34+
values={[
35+
{ label: 'vw_changes', value: 'view', },
36+
{ label: 'changes', value: 'resource', },
37+
]
38+
}>
39+
<TabItem value="view">
3340

41+
| Name | Datatype | Description |
42+
|:-----|:---------|:------------|
43+
| <CopyableCode code="id" /> | `text` | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
44+
| <CopyableCode code="name" /> | `text` | The name of the resource |
45+
| <CopyableCode code="changeResourceId" /> | `text` | field from the `properties` object |
46+
| <CopyableCode code="change_attributes" /> | `text` | field from the `properties` object |
47+
| <CopyableCode code="change_type" /> | `text` | field from the `properties` object |
48+
| <CopyableCode code="changes" /> | `text` | field from the `properties` object |
49+
| <CopyableCode code="resourceGroupName" /> | `text` | field from the `properties` object |
50+
| <CopyableCode code="resourceName" /> | `text` | field from the `properties` object |
51+
| <CopyableCode code="resourceProviderNamespace" /> | `text` | field from the `properties` object |
52+
| <CopyableCode code="resourceType" /> | `text` | field from the `properties` object |
53+
| <CopyableCode code="subscriptionId" /> | `text` | field from the `properties` object |
54+
| <CopyableCode code="target_resource_id" /> | `text` | field from the `properties` object |
55+
| <CopyableCode code="target_resource_type" /> | `text` | field from the `properties` object |
56+
| <CopyableCode code="type" /> | `text` | The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
57+
</TabItem>
58+
<TabItem value="resource">
59+
60+
| Name | Datatype | Description |
61+
|:-----|:---------|:------------|
62+
| <CopyableCode code="id" /> | `string` | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
63+
| <CopyableCode code="name" /> | `string` | The name of the resource |
64+
| <CopyableCode code="properties" /> | `object` | The properties of a change |
65+
| <CopyableCode code="type" /> | `string` | The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
66+
</TabItem></Tabs>
3467

3568
## Methods
3669
| Name | Accessible by | Required Params | Description |
3770
|:-----|:--------------|:----------------|:------------|
71+
| <CopyableCode code="get" /> | `SELECT` | <CopyableCode code="changeResourceId, resourceGroupName, resourceName, resourceProviderNamespace, resourceType, subscriptionId" /> | Obtains the specified change resource for the target resource |
72+
| <CopyableCode code="list" /> | `SELECT` | <CopyableCode code="resourceGroupName, resourceName, resourceProviderNamespace, resourceType, subscriptionId" /> | Obtains a list of change resources from the past 14 days for the target resource |
73+
74+
## `SELECT` examples
75+
76+
Obtains a list of change resources from the past 14 days for the target resource
77+
78+
<Tabs
79+
defaultValue="view"
80+
values={[
81+
{ label: 'vw_changes', value: 'view', },
82+
{ label: 'changes', value: 'resource', },
83+
]
84+
}>
85+
<TabItem value="view">
86+
87+
```sql
88+
SELECT
89+
id,
90+
name,
91+
changeResourceId,
92+
change_attributes,
93+
change_type,
94+
changes,
95+
resourceGroupName,
96+
resourceName,
97+
resourceProviderNamespace,
98+
resourceType,
99+
subscriptionId,
100+
target_resource_id,
101+
target_resource_type,
102+
type
103+
FROM azure.resources.vw_changes
104+
WHERE resourceGroupName = '{{ resourceGroupName }}'
105+
AND resourceName = '{{ resourceName }}'
106+
AND resourceProviderNamespace = '{{ resourceProviderNamespace }}'
107+
AND resourceType = '{{ resourceType }}'
108+
AND subscriptionId = '{{ subscriptionId }}';
109+
```
110+
</TabItem>
111+
<TabItem value="resource">
112+
113+
114+
```sql
115+
SELECT
116+
id,
117+
name,
118+
properties,
119+
type
120+
FROM azure.resources.changes
121+
WHERE resourceGroupName = '{{ resourceGroupName }}'
122+
AND resourceName = '{{ resourceName }}'
123+
AND resourceProviderNamespace = '{{ resourceProviderNamespace }}'
124+
AND resourceType = '{{ resourceType }}'
125+
AND subscriptionId = '{{ subscriptionId }}';
126+
```
127+
</TabItem></Tabs>
128+

‎docs/azure-docs/providers/azure/resources/deployment_operations/index.md

Lines changed: 98 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@ hide_table_of_contents: false
55
keywords:
66
- deployment_operations
77
- resources
8-
- google
9-
- stackql
8+
- azure
9+
- microsoft azure
1010
- infrastructure-as-code
1111
- configuration-as-data
1212
- cloud inventory
13-
description: Query, deploy and manage Google Cloud Platform (GCP) infrastructure and 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/google/stackql-google-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';
@@ -29,9 +29,102 @@ Creates, updates, deletes, gets or lists a <code>deployment_operations</code> re
2929
</tbody></table>
3030

3131
## Fields
32-
`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource.
32+
<Tabs
33+
defaultValue="view"
34+
values={[
35+
{ label: 'vw_deployment_operations', value: 'view', },
36+
{ label: 'deployment_operations', value: 'resource', },
37+
]
38+
}>
39+
<TabItem value="view">
3340

41+
| Name | Datatype | Description |
42+
|:-----|:---------|:------------|
43+
| <CopyableCode code="id" /> | `text` | Full deployment operation ID. |
44+
| <CopyableCode code="deploymentName" /> | `text` | field from the `properties` object |
45+
| <CopyableCode code="duration" /> | `text` | field from the `properties` object |
46+
| <CopyableCode code="operationId" /> | `text` | Deployment operation ID. |
47+
| <CopyableCode code="operation_id" /> | `text` | field from the `properties` object |
48+
| <CopyableCode code="provisioning_operation" /> | `text` | field from the `properties` object |
49+
| <CopyableCode code="provisioning_state" /> | `text` | field from the `properties` object |
50+
| <CopyableCode code="request" /> | `text` | field from the `properties` object |
51+
| <CopyableCode code="resourceGroupName" /> | `text` | field from the `properties` object |
52+
| <CopyableCode code="response" /> | `text` | field from the `properties` object |
53+
| <CopyableCode code="service_request_id" /> | `text` | field from the `properties` object |
54+
| <CopyableCode code="status_code" /> | `text` | field from the `properties` object |
55+
| <CopyableCode code="status_message" /> | `text` | field from the `properties` object |
56+
| <CopyableCode code="subscriptionId" /> | `text` | field from the `properties` object |
57+
| <CopyableCode code="target_resource" /> | `text` | field from the `properties` object |
58+
| <CopyableCode code="timestamp" /> | `text` | field from the `properties` object |
59+
</TabItem>
60+
<TabItem value="resource">
61+
62+
| Name | Datatype | Description |
63+
|:-----|:---------|:------------|
64+
| <CopyableCode code="id" /> | `string` | Full deployment operation ID. |
65+
| <CopyableCode code="operationId" /> | `string` | Deployment operation ID. |
66+
| <CopyableCode code="properties" /> | `object` | Deployment operation properties. |
67+
</TabItem></Tabs>
3468

3569
## Methods
3670
| Name | Accessible by | Required Params | Description |
3771
|:-----|:--------------|:----------------|:------------|
72+
| <CopyableCode code="get" /> | `SELECT` | <CopyableCode code="deploymentName, operationId, resourceGroupName, subscriptionId" /> | Gets a deployments operation. |
73+
| <CopyableCode code="get_at_management_group_scope" /> | `SELECT` | <CopyableCode code="deploymentName, groupId, operationId" /> | Gets a deployments operation. |
74+
| <CopyableCode code="get_at_scope" /> | `SELECT` | <CopyableCode code="deploymentName, operationId, scope" /> | Gets a deployments operation. |
75+
| <CopyableCode code="get_at_subscription_scope" /> | `SELECT` | <CopyableCode code="deploymentName, operationId, subscriptionId" /> | Gets a deployments operation. |
76+
| <CopyableCode code="get_at_tenant_scope" /> | `SELECT` | <CopyableCode code="deploymentName, operationId" /> | Gets a deployments operation. |
77+
| <CopyableCode code="list" /> | `SELECT` | <CopyableCode code="deploymentName, resourceGroupName, subscriptionId" /> | Gets all deployments operations for a deployment. |
78+
| <CopyableCode code="list_at_management_group_scope" /> | `SELECT` | <CopyableCode code="deploymentName, groupId" /> | Gets all deployments operations for a deployment. |
79+
| <CopyableCode code="list_at_scope" /> | `SELECT` | <CopyableCode code="deploymentName, scope" /> | Gets all deployments operations for a deployment. |
80+
| <CopyableCode code="list_at_subscription_scope" /> | `SELECT` | <CopyableCode code="deploymentName, subscriptionId" /> | Gets all deployments operations for a deployment. |
81+
| <CopyableCode code="list_at_tenant_scope" /> | `SELECT` | <CopyableCode code="deploymentName" /> | Gets all deployments operations for a deployment. |
82+
83+
## `SELECT` examples
84+
85+
Gets all deployments operations for a deployment.
86+
87+
<Tabs
88+
defaultValue="view"
89+
values={[
90+
{ label: 'vw_deployment_operations', value: 'view', },
91+
{ label: 'deployment_operations', value: 'resource', },
92+
]
93+
}>
94+
<TabItem value="view">
95+
96+
```sql
97+
SELECT
98+
id,
99+
deploymentName,
100+
duration,
101+
operationId,
102+
operation_id,
103+
provisioning_operation,
104+
provisioning_state,
105+
request,
106+
resourceGroupName,
107+
response,
108+
service_request_id,
109+
status_code,
110+
status_message,
111+
subscriptionId,
112+
target_resource,
113+
timestamp
114+
FROM azure.resources.vw_deployment_operations
115+
WHERE deploymentName = '{{ deploymentName }}';
116+
```
117+
</TabItem>
118+
<TabItem value="resource">
119+
120+
121+
```sql
122+
SELECT
123+
id,
124+
operationId,
125+
properties
126+
FROM azure.resources.deployment_operations
127+
WHERE deploymentName = '{{ deploymentName }}';
128+
```
129+
</TabItem></Tabs>
130+

‎docs/azure-docs/providers/azure/resources/deployment_operations_at_management_group_scope/index.md

Lines changed: 0 additions & 37 deletions
This file was deleted.

‎docs/azure-docs/providers/azure/resources/deployment_operations_at_scope/index.md

Lines changed: 0 additions & 37 deletions
This file was deleted.

‎docs/azure-docs/providers/azure/resources/deployment_operations_at_subscription_scope/index.md

Lines changed: 0 additions & 37 deletions
This file was deleted.

‎docs/azure-docs/providers/azure/resources/deployment_operations_at_tenant_scope/index.md

Lines changed: 0 additions & 37 deletions
This file was deleted.

0 commit comments

Comments
 (0)