Api Management Service - Update

Ссылка

Служба:: API Management

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

Обновляет существующую службу управления API.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}?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, используемая для этой операции.

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

Имя	Тип	Описание
identity	ApiManagementServiceIdentity	Управляемое удостоверение службы управления API.
properties.additionalLocations	AdditionalLocation[]	Дополнительные расположения центров обработки данных службы управления API.
properties.apiVersionConstraint	ApiVersionConstraint	Ограничение версии API уровня управления для службы управления API.
properties.certificates	CertificateConfiguration[]	Список сертификатов, которые необходимо установить в службе управления API. Максимальное число поддерживаемых сертификатов, которые можно установить, равно 10.
properties.configurationApi	ConfigurationApi	Конфигурация API конфигурации службы управления API.
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.developerPortalStatus	developerPortalStatus	Состояние портала разработчика в этой службе управления API.
properties.disableGateway	boolean	Свойство допустимо только для службы управления API, развернутой в нескольких расположениях. Это можно использовать для отключения шлюза в главном регионе.
properties.enableClientCertificate	boolean	Свойство предназначено только для службы SKU потребления. При этом сертификат клиента должен быть представлен по каждому запросу шлюза. Это также позволяет пройти проверку подлинности сертификата в политике шлюза.
properties.hostnameConfigurations	HostnameConfiguration[]	Настраиваемая конфигурация имени узла службы управления API.
properties.legacyPortalStatus	LegacyPortalStatus	Состояние устаревшего портала в службе управления API.
properties.natGatewayState	NatGatewayState	Свойство можно использовать для включения шлюза NAT для этой службы управления API.
properties.notificationSenderEmail	string maxLength: 100	Адрес электронной почты, с которого будет отправлено уведомление.
properties.privateEndpointConnections	RemotePrivateEndpointConnectionWrapper[]	Список подключений к частной конечной точке этой службы.
properties.publicIpAddressId	string	Общедоступный IP-адрес SKU SKU уровня "Стандартный" версии 4, связанный с развернутой службой виртуальной сети в регионе. Поддерживается только для развертывания SKU разработчика и класса Premium в виртуальной сети.
properties.publicNetworkAccess	PublicNetworkAccess	Допускается ли доступ к общедоступной конечной точке для этой службы управления API. Значение является необязательным, но при передаче должно быть "Включено" или "Отключено". Если значение "Отключено", частные конечные точки являются эксклюзивным методом доступа. Значение по умолчанию — "Включено"
properties.publisherEmail	string maxLength: 100	Электронная почта издателя.
properties.publisherName	string maxLength: 100	Имя издателя.
properties.restore	boolean	Отмена удаления службы управления API, если она была удалена ранее обратимо. Если этот флаг указан и задано значение True, все остальные свойства будут игнорироваться.
properties.virtualNetworkConfiguration	VirtualNetworkConfiguration	Конфигурация виртуальной сети службы управления API.
properties.virtualNetworkType	VirtualNetworkType	Тип VPN, в котором необходимо настроить службу управления API. Нет (значение по умолчанию) означает, что служба управления API не является частью какой-либо виртуальной сети, внешняя означает, что развертывание управления API настраивается внутри виртуальной сети с конечной точкой виртуальной сети, имеющей только конечную точку с доступом к Интернету, и внутреннее означает, что развертывание управления API настраивается в виртуальной сети только с конечной точкой управления интрасетью.
sku	ApiManagementServiceSkuProperties	Свойства SKU службы управления API.
tags	object	Теги ресурсов.
zones	string[]	Список зон доступности, обозначающих, откуда должен поступать ресурс.

Ответы

Имя	Тип	Описание
200 OK	ApiManagementServiceResource	Служба была успешно обновлена.
202 Accepted		Запрос на обновление службы был принят. Заголовки location: string
Other Status Codes	ErrorResponse	Ответ на ошибку, описывающий причину сбоя операции.

Имя

Тип

Описание

200 OK

ApiManagementServiceResource

Служба была успешно обновлена.

202 Accepted

Запрос на обновление службы был принят.

Заголовки

location: string

Other Status Codes

ErrorResponse

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

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

azure_auth

Поток OAuth2 Azure Active Directory.

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

Области

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

Примеры

ApiManagementUpdateServiceDisableTls10

ApiManagementUpdateServicePublisherDetails

