Api Management Service - Refresh Hostnames

Служба:: API Management

Версия API:: 2025-03-01-preview

Принудительно обновите SSL-сертификат, привязанный к пользовательским именам хостов, настроенным с помощью секрета из KeyVault на сервисе управления API.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/refreshHostnames?api-version=2025-03-01-preview

Параметры 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 minLength: 1	Идентификатор целевой подписки.
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.

Ответы

Имя	Тип	Описание
200 OK	ApiManagementServiceResource	Операция Azure успешно завершена.
202 Accepted		Операция ресурса принята. Заголовки Retry-After: integer location: string
Other Status Codes	ErrorResponse	Непредвиденное сообщение об ошибке.

Имя

Тип

Описание

200 OK

ApiManagementServiceResource

Операция Azure успешно завершена.

202 Accepted

Операция ресурса принята.

Заголовки

Retry-After: integer
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	Выдача себя за свою учетную запись пользователя

Примеры

ApiManagementServiceRefreshKeyVaultHostnames

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/refreshHostnames?api-version=2025-03-01-preview

from azure.identity import DefaultAzureCredential

from azure.mgmt.apimanagement import ApiManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apimanagement
# USAGE
    python api_management_service_refresh_key_vault_hostnames.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ApiManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.api_management_service.begin_refresh_hostnames(
        resource_group_name="rg1",
        service_name="apimService1",
    ).result()
    print(response)


# x-ms-original-file: 2025-03-01-preview/ApiManagementServiceRefreshKeyVaultHostnames.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

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

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

{
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "etag": "AAAAAAK5GpM=",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "identity": {
    "type": "SystemAssigned",
    "principalId": "b413456e-a9c8-4242-9754-0a01c061bd41",
    "tenantId": "b413456e-a9c8-4242-9754-0a01c061bd41"
  },
  "location": "West Europe",
  "properties": {
    "additionalLocations": [
      {
        "disableGateway": false,
        "gatewayRegionalUrl": "https://apimService1-northeurope-01.regional.azure-api.net",
        "location": "North Europe",
        "outboundPublicIPAddresses": [
          "4.xxx.40.176"
        ],
        "platformVersion": "stv2",
        "publicIPAddresses": [
          "4.xxx.40.176"
        ],
        "sku": {
          "name": "Premium",
          "capacity": 1
        },
        "virtualNetworkConfiguration": {
          "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/apimVnet/subnets/default2"
        }
      }
    ],
    "createdAtUtc": "2016-04-12T00:20:15.6018952Z",
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "True"
    },
    "developerPortalStatus": "Enabled",
    "developerPortalUrl": "https://apimService1.developer.azure-api.net",
    "disableGateway": false,
    "gatewayRegionalUrl": "https://apimService1-westeurope-01.regional.azure-api.net",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "certificateSource": "BuiltIn",
        "defaultSslBinding": false,
        "hostName": "apimService1.azure-api.net",
        "negotiateClientCertificate": false
      },
      {
        "type": "Proxy",
        "certificate": {
          "expiry": "2025-12-18T11:11:47+00:00",
          "subject": "CN=*.msitesting.net",
          "thumbprint": "9833D531D7A45XXXXXXXXXXXX8BD392E0BD3F"
        },
        "certificateSource": "KeyVault",
        "defaultSslBinding": true,
        "hostName": "proxy.msitesting.net",
        "keyVaultId": "https://apim-msi-keyvault.vault.azure.net/secrets/sslcertificate",
        "negotiateClientCertificate": false
      }
    ],
    "legacyPortalStatus": "Disabled",
    "managementApiUrl": "https://apimService1.management.azure-api.net",
    "natGatewayState": "Disabled",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "outboundPublicIPAddresses": [
      "57.xxx.61.xx"
    ],
    "platformVersion": "stv2.1",
    "provisioningState": "Succeeded",
    "publicIPAddresses": [
      "XX.153.XX.94"
    ],
    "publicNetworkAccess": "Enabled",
    "publisherEmail": "autorest@contoso.com",
    "publisherName": "Microsoft",
    "releaseChannel": "Default",
    "scmUrl": "https://apimService1.scm.azure-api.net",
    "virtualNetworkConfiguration": {
      "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1/subnets/default"
    },
    "virtualNetworkType": "External"
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  },
  "systemData": {
    "lastModifiedAt": "2024-06-14T17:33:34.8195595Z",
    "lastModifiedBy": "autorest@contoso.com",
    "lastModifiedByType": "User"
  },
  "tags": {}
}

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

