Api Management Service - Restore

  • Ссылка
Service:
API Management
API Version:
2022-08-01

Восстанавливает резервную копию службы Управление API, созданной с помощью операции ApiManagementService_Backup в текущей службе. Это длительная операция, и ее выполнение может занять несколько минут.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/restore?api-version=2022-08-01

Параметры URI

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

string

Имя группы ресурсов. Регистр букв в имени не учитывается.
serviceName
 path True

string

Имя службы Управление API.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId
 path True

string

Идентификатор целевой подписки.
api-version
 query True

string

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

Текст запроса

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

string

Имя создаваемого или извлекаемого файла резервной копии.
containerName True

string

Имя контейнера BLOB-объектов (используется для размещения или извлечения резервной копии).
storageAccount True

string

Имя учетной записи хранения Azure (используется для размещения или извлечения резервной копии).
accessKey

string

ключ доступа к учетной записи хранения; Требуется, только если accessType для задано значение AccessKey.
accessType

AccessType

Тип доступа, используемый для учетной записи хранения.
clientId

string

Идентификатор клиента управляемого удостоверения, назначаемого пользователем. Требуется, только если accessType для задано значение UserAssignedManagedIdentity.

Ответы

Имя Тип Описание
200 OK

ApiManagementServiceResource

Резервная копия успешно восстановлена в службе Управление API.
202 Accepted

Принято: заголовок расположения содержит URL-адрес, по которому можно проверить состояние длительной операции.

Headers

location: string
Other Status Codes

ErrorResponse

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

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

azure_auth

Поток OAuth2 в Azure Active Directory.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

Примеры

ApiManagementRestoreService

Sample Request

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/restore?api-version=2022-08-01

{
  "storageAccount": "teststorageaccount",
  "containerName": "backupContainer",
  "backupName": "apimService1backup_2017_03_19",
  "accessType": "AccessKey",
  "accessKey": "**************************************************"
}

Sample Response

Status code:
202 
location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2022-08-01
Status code:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "tag1": "value1",
    "tag2": "value2",
    "tag3": "value3"
  },
  "location": "West US",
  "etag": "AAAAAAACXok=",
  "properties": {
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2019-12-18T06:26:20.3348609Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "gatewayRegionalUrl": "https://apimService1-westus-01.regional.azure-api.net",
    "portalUrl": "https://apimService1.portal.azure-api.net",
    "developerPortalUrl": "https://apimService1.developer.azure-api.net",
    "managementApiUrl": "https://apimService1.management.azure-api.net",
    "scmUrl": "https://apimService1.scm.azure-api.net",
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "hostName": "apimService1.azure-api.net",
        "negotiateClientCertificate": false,
        "defaultSslBinding": false
      },
      {
        "type": "Proxy",
        "hostName": "gateway1.msitesting.net",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2036-01-01T07:00:00+00:00",
          "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": true
      },
      {
        "type": "Management",
        "hostName": "mgmt.msitesting.net",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2036-01-01T07:00:00+00:00",
          "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": false
      },
      {
        "type": "Portal",
        "hostName": "portal1.msitesting.net",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2036-01-01T07:00:00+00:00",
          "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": false
      }
    ],
    "publicIPAddresses": [
      "13.91.32.113"
    ],
    "additionalLocations": [
      {
        "location": "East US",
        "sku": {
          "name": "Premium",
          "capacity": 1
        },
        "publicIPAddresses": [
          "23.101.138.153"
        ],
        "gatewayRegionalUrl": "https://apimService1-eastus-01.regional.azure-api.net",
        "disableGateway": true
      }
    ],
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False"
    },
    "virtualNetworkType": "None",
    "disableGateway": false,
    "apiVersionConstraint": {
      "minApiVersion": "2019-01-01"
    }
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  }
}

Определения

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

Тип доступа, используемый для учетной записи хранения.
AdditionalLocation

Описание дополнительного расположения ресурса Управление API.
ApiManagementServiceBackupRestoreParameters

Параметры, предоставляемые операции резервного копирования и восстановления службы Управление API.
ApiManagementServiceIdentity

