次の方法で共有

Api Management Service - Create Or Update

サービス:
API Management
API バージョン:
2024-05-01

API Management サービスを作成または更新します。 これは実行時間の長い操作であり、完了までに数分かかる場合があります。

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 Management サービスの名前。
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 Management サービスの SKU プロパティ。
identity

ApiManagementServiceIdentity

Api Management サービスのマネージド サービス ID。
properties.additionalLocations

AdditionalLocation[]

API Management サービスの追加のデータセンターの場所。
properties.apiVersionConstraint

ApiVersionConstraint

API Management サービスのコントロール プレーン API のバージョン制約。
properties.certificates

CertificateConfiguration[]

API Management サービスにインストールする必要がある証明書の一覧。 インストールできるサポートされる証明書の最大数は 10 です。
properties.configurationApi

ConfigurationApi

API Management サービスの構成 API 構成。
properties.customProperties

object

API Management サービスのカスタム プロパティ。
設定 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 Management サービスで 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 Management サービスで HTTP2 プロトコルを有効にすることができます。
PATCH 操作でこれらのプロパティを指定しないと、省略されたプロパティの値が既定値にリセットされます。 Http2 を除くすべての設定で、サービスが 2018 年 4 月 1 日以前に作成された場合は既定値が True され、それ以外の場合 False。 Http2 設定の既定値は Falseです。

TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA、TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA、Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]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 Management サービスの開発者ポータルの状態。
properties.disableGateway

boolean

プロパティは、複数の場所にデプロイされた Api Management サービスに対してのみ有効です。 これを使用して、マスター リージョンのゲートウェイを無効にすることができます。
properties.enableClientCertificate

boolean

プロパティは、従量課金 SKU サービスにのみ使用されます。 これにより、ゲートウェイへの各要求にクライアント証明書が提示されます。 これにより、ゲートウェイのポリシーで証明書を認証することもできます。
properties.hostnameConfigurations

HostnameConfiguration[]

API Management サービスのカスタム ホスト名構成。
properties.legacyPortalStatus

LegacyPortalStatus

API Management サービスのレガシ ポータルの状態。
properties.natGatewayState

NatGatewayState

プロパティを使用して、この API Management サービスの NAT ゲートウェイを有効にすることができます。
properties.notificationSenderEmail

string

maxLength: 100

通知の送信先となる電子メール アドレス。
properties.privateEndpointConnections

RemotePrivateEndpointConnectionWrapper[]

このサービスのプライベート エンドポイント接続の一覧。
properties.publicIpAddressId

string

リージョンにデプロイされた Virtual Network サービスに関連付けられるパブリック Standard SKU IP V4 ベースの IP アドレス。 Virtual Network にデプロイされている Developer SKU と Premium SKU でのみサポートされます。
properties.publicNetworkAccess

PublicNetworkAccess

この API Management サービスに対してパブリック エンドポイント アクセスが許可されているかどうか。 値は省略可能ですが、渡される場合は 'Enabled' または 'Disabled' である必要があります。 "無効" の場合、プライベート エンドポイントは排他アクセス方法です。 既定値は 'Enabled' です
properties.restore

boolean

以前に論理的に削除された場合は、Api Management サービスの削除を取り消します。 このフラグを指定し、True に設定すると、他のすべてのプロパティは無視されます。
properties.virtualNetworkConfiguration

VirtualNetworkConfiguration

API Management サービスの仮想ネットワーク構成。
properties.virtualNetworkType

VirtualNetworkType

API Management サービスを構成する必要がある VPN の種類。 None (既定値) は、API Management サービスが仮想ネットワークに含まれていないことを意味し、外部は、インターネットに接続するエンドポイントを持つ仮想ネットワーク内に API Management デプロイが設定されていることを意味し、内部はイントラネットに接続するエンドポイントのみを持つ仮想ネットワーク内で API Management のデプロイが設定されることを意味します。
tags

object

リソース タグ。
zones

string[]

リソースの取得場所を表す可用性ゾーンの一覧。

応答

名前 型 説明
200 OK

ApiManagementServiceResource

サービスが正常に設定されました。
201 Created

