Api Management Service - Refresh Hostnames

服務:

API Management

API 版本:

2025-09-01-preview

強制刷新附加於自訂主機名稱的 SSL 憑證，該憑證是透過 Api Management 服務的 Secret 來自 KeyVault 設定的。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/refreshHostnames?api-version=2025-09-01-preview

URI 參數

名稱	位於	必要	類型	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	資源群組的名稱。 名稱不區分大小寫。
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	API 管理服務的名稱。
subscriptionId	path	True	string minLength: 1	目標訂用帳戶的標識碼。
api-version	query	True	string minLength: 1	用於此作業的 API 版本。

回應

名稱	類型	Description
200 OK	ApiManagementServiceResource	Azure 運作順利完成。
202 Accepted		已接受資源作業。 標題 Retry-After: integer location: string
Other Status Codes	ErrorResponse	未預期的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

ApiManagementServiceRefreshKeyVaultHostnames

範例要求

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/refreshHostnames?api-version=2025-09-01-preview

範例回覆

狀態碼:

200

{
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "etag": "AAAAAAK5GpM=",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "identity": {
    "type": "SystemAssigned",
    "principalId": "b413456e-a9c8-4242-9754-0a01c061bd41",
    "tenantId": "b413456e-a9c8-4242-9754-0a01c061bd41"
  },
  "location": "West Europe",
  "properties": {
    "additionalLocations": [
      {
        "disableGateway": false,
        "gatewayRegionalUrl": "https://apimService1-northeurope-01.regional.azure-api.net",
        "location": "North Europe",
        "outboundPublicIPAddresses": [
          "4.xxx.40.176"
        ],
        "platformVersion": "stv2",
        "publicIPAddresses": [
          "4.xxx.40.176"
        ],
        "sku": {
          "name": "Premium",
          "capacity": 1
        },
        "virtualNetworkConfiguration": {
          "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/apimVnet/subnets/default2"
        }
      }
    ],
    "createdAtUtc": "2016-04-12T00:20:15.6018952Z",
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "True"
    },
    "developerPortalStatus": "Enabled",
    "developerPortalUrl": "https://apimService1.developer.azure-api.net",
    "disableGateway": false,
    "gatewayRegionalUrl": "https://apimService1-westeurope-01.regional.azure-api.net",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "certificateSource": "BuiltIn",
        "defaultSslBinding": false,
        "hostName": "apimService1.azure-api.net",
        "negotiateClientCertificate": false
      },
      {
        "type": "Proxy",
        "certificate": {
          "expiry": "2025-12-18T11:11:47+00:00",
          "subject": "CN=*.msitesting.net",
          "thumbprint": "9833D531D7A45XXXXXXXXXXXX8BD392E0BD3F"
        },
        "certificateSource": "KeyVault",
        "defaultSslBinding": true,
        "hostName": "proxy.msitesting.net",
        "keyVaultId": "https://apim-msi-keyvault.vault.azure.net/secrets/sslcertificate",
        "negotiateClientCertificate": false
      }
    ],
    "legacyPortalStatus": "Disabled",
    "managementApiUrl": "https://apimService1.management.azure-api.net",
    "natGatewayState": "Disabled",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "outboundPublicIPAddresses": [
      "57.xxx.61.xx"
    ],
    "platformVersion": "stv2.1",
    "provisioningState": "Succeeded",
    "publicIPAddresses": [
      "XX.153.XX.94"
    ],
    "publicNetworkAccess": "Enabled",
    "publisherEmail": "autorest@contoso.com",
    "publisherName": "Microsoft",
    "releaseChannel": "Default",
    "scmUrl": "https://apimService1.scm.azure-api.net",
    "virtualNetworkConfiguration": {
      "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1/subnets/default"
    },
    "virtualNetworkType": "External"
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  },
  "systemData": {
    "lastModifiedAt": "2024-06-14T17:33:34.8195595Z",
    "lastModifiedBy": "autorest@contoso.com",
    "lastModifiedByType": "User"
  },
  "tags": {}
}

狀態碼:

202

