Gateway Custom Domains - List

Обработка запросов для вывода списка всех личных доменов шлюза Spring Cloud.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/gateways/{gatewayName}/domains?api-version=2022-09-01-preview

Параметры URI

Name In Required Type Description
gatewayName
path True
  • string

Имя шлюза Spring Cloud.

resourceGroupName
path True
  • string

Имя группы ресурсов, к которой относится ресурс. Это значение можно получить от API-интерфейса диспетчера ресурсов Azure или портала.

serviceName
path True
  • string

Имя ресурса службы.

subscriptionId
path True
  • string

Возвращает идентификатор подписки, однозначно определяющий Microsoft Azure подписку. Идентификатор подписки формирует часть URI для каждого вызова службы.

api-version
query True
  • string

Версия API, используемая для этой операции.

Ответы

Name Type Description
200 OK

Успешно. Ответ описывает список личных доменов шлюза Spring Cloud.

Other Status Codes

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

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

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 олицетворения учетной записи пользователя

Примеры

GatewayCustomDomains_List

Sample Request

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/gateways/default/domains?api-version=2022-09-01-preview

Sample Response

{
  "value": [
    {
      "properties": {
        "thumbprint": "*"
      },
      "systemData": {
        "createdBy": "sample-user",
        "createdByType": "User",
        "createdAt": "2021-08-11T03:16:03.944Z",
        "lastModifiedBy": "sample-user",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2021-08-11T03:17:03.944Z"
      },
      "type": "Microsoft.AppPlatform/Spring/gateways/domains",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/gateways/default/domains/myDomain",
      "name": "myDomain"
    }
  ]
}

Определения

CloudError

Ответ об ошибке службы.

CloudErrorBody

Ответ об ошибке службы.

createdByType

Тип удостоверения, создавшего ресурс.

GatewayCustomDomainProperties

Свойства личного домена для шлюза Spring Cloud

GatewayCustomDomainResource

Личный домен шлюза Spring Cloud

GatewayCustomDomainResourceCollection

Объект, включающий массив ресурсов личного домена шлюза Spring Cloud и возможную ссылку для следующего набора

lastModifiedByType

Тип удостоверения, который последний раз изменил ресурс.

SystemData

Метаданные, относящиеся к созданию и последнему модификации ресурса.

CloudError

Ответ об ошибке службы.

Name Type Description
error

Ответ об ошибке службы.

CloudErrorBody

Ответ об ошибке службы.

Name Type Description
code
  • string

Идентификатор ошибки. Коды инвариантны и предназначены для программного использования.

details

Список дополнительных сведений об ошибке.

message
  • string

Сообщение, описывающее ошибку, предназначенное для отображения в пользовательском интерфейсе.

target
  • string

Целевой объект конкретной ошибки. Например, имя свойства в ошибке.

createdByType

Тип удостоверения, создавшего ресурс.

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

GatewayCustomDomainProperties

Свойства личного домена для шлюза Spring Cloud

Name Type Description
thumbprint
  • string

Отпечаток привязанного сертификата.

GatewayCustomDomainResource

Личный домен шлюза Spring Cloud

Name Type Description
id
  • string

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

name
  • string

Имя ресурса.

properties

Свойства личного домена для шлюза Spring Cloud

systemData

Метаданные, относящиеся к созданию и последнему модификации ресурса.

type
  • string

Тип ресурса.

GatewayCustomDomainResourceCollection

Объект, включающий массив ресурсов личного домена шлюза Spring Cloud и возможную ссылку для следующего набора

Name Type Description
nextLink
  • string

КЛИЕНТ URL-адреса должен использовать для получения следующей страницы (на страницы на стороне сервера). Сейчас он имеет значение NULL, добавленный для использования в будущем.

value

Коллекция ресурсов личного домена шлюза Spring Cloud

lastModifiedByType

Тип удостоверения, который последний раз изменил ресурс.

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

SystemData

Метаданные, относящиеся к созданию и последнему модификации ресурса.

Name Type Description
createdAt
  • string

Метка времени создания ресурса (UTC).

createdBy
  • string

Удостоверение, создающее ресурс.

createdByType

Тип удостоверения, создавшего ресурс.

lastModifiedAt
  • string

Метка времени изменения ресурса (UTC).

lastModifiedBy
  • string

Удостоверение, которое последнее изменение ресурса.

lastModifiedByType

Тип удостоверения, который последний раз изменил ресурс.