api_management_workspace_link

Creates, updates, deletes, gets or lists an api_management_workspace_link resource.

Overview

Name	api_management_workspace_link
Type	Resource
Id	azure.api_management.api_management_workspace_link

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.
etag	string	ETag of the resource.
gateways	array	The array of linked gateways.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
workspaceId	string	The link to the API Management service workspace.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, service_name, workspace_id, subscription_id		Gets an API Management WorkspaceLink resource description.

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
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
service_name	string	The name of the API Management service. Required.
subscription_id	string
workspace_id	string	Workspace identifier. Must be unique in the current API Management service instance. Required.

SELECT examples

get

Gets an API Management WorkspaceLink resource description.

SELECT
id,
name,
etag,
gateways,
systemData,
type,
workspaceId
FROM azure.api_management.api_management_workspace_link
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND workspace_id = '{{ workspace_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;