Skip to content

Commit

Permalink
Merge pull request #148 from stackql/feature/doc-updates
Browse files Browse the repository at this point in the history
doc updates
  • Loading branch information
jeffreyaven authored May 3, 2024
2 parents c52a829 + eefb69e commit 753aaa7
Show file tree
Hide file tree
Showing 852 changed files with 10,334 additions and 7,944 deletions.
8 changes: 5 additions & 3 deletions docs/azure_extras-docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,11 @@ custom_edit_url: null
image: /img/providers/azure/stackql-azure-provider-featured-image.png
id: azure_extras-doc
slug: /providers/azure_extras

---
Additional Azure cloud computing services by Microsoft.

import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';

Additional Azure cloud computing services by Microsoft.

:::info Provider Summary (v24.01.00199)

Expand Down Expand Up @@ -48,7 +50,7 @@ REGISTRY PULL azure_extras;
## Authentication


StackQL uses Azure application credentials obtained using the `az login` command from the Azure SDK. For more information, see [here](https://learn.microsoft.com/en-us/cli/azure/authenticate-azure-cli).
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>.

## Services
<div class="row">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ description: Query, deploy and manage Azure resources using SQL
custom_edit_url: null
image: /img/providers/azure/stackql-azure-provider-featured-image.png
---

The Service For Managing Third Party Addons.

:::info Service Summary
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,18 +14,21 @@ description: Query, deploy and manage Azure resources using SQL
custom_edit_url: null
image: /img/providers/azure/stackql-azure-provider-featured-image.png
---



import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';




## Overview
<table><tbody>
<tr><td><b>Name</b></td><td><code>operations</code></td></tr>
<tr><td><b>Type</b></td><td>Resource</td></tr>
<tr><td><b>Id</b></td><td><code>azure_extras.addons.operations</code></td></tr>
<tr><td><b>Id</b></td><td><CopyableCode code="azure_extras.addons.operations" /></td></tr>
</tbody></table>

## Fields
## Methods
| Name | Accessible by | Required Params |
|:-----|:--------------|:----------------|
| `list` | `SELECT` | |
| <CopyableCode code="list" /> | `SELECT` | |
Original file line number Diff line number Diff line change
Expand Up @@ -14,26 +14,29 @@ description: Query, deploy and manage Azure resources using SQL
custom_edit_url: null
image: /img/providers/azure/stackql-azure-provider-featured-image.png
---



import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';




## Overview
<table><tbody>
<tr><td><b>Name</b></td><td><code>support_plan_types</code></td></tr>
<tr><td><b>Type</b></td><td>Resource</td></tr>
<tr><td><b>Id</b></td><td><code>azure_extras.addons.support_plan_types</code></td></tr>
<tr><td><b>Id</b></td><td><CopyableCode code="azure_extras.addons.support_plan_types" /></td></tr>
</tbody></table>

## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
| `id` | `string` | The id of the ARM resource, e.g. "/subscriptions/&#123;id&#125;/providers/Microsoft.Addons/supportProvider/&#123;supportProviderName&#125;/supportPlanTypes/&#123;planTypeName&#125;". |
| `name` | `string` | The name of the Canonical support plan, i.e. "essential", "standard" or "advanced". |
| `properties` | `object` | The properties of the Canonical support plan. |
| `type` | `string` | Microsoft.Addons/supportProvider |
| <CopyableCode code="id" /> | `string` | The id of the ARM resource, e.g. "/subscriptions/&#123;id&#125;/providers/Microsoft.Addons/supportProvider/&#123;supportProviderName&#125;/supportPlanTypes/&#123;planTypeName&#125;". |
| <CopyableCode code="name" /> | `string` | The name of the Canonical support plan, i.e. "essential", "standard" or "advanced". |
| <CopyableCode code="properties" /> | `object` | The properties of the Canonical support plan. |
| <CopyableCode code="type" /> | `string` | Microsoft.Addons/supportProvider |
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
| `get` | `SELECT` | `planTypeName, providerName, subscriptionId` | Returns whether or not the canonical support plan of type &#123;type&#125; is enabled for the subscription. |
| `create_or_update` | `INSERT` | `planTypeName, providerName, subscriptionId` | Creates or updates the Canonical support plan of type &#123;type&#125; for the subscription. |
| `delete` | `DELETE` | `planTypeName, providerName, subscriptionId` | Cancels the Canonical support plan of type &#123;type&#125; for the subscription. |
| <CopyableCode code="get" /> | `SELECT` | <CopyableCode code="planTypeName, providerName, subscriptionId" /> | Returns whether or not the canonical support plan of type &#123;type&#125; is enabled for the subscription. |
| <CopyableCode code="create_or_update" /> | `INSERT` | <CopyableCode code="planTypeName, providerName, subscriptionId" /> | Creates or updates the Canonical support plan of type &#123;type&#125; for the subscription. |
| <CopyableCode code="delete" /> | `DELETE` | <CopyableCode code="planTypeName, providerName, subscriptionId" /> | Cancels the Canonical support plan of type &#123;type&#125; for the subscription. |
Original file line number Diff line number Diff line change
Expand Up @@ -14,23 +14,26 @@ description: Query, deploy and manage Azure resources using SQL
custom_edit_url: null
image: /img/providers/azure/stackql-azure-provider-featured-image.png
---



import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';




## Overview
<table><tbody>
<tr><td><b>Name</b></td><td><code>support_plan_types_info</code></td></tr>
<tr><td><b>Type</b></td><td>Resource</td></tr>
<tr><td><b>Id</b></td><td><code>azure_extras.addons.support_plan_types_info</code></td></tr>
<tr><td><b>Id</b></td><td><CopyableCode code="azure_extras.addons.support_plan_types_info" /></td></tr>
</tbody></table>

## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
| `enabled` | `boolean` | Flag to indicate if this support plan type is currently enabled for the subscription. |
| `oneTimeCharge` | `string` | The one time charge status for the subscription. |
| `supportPlanType` | `string` | Support plan type. |
| <CopyableCode code="enabled" /> | `boolean` | Flag to indicate if this support plan type is currently enabled for the subscription. |
| <CopyableCode code="oneTimeCharge" /> | `string` | The one time charge status for the subscription. |
| <CopyableCode code="supportPlanType" /> | `string` | Support plan type. |
## Methods
| Name | Accessible by | Required Params |
|:-----|:--------------|:----------------|
| `list` | `SELECT` | `subscriptionId` |
| <CopyableCode code="list" /> | `SELECT` | <CopyableCode code="subscriptionId" /> |
Original file line number Diff line number Diff line change
Expand Up @@ -14,19 +14,22 @@ description: Query, deploy and manage Azure resources using SQL
custom_edit_url: null
image: /img/providers/azure/stackql-azure-provider-featured-image.png
---



import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';




## Overview
<table><tbody>
<tr><td><b>Name</b></td><td><code>check_name_availability</code></td></tr>
<tr><td><b>Type</b></td><td>Resource</td></tr>
<tr><td><b>Id</b></td><td><code>azure_extras.ag_food_platform.check_name_availability</code></td></tr>
<tr><td><b>Id</b></td><td><CopyableCode code="azure_extras.ag_food_platform.check_name_availability" /></td></tr>
</tbody></table>

## Fields
`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command
## Methods
| Name | Accessible by | Required Params |
|:-----|:--------------|:----------------|
| `check_name_availability` | `EXEC` | `subscriptionId` |
| <CopyableCode code="check_name_availability" /> | `EXEC` | <CopyableCode code="subscriptionId" /> |
Original file line number Diff line number Diff line change
Expand Up @@ -14,27 +14,30 @@ description: Query, deploy and manage Azure resources using SQL
custom_edit_url: null
image: /img/providers/azure/stackql-azure-provider-featured-image.png
---



import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';




## Overview
<table><tbody>
<tr><td><b>Name</b></td><td><code>data_connectors</code></td></tr>
<tr><td><b>Type</b></td><td>Resource</td></tr>
<tr><td><b>Id</b></td><td><code>azure_extras.ag_food_platform.data_connectors</code></td></tr>
<tr><td><b>Id</b></td><td><CopyableCode code="azure_extras.ag_food_platform.data_connectors" /></td></tr>
</tbody></table>

## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
| `eTag` | `string` | The ETag value to implement optimistic concurrency. |
| `properties` | `object` | DataConnector Properties. |
| `systemData` | `object` | Metadata pertaining to creation and last modification of the resource. |
| <CopyableCode code="eTag" /> | `string` | The ETag value to implement optimistic concurrency. |
| <CopyableCode code="properties" /> | `object` | DataConnector Properties. |
| <CopyableCode code="systemData" /> | `object` | Metadata pertaining to creation and last modification of the resource. |
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
| `get` | `SELECT` | `dataConnectorName, dataManagerForAgricultureResourceName, resourceGroupName, subscriptionId` | Get specific Data Connector resource by DataConnectorName. |
| `list` | `SELECT` | `dataManagerForAgricultureResourceName, resourceGroupName, subscriptionId` | Lists the Data Connector Credentials for MADMA instance. |
| `create_or_update` | `INSERT` | `dataConnectorName, dataManagerForAgricultureResourceName, resourceGroupName, subscriptionId, data__properties` | Create or update Data Connector For MADMA resource. |
| `delete` | `DELETE` | `dataConnectorName, dataManagerForAgricultureResourceName, resourceGroupName, subscriptionId` | Delete a Data Connectors with given dataConnector name. |
| `_list` | `EXEC` | `dataManagerForAgricultureResourceName, resourceGroupName, subscriptionId` | Lists the Data Connector Credentials for MADMA instance. |
| <CopyableCode code="get" /> | `SELECT` | <CopyableCode code="dataConnectorName, dataManagerForAgricultureResourceName, resourceGroupName, subscriptionId" /> | Get specific Data Connector resource by DataConnectorName. |
| <CopyableCode code="list" /> | `SELECT` | <CopyableCode code="dataManagerForAgricultureResourceName, resourceGroupName, subscriptionId" /> | Lists the Data Connector Credentials for MADMA instance. |
| <CopyableCode code="create_or_update" /> | `INSERT` | <CopyableCode code="dataConnectorName, dataManagerForAgricultureResourceName, resourceGroupName, subscriptionId, data__properties" /> | Create or update Data Connector For MADMA resource. |
| <CopyableCode code="delete" /> | `DELETE` | <CopyableCode code="dataConnectorName, dataManagerForAgricultureResourceName, resourceGroupName, subscriptionId" /> | Delete a Data Connectors with given dataConnector name. |
| <CopyableCode code="_list" /> | `EXEC` | <CopyableCode code="dataManagerForAgricultureResourceName, resourceGroupName, subscriptionId" /> | Lists the Data Connector Credentials for MADMA instance. |
Original file line number Diff line number Diff line change
Expand Up @@ -14,24 +14,27 @@ description: Query, deploy and manage Azure resources using SQL
custom_edit_url: null
image: /img/providers/azure/stackql-azure-provider-featured-image.png
---



import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';




## Overview
<table><tbody>
<tr><td><b>Name</b></td><td><code>data_manager_for_agriculture_extensions</code></td></tr>
<tr><td><b>Type</b></td><td>Resource</td></tr>
<tr><td><b>Id</b></td><td><code>azure_extras.ag_food_platform.data_manager_for_agriculture_extensions</code></td></tr>
<tr><td><b>Id</b></td><td><CopyableCode code="azure_extras.ag_food_platform.data_manager_for_agriculture_extensions" /></td></tr>
</tbody></table>

## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
| `properties` | `object` | DataManagerForAgricultureExtension properties. |
| `systemData` | `object` | Metadata pertaining to creation and last modification of the resource. |
| <CopyableCode code="properties" /> | `object` | DataManagerForAgricultureExtension properties. |
| <CopyableCode code="systemData" /> | `object` | Metadata pertaining to creation and last modification of the resource. |
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
| `get` | `SELECT` | `dataManagerForAgricultureExtensionId` | Get Data Manager For Agriculture extension. |
| `list` | `SELECT` | | Get list of Data Manager For Agriculture extension. |
| `_list` | `EXEC` | | Get list of Data Manager For Agriculture extension. |
| <CopyableCode code="get" /> | `SELECT` | <CopyableCode code="dataManagerForAgricultureExtensionId" /> | Get Data Manager For Agriculture extension. |
| <CopyableCode code="list" /> | `SELECT` | | Get list of Data Manager For Agriculture extension. |
| <CopyableCode code="_list" /> | `EXEC` | | Get list of Data Manager For Agriculture extension. |
Original file line number Diff line number Diff line change
Expand Up @@ -14,31 +14,34 @@ description: Query, deploy and manage Azure resources using SQL
custom_edit_url: null
image: /img/providers/azure/stackql-azure-provider-featured-image.png
---



import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';




## Overview
<table><tbody>
<tr><td><b>Name</b></td><td><code>data_manager_for_agriculture_resources</code></td></tr>
<tr><td><b>Type</b></td><td>Resource</td></tr>
<tr><td><b>Id</b></td><td><code>azure_extras.ag_food_platform.data_manager_for_agriculture_resources</code></td></tr>
<tr><td><b>Id</b></td><td><CopyableCode code="azure_extras.ag_food_platform.data_manager_for_agriculture_resources" /></td></tr>
</tbody></table>

## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
| `identity` | `object` | Identity for the resource. |
| `location` | `string` | The geo-location where the resource lives |
| `properties` | `object` | Data Manager For Agriculture ARM Resource properties. |
| `tags` | `object` | Resource tags. |
| <CopyableCode code="identity" /> | `object` | Identity for the resource. |
| <CopyableCode code="location" /> | `string` | The geo-location where the resource lives |
| <CopyableCode code="properties" /> | `object` | Data Manager For Agriculture ARM Resource properties. |
| <CopyableCode code="tags" /> | `object` | Resource tags. |
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
| `get` | `SELECT` | `dataManagerForAgricultureResourceName, resourceGroupName, subscriptionId` | Get DataManagerForAgriculture resource. |
| `list_by_resource_group` | `SELECT` | `resourceGroupName, subscriptionId` | Lists the DataManagerForAgriculture instances for a resource group. |
| `list_by_subscription` | `SELECT` | `subscriptionId` | Lists the DataManagerForAgriculture instances for a subscription. |
| `create_or_update` | `INSERT` | `dataManagerForAgricultureResourceName, resourceGroupName, subscriptionId` | Create or update Data Manager For Agriculture resource. |
| `delete` | `DELETE` | `dataManagerForAgricultureResourceName, resourceGroupName, subscriptionId` | Delete a Data Manager For Agriculture resource. |
| `_list_by_resource_group` | `EXEC` | `resourceGroupName, subscriptionId` | Lists the DataManagerForAgriculture instances for a resource group. |
| `_list_by_subscription` | `EXEC` | `subscriptionId` | Lists the DataManagerForAgriculture instances for a subscription. |
| `update` | `EXEC` | `dataManagerForAgricultureResourceName, resourceGroupName, subscriptionId` | Update a Data Manager For Agriculture resource. |
| <CopyableCode code="get" /> | `SELECT` | <CopyableCode code="dataManagerForAgricultureResourceName, resourceGroupName, subscriptionId" /> | Get DataManagerForAgriculture resource. |
| <CopyableCode code="list_by_resource_group" /> | `SELECT` | <CopyableCode code="resourceGroupName, subscriptionId" /> | Lists the DataManagerForAgriculture instances for a resource group. |
| <CopyableCode code="list_by_subscription" /> | `SELECT` | <CopyableCode code="subscriptionId" /> | Lists the DataManagerForAgriculture instances for a subscription. |
| <CopyableCode code="create_or_update" /> | `INSERT` | <CopyableCode code="dataManagerForAgricultureResourceName, resourceGroupName, subscriptionId" /> | Create or update Data Manager For Agriculture resource. |
| <CopyableCode code="delete" /> | `DELETE` | <CopyableCode code="dataManagerForAgricultureResourceName, resourceGroupName, subscriptionId" /> | Delete a Data Manager For Agriculture resource. |
| <CopyableCode code="_list_by_resource_group" /> | `EXEC` | <CopyableCode code="resourceGroupName, subscriptionId" /> | Lists the DataManagerForAgriculture instances for a resource group. |
| <CopyableCode code="_list_by_subscription" /> | `EXEC` | <CopyableCode code="subscriptionId" /> | Lists the DataManagerForAgriculture instances for a subscription. |
| <CopyableCode code="update" /> | `EXEC` | <CopyableCode code="dataManagerForAgricultureResourceName, resourceGroupName, subscriptionId" /> | Update a Data Manager For Agriculture resource. |
Loading

0 comments on commit 753aaa7

Please sign in to comment.