location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2025-09-01-preview

定義

名稱	Description
AdditionalLocation	其他 API 管理 資源位置的描述。
ApiManagementServiceIdentity	Api 管理 服務資源的身分識別屬性。
ApiManagementServiceResource	清單或取得回應中的單一 API 管理 服務資源。
ApiManagementServiceSkuProperties	API 管理 服務資源 SKU 屬性。
ApimIdentityType	用於資源的身分識別類型。 類型 'SystemAssigned， UserAssigned' 包含隱含建立的身分識別和一組使用者指派的身分識別。 類型 『None』 會從服務中移除任何身分識別。
ApiVersionConstraint	API 管理服務的控制平面 API 版本條件約束。
ArmIdWrapper	ARM 資源標識碼的包裝函式
CertificateConfiguration	憑證組態，由不受信任的中間憑證和根憑證組成。
CertificateConfigurationStoreName	System.Security.Cryptography.x509certificates.StoreName 證書存儲位置。 只有 Root 和 CertificateAuthority 是有效的位置。
CertificateInformation	SSL 憑證資訊。
CertificateSource	憑證來源。
CertificateStatus	憑證狀態。
ConfigurationApi	API 管理 服務的組態 API 相關資訊。
createdByType	建立資源的身分識別類型。
DeveloperPortalStatus	此 API 管理服務中的開發人員入口網站狀態。
ErrorAdditionalInfo	資源管理錯誤附加資訊。
ErrorDetail	錯誤詳細資料。
ErrorResponse	錯誤回應
HostnameConfiguration	自訂主機名稱設定。
HostnameType	主機名類型。
LegacyApiState	指示是否應該在 API 管理服務上公開舊版組態 API （v1）。 值為選擇性值，但必須是 『Enabled』 或 『Disabled』。 如果 「已停用」，舊版設定 API （v1） 將無法用於自我裝載閘道。 預設值為 'Enabled'
LegacyPortalStatus	API 管理服務中舊版入口網站的狀態。
NatGatewayState	屬性可用來啟用此 API 管理服務的 NAT 閘道。
PlatformVersion	執行服務的運算平台版本。
PrivateEndpointServiceConnectionStatus	私人端點連線狀態。
PrivateLinkServiceConnectionState	服務取用者與提供者之間連線狀態的相關信息集合。
PublicNetworkAccess	此 API 管理服務是否允許公用端點存取。 值為選擇性值，但如果傳入，則必須是 『Enabled』 或 'Disabled'。 如果為 『Disabled』，私人端點就是獨佔存取方法。 預設值為 'Enabled'
ReleaseChannel	此 API 管理 服務的發行通道。
RemotePrivateEndpointConnectionWrapper	遠端私人端點連線資源。
SkuType	Sku 的名稱。
systemData	與建立和上次修改資源相關的元數據。
UserIdentityProperties
VirtualNetworkConfiguration	部署 API 管理 服務的虛擬網路的設定。
VirtualNetworkType	API 管理閘道必須在其中設定的 VPN 類型。

AdditionalLocation

Object

其他 API 管理 資源位置的描述。

名稱	類型	預設值	Description
disableGateway	boolean	False	屬性僅適用於部署在多個位置的 Api 管理服務。 這可用來停用此額外位置中的閘道。
gatewayRegionalUrl	string		區域中 API 管理 服務的閘道 URL。
location	string		Azure 資料中心區域之間其他區域的位置名稱。
natGatewayState	NatGatewayState	Disabled	屬性可用來啟用此 API 管理服務的 NAT 閘道。
outboundPublicIPAddresses	string[]		與 NAT 閘道部署服務相關聯的輸出公用 IPV4 位址前置詞。 僅適用於 stv2 平台上的進階 SKU。
platformVersion	PlatformVersion		執行服務的運算平台版本。
privateIPAddresses	string[]		部署在特定額外位置的內部虛擬網路中的 API 管理 服務的私人靜態負載平衡 IP 位址。 僅適用於基本、標準、進階和隔離 SKU。
publicIPAddresses	string[]		其他位置中 API 管理 服務的公用靜態負載平衡 IP 位址。 僅適用於基本、標準、進階和隔離 SKU。
publicIpAddressId	string		要與位置中部署的虛擬網路服務相關聯的公用標準 SKU IP V4 型 IP 位址。 僅支援虛擬網路中部署的進階 SKU。
sku	ApiManagementServiceSkuProperties		API 管理服務的 SKU 屬性。
virtualNetworkConfiguration	VirtualNetworkConfiguration		位置的虛擬網路組態。
zones	string[]		可用性區域清單，表示資源需要來自何處。