location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2025-03-01-preview

Определения

Имя	Описание
AdditionalLocation	Описание дополнительного расположения ресурса службы "Управление API".
ApiManagementServiceIdentity	Свойства удостоверений ресурса службы "Управление API".
ApiManagementServiceResource	Один ресурс службы "Управление API" в списке или получении ответа.
ApiManagementServiceSkuProperties	Свойства SKU ресурса службы "Управление API".
ApimIdentityType	Тип удостоверения, используемого для ресурса. Тип SystemAssigned, UserAssigned включает как неявное созданное удостоверение, так и набор назначенных пользователем удостоверений. Тип "Нет" удаляет все удостоверения из службы.
ApiVersionConstraint	Ограничение версии API уровня управления для службы управления API.
ArmIdWrapper	Оболочка для идентификатора ресурса ARM
CertificateConfiguration	Конфигурация сертификатов, состоящая из недоверенных промежуточных и корневых сертификатов.
CertificateConfigurationStoreName	Расположение хранилища сертификатов System.Security.Cryptography.x509certificates.StoreName. Допустимы только корневой каталог и CertificateAuthority.
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. Значение является необязательным, но при передаче должно быть "Включено" или "Отключено". Если значение "Отключено", частные конечные точки являются эксклюзивным методом доступа. Значение по умолчанию — "Включено"
ReleaseChannel	Release Channel этой службы управления API.
RemotePrivateEndpointConnectionWrapper	Ресурс подключения к удаленной частной конечной точке.
SkuType	Имя SKU.
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.
UserIdentityProperties
VirtualNetworkConfiguration	Конфигурация виртуальной сети, в которой развернута служба управления API.
VirtualNetworkType	Тип VPN, в котором необходимо настроить шлюз управления API.

AdditionalLocation

Объект

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

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

ApiManagementServiceIdentity

Объект

Свойства удостоверений ресурса службы "Управление 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

Объект

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

Имя	Тип	Default value	Описание
etag	string		ETag ресурса.
id	string		Полный идентификатор ресурса для ресурса. Пример - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
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 Portal службы управления 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. Доступно только для Premium SKU на платформе stv2.
properties.platformVersion	PlatformVersion		Версия вычислительной платформы, на которой запущена служба в этом расположении.
properties.portalUrl	string		URL-адрес конечной точки портала издателя службы "Управление API".
properties.privateEndpointConnections	RemotePrivateEndpointConnectionWrapper[]		Список подключений к частной конечной точке этой службы.
properties.privateIPAddresses	string[]		Частные статические IP-адреса со сбалансированной статической нагрузкой службы управления API в основном регионе, развернутом во внутренней виртуальной сети. Доступно только для SKU Basic, Standard, Premium и Isolated.
properties.provisioningState	string		Текущее состояние подготовки службы управления API, которое может быть одним из следующих: Создано/Активировано/Успешно/Обновлено/Не выполнено/Остановлено/Завершено/Завершено/Удалено.
properties.publicIPAddresses	string[]		Общедоступные статические IP-адреса со сбалансированной статической нагрузкой службы "Управление API" в основном регионе. Доступно только для SKU Basic, Standard, Premium и Isolated.
properties.publicIpAddressId	string		Общедоступный IP-адрес SKU SKU уровня "Стандартный" версии 4, связанный с развернутой службой виртуальной сети в регионе. Поддерживается только для развертывания SKU разработчика и класса Premium в виртуальной сети.
properties.publicNetworkAccess	PublicNetworkAccess		Допускается ли доступ к общедоступной конечной точке для этой службы управления API. Значение является необязательным, но при передаче должно быть "Включено" или "Отключено". Если значение "Отключено", частные конечные точки являются эксклюзивным методом доступа. Значение по умолчанию — "Включено"
properties.publisherEmail	string maxLength: 100		Электронная почта издателя.
properties.publisherName	string maxLength: 100		Имя издателя.
properties.releaseChannel	ReleaseChannel		Release Channel этой службы управления API.
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 настраивается в виртуальной сети только с конечной точкой управления интрасетью.
properties.zoneRedundant	boolean	False	Требование по избыточности в зоне при создании StandardV2 и PremiumV2. Если этот флаг установлен на True, это вернёт сервис APIM с избыточным зонным или не будет выполнен запрос, если какой-либо компонент под ним не может быть избыточным в зоне.
sku	ApiManagementServiceSkuProperties		Свойства SKU службы управления API.
systemData	systemData		Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy.
tags	object		Теги ресурсов.
type	string		Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"
zones	string[]		Зоны доступности.

