通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Api Management Service - Create Or Update

  • 参考
服务:
API Management
API 版本:
2024-05-01

创建或更新 API 管理服务。 这是长时间运行的作，可能需要几分钟才能完成。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}?api-version=2024-05-01

URI 参数

名称 在 必需 类型 说明
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 (uuid)

目标订阅的 ID。 该值必须是 UUID。
api-version
 query True

string

minLength: 1

用于此作的 API 版本。

请求正文

名称 必需 类型 说明
___location True

string

资源位置。
properties.publisherEmail True

string

maxLength: 100

发布者电子邮件。
properties.publisherName True

string

maxLength: 100

发布者名称。
sku True

ApiManagementServiceSkuProperties

API 管理服务的 SKU 属性。
identity

ApiManagementServiceIdentity

Api 管理服务的托管服务标识。
properties.additionalLocations

AdditionalLocation[]

API 管理服务的其他数据中心位置。
properties.apiVersionConstraint

ApiVersionConstraint

API 管理服务的控制平面 API 版本约束。
properties.certificates

CertificateConfiguration[]

需要在 API 管理服务中安装的证书列表。 可安装的最大支持证书为 10。
properties.configurationApi

ConfigurationApi

API 管理服务的配置 API 配置。
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

此 API 管理服务中开发人员门户的状态。
properties.disableGateway

boolean

属性仅适用于部署在多个位置的 Api 管理服务。 这可用于禁用主区域中的网关。
properties.enableClientCertificate

boolean

仅用于消耗 SKU 服务的属性。 这会强制在向网关的每个请求上显示客户端证书。 这样，便可以在网关上的策略中对证书进行身份验证。
properties.hostnameConfigurations

HostnameConfiguration[]

API 管理服务的自定义主机名配置。
properties.legacyPortalStatus

LegacyPortalStatus

API 管理服务中旧门户的状态。
properties.natGatewayState

NatGatewayState

属性可用于为此 API 管理服务启用 NAT 网关。
properties.notificationSenderEmail

string

maxLength: 100

将从中发送通知的电子邮件地址。
properties.privateEndpointConnections

RemotePrivateEndpointConnectionWrapper[]

此服务的专用终结点连接列表。
properties.publicIpAddressId

string

要与区域中部署的虚拟网络服务关联的基于公共标准 SKU IP V4 的 IP 地址。 仅支持在虚拟网络中部署开发人员和高级 SKU。
properties.publicNetworkAccess

PublicNetworkAccess

是否允许此 API 管理服务访问公共终结点。 值是可选的，但如果传入，则必须为“Enabled”或“Disabled”。 如果为“Disabled”，则专用终结点是独占访问方法。 默认值为“Enabled”
properties.restore

boolean

取消删除 Api 管理服务（如果以前是软删除的）。 如果指定了此标志并设置为 True，将忽略所有其他属性。
properties.virtualNetworkConfiguration

VirtualNetworkConfiguration

API 管理服务的虚拟网络配置。
properties.virtualNetworkType

VirtualNetworkType

需要在其中配置 API 管理服务的 VPN 类型。 无（默认值）表示 API 管理服务不是任何虚拟网络的一部分，外部意味着 API 管理部署是在具有面向 Internet 的终结点的虚拟网络内设置的，内部意味着 API 管理部署仅在具有 Intranet 面向终结点的虚拟网络中进行设置。
tags

object

资源标记。
zones

string[]

一个可用性区域列表，表示资源需要来自何处。

响应

名称 类型 说明
200 OK

ApiManagementServiceResource

已成功设置服务。
201 Created

ApiManagementServiceResource

创建
Other Status Codes

ErrorResponse

描述作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

ApiManagementCreateMultiRegionServiceWithCustomHostname
ApiManagementCreateService
ApiManagementCreateServiceHavingMsi
ApiManagementCreateServiceInVnetWithPublicIP
ApiManagementCreateServiceInZones
ApiManagementCreateServiceSkuv2Service
ApiManagementCreateServiceWithCustomHostnameKeyVault
ApiManagementCreateServiceWithDeveloperPortal
ApiManagementCreateServiceWithNatGatewayEnabled
ApiManagementCreateServiceWithoutLegacyConfigurationApi
ApiManagementCreateServiceWithSystemCertificates
ApiManagementCreateServiceWithUserAssignedIdentity
ApiManagementUndelete

ApiManagementCreateMultiRegionServiceWithCustomHostname

示例请求

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1?api-version=2024-05-01

{
  "properties": {
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "hostName": "gateway1.msitesting.net",
        "encodedCertificate": "****** Base 64 Encoded Certificate ************",
        "certificatePassword": "Password",
        "defaultSslBinding": true
      },
      {
        "type": "Management",
        "hostName": "mgmt.msitesting.net",
        "encodedCertificate": "****** Base 64 Encoded Certificate ************",
        "certificatePassword": "Password"
      },
      {
        "type": "Portal",
        "hostName": "portal1.msitesting.net",
        "encodedCertificate": "****** Base 64 Encoded Certificate ************",
        "certificatePassword": "Password"
      },
      {
        "type": "ConfigurationApi",
        "hostName": "configuration-api.msitesting.net",
        "encodedCertificate": "****** Base 64 Encoded Certificate ************",
        "certificatePassword": "Password"
      }
    ],
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk",
    "additionalLocations": [
      {
        "___location": "East US",
        "sku": {
          "name": "Premium",
          "capacity": 1
        },
        "disableGateway": true
      }
    ],
    "virtualNetworkType": "None",
    "apiVersionConstraint": {
      "minApiVersion": "2019-01-01"
    }
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  },
  "___location": "West US",
  "tags": {
    "tag1": "value1",
    "tag2": "value2",
    "tag3": "value3"
  }
}

示例响应