Свойства удостоверения ресурса службы "Управление API".
ApiManagementServiceResource

Один ресурс службы Управление API в списке или получении ответа.
ApiManagementServiceSkuProperties

Управление API свойства SKU ресурса службы.
ApimIdentityType

Тип удостоверения, используемого для ресурса. Тип SystemAssigned, UserAssigned включает как условно созданное удостоверение, так и набор удостоверений, назначенных пользователем. Тип None удалит все удостоверения из службы.
ApiVersionConstraint

Ограничение версии API уровня управления для службы Управление API.
ArmIdWrapper

Оболочка для идентификатора ресурса ARM
CertificateConfiguration

Конфигурация сертификата, состоящая из ненадежных промежуточных и корневых сертификатов.
CertificateInformation

Сведения о SSL-сертификате.
CertificateSource

Источник сертификата.
CertificateStatus

Состояние сертификата.
createdByType

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

Контракт поля ошибки.
ErrorResponse

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

Настраиваемая конфигурация имени узла.
HostnameType

Тип имени узла.
NatGatewayState

Свойство можно использовать для включения шлюза NAT для этой службы Управление API.
PlatformVersion

Версия вычислительной платформы, на котором выполняется служба.
PrivateEndpointServiceConnectionStatus

Состояние подключения к частной конечной точке.
PrivateLinkServiceConnectionState

Коллекция сведений о состоянии соединения между потребителем службы и поставщиком.
PublicNetworkAccess

Разрешен ли доступ к общедоступной конечной точке для этой Управление API службы. Значение является необязательным, но при передаче должно быть "Включено" или "Отключено". Если значение "Отключено", частные конечные точки являются монопольным методом доступа. Значение по умолчанию — "Включено".
RemotePrivateEndpointConnectionWrapper

Ресурс подключения к удаленной частной конечной точке.
SkuType

Имя номера SKU.
systemData

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

Настройка виртуальной сети, в которой развернута служба Управление API.
VirtualNetworkType

Тип VPN, в котором необходимо настроить службу Управление API. None (значение по умолчанию) означает, что служба Управление API не является частью какого-либо виртуальная сеть, external означает, что развертывание Управление API настроено внутри виртуальная сеть с конечной точкой с выходом в Интернет, а внутреннее означает, что Управление API развертывание настраивается внутри виртуальная сеть только с конечной точкой, обращенной к интрасети.

AccessType

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

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

string

Используйте ключ доступа.
SystemAssignedManagedIdentity

string

Используйте управляемое удостоверение, назначаемое системой.
UserAssignedManagedIdentity

string

Используйте управляемое удостоверение, назначаемое пользователем.

AdditionalLocation

Описание дополнительного расположения ресурса Управление API.

Имя Тип Значение по умолчанию Описание
disableGateway

boolean

False

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

string

URL-адрес шлюза службы Управление API в регионе.
location

string

Имя расположения дополнительного региона между регионами центра обработки данных Azure.
natGatewayState

NatGatewayState

Disabled

Свойство можно использовать для включения шлюза NAT для этой службы Управление API.
outboundPublicIPAddresses

string[]

Префиксы исходящих общедоступных IPV4-адресов, связанные с развернутой службой шлюза NAT. Доступно только для SKU "Премиум" на платформе stv2.
platformVersion

PlatformVersion

Версия вычислительной платформы, на котором выполняется служба.
privateIPAddresses

string[]

Частные статические IP-адреса службы Управление API, развернутой во внутренней виртуальная сеть в определенном дополнительном расположении. Доступно только для SKU "Базовый", "Стандартный", "Премиум" и "Изолированный".
publicIPAddresses

string[]

Общедоступные статические IP-адреса с балансировкой нагрузки службы Управление API в дополнительном расположении. Доступно только для SKU "Базовый", "Стандартный", "Премиум" и "Изолированный".
publicIpAddressId

string

IP-адрес на основе общедоступного номера SKU категории "Стандартный" версии 4, который необходимо связать с виртуальная сеть развернутой службой в расположении. Поддерживается только для номера SKU уровня "Премиум", развертываемого в виртуальная сеть.
sku

