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 (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 以外的所有設定，預設值是 True 如果服務是在 2018 False 年 4 月 1 日或之前建立，否則為 。 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_SHA256false 。 預設值為 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 服務使用。 這會強制執行用戶端憑證，以針對閘道的每個要求呈現。 這也可讓您在閘道的原則中驗證憑證。
gatewayRegionalUrl	預設區域中API 管理服務的閘道 URL。 注意：此屬性不會序列化。 它只能由伺服器填入。
gatewayUrl	API 管理服務的閘道 URL。 注意：此屬性不會序列化。 它只能由伺服器填入。
hostnameConfigurations	API 管理服務的自訂主機名稱組態。
managementApiUrl	API 管理服務的管理 API 端點 URL。 注意：此屬性不會序列化。 它只能由伺服器填入。
natGatewayState	屬性可用來啟用此API 管理服務的 NAT 閘道。
notificationSenderEmail	Email將傳送通知的位址。
outboundPublicIPAddresses	與 NAT 閘道部署服務相關聯的輸出公用 IPV4 位址前置詞。 僅適用于 stv2 平臺上的進階 SKU。 注意：此屬性不會序列化。 它只能由伺服器填入。
platformVersion	在此位置執行服務的計算平臺版本。 注意：此屬性不會序列化。 它只能由伺服器填入。
portalUrl	API 管理服務的發行者入口網站端點 URL。 注意：此屬性不會序列化。 它只能由伺服器填入。
privateEndpointConnections	此服務的私人端點連線清單。
privateIPAddresses	主要區域中部署于內部虛擬網路中API 管理服務的私人靜態負載平衡 IP 位址。 僅適用于基本、標準、進階和隔離 SKU。 注意：此屬性不會序列化。 它只能由伺服器填入。
provisioningState	API 管理服務的目前布建狀態，可以是下列其中一項：Created/Activating/Succeeded/Updateing/Failed/Stopped/Terminating/TerminationingFailed/Deleted。 注意：此屬性不會序列化。 它只能由伺服器填入。
publicIPAddresses	主要區域中API 管理服務的公用靜態負載平衡 IP 位址。 僅適用于基本、標準、進階和隔離 SKU。 注意：此屬性不會序列化。 它只能由伺服器填入。
publicIpAddressId	要與區域中已部署虛擬網路服務相關聯的公用標準 SKU IP V4 型 IP 位址。 僅支援部署在 虛擬網路 中的開發人員和進階 SKU。
publicNetworkAccess	此API 管理服務是否允許公用端點存取。 值是選擇性的，但如果傳入，則必須是 'Enabled' 或 'Disabled'。 如果 「已停用」，私人端點就是獨佔存取方法。 預設值為 'Enabled'
restore	如果先前已虛刪除 Api Management Service，請將其取消刪除。 如果指定此旗標，並將設定為 True，則會忽略所有其他屬性。
scmUrl	API 管理服務的 SCM 端點 URL。 注意：此屬性不會序列化。 它只能由伺服器填入。
targetProvisioningState	API 管理服務的布建狀態，這是服務上啟動長時間執行作業的目標。 注意：此屬性不會序列化。 它只能由伺服器填入。
virtualNetworkConfiguration	API 管理服務的虛擬網路組態。
virtualNetworkType	需要在其中設定API 管理服務的 VPN 類型。 無 (預設值) 表示API 管理服務不屬於任何虛擬網路，外部表示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 (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 以外的所有設定，預設值是 True 如果服務是在 2018 False 年 4 月 1 日或之前建立，否則為 。 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_SHA256false 。 預設值為 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

gatewayRegionalUrl

預設區域中API 管理服務的閘道 URL。 注意：此屬性不會序列化。 它只能由伺服器填入。

gatewayRegionalUrl?: string

屬性值

string

gatewayUrl

API 管理服務的閘道 URL。 注意：此屬性不會序列化。 它只能由伺服器填入。

gatewayUrl?: string

屬性值

string

hostnameConfigurations

API 管理服務的自訂主機名稱組態。

hostnameConfigurations?: HostnameConfiguration[]

屬性值

HostnameConfiguration[]

managementApiUrl

API 管理服務的管理 API 端點 URL。 注意：此屬性不會序列化。 它只能由伺服器填入。

managementApiUrl?: string

屬性值

string

natGatewayState

屬性可用來啟用此API 管理服務的 NAT 閘道。

natGatewayState?: string

屬性值

string

notificationSenderEmail

Email將傳送通知的位址。

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/TerminationingFailed/Deleted。 注意：此屬性不會序列化。 它只能由伺服器填入。

provisioningState?: string

屬性值

string

publicIPAddresses

主要區域中API 管理服務的公用靜態負載平衡 IP 位址。 僅適用于基本、標準、進階和隔離 SKU。 注意：此屬性不會序列化。 它只能由伺服器填入。

publicIPAddresses?: string[]

屬性值

string[]

publicIpAddressId

要與區域中已部署虛擬網路服務相關聯的公用標準 SKU IP V4 型 IP 位址。 僅支援部署在 虛擬網路 中的開發人員和進階 SKU。

publicIpAddressId?: string

屬性值

string

publicNetworkAccess

此API 管理服務是否允許公用端點存取。 值是選擇性的，但如果傳入，則必須是 'Enabled' 或 'Disabled'。 如果 「已停用」，私人端點就是獨佔存取方法。 預設值為 'Enabled'

publicNetworkAccess?: string

屬性值

string

restore

如果先前已虛刪除 Api Management Service，請將其取消刪除。 如果指定此旗標，並將設定為 True，則會忽略所有其他屬性。

restore?: boolean

屬性值

boolean

scmUrl

API 管理服務的 SCM 端點 URL。 注意：此屬性不會序列化。 它只能由伺服器填入。

scmUrl?: string

屬性值

string

targetProvisioningState

API 管理服務的布建狀態，這是服務上啟動長時間執行作業的目標。 注意：此屬性不會序列化。 它只能由伺服器填入。

targetProvisioningState?: string

屬性值

string

virtualNetworkConfiguration

API 管理服務的虛擬網路組態。

virtualNetworkConfiguration?: VirtualNetworkConfiguration

屬性值

VirtualNetworkConfiguration

virtualNetworkType

需要在其中設定API 管理服務的 VPN 類型。 無 (預設值) 表示API 管理服務不屬於任何虛擬網路，外部表示API 管理部署是在具有網際網路面向端點的虛擬網路內設定，而內部表示API 管理部署只會在具有內部網路面向端點的虛擬網路內設定.

virtualNetworkType?: string

屬性值

string