状态代码:
201 
Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-05-01&asyncResponse
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-05-01&asyncResponse
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "tag1": "value1",
    "tag2": "value2",
    "tag3": "value3"
  },
  "___location": "West US",
  "etag": "AAAAAAACXoo=",
  "properties": {
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Created",
    "targetProvisioningState": "Activating",
    "createdAtUtc": "2019-12-18T08:04:26.9492661Z",
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "hostName": "apimService1.azure-api.net",
        "negotiateClientCertificate": false,
        "defaultSslBinding": false
      },
      {
        "type": "Proxy",
        "hostName": "gateway1.msitesting.net",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2036-01-01T07:00:00+00:00",
          "thumbprint": "8E989XXXXXXXXXXXXXXXXF1D174FDB3A2",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": true
      },
      {
        "type": "Management",
        "hostName": "mgmt.msitesting.net",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2036-01-01T07:00:00+00:00",
          "thumbprint": "8E989XXXXXXXXXXXXXXXXF1D174FDB3A2",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": false
      },
      {
        "type": "Portal",
        "hostName": "portal1.msitesting.net",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2036-01-01T07:00:00+00:00",
          "thumbprint": "8E989XXXXXXXXXXXXXXXXF1D174FDB3A2",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": false
      },
      {
        "type": "ConfigurationApi",
        "hostName": "configuration-api.msitesting.net",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2036-01-01T07:00:00+00:00",
          "thumbprint": "8E989XXXXXXXXXXXXXXXXF1D174FDB3A2",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": false
      }
    ],
    "additionalLocations": [
      {
        "___location": "East US",
        "sku": {
          "name": "Premium",
          "capacity": 1
        },
        "disableGateway": true
      }
    ],
    "virtualNetworkType": "None",
    "disableGateway": false,
    "apiVersionConstraint": {
      "minApiVersion": "2019-01-01"
    }
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  }
}
状态代码:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "tag1": "value1",
    "tag2": "value2",
    "tag3": "value3"
  },
  "___location": "West US",
  "etag": "AAAAAAACXok=",
  "properties": {
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2019-12-18T06:26:20.3348609Z",
    "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
      },
      {
        "type": "Proxy",
        "hostName": "gateway1.msitesting.net",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2036-01-01T07:00:00+00:00",
          "thumbprint": "8E989XXXXXXXXXXXXXXXXF1D174FDB3A2",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": true
      },
      {
        "type": "Management",
        "hostName": "mgmt.msitesting.net",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2036-01-01T07:00:00+00:00",
          "thumbprint": "8E989XXXXXXXXXXXXXXXXF1D174FDB3A2",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": false
      },
      {
        "type": "Portal",
        "hostName": "portal1.msitesting.net",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2036-01-01T07:00:00+00:00",
          "thumbprint": "8E989XXXXXXXXXXXXXXXXF1D174FDB3A2",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": false
      },
      {
        "type": "ConfigurationApi",
        "hostName": "configuration-api.msitesting.net",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2036-01-01T07:00:00+00:00",
          "thumbprint": "8E989XXXXXXXXXXXXXXXXF1D174FDB3A2",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": false
      }
    ],
    "publicIPAddresses": [
      "13.91.32.113"
    ],
    "additionalLocations": [
      {
        "___location": "East US",
        "sku": {
          "name": "Premium",
          "capacity": 1
        },
        "publicIPAddresses": [
          "23.101.138.153"
        ],
        "gatewayRegionalUrl": "https://apimService1-eastus-01.regional.azure-api.net",
        "disableGateway": true
      }
    ],
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False"
    },
    "virtualNetworkType": "None",
    "disableGateway": false,
    "apiVersionConstraint": {
      "minApiVersion": "2019-01-01"
    }
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  }
}

ApiManagementCreateService

示例请求

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1?api-version=2024-05-01

{
  "properties": {
    "publisherEmail": "foo@contoso.com",
    "publisherName": "foo"
  },
  "sku": {
    "name": "Developer",
    "capacity": 1
  },
  "___location": "South Central US",
  "tags": {
    "Name": "Contoso",
    "Test": "User"
  }
}

示例响应

状态代码:
201 
Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-05-01&asyncResponse
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-05-01&asyncResponse
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "api-version": "2024-05-01"
  },
  "___location": "East US",
  "etag": "AAAAAAAmRAM=",
  "properties": {
    "publisherEmail": "samir@microsoft.com",
    "publisherName": "foo",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Created",
    "targetProvisioningState": "Activating",
    "createdAtUtc": "2022-07-11T18:41:01.2506031Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "hostName": "apimService1.azure-api.net",
        "negotiateClientCertificate": false,
        "defaultSslBinding": true,
        "certificateSource": "BuiltIn"
      }
    ],
    "virtualNetworkType": "None",
    "disableGateway": false,
    "publicNetworkAccess": "Enabled",
    "platformVersion": "undetermined"
  },
  "sku": {
    "name": "Standard",
    "capacity": 1
  },
  "systemData": {
    "createdBy": "user@contoso.com",
    "createdByType": "User",
    "createdAt": "2022-07-11T18:41:00.9390609Z",
    "lastModifiedBy": "user@contoso.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2022-07-11T18:41:00.9390609Z"
  }
}
状态代码:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "api-version": "2024-05-01"
  },
  "___location": "East US",
  "etag": "AAAAAAAmREI=",
  "properties": {
    "publisherEmail": "samir@microsoft.com",
    "publisherName": "foo",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2022-07-11T18:41:01.2506031Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "gatewayRegionalUrl": "https://apimService1-eastus-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": true,
        "certificateSource": "BuiltIn"
      }
    ],
    "publicIPAddresses": [
      "13.90.229.33"
    ],
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False"
    },
    "virtualNetworkType": "None",
    "disableGateway": false,
    "publicNetworkAccess": "Enabled",
    "platformVersion": "stv1"
  },
  "sku": {
    "name": "Standard",
    "capacity": 1
  },
  "systemData": {
    "createdBy": "user@contoso.com",
    "createdByType": "User",
    "createdAt": "2022-07-11T18:41:00.9390609Z",
    "lastModifiedBy": "user@contoso.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2022-07-11T18:41:00.9390609Z"
  }
}

ApiManagementCreateServiceHavingMsi

示例请求

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1?api-version=2024-05-01

{
  "properties": {
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk"
  },
  "sku": {
    "name": "Consumption",
    "capacity": 0
  },
  "identity": {
    "type": "SystemAssigned"
  },
  "___location": "West US",
  "tags": {
    "tag1": "value1",
    "tag2": "value2",
    "tag3": "value3"
  }
}

示例响应

状态代码:
201 
Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-05-01&asyncResponse
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-05-01&asyncResponse
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "tag1": "value1",
    "tag2": "value2",
    "tag3": "value3"
  },
  "___location": "West US",
  "etag": "AAAAAAAAWiE=",
  "properties": {
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Created",
    "targetProvisioningState": "Activating",
    "createdAtUtc": "2019-04-11T16:29:29.9711098Z",
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "hostName": "apimService1.azure-api.net",
        "negotiateClientCertificate": false,
        "defaultSslBinding": true
      }
    ],
    "virtualNetworkType": "None"
  },
  "sku": {
    "name": "Consumption",
    "capacity": 0
  },
  "identity": {
    "type": "SystemAssigned",
    "principalId": "dfb9a757-df69-4966-a8d0-711a9cd8ffb4",
    "tenantId": "00000000-86f1-41af-91ab-2d7cd011db47"
  },
  "systemData": {
    "createdBy": "string",
    "createdByType": "Application",
    "createdAt": "2020-02-01T01:01:01.1075056Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "Application",
    "lastModifiedAt": "2020-02-02T02:03:01.1974346Z"
  }
}
状态代码:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "tag1": "value1",
    "tag2": "value2",
    "tag3": "value3"
  },
  "___location": "West US",
  "etag": "AAAAAAAAWiU=",
  "properties": {
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2019-04-11T16:29:29.9711098Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "hostName": "apimService1.azure-api.net",
        "negotiateClientCertificate": false,
        "defaultSslBinding": true,
        "certificateSource": "BuiltIn"
      }
    ],
    "virtualNetworkType": "None",
    "enableClientCertificate": false,
    "platformVersion": "mtv1"
  },
  "sku": {
    "name": "Consumption",
    "capacity": 0
  },
  "identity": {
    "type": "SystemAssigned",
    "principalId": "dfb9a757-df69-4966-a8d0-711a9cd8ffb4",
    "tenantId": "00000000-86f1-41af-91ab-2d7cd011db47"
  },
  "systemData": {
    "createdBy": "string",
    "createdByType": "Application",
    "createdAt": "2020-02-01T01:01:01.1075056Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "Application",
    "lastModifiedAt": "2020-02-02T02:03:01.1974346Z"
  }
}