ApiManagementUpdateServiceToNewVnetAndAvailabilityZones

ApiManagementUpdateServiceDisableTls10

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

HTTP

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

{
  "properties": {
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "false"
    }
  }
}

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

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

Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-05-01&asyncResponse
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-05-01&asyncResponse

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

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "Owner": "sasolank",
    "UID": "4f5025fe-0669-4e2e-8320-5199466e5eb3",
    "Reserved": "",
    "TestExpiration": "Thu, 29 Jun 2017 18:50:40 GMT",
    "Pool": "Manual",
    "TestSuiteExpiration": "Thu, 29 Jun 2017 18:51:46 GMT"
  },
  "location": "West US",
  "etag": "AAAAAAAYRPs=",
  "properties": {
    "publisherEmail": "admin@live.com",
    "publisherName": "Contoso",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2017-06-29T17:50:42.3191122Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "portalUrl": "https://apimService1.portal.azure-api.net",
    "managementApiUrl": "https://apimService1.management.azure-api.net",
    "scmUrl": "https://apimService1.scm.azure-api.net",
    "hostnameConfigurations": [],
    "publicIPAddresses": [
      "40.86.176.232"
    ],
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False"
    },
    "virtualNetworkType": "None"
  },
  "sku": {
    "name": "Standard",
    "capacity": 1
  }
}

ApiManagementUpdateServicePublisherDetails

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

HTTP

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

{
  "properties": {
    "publisherEmail": "foobar@live.com",
    "publisherName": "Contoso Vnext"
  }
}

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

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

Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-05-01&asyncResponse
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-05-01&asyncResponse

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

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "Owner": "sasolank",
    "UID": "4f5025fe-0669-4e2e-8320-5199466e5eb3",
    "Reserved": "",
    "TestExpiration": "Thu, 29 Jun 2017 18:50:40 GMT",
    "Pool": "Manual",
    "TestSuiteExpiration": "Thu, 29 Jun 2017 18:51:46 GMT"
  },
  "location": "West US",
  "etag": "AAAAAAAYRPs=",
  "properties": {
    "publisherEmail": "foobar@live.com",
    "publisherName": "Contoso Vnext",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2017-06-29T17:50:42.3191122Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "portalUrl": "https://apimService1.portal.azure-api.net",
    "managementApiUrl": "https://apimService1.management.azure-api.net",
    "scmUrl": "https://apimService1.scm.azure-api.net",
    "hostnameConfigurations": [],
    "publicIPAddresses": [
      "40.86.176.232"
    ],
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False"
    },
    "virtualNetworkType": "None"
  },
  "sku": {
    "name": "Standard",
    "capacity": 1
  }
}

ApiManagementUpdateServiceToNewVnetAndAvailabilityZones

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

HTTP

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

{
  "properties": {
    "additionalLocations": [
      {
        "location": "Australia East",
        "sku": {
          "name": "Premium",
          "capacity": 3
        },
        "zones": [
          "1",
          "2",
          "3"
        ],
        "virtualNetworkConfiguration": {
          "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/apimaeavnet/subnets/default"
        },
        "publicIpAddressId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/apim-australia-east-publicip"
      }
    ],
    "virtualNetworkConfiguration": {
      "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet-apim-japaneast/subnets/apim2"
    },
    "virtualNetworkType": "External",
    "publicIpAddressId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/publicip-apim-japan-east"
  },
  "sku": {
    "name": "Premium",
    "capacity": 3
  },
  "zones": [
    "1",
    "2",
    "3"
  ]
}

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

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

Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-05-01&asyncResponse
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-05-01&asyncResponse

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

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "location": "Japan East",
  "etag": "AAAAAAAWBIU=",
  "properties": {
    "publisherEmail": "contoso@microsoft.com",
    "publisherName": "apimPublisher",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2021-04-08T23:41:35.6447381Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "gatewayRegionalUrl": "https://apimService1-japaneast-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,
        "certificateSource": "BuiltIn"
      },
      {
        "type": "Proxy",
        "hostName": "mycustomdomain.int-azure-api.net",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2022-06-09T23:59:59+00:00",
          "thumbprint": "2994B5FFB8F76B3C687D324A8DEE0432C1ED18CD",
          "subject": "CN=mycustomdomain.int-azure-api.net"
        },
        "defaultSslBinding": true,
        "certificateSource": "Managed"
      }
    ],
    "publicIPAddresses": [
      "20.78.248.217"
    ],
    "additionalLocations": [
      {
        "location": "Australia East",
        "sku": {
          "name": "Premium",
          "capacity": 3
        },
        "zones": [
          "1",
          "2",
          "3"
        ],
        "publicIPAddresses": [
          "20.213.1.35"
        ],
        "virtualNetworkConfiguration": {
          "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/apimaeavnet/subnets/default"
        },
        "gatewayRegionalUrl": "https://apimService1-australiaeast-01.regional.azure-api.net",
        "disableGateway": false,
        "publicIpAddressId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/apim-australia-east-publicip",
        "platformVersion": "stv2"
      }
    ],
    "virtualNetworkConfiguration": {
      "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet-apim-japaneast/subnets/apim2"
    },
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_GCM_SHA256": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_256_CBC_SHA256": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_256_CBC_SHA": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "false",
      "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.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": "Internal",
    "disableGateway": false,
    "publicIpAddressId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/publicip-apim-japan-east",
    "publicNetworkAccess": "Enabled",
    "platformVersion": "stv2"
  },
  "sku": {
    "name": "Premium",
    "capacity": 3
  },
  "zones": [
    "1",
    "2",
    "3"
  ],
  "systemData": {
    "lastModifiedBy": "contoso@microsoft.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2022-01-21T20:04:21.6108974Z"
  }
}