ApiManagementServiceSkuProperties

Свойства SKU службы Управление API.
virtualNetworkConfiguration

VirtualNetworkConfiguration

Конфигурация виртуальной сети для расположения.
zones

string[]

Список зон доступности, обозначающих, откуда должен поступать ресурс.

ApiManagementServiceBackupRestoreParameters

Параметры, предоставляемые операции резервного копирования и восстановления службы Управление API.

Имя Тип Значение по умолчанию Описание
accessKey

string

ключ доступа к учетной записи хранения; Требуется, только если accessType задано значение AccessKey.
accessType

AccessType

AccessKey

Тип доступа, используемый для учетной записи хранения.
backupName

string

Имя создаваемого или извлекаемого файла резервной копии.
clientId

string

Идентификатор клиента управляемого удостоверения, назначаемого пользователем. Требуется, только если accessType задано значение UserAssignedManagedIdentity.
containerName

string

Имя контейнера больших двоичных объектов (используется для размещения или извлечения резервной копии).
storageAccount

string

Имя учетной записи хранения Azure (используется для размещения или извлечения резервной копии).

ApiManagementServiceIdentity

Свойства удостоверения ресурса службы "Управление API".

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

string

Идентификатор субъекта удостоверения.
tenantId

string

Идентификатор клиента удостоверения.
type

ApimIdentityType

Тип удостоверения, используемого для ресурса. Тип SystemAssigned, UserAssigned включает как условно созданное удостоверение, так и набор удостоверений, назначенных пользователем. Тип None удалит все удостоверения из службы.
userAssignedIdentities

<string,  UserIdentityProperties>

Список удостоверений пользователей, связанных с ресурсом. Ссылки на ключи словаря удостоверений пользователей будут иметь идентификаторы ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

ApiManagementServiceResource

Один ресурс службы Управление API в списке или получении ответа.

Имя Тип Значение по умолчанию Описание
etag

string

ETag ресурса.
id

string

Идентификатор ресурса.
identity

ApiManagementServiceIdentity

Управляемое удостоверение службы управления API.
location

string

Расположение ресурса.
name

string

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

AdditionalLocation[]

Дополнительные расположения центра обработки данных службы Управление API.
properties.apiVersionConstraint

ApiVersionConstraint

Ограничение версии API уровня управления для службы Управление API.
properties.certificates

CertificateConfiguration[]

Список сертификатов, которые необходимо установить в службе Управление API. Максимальное число поддерживаемых сертификатов, которые можно установить, равно 10.
properties.createdAtUtc

string

Дата создания службы Управление API в формате UTC. Дата соответствует следующему формату: yyyy-MM-ddTHH:mm:ssZ в соответствии со стандартом ISO 8601.
properties.customProperties

object

Пользовательские свойства службы Управление API.
Параметр Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 отключит TLS_RSA_WITH_3DES_EDE_CBC_SHA шифра для всех протоколов TLS(1.0, 1.1 и 1.2).
Параметр Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 можно использовать для отключения только TLS 1.1.
Параметр Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 можно использовать для отключения TLS 1.0 в службе Управление API.
Параметр Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 можно использовать, чтобы отключить только TLS 1.1 для связи с внутренними серверами.
Параметр Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 можно использовать для отключения ПРОТОКОЛА TLS 1.0 для обмена данными с внутренними серверами.
Параметр Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 можно использовать для включения протокола HTTP2 в службе Управление API.
Если не указать ни одно из этих свойств в операции PATCH, значения опущенных свойств будут сброшены до значений по умолчанию. Для всех параметров, кроме Http2, значением по умолчанию является True , если служба была создана 1 апреля 2018 года или раньше, и False в противном случае. Значение по умолчанию параметра Http2 — False.

Вы можете отключить любой из следующих шифров с помощью параметров Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256 TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA TLS_RSA_WITH_AES_128_CBC_SHA. Например, Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256:false. Значение по умолчанию — true для них.
Примечание. Следующие шифры нельзя отключить, так как они требуются для внутренних компонентов платформы: TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
properties.developerPortalUrl