ApiManagementCreateServiceInVnetWithPublicIP

示例请求

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1?api-version=2024-05-01

{
  "properties": {
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk",
    "virtualNetworkConfiguration": {
      "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName/providers/Microsoft.Network/virtualNetworks/apimcus/subnets/tenant"
    },
    "publicIpAddressId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName/providers/Microsoft.Network/publicIPAddresses/apimazvnet",
    "virtualNetworkType": "External"
  },
  "sku": {
    "name": "Premium",
    "capacity": 2
  },
  "zones": [
    "1",
    "2"
  ],
  "___location": "East US 2 EUAP",
  "tags": {
    "tag1": "value1",
    "tag2": "value2",
    "tag3": "value3"
  }
}

示例响应

状态代码:
201 
Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-05-01&asyncResponse
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-05-01&asyncResponse
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "tag1": "value1",
    "tag2": "value2",
    "tag3": "value3"
  },
  "___location": "East US 2 EUAP",
  "etag": "AAAAAAAiXto=",
  "properties": {
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Created",
    "targetProvisioningState": "Activating",
    "createdAtUtc": "2020-07-28T23:18:14.6562474Z",
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "hostName": "apimService1.azure-api.net",
        "negotiateClientCertificate": false,
        "defaultSslBinding": true,
        "certificateSource": "BuiltIn"
      }
    ],
    "publicIpAddressId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName/providers/Microsoft.Network/publicIPAddresses/apimazvnet",
    "virtualNetworkConfiguration": {
      "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName/providers/Microsoft.Network/virtualNetworks/apimcus/subnets/tenant"
    },
    "virtualNetworkType": "External",
    "disableGateway": false,
    "platformVersion": "stv2.1"
  },
  "sku": {
    "name": "Premium",
    "capacity": 2
  },
  "zones": [
    "1",
    "2"
  ],
  "systemData": {
    "createdBy": "string",
    "createdByType": "Application",
    "createdAt": "2020-02-01T01:01:01.1075056Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "Application",
    "lastModifiedAt": "2020-02-02T02:03:01.1974346Z"
  }
}
状态代码:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "tag1": "value1",
    "tag2": "value2",
    "tag3": "value3"
  },
  "___location": "East US 2 EUAP",
  "etag": "AAAAAAAGTAs=",
  "properties": {
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2021-02-22T06:53:46.6409875Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "gatewayRegionalUrl": "https://apimService1-eastus2euap-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": true
      }
    ],
    "publicIPAddresses": [
      "20.47.137.XXX"
    ],
    "publicIpAddressId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName/providers/Microsoft.Network/publicIPAddresses/apimazvnet",
    "virtualNetworkConfiguration": {
      "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName/providers/Microsoft.Network/virtualNetworks/apimcus/subnets/tenant"
    },
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False"
    },
    "virtualNetworkType": "External",
    "disableGateway": false,
    "platformVersion": "stv2"
  },
  "sku": {
    "name": "Premium",
    "capacity": 2
  },
  "zones": [
    "1",
    "2"
  ],
  "systemData": {
    "createdBy": "string",
    "createdByType": "Application",
    "createdAt": "2020-02-01T01:01:01.1075056Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "Application",
    "lastModifiedAt": "2020-02-02T02:03:01.1974346Z"
  }
}

ApiManagementCreateServiceInZones

示例请求

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1?api-version=2024-05-01

{
  "properties": {
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk"
  },
  "sku": {
    "name": "Premium",
    "capacity": 2
  },
  "zones": [
    "1",
    "2"
  ],
  "___location": "North europe",
  "tags": {
    "tag1": "value1",
    "tag2": "value2",
    "tag3": "value3"
  }
}

示例响应

状态代码:
201 
Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-05-01&asyncResponse
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-05-01&asyncResponse
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "tag1": "value1",
    "tag2": "value2",
    "tag3": "value3"
  },
  "___location": "North Europe",
  "etag": "AAAAAAAiXto=",
  "properties": {
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Created",
    "targetProvisioningState": "Activating",
    "createdAtUtc": "2020-07-28T23:18:14.6562474Z",
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "hostName": "apimService1.azure-api.net",
        "negotiateClientCertificate": false,
        "defaultSslBinding": true,
        "certificateSource": "BuiltIn"
      }
    ],
    "virtualNetworkType": "None",
    "disableGateway": false,
    "platformVersion": "stv2"
  },
  "sku": {
    "name": "Premium",
    "capacity": 2
  },
  "zones": [
    "1",
    "2"
  ],
  "systemData": {
    "createdBy": "string",
    "createdByType": "Application",
    "createdAt": "2020-02-01T01:01:01.1075056Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "Application",
    "lastModifiedAt": "2020-02-02T02:03:01.1974346Z"
  }
}
状态代码:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "tag1": "value1",
    "tag2": "value2",
    "tag3": "value3"
  },
  "___location": "North Europe",
  "etag": "AAAAAAAiXvE=",
  "properties": {
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2020-07-28T23:18:14.6562474Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "gatewayRegionalUrl": "https://apimService1-northeurope-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": true
      }
    ],
    "publicIPAddresses": [
      "20.54.34.66"
    ],
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False"
    },
    "virtualNetworkType": "None",
    "disableGateway": false,
    "platformVersion": "stv2"
  },
  "sku": {
    "name": "Premium",
    "capacity": 2
  },
  "zones": [
    "1",
    "2"
  ],
  "systemData": {
    "createdBy": "string",
    "createdByType": "Application",
    "createdAt": "2020-02-01T01:01:01.1075056Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "Application",
    "lastModifiedAt": "2020-02-02T02:03:01.1974346Z"
  }
}

ApiManagementCreateServiceSkuv2Service

示例请求

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1?api-version=2024-05-01

{
  "properties": {
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk"
  },
  "sku": {
    "name": "StandardV2",
    "capacity": 1
  },
  "identity": {
    "type": "SystemAssigned"
  },
  "___location": "West US",
  "tags": {
    "tag1": "value1",
    "tag2": "value2",
    "tag3": "value3"
  }
}

示例响应

