data_products

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

Overview

Name	data_products
Type	Resource
Id	azure.network_analytics.data_products

Fields

The following fields are returned by SELECT queries:

get

Azure operation completed successfully.

Name	Datatype	Description
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
tags	object	Resource tags.

list_by_resource_group

Azure operation completed successfully.

Name	Datatype	Description
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
tags	object	Resource tags.

list_by_subscription

Azure operation completed successfully.

Name	Datatype	Description
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, dataProductName		Retrieve data product resource.
list_by_resource_group	select	subscriptionId, resourceGroupName		List data products by resource group.
list_by_subscription	select	subscriptionId		List data products by subscription.
create	insert	subscriptionId, resourceGroupName, dataProductName		Create data product resource.
update	update	subscriptionId, resourceGroupName, dataProductName		Update data product resource.
delete	delete	subscriptionId, resourceGroupName, dataProductName		Delete data product resource.
add_user_role	exec	subscriptionId, resourceGroupName, dataProductName, roleId, principalId, userName, dataTypeScope, principalType, role		Assign role to the data product.
generate_storage_account_sas_token	exec	subscriptionId, resourceGroupName, dataProductName, startTimeStamp, expiryTimeStamp, ipAddress		Generate sas token for storage account.
remove_user_role	exec	subscriptionId, resourceGroupName, dataProductName, roleId, principalId, userName, dataTypeScope, principalType, role, roleAssignmentId		Remove role from the data product.
rotate_key	exec	subscriptionId, resourceGroupName, dataProductName, 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
dataProductName	string	The data product resource name
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Retrieve data product resource.

SELECT
identity,
location,
properties,
tags
FROM azure.network_analytics.data_products
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND dataProductName = '{{ dataProductName }}' -- required
;

list_by_resource_group

List data products by resource group.

SELECT
identity,
location,
properties,
tags
FROM azure.network_analytics.data_products
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_subscription

List data products by subscription.

SELECT
identity,
location,
properties,
tags
FROM azure.network_analytics.data_products
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create

Create data product resource.

INSERT INTO azure.network_analytics.data_products (
data__properties,
data__identity,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
dataProductName
)
SELECT 
'{{ properties }}',
'{{ identity }}',
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ dataProductName }}'
RETURNING
identity,
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: data_products
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the data_products resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the data_products resource.
    - name: dataProductName
      value: string
      description: Required parameter for the data_products resource.
    - name: properties
      value: object
      description: |
        The resource-specific properties for this resource.
    - name: identity
      value: object
      description: |
        The managed service identities assigned to this resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

Update data product resource.

UPDATE azure.network_analytics.data_products
SET 
data__identity = '{{ identity }}',
data__tags = '{{ tags }}',
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND dataProductName = '{{ dataProductName }}' --required
RETURNING
identity,
location,
properties,
tags;

DELETE examples

delete

Delete data product resource.

DELETE FROM azure.network_analytics.data_products
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND dataProductName = '{{ dataProductName }}' --required
;

Lifecycle Methods

add_user_role

Assign role to the data product.

EXEC azure.network_analytics.data_products.add_user_role 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@dataProductName='{{ dataProductName }}' --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.network_analytics.data_products.generate_storage_account_sas_token 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@dataProductName='{{ dataProductName }}' --required 
@@json=
'{
"startTimeStamp": "{{ startTimeStamp }}", 
"expiryTimeStamp": "{{ expiryTimeStamp }}", 
"ipAddress": "{{ ipAddress }}"
}'
;

remove_user_role

Remove role from the data product.

EXEC azure.network_analytics.data_products.remove_user_role 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@dataProductName='{{ dataProductName }}' --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.network_analytics.data_products.rotate_key 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@dataProductName='{{ dataProductName }}' --required 
@@json=
'{
"keyVaultUrl": "{{ keyVaultUrl }}"
}'
;