string

URL-адрес конечной точки портала DEveloper службы Управление API.
properties.disableGateway

boolean

False

Свойство допустимо только для службы управления API, развернутой в нескольких расположениях. Это можно использовать для отключения шлюза в master регионе.
properties.enableClientCertificate

boolean

False

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

string

URL-адрес шлюза службы Управление API в регионе по умолчанию.
properties.gatewayUrl

string

URL-адрес шлюза службы Управление API.
properties.hostnameConfigurations

HostnameConfiguration[]

Настраиваемая конфигурация имени узла службы Управление API.
properties.managementApiUrl

string

URL-адрес конечной точки API управления службы Управление API.
properties.natGatewayState

NatGatewayState

Disabled

Свойство можно использовать для включения шлюза NAT для этой службы Управление API.
properties.notificationSenderEmail

string

Email адрес, с которого будет отправлено уведомление.
properties.outboundPublicIPAddresses

string[]

Префиксы исходящих общедоступных IPV4-адресов, связанные с развернутой службой шлюза NAT. Доступно только для SKU "Премиум" на платформе stv2.
properties.platformVersion

PlatformVersion

Версия вычислительной платформы, запустив службу в этом расположении.
properties.portalUrl

string

Url-адрес конечной точки портала издателя службы Управление API.
properties.privateEndpointConnections

RemotePrivateEndpointConnectionWrapper[]

Список подключений к частной конечной точке этой службы.
properties.privateIPAddresses

string[]

Частные статические IP-адреса службы Управление API в основном регионе, развернутые во внутренней виртуальная сеть. Доступно только для SKU "Базовый", "Стандартный", "Премиум" и "Изолированный".
properties.provisioningState

string

Текущее состояние подготовки службы Управление API, которое может быть одним из следующих: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.
properties.publicIPAddresses

string[]

Общедоступные статические IP-адреса службы Управление API в основном регионе. Доступно только для SKU "Базовый", "Стандартный", "Премиум" и "Изолированный".
properties.publicIpAddressId

string

IP-адрес на основе общедоступного номера SKU SKU V4, связанный с виртуальная сеть развернутой службой в регионе. Поддерживается только для SKU "Разработчик" и "Премиум", развертываемых в виртуальная сеть.
properties.publicNetworkAccess

PublicNetworkAccess

Разрешен ли доступ к общедоступной конечной точке для этой Управление API службы. Значение является необязательным, но при передаче должно быть "Включено" или "Отключено". Если значение "Отключено", частные конечные точки являются монопольным методом доступа. Значение по умолчанию — "Включено".
properties.publisherEmail

string

Электронная почта издателя.
properties.publisherName

string

Имя издателя.
properties.restore

boolean

False

Отмените удаление службы управления API, если она ранее была обратимо удалена. Если этот флаг указан и имеет значение True, все остальные свойства будут игнорироваться.
properties.scmUrl

string

URL-адрес конечной точки SCM службы Управление API.
properties.targetProvisioningState

string

Состояние подготовки службы Управление API, на которую нацелена длительная операция, запущенная в службе.
properties.virtualNetworkConfiguration

VirtualNetworkConfiguration

Конфигурация виртуальной сети службы Управление API.
properties.virtualNetworkType

VirtualNetworkType

None

Тип VPN, в котором необходимо настроить службу Управление API. None (значение по умолчанию) означает, что служба Управление API не является частью какого-либо виртуальная сеть, external означает, что развертывание Управление API настроено внутри виртуальная сеть с конечной точкой с выходом в Интернет, а внутреннее означает, что Управление API развертывание настраивается внутри виртуальная сеть только с конечной точкой, обращенной к интрасети.
sku

ApiManagementServiceSkuProperties

Свойства SKU службы Управление API.
systemData

systemData

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

object

Теги ресурсов.
type

string

Для Управление API ресурса задано значение Microsoft.ApiManagement.
zones

string[]

Список зон доступности, обозначающих, откуда должен поступать ресурс.