状态代码:
201 
Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-05-01&asyncResponse
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-05-01&asyncResponse
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {},
  "___location": "East US",
  "etag": "AAAAAAA3h2Q=",
  "properties": {
    "publisherEmail": "apim@contoso.com",
    "publisherName": "apimgmt-skuv2",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Activating",
    "targetProvisioningState": "Activating",
    "createdAtUtc": "2023-08-11T18:24:14.7662749Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "hostName": "apimService1.azure-api.net",
        "negotiateClientCertificate": false,
        "defaultSslBinding": true,
        "certificateSource": "BuiltIn"
      }
    ],
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False"
    },
    "virtualNetworkType": "None",
    "disableGateway": false,
    "natGatewayState": "Unsupported",
    "publicNetworkAccess": "Enabled",
    "platformVersion": "undetermined",
    "legacyPortalStatus": "Disabled",
    "developerPortalStatus": "Disabled"
  },
  "sku": {
    "name": "StandardV2",
    "capacity": 1
  },
  "identity": {
    "type": "SystemAssigned",
    "principalId": "de161222-0000-0000-0000-1caa5d9f0b0e",
    "tenantId": "72f988bf-0000-0000-0000-2d7cd011db47"
  },
  "zones": null,
  "systemData": {
    "createdBy": "contoso@microsoft.com",
    "createdByType": "User",
    "createdAt": "2023-08-11T18:24:13.7820033Z",
    "lastModifiedBy": "contoso@microsoft.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2023-08-11T18:24:13.7820033Z"
  }
}
状态代码:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {},
  "___location": "East US",
  "etag": "AAAAAAA3fHM=",
  "properties": {
    "publisherEmail": "apim@contoso.com",
    "publisherName": "apimgmt-skuv2",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2023-08-10T18:50:52.5509471Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "hostName": "apimService1.azure-api.net",
        "negotiateClientCertificate": false,
        "defaultSslBinding": true,
        "certificateSource": "BuiltIn"
      }
    ],
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False"
    },
    "virtualNetworkType": "None",
    "disableGateway": false,
    "natGatewayState": "Unsupported",
    "publicNetworkAccess": "Enabled",
    "platformVersion": "undetermined"
  },
  "sku": {
    "name": "StandardV2",
    "capacity": 1
  },
  "identity": {
    "type": "SystemAssigned",
    "principalId": "de161222-0000-0000-0000-1caa5d9f0b0e",
    "tenantId": "72f988bf-0000-0000-0000-2d7cd011db47"
  },
  "zones": null,
  "systemData": {
    "createdBy": "contoso@microsoft.com",
    "createdByType": "User",
    "createdAt": "2023-08-10T18:50:51.539583Z",
    "lastModifiedBy": "contoso@microsoft.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2023-08-10T18:50:51.539583Z"
  }
}

ApiManagementCreateServiceWithCustomHostnameKeyVault

示例请求

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1?api-version=2024-05-01

{
  "properties": {
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "hostName": "gateway1.msitesting.net",
        "keyVaultId": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert",
        "identityClientId": "329419bc-adec-4dce-9568-25a6d486e468",
        "defaultSslBinding": true
      },
      {
        "type": "Management",
        "hostName": "mgmt.msitesting.net",
        "keyVaultId": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert",
        "identityClientId": "329419bc-adec-4dce-9568-25a6d486e468"
      },
      {
        "type": "Portal",
        "hostName": "portal1.msitesting.net",
        "keyVaultId": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert",
        "identityClientId": "329419bc-adec-4dce-9568-25a6d486e468"
      },
      {
        "type": "ConfigurationApi",
        "hostName": "configuration-api.msitesting.net",
        "encodedCertificate": "****** Base 64 Encoded Certificate ************",
        "certificatePassword": "Password"
      }
    ],
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk",
    "virtualNetworkType": "None",
    "apiVersionConstraint": {
      "minApiVersion": "2019-01-01"
    }
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  },
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {}
    }
  },
  "___location": "North Europe",
  "tags": {
    "tag1": "value1",
    "tag2": "value2",
    "tag3": "value3"
  }
}

示例响应

状态代码:
201 
Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-05-01&asyncResponse
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-05-01&asyncResponse
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "tag1": "value1",
    "tag2": "value2",
    "tag3": "value3"
  },
  "___location": "North Europe",
  "etag": "AAAAAAAigi8=",
  "properties": {
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Created",
    "targetProvisioningState": "Activating",
    "createdAtUtc": "2020-09-13T22:30:20.7759747Z",
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "hostName": "apimService1.azure-api.net",
        "negotiateClientCertificate": false,
        "defaultSslBinding": false,
        "certificateSource": "BuiltIn"
      },
      {
        "type": "Proxy",
        "hostName": "gateway1.msitesting.net",
        "keyVaultId": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2037-01-01T07:00:00+00:00",
          "thumbprint": "EA276907917CB5XXXXXXXXXXX690",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": true,
        "identityClientId": "329419bc-adec-4dce-9568-25a6d486e468",
        "certificateSource": "KeyVault"
      },
      {
        "type": "Management",
        "hostName": "mgmt.msitesting.net",
        "keyVaultId": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2037-01-01T07:00:00+00:00",
          "thumbprint": "EA276907917CB5XXXXXXXXXXX690",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": false,
        "identityClientId": "329419bc-adec-4dce-9568-25a6d486e468",
        "certificateSource": "KeyVault"
      },
      {
        "type": "Portal",
        "hostName": "portal1.msitesting.net",
        "keyVaultId": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2037-01-01T07:00:00+00:00",
          "thumbprint": "EA276907917CB5XXXXXXXXXXX690",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": false,
        "identityClientId": "329419bc-adec-4dce-9568-25a6d486e468",
        "certificateSource": "KeyVault"
      },
      {
        "type": "ConfigurationApi",
        "hostName": "configuration-api.msitesting.net",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2036-01-01T07:00:00+00:00",
          "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": false
      }
    ],
    "virtualNetworkType": "None",
    "disableGateway": false,
    "platformVersion": "stv2",
    "apiVersionConstraint": {
      "minApiVersion": "2019-01-01"
    }
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  },
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {}
    }
  },
  "systemData": {
    "createdBy": "string",
    "createdByType": "Application",
    "createdAt": "2020-02-01T01:01:01.1075056Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "Application",
    "lastModifiedAt": "2020-02-02T02:03:01.1974346Z"
  }
}
状态代码:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "tag1": "value1",
    "tag2": "value2",
    "tag3": "value3"
  },
  "___location": "North Europe",
  "etag": "AAAAAAAigjU=",
  "properties": {
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2020-09-13T22:30:20.7759747Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "gatewayRegionalUrl": "https://apimService1-northeurope-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": "gateway1.msitesting.net",
        "keyVaultId": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2037-01-01T07:00:00+00:00",
          "thumbprint": "EA276907917CB5XXXXXXXXXXX690",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": true,
        "identityClientId": "329419bc-adec-4dce-9568-25a6d486e468",
        "certificateSource": "KeyVault"
      },
      {
        "type": "Management",
        "hostName": "mgmt.msitesting.net",
        "keyVaultId": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2037-01-01T07:00:00+00:00",
          "thumbprint": "EA276907917CB5XXXXXXXXXXX690",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": false,
        "identityClientId": "329419bc-adec-4dce-9568-25a6d486e468",
        "certificateSource": "KeyVault"
      },
      {
        "type": "Portal",
        "hostName": "portal1.msitesting.net",
        "keyVaultId": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2037-01-01T07:00:00+00:00",
          "thumbprint": "EA276907917CB5XXXXXXXXXXX690",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": false,
        "identityClientId": "329419bc-adec-4dce-9568-25a6d486e468",
        "certificateSource": "KeyVault"
      },
      {
        "type": "ConfigurationApi",
        "hostName": "configuration-api.msitesting.net",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2036-01-01T07:00:00+00:00",
          "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": false
      }
    ],
    "publicIPAddresses": [
      "40.112.74.192"
    ],
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False"
    },
    "virtualNetworkType": "None",
    "disableGateway": false,
    "platformVersion": "stv2",
    "apiVersionConstraint": {
      "minApiVersion": "2019-01-01"
    }
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  },
  "identity": {
    "type": "UserAssigned",
    "tenantId": "f686d426-8d16-0000-0000-ab578e110ccd",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {
        "principalId": "15e769b2-0000-0000-0000-3fd9a923ac3a",
        "clientId": "329419bc-adec-4dce-9568-25a6d486e468"
      }
    }
  },
  "systemData": {
    "createdBy": "string",
    "createdByType": "Application",
    "createdAt": "2020-02-01T01:01:01.1075056Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "Application",
    "lastModifiedAt": "2020-02-02T02:03:01.1974346Z"
  }
}

