你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Api Management Service - MigrateToStv2
将API 管理服务升级到 Stv2 平台。 有关详细信息, https://aka.ms/apim-migrate-stv2请参阅 。 此更改不可逆。 这是长时间运行的操作,可能需要几分钟才能完成。
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/migrateToStv2?api-version=2022-08-01
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
resource
|
path | True |
string |
资源组的名称。 此名称不区分大小写。 |
service
|
path | True |
string |
API 管理服务的名称。 正则表达式模式: |
subscription
|
path | True |
string |
目标订阅的 ID。 |
api-version
|
query | True |
string |
要用于此操作的 API 版本。 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
已成功迁移服务。 |
|
202 Accepted |
已提交迁移请求。 标头 location: string |
|
Other Status Codes |
描述操作失败原因的错误响应。 |
安全性
azure_auth
Azure Active Directory OAuth2 Flow。
类型:
oauth2
流向:
implicit
授权 URL:
https://login.microsoftonline.com/common/oauth2/authorize
作用域
名称 | 说明 |
---|---|
user_impersonation | 模拟用户帐户 |
示例
ApiManagementMigrateService
示例请求
示例响应
location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2022-08-01
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimservice1",
"name": "apimservice1",
"type": "Microsoft.ApiManagement/service",
"tags": {},
"location": "West US",
"etag": "AAAAAADqC0c=",
"properties": {
"publisherEmail": "abcs@contoso.com",
"publisherName": "contoso publisher",
"notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
"provisioningState": "Succeeded",
"targetProvisioningState": "",
"createdAtUtc": "2019-12-02T01:42:09.1268424Z",
"gatewayUrl": "https://apimservice1.azure-api.net",
"gatewayRegionalUrl": "https://apimservice1-westus-01.regional.azure-api.net",
"portalUrl": "https://apimservice1.portal.azure-api.net",
"developerPortalUrl": "https://apimService1.developer.azure-api.net",
"managementApiUrl": "https://apimservice1.management.azure-api.net",
"scmUrl": "https://apimservice1.scm.azure-api.net",
"hostnameConfigurations": [
{
"type": "Proxy",
"hostName": "apimService1.azure-api.net",
"negotiateClientCertificate": false,
"defaultSslBinding": false,
"certificateSource": "BuiltIn"
},
{
"type": "Proxy",
"hostName": "apimgatewaytest.preview.net",
"negotiateClientCertificate": false,
"certificate": {
"expiry": "2019-08-16T16:51:34+00:00",
"thumbprint": "B4330123DBAXXXXXXXXX1F35E84493476",
"subject": "CN=*.preview.net"
},
"defaultSslBinding": true,
"certificateSource": "Custom"
}
],
"publicIPAddresses": [
"137.XXX.11.74"
],
"privateIPAddresses": [
"172.XX.0.5"
],
"additionalLocations": [
{
"location": "West US 2",
"sku": {
"name": "Premium",
"capacity": 1
},
"publicIPAddresses": [
"40.XXX.79.187"
],
"privateIPAddresses": [
"10.0.X.6"
],
"virtualNetworkConfiguration": {
"subnetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/APIMVNet/subnets/apim-internal-sub"
},
"gatewayRegionalUrl": "https://apimservice1-westus2-01.regional.azure-api.net",
"disableGateway": false
}
],
"virtualNetworkConfiguration": {
"subnetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/apim-appGateway-vnet/subnets/apim-subnet"
},
"customProperties": {
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "True",
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "True",
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False",
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "True",
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "True",
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "True",
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False"
},
"virtualNetworkType": "Internal",
"disableGateway": false,
"apiVersionConstraint": {},
"platformVersion": "stv1"
},
"sku": {
"name": "Premium",
"capacity": 1
}
}
定义
名称 | 说明 |
---|---|
Additional |
其他API 管理资源位置的说明。 |
Api |
Api 管理服务资源的标识属性。 |
Api |
列出或获取响应中的单个API 管理服务资源。 |
Api |
API 管理服务资源 SKU 属性。 |
Apim |
用于资源的标识类型。 类型“SystemAssigned ,UserAssigned”包含隐式创建的标识和一组用户分配的标识。 类型“None”将从服务中删除任何标识。 |
Api |
API 管理服务的控制平面 Api 版本约束。 |
Arm |
ARM 资源 ID 的包装器 |
Certificate |
由不受信任的中间文件和根证书组成的证书配置。 |
Certificate |
SSL 证书信息。 |
Certificate |
证书源。 |
Certificate |
证书状态。 |
created |
创建资源的标识类型。 |
Error |
错误字段协定。 |
Error |
错误响应。 |
Hostname |
自定义主机名配置。 |
Hostname |
主机名类型。 |
Nat |
属性可用于为此API 管理服务启用 NAT 网关。 |
Platform |
运行服务的计算平台版本。 |
Private |
专用终结点连接状态。 |
Private |
有关服务使用者与提供程序之间的连接状态的信息集合。 |
Public |
是否允许此API 管理服务访问公共终结点。 值是可选的,但如果传入,则必须为“Enabled”或“Disabled”。 如果“已禁用”,则专用终结点是独占访问方法。 默认值为“Enabled” |
Remote |
远程专用终结点连接资源。 |
Sku |
SKU 的名称。 |
system |
与资源的创建和上次修改相关的元数据。 |
User |
|
Virtual |
配置API 管理服务部署到的虚拟网络。 |
Virtual |
需要在其中配置API 管理服务的 VPN 类型。 无 (默认值) 表示API 管理服务不属于任何虚拟网络,外部意味着API 管理部署是在具有面向 Internet 的终结点的虚拟网络内设置的,而内部意味着API 管理部署是在仅具有面向 Intranet 的终结点的虚拟网络内设置的. |
AdditionalLocation
其他API 管理资源位置的说明。
名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
disableGateway |
boolean |
False |
属性仅对部署在多个位置的 Api 管理服务有效。 这可用于在此附加位置中禁用网关。 |
gatewayRegionalUrl |
string |
区域中API 管理服务的网关 URL。 |
|
location |
string |
Azure 数据中心区域之间其他区域的位置名称。 |
|
natGatewayState | Disabled |
属性可用于为此API 管理服务启用 NAT 网关。 |
|
outboundPublicIPAddresses |
string[] |
与 NAT 网关部署的服务关联的出站公共 IPV4 地址前缀。 仅适用于 stv2 平台上的高级 SKU。 |
|
platformVersion |
运行服务的计算平台版本。 |
||
privateIPAddresses |
string[] |
部署在特定附加位置的内部虚拟网络API 管理服务的专用静态负载均衡 IP 地址。 仅适用于基本、标准、高级和独立 SKU。 |
|
publicIPAddresses |
string[] |
其他位置中API 管理服务的公共静态负载均衡 IP 地址。 仅适用于基本、标准、高级和独立 SKU。 |
|
publicIpAddressId |
string |
要与位置中部署 虚拟网络的服务关联的基于公共标准 SKU IP V4 的 IP 地址。 仅支持在 虚拟网络 中部署的高级 SKU。 |
|
sku |
API 管理服务的 SKU 属性。 |
||
virtualNetworkConfiguration |
位置的虚拟网络配置。 |
||
zones |
string[] |
表示资源需要来自的可用性区域列表。 |
ApiManagementServiceIdentity
Api 管理服务资源的标识属性。
名称 | 类型 | 说明 |
---|---|---|
principalId |
string |
标识的主体 ID。 |
tenantId |
string |
标识的客户端租户 ID。 |
type |
用于资源的标识类型。 类型“SystemAssigned ,UserAssigned”包含隐式创建的标识和一组用户分配的标识。 类型“None”将从服务中删除任何标识。 |
|
userAssignedIdentities |
<string,
User |
与资源关联的用户标识列表。 用户标识字典键引用将是 ARM 资源 ID,格式为:“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 |
ApiManagementServiceResource
列出或获取响应中的单个API 管理服务资源。
名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
etag |
string |
资源的 ETag。 |
|
id |
string |
资源 ID。 |
|
identity |
Api 管理服务的托管服务标识。 |
||
location |
string |
资源位置。 |
|
name |
string |
资源名称。 |
|
properties.additionalLocations |
API 管理服务的其他数据中心位置。 |
||
properties.apiVersionConstraint |
API 管理服务的控制平面 Api 版本约束。 |
||
properties.certificates |
需要在 API 管理 服务中安装的证书列表。 可安装的最大支持证书数为 10。 |
||
properties.createdAtUtc |
string |
API 管理服务的创建 UTC 日期。日期符合以下格式: |
|
properties.customProperties |
object |
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 |
API 管理服务的自定义主机名配置。 |
||
properties.managementApiUrl |
string |
API 管理服务的管理 API 终结点 URL。 |
|
properties.natGatewayState | Disabled |
属性可用于为此API 管理服务启用 NAT 网关。 |
|
properties.notificationSenderEmail |
string |
Email发送通知的地址。 |
|
properties.outboundPublicIPAddresses |
string[] |
与 NAT 网关部署的服务关联的出站公共 IPV4 地址前缀。 仅适用于 stv2 平台上的高级 SKU。 |
|
properties.platformVersion |
在此位置运行服务的计算平台版本。 |
||
properties.portalUrl |
string |
API 管理服务的发布者门户终结点 URL。 |
|
properties.privateEndpointConnections |
此服务的专用终结点连接列表。 |
||
properties.privateIPAddresses |
string[] |
主要区域中部署在内部虚拟网络中的 API 管理 服务的专用静态负载均衡 IP 地址。 仅适用于基本、标准、高级和独立 SKU。 |
|
properties.provisioningState |
string |
API 管理服务的当前预配状态,可以是以下项之一:Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted。 |
|
properties.publicIPAddresses |
string[] |
主要区域中API 管理服务的公共静态负载均衡 IP 地址。 仅适用于基本、标准、高级和独立 SKU。 |
|
properties.publicIpAddressId |
string |
要与区域中部署的服务关联的基于公共标准 SKU IP V4 的 IP 地址虚拟网络。 仅支持在 虚拟网络 中部署的开发人员和高级 SKU。 |
|
properties.publicNetworkAccess |
此API 管理服务是否允许公共终结点访问。 值是可选的,但如果传入,则必须为“Enabled”或“Disabled”。 如果为“Disabled”,则专用终结点是独占访问方法。 默认值为“Enabled” |
||
properties.publisherEmail |
string |
发布者电子邮件。 |
|
properties.publisherName |
string |
发布者名称。 |
|
properties.restore |
boolean |
False |
取消删除 Api 管理服务(如果以前已软删除)。 如果指定了此标志并将其设置为 True,则将忽略所有其他属性。 |
properties.scmUrl |
string |
API 管理服务的 SCM 终结点 URL。 |
|
properties.targetProvisioningState |
string |
API 管理服务的预配状态,这是针对该服务启动的长时间运行操作的目标。 |
|
properties.virtualNetworkConfiguration |
API 管理服务的虚拟网络配置。 |
||
properties.virtualNetworkType | None |
需要在其中配置API 管理服务的 VPN 类型。 无 (默认值) 表示API 管理服务不属于任何虚拟网络,外部表示API 管理部署是在具有面向 Internet 的终结点的虚拟网络内设置的,而“内部”表示API 管理部署是在仅具有面向 Intranet 的终结点的虚拟网络内设置的. |
|
sku |
API 管理服务的 SKU 属性。 |
||
systemData |
与资源的创建和上次修改相关的元数据。 |
||
tags |
object |
资源标记。 |
|
type |
string |
API 管理资源的资源类型设置为 Microsoft.ApiManagement。 |
|
zones |
string[] |
指示资源需要来自何处的可用性区域列表。 |
ApiManagementServiceSkuProperties
API 管理服务资源 SKU 属性。
名称 | 类型 | 说明 |
---|---|---|
capacity |
integer |
SKU 的容量 (SKU) 的已部署单位数。 对于消耗型,SKU 容量必须指定为 0。 |
name |
SKU 的名称。 |
ApimIdentityType
用于资源的标识类型。 类型“SystemAssigned ,UserAssigned”包含隐式创建的标识和一组用户分配的标识。 类型“None”将从服务中删除任何标识。
名称 | 类型 | 说明 |
---|---|---|
None |
string |
|
SystemAssigned |
string |
|
SystemAssigned, UserAssigned |
string |
|
UserAssigned |
string |
ApiVersionConstraint
API 管理服务的控制平面 Api 版本约束。
名称 | 类型 | 说明 |
---|---|---|
minApiVersion |
string |
将控制平面 API 调用限制为API 管理版本等于或高于此值的服务。 |
ArmIdWrapper
ARM 资源 ID 的包装器
名称 | 类型 | 说明 |
---|---|---|
id |
string |
CertificateConfiguration
由不受信任的中间文件和根证书组成的证书配置。
名称 | 类型 | 说明 |
---|---|---|
certificate |
证书信息。 |
|
certificatePassword |
string |
证书密码。 |
encodedCertificate |
string |
Base64 编码证书。 |
storeName |
enum:
|
System.Security.Cryptography.x509certificates.StoreName 证书存储位置。 只有 Root 和 CertificateAuthority 是有效位置。 |
CertificateInformation
SSL 证书信息。
名称 | 类型 | 说明 |
---|---|---|
expiry |
string |
证书的到期日期。 日期符合以下格式: |
subject |
string |
证书的使用者。 |
thumbprint |
string |
证书的指纹。 |
CertificateSource
证书源。
名称 | 类型 | 说明 |
---|---|---|
BuiltIn |
string |
|
Custom |
string |
|
KeyVault |
string |
|
Managed |
string |
CertificateStatus
证书状态。
名称 | 类型 | 说明 |
---|---|---|
Completed |
string |
|
Failed |
string |
|
InProgress |
string |
createdByType
创建资源的标识类型。
名称 | 类型 | 说明 |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
ErrorFieldContract
错误字段协定。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
属性级错误代码。 |
message |
string |
属性级错误的可读表示形式。 |
target |
string |
属性名称。 |
ErrorResponse
错误响应。
名称 | 类型 | 说明 |
---|---|---|
error.code |
string |
服务定义的错误代码。 此代码用作响应中指定的 HTTP 错误代码的子状态。 |
error.details |
在发生验证错误时,请求中发送的无效字段列表。 |
|
error.message |
string |
错误的用户可读表示形式。 |
HostnameConfiguration
自定义主机名配置。
名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
certificate |
证书信息。 |
||
certificatePassword |
string |
证书密码。 |
|
certificateSource |
证书源。 |
||
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
主机名类型。
名称 | 类型 | 说明 |
---|---|---|
DeveloperPortal |
string |
|
Management |
string |
|
Portal |
string |
|
Proxy |
string |
|
Scm |
string |
NatGatewayState
属性可用于为此API 管理服务启用 NAT 网关。
名称 | 类型 | 说明 |
---|---|---|
Disabled |
string |
服务已禁用 Nat 网关。 |
Enabled |
string |
为服务启用了 Nat 网关。 |
PlatformVersion
运行服务的计算平台版本。
名称 | 类型 | 说明 |
---|---|---|
mtv1 |
string |
在多租户 V1 平台上运行该服务的平台。 |
stv1 |
string |
在单租户 V1 平台上运行服务的平台。 |
stv2 |
string |
在单租户 V2 平台上运行服务的平台。 |
undetermined |
string |
无法确定平台版本,因为未部署计算平台。 |
PrivateEndpointServiceConnectionStatus
专用终结点连接状态。
名称 | 类型 | 说明 |
---|---|---|
Approved |
string |
|
Pending |
string |
|
Rejected |
string |
PrivateLinkServiceConnectionState
有关服务使用者与提供程序之间的连接状态的信息集合。
名称 | 类型 | 说明 |
---|---|---|
actionsRequired |
string |
一条消息,指示服务提供商的更改是否需要对使用者进行任何更新。 |
description |
string |
批准/拒绝连接的原因。 |
status |
指示连接是否已由服务的所有者批准/拒绝/删除。 |
PublicNetworkAccess
是否允许此API 管理服务访问公共终结点。 值是可选的,但如果传入,则必须为“Enabled”或“Disabled”。 如果“已禁用”,则专用终结点是独占访问方法。 默认值为“Enabled”
名称 | 类型 | 说明 |
---|---|---|
Disabled |
string |
|
Enabled |
string |
RemotePrivateEndpointConnectionWrapper
远程专用终结点连接资源。
名称 | 类型 | 说明 |
---|---|---|
id |
string |
专用终结点连接资源 ID |
name |
string |
专用终结点连接名称 |
properties.groupIds |
string[] |
所有组 ID。 |
properties.privateEndpoint |
专用终结点的资源。 |
|
properties.privateLinkServiceConnectionState |
有关服务使用者与提供程序之间的连接状态的信息集合。 |
|
properties.provisioningState |
string |
专用终结点连接资源的预配状态。 |
type |
string |
专用终结点连接资源类型 |
SkuType
SKU 的名称。
名称 | 类型 | 说明 |
---|---|---|
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
与资源的创建和上次修改相关的元数据。
名称 | 类型 | 说明 |
---|---|---|
createdAt |
string |
资源创建时间戳 (UTC) 。 |
createdBy |
string |
创建资源的标识。 |
createdByType |
创建资源的标识类型。 |
|
lastModifiedAt |
string |
资源上次修改的时间戳 (UTC) |
lastModifiedBy |
string |
上次修改资源的标识。 |
lastModifiedByType |
上次修改资源的标识类型。 |
UserIdentityProperties
名称 | 类型 | 说明 |
---|---|---|
clientId |
string |
用户分配标识的客户端 ID。 |
principalId |
string |
用户分配的标识的主体 ID。 |
VirtualNetworkConfiguration
配置API 管理服务部署到的虚拟网络。
名称 | 类型 | 说明 |
---|---|---|
subnetResourceId |
string |
虚拟网络中要在其中部署API 管理服务的子网的完整资源 ID。 |
subnetname |
string |
子网的名称。 |
vnetid |
string |
虚拟网络 ID。 这通常是 GUID。 默认情况下,应为 NULL GUID。 |
VirtualNetworkType
需要在其中配置API 管理服务的 VPN 类型。 无 (默认值) 表示API 管理服务不属于任何虚拟网络,外部意味着API 管理部署是在具有面向 Internet 的终结点的虚拟网络内设置的,而内部意味着API 管理部署是在仅具有面向 Intranet 的终结点的虚拟网络内设置的.
名称 | 类型 | 说明 |
---|---|---|
External |
string |
该服务是虚拟网络的一部分,可从 Internet 访问。 |
Internal |
string |
该服务是虚拟网络的一部分,只能从虚拟网络中访问。 |
None |
string |
该服务不属于任何虚拟网络。 |