Определения

Имя	Описание
AdditionalLocation	Описание дополнительного расположения ресурса управления API.
ApiManagementServiceIdentity	Свойства удостоверения ресурса службы управления API.
ApiManagementServiceResource	Один ресурс службы управления API в списке или получении ответа.
ApiManagementServiceSkuProperties	Свойства SKU ресурса службы управления API.
ApiManagementServiceUpdateParameters	Параметр, предоставленный для службы управления API.
ApimIdentityType	Тип удостоверения, используемого для ресурса. Тип SystemAssigned, UserAssigned включает как неявное созданное удостоверение, так и набор назначенных пользователем удостоверений. Тип "Нет" удаляет все удостоверения из службы.
ApiVersionConstraint	Ограничение версии API уровня управления для службы управления API.
ArmIdWrapper	Оболочка для идентификатора ресурса ARM
CertificateConfiguration	Конфигурация сертификата, состоящая из ненадежных промежуточных и корневых сертификатов.
CertificateInformation	Сведения о SSL-сертификате.
CertificateSource	Источник сертификата.
CertificateStatus	Состояние сертификата.
ConfigurationApi	Сведения об API конфигурации службы управления API.
createdByType	Тип удостоверения, создавшего ресурс.
developerPortalStatus	Состояние портала разработчика в этой службе управления API.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
HostnameConfiguration	Настраиваемая конфигурация имени узла.
HostnameType	Тип имени узла.
LegacyApiState	Указывает, следует ли предоставлять устаревший API конфигурации (версии 1) в службе управления API. Значение является необязательным, но должно быть "Включено" или "Отключено". Если параметр "Отключен", устаревший API конфигурации (версия 1) не будет доступен для локальных шлюзов. Значение по умолчанию — "Включено"
LegacyPortalStatus	Состояние устаревшего портала в службе управления API.
NatGatewayState	Свойство можно использовать для включения шлюза NAT для этой службы управления API.
PlatformVersion	Версия вычислительной платформы, выполняющая службу.
PrivateEndpointServiceConnectionStatus	Состояние подключения к частной конечной точке.
PrivateLinkServiceConnectionState	Коллекция сведений о состоянии подключения между потребителем службы и поставщиком.
PublicNetworkAccess	Допускается ли доступ к общедоступной конечной точке для этой службы управления API. Значение является необязательным, но при передаче должно быть "Включено" или "Отключено". Если значение "Отключено", частные конечные точки являются эксклюзивным методом доступа. Значение по умолчанию — "Включено"
RemotePrivateEndpointConnectionWrapper	Ресурс подключения к удаленной частной конечной точке.
SkuType	Имя SKU.
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.
UserIdentityProperties
VirtualNetworkConfiguration	Настройка виртуальной сети, в которой развернута служба управления API.
VirtualNetworkType	Тип VPN, в котором необходимо настроить службу управления API. Нет (значение по умолчанию) означает, что служба управления API не является частью какой-либо виртуальной сети, внешняя означает, что развертывание управления API настраивается внутри виртуальной сети с конечной точкой виртуальной сети, имеющей только конечную точку с доступом к Интернету, и внутреннее означает, что развертывание управления API настраивается в виртуальной сети только с конечной точкой управления интрасетью.