ApiManagementServiceIdentity

Object

Api 管理 服務資源的身分識別屬性。

名稱	類型	Description
principalId	string (uuid)	身分識別的主體標識碼。
tenantId	string (uuid)	身分識別的用戶端租用戶標識碼。
type	ApimIdentityType	用於資源的身分識別類型。 類型 'SystemAssigned， UserAssigned' 包含隱含建立的身分識別和一組使用者指派的身分識別。 類型 『None』 會從服務中移除任何身分識別。
userAssignedIdentities	<string,  UserIdentityProperties>	與資源相關聯的使用者身分識別清單。 使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。

ApiManagementServiceResource

Object

清單或取得回應中的單一 API 管理 服務資源。

名稱	類型	預設值	Description
etag	string		資源的 ETag。
id	string		資源的完整資源標識碼。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ApiManagementServiceIdentity		Api 管理服務的受控服務識別。
location	string		資源所在的地理位置
name	string		資源的名稱
properties.additionalLocations	AdditionalLocation[]		API 管理服務的其他數據中心位置。
properties.apiVersionConstraint	ApiVersionConstraint		API 管理服務的控制平面 API 版本條件約束。
properties.certificates	CertificateConfiguration[]		需要在 API 管理服務中安裝的憑證清單。 可安裝的憑證數目上限為 10。
properties.configurationApi	ConfigurationApi		設定 API 管理服務的 API 組態。
properties.createdAtUtc	string (date-time)		API 管理服務的建立 UTC 日期。日期符合以下格式： yyyy-MM-ddTHH:mm:ssZ 根據 ISO 8601 標準的規定。
properties.customProperties	object		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
properties.developerPortalStatus	DeveloperPortalStatus	Enabled	此 API 管理服務中的開發人員入口網站狀態。
properties.developerPortalUrl	string		API 管理服務的 DEveloper 入口網站端點 URL。
properties.disableGateway	boolean	False	屬性僅適用於部署在多個位置的 Api 管理服務。 這可用來停用主要區域中的閘道。
properties.enableClientCertificate	boolean	False	屬性僅供取用 SKU 服務使用。 這會強制在閘道的每個要求上顯示客戶端憑證。 這也可讓您在閘道的原則中驗證憑證。
properties.gatewayRegionalUrl	string		預設區域中 API 管理 服務的閘道 URL。
properties.gatewayUrl	string		API 管理 服務的閘道 URL。
properties.hostnameConfigurations	HostnameConfiguration[]		API 管理服務的自定義主機名組態。
properties.legacyPortalStatus	LegacyPortalStatus	Enabled	API 管理服務中舊版入口網站的狀態。
properties.managementApiUrl	string		API 管理服務的管理 API 端點 URL。
properties.natGatewayState	NatGatewayState	Disabled	屬性可用來啟用此 API 管理服務的 NAT 閘道。
properties.notificationSenderEmail	string maxLength: 100		將傳送通知的電子郵件位址。
properties.outboundPublicIPAddresses	string[]		與 NAT 閘道部署服務相關聯的輸出公用 IPV4 位址前置詞。 僅適用於 stv2 平台上的進階 SKU。
properties.platformVersion	PlatformVersion		在此位置執行服務的運算平台版本。
properties.portalUrl	string		發行者入口網站端點 API 管理 服務的 URL。
properties.privateEndpointConnections	RemotePrivateEndpointConnectionWrapper[]		此服務的私人端點連線清單。
properties.privateIPAddresses	string[]		主要區域中部署在內部虛擬網路中的主要區域中 API 管理服務的私人靜態負載平衡 IP 位址。 僅適用於基本、標準、進階和隔離 SKU。
properties.provisioningState	string		API 管理服務的目前布建狀態，可以是下列其中一項：建立/啟用/成功/更新/失敗/停止/終止/終止/終止失敗/刪除。
properties.publicIPAddresses	string[]		主要區域中 API 管理 服務的公用靜態負載平衡 IP 位址。 僅適用於基本、標準、進階和隔離 SKU。
properties.publicIpAddressId	string		要與區域中部署的虛擬網路服務相關聯的公用標準 SKU IP V4 型 IP 位址。 僅支援虛擬網路中部署的開發人員和進階 SKU。
properties.publicNetworkAccess	PublicNetworkAccess		此 API 管理服務是否允許公用端點存取。 值為選擇性值，但如果傳入，則必須是 『Enabled』 或 'Disabled'。 如果為 『Disabled』，私人端點就是獨佔存取方法。 預設值為 'Enabled'
properties.publisherEmail	string maxLength: 100		發行者電子郵件。
properties.publisherName	string maxLength: 100		發行者名稱。
properties.releaseChannel	ReleaseChannel		此 API 管理 服務的發行通道。
properties.restore	boolean	False	如果先前已虛刪除，請取消刪除 Api 管理服務。 如果指定此旗標，並將 設定為 True，則會忽略所有其他屬性。
properties.scmUrl	string		API 管理服務的 SCM 端點 URL。
properties.targetProvisioningState	string		API 管理 服務的布建狀態，其目標是由在服務上啟動的長時間執行作業所針對。
properties.virtualNetworkConfiguration	VirtualNetworkConfiguration		API 管理服務的虛擬網路組態。
properties.virtualNetworkType	VirtualNetworkType	None	必須在其中設定 API 管理服務的 VPN 類型。 無 （預設值） 表示 API 管理服務不屬於任何虛擬網路，外部表示 API 管理部署是在具有因特網面向端點的虛擬網路內設定，而內部表示 API 管理部署只會在具有內部網路對向端點的虛擬網路內進行設定。
properties.zoneRedundant	boolean	False	建立 StandardV2 和 PremiumV2 時的區域冗餘需求。 若此旗標設為 True，則會回傳帶有區域冗餘的 APIM 服務;若底層元件無法具備區域冗餘，則請求失敗。
sku	ApiManagementServiceSkuProperties		API 管理服務的 SKU 屬性。
systemData	systemData		包含 createdBy 和 modifiedBy 資訊的 Azure Resource Manager 元數據。
tags	object		資源標籤。
type	string		資源的類型。 例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”
zones	string[]		可用性區域。

