Linked Workspace - Get

Service:

Automation

API Version:

2023-11-01

Retrieve the linked workspace for the account id.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/linkedWorkspace?api-version=2023-11-01

URI Parameters

Name	In	Required	Type	Description
automationAccountName	path	True	string	The name of the automation account.
resourceGroupName	path	True	string	Name of an Azure Resource group. Regex pattern: ^[-\w\._]+$
subscriptionId	path	True	string	Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version	query	True	string	Client Api Version.

Responses

Name	Type	Description
200 OK	LinkedWorkspace	OK
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

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

Get the linked workspace of an automation account

Sample Request

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/ContosoAutomationAccount/linkedWorkspace?api-version=2023-11-01

Sample Response

Status code:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.OperationalInsights/workspaces/ContosoWorkspace"
}

Definitions

Name	Description
ErrorResponse	Error response of an operation failure
LinkedWorkspace	Definition of the linked workspace.

ErrorResponse

Error response of an operation failure

Name	Type	Description
code	string	Error code
message	string	Error message indicating why the operation failed.

LinkedWorkspace

Definition of the linked workspace.

Name	Type	Description
id	string	Gets the id of the linked workspace.