Api Management Service - Update

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

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

URI パラメーター

Name In Required Type Description
resourceGroupName
path True
  • string

リソース グループの名前。

serviceName
path True
  • string

API Management サービスの名前。

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True
  • string

サブスクリプションを一意に識別するサブスクリプション資格情報Microsoft Azure。 サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。

api-version
query True
  • string

クライアント要求で使用する API のバージョン。

要求本文

Name Type Description
identity

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

properties.additionalLocations

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

properties.apiVersionConstraint

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

properties.certificates

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

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 を除くすべての設定の既定値は、サービスが True 2018 年 4 月 1 日以前に作成されたかどうか、 False それ以外の場合です。 Http2 設定の既定値は False.

TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]、TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA、TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA、TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA、TLS_RSA_WITH_AES_128_GCM_SHA256、TLS_RSA_WITH_AES_256_CBC_SHA256、 TLS_RSA_WITH_AES_128_CBC_SHA256、TLS_RSA_WITH_AES_256_CBC_SHA、TLS_RSA_WITH_AES_128_CBC_SHA。 たとえば、 Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256:false. 既定値はそれらの true 値です。 注: 次の暗号は、Azure CloudService 内部コンポーネント (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,TLS_RSA_WITH_AES_256_GCM_SHA384

properties.disableGateway
  • boolean

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

properties.enableClientCertificate
  • boolean

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

properties.hostnameConfigurations

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

properties.notificationSenderEmail
  • string

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

properties.privateEndpointConnections

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

properties.publicIpAddressId
  • string

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

properties.publicNetworkAccess

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

properties.publisherEmail
  • string

電子メールPublisherします。

properties.publisherName
  • string

Publisher名。

properties.restore
  • boolean

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

properties.virtualNetworkConfiguration

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

properties.virtualNetworkType

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

sku

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

tags
  • object

リソース タグ。

zones
  • string[]

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

応答

Name Type Description
200 OK

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

202 Accepted

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

Other Status Codes

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

セキュリティ

azure_auth

OAuth2 FlowをAzure Active Directoryします。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation ユーザー アカウントを偽装する

ApiManagementUpdateServiceDisableTls10
ApiManagementUpdateServicePublisherDetails
ApiManagementUpdateServiceToNewVnetAndAvailabilityZones

ApiManagementUpdateServiceDisableTls10

Sample Request

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1?api-version=2021-12-01-preview

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

Sample Response

{
  "id": "/subscriptions/subid/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

Sample Request

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1?api-version=2021-12-01-preview

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

Sample Response

{
  "id": "/subscriptions/subid/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

Sample Request

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1?api-version=2021-12-01-preview

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

Sample Response

location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/TGV2eTExMDZtMDJfVGVybV9jMmZlY2QwMA==?api-version=2021-12-01-preview
{
  "id": "/subscriptions/subid/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/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/apimaeavnet/subnets/default"
        },
        "gatewayRegionalUrl": "https://apimService1-australiaeast-01.regional.azure-api.net",
        "disableGateway": false,
        "publicIpAddressId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/apim-australia-east-publicip",
        "platformVersion": "stv2"
      }
    ],
    "virtualNetworkConfiguration": {
      "subnetResourceId": "/subscriptions/subid/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/subid/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 応答の 1 つのAPI Management サービス リソース。

ApiManagementServiceSkuProperties

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

ApiManagementServiceUpdateParameters

Update Api Management Service に指定されたパラメーター。

ApimIdentityType

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

ApiVersionConstraint

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

ArmIdWrapper

ARM リソース ID のラッパー

CertificateConfiguration

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

CertificateInformation

SSL 証明書情報。

CertificateSource

証明書のソース。

CertificateStatus

証明書の状態。

createdByType

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

ErrorFieldContract

エラー フィールド コントラクト。

ErrorResponse

エラー応答。

HostnameConfiguration

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

HostnameType

ホスト名の種類。

PlatformVersion

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

PrivateEndpointServiceConnectionStatus

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

PrivateLinkServiceConnectionState

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

PublicNetworkAccess

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

RemotePrivateEndpointConnectionWrapper

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

SkuType

SKU の名前。

systemData

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

UserIdentityProperties
VirtualNetworkConfiguration

API Management サービスがデプロイされる仮想ネットワークの構成。

VirtualNetworkType

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

AdditionalLocation

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

Name Type Default Value Description
disableGateway
  • boolean
False

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

gatewayRegionalUrl
  • string

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

location
  • string

Azure Data Center リージョン間の追加リージョンの場所名。

platformVersion

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

privateIPAddresses
  • string[]

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

publicIPAddresses
  • string[]

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

publicIpAddressId
  • string

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

sku

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

virtualNetworkConfiguration

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

zones
  • string[]

リソースの入手先を表す可用性ゾーンの一覧。

ApiManagementServiceIdentity

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

Name Type Description
principalId
  • string

ID のプリンシパル ID。

tenantId
  • string

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

type

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

userAssignedIdentities

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

ApiManagementServiceResource

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

Name Type Default Value Description
etag
  • string

リソースの ETag。

id
  • string

リソースの ID

identity

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

location
  • string

リソースの場所。

name
  • string

リソース名。

properties.additionalLocations

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

properties.apiVersionConstraint

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

properties.certificates

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

properties.createdAtUtc
  • string

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 を除くすべての設定の既定値は、サービスが True 2018 年 4 月 1 日以前に作成されたかどうか、それ以外の False 場合です。 Http2 設定の既定値は False.

TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]、TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA、TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA、TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA、TLS_RSA_WITH_AES_128_GCM_SHA256、TLS_RSA_WITH_AES_256_CBC_SHA256、 TLS_RSA_WITH_AES_128_CBC_SHA256、TLS_RSA_WITH_AES_256_CBC_SHA、TLS_RSA_WITH_AES_128_CBC_SHA。 たとえば、 Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256:false. 既定値はそれらの true 値です。 注: 次の暗号は、Azure CloudService 内部コンポーネント (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,TLS_RSA_WITH_AES_256_GCM_SHA384

properties.developerPortalUrl
  • string

API Management サービスの DEveloper ポータル エンドポイント 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

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

properties.managementApiUrl
  • string

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

properties.notificationSenderEmail
  • string

通知の送信先となるメール アドレス。

properties.platformVersion

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

properties.portalUrl
  • string

API Management サービスのポータル エンドポイント URL をPublisherします。

properties.privateEndpointConnections

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

properties.privateIPAddresses
  • string[]

内部Virtual Networkにデプロイされているプライマリ リージョンのAPI Management サービスのプライベート静的負荷分散 IP アドレス。 Basic、Standard、プレミアム、Isolated SKU でのみ使用できます。

properties.provisioningState
  • string

API Management サービスの現在のプロビジョニング状態。作成/アクティブ化/成功/更新/失敗/停止/終了/終了/終了Failed/Deletedのいずれかになります。

properties.publicIPAddresses
  • string[]

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

properties.publicIpAddressId
  • string

リージョンにデプロイされたサービスVirtual Network関連付けるパブリック Standard SKU IP V4 ベースの IP アドレス。 Virtual Networkにデプロイされている開発者およびプレミアム SKU に対してのみサポートされます。

properties.publicNetworkAccess

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

properties.publisherEmail
  • string

電子メールPublisher。

properties.publisherName
  • string

Publisher名。

properties.restore
  • boolean
False

以前に論理的に削除された場合は、削除を取り消します。 このフラグが指定され、True に設定されている場合、他のすべてのプロパティは無視されます。

properties.scmUrl
  • string

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

properties.targetProvisioningState
  • string

API Management サービスのプロビジョニング状態。これは、サービスで開始された実行時間の長い操作によって対象となります。

properties.virtualNetworkConfiguration

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

properties.virtualNetworkType None

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

sku

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

systemData

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

tags
  • object

リソース タグ。

type
  • string

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

zones
  • string[]

リソースの入手先を表す可用性ゾーンの一覧。

ApiManagementServiceSkuProperties

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

Name Type Description
capacity
  • integer

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

name

SKU の名前。

ApiManagementServiceUpdateParameters

Update Api Management Service に指定されたパラメーター。

Name Type Default Value Description
etag
  • string

リソースの ETag。

id
  • string

リソースの ID

identity

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

name
  • string

リソース名。

properties.additionalLocations

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

properties.apiVersionConstraint

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

properties.certificates

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

properties.createdAtUtc
  • string

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 を除くすべての設定の既定値は、サービスが True 2018 年 4 月 1 日以前に作成されたかどうか、それ以外の False 場合です。 Http2 設定の既定値は False.

TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]、TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA、TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA、TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA、TLS_RSA_WITH_AES_128_GCM_SHA256、TLS_RSA_WITH_AES_256_CBC_SHA256、 TLS_RSA_WITH_AES_128_CBC_SHA256、TLS_RSA_WITH_AES_256_CBC_SHA、TLS_RSA_WITH_AES_128_CBC_SHA。 たとえば、 Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256:false. 既定値はそれらの true 値です。 注: 次の暗号は、Azure CloudService 内部コンポーネント (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,TLS_RSA_WITH_AES_256_GCM_SHA384

properties.developerPortalUrl
  • string

API Management サービスの DEveloper ポータル エンドポイント 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

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

properties.managementApiUrl
  • string

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

properties.notificationSenderEmail
  • string

通知の送信先となるメール アドレス。

properties.platformVersion

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

properties.portalUrl
  • string

API Management サービスのポータル エンドポイント URL をPublisherします。

properties.privateEndpointConnections

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

properties.privateIPAddresses
  • string[]

内部Virtual Networkにデプロイされているプライマリ リージョンのAPI Management サービスのプライベート静的負荷分散 IP アドレス。 Basic、Standard、プレミアム、Isolated SKU でのみ使用できます。

properties.provisioningState
  • string

API Management サービスの現在のプロビジョニング状態。作成/アクティブ化/成功/更新/失敗/停止/終了/終了/終了Failed/Deletedのいずれかになります。

properties.publicIPAddresses
  • string[]

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

properties.publicIpAddressId
  • string

リージョンにデプロイされたサービスVirtual Network関連付けるパブリック Standard SKU IP V4 ベースの IP アドレス。 Virtual Networkにデプロイされている開発者およびプレミアム SKU に対してのみサポートされます。

properties.publicNetworkAccess

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

properties.publisherEmail
  • string

電子メールPublisher。

properties.publisherName
  • string

Publisher名。

properties.restore
  • boolean
False

以前に論理的に削除された場合は、削除を取り消します。 このフラグが指定され、True に設定されている場合、他のすべてのプロパティは無視されます。

properties.scmUrl
  • string

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

properties.targetProvisioningState
  • string

API Management サービスのプロビジョニング状態。これは、サービスで開始された実行時間の長い操作によって対象となります。

properties.virtualNetworkConfiguration

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

properties.virtualNetworkType None

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

sku

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

tags
  • object

リソース タグ。

type
  • string

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

zones
  • string[]

リソースの入手先を表す可用性ゾーンの一覧。

ApimIdentityType

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

Name Type Description
None
  • string
SystemAssigned
  • string
SystemAssigned, UserAssigned
  • string
UserAssigned
  • string

ApiVersionConstraint

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

Name Type Description
minApiVersion
  • string

コントロール プレーン API 呼び出しを、この値以上のバージョンでAPI Managementサービスに制限します。

ArmIdWrapper

ARM リソース ID のラッパー

Name Type Description
id
  • string

CertificateConfiguration

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

Name Type Description
certificate

証明書情報。

certificatePassword
  • string

証明書のパスワード。

encodedCertificate
  • string

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

storeName enum:
  • CertificateAuthority
  • Root

System.Security.Cryptography.x509certificates.StoreName 証明書ストアの場所。 ルートと CertificateAuthority のみが有効な場所です。

CertificateInformation

SSL 証明書情報。

Name Type Description
expiry
  • string

証明書の有効期限。 日付は、ISO 8601 標準で指定されている形式 yyyy-MM-ddTHH:mm:ssZ に準拠しています。

subject
  • string

証明書のサブジェクト。

thumbprint
  • string

証明書の拇印。

CertificateSource

証明書のソース。

Name Type Description
BuiltIn
  • string
Custom
  • string
KeyVault
  • string
Managed
  • string

CertificateStatus

証明書の状態。

Name Type Description
Completed
  • string
Failed
  • string
InProgress
  • string

createdByType

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

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

ErrorFieldContract

エラー フィールド コントラクト。

Name Type Description
code
  • string

プロパティ レベルのエラー コード。

message
  • string

プロパティ レベルエラーの人間が判読できる表現。

target
  • string

プロパティ名。

ErrorResponse

エラー応答。

Name Type Description
error.code
  • string

サービスによって定義されたエラー コード。 このコードは、応答に指定された HTTP エラー コードのサブステータスとして機能します。

error.details

検証エラーが発生した場合に要求で送信される無効なフィールドの一覧。

error.message
  • string

人が判読できるエラーの表現。

HostnameConfiguration

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

Name Type Default Value Description
certificate

証明書情報。

certificatePassword
  • string

証明書のパスワード。

certificateSource

証明書のソース。

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

ホスト名の種類。

Name Type Description
DeveloperPortal
  • string
Management
  • string
Portal
  • string
Proxy
  • string
Scm
  • string

PlatformVersion

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

Name Type Description
mtv1
  • string

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

stv1
  • string

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

stv2
  • string

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

undetermined
  • string

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

PrivateEndpointServiceConnectionStatus

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

Name Type Description
Approved
  • string
Pending
  • string
Rejected
  • string

PrivateLinkServiceConnectionState

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

Name Type Description
actionsRequired
  • string

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

description
  • string

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

status

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

PublicNetworkAccess

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

Name Type Description
Disabled
  • string
Enabled
  • string

RemotePrivateEndpointConnectionWrapper

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

Name Type Description
id
  • string

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

name
  • string

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

properties.groupIds
  • string[]

すべてのグループ ID。

properties.privateEndpoint

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

properties.privateLinkServiceConnectionState

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

properties.provisioningState
  • string

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

type
  • string

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

SkuType

SKU の名前。

Name Type Description
Basic
  • string

Api Management の基本的な SKU。

Consumption
  • string

Api Management の従量課金 SKU。

Developer
  • string

Api Management の開発者 SKU。

Isolated
  • string

Api Management の分離された SKU。

Premium
  • string

Api Management の SKU をプレミアムします。

Standard
  • string

Api Management の Standard SKU。

systemData

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

Name Type Description
createdAt
  • string

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

createdBy
  • string

リソースを作成した ID。

createdByType

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

lastModifiedAt
  • string

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

lastModifiedBy
  • string

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

lastModifiedByType

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

UserIdentityProperties

Name Type Description
clientId
  • string

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

principalId
  • string

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

VirtualNetworkConfiguration

API Management サービスがデプロイされる仮想ネットワークの構成。

Name Type Description
subnetResourceId
  • string

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

subnetname
  • string

サブネットの名前。

vnetid
  • string

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

VirtualNetworkType

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

Name Type Description
External
  • string

サービスはVirtual Networkの一部であり、インターネットからアクセスできます。

Internal
  • string

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

None
  • string

サービスは、Virtual Networkの一部ではありません。