共用方式為

Api Management Service - Apply Network Configuration Updates

  • 參考
服務:
API Management
API 版本:
2021-08-01

匯報 虛擬網路中執行的 Microsoft.ApiManagement 資源，以挑選更新的 DNS 變更。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/applynetworkconfigurationupdates?api-version=2021-08-01

URI 參數

名稱 位於 必要 類型 Description
resourceGroupName
 path True

string

資源群組的名稱。
serviceName
 path True

string

API 管理 服務的名稱。

Regex 模式: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId
 path True

string

可唯一識別 Microsoft Azure 訂用帳戶的訂用帳戶認證。 訂用帳戶識別碼會構成每個服務呼叫 URI 的一部分。
api-version
 query True

string

要與用戶端要求搭配使用的 API 版本。

要求本文

名稱 類型 Description
location

string

要更新多區域服務的 Api 管理服務位置。 對於部署在單一區域中的服務，不需要此參數。

回應

名稱 類型 Description
200 OK

ApiManagementServiceResource

已成功在 Api 管理服務上套用網路組態更新。
202 Accepted

已接受：位置標頭包含可檢查長時間執行作業狀態的URL。
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 模擬您的用戶帳戶

範例

ApiManagementApplyNetworkConfigurationUpdates

範例要求

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/applynetworkconfigurationupdates?api-version=2021-08-01

{
  "location": "west us"
}

範例回覆

狀態碼:
202 
location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2021-08-01
狀態碼:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "UID": "52ed5986-717b-45b4-b17c-3df8db372cff"
  },
  "location": "East Asia",
  "etag": "AAAAAAAXX6Y=",
  "properties": {
    "publisherEmail": "admin@live.com",
    "publisherName": "Contoso",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2015-09-22T01:50:34.7921566Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "portalUrl": "https://apimService1.portal.azure-api.net",
    "managementApiUrl": "https://apimService1.management.azure-api.net",
    "scmUrl": "https://apimService1.scm.azure-api.net",
    "hostnameConfigurations": [],
    "publicIPAddresses": [
      "207.46.155.24"
    ],
    "virtualNetworkConfiguration": {
      "subnetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/eastUsVirtualNetwork/subnets/apimSubnet"
    },
    "virtualNetworkType": "External"
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  }
}

定義

名稱 Description
AdditionalLocation

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

提供給套用網路設定作業的參數。
ApiManagementServiceIdentity

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

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

API 管理 服務資源 SKU 屬性。
ApimIdentityType

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

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

ARM 資源標識碼的包裝函式
CertificateConfiguration

憑證組態，其中包含不受信任的中繼和跟證書。
CertificateInformation

SSL 憑證資訊。
CertificateSource

憑證來源。
CertificateStatus

憑證狀態。
createdByType

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

錯誤欄位合約。
ErrorResponse

錯誤回應。
HostnameConfiguration

自定義主機名組態。
HostnameType

主機名類型。
PlatformVersion

執行服務的計算平臺版本。
PrivateEndpointServiceConnectionStatus

私人端點連線狀態。
PrivateLinkServiceConnectionState

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

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

遠端私人端點連線資源。
SkuType

Sku 的名稱。
systemData

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

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

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

AdditionalLocation

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

名稱 類型 預設值 Description
disableGateway

boolean

False

屬性僅適用於部署在多個位置的 Api 管理服務。 這可用來停用此額外位置中的閘道。
gatewayRegionalUrl

string

區域中 API 管理 服務的閘道 URL。
location

string

Azure 資料中心區域之間其他區域的位置名稱。
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[]

可用性區域清單，表示資源需要來自何處。

ApiManagementServiceApplyNetworkConfigurationParameters

提供給套用網路設定作業的參數。

名稱 類型 Description
location

string

要針對多區域服務更新的 Api 管理服務位置。 對於部署在單一區域中的服務，不需要此參數。

ApiManagementServiceIdentity

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

名稱 類型 Description
principalId

string

身分識別的主體標識碼。
tenantId

string

身分識別的用戶端租用戶標識碼。
type

ApimIdentityType

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

<string,  UserIdentityProperties>

與資源相關聯的使用者身分識別清單。 使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。

ApiManagementServiceResource

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

名稱 類型 預設值 Description
etag

string

資源的 ETag。
id

string

資源識別碼。
identity

ApiManagementServiceIdentity

