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

ApiManagementServiceResource interface

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

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

Extends
ApimResource

Свойства

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 потребления. При этом сертификат клиента должен отображаться при каждом запросе к шлюзу. Это также позволяет проверять подлинность сертификата в политике шлюза.
etag

ETag ресурса. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его может заполнить только сервер.
gatewayRegionalUrl

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

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

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

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

Расположение ресурса.
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 "Стандартный" версии 4, который будет связан с виртуальная сеть развернутой службой в регионе. Поддерживается только для SKU developer и Premium, развертываемых в виртуальная сеть.
publicNetworkAccess

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

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

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

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

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

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

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

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

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

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

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

Унаследованные свойства

id

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

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

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

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

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

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

etag

ETag ресурса. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его может заполнить только сервер.

etag?: string

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

string

gatewayRegionalUrl

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

gatewayRegionalUrl?: string

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

string

gatewayUrl

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

gatewayUrl?: string

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

string

hostnameConfigurations

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

hostnameConfigurations?: HostnameConfiguration[]

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

HostnameConfiguration[]

identity

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

identity?: ApiManagementServiceIdentity

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

ApiManagementServiceIdentity

location

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

location: string

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

string

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 "Стандартный" версии 4, который будет связан с виртуальная сеть развернутой службой в регионе. Поддерживается только для SKU developer и Premium, развертываемых в виртуальная сеть.

publicIpAddressId?: string

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

string

publicNetworkAccess

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

publicNetworkAccess?: string

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

string

publisherEmail

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

publisherEmail: string

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

string

publisherName

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

publisherName: string

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

string

restore

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

restore?: boolean

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

boolean

scmUrl

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

scmUrl?: string

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

string

sku

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

sku: ApiManagementServiceSkuProperties

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

ApiManagementServiceSkuProperties

systemData

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

systemData?: SystemData

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

SystemData

targetProvisioningState

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

targetProvisioningState?: string

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

string

virtualNetworkConfiguration

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

virtualNetworkConfiguration?: VirtualNetworkConfiguration

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

VirtualNetworkConfiguration

virtualNetworkType

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

virtualNetworkType?: string

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

string

zones

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

zones?: string[]

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

string[]

Сведения об унаследованном свойстве

id

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

id?: string

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

string

Наследуетсяот ApimResource.id

name

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

name?: string

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

string

Наследуетсяот ApimResource.name

tags

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

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

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

{[propertyName: string]: string}

Наследуется отApimResource.tags

type

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

type?: string

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

string

Наследуется отApimResource.type