ApiManagementServiceUpdateProperties interface
API 管理服務資源描述的屬性。
- Extends
屬性
publisher |
發行者電子郵件。 |
publisher |
發行者名稱。 |
繼承的屬性
additional |
API 管理服務的其他數據中心位置。 |
api |
API 管理服務的控制平面 API 版本條件約束。 |
certificates | 需要在 API 管理服務中安裝的憑證清單。 可安裝的憑證數目上限為 10。 |
created |
建立 API 管理服務的 UTC 日期。日期符合下列格式: |
custom |
API 管理服務的自定義屬性。 |
developer |
API 管理服務的 DEveloper 入口網站端點 URL。 注意:這個屬性不會串行化。 它只能由伺服器填入。 |
disable |
屬性僅適用於部署在多個位置的 Api 管理服務。 這可用來停用主要區域中的閘道。 |
enable |
屬性僅供取用 SKU 服務使用。 這會強制在閘道的每個要求上顯示客戶端憑證。 這也可讓您在閘道的原則中驗證憑證。 |
gateway |
默認區域中 API 管理服務的閘道 URL。 注意:這個屬性不會串行化。 它只能由伺服器填入。 |
gateway |
API 管理服務的閘道 URL。 注意:這個屬性不會串行化。 它只能由伺服器填入。 |
hostname |
API 管理服務的自定義主機名組態。 |
management |
API 管理服務的管理 API 端點 URL。 注意:這個屬性不會串行化。 它只能由伺服器填入。 |
nat |
屬性可用來啟用此 API 管理服務的 NAT 閘道。 |
notification |
將傳送通知的電子郵件位址。 |
outbound |
與 NAT 閘道部署服務相關聯的輸出公用 IPV4 位址前綴。 僅適用於 stv2 平臺上的進階 SKU。 注意:這個屬性不會串行化。 它只能由伺服器填入。 |
platform |
在此位置中執行服務的計算平臺版本。 注意:這個屬性不會串行化。 它只能由伺服器填入。 |
portal |
API 管理服務的發行者入口網站端點 URL。 注意:這個屬性不會串行化。 它只能由伺服器填入。 |
private |
此服務的私人端點連線清單。 |
private |
在內部虛擬網路中部署的主要區域中 API 管理服務的私人靜態負載平衡 IP 位址。 僅適用於基本、標準、進階和隔離 SKU。 注意:這個屬性不會串行化。 它只能由伺服器填入。 |
provisioning |
API 管理服務目前的布建狀態,可以是下列其中一項:Created/Activating/Succeeded/Updateing/Failed/Stopped/Terminating/TerminationFailed/Deleted。 注意:這個屬性不會串行化。 它只能由伺服器填入。 |
public |
主要區域中 API 管理服務的公用靜態負載平衡 IP 位址。 僅適用於基本、標準、進階和隔離 SKU。 注意:這個屬性不會串行化。 它只能由伺服器填入。 |
public |
要與區域中部署的虛擬網路服務相關聯的公用標準 SKU IP V4 型 IP 位址。 僅支援虛擬網路中部署的開發人員和進階 SKU。 |
public |
此 API 管理服務是否允許公用端點存取。 值為選擇性值,但如果傳入,則必須是 『Enabled』 或 'Disabled'。 如果為 『Disabled』,私人端點就是獨佔存取方法。 預設值為 'Enabled' |
restore | 如果先前已虛刪除,請取消刪除 Api 管理服務。 如果指定此旗標,並將 設定為 True,則會忽略所有其他屬性。 |
scm |
API 管理服務的 SCM 端點 URL。 注意:這個屬性不會串行化。 它只能由伺服器填入。 |
target |
API 管理服務的布建狀態,由服務上啟動的長時間執行作業為目標。 注意:這個屬性不會串行化。 它只能由伺服器填入。 |
virtual |
API 管理服務的虛擬網路組態。 |
virtual |
必須在其中設定 API 管理服務的 VPN 類型。 無 (預設值) 表示 API 管理服務不屬於任何虛擬網路,外部表示 API 管理部署是在具有因特網面向端點的虛擬網路內設定,而內部表示 API 管理部署只會在具有內部網路對向端點的虛擬網路內進行設定。 |
屬性詳細資料
publisherEmail
發行者電子郵件。
publisherEmail?: string
屬性值
string
publisherName
發行者名稱。
publisherName?: string
屬性值
string
繼承的屬性詳細資料
additionalLocations
API 管理服務的其他數據中心位置。
additionalLocations?: AdditionalLocation[]
屬性值
apiVersionConstraint
API 管理服務的控制平面 API 版本條件約束。
apiVersionConstraint?: ApiVersionConstraint
屬性值
certificates
需要在 API 管理服務中安裝的憑證清單。 可安裝的憑證數目上限為 10。
certificates?: CertificateConfiguration[]
屬性值
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}
developerPortalUrl
API 管理服務的 DEveloper 入口網站端點 URL。 注意:這個屬性不會串行化。 它只能由伺服器填入。
developerPortalUrl?: string
屬性值
string
disableGateway
屬性僅適用於部署在多個位置的 Api 管理服務。 這可用來停用主要區域中的閘道。
disableGateway?: boolean
屬性值
boolean
enableClientCertificate
屬性僅供取用 SKU 服務使用。 這會強制在閘道的每個要求上顯示客戶端憑證。 這也可讓您在閘道的原則中驗證憑證。
enableClientCertificate?: boolean
屬性值
boolean
繼承自ApiManagementServiceBaseProperties.enableClientCertificate
gatewayRegionalUrl
默認區域中 API 管理服務的閘道 URL。 注意:這個屬性不會串行化。 它只能由伺服器填入。
gatewayRegionalUrl?: string
屬性值
string
gatewayUrl
API 管理服務的閘道 URL。 注意:這個屬性不會串行化。 它只能由伺服器填入。
gatewayUrl?: string
屬性值
string
hostnameConfigurations
API 管理服務的自定義主機名組態。
hostnameConfigurations?: HostnameConfiguration[]
屬性值
繼承自ApiManagementServiceBaseProperties.hostnameConfigurations
managementApiUrl
API 管理服務的管理 API 端點 URL。 注意:這個屬性不會串行化。 它只能由伺服器填入。
managementApiUrl?: string
屬性值
string
natGatewayState
屬性可用來啟用此 API 管理服務的 NAT 閘道。
natGatewayState?: string
屬性值
string
notificationSenderEmail
將傳送通知的電子郵件位址。
notificationSenderEmail?: string
屬性值
string
繼承自ApiManagementServiceBaseProperties.notificationSenderEmail
outboundPublicIPAddresses
與 NAT 閘道部署服務相關聯的輸出公用 IPV4 位址前綴。 僅適用於 stv2 平臺上的進階 SKU。 注意:這個屬性不會串行化。 它只能由伺服器填入。
outboundPublicIPAddresses?: string[]
屬性值
string[]
繼承自ApiManagementServiceBaseProperties.outboundPublicIPAddresses
platformVersion
在此位置中執行服務的計算平臺版本。 注意:這個屬性不會串行化。 它只能由伺服器填入。
platformVersion?: string
屬性值
string
portalUrl
API 管理服務的發行者入口網站端點 URL。 注意:這個屬性不會串行化。 它只能由伺服器填入。
portalUrl?: string
屬性值
string
privateEndpointConnections
此服務的私人端點連線清單。
privateEndpointConnections?: RemotePrivateEndpointConnectionWrapper[]
屬性值
繼承自ApiManagementServiceBaseProperties.privateEndpointConnections
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
restore
如果先前已虛刪除,請取消刪除 Api 管理服務。 如果指定此旗標,並將 設定為 True,則會忽略所有其他屬性。
restore?: boolean
屬性值
boolean
scmUrl
API 管理服務的 SCM 端點 URL。 注意:這個屬性不會串行化。 它只能由伺服器填入。
scmUrl?: string
屬性值
string
targetProvisioningState
API 管理服務的布建狀態,由服務上啟動的長時間執行作業為目標。 注意:這個屬性不會串行化。 它只能由伺服器填入。
targetProvisioningState?: string
屬性值
string
繼承自ApiManagementServiceBaseProperties.targetProvisioningState
virtualNetworkConfiguration
API 管理服務的虛擬網路組態。
virtualNetworkConfiguration?: VirtualNetworkConfiguration
屬性值
繼承自ApiManagementServiceBaseProperties.virtualNetworkConfiguration
virtualNetworkType
必須在其中設定 API 管理服務的 VPN 類型。 無 (預設值) 表示 API 管理服務不屬於任何虛擬網路,外部表示 API 管理部署是在具有因特網面向端點的虛擬網路內設定,而內部表示 API 管理部署只會在具有內部網路對向端點的虛擬網路內進行設定。
virtualNetworkType?: string
屬性值
string