ApiManagementCreateServiceWithDeveloperPortal

示例请求

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1?api-version=2024-05-01

{
  "properties": {
    "publisherEmail": "foo@contoso.com",
    "publisherName": "foo",
    "developerPortalStatus": "Enabled"
  },
  "sku": {
    "name": "Developer",
    "capacity": 1
  },
  "___location": "South Central US",
  "tags": {
    "Name": "Contoso",
    "Test": "User"
  }
}

示例响应

状态代码:
201 
Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-05-01&asyncResponse
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-05-01&asyncResponse
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "api-version": "2024-05-01"
  },
  "___location": "East US",
  "etag": "AAAAAAAmRAM=",
  "properties": {
    "publisherEmail": "samir@microsoft.com",
    "publisherName": "foo",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Created",
    "targetProvisioningState": "Activating",
    "createdAtUtc": "2022-07-11T18:41:01.2506031Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "hostName": "apimService1.azure-api.net",
        "negotiateClientCertificate": false,
        "defaultSslBinding": true,
        "certificateSource": "BuiltIn"
      }
    ],
    "virtualNetworkType": "None",
    "disableGateway": false,
    "publicNetworkAccess": "Enabled",
    "platformVersion": "undetermined",
    "legacyPortalStatus": "Disabled",
    "developerPortalStatus": "Enabled"
  },
  "sku": {
    "name": "Standard",
    "capacity": 1
  },
  "systemData": {
    "createdBy": "user@contoso.com",
    "createdByType": "User",
    "createdAt": "2022-07-11T18:41:00.9390609Z",
    "lastModifiedBy": "user@contoso.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2022-07-11T18:41:00.9390609Z"
  }
}
状态代码:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "api-version": "2024-05-01"
  },
  "___location": "East US",
  "etag": "AAAAAAAmREI=",
  "properties": {
    "publisherEmail": "samir@microsoft.com",
    "publisherName": "foo",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2022-07-11T18:41:01.2506031Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "gatewayRegionalUrl": "https://apimService1-eastus-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": true,
        "certificateSource": "BuiltIn"
      }
    ],
    "publicIPAddresses": [
      "13.90.229.33"
    ],
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False"
    },
    "virtualNetworkType": "None",
    "disableGateway": false,
    "publicNetworkAccess": "Enabled",
    "platformVersion": "stv1"
  },
  "sku": {
    "name": "Standard",
    "capacity": 1
  },
  "systemData": {
    "createdBy": "user@contoso.com",
    "createdByType": "User",
    "createdAt": "2022-07-11T18:41:00.9390609Z",
    "lastModifiedBy": "user@contoso.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2022-07-11T18:41:00.9390609Z"
  }
}

ApiManagementCreateServiceWithNatGatewayEnabled

示例请求

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1?api-version=2024-05-01

{
  "properties": {
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk",
    "natGatewayState": "Enabled"
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  },
  "___location": "East US",
  "tags": {
    "tag1": "value1",
    "tag2": "value2",
    "tag3": "value3"
  }
}

示例响应

状态代码:
201 
Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-05-01&asyncResponse
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-05-01&asyncResponse
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "api-version": "2024-05-01"
  },
  "___location": "East US",
  "etag": "AAAAAAAmRAM=",
  "properties": {
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Created",
    "targetProvisioningState": "Activating",
    "createdAtUtc": "2022-07-11T18:41:01.2506031Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "hostName": "apimService1.azure-api.net",
        "negotiateClientCertificate": false,
        "defaultSslBinding": true,
        "certificateSource": "BuiltIn"
      }
    ],
    "privateIPAddresses": null,
    "additionalLocations": null,
    "virtualNetworkConfiguration": null,
    "virtualNetworkType": "None",
    "certificates": null,
    "disableGateway": false,
    "natGatewayState": "Enabled",
    "apiVersionConstraint": {
      "minApiVersion": null
    },
    "publicIpAddressId": null,
    "publicNetworkAccess": "Enabled",
    "privateEndpointConnections": null,
    "platformVersion": "stv2"
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  },
  "identity": null,
  "zones": null,
  "systemData": {
    "createdBy": "user@contoso.com",
    "createdByType": "User",
    "createdAt": "2022-07-11T18:41:00.9390609Z",
    "lastModifiedBy": "user@contoso.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2022-07-11T18:41:00.9390609Z"
  }
}
状态代码:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "api-version": "2024-05-01"
  },
  "___location": "East US",
  "etag": "AAAAAAAmREI=",
  "properties": {
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2022-07-26T18:41:01.2506031Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "gatewayRegionalUrl": "https://apimService1-eastus-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": true,
        "certificateSource": "BuiltIn"
      }
    ],
    "publicIPAddresses": [
      "13.90.229.33"
    ],
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "false"
    },
    "virtualNetworkType": "None",
    "disableGateway": false,
    "natGatewayState": "Enabled",
    "outboundPublicIPAddresses": [
      "60.0.0.0/31"
    ],
    "apiVersionConstraint": {
      "minApiVersion": null
    },
    "publicNetworkAccess": "Enabled",
    "platformVersion": "stv2"
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  },
  "systemData": {
    "createdBy": "user@contoso.com",
    "createdByType": "User",
    "createdAt": "2022-07-11T18:41:00.9390609Z",
    "lastModifiedBy": "user@contoso.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2022-07-11T18:41:00.9390609Z"
  }
}

