data_types

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

Overview

Name	data_types
Type	Resource
Id	azure_extras.network_analytics.data_types

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.
databaseCacheRetention	integer	Field for database cache retention in days.
databaseRetention	integer	Field for database data retention in days.
provisioningState	string	Latest provisioning state of data product. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted".
state	string	State of data type. Known values are: "Stopped" and "Running".
stateReason	string	Reason for the state of data type.
storageOutputRetention	integer	Field for storage output retention in days.
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".
visualizationUrl	string	Url for data visualization.

list_by_data_product

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.
databaseCacheRetention	integer	Field for database cache retention in days.
databaseRetention	integer	Field for database data retention in days.
provisioningState	string	Latest provisioning state of data product. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted".
state	string	State of data type. Known values are: "Stopped" and "Running".
stateReason	string	Reason for the state of data type.
storageOutputRetention	integer	Field for storage output retention in days.
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".
visualizationUrl	string	Url for data visualization.

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, data_type_name, subscription_id		Retrieve data type resource.
list_by_data_product	select	resource_group_name, data_product_name, subscription_id		List data type by parent resource.
create	insert	resource_group_name, data_product_name, data_type_name, subscription_id		Create data type resource.
update	update	resource_group_name, data_product_name, data_type_name, subscription_id		Update data type resource.
delete	delete	resource_group_name, data_product_name, data_type_name, subscription_id		Delete data type resource.
delete_data	exec	resource_group_name, data_product_name, data_type_name, subscription_id		Delete data for data type.
generate_storage_container_sas_token	exec	resource_group_name, data_product_name, data_type_name, subscription_id, startTimeStamp, expiryTimeStamp, ipAddress		Generate sas token for storage container.

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.
data_type_name	string	The data type 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 type resource.

SELECT
id,
name,
databaseCacheRetention,
databaseRetention,
provisioningState,
state,
stateReason,
storageOutputRetention,
systemData,
type,
visualizationUrl
FROM azure_extras.network_analytics.data_types
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND data_product_name = '{{ data_product_name }}' -- required
AND data_type_name = '{{ data_type_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_data_product

List data type by parent resource.

SELECT
id,
name,
databaseCacheRetention,
databaseRetention,
provisioningState,
state,
stateReason,
storageOutputRetention,
systemData,
type,
visualizationUrl
FROM azure_extras.network_analytics.data_types
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND data_product_name = '{{ data_product_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Create data type resource.

INSERT INTO azure_extras.network_analytics.data_types (
properties,
resource_group_name,
data_product_name,
data_type_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ data_product_name }}',
'{{ data_type_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: data_types
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the data_types resource.
  - name: data_product_name
    value: "{{ data_product_name }}"
    description: Required parameter for the data_types resource.
  - name: data_type_name
    value: "{{ data_type_name }}"
    description: Required parameter for the data_types resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the data_types resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      provisioningState: "{{ provisioningState }}"
      state: "{{ state }}"
      stateReason: "{{ stateReason }}"
      storageOutputRetention: {{ storageOutputRetention }}
      databaseCacheRetention: {{ databaseCacheRetention }}
      databaseRetention: {{ databaseRetention }}
      visualizationUrl: "{{ visualizationUrl }}"

UPDATE examples

update

Update data type resource.

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

DELETE examples

delete

Delete data type resource.

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

Lifecycle Methods

delete_data

Delete data for data type.

EXEC azure_extras.network_analytics.data_types.delete_data 
@resource_group_name='{{ resource_group_name }}' --required, 
@data_product_name='{{ data_product_name }}' --required, 
@data_type_name='{{ data_type_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

generate_storage_container_sas_token

Generate sas token for storage container.

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