ApiManagementServiceResource

作成
Other Status Codes

ErrorResponse

操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 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 Management リソースの場所の説明。
ApiManagementServiceIdentity

Api Management サービス リソースの ID プロパティ。
ApiManagementServiceResource

List または Get 応答の単一の API Management サービス リソース。
ApiManagementServiceSkuProperties

API Management サービス リソース SKU のプロパティ。
ApimIdentityType

リソースに使用される ID の種類。 型 'SystemAssigned, UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' は、サービスからすべての ID を削除します。
ApiVersionConstraint

API Management サービスのコントロール プレーン API のバージョン制約。
ArmIdWrapper

ARM リソース ID のラッパー
CertificateConfiguration

信頼されていない中間証明書とルート証明書で構成される証明書の構成。
CertificateInformation

SSL 証明書情報。
CertificateSource

証明書ソース。
CertificateStatus

証明書の状態。
ConfigurationApi

API Management サービスの構成 API に関する情報。
createdByType

リソースを作成した ID の種類。
developerPortalStatus

この API Management サービスの開発者ポータルの状態。
ErrorAdditionalInfo

リソース管理エラーの追加情報。
ErrorDetail

エラーの詳細。
ErrorResponse

エラー応答
HostnameConfiguration

カスタム ホスト名の構成。
HostnameType

ホスト名の種類。
LegacyApiState

レガシ構成 API (v1) を API Management サービスで公開する必要があるかどうかを示します。 値は省略可能ですが、'Enabled' または 'Disabled' である必要があります。 "無効" の場合、レガシ構成 API (v1) はセルフホステッド ゲートウェイでは使用できません。 既定値は 'Enabled' です
LegacyPortalStatus

API Management サービスのレガシ ポータルの状態。
NatGatewayState

プロパティを使用して、この API Management サービスの NAT ゲートウェイを有効にすることができます。
PlatformVersion

サービスを実行しているコンピューティング プラットフォームのバージョン。
PrivateEndpointServiceConnectionStatus

プライベート エンドポイント接続の状態。
PrivateLinkServiceConnectionState

サービス コンシューマーとプロバイダー間の接続の状態に関する情報のコレクション。
PublicNetworkAccess

この API Management サービスに対してパブリック エンドポイント アクセスが許可されているかどうか。 値は省略可能ですが、渡される場合は 'Enabled' または 'Disabled' である必要があります。 "無効" の場合、プライベート エンドポイントは排他アクセス方法です。 既定値は 'Enabled' です
RemotePrivateEndpointConnectionWrapper

リモート プライベート エンドポイント接続リソース。
SkuType

SKU の名前。
systemData

リソースの作成と最後の変更に関連するメタデータ。
UserIdentityProperties
VirtualNetworkConfiguration

API Management サービスのデプロイ先となる仮想ネットワークの構成。
VirtualNetworkType

API Management サービスを構成する必要がある VPN の種類。 None (既定値) は、API Management サービスが仮想ネットワークに含まれていないことを意味し、外部は、インターネットに接続するエンドポイントを持つ仮想ネットワーク内に API Management デプロイが設定されていることを意味し、内部はイントラネットに接続するエンドポイントのみを持つ仮想ネットワーク内で API Management のデプロイが設定されることを意味します。

AdditionalLocation

Object

追加の API Management リソースの場所の説明。

名前 型 規定値 説明
disableGateway

boolean

False

プロパティは、複数の場所にデプロイされた Api Management サービスに対してのみ有効です。 これを使用して、この追加の場所でゲートウェイを無効にすることができます。
gatewayRegionalUrl

string

リージョン内の API Management サービスのゲートウェイ URL。
location

string

Azure データ センター リージョン間の追加リージョンの場所名。
natGatewayState

NatGatewayState

Disabled

プロパティを使用して、この API Management サービスの NAT ゲートウェイを有効にすることができます。
outboundPublicIPAddresses

string[]

NAT ゲートウェイでデプロイされたサービスに関連付けられている送信パブリック IPV4 アドレス プレフィックス。 stv2 プラットフォームの Premium SKU でのみ使用できます。
platformVersion

PlatformVersion

