workspace_links

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

Overview

Name	workspace_links
Type	Resource
Id	azure.api_management.workspace_links

Fields

The following fields are returned by SELECT queries:

get

Successfully got the API Management WorkspaceLink resource.

Name	Datatype	Description
etag	string	ETag of the resource.
properties	object	Properties of the API Management WorkspaceLinks.

list_by_service

The API Management gateway workspaceLinks list.

Name	Datatype	Description
etag	string	ETag of the resource.
properties	object	Properties of the API Management WorkspaceLinks.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, serviceName, workspaceId, subscriptionId		Gets an API Management WorkspaceLink resource description.
list_by_service	select	resourceGroupName, subscriptionId, serviceName		List all API Management workspaceLinks for a service.

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
resourceGroupName	string	The name of the resource group. The name is case insensitive.
serviceName	string	The name of the API Management service.
subscriptionId	string	The ID of the target subscription.
workspaceId	string	Workspace identifier. Must be unique in the current API Management service instance.

SELECT examples

get

Gets an API Management WorkspaceLink resource description.

SELECT
etag,
properties
FROM azure.api_management.workspace_links
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND workspaceId = '{{ workspaceId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_service

List all API Management workspaceLinks for a service.

SELECT
etag,
properties
FROM azure.api_management.workspace_links
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND serviceName = '{{ serviceName }}' -- required
;