data_controllers

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

Overview

Name	data_controllers
Type	Resource
Id	azure.azure_arc_data.data_controllers

Fields

The following fields are returned by SELECT queries:

get_data_controller

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.
basicLoginInformation	object	Deprecated. Azure Arc Data Services data controller no longer expose any endpoint. All traffic are exposed through Kubernetes native API.
clusterId	string	If a CustomLocation is provided, this contains the ARM id of the connected cluster the custom location belongs to.
extendedLocation	object	The extendedLocation of the resource.
extensionId	string	If a CustomLocation is provided, this contains the ARM id of the extension the custom location belongs to.
infrastructure	string	The infrastructure the data controller is running on. Known values are: "azure", "gcp", "aws", "alibaba", "onpremises", and "other".
k8sRaw	object	The raw kubernetes information.
lastUploadedDate	string (date-time)	Last uploaded date from Kubernetes cluster. Defaults to current date time.
location	string	The geo-location where the resource lives. Required.
logAnalyticsWorkspaceConfig	object	Log analytics workspace id and primary key.
logsDashboardCredential	object	Login credential for logs dashboard on the Kubernetes cluster.
metricsDashboardCredential	object	Login credential for metrics dashboard on the Kubernetes cluster.
onPremiseProperty	object	Properties from the Kubernetes data controller.
provisioningState	string	The provisioning state of the Arc Data Controller 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".
uploadServicePrincipal	object	Deprecated. Service principal is deprecated in favor of Arc Kubernetes service extension managed identity.
uploadWatermark	object	Properties on upload watermark. Mostly timestamp for each upload data type.

list_in_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.
basicLoginInformation	object	Deprecated. Azure Arc Data Services data controller no longer expose any endpoint. All traffic are exposed through Kubernetes native API.
clusterId	string	If a CustomLocation is provided, this contains the ARM id of the connected cluster the custom location belongs to.
extendedLocation	object	The extendedLocation of the resource.
extensionId	string	If a CustomLocation is provided, this contains the ARM id of the extension the custom location belongs to.
infrastructure	string	The infrastructure the data controller is running on. Known values are: "azure", "gcp", "aws", "alibaba", "onpremises", and "other".
k8sRaw	object	The raw kubernetes information.
lastUploadedDate	string (date-time)	Last uploaded date from Kubernetes cluster. Defaults to current date time.
location	string	The geo-location where the resource lives. Required.
logAnalyticsWorkspaceConfig	object	Log analytics workspace id and primary key.
logsDashboardCredential	object	Login credential for logs dashboard on the Kubernetes cluster.
metricsDashboardCredential	object	Login credential for metrics dashboard on the Kubernetes cluster.
onPremiseProperty	object	Properties from the Kubernetes data controller.
provisioningState	string	The provisioning state of the Arc Data Controller 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".
uploadServicePrincipal	object	Deprecated. Service principal is deprecated in favor of Arc Kubernetes service extension managed identity.
uploadWatermark	object	Properties on upload watermark. Mostly timestamp for each upload data type.

