data_products

Creates, updates, deletes, gets or lists a data_products resource.

Overview

Name	data_products
Type	Resource
Id	azure_extras.network_analytics.data_products

Fields

The following fields are returned by SELECT queries:

get

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.
availableMinorVersions	array	List of available minor versions of the data product resource.
consumptionEndpoints	object	Resource links which exposed to the customer to query the data.
currentMinorVersion	string	Current configured minor version of the data product resource.
customerEncryptionKey	object	Customer managed encryption key details for data product.
customerManagedKeyEncryptionEnabled	string	Flag to enable customer managed key encryption for data product. Known values are: "Enabled" and "Disabled".
documentation	string	Documentation link for the data product based on definition file.
identity	object	The managed service identities assigned to this resource.
keyVaultUrl	string	Key vault url.
location	string	The geo-location where the resource lives. Required.
majorVersion	string	Major version of data product. Required.
managedResourceGroupConfiguration	object	Managed resource group configuration.
networkacls	object	Network rule set for data product.
owners	array	List of name or email associated with data product resource deployment.
privateLinksEnabled	string	Flag to enable or disable private link for data product resource. Known values are: "Enabled" and "Disabled".
product	string	Product name of data product. Required.
provisioningState	string	Latest provisioning state of data product. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted".
publicNetworkAccess	string	Flag to enable or disable public access of data product resource. Known values are: "Enabled" and "Disabled".
publisher	string	Data product publisher name. Required.
purviewAccount	string	Purview account url for data product to connect to.
purviewCollection	string	Purview collection url for data product to connect to.
redundancy	string	Flag to enable or disable redundancy for data product. Known values are: "Enabled" and "Disabled".
resourceGuid	string	The resource GUID property of the data product resource.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_group

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.
availableMinorVersions	array	List of available minor versions of the data product resource.
consumptionEndpoints	object	Resource links which exposed to the customer to query the data.
currentMinorVersion	string	Current configured minor version of the data product resource.
customerEncryptionKey	object	Customer managed encryption key details for data product.
customerManagedKeyEncryptionEnabled	string	Flag to enable customer managed key encryption for data product. Known values are: "Enabled" and "Disabled".
documentation	string	Documentation link for the data product based on definition file.
identity	object	The managed service identities assigned to this resource.
keyVaultUrl	string	Key vault url.
location	string	The geo-location where the resource lives. Required.
majorVersion	string	Major version of data product. Required.
managedResourceGroupConfiguration	object	Managed resource group configuration.
networkacls	object	Network rule set for data product.
owners	array	List of name or email associated with data product resource deployment.
privateLinksEnabled	string	Flag to enable or disable private link for data product resource. Known values are: "Enabled" and "Disabled".
product	string	Product name of data product. Required.
provisioningState	string	Latest provisioning state of data product. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted".
publicNetworkAccess	string	Flag to enable or disable public access of data product resource. Known values are: "Enabled" and "Disabled".
publisher	string	Data product publisher name. Required.
purviewAccount	string	Purview account url for data product to connect to.
purviewCollection	string	Purview collection url for data product to connect to.
redundancy	string	Flag to enable or disable redundancy for data product. Known values are: "Enabled" and "Disabled".
resourceGuid	string	The resource GUID property of the data product resource.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

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.
availableMinorVersions	array	List of available minor versions of the data product resource.
consumptionEndpoints	object	Resource links which exposed to the customer to query the data.
currentMinorVersion	string	Current configured minor version of the data product resource.
customerEncryptionKey	object	Customer managed encryption key details for data product.
customerManagedKeyEncryptionEnabled	string	Flag to enable customer managed key encryption for data product. Known values are: "Enabled" and "Disabled".
documentation	string	Documentation link for the data product based on definition file.
identity	object	The managed service identities assigned to this resource.
keyVaultUrl	string	Key vault url.
location	string	The geo-location where the resource lives. Required.
majorVersion	string	Major version of data product. Required.
managedResourceGroupConfiguration	object	Managed resource group configuration.
networkacls	object	Network rule set for data product.
owners	array	List of name or email associated with data product resource deployment.
privateLinksEnabled	string	Flag to enable or disable private link for data product resource. Known values are: "Enabled" and "Disabled".
product	string	Product name of data product. Required.
provisioningState	string	Latest provisioning state of data product. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted".
publicNetworkAccess	string	Flag to enable or disable public access of data product resource. Known values are: "Enabled" and "Disabled".
publisher	string	Data product publisher name. Required.
purviewAccount	string	Purview account url for data product to connect to.
purviewCollection	string	Purview collection url for data product to connect to.
redundancy	string	Flag to enable or disable redundancy for data product. Known values are: "Enabled" and "Disabled".
resourceGuid	string	The resource GUID property of the data product resource.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
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, data_product_name, subscription_id		Retrieve data product resource.
list_by_resource_group	select	resource_group_name, subscription_id		List data products by resource group.
list_by_subscription	select	subscription_id		List data products by subscription.
create	insert	resource_group_name, data_product_name, subscription_id, location		Create data product resource.
update	update	resource_group_name, data_product_name, subscription_id		Update data product resource.
delete	delete	resource_group_name, data_product_name, subscription_id		Delete data product resource.
list_roles_assignments	exec	resource_group_name, data_product_name, subscription_id		List user roles associated with the data product.
add_user_role	exec	resource_group_name, data_product_name, subscription_id, roleId, principalId, userName, dataTypeScope, principalType, role		Assign role to the data product.
generate_storage_account_sas_token	exec	resource_group_name, data_product_name, subscription_id, startTimeStamp, expiryTimeStamp, ipAddress		Generate sas token for storage account.
remove_user_role	exec	resource_group_name, data_product_name, subscription_id, roleId, principalId, userName, dataTypeScope, principalType, role, roleAssignmentId		Remove role from the data product.
rotate_key	exec	resource_group_name, data_product_name, subscription_id, keyVaultUrl		Initiate key rotation on Data Product.

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
data_product_name	string	The data product resource name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Retrieve data product resource.