ApiManagementCreateServiceWithoutLegacyConfigurationApi

示例请求

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1?api-version=2024-05-01

{
  "properties": {
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk",
    "configurationApi": {
      "legacyApi": "Disabled"
    }
  },
  "sku": {
    "name": "Basic",
    "capacity": 1
  },
  "___location": "Central US",
  "tags": {
    "tag1": "value1",
    "tag2": "value2",
    "tag3": "value3"
  }
}

示例响应

状态代码:
201 
Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-05-01&asyncResponse
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-05-01&asyncResponse
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "tag1": "value1",
    "tag2": "value2",
    "tag3": "value3"
  },
  "___location": "Central US",
  "etag": "AAAAAAAp3TM=",
  "properties": {
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Created",
    "targetProvisioningState": "Activating",
    "createdAtUtc": "2019-12-18T06:33:28.0906918Z",
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "hostName": "apimService1.azure-api.net",
        "negotiateClientCertificate": false,
        "defaultSslBinding": true
      }
    ],
    "virtualNetworkType": "None",
    "certificates": [],
    "disableGateway": false,
    "configurationApi": {
      "legacyApi": "Disabled"
    },
    "platformVersion": "stv2",
    "apiVersionConstraint": {}
  },
  "sku": {
    "name": "Basic",
    "capacity": 1
  },
  "systemData": {
    "createdBy": "string",
    "createdByType": "Application",
    "createdAt": "2020-02-01T01:01:01.1075056Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "Application",
    "lastModifiedAt": "2020-02-02T02:03:01.1974346Z"
  }
}
状态代码:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "tag1": "value1",
    "tag2": "value2",
    "tag3": "value3"
  },
  "___location": "Central US",
  "etag": "AAAAAAAp3UM=",
  "properties": {
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2019-12-18T06:33:28.0906918Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "gatewayRegionalUrl": "https://apimService1-centralus-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": true,
        "certificateSource": "BuiltIn"
      }
    ],
    "publicIPAddresses": [
      "40.113.223.117"
    ],
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False"
    },
    "virtualNetworkType": "None",
    "certificates": [],
    "disableGateway": false,
    "configurationApi": {
      "legacyApi": "Disabled"
    },
    "platformVersion": "stv2",
    "apiVersionConstraint": {}
  },
  "sku": {
    "name": "Basic",
    "capacity": 1
  },
  "systemData": {
    "createdBy": "string",
    "createdByType": "Application",
    "createdAt": "2020-02-01T01:01:01.1075056Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "Application",
    "lastModifiedAt": "2020-02-02T02:03:01.1974346Z"
  }
}

ApiManagementCreateServiceWithSystemCertificates

示例请求

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1?api-version=2024-05-01

{
  "properties": {
    "certificates": [
      {
        "encodedCertificate": "*******Base64 encoded Certificate******************",
        "certificatePassword": "Password",
        "storeName": "CertificateAuthority"
      }
    ],
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk"
  },
  "sku": {
    "name": "Basic",
    "capacity": 1
  },
  "___location": "Central US",
  "tags": {
    "tag1": "value1",
    "tag2": "value2",
    "tag3": "value3"
  }
}

示例响应

状态代码:
201 
Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-05-01&asyncResponse
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-05-01&asyncResponse
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "tag1": "value1",
    "tag2": "value2",
    "tag3": "value3"
  },
  "___location": "Central US",
  "etag": "AAAAAAAp3TM=",
  "properties": {
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Created",
    "targetProvisioningState": "Activating",
    "createdAtUtc": "2019-12-18T06:33:28.0906918Z",
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "hostName": "apimService1.azure-api.net",
        "negotiateClientCertificate": false,
        "defaultSslBinding": true
      }
    ],
    "virtualNetworkType": "None",
    "certificates": [
      {
        "storeName": "CertificateAuthority",
        "certificate": {
          "expiry": "2036-01-01T07:00:00+00:00",
          "thumbprint": "8E989652CABCF585ACBFCB9C2C91F1D174FDB3A2",
          "subject": "CN=*.msitesting.net"
        }
      }
    ],
    "disableGateway": false,
    "platformVersion": "stv2",
    "apiVersionConstraint": {}
  },
  "sku": {
    "name": "Basic",
    "capacity": 1
  },
  "systemData": {
    "createdBy": "string",
    "createdByType": "Application",
    "createdAt": "2020-02-01T01:01:01.1075056Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "Application",
    "lastModifiedAt": "2020-02-02T02:03:01.1974346Z"
  }
}
状态代码:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "tag1": "value1",
    "tag2": "value2",
    "tag3": "value3"
  },
  "___location": "Central US",
  "etag": "AAAAAAAp3UM=",
  "properties": {
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2019-12-18T06:33:28.0906918Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "gatewayRegionalUrl": "https://apimService1-centralus-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": true,
        "certificateSource": "BuiltIn"
      }
    ],
    "publicIPAddresses": [
      "40.113.223.117"
    ],
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False"
    },
    "virtualNetworkType": "None",
    "certificates": [
      {
        "storeName": "CertificateAuthority",
        "certificate": {
          "expiry": "2036-01-01T07:00:00+00:00",
          "thumbprint": "8E989652CABCF585ACBFCB9C2C91F1D174FDB3A2",
          "subject": "CN=*.msitesting.net"
        }
      }
    ],
    "disableGateway": false,
    "platformVersion": "stv2",
    "apiVersionConstraint": {}
  },
  "sku": {
    "name": "Basic",
    "capacity": 1
  },
  "systemData": {
    "createdBy": "string",
    "createdByType": "Application",
    "createdAt": "2020-02-01T01:01:01.1075056Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "Application",
    "lastModifiedAt": "2020-02-02T02:03:01.1974346Z"
  }
}

ApiManagementCreateServiceWithUserAssignedIdentity

示例请求

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1?api-version=2024-05-01

{
  "properties": {
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk"
  },
  "sku": {
    "name": "Consumption",
    "capacity": 0
  },
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/apimService1": {}
    }
  },
  "___location": "West US",
  "tags": {
    "tag1": "value1",
    "tag2": "value2",
    "tag3": "value3"
  }
}

示例响应

