Workspace - List By Service

Служба:: API Management

Версия API:: 2024-05-01

Выводит список всех рабочих областей экземпляра службы управления API.

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

С использованием необязательных параметров:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces?$filter={$filter}&$top={$top}&$skip={$skip}&api-version=2024-05-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Имя группы ресурсов. Имя не учитывает регистр.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Имя службы управления API.
subscriptionId	path	True	string (uuid)	Идентификатор целевой подписки. Значение должно быть UUID.
api-version	query	True	string minLength: 1	Версия API, используемая для этой операции.
$filter	query		string	\| Поле \| Использование \| Поддерживаемые операторы \| Поддерживаемые функции \| \|-------------\|-------------\|-------------\|-------------\| \| displayName \| filter \| ge, le, eq, ne, gt, lt \| substringof, contains, startswith, endswith \| \| описание \| filter \| ge, le, eq, ne, gt, lt \| substringof, contains, startswith, endswith \|
$skip	query		integer (int32) minimum: 0	Количество пропускаемых записей.
$top	query		integer (int32) minimum: 1	Количество возвращаемых записей.

Ответы

Имя	Тип	Описание
200 OK	WorkspaceCollection	Ответ результата страницы рабочих областей.
Other Status Codes	ErrorResponse	Ответ на ошибку, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

ApiManagementListWorkspaces

Образец запроса

HTTP

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

Пример ответа

Код состояния:: 200

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1",
      "type": "Microsoft.ApiManagement/service/workspaces",
      "name": "wks1",
      "properties": {
        "description": "workspace 1",
        "displayName": "my workspace"
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks2",
      "type": "Microsoft.ApiManagement/service/workspaces",
      "name": "wks1",
      "properties": {
        "description": "workspace 2",
        "displayName": "my workspace"
      }
    }
  ],
  "count": 2,
  "nextLink": ""
}

Определения

Имя	Описание
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
WorkspaceCollection	Представление списка страничных рабочих областей.
WorkspaceContract	Сведения о рабочей области.

ErrorAdditionalInfo

Object

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Object

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Object

Ответ на ошибку

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

WorkspaceCollection

Object

Представление списка страничных рабочих областей.

Имя	Тип	Описание
count	integer (int64)	Общее число записей на всех страницах.
nextLink	string	Следующая ссылка на страницу, если она есть.
value	WorkspaceContract[]	Значения страницы.

WorkspaceContract

Object

Сведения о рабочей области.

Имя	Тип	Описание
id	string	Полный идентификатор ресурса для ресурса. Пример - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Имя ресурса
properties.description	string	Описание рабочей области.
properties.displayName	string	Имя рабочей области.
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"