你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

ApiManagementServiceResource interface

包:

@azure/arm-apimanagement

列表或获取响应中的单个 API 管理服务资源。

扩展

ApimResource

属性

additionalLocations	API 管理服务的其他数据中心位置。
apiVersionConstraint	API 管理服务的控制平面 API 版本约束。
certificates	需要在 API 管理服务中安装的证书列表。 可安装的最大支持证书为 10。
createdAtUtc	API 管理服务的创建 UTC 日期。日期符合以下格式：按 ISO 8601 标准指定的 yyyy-MM-ddTHH:mm:ssZ。 注意：此属性不会序列化。 它只能由服务器填充。
customProperties	API 管理服务的自定义属性。 设置 Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 将禁用所有 TLS（1.0、1.1 和 1.2）的密码TLS_RSA_WITH_3DES_EDE_CBC_SHA。 设置 Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 可用于仅禁用 TLS 1.1。 设置 Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 可用于在 API 管理服务上禁用 TLS 1.0。 设置 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 可用于在 API 管理服务上启用 HTTP2 协议。 在 PATCH作上未指定这些属性中的任何一个将省略的属性的值重置为其默认值。 对于除 Http2 之外的所有设置，如果服务是在 2018 年 4 月 1 日或之前创建的，则默认值 True，否则 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	API 管理服务的 DEveloper 门户终结点 URL。 注意：此属性不会序列化。 它只能由服务器填充。
disableGateway	属性仅适用于部署在多个位置的 Api 管理服务。 这可用于禁用主区域中的网关。
enableClientCertificate	仅用于消耗 SKU 服务的属性。 这会强制在向网关的每个请求上显示客户端证书。 这样，便可以在网关上的策略中对证书进行身份验证。
etag	资源的 ETag。 注意：此属性不会序列化。 它只能由服务器填充。
gatewayRegionalUrl	默认区域中 API 管理服务的网关 URL。 注意：此属性不会序列化。 它只能由服务器填充。
gatewayUrl	API 管理服务的网关 URL。 注意：此属性不会序列化。 它只能由服务器填充。
hostnameConfigurations	API 管理服务的自定义主机名配置。
identity	Api 管理服务的托管服务标识。
location	资源位置。
managementApiUrl	API 管理服务的管理 API 终结点 URL。 注意：此属性不会序列化。 它只能由服务器填充。
natGatewayState	属性可用于为此 API 管理服务启用 NAT 网关。
notificationSenderEmail	将从中发送通知的电子邮件地址。
outboundPublicIPAddresses	与 NAT 网关部署的服务关联的出站公共 IPV4 地址前缀。 仅适用于 stv2 平台上的高级 SKU。 注意：此属性不会序列化。 它只能由服务器填充。
platformVersion	在此位置运行服务的计算平台版本。 注意：此属性不会序列化。 它只能由服务器填充。
portalUrl	API 管理服务的发布者门户终结点 URL。 注意：此属性不会序列化。 它只能由服务器填充。
privateEndpointConnections	此服务的专用终结点连接列表。
privateIPAddresses	主要区域中部署在内部虚拟网络中的 API 管理服务的专用静态负载均衡 IP 地址。 仅适用于基本、标准、高级和独立 SKU。 注意：此属性不会序列化。 它只能由服务器填充。
provisioningState	API 管理服务的当前预配状态，可以是下列项之一：Created/Activating/Succeeded/Updateing/Failed/Stopped/Terminating/TerminationFailed/Deleted。 注意：此属性不会序列化。 它只能由服务器填充。
publicIPAddresses	主要区域中 API 管理服务的公共静态负载均衡 IP 地址。 仅适用于基本、标准、高级和独立 SKU。 注意：此属性不会序列化。 它只能由服务器填充。
publicIpAddressId	要与区域中部署的虚拟网络服务关联的基于公共标准 SKU IP V4 的 IP 地址。 仅支持在虚拟网络中部署开发人员和高级 SKU。
publicNetworkAccess	是否允许此 API 管理服务访问公共终结点。 值是可选的，但如果传入，则必须为“Enabled”或“Disabled”。 如果为“Disabled”，则专用终结点是独占访问方法。 默认值为“Enabled”
publisherEmail	发布者电子邮件。
publisherName	发布者名称。
restore	取消删除 Api 管理服务（如果以前是软删除的）。 如果指定了此标志并设置为 True，将忽略所有其他属性。
scmUrl	API 管理服务的 SCM 终结点 URL。 注意：此属性不会序列化。 它只能由服务器填充。
sku	API 管理服务的 SKU 属性。
systemData	与创建和上次修改资源相关的元数据。 注意：此属性不会序列化。 它只能由服务器填充。
targetProvisioningState	API 管理服务的预配状态，该服务以长时间运行的作为目标。 注意：此属性不会序列化。 它只能由服务器填充。
virtualNetworkConfiguration	API 管理服务的虚拟网络配置。
virtualNetworkType	需要在其中配置 API 管理服务的 VPN 类型。 无（默认值）表示 API 管理服务不是任何虚拟网络的一部分，外部意味着 API 管理部署是在具有面向 Internet 的终结点的虚拟网络内设置的，内部意味着 API 管理部署仅在具有 Intranet 面向终结点的虚拟网络中进行设置。
zones	一个可用性区域列表，表示资源需要来自何处。

