Api Management Service - Update

リファレンス

サービス:: API Management

API バージョン:: 2024-05-01

既存の API Management サービスを更新します。

PATCH 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 バージョン。

要求本文

名前	型	説明
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.publisherEmail	string maxLength: 100	発行元の電子メール。
properties.publisherName	string maxLength: 100	発行元名。
properties.restore	boolean	以前に論理的に削除された場合は、Api Management サービスの削除を取り消します。このフラグを指定し、True に設定すると、他のすべてのプロパティは無視されます。
properties.virtualNetworkConfiguration	VirtualNetworkConfiguration	API Management サービスの仮想ネットワーク構成。
properties.virtualNetworkType	VirtualNetworkType	API Management サービスを構成する必要がある VPN の種類。 None (既定値) は、API Management サービスが仮想ネットワークに含まれていないことを意味し、外部は、インターネットに接続するエンドポイントを持つ仮想ネットワーク内に API Management デプロイが設定されていることを意味し、内部はイントラネットに接続するエンドポイントのみを持つ仮想ネットワーク内で API Management のデプロイが設定されることを意味します。
sku	ApiManagementServiceSkuProperties	API Management サービスの SKU プロパティ。
tags	object	リソースタグ。
zones	string[]	リソースの取得場所を表す可用性ゾーンの一覧。

応答

名前	型	説明
200 OK	ApiManagementServiceResource	サービスが正常に更新されました。
202 Accepted		サービス更新要求が受け入れられました。ヘッダー location: string
Other Status Codes	ErrorResponse	操作が失敗した理由を説明するエラー応答。

名前

型

説明

200 OK

ApiManagementServiceResource

サービスが正常に更新されました。

202 Accepted

サービス更新要求が受け入れられました。

ヘッダー

location: string

Other Status Codes

ErrorResponse

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

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

ApiManagementUpdateServiceDisableTls10

ApiManagementUpdateServicePublisherDetails

ApiManagementUpdateServiceToNewVnetAndAvailabilityZones

ApiManagementUpdateServiceDisableTls10

要求のサンプル

HTTP

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

{
  "properties": {
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "false"
    }
  }
}

応答のサンプル

状態コード:: 202

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

状態コード:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "Owner": "sasolank",
    "UID": "4f5025fe-0669-4e2e-8320-5199466e5eb3",
    "Reserved": "",
    "TestExpiration": "Thu, 29 Jun 2017 18:50:40 GMT",
    "Pool": "Manual",
    "TestSuiteExpiration": "Thu, 29 Jun 2017 18:51:46 GMT"
  },
  "location": "West US",
  "etag": "AAAAAAAYRPs=",
  "properties": {
    "publisherEmail": "admin@live.com",
    "publisherName": "Contoso",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2017-06-29T17:50:42.3191122Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "portalUrl": "https://apimService1.portal.azure-api.net",
    "managementApiUrl": "https://apimService1.management.azure-api.net",
    "scmUrl": "https://apimService1.scm.azure-api.net",
    "hostnameConfigurations": [],
    "publicIPAddresses": [
      "40.86.176.232"
    ],
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False"
    },
    "virtualNetworkType": "None"
  },
  "sku": {
    "name": "Standard",
    "capacity": 1
  }
}

ApiManagementUpdateServicePublisherDetails

要求のサンプル

HTTP

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

{
  "properties": {
    "publisherEmail": "foobar@live.com",
    "publisherName": "Contoso Vnext"
  }
}

応答のサンプル

状態コード:: 202

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

状態コード:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "Owner": "sasolank",
    "UID": "4f5025fe-0669-4e2e-8320-5199466e5eb3",
    "Reserved": "",
    "TestExpiration": "Thu, 29 Jun 2017 18:50:40 GMT",
    "Pool": "Manual",
    "TestSuiteExpiration": "Thu, 29 Jun 2017 18:51:46 GMT"
  },
  "location": "West US",
  "etag": "AAAAAAAYRPs=",
  "properties": {
    "publisherEmail": "foobar@live.com",
    "publisherName": "Contoso Vnext",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2017-06-29T17:50:42.3191122Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "portalUrl": "https://apimService1.portal.azure-api.net",
    "managementApiUrl": "https://apimService1.management.azure-api.net",
    "scmUrl": "https://apimService1.scm.azure-api.net",
    "hostnameConfigurations": [],
    "publicIPAddresses": [
      "40.86.176.232"
    ],
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False"
    },
    "virtualNetworkType": "None"
  },
  "sku": {
    "name": "Standard",
    "capacity": 1
  }
}