SELECT
id,
name,
availableMinorVersions,
consumptionEndpoints,
currentMinorVersion,
customerEncryptionKey,
customerManagedKeyEncryptionEnabled,
documentation,
identity,
keyVaultUrl,
location,
majorVersion,
managedResourceGroupConfiguration,
networkacls,
owners,
privateLinksEnabled,
product,
provisioningState,
publicNetworkAccess,
publisher,
purviewAccount,
purviewCollection,
redundancy,
resourceGuid,
systemData,
tags,
type
FROM azure_extras.network_analytics.data_products
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND data_product_name = '{{ data_product_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List data products by resource group.

SELECT
id,
name,
availableMinorVersions,
consumptionEndpoints,
currentMinorVersion,
customerEncryptionKey,
customerManagedKeyEncryptionEnabled,
documentation,
identity,
keyVaultUrl,
location,
majorVersion,
managedResourceGroupConfiguration,
networkacls,
owners,
privateLinksEnabled,
product,
provisioningState,
publicNetworkAccess,
publisher,
purviewAccount,
purviewCollection,
redundancy,
resourceGuid,
systemData,
tags,
type
FROM azure_extras.network_analytics.data_products
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

List data products by subscription.

SELECT
id,
name,
availableMinorVersions,
consumptionEndpoints,
currentMinorVersion,
customerEncryptionKey,
customerManagedKeyEncryptionEnabled,
documentation,
identity,
keyVaultUrl,
location,
majorVersion,
managedResourceGroupConfiguration,
networkacls,
owners,
privateLinksEnabled,
product,
provisioningState,
publicNetworkAccess,
publisher,
purviewAccount,
purviewCollection,
redundancy,
resourceGuid,
systemData,
tags,
type
FROM azure_extras.network_analytics.data_products
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Create data product resource.