AdditionalLocation

Object

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

Имя	Тип	Default value	Описание
disableGateway	boolean	False	Свойство допустимо только для службы управления API, развернутой в нескольких расположениях. Это можно использовать для отключения шлюза в этом дополнительном расположении.
gatewayRegionalUrl	string		URL-адрес шлюза службы управления API в регионе.
location	string		Имя расположения дополнительного региона среди регионов Центра обработки данных Azure.
natGatewayState	NatGatewayState	Disabled	Свойство можно использовать для включения шлюза NAT для этой службы управления API.
outboundPublicIPAddresses	string[]		Префиксы исходящего общедоступного IPV4-адреса, связанные с развернутой службой шлюза NAT. Доступно только для SKU класса Premium на платформе stv2.
platformVersion	PlatformVersion		Версия вычислительной платформы, выполняющая службу.
privateIPAddresses	string[]		Частные статические IP-адреса службы управления API, развернутые во внутренней виртуальной сети в определенном дополнительном расположении. Доступно только для SKU уровня "Базовый", "Стандартный", "Премиум" и "Изолированный".
publicIPAddresses	string[]		Общедоступные статические IP-адреса службы управления API в дополнительном расположении. Доступно только для SKU уровня "Базовый", "Стандартный", "Премиум" и "Изолированный".
publicIpAddressId	string		Общедоступный IP-адрес SKU SKU уровня "Стандартный" версии 4, связанный с развернутой службой виртуальной сети в расположении. Поддерживается только для SKU класса Premium, развертываемого в виртуальной сети.
sku	ApiManagementServiceSkuProperties		Свойства SKU службы управления API.
virtualNetworkConfiguration	VirtualNetworkConfiguration		Конфигурация виртуальной сети для расположения.
zones	string[]		Список зон доступности, обозначающих, откуда должен поступать ресурс.

ApiManagementServiceIdentity

Object

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

Имя	Тип	Описание
principalId	string (uuid)	Идентификатор субъекта удостоверения.
tenantId	string (uuid)	Идентификатор клиента удостоверения.
type	ApimIdentityType	Тип удостоверения, используемого для ресурса. Тип SystemAssigned, UserAssigned включает как неявное созданное удостоверение, так и набор назначенных пользователем удостоверений. Тип "Нет" удаляет все удостоверения из службы.
userAssignedIdentities	<string, UserIdentityProperties>	Список удостоверений пользователей, связанных с ресурсом. Ссылки на ключ словаря удостоверений пользователя будут идентификаторами ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

ApiManagementServiceResource

Object

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