状态代码:
201 
Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-05-01&asyncResponse
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-05-01&asyncResponse
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "tag1": "value1",
    "tag2": "value2",
    "tag3": "value3"
  },
  "___location": "West US",
  "etag": "AAAAAAAFzyQ=",
  "properties": {
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Created",
    "targetProvisioningState": "Activating",
    "createdAtUtc": "2020-03-12T01:05:33.4573398Z",
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "hostName": "apimService1.azure-api.net",
        "negotiateClientCertificate": false,
        "defaultSslBinding": true,
        "certificateSource": "BuiltIn"
      }
    ],
    "virtualNetworkType": "None",
    "platformVersion": "mtv1"
  },
  "sku": {
    "name": "Consumption",
    "capacity": 0
  },
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/apimService1": {}
    }
  },
  "systemData": {
    "createdBy": "string",
    "createdByType": "Application",
    "createdAt": "2020-02-01T01:01:01.1075056Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "Application",
    "lastModifiedAt": "2020-02-02T02:03:01.1974346Z"
  }
}
状态代码:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "tag1": "value1",
    "tag2": "value2",
    "tag3": "value3"
  },
  "___location": "West US",
  "etag": "AAAAAAAFzyk=",
  "properties": {
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2020-03-12T01:05:33.4573398Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "hostName": "apimService1.azure-api.net",
        "negotiateClientCertificate": false,
        "defaultSslBinding": true,
        "certificateSource": "BuiltIn"
      }
    ],
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False"
    },
    "virtualNetworkType": "None",
    "disableGateway": false,
    "platformVersion": "mtv1"
  },
  "sku": {
    "name": "Consumption",
    "capacity": 0
  },
  "identity": {
    "type": "UserAssigned",
    "tenantId": "00000000-86f1-41af-0000-2d7cd011db47",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/apimService1": {
        "principalId": "00000000-6e62-4649-9f54-a119fc1ba85e",
        "clientId": "5a2c6b8e-0905-0000-a772-993c9418137f"
      }
    }
  },
  "systemData": {
    "createdBy": "string",
    "createdByType": "Application",
    "createdAt": "2020-02-01T01:01:01.1075056Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "Application",
    "lastModifiedAt": "2020-02-02T02:03:01.1974346Z"
  }
}

ApiManagementUndelete

示例请求

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1?api-version=2024-05-01

{
  "properties": {
    "publisherEmail": "foo@contoso.com",
    "publisherName": "foo",
    "restore": true
  },
  "sku": {
    "name": "Developer",
    "capacity": 1
  },
  "___location": "South Central US"
}

示例响应

状态代码:
201 
Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-05-01&asyncResponse
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-05-01&asyncResponse
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "___location": "South Central US",
  "etag": "AAAAAAAp3P0=",
  "properties": {
    "publisherEmail": "foo@contoso.com",
    "publisherName": "foo",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Created",
    "targetProvisioningState": "Activating",
    "createdAtUtc": "2019-12-18T06:10:56.0327105Z",
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "hostName": "apimService1.azure-api.net",
        "negotiateClientCertificate": false,
        "defaultSslBinding": true
      }
    ],
    "virtualNetworkType": "None",
    "disableGateway": false,
    "apiVersionConstraint": {}
  },
  "sku": {
    "name": "Developer",
    "capacity": 1
  }
}
状态代码:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "___location": "South Central US",
  "etag": "AAAAAAAp3T4=",
  "properties": {
    "publisherEmail": "foo@contoso.com",
    "publisherName": "foo",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2019-12-18T06:10:56.0327105Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "gatewayRegionalUrl": "https://apimService1-southcentralus-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": true
      }
    ],
    "publicIPAddresses": [
      "23.102.171.124"
    ],
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False"
    },
    "virtualNetworkType": "None",
    "disableGateway": false,
    "apiVersionConstraint": {}
  },
  "sku": {
    "name": "Developer",
    "capacity": 1
  }
}

定义

名称 说明
AdditionalLocation

其他 API 管理资源位置的说明。
ApiManagementServiceIdentity

Api 管理服务资源的标识属性。
ApiManagementServiceResource

列表或获取响应中的单个 API 管理服务资源。
ApiManagementServiceSkuProperties

API 管理服务资源 SKU 属性。
ApimIdentityType

用于资源的标识类型。 类型“SystemAssigned，UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将从服务中删除任何标识。
ApiVersionConstraint

API 管理服务的控制平面 API 版本约束。
ArmIdWrapper

ARM 资源 ID 的包装器
CertificateConfiguration

证书配置，由不受信任的中间证书和根证书组成。
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”
RemotePrivateEndpointConnectionWrapper

远程专用终结点连接资源。
SkuType

Sku 的名称。
systemData

与创建和上次修改资源相关的元数据。
UserIdentityProperties
VirtualNetworkConfiguration

配置部署 API 管理服务的虚拟网络。
VirtualNetworkType

需要在其中配置 API 管理服务的 VPN 类型。 无（默认值）表示 API 管理服务不是任何虚拟网络的一部分，外部意味着 API 管理部署是在具有面向 Internet 的终结点的虚拟网络内设置的，内部意味着 API 管理部署仅在具有 Intranet 面向终结点的虚拟网络中进行设置。

AdditionalLocation

Object

其他 API 管理资源位置的说明。

名称 类型 默认值 说明
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 管理服务资源的标识属性。

名称 类型 说明
principalId

string (uuid)

标识的主体 ID。
tenantId

string (uuid)

标识的客户端租户 ID。
type

ApimIdentityType

用于资源的标识类型。 类型“SystemAssigned，UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将从服务中删除任何标识。
userAssignedIdentities

<string,  UserIdentityProperties>

与资源关联的用户标识列表。 用户标识字典密钥引用的格式为 ARM 资源 ID：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。

ApiManagementServiceResource

Object

列表或获取响应中的单个 API 管理服务资源。

名称 类型 默认值 说明
etag

string

资源的 ETag。
id

string

资源 ID。
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 日期。日期符合以下格式：按 ISO 8601 标准指定的 yyyy-MM-ddTHH:mm:ssZ。
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 管理服务的当前预配状态，可以是下列项之一：Created/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

maxLength: 100

发布者电子邮件。
properties.publisherName

string

maxLength: 100

发布者名称。
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 管理部署是在具有面向 Internet 的终结点的虚拟网络内设置的，内部意味着 API 管理部署仅在具有 Intranet 面向终结点的虚拟网络中进行设置。
sku

ApiManagementServiceSkuProperties

API 管理服务的 SKU 属性。
systemData

systemData

与创建和上次修改资源相关的元数据。
tags

object

资源标记。
type

string

API 管理资源的资源类型设置为 Microsoft.ApiManagement。
zones

string[]

一个可用性区域列表，表示资源需要来自何处。

ApiManagementServiceSkuProperties

Object

API 管理服务资源 SKU 属性。

名称 类型 说明
capacity

integer (int32)

SKU 的容量（SKU 的已部署单位数）。 对于消耗 SKU 容量，必须指定为 0。
name

SkuType

Sku 的名称。

ApimIdentityType

枚举

用于资源的标识类型。 类型“SystemAssigned，UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将从服务中删除任何标识。

值 说明
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

ApiVersionConstraint

Object

API 管理服务的控制平面 API 版本约束。

名称 类型 说明
minApiVersion

string

限制对 API 管理服务的控制平面 API 调用，其版本等于或高于此值。

ArmIdWrapper

Object

ARM 资源 ID 的包装器

名称 类型 说明
id

string

CertificateConfiguration

Object

证书配置，由不受信任的中间证书和根证书组成。

名称 类型 说明
certificate

CertificateInformation

证书信息。
certificatePassword

string

证书密码。
encodedCertificate

string

Base64 编码证书。
storeName enum:
  • CertificateAuthority
  • Root

