linked_services

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

Overview

Name	linked_services
Type	Resource
Id	azure.log_analytics.linked_services

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.
provisioningState	string	The provisioning state of the linked service. Known values are: "Succeeded", "Deleting", "ProvisioningAccount", and "Updating". (Succeeded, Deleting, ProvisioningAccount, Updating)
resourceId	string	The resource id of the resource that will be linked to the workspace. This should be used for linking resources which require read access.
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".
writeAccessResourceId	string	The resource id of the resource that will be linked to the workspace. This should be used for linking resources which require write access.

list_by_workspace

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.
provisioningState	string	The provisioning state of the linked service. Known values are: "Succeeded", "Deleting", "ProvisioningAccount", and "Updating". (Succeeded, Deleting, ProvisioningAccount, Updating)
resourceId	string	The resource id of the resource that will be linked to the workspace. This should be used for linking resources which require read access.
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".
writeAccessResourceId	string	The resource id of the resource that will be linked to the workspace. This should be used for linking resources which require write access.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, workspace_name, linked_service_name, subscription_id		Gets a linked service instance.
list_by_workspace	select	resource_group_name, workspace_name, subscription_id		Gets the linked services instances in a workspace.
create_or_update	insert	resource_group_name, workspace_name, linked_service_name, subscription_id, properties		Create or update a linked service.
create_or_update	replace	resource_group_name, workspace_name, linked_service_name, subscription_id, properties		Create or update a linked service.
delete	delete	resource_group_name, workspace_name, linked_service_name, subscription_id		Deletes a linked service instance.

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
linked_service_name	string	Name of the linked service. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
workspace_name	string	The name of the workspace. Required.

SELECT examples

get

Gets a linked service instance.

SELECT
id,
name,
provisioningState,
resourceId,
systemData,
tags,
type,
writeAccessResourceId
FROM azure.log_analytics.linked_services
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND linked_service_name = '{{ linked_service_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_workspace

Gets the linked services instances in a workspace.

SELECT
id,
name,
provisioningState,
resourceId,
systemData,
tags,
type,
writeAccessResourceId
FROM azure.log_analytics.linked_services
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update a linked service.

INSERT INTO azure.log_analytics.linked_services (
properties,
tags,
resource_group_name,
workspace_name,
linked_service_name,
subscription_id
)
SELECT 
'{{ properties }}' /* required */,
'{{ tags }}',
'{{ resource_group_name }}',
'{{ workspace_name }}',
'{{ linked_service_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: linked_services
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the linked_services resource.
  - name: workspace_name
    value: "{{ workspace_name }}"
    description: Required parameter for the linked_services resource.
  - name: linked_service_name
    value: "{{ linked_service_name }}"
    description: Required parameter for the linked_services resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the linked_services resource.
  - name: properties
    description: |
      The properties of the linked service. Required.
    value:
      resourceId: "{{ resourceId }}"
      writeAccessResourceId: "{{ writeAccessResourceId }}"
      provisioningState: "{{ provisioningState }}"
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.

REPLACE examples

create_or_update

Create or update a linked service.

REPLACE azure.log_analytics.linked_services
SET 
properties = '{{ properties }}',
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND linked_service_name = '{{ linked_service_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes a linked service instance.

DELETE FROM azure.log_analytics.linked_services
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND linked_service_name = '{{ linked_service_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;