Имя	Тип	Default value	Описание
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.configurationApi	ConfigurationApi		Конфигурация API конфигурации службы управления API.
properties.createdAtUtc	string (date-time)		Дата создания службы управления 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.developerPortalStatus	developerPortalStatus	Enabled	Состояние портала разработчика в этой службе управления API.
properties.developerPortalUrl	string		URL-адрес конечной точки портала DEveloper службы управления API.
properties.disableGateway	boolean	False	Свойство допустимо только для службы управления API, развернутой в нескольких расположениях. Это можно использовать для отключения шлюза в главном регионе.
properties.enableClientCertificate	boolean	False	Свойство предназначено только для службы SKU потребления. При этом сертификат клиента должен быть представлен по каждому запросу шлюза. Это также позволяет пройти проверку подлинности сертификата в политике шлюза.
properties.gatewayRegionalUrl	string		URL-адрес шлюза службы управления API в регионе по умолчанию.
properties.gatewayUrl	string		URL-адрес шлюза службы управления API.
properties.hostnameConfigurations	HostnameConfiguration[]		Настраиваемая конфигурация имени узла службы управления API.
properties.legacyPortalStatus	LegacyPortalStatus	Enabled	Состояние устаревшего портала в службе управления API.
properties.managementApiUrl	string		URL-адрес конечной точки API управления службой управления API.
properties.natGatewayState	NatGatewayState	Disabled	Свойство можно использовать для включения шлюза NAT для этой службы управления API.
properties.notificationSenderEmail	string maxLength: 100		Адрес электронной почты, с которого будет отправлено уведомление.
properties.outboundPublicIPAddresses	string[]		Префиксы исходящего общедоступного IPV4-адреса, связанные с развернутой службой шлюза NAT. Доступно только для SKU класса Premium на платформе stv2.
properties.platformVersion	PlatformVersion		Версия вычислительной платформы, выполняющая службу в этом расположении.
properties.portalUrl	string		URL-адрес конечной точки портала издателя службы управления API.
properties.privateEndpointConnections	RemotePrivateEndpointConnectionWrapper[]		Список подключений к частной конечной точке этой службы.
properties.privateIPAddresses	string[]		Частные статические IP-адреса службы управления API в основном регионе, развернутом в внутренней виртуальной сети. Доступно только для SKU уровня "Базовый", "Стандартный", "Премиум" и "Изолированный".
properties.provisioningState	string		Текущее состояние подготовки службы управления API, которое может быть одним из следующих: Create/Активация/Успешное обновление/Сбой/Остановлено/Остановлено/Завершение/Завершение/Завершение/Удаление.
properties.publicIPAddresses	string[]		Общедоступные статические IP-адреса службы управления API в основном регионе. Доступно только для SKU уровня "Базовый", "Стандартный", "Премиум" и "Изолированный".
properties.publicIpAddressId	string		Общедоступный IP-адрес SKU SKU уровня "Стандартный" версии 4, связанный с развернутой службой виртуальной сети в регионе. Поддерживается только для развертывания SKU разработчика и класса Premium в виртуальной сети.
properties.publicNetworkAccess	PublicNetworkAccess		Допускается ли доступ к общедоступной конечной точке для этой службы управления API. Значение является необязательным, но при передаче должно быть "Включено" или "Отключено". Если значение "Отключено", частные конечные точки являются эксклюзивным методом доступа. Значение по умолчанию — "Включено"
properties.publisherEmail	string maxLength: 100		Электронная почта издателя.
properties.publisherName	string maxLength: 100		Имя издателя.
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. Нет (значение по умолчанию) означает, что служба управления API не является частью какой-либо виртуальной сети, внешняя означает, что развертывание управления API настраивается внутри виртуальной сети с конечной точкой виртуальной сети, имеющей только конечную точку с доступом к Интернету, и внутреннее означает, что развертывание управления API настраивается в виртуальной сети только с конечной точкой управления интрасетью.
sku	ApiManagementServiceSkuProperties		Свойства SKU службы управления API.
systemData	systemData		Метаданные, относящиеся к созданию и последнему изменении ресурса.
tags	object		Теги ресурсов.
type	string		Тип ресурса управления API имеет значение Microsoft.ApiManagement.
zones	string[]		Список зон доступности, обозначающих, откуда должен поступать ресурс.

ApiManagementServiceSkuProperties

Object

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

Имя	Тип	Описание
capacity	integer (int32)	Емкость номера SKU (количество развернутых единиц SKU). Для емкости SKU потребления необходимо указать значение 0.
name	SkuType	Имя SKU.

ApiManagementServiceUpdateParameters

Object

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