ApiManagementServiceSkuProperties

Управление API свойства SKU ресурса службы.

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

integer

Емкость номера SKU (количество развернутых единиц SKU). Для параметра Потребление емкость SKU должна быть указана как 0.
name

SkuType

Имя номера SKU.

ApimIdentityType

Тип удостоверения, используемого для ресурса. Тип SystemAssigned, UserAssigned включает как условно созданное удостоверение, так и набор удостоверений, назначенных пользователем. Тип None удалит все удостоверения из службы.

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

string

SystemAssigned

string

SystemAssigned, UserAssigned

string

UserAssigned

string

ApiVersionConstraint

Ограничение версии API уровня управления для службы Управление API.

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

string

Ограничьте вызовы API уровня управления для Управление API службы с версией, равной или более поздней, чем это значение.

ArmIdWrapper

Оболочка для идентификатора ресурса ARM

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

string

CertificateConfiguration

Конфигурация сертификата, состоящая из ненадежных промежуточных и корневых сертификатов.

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

CertificateInformation

Сведения о сертификате.
certificatePassword

string

Пароль сертификата.
encodedCertificate

string

Сертификат в кодировке Base64.
storeName enum:
  • CertificateAuthority
  • Root

Расположение хранилища сертификатов System.Security.Cryptography.x509certificates.StoreName. Допустимы только корневой каталог и certificateAuthority.

CertificateInformation

Сведения о SSL-сертификате.

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

string

Дата окончания срока действия сертификата. Дата соответствует следующему формату: yyyy-MM-ddTHH:mm:ssZ в соответствии со стандартом ISO 8601.
subject

string

Субъект сертификата.
thumbprint

string

Отпечаток сертификата.

CertificateSource

Источник сертификата.

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

string

Custom

string

KeyVault

string

Managed

string

CertificateStatus

Состояние сертификата.

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

string

Failed

string

InProgress

string

createdByType

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

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

string

Key

string

ManagedIdentity

string

User

string

ErrorFieldContract

Контракт поля ошибки.

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

string

Код ошибки уровня свойства.
message

string

Понятное представление ошибки на уровне свойств.
target

string

Имя свойства.

ErrorResponse

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

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

string

Код ошибки, определяемый службой. Это код служит в качестве подсостояния для кода ошибки HTTP, указанного в ответе.
error.details

ErrorFieldContract[]

Список недопустимых полей, отправляемых в запросе, в случае ошибки проверки.
error.message

string

Читаемое представление ошибки.

HostnameConfiguration

Настраиваемая конфигурация имени узла.

Имя Тип Значение по умолчанию Описание
certificate

CertificateInformation

Сведения о сертификате.
certificatePassword

string

Пароль сертификата.
certificateSource

CertificateSource

Источник сертификата.
certificateStatus

CertificateStatus

Состояние сертификата.
defaultSslBinding

boolean

False

Укажите значение true, чтобы настроить сертификат, связанный с этим именем узла, в качестве SSL-сертификата по умолчанию. Если клиент не отправляет заголовок SNI, это будет сертификат, который будет оспорен. Свойство полезно, если в службе включено несколько пользовательских имен узлов и ей необходимо выбрать SSL-сертификат по умолчанию. Параметр применяется только к типу имени узла шлюза.
encodedCertificate

string

Сертификат в кодировке Base64.
hostName

string

Имя узла, настраиваемое в службе "Управление API".
identityClientId

string

Системное или назначаемое пользователем управляемое удостоверение clientId, созданное Azure AD, которое имеет доступ GET к хранилищу ключей, содержащим SSL-сертификат.
keyVaultId

string

URL-адрес секрета KeyVault, содержащего SSL-сертификат. Если указан абсолютный URL-адрес, содержащий версию, автоматическое обновление SSL-сертификата не будет работать. Для этого требуется, чтобы служба управления API была настроена с aka.ms/apimmsi. Секрет должен иметь тип application/x-pkcs12
negotiateClientCertificate

boolean

False