ApiManagementUpdateServiceToNewVnetAndAvailabilityZones

要求のサンプル

HTTP

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

{
  "properties": {
    "additionalLocations": [
      {
        "location": "Australia East",
        "sku": {
          "name": "Premium",
          "capacity": 3
        },
        "zones": [
          "1",
          "2",
          "3"
        ],
        "virtualNetworkConfiguration": {
          "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/apimaeavnet/subnets/default"
        },
        "publicIpAddressId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/apim-australia-east-publicip"
      }
    ],
    "virtualNetworkConfiguration": {
      "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet-apim-japaneast/subnets/apim2"
    },
    "virtualNetworkType": "External",
    "publicIpAddressId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/publicip-apim-japan-east"
  },
  "sku": {
    "name": "Premium",
    "capacity": 3
  },
  "zones": [
    "1",
    "2",
    "3"
  ]
}

応答のサンプル

状態コード:: 202

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

状態コード:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "location": "Japan East",
  "etag": "AAAAAAAWBIU=",
  "properties": {
    "publisherEmail": "contoso@microsoft.com",
    "publisherName": "apimPublisher",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2021-04-08T23:41:35.6447381Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "gatewayRegionalUrl": "https://apimService1-japaneast-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": "mycustomdomain.int-azure-api.net",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2022-06-09T23:59:59+00:00",
          "thumbprint": "2994B5FFB8F76B3C687D324A8DEE0432C1ED18CD",
          "subject": "CN=mycustomdomain.int-azure-api.net"
        },
        "defaultSslBinding": true,
        "certificateSource": "Managed"
      }
    ],
    "publicIPAddresses": [
      "20.78.248.217"
    ],
    "additionalLocations": [
      {
        "location": "Australia East",
        "sku": {
          "name": "Premium",
          "capacity": 3
        },
        "zones": [
          "1",
          "2",
          "3"
        ],
        "publicIPAddresses": [
          "20.213.1.35"
        ],
        "virtualNetworkConfiguration": {
          "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/apimaeavnet/subnets/default"
        },
        "gatewayRegionalUrl": "https://apimService1-australiaeast-01.regional.azure-api.net",
        "disableGateway": false,
        "publicIpAddressId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/apim-australia-east-publicip",
        "platformVersion": "stv2"
      }
    ],
    "virtualNetworkConfiguration": {
      "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet-apim-japaneast/subnets/apim2"
    },
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_GCM_SHA256": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_256_CBC_SHA256": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_256_CBC_SHA": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "false",
      "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.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": "Internal",
    "disableGateway": false,
    "publicIpAddressId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/publicip-apim-japan-east",
    "publicNetworkAccess": "Enabled",
    "platformVersion": "stv2"
  },
  "sku": {
    "name": "Premium",
    "capacity": 3
  },
  "zones": [
    "1",
    "2",
    "3"
  ],
  "systemData": {
    "lastModifiedBy": "contoso@microsoft.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2022-01-21T20:04:21.6108974Z"
  }
}

定義

名前	説明
AdditionalLocation	追加の API Management リソースの場所の説明。
ApiManagementServiceIdentity	Api Management サービスリソースの ID プロパティ。
ApiManagementServiceResource	List または Get 応答の単一の API Management サービスリソース。
ApiManagementServiceSkuProperties	API Management サービスリソース SKU のプロパティ。
ApiManagementServiceUpdateParameters	Update Api Management サービスに指定されたパラメーター。
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 の名前。

ApiManagementServiceUpdateParameters

Object

Update Api Management サービスに指定されたパラメーター。

名前	型	規定値	説明
etag	string		リソースの ETag。
id	string		リソース ID。
identity	ApiManagementServiceIdentity		Api Management サービスのマネージドサービス ID。
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 プロパティ。
tags	object		リソースタグ。
type	string		API Management リソースのリソースの種類が Microsoft.ApiManagement に設定されています。
zones	string[]		リソースの取得場所を表す可用性ゾーンの一覧。

ApimIdentityType

列挙

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

値	説明
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

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

列挙

証明書ソース。

値	説明
BuiltIn
Custom
KeyVault
Managed

CertificateStatus

列挙

証明書の状態。

値	説明
Completed
Failed
InProgress

ConfigurationApi

Object

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

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

createdByType

列挙

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

値	説明
Application
Key
ManagedIdentity
User

developerPortalStatus

列挙

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

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

ErrorAdditionalInfo