Имя	Тип	Default value	Описание
etag	string		ETag ресурса.
id	string		Идентификатор ресурса.
identity	ApiManagementServiceIdentity		Управляемое удостоверение службы управления API.
name	string		Имя ресурса.
properties.additionalLocations	AdditionalLocation[]		Дополнительные расположения центров обработки данных службы управления API.
properties.apiVersionConstraint	ApiVersionConstraint		Ограничение версии API уровня управления для службы управления API.
properties.certificates	CertificateConfiguration[]		Список сертификатов, которые необходимо установить в службе управления API. Максимальное число поддерживаемых сертификатов, которые можно установить, равно 10.
properties.configurationApi	ConfigurationApi		Конфигурация API конфигурации службы управления API.
properties.createdAtUtc	string (date-time)		Дата создания службы управления 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.developerPortalStatus	developerPortalStatus	Enabled	Состояние портала разработчика в этой службе управления API.
properties.developerPortalUrl	string		URL-адрес конечной точки портала DEveloper службы управления API.
properties.disableGateway	boolean	False	Свойство допустимо только для службы управления API, развернутой в нескольких расположениях. Это можно использовать для отключения шлюза в главном регионе.
properties.enableClientCertificate	boolean	False	Свойство предназначено только для службы SKU потребления. При этом сертификат клиента должен быть представлен по каждому запросу шлюза. Это также позволяет пройти проверку подлинности сертификата в политике шлюза.
properties.gatewayRegionalUrl	string		URL-адрес шлюза службы управления API в регионе по умолчанию.
properties.gatewayUrl	string		URL-адрес шлюза службы управления API.
properties.hostnameConfigurations	HostnameConfiguration[]		Настраиваемая конфигурация имени узла службы управления API.
properties.legacyPortalStatus	LegacyPortalStatus	Enabled	Состояние устаревшего портала в службе управления API.
properties.managementApiUrl	string		URL-адрес конечной точки API управления службой управления API.
properties.natGatewayState	NatGatewayState	Disabled	Свойство можно использовать для включения шлюза NAT для этой службы управления API.
properties.notificationSenderEmail	string maxLength: 100		Адрес электронной почты, с которого будет отправлено уведомление.
properties.outboundPublicIPAddresses	string[]		Префиксы исходящего общедоступного IPV4-адреса, связанные с развернутой службой шлюза NAT. Доступно только для SKU класса Premium на платформе stv2.
properties.platformVersion	PlatformVersion		Версия вычислительной платформы, выполняющая службу в этом расположении.
properties.portalUrl	string		URL-адрес конечной точки портала издателя службы управления API.
properties.privateEndpointConnections	RemotePrivateEndpointConnectionWrapper[]		Список подключений к частной конечной точке этой службы.
properties.privateIPAddresses	string[]		Частные статические IP-адреса службы управления API в основном регионе, развернутом в внутренней виртуальной сети. Доступно только для SKU уровня "Базовый", "Стандартный", "Премиум" и "Изолированный".
properties.provisioningState	string		Текущее состояние подготовки службы управления API, которое может быть одним из следующих: Create/Активация/Успешное обновление/Сбой/Остановлено/Остановлено/Завершение/Завершение/Завершение/Удаление.
properties.publicIPAddresses	string[]		Общедоступные статические IP-адреса службы управления API в основном регионе. Доступно только для SKU уровня "Базовый", "Стандартный", "Премиум" и "Изолированный".
properties.publicIpAddressId	string		Общедоступный IP-адрес SKU SKU уровня "Стандартный" версии 4, связанный с развернутой службой виртуальной сети в регионе. Поддерживается только для развертывания SKU разработчика и класса Premium в виртуальной сети.
properties.publicNetworkAccess	PublicNetworkAccess		Допускается ли доступ к общедоступной конечной точке для этой службы управления API. Значение является необязательным, но при передаче должно быть "Включено" или "Отключено". Если значение "Отключено", частные конечные точки являются эксклюзивным методом доступа. Значение по умолчанию — "Включено"
properties.publisherEmail	string maxLength: 100		Электронная почта издателя.
properties.publisherName	string maxLength: 100		Имя издателя.
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. Нет (значение по умолчанию) означает, что служба управления API не является частью какой-либо виртуальной сети, внешняя означает, что развертывание управления API настраивается внутри виртуальной сети с конечной точкой виртуальной сети, имеющей только конечную точку с доступом к Интернету, и внутреннее означает, что развертывание управления API настраивается в виртуальной сети только с конечной точкой управления интрасетью.
sku	ApiManagementServiceSkuProperties		Свойства SKU службы управления API.
tags	object		Теги ресурсов.
type	string		Тип ресурса управления API имеет значение Microsoft.ApiManagement.
zones	string[]		Список зон доступности, обозначающих, откуда должен поступать ресурс.

ApimIdentityType

Перечисление

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

Значение	Описание
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

ApiVersionConstraint

Object

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

Имя	Тип	Описание
minApiVersion	string	Ограничение вызовов API уровня управления к службе управления API с версией, равной или более новой, чем это значение.

ArmIdWrapper

Object

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

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

CertificateConfiguration

Object

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

Имя	Тип	Описание
certificate	CertificateInformation	Сведения о сертификате.
certificatePassword	string	Пароль сертификата.
encodedCertificate	string	Сертификат в кодировке Base64.
storeName	enum: CertificateAuthority Root	Расположение хранилища сертификатов System.Security.Cryptography.x509certificates.StoreName. Допустимы только корневой каталог и CertificateAuthority.