ApiManagementServiceSkuProperties

Object

API 管理 服務資源 SKU 屬性。

名稱	類型	Description
capacity	integer (int32)	SKU 的容量（SKU 的部署單位數目）。 針對 [取用 SKU 容量] 必須指定為 0。
name	SkuType	Sku 的名稱。

ApimIdentityType

列舉型別

用於資源的身分識別類型。 類型 'SystemAssigned， UserAssigned' 包含隱含建立的身分識別和一組使用者指派的身分識別。 類型 『None』 會從服務中移除任何身分識別。

值	Description
SystemAssigned
UserAssigned
SystemAssigned, UserAssigned
None

ApiVersionConstraint

Object

API 管理服務的控制平面 API 版本條件約束。

名稱	類型	Description
minApiVersion	string	限制對 API 管理服務的控制平面 API 呼叫，其版本等於或大於此值。

ArmIdWrapper

Object

ARM 資源標識碼的包裝函式

名稱	類型	Description
id	string

CertificateConfiguration

Object

憑證組態，由不受信任的中間憑證和根憑證組成。

名稱	類型	Description
certificate	CertificateInformation	憑證資訊。
certificatePassword	string	憑證密碼。
encodedCertificate	string	Base64 編碼憑證。
storeName	CertificateConfigurationStoreName	System.Security.Cryptography.x509certificates.StoreName 證書存儲位置。 只有 Root 和 CertificateAuthority 是有效的位置。

