Api Management Service - Update
Обновления существующей службы Управление API.
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}?api-version=2022-08-01
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
resource
|
path | True |
string |
Имя группы ресурсов. Регистр букв в имени не учитывается. |
service
|
path | True |
string |
Имя службы Управление API. Шаблон регулярного выражения: |
subscription
|
path | True |
string |
Идентификатор целевой подписки. |
api-version
|
query | True |
string |
Версия API, используемая для данной операции. |
Текст запроса
Имя | Тип | Описание |
---|---|---|
identity |
Управляемое удостоверение службы управления API. |
|
properties.additionalLocations |
Дополнительные расположения центра обработки данных службы Управление API. |
|
properties.apiVersionConstraint |
Ограничение версии API уровня управления для службы Управление API. |
|
properties.certificates |
Список сертификатов, которые необходимо установить в службе Управление API. Максимальное число поддерживаемых сертификатов, которые можно установить, равно 10. |
|
properties.customProperties |
object |
Пользовательские свойства службы Управление API. |
properties.disableGateway |
boolean |
Свойство допустимо только для службы управления API, развернутой в нескольких расположениях. Это можно использовать для отключения шлюза в master регионе. |
properties.enableClientCertificate |
boolean |
Свойство предназначено только для службы SKU потребления. Это принудительно обеспечивает представление сертификата клиента при каждом запросе к шлюзу. Это также позволяет проверять подлинность сертификата в политике шлюза. |
properties.hostnameConfigurations |
Настраиваемая конфигурация имени узла службы Управление API. |
|
properties.natGatewayState |
Свойство можно использовать для включения шлюза NAT для этой службы Управление API. |
|
properties.notificationSenderEmail |
string |
Email адрес, с которого будет отправлено уведомление. |
properties.privateEndpointConnections |
Список подключений к частной конечной точке этой службы. |
|
properties.publicIpAddressId |
string |
IP-адрес на основе общедоступного номера SKU SKU V4, связанный с виртуальная сеть развернутой службой в регионе. Поддерживается только для SKU "Разработчик" и "Премиум", развертываемых в виртуальная сеть. |
properties.publicNetworkAccess |
Разрешен ли доступ к общедоступной конечной точке для этой Управление API службы. Значение является необязательным, но при передаче должно быть "Включено" или "Отключено". Если значение "Отключено", частные конечные точки являются монопольным методом доступа. Значение по умолчанию — "Включено". |
|
properties.publisherEmail |
string |
Электронная почта издателя. |
properties.publisherName |
string |
Имя издателя. |
properties.restore |
boolean |
Отмените удаление службы управления API, если она ранее была обратимо удалена. Если этот флаг указан и имеет значение True, все остальные свойства будут игнорироваться. |
properties.virtualNetworkConfiguration |
Конфигурация виртуальной сети службы Управление API. |
|
properties.virtualNetworkType |
Тип VPN, в котором необходимо настроить службу Управление API. None (значение по умолчанию) означает, что служба Управление API не является частью какого-либо виртуальная сеть, external означает, что развертывание Управление API настроено внутри виртуальная сеть с конечной точкой с выходом в Интернет, а внутреннее означает, что Управление API развертывание настраивается внутри виртуальная сеть только с конечной точкой, обращенной к интрасети. |
|
sku |
Свойства SKU службы Управление API. |
|
tags |
object |
Теги ресурсов. |
zones |
string[] |
Список зон доступности, обозначающих, откуда должен поступать ресурс. |
Ответы
Имя | Тип | Описание |
---|---|---|
200 OK |
Служба успешно обновлена. |
|
202 Accepted |
Запрос на обновление службы принят. |
|
Other Status Codes |
Ответ об ошибке, описывающий причину сбоя операции. |
Безопасность
azure_auth
Поток OAuth2 в Azure Active Directory.
Тип:
oauth2
Flow:
implicit
URL-адрес авторизации:
https://login.microsoftonline.com/common/oauth2/authorize
Области
Имя | Описание |
---|---|
user_impersonation | олицетворения учетной записи пользователя |
Примеры
Api |
Api |
Api |
ApiManagementUpdateServiceDisableTls10
Образец запроса
PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1?api-version=2022-08-01
{
"properties": {
"customProperties": {
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "false"
}
}
}
Пример ответа
Location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2022-08-01&asyncResponse
Azure-AsyncOperation: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2022-08-01&asyncResponse
{
"id": "/subscriptions/subid/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
Образец запроса
Пример ответа
Location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2022-08-01&asyncResponse
Azure-AsyncOperation: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2022-08-01&asyncResponse
{
"id": "/subscriptions/subid/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
Образец запроса
PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1?api-version=2022-08-01
{
"properties": {
"additionalLocations": [
{
"location": "Australia East",
"sku": {
"name": "Premium",
"capacity": 3
},
"zones": [
"1",
"2",
"3"
],
"virtualNetworkConfiguration": {
"subnetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/apimaeavnet/subnets/default"
},
"publicIpAddressId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/apim-australia-east-publicip"
}
],
"virtualNetworkConfiguration": {
"subnetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet-apim-japaneast/subnets/apim2"
},
"virtualNetworkType": "External",
"publicIpAddressId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/publicip-apim-japan-east"
},
"sku": {
"name": "Premium",
"capacity": 3
},
"zones": [
"1",
"2",
"3"
]
}
Пример ответа
Location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2022-08-01&asyncResponse
Azure-AsyncOperation: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2022-08-01&asyncResponse
{
"id": "/subscriptions/subid/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/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/apimaeavnet/subnets/default"
},
"gatewayRegionalUrl": "https://apimService1-australiaeast-01.regional.azure-api.net",
"disableGateway": false,
"publicIpAddressId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/apim-australia-east-publicip",
"platformVersion": "stv2"
}
],
"virtualNetworkConfiguration": {
"subnetResourceId": "/subscriptions/subid/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/subid/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"
}
}
Определения
Имя | Описание |
---|---|
Additional |
Описание дополнительного расположения ресурса Управление API. |
Api |
Свойства идентификатора ресурса службы "Управление API". |
Api |
Один ресурс службы Управление API в списке или получении ответа. |
Api |
Управление API свойства SKU ресурса службы. |
Api |
Параметр, предоставленный для обновления службы управления API. |
Apim |
Тип удостоверения, используемого для ресурса. Тип SystemAssigned, UserAssigned включает как условно созданное удостоверение, так и набор удостоверений, назначенных пользователем. Тип None удалит все удостоверения из службы. |
Api |
Ограничение версии API уровня управления для службы Управление API. |
Arm |
Оболочка для идентификатора ресурса ARM |
Certificate |
Конфигурация сертификата, состоящая из ненадежных промежуточных и корневых сертификатов. |
Certificate |
Сведения о SSL-сертификате. |
Certificate |
Источник сертификата. |
Certificate |
Состояние сертификата. |
created |
Тип удостоверения, создавшего ресурс. |
Error |
Контракт поля ошибки. |
Error |
Ответ на ошибку. |
Hostname |
Настраиваемая конфигурация имени узла. |
Hostname |
Тип имени узла. |
Nat |
Свойство можно использовать для включения шлюза NAT для этой службы Управление API. |
Platform |
Версия вычислительной платформы, на котором выполняется служба. |
Private |
Состояние подключения к частной конечной точке. |
Private |
Коллекция сведений о состоянии соединения между потребителем службы и поставщиком. |
Public |
Разрешен ли доступ к общедоступной конечной точке для этой Управление API службы. Значение является необязательным, но при передаче должно быть "Включено" или "Отключено". Если значение "Отключено", частные конечные точки являются монопольным методом доступа. Значение по умолчанию — "Включено". |
Remote |
Ресурс подключения к удаленной частной конечной точке. |
Sku |
Имя номера SKU. |
system |
Метаданные, относящиеся к созданию и последнему изменению ресурса. |
User |
|
Virtual |
Конфигурация виртуальной сети, в которой развернута Управление API служба. |
Virtual |
Тип VPN, в котором необходимо настроить службу Управление API. None (значение по умолчанию) означает, что служба Управление API не является частью какого-либо виртуальная сеть, external означает, что развертывание Управление API настроено внутри виртуальная сеть с конечной точкой с выходом в Интернет, а внутреннее означает, что Управление API развертывание настраивается внутри виртуальная сеть только с конечной точкой, обращенной к интрасети. |
AdditionalLocation
Описание дополнительного расположения ресурса Управление API.
Имя | Тип | Default value | Описание |
---|---|---|---|
disableGateway |
boolean |
False |
Свойство допустимо только для службы управления API, развернутой в нескольких расположениях. Его можно использовать для отключения шлюза в этом дополнительном расположении. |
gatewayRegionalUrl |
string |
URL-адрес шлюза службы Управление API в регионе. |
|
location |
string |
Имя расположения дополнительного региона среди регионов центра обработки данных Azure. |
|
natGatewayState | Disabled |
Свойство можно использовать для включения шлюза NAT для этой службы Управление API. |
|
outboundPublicIPAddresses |
string[] |
Префиксы исходящих общедоступных IPV4-адресов, связанные с развернутой службой шлюза NAT. Доступно только для номера SKU "Премиум" на платформе stv2. |
|
platformVersion |
Версия вычислительной платформы, на котором выполняется служба. |
||
privateIPAddresses |
string[] |
Частные статические IP-адреса службы Управление API, развернутой во внутренней виртуальная сеть в определенном дополнительном расположении. Доступно только для SKU "Базовый", "Стандартный", "Премиум" и "Изолированный". |
|
publicIPAddresses |
string[] |
Общедоступные статические IP-адреса с балансировкой нагрузки службы Управление API в дополнительном расположении. Доступно только для SKU "Базовый", "Стандартный", "Премиум" и "Изолированный". |
|
publicIpAddressId |
string |
IP-адрес на основе общедоступного номера SKU "Стандартный" версии 4, который будет связан с виртуальная сеть развернутой службой в расположении. Поддерживается только для номера SKU "Премиум", развертываемого в виртуальная сеть. |
|
sku |
Свойства SKU службы Управление API. |
||
virtualNetworkConfiguration |
Конфигурация виртуальной сети для расположения. |
||
zones |
string[] |
Список зон доступности, обозначающих, откуда должен поступать ресурс. |
ApiManagementServiceIdentity
Свойства идентификатора ресурса службы "Управление API".
Имя | Тип | Описание |
---|---|---|
principalId |
string |
Идентификатор субъекта удостоверения. |
tenantId |
string |
Идентификатор клиента для удостоверения. |
type |
Тип удостоверения, используемого для ресурса. Тип SystemAssigned, UserAssigned включает как условно созданное удостоверение, так и набор удостоверений, назначенных пользователем. Тип None удалит все удостоверения из службы. |
|
userAssignedIdentities |
<string,
User |
Список удостоверений пользователей, связанных с ресурсом. Ссылки на ключи словаря удостоверений пользователей будут иметь идентификаторы ресурсов ARM в формате "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". |
ApiManagementServiceResource
Один ресурс службы Управление API в списке или получении ответа.
Имя | Тип | Default value | Описание |
---|---|---|---|
etag |
string |
ETag ресурса. |
|
id |
string |
Идентификатор ресурса. |
|
identity |
Управляемое удостоверение службы управления API. |
||
location |
string |
Расположение ресурса. |
|
name |
string |
Имя ресурса. |
|
properties.additionalLocations |
Дополнительные расположения центра обработки данных службы Управление API. |
||
properties.apiVersionConstraint |
Ограничение версии API уровня управления для службы Управление API. |
||
properties.certificates |
Список сертификатов, которые необходимо установить в службе Управление API. Максимальное число поддерживаемых сертификатов, которые можно установить, равно 10. |
||
properties.createdAtUtc |
string |
Дата создания службы Управление API в формате UTC. Дата соответствует следующему формату: |
|
properties.customProperties |
object |
Пользовательские свойства службы Управление API. |
|
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 |
Настраиваемая конфигурация имени узла службы Управление API. |
||
properties.managementApiUrl |
string |
URL-адрес конечной точки API управления службы Управление API. |
|
properties.natGatewayState | Disabled |
Свойство можно использовать для включения шлюза NAT для этой службы Управление API. |
|
properties.notificationSenderEmail |
string |
Email адрес, с которого будет отправлено уведомление. |
|
properties.outboundPublicIPAddresses |
string[] |
Префиксы исходящих общедоступных IPV4-адресов, связанные с развернутой службой шлюза NAT. Доступно только для SKU "Премиум" на платформе stv2. |
|
properties.platformVersion |
Версия вычислительной платформы, запустив службу в этом расположении. |
||
properties.portalUrl |
string |
Url-адрес конечной точки портала издателя службы Управление API. |
|
properties.privateEndpointConnections |
Список подключений к частной конечной точке этой службы. |
||
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 |
Разрешен ли доступ к общедоступной конечной точке для этой Управление 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 |
Конфигурация виртуальной сети службы Управление API. |
||
properties.virtualNetworkType | None |
Тип VPN, в котором необходимо настроить службу Управление API. None (значение по умолчанию) означает, что служба Управление API не является частью какого-либо виртуальная сеть, external означает, что развертывание Управление API настроено внутри виртуальная сеть с конечной точкой с выходом в Интернет, а внутреннее означает, что Управление API развертывание настраивается внутри виртуальная сеть только с конечной точкой, обращенной к интрасети. |
|
sku |
Свойства SKU службы Управление API. |
||
systemData |
Метаданные, относящиеся к созданию и последнему изменению ресурса. |
||
tags |
object |
Теги ресурсов. |
|
type |
string |
Тип ресурса для Управление API ресурса имеет значение Microsoft.ApiManagement. |
|
zones |
string[] |
Список зон доступности, обозначающих, откуда должен поступать ресурс. |
ApiManagementServiceSkuProperties
Управление API свойства SKU ресурса службы.
Имя | Тип | Описание |
---|---|---|
capacity |
integer |
Емкость номера SKU (количество развернутых единиц SKU). Для параметра Потребление SKU емкость должна быть указана как 0. |
name |
Имя номера SKU. |
ApiManagementServiceUpdateParameters
Параметр, предоставленный для обновления службы управления API.
Имя | Тип | Default value | Описание |
---|---|---|---|
etag |
string |
ETag ресурса. |
|
id |
string |
Идентификатор ресурса. |
|
identity |
Управляемое удостоверение службы управления API. |
||
name |
string |
Имя ресурса. |
|
properties.additionalLocations |
Дополнительные расположения центра обработки данных службы Управление API. |
||
properties.apiVersionConstraint |
Ограничение версии API уровня управления для службы Управление API. |
||
properties.certificates |
Список сертификатов, которые необходимо установить в службе Управление API. Максимальное число поддерживаемых сертификатов, которые можно установить, равно 10. |
||
properties.createdAtUtc |
string |
Дата создания службы Управление API в формате UTC. Дата соответствует следующему формату: |
|
properties.customProperties |
object |
Пользовательские свойства службы Управление API. |
|
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 |
Настраиваемая конфигурация имени узла службы Управление API. |
||
properties.managementApiUrl |
string |
URL-адрес конечной точки API управления службы Управление API. |
|
properties.natGatewayState | Disabled |
Свойство можно использовать для включения шлюза NAT для этой службы Управление API. |
|
properties.notificationSenderEmail |
string |
Email адрес, с которого будет отправлено уведомление. |
|
properties.outboundPublicIPAddresses |
string[] |
Префиксы исходящих общедоступных IPV4-адресов, связанные с развернутой службой шлюза NAT. Доступно только для SKU "Премиум" на платформе stv2. |
|
properties.platformVersion |
Версия вычислительной платформы, запустив службу в этом расположении. |
||
properties.portalUrl |
string |
Url-адрес конечной точки портала издателя службы Управление API. |
|
properties.privateEndpointConnections |
Список подключений к частной конечной точке этой службы. |
||
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 |
Разрешен ли доступ к общедоступной конечной точке для этой Управление 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 |
Конфигурация виртуальной сети службы Управление API. |
||
properties.virtualNetworkType | None |
Тип VPN, в котором необходимо настроить службу Управление API. None (значение по умолчанию) означает, что служба Управление API не является частью какого-либо виртуальная сеть, external означает, что развертывание Управление API настроено внутри виртуальная сеть с конечной точкой с выходом в Интернет, а внутреннее означает, что Управление API развертывание настраивается внутри виртуальная сеть только с конечной точкой, обращенной к интрасети. |
|
sku |
Свойства SKU службы Управление API. |
||
tags |
object |
Теги ресурсов. |
|
type |
string |
Для Управление API ресурса задано значение Microsoft.ApiManagement. |
|
zones |
string[] |
Список зон доступности, обозначающих, откуда должен поступать ресурс. |
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 |
Сведения о сертификате. |
|
certificatePassword |
string |
Пароль сертификата. |
encodedCertificate |
string |
Сертификат в кодировке Base64. |
storeName |
enum:
|
Расположение хранилища сертификатов System.Security.Cryptography.x509certificates.StoreName. Допустимыми расположениями являются только Root и CertificateAuthority. |
CertificateInformation
Сведения о SSL-сертификате.
Имя | Тип | Описание |
---|---|---|
expiry |
string |
Дата окончания срока действия сертификата. Дата соответствует следующему формату: |
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 |
Список недопустимых полей, отправляемых в запросе, в случае ошибки проверки. |
|
error.message |
string |
Читаемое представление ошибки. |
HostnameConfiguration
Настраиваемая конфигурация имени узла.
Имя | Тип | Default value | Описание |
---|---|---|---|
certificate |
Сведения о сертификате. |
||
certificatePassword |
string |
Пароль сертификата. |
|
certificateSource |
Источник сертификата. |
||
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
Тип имени узла.
Имя | Тип | Описание |
---|---|---|
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 |
Указывает, было ли подключение утверждено, отклонено или удалено владельцем службы. |
PublicNetworkAccess
Разрешен ли доступ к общедоступной конечной точке для этой Управление API службы. Значение является необязательным, но при передаче должно быть "Включено" или "Отключено". Если значение "Отключено", частные конечные точки являются монопольным методом доступа. Значение по умолчанию — "Включено".
Имя | Тип | Описание |
---|---|---|
Disabled |
string |
|
Enabled |
string |
RemotePrivateEndpointConnectionWrapper
Ресурс подключения к удаленной частной конечной точке.
Имя | Тип | Описание |
---|---|---|
id |
string |
Идентификатор ресурса подключения к частной конечной точке |
name |
string |
Имя подключения к частной конечной точке |
properties.groupIds |
string[] |
Все идентификаторы групп. |
properties.privateEndpoint |
Ресурс частной конечной точки. |
|
properties.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 |
Тип удостоверения, создавшего ресурс. |
|
lastModifiedAt |
string |
Метка времени последнего изменения ресурса (UTC) |
lastModifiedBy |
string |
Удостоверение, которое в последний раз изменял ресурс. |
lastModifiedByType |
Тип удостоверения, изменяющего ресурс в последний раз. |
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 |
Служба не является частью каких-либо виртуальная сеть. |