data_products_catalogs
Creates, updates, deletes, gets or lists a data_products_catalogs resource.
Overview
| Name | data_products_catalogs |
| Type | Resource |
| Id | azure_extras.network_analytics.data_products_catalogs |
Fields
The following fields are returned by SELECT queries:
- get
- list_by_subscription
| Name | Datatype | Description |
|---|---|---|
id | string | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. |
name | string | The name of the resource. |
provisioningState | string | The data catalog provisioning state. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted". |
publishers | array | The data product publisher information. Required. |
systemData | object | Azure Resource Manager metadata containing createdBy and modifiedBy information. |
type | string | The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". |
| Name | Datatype | Description |
|---|---|---|
id | string | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. |
name | string | The name of the resource. |
provisioningState | string | The data catalog provisioning state. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted". |
publishers | array | The data product publisher information. Required. |
systemData | object | Azure Resource Manager metadata containing createdBy and modifiedBy information. |
type | string | The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | resource_group_name, subscription_id | Retrieve data type resource. | |
list_by_subscription | select | subscription_id | List data catalog by subscription. | |
list_by_resource_group | exec | resource_group_name, subscription_id | List data catalog by resource group. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
resource_group_name | string | The name of the resource group. The name is case insensitive. Required. |
subscription_id | string |
SELECT examples
- get
- list_by_subscription
Retrieve data type resource.
SELECT
id,
name,
provisioningState,
publishers,
systemData,
type
FROM azure_extras.network_analytics.data_products_catalogs
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;
List data catalog by subscription.
SELECT
id,
name,
provisioningState,
publishers,
systemData,
type
FROM azure_extras.network_analytics.data_products_catalogs
WHERE subscription_id = '{{ subscription_id }}' -- required
;
Lifecycle Methods
- list_by_resource_group
List data catalog by resource group.
EXEC azure_extras.network_analytics.data_products_catalogs.list_by_resource_group
@resource_group_name='{{ resource_group_name }}' --required,
@subscription_id='{{ subscription_id }}' --required
;