Object

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

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラーメッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラーオブジェクト。

HostnameConfiguration

Object

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

名前	型	規定値	説明
certificate	CertificateInformation		証明書情報。
certificatePassword	string		証明書パスワード。
certificateSource	CertificateSource		証明書ソース。
certificateStatus	CertificateStatus		証明書の状態。
defaultSslBinding	boolean	False	このホスト名に関連付けられている証明書を既定の 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

列挙

ホスト名の種類。

値	説明
ConfigurationApi
DeveloperPortal
Management
Portal
Proxy
Scm

LegacyApiState

列挙

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

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

LegacyPortalStatus

列挙

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

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

NatGatewayState

列挙

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

値	説明
Disabled	Nat Gateway はサービスに対して無効になっています。
Enabled	サービスに対して Nat Gateway が有効になっています。

PlatformVersion

列挙

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

値	説明
mtv1	マルチテナント V1 プラットフォームでサービスを実行しているプラットフォーム。
stv1	シングルテナント V1 プラットフォームでサービスを実行しているプラットフォーム。
stv2	シングルテナント V2 プラットフォームでサービスを実行しているプラットフォーム。
stv2.1	新しいハードウェア上のシングルテナント V2 プラットフォームでサービスを実行するプラットフォーム。
undetermined	コンピューティングプラットフォームがデプロイされていないため、プラットフォームのバージョンを特定できません。

PrivateEndpointServiceConnectionStatus

列挙

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

値	説明
Approved
Pending
Rejected

PrivateLinkServiceConnectionState

Object

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

名前	型	説明
actionsRequired	string	サービスプロバイダーの変更にコンシューマーの更新が必要かどうかを示すメッセージ。
description	string	接続の承認/拒否の理由。
status	PrivateEndpointServiceConnectionStatus	接続がサービスの所有者によって承認/拒否/削除されたかどうかを示します。

PublicNetworkAccess

列挙

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

値	説明
Disabled
Enabled

RemotePrivateEndpointConnectionWrapper

Object

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

名前	型	説明
id	string	プライベートエンドポイント接続リソース ID
name	string	プライベートエンドポイント接続名
properties.groupIds	string[]	すべてのグループ ID。
properties.privateEndpoint	ArmIdWrapper	プライベートエンドポイントのリソース。
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	サービスコンシューマーとプロバイダー間の接続の状態に関する情報のコレクション。
properties.provisioningState	string	プライベートエンドポイント接続リソースのプロビジョニング状態。
type	string	プライベートエンドポイント接続リソースの種類

SkuType

列挙

SKU の名前。

値	説明
Basic	Api Management の Basic SKU。
BasicV2	Api Management の BasicV2 SKU。
Consumption	Api Management の従量課金 SKU。
Developer	Api Management の開発者 SKU。
Isolated	Api Management の分離 SKU。
Premium	Api Management の Premium SKU。
Standard	Api Management の Standard 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 のデプロイが設定されることを意味します。

値	説明
External	このサービスは仮想ネットワークの一部であり、インターネットからアクセスできます。
Internal	サービスは仮想ネットワークの一部であり、仮想ネットワーク内からのみアクセスできます。
None	サービスは仮想ネットワークの一部ではありません。

次の方法で共有

Api Management Service - Update

URI パラメーター

要求本文

応答

セキュリティ

azure_auth

スコープ

例

ApiManagementUpdateServiceDisableTls10

要求のサンプル

応答のサンプル

ApiManagementUpdateServicePublisherDetails

要求のサンプル

応答のサンプル

ApiManagementUpdateServiceToNewVnetAndAvailabilityZones

要求のサンプル

応答のサンプル

定義

AdditionalLocation

ApiManagementServiceIdentity

ApiManagementServiceResource

ApiManagementServiceSkuProperties

ApiManagementServiceUpdateParameters

ApimIdentityType

ApiVersionConstraint

ArmIdWrapper

CertificateConfiguration

CertificateInformation

CertificateSource

CertificateStatus

ConfigurationApi

createdByType

developerPortalStatus

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

HostnameConfiguration

HostnameType

LegacyApiState

LegacyPortalStatus

NatGatewayState

PlatformVersion

PrivateEndpointServiceConnectionStatus

PrivateLinkServiceConnectionState

PublicNetworkAccess

RemotePrivateEndpointConnectionWrapper

SkuType

systemData

UserIdentityProperties

VirtualNetworkConfiguration

VirtualNetworkType

その他のリソース