サービスを実行しているコンピューティング プラットフォームのバージョン。
privateIPAddresses

string[]

特定の追加の場所にある内部仮想ネットワークにデプロイされる API Management サービスのプライベート静的負荷分散 IP アドレス。 Basic、Standard、Premium、Isolated SKU でのみ使用できます。
publicIPAddresses

string[]

追加の場所にある API Management サービスのパブリック静的負荷分散 IP アドレス。 Basic、Standard、Premium、Isolated SKU でのみ使用できます。
publicIpAddressId

string

場所にデプロイされた Virtual Network サービスに関連付けられるパブリック Standard SKU IP V4 ベースの IP アドレス。 Virtual Network にデプロイされている Premium SKU でのみサポートされます。
sku

ApiManagementServiceSkuProperties

API Management サービスの SKU プロパティ。
virtualNetworkConfiguration

VirtualNetworkConfiguration

場所の仮想ネットワーク構成。
zones

string[]

リソースの取得場所を表す可用性ゾーンの一覧。

ApiManagementServiceIdentity

Object

Api Management サービス リソースの ID プロパティ。

名前 型 説明
principalId

string (uuid)

ID のプリンシパル ID。
tenantId

string (uuid)

ID のクライアント テナント ID。
type

ApimIdentityType

リソースに使用される ID の種類。 型 'SystemAssigned, UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' は、サービスからすべての ID を削除します。
userAssignedIdentities

<string,  UserIdentityProperties>

リソースに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ のキー参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。

ApiManagementServiceResource

Object

List または Get 応答の単一の API Management サービス リソース。

名前 型 規定値 説明
etag

string

リソースの ETag。
id

string

リソース ID。
identity

ApiManagementServiceIdentity

Api Management サービスのマネージド サービス ID。
location

string

リソースの場所。
name

string

リソース名。
properties.additionalLocations

AdditionalLocation[]

API Management サービスの追加のデータセンターの場所。
properties.apiVersionConstraint

ApiVersionConstraint

API Management サービスのコントロール プレーン API のバージョン制約。
properties.certificates

CertificateConfiguration[]

API Management サービスにインストールする必要がある証明書の一覧。 インストールできるサポートされる証明書の最大数は 10 です。
properties.configurationApi

ConfigurationApi

API Management サービスの構成 API 構成。
properties.createdAtUtc

string (date-time)

API Management サービスの作成 UTC 日付。日付は、ISO 8601 標準で指定された yyyy-MM-ddTHH:mm:ssZ 形式に準拠しています。
properties.customProperties

object

API Management サービスのカスタム プロパティ。
設定 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 Management サービスで 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 Management サービスで HTTP2 プロトコルを有効にすることができます。
PATCH 操作でこれらのプロパティを指定しないと、省略されたプロパティの値が既定値にリセットされます。 Http2 を除くすべての設定で、サービスが 2018 年 4 月 1 日以前に作成された場合は既定値が True され、それ以外の場合 False。 Http2 設定の既定値は Falseです。

TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA、TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA、Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]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 Management サービスの開発者ポータルの状態。
properties.developerPortalUrl

string

API Management サービスの DEveloper Portal エンドポイント URL。
properties.disableGateway

boolean

False

プロパティは、複数の場所にデプロイされた Api Management サービスに対してのみ有効です。 これを使用して、マスター リージョンのゲートウェイを無効にすることができます。
properties.enableClientCertificate

boolean

False

プロパティは、従量課金 SKU サービスにのみ使用されます。 これにより、ゲートウェイへの各要求にクライアント証明書が提示されます。 これにより、ゲートウェイのポリシーで証明書を認証することもできます。
properties.gatewayRegionalUrl

string

既定のリージョンの API Management サービスのゲートウェイ URL。
properties.gatewayUrl

string

API Management サービスのゲートウェイ URL。
properties.hostnameConfigurations

HostnameConfiguration[]

API Management サービスのカスタム ホスト名構成。
properties.legacyPortalStatus

LegacyPortalStatus

Enabled

API Management サービスのレガシ ポータルの状態。
properties.managementApiUrl

string

API Management サービスの管理 API エンドポイント URL。
properties.natGatewayState