Api 管理服務的受控服務識別。
location

string

資源位置。
name

string

資源名稱。
properties.additionalLocations

AdditionalLocation[]

API 管理 服務的其他數據中心位置。
properties.apiVersionConstraint

ApiVersionConstraint

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

CertificateConfiguration[]

需要安裝在 API 管理 服務中的憑證清單。 可安裝的憑證上限為10。
properties.createdAtUtc

string

建立 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 以外的所有設定，預設值是 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
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.managementApiUrl

string

API 管理 服務的管理 API 端點 URL。
properties.notificationSenderEmail

string

Email將傳送通知的位址。
properties.platformVersion

PlatformVersion

在此位置執行服務的計算平臺版本。
properties.portalUrl

string

API 管理 服務的發行者入口網站端點 URL。
properties.privateEndpointConnections

RemotePrivateEndpointConnectionWrapper[]

此服務的私人端點連線清單。
properties.privateIPAddresses

string[]

主要區域中部署於內部 虛擬網路 中之 API 管理 服務的私人靜態負載平衡 IP 位址。 僅適用於基本、標準、進階和隔離 SKU。
properties.provisioningState

string

API 管理 服務的目前布建狀態，可以是下列其中一項：Create/Activating/Succeeded/Updateing/Failed/Stopped/Terminating/TerminationFailed/Deleted。
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

發行者電子郵件。
properties.publisherName

string

發行者名稱。
properties.restore

boolean

False

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

string

API 管理 服務的 SCM 端點 URL。
properties.targetProvisioningState

string

API 管理 服務的布建狀態，這是服務上啟動長時間執行作業的目標。
properties.virtualNetworkConfiguration

VirtualNetworkConfiguration

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

VirtualNetworkType

None

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

ApiManagementServiceSkuProperties

API 管理 服務的 SKU 屬性。
systemData

systemData

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

object

資源標籤。
type

string

API 管理 資源的資源類型會設定為 Microsoft.ApiManagement。
zones

string[]

可用性區域清單，指出資源需要來自何處。

ApiManagementServiceSkuProperties

API 管理 服務資源 SKU 屬性。

名稱 類型 Description
capacity

integer

SKU 的容量 (SKU) 的已部署單位數目。 針對 [使用量 SKU 容量] 必須指定為 0。
name

SkuType

Sku 的名稱。

ApimIdentityType

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

名稱 類型 Description
None

string

SystemAssigned

string

SystemAssigned, UserAssigned

string

UserAssigned

string

ApiVersionConstraint

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

名稱 類型 Description
minApiVersion

string

將控制平面 API 呼叫限制為版本等於或大於此值 API 管理 服務。

ArmIdWrapper

ARM 資源標識碼的包裝函式

名稱 類型 Description
id

string

CertificateConfiguration

憑證組態，其中包含不受信任的中繼和跟證書。

名稱 類型 Description
certificate

CertificateInformation

憑證資訊。
certificatePassword

string

憑證密碼。
encodedCertificate

string

Base64 編碼憑證。
storeName enum:
  • CertificateAuthority
  • Root

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

CertificateInformation

SSL 憑證資訊。

名稱 類型 Description
expiry

string

憑證的到期日。 日期符合下列格式： yyyy-MM-ddTHH:mm:ssZ 如 ISO 8601 標準所指定。
subject

string

憑證的主體。
thumbprint

string

憑證的指紋。

CertificateSource

憑證來源。

名稱 類型 Description
BuiltIn

string

Custom

string

KeyVault

string

Managed

string

CertificateStatus

憑證狀態。

名稱 類型 Description
Completed

string

Failed

string

InProgress

string

createdByType

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

名稱 類型 Description
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorFieldContract

錯誤欄位合約。

名稱 類型 Description
code

string

屬性層級錯誤碼。
message

string

人類可讀取的屬性層級錯誤表示法。
target

string

屬性名稱。

ErrorResponse

錯誤回應。

名稱 類型 Description
error.code

string

服務定義的錯誤碼。 此代碼會作為回應中指定之 HTTP 錯誤碼的子狀態。
error.details

ErrorFieldContract[]

要求中傳送無效欄位的清單，以防發生驗證錯誤。
error.message

string

人類可閱讀的錯誤表示法。

HostnameConfiguration

自定義主機名組態。

名稱 類型 預設值 Description
certificate