System.Security.Cryptography.x509certificates.StoreName 证书存储位置。 只有 Root 和 CertificateAuthority 是有效位置。

CertificateInformation

Object

SSL 证书信息。

名称 类型 说明
expiry

string (date-time)

证书的到期日期。 日期符合以下格式：按 ISO 8601 标准指定的 yyyy-MM-ddTHH:mm:ssZ。
subject

string

证书的使用者。
thumbprint

string

证书的指纹。

CertificateSource

枚举

证书源。

值 说明
BuiltIn
Custom
KeyVault
Managed

CertificateStatus

枚举

证书状态。

值 说明
Completed
Failed
InProgress

ConfigurationApi

Object

有关 API 管理服务的配置 API 的信息。

名称 类型 默认值 说明
legacyApi

LegacyApiState

Enabled

指示是否应在 API 管理服务上公开旧配置 API （v1）。 值是可选的，但必须是“Enabled”或“Disabled”。 如果“已禁用”，旧版配置 API（v1）将不适用于自承载网关。 默认值为“Enabled”

createdByType

枚举

创建资源的标识的类型。

值 说明
Application
Key
ManagedIdentity
User

developerPortalStatus

枚举

此 API 管理服务中开发人员门户的状态。

值 说明
Disabled

为服务禁用开发人员门户。
Enabled

开发人员门户已为该服务启用。

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。
type

string

其他信息类型。

ErrorDetail

Object

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。
code

string

错误代码。
details

ErrorDetail[]

错误详细信息。
message

string

错误消息。
target

string

错误目标。

ErrorResponse

Object

错误响应

名称 类型 说明
error

ErrorDetail

错误对象。

HostnameConfiguration

Object

自定义主机名配置。

名称 类型 默认值 说明
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。
keyVaultId

string

包含 Ssl 证书的 KeyVault 机密的 URL。 如果提供了包含版本的绝对 URL，则 ssl 证书的自动更新将不起作用。 这要求使用 aka.ms/apimmsi 配置 Api 管理服务。 机密应为 application/x-pkcs12 类型
negotiateClientCertificate

boolean

False

指定 true 以始终协商主机名上的客户端证书。 默认值为 false。
type

HostnameType

主机名类型。

HostnameType

枚举

主机名类型。

值 说明
ConfigurationApi
DeveloperPortal
Management
Portal
Proxy
Scm

LegacyApiState

枚举

指示是否应在 API 管理服务上公开旧配置 API （v1）。 值是可选的，但必须是“Enabled”或“Disabled”。 如果“已禁用”，旧版配置 API（v1）将不适用于自承载网关。 默认值为“Enabled”

值 说明
Disabled

旧版配置 API（v1）已为服务禁用，自承载网关无法连接到它。
Enabled

为服务启用了旧配置 API（v1），自承载网关可以连接到该服务。

LegacyPortalStatus

枚举

API 管理服务中旧门户的状态。

值 说明
Disabled

为服务禁用旧门户。
Enabled

为服务启用旧门户。

NatGatewayState

枚举

属性可用于为此 API 管理服务启用 NAT 网关。

值 说明
Disabled

为服务禁用 Nat 网关。
Enabled

为服务启用 Nat 网关。

PlatformVersion

枚举

运行服务的计算平台版本。

值 说明
mtv1

在多租户 V1 平台上运行服务的平台。
stv1

在单租户 V1 平台上运行服务的平台。
stv2

在单租户 V2 平台上运行服务的平台。
stv2.1

在较新的硬件上的单租户 V2 平台上运行服务的平台。
undetermined

无法确定平台版本，因为未部署计算平台。

PrivateEndpointServiceConnectionStatus

枚举

专用终结点连接状态。

值 说明
Approved
Pending
Rejected

PrivateLinkServiceConnectionState

Object

有关服务使用者与提供程序之间的连接状态的信息集合。

名称 类型 说明
actionsRequired

string

一条消息，指示服务提供商上的更改是否需要对使用者进行任何更新。
description

string

批准/拒绝连接的原因。
status

PrivateEndpointServiceConnectionStatus

指示连接是否已被服务的所有者批准/拒绝/删除。

PublicNetworkAccess

枚举

是否允许此 API 管理服务访问公共终结点。 值是可选的，但如果传入，则必须为“Enabled”或“Disabled”。 如果为“Disabled”，则专用终结点是独占访问方法。 默认值为“Enabled”

值 说明
Disabled
Enabled

RemotePrivateEndpointConnectionWrapper

Object

远程专用终结点连接资源。

名称 类型 说明
id

string

专用终结点连接资源 ID
name

string

专用终结点连接名称
properties.groupIds

string[]

所有组 ID。
properties.privateEndpoint

ArmIdWrapper

专用终结点的资源。
properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

有关服务使用者与提供程序之间的连接状态的信息集合。
properties.provisioningState

string

专用终结点连接资源的预配状态。
type

string

专用终结点连接资源类型

SkuType

枚举

Sku 的名称。

值 说明
Basic

Api 管理的基本 SKU。
BasicV2

Api 管理的 BasicV2 SKU。
Consumption

API 管理的消耗 SKU。
Developer

Api 管理的开发人员 SKU。
Isolated

独立 API 管理的 SKU。
Premium

Api 管理的高级 SKU。
Standard

Api 管理的标准 SKU。
StandardV2

Api 管理的 StandardV2 SKU。

systemData

Object

与创建和上次修改资源相关的元数据。

名称 类型 说明
createdAt

string (date-time)

资源创建时间戳（UTC）。
createdBy

string

创建资源的标识。
createdByType

createdByType

创建资源的标识的类型。
lastModifiedAt

string (date-time)

上次修改的资源时间戳（UTC）
lastModifiedBy

string

上次修改资源的标识。
lastModifiedByType

createdByType

上次修改资源的标识的类型。

UserIdentityProperties

Object
名称 类型 说明
clientId

string

用户分配标识的客户端 ID。
principalId

string

用户分配标识的主体 ID。

VirtualNetworkConfiguration

Object

配置部署 API 管理服务的虚拟网络。

名称 类型 说明
subnetResourceId

string

pattern: ^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$

要在其中部署 API 管理服务的虚拟网络中子网的完整资源 ID。
subnetname

string

子网的名称。
vnetid

string

虚拟网络 ID。 这通常是 GUID。 默认情况下，需要 NULL GUID。

VirtualNetworkType

枚举

需要在其中配置 API 管理服务的 VPN 类型。 无（默认值）表示 API 管理服务不是任何虚拟网络的一部分，外部意味着 API 管理部署是在具有面向 Internet 的终结点的虚拟网络内设置的，内部意味着 API 管理部署仅在具有 Intranet 面向终结点的虚拟网络中进行设置。

值 说明
External

该服务是虚拟网络的一部分，可从 Internet 访问。
Internal

该服务是虚拟网络的一部分，它只能从虚拟网络内部访问。
None

该服务不属于任何虚拟网络。