NatGatewayState

Disabled

プロパティを使用して、この API Management サービスの NAT ゲートウェイを有効にすることができます。
properties.notificationSenderEmail

string

maxLength: 100

通知の送信先となる電子メール アドレス。
properties.outboundPublicIPAddresses

string[]

NAT ゲートウェイでデプロイされたサービスに関連付けられている送信パブリック IPV4 アドレス プレフィックス。 stv2 プラットフォームの Premium SKU でのみ使用できます。
properties.platformVersion

PlatformVersion

この場所でサービスを実行しているコンピューティング プラットフォーム のバージョン。
properties.portalUrl

string

API Management サービスのパブリッシャー ポータル エンドポイント URL。
properties.privateEndpointConnections

RemotePrivateEndpointConnectionWrapper[]

このサービスのプライベート エンドポイント接続の一覧。
properties.privateIPAddresses

string[]

内部仮想ネットワークにデプロイされているプライマリ リージョンの API Management サービスのプライベート静的負荷分散 IP アドレス。 Basic、Standard、Premium、Isolated SKU でのみ使用できます。
properties.provisioningState

string

API Management サービスの現在のプロビジョニング状態。作成済み/アクティブ化/成功/更新/失敗/停止/終了/終了Failed/削除済みのいずれかです。
properties.publicIPAddresses

string[]

プライマリ リージョンの API Management サービスのパブリック静的負荷分散 IP アドレス。 Basic、Standard、Premium、Isolated SKU でのみ使用できます。
properties.publicIpAddressId

string

リージョンにデプロイされた Virtual Network サービスに関連付けられるパブリック Standard SKU IP V4 ベースの IP アドレス。 Virtual Network にデプロイされている Developer SKU と Premium SKU でのみサポートされます。
properties.publicNetworkAccess

PublicNetworkAccess

この API Management サービスに対してパブリック エンドポイント アクセスが許可されているかどうか。 値は省略可能ですが、渡される場合は 'Enabled' または 'Disabled' である必要があります。 "無効" の場合、プライベート エンドポイントは排他アクセス方法です。 既定値は 'Enabled' です
properties.publisherEmail

string

maxLength: 100

発行元の電子メール。
properties.publisherName

string

maxLength: 100

発行元名。
properties.restore

boolean

False

以前に論理的に削除された場合は、Api Management サービスの削除を取り消します。 このフラグを指定し、True に設定すると、他のすべてのプロパティは無視されます。
properties.scmUrl

string

API Management サービスの SCM エンドポイント URL。
properties.targetProvisioningState

string

API Management サービスのプロビジョニング状態。これは、サービスで開始された実行時間の長い操作を対象とします。
properties.virtualNetworkConfiguration

VirtualNetworkConfiguration

API Management サービスの仮想ネットワーク構成。
properties.virtualNetworkType

VirtualNetworkType

None

API Management サービスを構成する必要がある VPN の種類。 None (既定値) は、API Management サービスが仮想ネットワークに含まれていないことを意味し、外部は、インターネットに接続するエンドポイントを持つ仮想ネットワーク内に API Management デプロイが設定されていることを意味し、内部はイントラネットに接続するエンドポイントのみを持つ仮想ネットワーク内で API Management のデプロイが設定されることを意味します。
sku

ApiManagementServiceSkuProperties

API Management サービスの SKU プロパティ。
systemData

systemData

リソースの作成と最後の変更に関連するメタデータ。
tags

object

リソース タグ。
type

string

API Management リソースのリソースの種類が Microsoft.ApiManagement に設定されています。
zones

string[]

リソースの取得場所を表す可用性ゾーンの一覧。

ApiManagementServiceSkuProperties

Object

API Management サービス リソース SKU のプロパティ。

名前 型 説明
capacity

integer (int32)

SKU の容量 (SKU のデプロイされたユニットの数)。 従量課金 SKU の容量は 0 として指定する必要があります。
name

SkuType

SKU の名前。

ApimIdentityType

列挙

リソースに使用される ID の種類。 型 'SystemAssigned, UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' は、サービスからすべての ID を削除します。

