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

ApiManagementServiceBaseProperties interface

  • Ссылка
Пакет:
@azure/arm-apimanagement

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

Свойства

additionalLocations

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

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

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

Дата создания службы Управление API в формате UTC. Дата соответствует следующему формату: yyyy-MM-ddTHH:mm:ssZ в соответствии со стандартом ISO 8601. ПРИМЕЧАНИЕ. Это свойство не сериализуется. Он может быть заполнен только сервером.
customProperties

Пользовательские свойства службы Управление 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
developerPortalUrl

URL-адрес конечной точки портала DEveloper службы Управление API. ПРИМЕЧАНИЕ. Это свойство не сериализуется. Он может быть заполнен только сервером.
disableGateway

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

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

URL-адрес шлюза службы Управление API в регионе по умолчанию. ПРИМЕЧАНИЕ. Это свойство не сериализуется. Он может быть заполнен только сервером.
gatewayUrl

URL-адрес шлюза службы Управление API. ПРИМЕЧАНИЕ. Это свойство не сериализуется. Он может быть заполнен только сервером.
hostnameConfigurations

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

URL-адрес конечной точки API управления службы Управление API. ПРИМЕЧАНИЕ. Это свойство не сериализуется. Он может быть заполнен только сервером.
natGatewayState

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

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

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

Версия вычислительной платформы, запустив службу в этом расположении. ПРИМЕЧАНИЕ. Это свойство не сериализуется. Он может быть заполнен только сервером.
portalUrl

Url-адрес конечной точки портала издателя службы Управление API. ПРИМЕЧАНИЕ. Это свойство не сериализуется. Он может быть заполнен только сервером.
privateEndpointConnections

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

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

Текущее состояние подготовки службы Управление API, которое может быть одним из следующих: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted. ПРИМЕЧАНИЕ. Это свойство не сериализуется. Он может быть заполнен только сервером.
publicIPAddresses

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

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

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

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

URL-адрес конечной точки SCM службы Управление API. ПРИМЕЧАНИЕ. Это свойство не сериализуется. Он может быть заполнен только сервером.
targetProvisioningState

Состояние подготовки службы Управление API, на которую нацелена длительная операция, запущенная в службе. ПРИМЕЧАНИЕ. Это свойство не сериализуется. Он может быть заполнен только сервером.
virtualNetworkConfiguration

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

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

Сведения о свойстве

additionalLocations

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

additionalLocations?: AdditionalLocation[]

Значение свойства

AdditionalLocation[]

apiVersionConstraint

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

apiVersionConstraint?: ApiVersionConstraint

Значение свойства

ApiVersionConstraint

certificates

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

certificates?: CertificateConfiguration[]

Значение свойства

CertificateConfiguration[]

createdAtUtc

Дата создания службы Управление API в формате UTC. Дата соответствует следующему формату: yyyy-MM-ddTHH:mm:ssZ в соответствии со стандартом ISO 8601. ПРИМЕЧАНИЕ. Это свойство не сериализуется. Он может быть заполнен только сервером.

createdAtUtc?: Date

Значение свойства

Date

customProperties

Пользовательские свойства службы Управление 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

customProperties?: {[propertyName: string]: string}

Значение свойства

{[propertyName: string]: string}

developerPortalUrl

URL-адрес конечной точки портала DEveloper службы Управление API. ПРИМЕЧАНИЕ. Это свойство не сериализуется. Он может быть заполнен только сервером.

developerPortalUrl?: string

Значение свойства

string

disableGateway

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

disableGateway?: boolean

Значение свойства

boolean

enableClientCertificate

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

enableClientCertificate?: boolean

Значение свойства

boolean

gatewayRegionalUrl

URL-адрес шлюза службы Управление API в регионе по умолчанию. ПРИМЕЧАНИЕ. Это свойство не сериализуется. Он может быть заполнен только сервером.

gatewayRegionalUrl?: string

Значение свойства

string

gatewayUrl

URL-адрес шлюза службы Управление API. ПРИМЕЧАНИЕ. Это свойство не сериализуется. Он может быть заполнен только сервером.

gatewayUrl?: string

Значение свойства

string

hostnameConfigurations

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

hostnameConfigurations?: HostnameConfiguration[]

Значение свойства

HostnameConfiguration[]

managementApiUrl

URL-адрес конечной точки API управления службы Управление API. ПРИМЕЧАНИЕ. Это свойство не сериализуется. Он может быть заполнен только сервером.

managementApiUrl?: string

Значение свойства

string

natGatewayState

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

natGatewayState?: string

Значение свойства

string

notificationSenderEmail

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

notificationSenderEmail?: string

Значение свойства

string

outboundPublicIPAddresses

Префиксы исходящих общедоступных IPV4-адресов, связанные с развернутой службой шлюза NAT. Доступно только для SKU "Премиум" на платформе stv2. ПРИМЕЧАНИЕ. Это свойство не сериализуется. Он может быть заполнен только сервером.

outboundPublicIPAddresses?: string[]

Значение свойства

string[]

platformVersion

Версия вычислительной платформы, запустив службу в этом расположении. ПРИМЕЧАНИЕ. Это свойство не сериализуется. Он может быть заполнен только сервером.

platformVersion?: string

Значение свойства

string

portalUrl

Url-адрес конечной точки портала издателя службы Управление API. ПРИМЕЧАНИЕ. Это свойство не сериализуется. Он может быть заполнен только сервером.

portalUrl?: string

Значение свойства

string

privateEndpointConnections

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

privateEndpointConnections?: RemotePrivateEndpointConnectionWrapper[]

Значение свойства

RemotePrivateEndpointConnectionWrapper[]

privateIPAddresses

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

privateIPAddresses?: string[]

Значение свойства

string[]

provisioningState

Текущее состояние подготовки службы Управление API, которое может быть одним из следующих: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted. ПРИМЕЧАНИЕ. Это свойство не сериализуется. Он может быть заполнен только сервером.

provisioningState?: string

Значение свойства

string

publicIPAddresses

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

publicIPAddresses?: string[]

Значение свойства

string[]

publicIpAddressId

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

publicIpAddressId?: string

Значение свойства

string

publicNetworkAccess

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

publicNetworkAccess?: string

Значение свойства

string

restore

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

restore?: boolean

Значение свойства

boolean

scmUrl

URL-адрес конечной точки SCM службы Управление API. ПРИМЕЧАНИЕ. Это свойство не сериализуется. Он может быть заполнен только сервером.

scmUrl?: string

Значение свойства

string

targetProvisioningState

Состояние подготовки службы Управление API, на которую нацелена длительная операция, запущенная в службе. ПРИМЕЧАНИЕ. Это свойство не сериализуется. Он может быть заполнен только сервером.

targetProvisioningState?: string

Значение свойства

string

virtualNetworkConfiguration

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

virtualNetworkConfiguration?: VirtualNetworkConfiguration

Значение свойства

VirtualNetworkConfiguration

virtualNetworkType

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

virtualNetworkType?: string

Значение свойства

string