CertificateConfigurationStoreName

列舉型別

System.Security.Cryptography.x509certificates.StoreName 證書存儲位置。 只有 Root 和 CertificateAuthority 是有效的位置。

值	Description
CertificateAuthority
Root

CertificateInformation

Object

SSL 憑證資訊。

名稱	類型	Description
expiry	string (date-time)	憑證的到期日。 日期符合下列格式：yyyy-MM-ddTHH:mm:ssZ ISO 8601 標準所指定。
subject	string	憑證的主體。
thumbprint	string	憑證的指紋。

CertificateSource

列舉型別

憑證來源。

值	Description
Managed
KeyVault
Custom
BuiltIn

CertificateStatus

列舉型別

憑證狀態。

值	Description
Completed
Failed
InProgress

ConfigurationApi

Object

API 管理 服務的組態 API 相關資訊。

名稱	類型	預設值	Description
legacyApi	LegacyApiState	Enabled	指示是否應該在 API 管理服務上公開舊版組態 API （v1）。 值為選擇性值，但必須是 『Enabled』 或 『Disabled』。 如果 「已停用」，舊版設定 API （v1） 將無法用於自我裝載閘道。 預設值為 'Enabled'

createdByType

列舉型別

建立資源的身分識別類型。

值	Description
User
Application
ManagedIdentity
Key

DeveloperPortalStatus

列舉型別

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

值	Description
Enabled	已針對服務啟用開發人員入口網站。
Disabled	已停用服務的開發人員入口網站。

ErrorAdditionalInfo

Object

資源管理錯誤附加資訊。

名稱	類型	Description
info	object	附加資訊。
type	string	其他資訊類型。

ErrorDetail

Object

錯誤詳細資料。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤附加資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳情
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

Object

錯誤回應

名稱	類型	Description
error	ErrorDetail	錯誤物件。

HostnameConfiguration

Object

自訂主機名稱設定。

名稱	類型	預設值	Description
certificate	CertificateInformation		憑證資訊。
certificatePassword	string		憑證密碼。
certificateSource	CertificateSource		憑證來源。
certificateStatus	CertificateStatus		憑證狀態。
defaultSslBinding	boolean	False	指定 true，將與此主機名相關聯的憑證設定為預設 SSL 憑證。 如果用戶端未傳送 SNI 標頭，則這會是將會受到挑戰的憑證。 如果服務已啟用多個自定義主機名，且必須決定預設ssl憑證，則屬性會很有用。 僅套用至閘道主機名稱類型的設定。
encodedCertificate	string		Base64 編碼憑證。
hostName	string		在 Api 管理服務上設定的主機名。
identityClientId	string		Azure AD 所產生的系統或使用者指派受控識別 clientId，其具有包含 SSL 憑證之 keyVault 的 GET 存取權。
keyVaultId	string		包含 Ssl 憑證之 KeyVault 秘密的 URL。 如果提供包含版本的絕對 URL，SSL 憑證的自動更新將無法運作。 這需要使用 aka.ms/apimmsi 來設定 Api 管理服務。 秘密的類型應 為 application/x-pkcs12
negotiateClientCertificate	boolean	False	指定 true 以一律交涉主機名上的客戶端憑證。 默認值為 false。
type	HostnameType		主機名類型。

HostnameType

列舉型別

主機名類型。

值	Description
Proxy
Portal
Management
Scm
DeveloperPortal
ConfigurationApi

LegacyApiState

列舉型別

指示是否應該在 API 管理服務上公開舊版組態 API （v1）。 值為選擇性值，但必須是 『Enabled』 或 『Disabled』。 如果 「已停用」，舊版設定 API （v1） 將無法用於自我裝載閘道。 預設值為 'Enabled'

值	Description
Enabled	已為服務啟用舊版組態 API （v1），且自我裝載閘道可以連線到它。
Disabled	服務已停用舊版組態 API （v1），且自我裝載閘道無法連線到該 API。