INSERT INTO azure_extras.network_analytics.data_products (
tags,
location,
properties,
identity,
resource_group_name,
data_product_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ identity }}',
'{{ resource_group_name }}',
'{{ data_product_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: data_products
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the data_products resource.
  - name: data_product_name
    value: "{{ data_product_name }}"
    description: Required parameter for the data_products resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the data_products resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      resourceGuid: "{{ resourceGuid }}"
      provisioningState: "{{ provisioningState }}"
      publisher: "{{ publisher }}"
      product: "{{ product }}"
      majorVersion: "{{ majorVersion }}"
      owners:
        - "{{ owners }}"
      redundancy: "{{ redundancy }}"
      purviewAccount: "{{ purviewAccount }}"
      purviewCollection: "{{ purviewCollection }}"
      privateLinksEnabled: "{{ privateLinksEnabled }}"
      publicNetworkAccess: "{{ publicNetworkAccess }}"
      customerManagedKeyEncryptionEnabled: "{{ customerManagedKeyEncryptionEnabled }}"
      customerEncryptionKey:
        keyVaultUri: "{{ keyVaultUri }}"
        keyName: "{{ keyName }}"
        keyVersion: "{{ keyVersion }}"
      networkacls:
        virtualNetworkRule:
          - id: "{{ id }}"
            action: "{{ action }}"
            state: "{{ state }}"
        ipRules:
          - value: "{{ value }}"
            action: "{{ action }}"
        allowedQueryIpRangeList:
          - "{{ allowedQueryIpRangeList }}"
        defaultAction: "{{ defaultAction }}"
      managedResourceGroupConfiguration:
        name: "{{ name }}"
        location: "{{ location }}"
      availableMinorVersions:
        - "{{ availableMinorVersions }}"
      currentMinorVersion: "{{ currentMinorVersion }}"
      documentation: "{{ documentation }}"
      consumptionEndpoints:
        ingestionUrl: "{{ ingestionUrl }}"
        ingestionResourceId: "{{ ingestionResourceId }}"
        fileAccessUrl: "{{ fileAccessUrl }}"
        fileAccessResourceId: "{{ fileAccessResourceId }}"
        queryUrl: "{{ queryUrl }}"
        queryResourceId: "{{ queryResourceId }}"
      keyVaultUrl: "{{ keyVaultUrl }}"
  - name: identity
    description: |
      The managed service identities assigned to this resource.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"

UPDATE examples

update

Update data product resource.

UPDATE azure_extras.network_analytics.data_products
SET 
identity = '{{ identity }}',
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND data_product_name = '{{ data_product_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete data product resource.

DELETE FROM azure_extras.network_analytics.data_products
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND data_product_name = '{{ data_product_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_roles_assignments

List user roles associated with the data product.

EXEC azure_extras.network_analytics.data_products.list_roles_assignments 
@resource_group_name='{{ resource_group_name }}' --required, 
@data_product_name='{{ data_product_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

add_user_role

Assign role to the data product.

EXEC azure_extras.network_analytics.data_products.add_user_role 
@resource_group_name='{{ resource_group_name }}' --required, 
@data_product_name='{{ data_product_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"roleId": "{{ roleId }}", 
"principalId": "{{ principalId }}", 
"userName": "{{ userName }}", 
"dataTypeScope": "{{ dataTypeScope }}", 
"principalType": "{{ principalType }}", 
"role": "{{ role }}"
}'
;

generate_storage_account_sas_token

Generate sas token for storage account.

EXEC azure_extras.network_analytics.data_products.generate_storage_account_sas_token 
@resource_group_name='{{ resource_group_name }}' --required, 
@data_product_name='{{ data_product_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"startTimeStamp": "{{ startTimeStamp }}", 
"expiryTimeStamp": "{{ expiryTimeStamp }}", 
"ipAddress": "{{ ipAddress }}"
}'
;

remove_user_role

Remove role from the data product.

EXEC azure_extras.network_analytics.data_products.remove_user_role 
@resource_group_name='{{ resource_group_name }}' --required, 
@data_product_name='{{ data_product_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"roleId": "{{ roleId }}", 
"principalId": "{{ principalId }}", 
"userName": "{{ userName }}", 
"dataTypeScope": "{{ dataTypeScope }}", 
"principalType": "{{ principalType }}", 
"role": "{{ role }}", 
"roleAssignmentId": "{{ roleAssignmentId }}"
}'
;

rotate_key

Initiate key rotation on Data Product.

EXEC azure_extras.network_analytics.data_products.rotate_key 
@resource_group_name='{{ resource_group_name }}' --required, 
@data_product_name='{{ data_product_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"keyVaultUrl": "{{ keyVaultUrl }}"
}'
;