値 説明
SystemAssigned
UserAssigned
SystemAssigned, UserAssigned
None

ApiVersionConstraint

Object

API Management サービスのコントロール プレーン API のバージョン制約。

名前 型 説明
minApiVersion

string

この値以上のバージョンを使用して、API Management サービスへのコントロール プレーン 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

列挙

証明書ソース。

値 説明
Managed
KeyVault
Custom
BuiltIn

CertificateStatus

列挙

証明書の状態。

値 説明
Completed
Failed
InProgress

ConfigurationApi

Object

API Management サービスの構成 API に関する情報。

名前 型 規定値 説明
legacyApi

LegacyApiState

Enabled

レガシ構成 API (v1) を API Management サービスで公開する必要があるかどうかを示します。 値は省略可能ですが、'Enabled' または 'Disabled' である必要があります。 "無効" の場合、レガシ構成 API (v1) はセルフホステッド ゲートウェイでは使用できません。 既定値は 'Enabled' です

createdByType

列挙

リソースを作成した ID の種類。

値 説明
User
Application
ManagedIdentity
Key

developerPortalStatus

列挙

この API Management サービスの開発者ポータルの状態。

値 説明
Enabled

開発者ポータルは、サービスに対して有効になっています。
Disabled

開発者ポータルは、サービスに対して無効になっています。

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

このホスト名に関連付けられている証明書を既定の SSL 証明書として設定するには、true を指定します。 クライアントが SNI ヘッダーを送信しない場合、これはチャレンジされる証明書になります。 このプロパティは、サービスで複数のカスタム ホスト名が有効になっていて、既定の ssl 証明書を決定する必要がある場合に便利です。 この設定は、ゲートウェイのホスト名の種類にのみ適用されます。
encodedCertificate

string

Base64 でエンコードされた証明書。
hostName

string

Api Management サービスで構成するホスト名。
identityClientId

string

Azure AD によって生成されたシステムまたはユーザー割り当てマネージド ID clientId。SSL 証明書を含む keyVault への GET アクセス権を持ちます。
keyVaultId

string

Ssl 証明書を含む KeyVault シークレットの URL。 バージョンを含む絶対 URL が指定されている場合、ssl 証明書の自動更新は機能しません。 そのためには、api Management サービスを aka.ms/apimmsi で構成する必要があります。 シークレットの種類は application/x-pkcs12 する必要があります
negotiateClientCertificate

boolean

False

ホスト名のクライアント証明書を常にネゴシエートするには、true を指定します。 既定値は false です。
type

HostnameType

ホスト名の種類。

HostnameType

列挙

ホスト名の種類。

値 説明
Proxy
Portal
Management
Scm
DeveloperPortal
ConfigurationApi

LegacyApiState

列挙

レガシ構成 API (v1) を API Management サービスで公開する必要があるかどうかを示します。 値は省略可能ですが、'Enabled' または 'Disabled' である必要があります。 "無効" の場合、レガシ構成 API (v1) はセルフホステッド ゲートウェイでは使用できません。 既定値は 'Enabled' です

値 説明
Enabled

サービスに対してレガシ構成 API (v1) が有効になっており、セルフホステッド ゲートウェイがそれに接続できます。
Disabled

サービスのレガシ構成 API (v1) は無効になっており、セルフホステッド ゲートウェイはそれに接続できません。

LegacyPortalStatus

列挙

API Management サービスのレガシ ポータルの状態。

値 説明
Enabled

サービスに対してレガシ ポータルが有効になっています。
Disabled

サービスに対してレガシ ポータルが無効になっています。

NatGatewayState

列挙

プロパティを使用して、この API Management サービスの NAT ゲートウェイを有効にすることができます。

値 説明
Enabled

サービスに対して Nat Gateway が有効になっています。
Disabled

Nat Gateway はサービスに対して無効になっています。

PlatformVersion

列挙

サービスを実行しているコンピューティング プラットフォームのバージョン。

値 説明
undetermined

コンピューティング プラットフォームがデプロイされていないため、プラットフォームのバージョンを特定できません。
stv1

シングル テナント V1 プラットフォームでサービスを実行しているプラットフォーム。
stv2