LegacyPortalStatus

列舉型別

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

值	Description
Enabled	已為服務啟用舊版入口網站。
Disabled	服務已停用舊版入口網站。

NatGatewayState

列舉型別

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

值	Description
Enabled	已為服務啟用 Nat 閘道。
Disabled	已停用服務的 Nat 閘道。

PlatformVersion

列舉型別

執行服務的運算平台版本。

值	Description
undetermined	無法判斷平台版本，因為未部署運算平台。
stv1	在單一租用戶 V1 平台上執行服務的平台。
stv2	在單一租用戶 V2 平台上執行服務的平台。
mtv1	在多租用戶 V1 平台上執行服務的平台。
stv2.1	在較新硬體上的單一租用戶 V2 平台上執行服務的平台。

PrivateEndpointServiceConnectionStatus

列舉型別

私人端點連線狀態。

值	Description
Pending
Approved
Rejected

PrivateLinkServiceConnectionState

Object

服務取用者與提供者之間連線狀態的相關信息集合。

名稱	類型	Description
actionsRequired	string	訊息，指出服務提供者上的變更是否需要取用者的任何更新。
description	string	核准/拒絕連線的原因。
status	PrivateEndpointServiceConnectionStatus	指出服務擁有者是否已核准/拒絕/移除連線。

PublicNetworkAccess

列舉型別

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

值	Description
Enabled
Disabled

ReleaseChannel

列舉型別

此 API 管理 服務的發行通道。

值	Description
Preview	服務的預覽頻道。
Default	服務的預設通道。
Stable	服務的穩定通道。

RemotePrivateEndpointConnectionWrapper

Object

遠端私人端點連線資源。

名稱	類型	Description
id	string	私人端點聯機資源標識碼
name	string	私人端點連線名稱
properties.groupIds	string[]	所有群組 ID。
properties.privateEndpoint	ArmIdWrapper	私人端點的資源。
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	服務取用者與提供者之間連線狀態的相關信息集合。
properties.provisioningState	string	私人端點聯機資源的布建狀態。
type	string	私人端點連線資源類型

SkuType

列舉型別

Sku 的名稱。

值	Description
Developer	Api Management 的開發人員 SKU。
Standard	API 管理的標準 SKU。
Premium	API 管理的進階 SKU。
Basic	API 管理的基本 SKU。
Consumption	Api Management 的取用 SKU。
Isolated	Api Management 的隔離 SKU。
BasicV2	Api Management 的 BasicV2 SKU。
StandardV2	StandardV2 SKU 的 API 管理。
PremiumV2	PremiumV2 API 管理的 SKU。

systemData

Object

與建立和上次修改資源相關的元數據。

名稱	類型	Description
createdAt	string (date-time)	資源建立的時間戳（UTC）。
createdBy	string	建立資源的身分識別。
createdByType	createdByType	建立資源的身分識別類型。
lastModifiedAt	string (date-time)	上次修改的資源時間戳 （UTC）
lastModifiedBy	string	上次修改資源的身分識別。
lastModifiedByType	createdByType	上次修改資源的身分識別類型。

UserIdentityProperties

Object

名稱	類型	Description
clientId	string	使用者指派身分識別的用戶端標識碼。
principalId	string	使用者指派身分識別的主體標識碼。

VirtualNetworkConfiguration

Object

部署 API 管理 服務的虛擬網路的設定。

名稱	類型	Description
subnetResourceId	string pattern: ^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$	虛擬網路中要部署 API 管理服務之子網的完整資源識別碼。
subnetname	string	子網路的名稱。
vnetid	string	虛擬網路識別碼。 這通常是 GUID。 預設預期 Null GUID。

VirtualNetworkType

列舉型別

API 管理閘道必須在其中設定的 VPN 類型。

值	Description
None	API 管理 閘道不是任何虛擬網路的一部分。
External	API 管理 閘道是虛擬網路的一部分，可從因特網存取。
Internal	API 管理 閘道是虛擬網路的一部分，而且只能從虛擬網路內存取。