Поделиться через

Product Group Link - List By Product

Служба:
API Management
Версия API:
2024-05-01

Перечисляет коллекцию ссылок группы, связанных с продуктом.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/groupLinks?api-version=2024-05-01
С использованием необязательных параметров: 
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/groupLinks?$filter={$filter}&$top={$top}&$skip={$skip}&api-version=2024-05-01

Параметры URI

Имя В Обязательно Тип Описание
productId
 path True

string

minLength: 1
maxLength: 256

Идентификатор продукта. Должен быть уникальным в текущем экземпляре службы управления API.
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

| Поле | Использование | Поддерживаемые операторы | Поддерживаемые функции |
|-------------|-------------|-------------|-------------|
| groupId | 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

ProductGroupLinkCollection

Текст ответа содержит коллекцию сущностей связи группы в продукте.
Other Status Codes

ErrorResponse

Ответ на ошибку, описывающий причину сбоя операции.

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

azure_auth

Поток OAuth2 Azure Active Directory.

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

Области

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

Примеры

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

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

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

Код состояния:
200 
{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/product1/groupLinks/link1",
      "type": "Microsoft.ApiManagement/service/products/groupLinks",
      "name": "link1",
      "properties": {
        "groupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/group1"
      }
    }
  ],
  "count": 1,
  "nextLink": ""
}

Определения

Имя Описание
ErrorAdditionalInfo

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

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

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

Представление списка ссылок на страницы product-group.
ProductGroupLinkContract

Сведения о ссылке на группу продуктов.

ErrorAdditionalInfo

Object

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

Имя Тип Описание
info

object

Дополнительные сведения.
type

string

Дополнительный тип сведений.

ErrorDetail

Object

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

Имя Тип Описание
additionalInfo

ErrorAdditionalInfo[]

Дополнительные сведения об ошибке.
code

string

Код ошибки.
details

ErrorDetail[]

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

string

Сообщение об ошибке.
target

string

Целевой объект ошибки.

ErrorResponse

Object

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

Имя Тип Описание
error

ErrorDetail

Объект ошибки.

ProductGroupLinkCollection

Object

Представление списка ссылок на страницы product-group.

Имя Тип Описание
count

integer (int64)

Общее число записей на всех страницах.
nextLink

string

Следующая ссылка на страницу, если она есть.
value

ProductGroupLinkContract[]

Значения страницы.

ProductGroupLinkContract

Object

Сведения о ссылке на группу продуктов.

Имя Тип Описание
id

string

Полный идентификатор ресурса для ресурса. Пример - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

Имя ресурса
properties.groupId

string

Полный идентификатор ресурса группы.
type

string

Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"