CertificateInformation

Object

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

Имя	Тип	Описание
expiry	string (date-time)	Дата окончания срока действия сертификата. Дата соответствует следующему формату: `yyyy-MM-ddTHH:mm:ssZ`, как указано в стандарте ISO 8601.
subject	string	Тема сертификата.
thumbprint	string	Отпечаток сертификата.

CertificateSource

Перечисление

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

Значение	Описание
BuiltIn
Custom
KeyVault
Managed

CertificateStatus

Перечисление

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

Значение	Описание
Completed
Failed
InProgress

ConfigurationApi

Object

Сведения об API конфигурации службы управления API.

Имя	Тип	Default value	Описание
legacyApi	LegacyApiState	Enabled	Указывает, следует ли предоставлять устаревший API конфигурации (версии 1) в службе управления API. Значение является необязательным, но должно быть "Включено" или "Отключено". Если параметр "Отключен", устаревший API конфигурации (версия 1) не будет доступен для локальных шлюзов. Значение по умолчанию — "Включено"

createdByType

Перечисление

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

Значение	Описание
Application
Key
ManagedIdentity
User

developerPortalStatus

Перечисление

Состояние портала разработчика в этой службе управления API.

Значение	Описание
Disabled	Портал разработчика отключен для службы.
Enabled	Портал разработчика включен для службы.

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

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

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

ErrorResponse

Object

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

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

HostnameConfiguration

Object

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

Имя	Тип	Default value	Описание
certificate	CertificateInformation		Сведения о сертификате.
certificatePassword	string		Пароль сертификата.
certificateSource	CertificateSource		Источник сертификата.
certificateStatus	CertificateStatus		Состояние сертификата.
defaultSslBinding	boolean	False	Укажите значение true, чтобы настроить сертификат, связанный с этим именем узла, в качестве SSL-сертификата по умолчанию. Если клиент не отправляет заголовок SNI, это будет сертификат, который будет оспариваться. Это свойство полезно, если служба включает несколько пользовательских имен узлов, и она должна принять решение о ssl-сертификате по умолчанию. Параметр применяется только к типу имени узла шлюза.
encodedCertificate	string		Сертификат в кодировке Base64.
hostName	string		Имя узла для настройки в службе управления API.
identityClientId	string		Идентификатор клиента управляемого удостоверения, назначаемого системой или пользователем, создаваемый Azure AD, имеет доступ GET к ключуVault, содержащей SSL-сертификат.
keyVaultId	string		URL-адрес секрета KeyVault, содержащего ssl-сертификат. Если указан абсолютный URL-адрес, содержащий версию, автоматическое обновление SSL-сертификата не будет работать. Для этого требуется, чтобы служба управления API была настроена с помощью aka.ms/apimmsi. Секрет должен быть типом application/x-pkcs12
negotiateClientCertificate	boolean	False	Укажите значение true, чтобы всегда согласовывать сертификат клиента в имени узла. Значение по умолчанию равно false.
type	HostnameType		Тип имени узла.

HostnameType

Перечисление

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

Значение	Описание
ConfigurationApi
DeveloperPortal
Management
Portal
Proxy
Scm

LegacyApiState

Перечисление

Указывает, следует ли предоставлять устаревший API конфигурации (версии 1) в службе управления API. Значение является необязательным, но должно быть "Включено" или "Отключено". Если параметр "Отключен", устаревший API конфигурации (версия 1) не будет доступен для локальных шлюзов. Значение по умолчанию — "Включено"

Значение	Описание
Disabled	Устаревший API конфигурации (версия 1) отключен для службы, а локальные шлюзы не могут подключиться к нему.
Enabled	Устаревший API конфигурации (версия 1) включен для службы, а локальные шлюзы могут подключаться к нему.

LegacyPortalStatus

Перечисление

Состояние устаревшего портала в службе управления API.

Значение	Описание
Disabled	Устаревший портал отключен для службы.
Enabled	Устаревший портал включен для службы.

NatGatewayState

Перечисление

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

Значение	Описание
Disabled	Шлюз Nat отключен для службы.
Enabled	Шлюз Nat включен для службы.

PlatformVersion

Перечисление

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

