Api Management Workspace Link - Get

Reference

Service:: API Management

API Version:: 2024-05-01

Gets an API Management WorkspaceLink resource description.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaceLinks/{workspaceId}?api-version=2024-05-01

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
serviceName	path	True	string	The name of the API Management service. Regex pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string uuid	The ID of the target subscription. The value must be an UUID.
workspaceId	path	True	string	Workspace identifier. Must be unique in the current API Management service instance. Regex pattern: `^[^*#&+:<>?]+$`
api-version	query	True	string	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	ApiManagementWorkspaceLinksResource	Successfully got the API Management WorkspaceLink resource.
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

ApiManagementGetWorkspaceLinks

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/service1/workspaceLinks/wk-1?api-version=2024-05-01

Sample response

Status code:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/service-1/workspaceLinks/wk-1",
  "name": "wk-1",
  "type": "Microsoft.ApiManagement/service/workspaceLinks",
  "etag": "AAAAAAAWN/4=",
  "properties": {
    "workspaceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/services/service-1/workspaces/wk-1",
    "gateways": [
      {
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/gateway-1"
      }
    ]
  }
}

Definitions

Name	Description
ApiManagementWorkspaceLinksResource	A single API Management WorkspaceLinks in List or Get response.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
WorkspaceLinksGateway

ApiManagementWorkspaceLinksResource

A single API Management WorkspaceLinks in List or Get response.

Name	Type	Description
etag	string	ETag of the resource.
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.gateways	WorkspaceLinksGateway[]	The array of linked gateways.
properties.workspaceId	string	The link to the API Management service workspace.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

WorkspaceLinksGateway

Name	Type	Description
id	string	The link to the API Management gateway.

Share via