Linked Services - Create Or Update

Reference

Service:: Log Analytics

API Version:: 2023-09-01

Create or update a linked service.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/linkedServices/{linkedServiceName}?api-version=2023-09-01

URI Parameters

Name	In	Required	Type	Description
linkedServiceName	path	True	string	Name of the linkedServices resource
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string	The ID of the target subscription.
workspaceName	path	True	string	The name of the workspace. Regex pattern: `^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$`
api-version	query	True	string	The API version to use for this operation.

Request Body

Name	Type	Description
properties.provisioningState	LinkedServiceEntityStatus	The provisioning state of the linked service.
properties.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
properties.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
tags	object	Resource tags.

Responses

Name	Type	Description
200 OK	LinkedService	OK response definition.
201 Created	LinkedService	Created response definition.
202 Accepted		Accepted response definition.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

LinkedServicesCreate

Sample request

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-00000000000/resourcegroups/mms-eus/providers/Microsoft.OperationalInsights/workspaces/TestLinkWS/linkedServices/Cluster?api-version=2023-09-01

{
  "properties": {
    "writeAccessResourceId": "/subscriptions/00000000-0000-0000-0000-00000000000/resourceGroups/mms-eus/providers/Microsoft.OperationalInsights/clusters/testcluster"
  }
}

Sample response

Status code:: 202

Status code:: 200

{
  "properties": {
    "writeAccessResourceId": "/subscriptions/00000000-0000-0000-0000-00000000000/resourceGroups/mms-eus/providers/Microsoft.OperationalInsights/clusters/testcluster",
    "provisioningState": "ProvisioningAccount"
  },
  "id": "/subscriptions/00000000-0000-0000-0000-00000000000/resourcegroups/mms-eus/providers/microsoft.operationalinsights/workspaces/testlinkws/linkedservices/cluster",
  "name": "TestLinkWS/Cluster",
  "type": "Microsoft.OperationalInsights/workspaces/linkedServices"
}

Status code:: 201

{
  "properties": {
    "writeAccessResourceId": "/subscriptions/00000000-0000-0000-0000-00000000000/resourceGroups/mms-eus/providers/Microsoft.OperationalInsights/clusters/testcluster",
    "provisioningState": "ProvisioningAccount"
  },
  "id": "/subscriptions/00000000-0000-0000-0000-00000000000/resourcegroups/mms-eus/providers/microsoft.operationalinsights/workspaces/testlinkws/linkedservices/cluster",
  "name": "TestLinkWS/Cluster",
  "type": "Microsoft.OperationalInsights/workspaces/linkedServices"
}

Definitions

Name	Description
LinkedService	The top level Linked service resource container.
LinkedServiceEntityStatus	The provisioning state of the linked service.

LinkedService

The top level Linked service resource container.

Name	Type	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
properties.provisioningState	LinkedServiceEntityStatus	The provisioning state of the linked service.
properties.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
properties.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
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

LinkedServiceEntityStatus

The provisioning state of the linked service.

Name	Type	Description
Deleting	string
ProvisioningAccount	string
Succeeded	string
Updating	string

Share via