list_in_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.
basicLoginInformation	object	Deprecated. Azure Arc Data Services data controller no longer expose any endpoint. All traffic are exposed through Kubernetes native API.
clusterId	string	If a CustomLocation is provided, this contains the ARM id of the connected cluster the custom location belongs to.
extendedLocation	object	The extendedLocation of the resource.
extensionId	string	If a CustomLocation is provided, this contains the ARM id of the extension the custom location belongs to.
infrastructure	string	The infrastructure the data controller is running on. Known values are: "azure", "gcp", "aws", "alibaba", "onpremises", and "other".
k8sRaw	object	The raw kubernetes information.
lastUploadedDate	string (date-time)	Last uploaded date from Kubernetes cluster. Defaults to current date time.
location	string	The geo-location where the resource lives. Required.
logAnalyticsWorkspaceConfig	object	Log analytics workspace id and primary key.
logsDashboardCredential	object	Login credential for logs dashboard on the Kubernetes cluster.
metricsDashboardCredential	object	Login credential for metrics dashboard on the Kubernetes cluster.
onPremiseProperty	object	Properties from the Kubernetes data controller.
provisioningState	string	The provisioning state of the Arc Data Controller 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".
uploadServicePrincipal	object	Deprecated. Service principal is deprecated in favor of Arc Kubernetes service extension managed identity.
uploadWatermark	object	Properties on upload watermark. Mostly timestamp for each upload data type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_data_controller	select	resource_group_name, data_controller_name, subscription_id		Retrieves a dataController resource.
list_in_group	select	resource_group_name, subscription_id		List dataController resources in the resource group. List dataController resources in the resource group.
list_in_subscription	select	subscription_id		List dataController resources in the subscription. List dataController resources in the subscription.
delete_data_controller	delete	resource_group_name, data_controller_name, subscription_id		Deletes a dataController resource.
put_data_controller	exec	resource_group_name, data_controller_name, subscription_id, location, properties		Creates or replaces a dataController resource.
patch_data_controller	exec	resource_group_name, data_controller_name, subscription_id		Updates a dataController resource.

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_controller_name	string	The name of the data controller. Required.
resource_group_name	string	The name of the Azure resource group. Required.
subscription_id	string

SELECT examples

get_data_controller

Retrieves a dataController resource.

SELECT
id,
name,
basicLoginInformation,
clusterId,
extendedLocation,
extensionId,
infrastructure,
k8sRaw,
lastUploadedDate,
location,
logAnalyticsWorkspaceConfig,
logsDashboardCredential,
metricsDashboardCredential,
onPremiseProperty,
provisioningState,
systemData,
tags,
type,
uploadServicePrincipal,
uploadWatermark
FROM azure.azure_arc_data.data_controllers
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND data_controller_name = '{{ data_controller_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_in_group

List dataController resources in the resource group. List dataController resources in the resource group.

SELECT
id,
name,
basicLoginInformation,
clusterId,
extendedLocation,
extensionId,
infrastructure,
k8sRaw,
lastUploadedDate,
location,
logAnalyticsWorkspaceConfig,
logsDashboardCredential,
metricsDashboardCredential,
onPremiseProperty,
provisioningState,
systemData,
tags,
type,
uploadServicePrincipal,
uploadWatermark
FROM azure.azure_arc_data.data_controllers
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_in_subscription

List dataController resources in the subscription. List dataController resources in the subscription.

SELECT
id,
name,
basicLoginInformation,
clusterId,
extendedLocation,
extensionId,
infrastructure,
k8sRaw,
lastUploadedDate,
location,
logAnalyticsWorkspaceConfig,
logsDashboardCredential,
metricsDashboardCredential,
onPremiseProperty,
provisioningState,
systemData,
tags,
type,
uploadServicePrincipal,
uploadWatermark
FROM azure.azure_arc_data.data_controllers
WHERE subscription_id = '{{ subscription_id }}' -- required
;

DELETE examples

delete_data_controller

Deletes a dataController resource.

DELETE FROM azure.azure_arc_data.data_controllers
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND data_controller_name = '{{ data_controller_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

put_data_controller

Creates or replaces a dataController resource.

EXEC azure.azure_arc_data.data_controllers.put_data_controller 
@resource_group_name='{{ resource_group_name }}' --required, 
@data_controller_name='{{ data_controller_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"tags": "{{ tags }}", 
"location": "{{ location }}", 
"extendedLocation": "{{ extendedLocation }}", 
"properties": "{{ properties }}"
}'
;

patch_data_controller

Updates a dataController resource.

EXEC azure.azure_arc_data.data_controllers.patch_data_controller 
@resource_group_name='{{ resource_group_name }}' --required, 
@data_controller_name='{{ data_controller_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"tags": "{{ tags }}", 
"properties": "{{ properties }}"
}'
;