ApiManagementServiceSkuProperties

Объект

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

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

ApimIdentityType

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

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

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

ApiVersionConstraint

Объект

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

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

ArmIdWrapper

Объект

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

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

CertificateConfiguration

Объект

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

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

CertificateConfigurationStoreName

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

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

Значение	Описание
CertificateAuthority
Root

CertificateInformation

Объект

Информация о SSL-сертификате.

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

CertificateSource

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

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

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

CertificateStatus

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

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

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

ConfigurationApi

Объект

Информация об API конфигурации службы "Управление API".

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

createdByType

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

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

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

DeveloperPortalStatus

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

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

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

ErrorAdditionalInfo

Объект

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

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

ErrorDetail

Объект

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

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

ErrorResponse

Объект

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

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

HostnameConfiguration

Объект

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

Имя	Тип	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

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

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

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

LegacyApiState

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

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

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

LegacyPortalStatus

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

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

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

NatGatewayState

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

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

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

PlatformVersion

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

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

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

PrivateEndpointServiceConnectionStatus

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

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

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

PrivateLinkServiceConnectionState

Объект

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

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

PublicNetworkAccess

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

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

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

ReleaseChannel

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

Release Channel этой службы управления API.

Значение	Описание
Preview	Предварительный просмотр канала сервиса.
Default	Канал службы по умолчанию.
Stable	Стабильный канал работы сервиса.

RemotePrivateEndpointConnectionWrapper

Объект

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

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

SkuType

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

Имя SKU.

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

systemData

Объект

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

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

UserIdentityProperties

Объект

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

VirtualNetworkConfiguration

Объект

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

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

VirtualNetworkType

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

Тип VPN, в котором необходимо настроить шлюз управления API.

Значение	Описание
None	Шлюз службы "Управление API" не является частью какой-либо виртуальной сети.
External	Шлюз управления API является частью виртуальной сети и доступен из Интернета.
Internal	Шлюз службы "Управление API" является частью виртуальной сети и доступен только из виртуальной сети.

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

Api Management Service - Refresh Hostnames

Параметры URI

Ответы

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

azure_auth

Области

Примеры

ApiManagementServiceRefreshKeyVaultHostnames

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

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

Определения

AdditionalLocation

ApiManagementServiceIdentity

ApiManagementServiceResource

ApiManagementServiceSkuProperties

ApimIdentityType

ApiVersionConstraint

ArmIdWrapper

CertificateConfiguration

CertificateConfigurationStoreName

CertificateInformation

CertificateSource

CertificateStatus

ConfigurationApi

createdByType

DeveloperPortalStatus

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

HostnameConfiguration

HostnameType

LegacyApiState

LegacyPortalStatus

NatGatewayState

PlatformVersion

PrivateEndpointServiceConnectionStatus

PrivateLinkServiceConnectionState

PublicNetworkAccess

ReleaseChannel

RemotePrivateEndpointConnectionWrapper

SkuType

systemData

UserIdentityProperties

VirtualNetworkConfiguration

VirtualNetworkType