继承属性

id	资源 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 日期。日期符合以下格式：按 ISO 8601 标准指定的 yyyy-MM-ddTHH:mm:ssZ。 注意：此属性不会序列化。 它只能由服务器填充。

createdAtUtc?: Date

属性值

Date

customProperties

API 管理服务的自定义属性。
设置 Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 将禁用所有 TLS（1.0、1.1 和 1.2）的密码TLS_RSA_WITH_3DES_EDE_CBC_SHA。
设置 Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 可用于仅禁用 TLS 1.1。
设置 Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 可用于在 API 管理服务上禁用 TLS 1.0。
设置 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 可用于在 API 管理服务上启用 HTTP2 协议。
在 PATCH作上未指定这些属性中的任何一个将省略的属性的值重置为其默认值。 对于除 Http2 之外的所有设置，如果服务是在 2018 年 4 月 1 日或之前创建的，则默认值 True，否则 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

API 管理服务的 DEveloper 门户终结点 URL。 注意：此属性不会序列化。 它只能由服务器填充。

developerPortalUrl?: string

属性值

string

disableGateway

属性仅适用于部署在多个位置的 Api 管理服务。 这可用于禁用主区域中的网关。

disableGateway?: boolean

属性值

boolean

enableClientCertificate

仅用于消耗 SKU 服务的属性。 这会强制在向网关的每个请求上显示客户端证书。 这样，便可以在网关上的策略中对证书进行身份验证。

enableClientCertificate?: boolean

属性值

boolean

etag

资源的 ETag。 注意：此属性不会序列化。 它只能由服务器填充。

etag?: string

属性值

string

gatewayRegionalUrl

默认区域中 API 管理服务的网关 URL。 注意：此属性不会序列化。 它只能由服务器填充。

gatewayRegionalUrl?: string

属性值

string

gatewayUrl

API 管理服务的网关 URL。 注意：此属性不会序列化。 它只能由服务器填充。

gatewayUrl?: string

属性值

string

hostnameConfigurations

API 管理服务的自定义主机名配置。

hostnameConfigurations?: HostnameConfiguration[]

属性值

HostnameConfiguration[]

identity

Api 管理服务的托管服务标识。

identity?: ApiManagementServiceIdentity

属性值

ApiManagementServiceIdentity

location

资源位置。

location: string

属性值

string

managementApiUrl

API 管理服务的管理 API 终结点 URL。 注意：此属性不会序列化。 它只能由服务器填充。

managementApiUrl?: string

属性值

string

natGatewayState

属性可用于为此 API 管理服务启用 NAT 网关。

natGatewayState?: string

属性值

string

notificationSenderEmail

将从中发送通知的电子邮件地址。