Укажите значение true, чтобы всегда согласовывать сертификат клиента по имени узла. Значение по умолчанию — false.
type

HostnameType

Тип имени узла.

HostnameType

Тип имени узла.

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

string

Management

string

Portal

string

Proxy

string

Scm

string

NatGatewayState

Свойство можно использовать для включения шлюза NAT для этой службы Управление API.

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

string

Шлюз Nat отключен для службы.
Enabled

string

Шлюз NAT включен для службы.

PlatformVersion

Версия вычислительной платформы, на котором выполняется служба.

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

string

Платформа, на котором выполняется служба на платформе с несколькими клиентами версии 1.
stv1

string

Платформа, на котором выполняется служба на платформе с одним клиентом версии 1.
stv2

string

Платформа, на котором выполняется служба на платформе с одним клиентом версии 2.
undetermined

string

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

PrivateEndpointServiceConnectionStatus

Состояние подключения к частной конечной точке.

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

string

Pending

string

Rejected

string

PrivateLinkServiceConnectionState

Коллекция сведений о состоянии соединения между потребителем службы и поставщиком.

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

string

Сообщение, указывающее, требуются ли изменения в поставщике услуг какие-либо обновления на потребителе.
description

string

Причина утверждения или отклонения подключения.
status

PrivateEndpointServiceConnectionStatus

Указывает, было ли подключение утверждено, отклонено или удалено владельцем службы.

PublicNetworkAccess

Разрешен ли доступ к общедоступной конечной точке для этой Управление API службы. Значение является необязательным, но при передаче должно быть "Включено" или "Отключено". Если значение "Отключено", частные конечные точки являются монопольным методом доступа. Значение по умолчанию — "Включено".

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

string

Enabled

string

RemotePrivateEndpointConnectionWrapper

Ресурс подключения к удаленной частной конечной точке.

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

string

Идентификатор ресурса подключения к частной конечной точке
name

string

Имя подключения к частной конечной точке
properties.groupIds

string[]

Все идентификаторы группы.
properties.privateEndpoint

ArmIdWrapper

Ресурс частной конечной точки.
properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Коллекция сведений о состоянии соединения между потребителем службы и поставщиком.
properties.provisioningState

string

Состояние подготовки ресурса подключения к частной конечной точке.
type

string

Тип ресурса подключения к частной конечной точке

SkuType

Имя номера SKU.

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

string

SKU "Базовый" службы "Управление API".
Consumption

string

SKU потребления службы "Управление API".
Developer

string

SKU разработчика службы "Управление API".
Isolated

string

Изолированный номер SKU службы "Управление API".
Premium

string

SKU уровня "Премиум" службы "Управление API".
Standard

string

Номер SKU "Стандартный" службы "Управление API".

systemData

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

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

string

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

string

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

createdByType

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

string

Метка времени последнего изменения ресурса (UTC)
lastModifiedBy

string

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

createdByType

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

UserIdentityProperties

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

string

Идентификатор клиента удостоверения, назначаемого пользователем.
principalId

string

Идентификатор субъекта удостоверения, назначаемого пользователем.

VirtualNetworkConfiguration

Настройка виртуальной сети, в которой развернута служба Управление API.

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

string

Полный идентификатор ресурса подсети в виртуальной сети для развертывания службы Управление API.
subnetname

string

Имя подсети.
vnetid

string

Идентификатор виртуальной сети. Обычно это GUID. По умолчанию ожидается нулевой GUID.

VirtualNetworkType

Тип VPN, в котором необходимо настроить службу Управление API. None (значение по умолчанию) означает, что служба Управление API не является частью какого-либо виртуальная сеть, external означает, что развертывание Управление API настроено внутри виртуальная сеть с конечной точкой с выходом в Интернет, а внутреннее означает, что Управление API развертывание настраивается внутри виртуальная сеть только с конечной точкой, обращенной к интрасети.

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

string

Служба является частью виртуальная сеть и доступна из Интернета.
Internal

string

Служба является частью виртуальная сеть и доступна только из виртуальной сети.
None

string

Служба не является частью каких-либо виртуальная сеть.