data_managers

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

Overview

Name	data_managers
Type	Resource
Id	azure.hybrid_data_manager.data_managers

Fields

The following fields are returned by SELECT queries:

get

Data Manager Resource object.

Name	Datatype	Description
id	string	The Resource Id.
name	string	The Resource Name.
etag	string	Etag of the Resource.
location	string	The location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update the request will succeed.
sku	object	The sku type.
tags	object	The list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups).
type	string	The Resource type.

list_by_resource_group

List of data manager resources by resource group.

Name	Datatype	Description
id	string	The Resource Id.
name	string	The Resource Name.
etag	string	Etag of the Resource.
location	string	The location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update the request will succeed.
sku	object	The sku type.
tags	object	The list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups).
type	string	The Resource type.

list

List of data manager resources available under the subscription.

Name	Datatype	Description
id	string	The Resource Id.
name	string	The Resource Name.
etag	string	Etag of the Resource.
location	string	The location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update the request will succeed.
sku	object	The sku type.
tags	object	The list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups).
type	string	The Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, dataManagerName		Gets information about the specified data manager resource.
list_by_resource_group	select	subscriptionId, resourceGroupName		Lists all the data manager resources available under the given resource group.
list	select	subscriptionId		Lists all the data manager resources available under the subscription.
create	insert	subscriptionId, resourceGroupName, dataManagerName		Creates a new data manager resource with the specified parameters. Existing resources cannot be updated with this API and should instead be updated with the Update data manager resource API.
update	update	subscriptionId, resourceGroupName, dataManagerName	If-Match	Updates the properties of an existing data manager resource.
delete	delete	subscriptionId, resourceGroupName, dataManagerName		Deletes a data manager resource in Microsoft Azure.

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
dataManagerName	string	The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only
resourceGroupName	string	The Resource Group Name
subscriptionId	string	The Subscription Id
If-Match	string	Defines the If-Match condition. The patch will be performed only if the ETag of the data manager resource on the server matches this value.

SELECT examples

get

Gets information about the specified data manager resource.

SELECT
id,
name,
etag,
location,
sku,
tags,
type
FROM azure.hybrid_data_manager.data_managers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND dataManagerName = '{{ dataManagerName }}' -- required
;

list_by_resource_group

Lists all the data manager resources available under the given resource group.

SELECT
id,
name,
etag,
location,
sku,
tags,
type
FROM azure.hybrid_data_manager.data_managers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list

Lists all the data manager resources available under the subscription.

SELECT
id,
name,
etag,
location,
sku,
tags,
type
FROM azure.hybrid_data_manager.data_managers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create

Creates a new data manager resource with the specified parameters. Existing resources cannot be updated with this API
and should instead be updated with the Update data manager resource API.

INSERT INTO azure.hybrid_data_manager.data_managers (
data__location,
data__tags,
data__sku,
data__etag,
subscriptionId,
resourceGroupName,
dataManagerName
)
SELECT 
'{{ location }}',
'{{ tags }}',
'{{ sku }}',
'{{ etag }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ dataManagerName }}'
RETURNING
id,
name,
etag,
location,
sku,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: data_managers
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the data_managers resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the data_managers resource.
    - name: dataManagerName
      value: string
      description: Required parameter for the data_managers resource.
    - name: location
      value: string
      description: |
        The location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East
        US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo
        region is specified on update the request will succeed.
    - name: tags
      value: object
      description: |
        The list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource
        (across resource groups).
    - name: sku
      value: object
      description: |
        The sku type.
    - name: etag
      value: string
      description: |
        Etag of the Resource.

UPDATE examples

update

Updates the properties of an existing data manager resource.

UPDATE azure.hybrid_data_manager.data_managers
SET 
data__sku = '{{ sku }}',
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND dataManagerName = '{{ dataManagerName }}' --required
AND If-Match = '{{ If-Match}}'
RETURNING
id,
name,
etag,
location,
sku,
tags,
type;

DELETE examples

delete

Deletes a data manager resource in Microsoft Azure.

DELETE FROM azure.hybrid_data_manager.data_managers
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND dataManagerName = '{{ dataManagerName }}' --required
;