ApiManagementServiceResource interface

套件:

@azure/arm-apimanagement

List 或 Get 回應中的單一 API 管理服務資源。

Extends

ApimResource

屬性

additionalLocations	API 管理服務的其他數據中心位置。
apiVersionConstraint	API 管理服務的控制平面 API 版本條件約束。
certificates	需要在 API 管理服務中安裝的憑證清單。 可安裝的憑證數目上限為 10。
configurationApi	設定 API 管理服務的 API 組態。
createdAtUtc	建立 API 管理服務的 UTC 日期。日期符合下列格式：yyyy-MM-ddTHH:mm:ssZ ISO 8601 標準所指定。 注意：這個屬性不會串行化。 它只能由伺服器填入。
customProperties	API 管理服務的自定義屬性。 設定 Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 會停用所有 TLS 的加密TLS_RSA_WITH_3DES_EDE_CBC_SHA（1.0、1.1 和 1.2）。 設定 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
developerPortalStatus	此 API 管理服務中的開發人員入口網站狀態。
developerPortalUrl	API 管理服務的 DEveloper 入口網站端點 URL。 注意：這個屬性不會串行化。 它只能由伺服器填入。
disableGateway	屬性僅適用於部署在多個位置的 Api 管理服務。 這可用來停用主要區域中的閘道。
enableClientCertificate	屬性僅供取用 SKU 服務使用。 這會強制在閘道的每個要求上顯示客戶端憑證。 這也可讓您在閘道的原則中驗證憑證。
etag	資源的 ETag。 注意：這個屬性不會串行化。 它只能由伺服器填入。
gatewayRegionalUrl	默認區域中 API 管理服務的閘道 URL。 注意：這個屬性不會串行化。 它只能由伺服器填入。
gatewayUrl	API 管理服務的閘道 URL。 注意：這個屬性不會串行化。 它只能由伺服器填入。
hostnameConfigurations	API 管理服務的自定義主機名組態。
identity	Api 管理服務的受控服務識別。
legacyPortalStatus	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 管理部署是在具有因特網面向端點的虛擬網路內設定，而內部表示 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[]

configurationApi

設定 API 管理服務的 API 組態。

configurationApi?: ConfigurationApi

屬性值

ConfigurationApi

createdAtUtc

建立 API 管理服務的 UTC 日期。日期符合下列格式：yyyy-MM-ddTHH:mm:ssZ ISO 8601 標準所指定。 注意：這個屬性不會串行化。 它只能由伺服器填入。

createdAtUtc?: Date

屬性值

Date

customProperties

API 管理服務的自定義屬性。
設定 Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 會停用所有 TLS 的加密TLS_RSA_WITH_3DES_EDE_CBC_SHA（1.0、1.1 和 1.2）。
設定 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}

developerPortalStatus

此 API 管理服務中的開發人員入口網站狀態。

developerPortalStatus?: 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

legacyPortalStatus

API 管理服務中舊版入口網站的狀態。

legacyPortalStatus?: string

屬性值

string

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 管理部署是在具有因特網面向端點的虛擬網路內設定，而內部表示 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