notificationSenderEmail?: string

属性值

string

outboundPublicIPAddresses

与 NAT 网关部署的服务关联的出站公共 IPV4 地址前缀。 仅适用于 stv2 平台上的高级 SKU。 注意：此属性不会序列化。 它只能由服务器填充。

outboundPublicIPAddresses?: string[]

属性值

string[]

platformVersion

在此位置运行服务的计算平台版本。 注意：此属性不会序列化。 它只能由服务器填充。

platformVersion?: string

属性值

string

portalUrl

API 管理服务的发布者门户终结点 URL。 注意：此属性不会序列化。 它只能由服务器填充。

portalUrl?: string

属性值

string

privateEndpointConnections

此服务的专用终结点连接列表。

privateEndpointConnections?: RemotePrivateEndpointConnectionWrapper[]

属性值

RemotePrivateEndpointConnectionWrapper[]

privateIPAddresses

主要区域中部署在内部虚拟网络中的 API 管理服务的专用静态负载均衡 IP 地址。 仅适用于基本、标准、高级和独立 SKU。 注意：此属性不会序列化。 它只能由服务器填充。

privateIPAddresses?: string[]

属性值

string[]

provisioningState

API 管理服务的当前预配状态，可以是下列项之一：Created/Activating/Succeeded/Updateing/Failed/Stopped/Terminating/TerminationFailed/Deleted。 注意：此属性不会序列化。 它只能由服务器填充。

provisioningState?: string

属性值

string

publicIPAddresses

主要区域中 API 管理服务的公共静态负载均衡 IP 地址。 仅适用于基本、标准、高级和独立 SKU。 注意：此属性不会序列化。 它只能由服务器填充。

publicIPAddresses?: string[]

属性值

string[]

publicIpAddressId

要与区域中部署的虚拟网络服务关联的基于公共标准 SKU IP V4 的 IP 地址。 仅支持在虚拟网络中部署开发人员和高级 SKU。

publicIpAddressId?: string

属性值

string

publicNetworkAccess

是否允许此 API 管理服务访问公共终结点。 值是可选的，但如果传入，则必须为“Enabled”或“Disabled”。 如果为“Disabled”，则专用终结点是独占访问方法。 默认值为“Enabled”

publicNetworkAccess?: string

属性值

string

publisherEmail

发布者电子邮件。

publisherEmail: string

属性值

string

publisherName

发布者名称。

publisherName: string

属性值

string

restore

取消删除 Api 管理服务（如果以前是软删除的）。 如果指定了此标志并设置为 True，将忽略所有其他属性。

restore?: boolean

属性值

boolean

scmUrl

API 管理服务的 SCM 终结点 URL。 注意：此属性不会序列化。 它只能由服务器填充。

scmUrl?: string

属性值

string

sku

API 管理服务的 SKU 属性。

sku: ApiManagementServiceSkuProperties

属性值

ApiManagementServiceSkuProperties

systemData

与创建和上次修改资源相关的元数据。 注意：此属性不会序列化。 它只能由服务器填充。

systemData?: SystemData

属性值

SystemData

targetProvisioningState

API 管理服务的预配状态，该服务以长时间运行的作为目标。 注意：此属性不会序列化。 它只能由服务器填充。

targetProvisioningState?: string

属性值

string

virtualNetworkConfiguration

API 管理服务的虚拟网络配置。

virtualNetworkConfiguration?: VirtualNetworkConfiguration

属性值

VirtualNetworkConfiguration

virtualNetworkType

需要在其中配置 API 管理服务的 VPN 类型。 无（默认值）表示 API 管理服务不是任何虚拟网络的一部分，外部意味着 API 管理部署是在具有面向 Internet 的终结点的虚拟网络内设置的，内部意味着 API 管理部署仅在具有 Intranet 面向终结点的虚拟网络中进行设置。

virtualNetworkType?: string

属性值

string

zones

一个可用性区域列表，表示资源需要来自何处。

zones?: string[]

属性值

string[]

继承属性详细信息

id

资源 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