Значение	Описание
mtv1	Платформа, выполняющая службу на платформе Multi Tenant V1.
stv1	Платформа, выполняющая службу на платформе Single Tenant V1.
stv2	Платформа, выполняющая службу на платформе Single Tenant V2.
stv2.1	Платформа, на котором выполняется служба на платформе single Tenant V2 на более новом оборудовании.
undetermined	Не удается определить версию платформы, так как вычислительные платформы не развернуты.

PrivateEndpointServiceConnectionStatus

Перечисление

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

Значение	Описание
Approved
Pending
Rejected

PrivateLinkServiceConnectionState

Object

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

Имя	Тип	Описание
actionsRequired	string	Сообщение, указывающее, требуются ли изменения в поставщике услуг, требуются какие-либо обновления для потребителя.
description	string	Причина утверждения или отклонения подключения.
status	PrivateEndpointServiceConnectionStatus	Указывает, утверждено ли подключение, отклонено или удалено владельцем службы.

PublicNetworkAccess

Перечисление

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

Значение	Описание
Disabled
Enabled

RemotePrivateEndpointConnectionWrapper

Object

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

Имя	Тип	Описание
id	string	Идентификатор ресурса подключения к частной конечной точке
name	string	Имя подключения к частной конечной точке
properties.groupIds	string[]	Все идентификаторы группы.
properties.privateEndpoint	ArmIdWrapper	Ресурс частной конечной точки.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Коллекция сведений о состоянии подключения между потребителем службы и поставщиком.
properties.provisioningState	string	Состояние подготовки ресурса подключения частной конечной точки.
type	string	Тип ресурса подключения к частной конечной точке

SkuType

Перечисление

Имя SKU.

Значение	Описание
Basic	Базовый номер SKU управления API.
BasicV2	SKU BasicV2 для управления API.
Consumption	Номер SKU потребления для управления API.
Developer	Номер SKU разработчика для управления API.
Isolated	Изолированный SKU управления API.
Premium	Номер SKU уровня "Премиум" для управления API.
Standard	Стандартный номер SKU управления API.
StandardV2	Номер SKU StandardV2 для управления API.

systemData

Object

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

Имя	Тип	Описание
createdAt	string (date-time)	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string (date-time)	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Идентификатор, который последний раз изменил ресурс.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.

UserIdentityProperties

Object

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

VirtualNetworkConfiguration

Object

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

Имя	Тип	Описание
subnetResourceId	string pattern: ^/subscriptions/[^/]/resourceGroups/[^/]/providers/Microsoft.(ClassicNetwork\|Network)/virtualNetworks/[^/]/subnets/[^/]$	Полный идентификатор ресурса подсети в виртуальной сети для развертывания службы управления API.
subnetname	string	Имя подсети.
vnetid	string	Идентификатор виртуальной сети. Обычно это GUID. Ожидается значение NULL GUID по умолчанию.

VirtualNetworkType

Перечисление

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

Значение	Описание
External	Служба входит в виртуальную сеть и доступна из Интернета.
Internal	Служба является частью виртуальной сети, и она доступна только из виртуальной сети.
None	Служба не является частью какой-либо виртуальной сети.

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

Api Management Service - Update

Параметры URI

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

Ответы

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

azure_auth

Области

Примеры

ApiManagementUpdateServiceDisableTls10

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

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

ApiManagementUpdateServicePublisherDetails

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

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

ApiManagementUpdateServiceToNewVnetAndAvailabilityZones

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

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

Определения

AdditionalLocation

ApiManagementServiceIdentity

ApiManagementServiceResource

ApiManagementServiceSkuProperties

ApiManagementServiceUpdateParameters

ApimIdentityType

ApiVersionConstraint

ArmIdWrapper

CertificateConfiguration

CertificateInformation

CertificateSource

CertificateStatus

ConfigurationApi

createdByType

developerPortalStatus

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

HostnameConfiguration

HostnameType

LegacyApiState

LegacyPortalStatus

NatGatewayState

PlatformVersion

PrivateEndpointServiceConnectionStatus

PrivateLinkServiceConnectionState

PublicNetworkAccess

RemotePrivateEndpointConnectionWrapper

SkuType

systemData

UserIdentityProperties

VirtualNetworkConfiguration

VirtualNetworkType

Дополнительные ресурсы