シングル テナント V2 プラットフォームでサービスを実行しているプラットフォーム。
mtv1

マルチテナント V1 プラットフォームでサービスを実行しているプラットフォーム。
stv2.1

新しいハードウェア上のシングル テナント V2 プラットフォームでサービスを実行するプラットフォーム。

PrivateEndpointServiceConnectionStatus

列挙

プライベート エンドポイント接続の状態。

値 説明
Pending
Approved
Rejected

PrivateLinkServiceConnectionState

Object

サービス コンシューマーとプロバイダー間の接続の状態に関する情報のコレクション。

名前 型 説明
actionsRequired

string

サービス プロバイダーの変更にコンシューマーの更新が必要かどうかを示すメッセージ。
description

string

接続の承認/拒否の理由。
status

PrivateEndpointServiceConnectionStatus

接続がサービスの所有者によって承認/拒否/削除されたかどうかを示します。

PublicNetworkAccess

列挙

この API Management サービスに対してパブリック エンドポイント アクセスが許可されているかどうか。 値は省略可能ですが、渡される場合は 'Enabled' または 'Disabled' である必要があります。 "無効" の場合、プライベート エンドポイントは排他アクセス方法です。 既定値は 'Enabled' です

値 説明
Enabled
Disabled

RemotePrivateEndpointConnectionWrapper

Object

リモート プライベート エンドポイント接続リソース。

名前 型 説明
id

string

プライベート エンドポイント接続リソース ID
name

string

プライベート エンドポイント接続名
properties.groupIds

string[]

すべてのグループ ID。
properties.privateEndpoint

ArmIdWrapper

プライベート エンドポイントのリソース。
properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

サービス コンシューマーとプロバイダー間の接続の状態に関する情報のコレクション。
properties.provisioningState

string

プライベート エンドポイント接続リソースのプロビジョニング状態。
type

string

プライベート エンドポイント接続リソースの種類

SkuType

列挙

SKU の名前。

値 説明
Developer

Api Management の開発者 SKU。
Standard

Api Management の Standard SKU。
Premium

Api Management の Premium SKU。
Basic

Api Management の Basic SKU。
Consumption

Api Management の従量課金 SKU。
Isolated

Api Management の分離 SKU。
BasicV2

Api Management の BasicV2 SKU。
StandardV2

Api Management の StandardV2 SKU。

systemData

Object

リソースの作成と最後の変更に関連するメタデータ。

名前 型 説明
createdAt

string (date-time)

リソース作成のタイムスタンプ (UTC)。
createdBy

string

リソースを作成した ID。
createdByType

createdByType

リソースを作成した ID の種類。
lastModifiedAt

string (date-time)

リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy

string

リソースを最後に変更した ID。
lastModifiedByType

createdByType

リソースを最後に変更した ID の種類。

UserIdentityProperties

Object
名前 型 説明
clientId

string

ユーザー割り当て ID のクライアント ID。
principalId

string

ユーザー割り当て ID のプリンシパル ID。

VirtualNetworkConfiguration

Object

API Management サービスのデプロイ先となる仮想ネットワークの構成。

名前 型 説明
subnetResourceId

string

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

API Management サービスをデプロイする仮想ネットワーク内のサブネットの完全なリソース ID。
subnetname

string

サブネットの名前。
vnetid

string

仮想ネットワーク ID。 これは通常、GUID です。 既定では null GUID が必要です。

VirtualNetworkType

列挙

API Management サービスを構成する必要がある VPN の種類。 None (既定値) は、API Management サービスが仮想ネットワークに含まれていないことを意味し、外部は、インターネットに接続するエンドポイントを持つ仮想ネットワーク内に API Management デプロイが設定されていることを意味し、内部はイントラネットに接続するエンドポイントのみを持つ仮想ネットワーク内で API Management のデプロイが設定されることを意味します。

値 説明
None

サービスは仮想ネットワークの一部ではありません。
External

このサービスは仮想ネットワークの一部であり、インターネットからアクセスできます。
Internal

サービスは仮想ネットワークの一部であり、仮想ネットワーク内からのみアクセスできます。