CertificateInformation

憑證資訊。
certificatePassword

string

憑證密碼。
certificateSource

CertificateSource

憑證來源。
certificateStatus

CertificateStatus

憑證狀態。
defaultSslBinding

boolean

False

指定 true，將與此主機名相關聯的憑證設定為預設 SSL 憑證。 如果用戶端未傳送 SNI 標頭，則這會是將會受到挑戰的憑證。 如果服務已啟用多個自定義主機名，而且必須決定預設 SSL 憑證，則此屬性很有用。 僅套用至 Proxy 主機名類型的設定。
encodedCertificate

string

Base64 編碼的憑證。
hostName

string

在 Api 管理服務上設定的主機名。
identityClientId

string

系統或使用者指派的受控識別 clientId，由 Azure AD 產生，可存取包含 SSL 憑證的 keyVault。
keyVaultId

string

包含 Ssl 憑證的 KeyVault 秘密 URL。 如果提供包含版本的絕對 URL，則 SSL 憑證的自動更新將無法運作。 這需要使用 aka.ms/apimmsi 來設定 Api 管理服務。 秘密的類型應該是 application/x-pkcs12
negotiateClientCertificate

boolean

False

指定 true 以一律在主機名上交涉客戶端憑證。 默認值為 false。
type

HostnameType

主機名類型。

HostnameType

主機名類型。

名稱 類型 Description
DeveloperPortal

string

Management

string

Portal

string

Proxy

string

Scm

string

PlatformVersion

執行服務的計算平臺版本。

名稱 類型 Description
mtv1

string

在多租使用者 V1 平台上執行服務的平臺。
stv1

string

在單一租使用者 V1 平台上執行服務的平臺。
stv2

string

在單一租使用者 V2 平台上執行服務的平臺。
undetermined

string

無法判斷平臺版本，因為未部署計算平臺。

PrivateEndpointServiceConnectionStatus

私人端點連線狀態。

名稱 類型 Description
Approved

string

Pending

string

Rejected

string

PrivateLinkServiceConnectionState

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

名稱 類型 Description
actionsRequired

string

訊息，指出服務提供者上的變更是否需要在取用者上進行任何更新。
description

string

連接核准/拒絕的原因。
status

PrivateEndpointServiceConnectionStatus

指出服務擁有者是否已核准/拒絕/移除連線。

PublicNetworkAccess

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

名稱 類型 Description
Disabled

string

Enabled

string

RemotePrivateEndpointConnectionWrapper

遠端私人端點連線資源。

名稱 類型 Description
id

string

私人端點聯機資源標識碼
name

string

私人端點連線名稱
properties.groupIds

string[]

所有群組標識碼。
properties.privateEndpoint

ArmIdWrapper

私人端點的資源。
properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

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

string

私人端點聯機資源的布建狀態。
type

string

私人端點連線資源類型

SkuType

Sku 的名稱。

名稱 類型 Description
Basic

string

API 管理的基本 SKU。
Consumption

string

API 管理的取用 SKU。
Developer

string

Api 管理的開發人員 SKU。
Isolated

string

Api 管理的隔離 SKU。
Premium

string

Api 管理的進階 SKU。
Standard

string

Api 管理的標準 SKU。

systemData

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

名稱 類型 Description
createdAt

string

資源建立的時間戳 (UTC) 。
createdBy

string

建立資源的身分識別。
createdByType

createdByType

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

string

上次修改的資源時間戳 (UTC)

lastModifiedBy

string

上次修改資源的身分識別。
lastModifiedByType

createdByType

上次修改資源的身分識別類型。

UserIdentityProperties

名稱 類型 Description
clientId

string

使用者指派身分識別的用戶端標識碼。
principalId

string

使用者指派身分識別的主體標識碼。

VirtualNetworkConfiguration

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

名稱 類型 Description
subnetResourceId

string

虛擬網路中要部署 API 管理 服務之子網的完整資源標識符。
subnetname

string

子網路的名稱。
vnetid

string

虛擬網路識別碼。 這通常是 GUID。 預設會預期 Null GUID。

VirtualNetworkType

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

名稱 類型 Description
External

string

此服務是 虛擬網路的一部分，可從因特網存取。
Internal

string

此服務是 虛擬網路的一部分，而且只能從虛擬網路記憶體取。
None

string

此服務不是任何 虛擬網路的一部分。