Microsoft.ApiManagement サービス
Bicep リソース定義
サービス リソースの種類は、次を対象とする操作でデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.ApiManagement/service リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.ApiManagement/service@2023-05-01-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
{customized property}: 'string'
sku: {
capacity: int
name: 'string'
}
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {
clientId: 'string'
principalId: 'string'
}
}
}
properties: {
additionalLocations: [
{
disableGateway: bool
location: 'string'
natGatewayState: 'string'
publicIpAddressId: 'string'
sku: {
capacity: int
name: 'string'
}
virtualNetworkConfiguration: {
subnetResourceId: 'string'
}
zones: [
'string'
]
}
]
apiVersionConstraint: {
minApiVersion: 'string'
}
certificates: [
{
certificate: {
expiry: 'string'
subject: 'string'
thumbprint: 'string'
}
certificatePassword: 'string'
encodedCertificate: 'string'
storeName: 'string'
}
]
configurationApi: {
legacyApi: 'string'
}
customProperties: {
{customized property}: 'string'
}
developerPortalStatus: 'string'
disableGateway: bool
enableClientCertificate: bool
hostnameConfigurations: [
{
certificate: {
expiry: 'string'
subject: 'string'
thumbprint: 'string'
}
certificatePassword: 'string'
certificateSource: 'string'
certificateStatus: 'string'
defaultSslBinding: bool
encodedCertificate: 'string'
hostName: 'string'
identityClientId: 'string'
keyVaultId: 'string'
negotiateClientCertificate: bool
type: 'string'
}
]
legacyPortalStatus: 'string'
natGatewayState: 'string'
notificationSenderEmail: 'string'
privateEndpointConnections: [
{
id: 'string'
name: 'string'
properties: {
privateEndpoint: {}
privateLinkServiceConnectionState: {
actionsRequired: 'string'
description: 'string'
status: 'string'
}
}
type: 'string'
}
]
publicIpAddressId: 'string'
publicNetworkAccess: 'string'
publisherEmail: 'string'
publisherName: 'string'
restore: bool
virtualNetworkConfiguration: {
subnetResourceId: 'string'
}
virtualNetworkType: 'string'
}
zones: [
'string'
]
}
プロパティ値
サービス (service)
| 名前 | 説明 | 値 |
|---|---|---|
| name | リソース名 | string (必須) 文字制限: 1 から 50 有効な文字: 英数字とハイフン。 先頭は文字、末尾は英数字にします。 リソース名は、Azure 全体で一意である必要があります。 |
| location | リソースの場所。 | string (必須) |
| tags | リソース タグ。 | タグの名前と値のディクショナリ。 「テンプレート内のタグ」を参照してください |
| sku | API Management サービスの SKU プロパティ。 | ApiManagementServiceSkuProperties (必須) |
| identity | Api Management サービスのマネージド サービス ID。 | ApiManagementServiceIdentity |
| properties | API Management サービスのプロパティ。 | ApiManagementServiceProperties (必須) |
| ゾーン | リソースの取得元を表す可用性ゾーンの一覧。 | string[] |
ApiManagementServiceIdentity
| 名前 | 説明 | 値 |
|---|---|---|
| type | リソースに使用される ID の種類。 種類 "SystemAssigned、UserAssigned" には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' は、サービスからすべての ID を削除します。 | 'None' 'SystemAssigned' 'SystemAssigned、UserAssigned' 'UserAssigned' (必須) |
| userAssignedIdentities | リソースに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ キー参照は、次の形式の ARM リソース ID になります。 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' |
ApiManagementServiceIdentityUserAssignedIdentities |
ApiManagementServiceIdentityUserAssignedIdentities
| 名前 | 説明 | 値 |
|---|---|---|
| {カスタマイズされたプロパティ} | UserIdentityProperties |
UserIdentityProperties
| 名前 | 説明 | 値 |
|---|---|---|
| clientId | ユーザー割り当て ID のクライアント ID。 | string |
| principalId | ユーザー割り当て ID のプリンシパル ID。 | string |
ApiManagementServiceProperties
| 名前 | 説明 | 値 |
|---|---|---|
| additionalLocations | API Management サービスのその他のデータセンターの場所。 | AdditionalLocation[] |
| apiVersionConstraint | API Management サービスのコントロール プレーン Api のバージョン制約。 | ApiVersionConstraint |
| certificates | API Management サービスにインストールする必要がある証明書の一覧。 インストールできるサポートされる証明書の最大数は 10 です。 | CertificateConfiguration[] |
| configurationApi | API Management サービスの構成 API 構成。 | ConfigurationApi |
| customProperties | 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。Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA、TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA、TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA、TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA、TLS_RSA_WITH_AES_128_GCM_SHA256、TLS_RSA_WITH_AES_256_CBC_SHA256、 TLS_RSA_WITH_AES_128_CBC_SHA256、TLS_RSA_WITH_AES_256_CBC_SHA、TLS_RSA_WITH_AES_128_CBC_SHA。 たとえば、 Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256:false. 既定値はそれらの true 値です。注: 次の暗号は、内部プラットフォーム コンポーネントで必要であるため無効にできません:TLS_AES_256_GCM_SHA384、TLS_AES_128_GCM_SHA256、TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384、TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256、TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384、TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256、TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384、TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256、TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384、TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 |
ApiManagementServiceBasePropertiesCustomProperties |
| developerPortalStatus | このAPI Management サービスの開発者ポータルの状態。 | 'Disabled' 'Enabled' |
| disableGateway | プロパティは、複数の場所にデプロイされた Api Management サービスに対してのみ有効です。 これは、マスター リージョンのゲートウェイを無効にするために使用できます。 | [bool] |
| enableClientCertificate | プロパティは、従量課金 SKU サービスにのみ使用されることを意味します。 これにより、ゲートウェイへの要求ごとにクライアント証明書が提示されます。 これにより、ゲートウェイのポリシーで証明書を認証することもできます。 | [bool] |
| hostnameConfigurations | API Management サービスのカスタム ホスト名構成。 | HostnameConfiguration[] |
| legacyPortalStatus | API Management サービスのレガシ ポータルの状態。 | 'Disabled' 'Enabled' |
| natGatewayState | プロパティを使用して、このAPI Management サービスの NAT ゲートウェイを有効にすることができます。 | 'Disabled' 'Enabled' |
| notificationSenderEmail | 通知の送信先となるアドレスをEmailします。 | string |
| privateEndpointConnections | このサービスのプライベート エンドポイント接続の一覧。 | RemotePrivateEndpointConnectionWrapper[] |
| publicIpAddressId | リージョンにデプロイされたサービスVirtual Network関連付けるパブリック Standard SKU IP V4 ベースの IP アドレス。 Virtual Networkにデプロイされている Developer SKU と Premium SKU でのみサポートされます。 | string |
| publicNetworkAccess | このAPI Management サービスに対してパブリック エンドポイント アクセスが許可されるかどうか。 値は省略可能ですが、渡される場合は、'Enabled' または 'Disabled' である必要があります。 "無効" の場合、プライベート エンドポイントは排他アクセス方法です。 既定値は 'Enabled' です | 'Disabled' 'Enabled' |
| publisherEmail | 発行元の電子メール。 | string (必須) |
| publisherName | 発行元名。 | string (必須) |
| 復元 | 以前に論理的に削除された場合は、Api Management サービスの削除を取り消します。 このフラグを指定し、True に設定すると、他のすべてのプロパティは無視されます。 | [bool] |
| virtualNetworkConfiguration | API Management サービスの仮想ネットワーク構成。 | VirtualNetworkConfiguration |
| virtualNetworkType | API Management サービスを構成する必要がある VPN の種類。 None (既定値) は、API Management サービスがVirtual Networkに含まれていないことを意味し、External はインターネットに接続するエンドポイントを持つVirtual Network内にAPI Management展開が設定されていることを意味し、内部はAPI Management展開は、イントラネットに接続するエンドポイントのみを持つVirtual Network内で設定されます。 | 'External' 'Internal' 'None' |
AdditionalLocation
| 名前 | 説明 | 値 |
|---|---|---|
| disableGateway | プロパティは、複数の場所にデプロイされた Api Management サービスに対してのみ有効です。 これを使用して、この追加の場所でゲートウェイを無効にすることができます。 | [bool] |
| location | Azure データ センター リージョン間の追加リージョンの場所名。 | string (必須) |
| natGatewayState | プロパティを使用して、このAPI Management サービスの NAT ゲートウェイを有効にすることができます。 | 'Disabled' 'Enabled' |
| publicIpAddressId | 場所にデプロイされたサービスVirtual Network関連付けるパブリック Standard SKU IP V4 ベースの IP アドレス。 Virtual Networkにデプロイされている Premium SKU でのみサポートされます。 | string |
| sku | API Management サービスの SKU プロパティ。 | ApiManagementServiceSkuProperties (必須) |
| virtualNetworkConfiguration | 場所の仮想ネットワーク構成。 | VirtualNetworkConfiguration |
| ゾーン | リソースの取得元を表す可用性ゾーンの一覧。 | string[] |
ApiManagementServiceSkuProperties
| 名前 | 説明 | 値 |
|---|---|---|
| capacity | SKU の容量 (SKU のデプロイされたユニットの数)。 従量課金 SKU の容量は 0 として指定する必要があります。 | int (必須) |
| name | SKU の名前。 | 'Basic' 'BasicV2' 'Consumption' 'Developer' 'Isolated' 'Premium' 'Standard' 'StandardV2' (必須) |
VirtualNetworkConfiguration
| 名前 | 説明 | 値 |
|---|---|---|
| subnetResourceId | API Management サービスをデプロイする仮想ネットワーク内のサブネットの完全なリソース ID。 | string |
ApiVersionConstraint
| 名前 | 説明 | 値 |
|---|---|---|
| minApiVersion | コントロール プレーン API の呼び出しを、この値以上のバージョンAPI Managementサービスに制限します。 | string |
CertificateConfiguration
| 名前 | 説明 | 値 |
|---|---|---|
| 証明書 (certificate) | 証明書情報。 | CertificateInformation |
| certificatePassword | 証明書パスワード。 | string |
| encodedCertificate | Base64 でエンコードされた証明書。 | string |
| storeName | System.Security.Cryptography.x509certificates.StoreName 証明書ストアの場所。 Root と CertificateAuthority のみが有効な場所です。 | 'CertificateAuthority' 'Root' (必須) |
CertificateInformation
| 名前 | 説明 | 値 |
|---|---|---|
| expiry | 証明書の有効期限。 日付は、ISO 8601 標準で指定されている形式 yyyy-MM-ddTHH:mm:ssZ に準拠しています。 |
string (必須) |
| subject | 証明書のサブジェクト。 | string (必須) |
| thumbprint | 証明書の拇印。 | string (必須) |
ConfigurationApi
| 名前 | 説明 | 値 |
|---|---|---|
| legacyApi | API Management サービスでレガシ構成 API (v1) を公開する必要があるかどうかを示します。 値は省略可能ですが、'Enabled' または 'Disabled' である必要があります。 "無効" の場合、レガシ構成 API (v1) はセルフホステッド ゲートウェイでは使用できません。 既定値は 'Enabled' です | 'Disabled' 'Enabled' |
ApiManagementServiceBasePropertiesCustomProperties
| 名前 | 説明 | 値 |
|---|---|---|
| {カスタマイズされたプロパティ} | string |
HostnameConfiguration
| 名前 | 説明 | 値 |
|---|---|---|
| 証明書 (certificate) | 証明書情報。 | CertificateInformation |
| certificatePassword | 証明書パスワード。 | string |
| certificateSource | 証明書ソース。 | 'BuiltIn' 'Custom' 'KeyVault' 'Managed' |
| certificateStatus | 証明書の状態。 | 'Completed' 'Failed' 'InProgress' |
| defaultSslBinding | このホスト名に関連付けられている証明書を既定の SSL 証明書として設定するには、true を指定します。 クライアントが SNI ヘッダーを送信しない場合、これはチャレンジされる証明書になります。 プロパティは、サービスで複数のカスタム ホスト名が有効になっており、既定の ssl 証明書を決定する必要がある場合に便利です。 設定は、ゲートウェイのホスト名の種類にのみ適用されます。 | [bool] |
| encodedCertificate | Base64 でエンコードされた証明書。 | string |
| hostName | Api Management サービスで構成するホスト名。 | string (必須) |
| identityClientId | Azure AD によって生成されたシステムまたはユーザー割り当てマネージド ID clientId。SSL 証明書を含む keyVault への GET アクセス権を持ちます。 | string |
| keyVaultId | Ssl 証明書を含む KeyVault シークレットの URL。 バージョンを含む絶対 URL が指定されている場合、ssl 証明書の自動更新は機能しません。 そのためには、api Management サービスを aka.ms/apimmsi で構成する必要があります。 シークレットの種類は application/x-pkcs12 である必要があります | string |
| negotiateClientCertificate | ホスト名のクライアント証明書を常にネゴシエートするには、true を指定します。 既定値は false です。 | [bool] |
| 型 | ホスト名の種類。 | 'ConfigurationApi' 'DeveloperPortal' 'Management' 'ポータル' 'Proxy' 'Scm' (必須) |
RemotePrivateEndpointConnectionWrapper
| 名前 | 説明 | 値 |
|---|---|---|
| id | プライベート エンドポイント接続リソース ID | string |
| name | プライベート エンドポイント接続名 | string |
| properties | リソースのプロパティ。 | PrivateEndpointConnectionWrapperProperties |
| 型 | プライベート エンドポイント接続リソースの種類 | string |
PrivateEndpointConnectionWrapperProperties
| 名前 | 説明 | 値 |
|---|---|---|
| privateEndpoint | プライベート エンドポイントのリソース。 | ArmIdWrapper |
| privateLinkServiceConnectionState | サービス コンシューマーとプロバイダー間の接続の状態に関する情報のコレクション。 | PrivateLinkServiceConnectionState (必須) |
ArmIdWrapper
このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。
PrivateLinkServiceConnectionState
| 名前 | 説明 | 値 |
|---|---|---|
| actionsRequired | サービス プロバイダーの変更にコンシューマーに対する更新が必要かどうかを示すメッセージ。 | string |
| description | 接続の承認/拒否の理由。 | string |
| status | サービスの所有者によって接続が承認/拒否/削除されたかどうかを示します。 | '承認済み' '保留中' 'Rejected' |
クイック スタート テンプレート
次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。
| Template | 説明 |
|---|---|
テンプレートを使用して API Management インスタンスとそのすべてのサブリソースを作成する |
このテンプレートでは、API Management サービスを作成し、サブエンティティを構成する方法を示します |
| 外部Azure Cache for Redisを使用してAPI Managementをデプロイする |
このテンプレートでは、外部Azure Cache for Redis インスタンスをAPI Management外部キャッシュとして使用層に Azure API Management のインスタンスを作成する方法を示します。 |
| パブリック IP を使用して外部 VNet にAPI Managementをデプロイする |
このテンプレートでは、外部モードで仮想ネットワークのサブネット内の Premium レベルに Azure API Management のインスタンスを作成し、サブネットで推奨される NSG 規則を構成する方法を示します。 インスタンスは 2 つの可用性ゾーンにデプロイされます。 このテンプレートでは、サブスクリプションのパブリック IP アドレスも構成されます。 |
| カスタム ホスト名を使用してAPI Management インスタンスを作成する |
このテンプレートでは、ポータルのカスタム ホスト名とプロキシ用の複数のカスタム ホスト名を使用して Azure API Managementのインスタンスを作成する方法を示します |
| App Gateway を使用して内部 VNet にAPI Managementを作成する |
このテンプレートでは、Azure Application Gatewayによって保護されたプライベート ネットワーク上に Azure API Management のインスタンスを作成する方法を示します。 |
| パブリック IP を使用して内部 VNet にAPI Managementをデプロイする |
このテンプレートでは、内部モードで仮想ネットワークのサブネット内の Premium レベルに Azure API Management のインスタンスを作成し、サブネットに推奨される NSG 規則を構成する方法を示します。 インスタンスは 2 つの可用性ゾーンにデプロイされます。 このテンプレートでは、サブスクリプションのパブリック IP アドレスも構成されます。 |
| MSI ID を持つAPI Management インスタンスを作成する |
このテンプレートは、MSI ID を持つ Azure API Managementの開発者インスタンスを作成します |
| マルチリージョン Premium レベルのAPI Management インスタンスを作成する |
このテンプレートでは、追加の場所を含むAPI Management インスタンスを作成する方法を示します。 プライマリの場所は、リソース グループの場所と同じです。 追加の場所については、テンプレートに NorthCentralUs と米国東部 2 が表示されます。 プライマリの場所は、追加の場所とは異なる必要があります。 |
| KeyVault を使用してカスタム プロキシ ssl を使用してAPI Managementを作成する |
このテンプレートでは、Azure API Management のインスタンスを作成し、keyvault の ssl 証明書を使用してプロキシのカスタム ホスト名を構成する方法を示します。 |
| KeyVault から SSL を使用してAPI Management サービスを作成する |
このテンプレートは、ユーザー割り当て ID で構成されたAPI Management サービスをデプロイします。 この ID を使用して KeyVault から SSL 証明書をフェッチし、4 時間ごとにチェックすることで更新を維持します。 |
| API Management インスタンスの作成と監視 |
このテンプレートは、Azure API Management サービスと Log Analytics ワークスペースのインスタンスを作成し、Log Analytics を使用してAPI Management サービスの監視を設定します |
| プライベート エンドポイントを使用してAPI Management サービスを作成する |
このテンプレートでは、API Management サービス、仮想ネットワーク、およびAPI Management サービスを仮想ネットワークに公開するプライベート エンドポイントが作成されます。 |
| Availability Zones に API Management をデプロイする |
このテンプレートは、Azure API Managementの Premium インスタンスを作成し、可用性ゾーンにデプロイします |
| テンプレートを使用して API Management インスタンスを作成する |
このテンプレートは、Azure API Managementの開発者インスタンスを作成します |
| Front Door Standard/Premium とAPI Managementオリジン |
このテンプレートは、Front Door Premium とAPI Management インスタンスを作成し、NSG とグローバル API Management ポリシーを使用して、トラフィックが Front Door の配信元を通過したことを検証します。 |
| Azure Front Door を Azure API Managementの前に作成する |
このサンプルでは、Azure Front Door を Azure API Managementの前でグローバル ロード バランサーとして使用する方法を示します。 |
| 内部API Managementと Web アプリを使用したApplication Gateway |
Application Gateway、Azure Web アプリでホストされている Web API をサービスする仮想ネットワーク (内部モード) API Managementインスタンスにインターネット トラフィックをルーティングします。 |
ARM テンプレート リソース定義
サービス リソースの種類は、次を対象とする操作でデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドに関するページを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.ApiManagement/service リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.ApiManagement/service",
"apiVersion": "2023-05-01-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"{customized property}": "string"
"sku": {
"capacity": "int",
"name": "string"
},
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
"clientId": "string",
"principalId": "string"
}
}
},
"properties": {
"additionalLocations": [
{
"disableGateway": "bool",
"location": "string",
"natGatewayState": "string",
"publicIpAddressId": "string",
"sku": {
"capacity": "int",
"name": "string"
},
"virtualNetworkConfiguration": {
"subnetResourceId": "string"
},
"zones": [ "string" ]
}
],
"apiVersionConstraint": {
"minApiVersion": "string"
},
"certificates": [
{
"certificate": {
"expiry": "string",
"subject": "string",
"thumbprint": "string"
},
"certificatePassword": "string",
"encodedCertificate": "string",
"storeName": "string"
}
],
"configurationApi": {
"legacyApi": "string"
},
"customProperties": {
"{customized property}": "string"
},
"developerPortalStatus": "string",
"disableGateway": "bool",
"enableClientCertificate": "bool",
"hostnameConfigurations": [
{
"certificate": {
"expiry": "string",
"subject": "string",
"thumbprint": "string"
},
"certificatePassword": "string",
"certificateSource": "string",
"certificateStatus": "string",
"defaultSslBinding": "bool",
"encodedCertificate": "string",
"hostName": "string",
"identityClientId": "string",
"keyVaultId": "string",
"negotiateClientCertificate": "bool",
"type": "string"
}
],
"legacyPortalStatus": "string",
"natGatewayState": "string",
"notificationSenderEmail": "string",
"privateEndpointConnections": [
{
"id": "string",
"name": "string",
"properties": {
"privateEndpoint": {},
"privateLinkServiceConnectionState": {
"actionsRequired": "string",
"description": "string",
"status": "string"
}
},
"type": "string"
}
],
"publicIpAddressId": "string",
"publicNetworkAccess": "string",
"publisherEmail": "string",
"publisherName": "string",
"restore": "bool",
"virtualNetworkConfiguration": {
"subnetResourceId": "string"
},
"virtualNetworkType": "string"
},
"zones": [ "string" ]
}
プロパティ値
サービス (service)
| 名前 | 説明 | 値 |
|---|---|---|
| type | リソースの種類 | 'Microsoft.ApiManagement/service' |
| apiVersion | リソース API のバージョン | '2023-05-01-preview' |
| name | リソース名 | string (必須) 文字数制限: 1 から 50 有効な文字: 英数字とハイフン。 先頭は文字、末尾は英数字にします。 リソース名は、Azure 全体で一意である必要があります。 |
| location | リソースの場所。 | string (必須) |
| tags | リソース タグ。 | タグ名と値のディクショナリ。 「テンプレートのタグ」を参照してください |
| sku | API Management サービスの SKU プロパティ。 | ApiManagementServiceSkuProperties (必須) |
| identity | Api Management サービスのマネージド サービス ID。 | ApiManagementServiceIdentity |
| properties | API Management サービスのプロパティ。 | ApiManagementServiceProperties (必須) |
| ゾーン | リソースの取得元を表す可用性ゾーンの一覧。 | string[] |
ApiManagementServiceIdentity
| 名前 | 説明 | 値 |
|---|---|---|
| type | リソースに使用される ID の種類。 種類 "SystemAssigned、UserAssigned" には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' は、サービスから ID を削除します。 | 'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' (必須) |
| userAssignedIdentities | リソースに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ キー参照は、次の形式の ARM リソース ID になります。 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' |
ApiManagementServiceIdentityUserAssignedIdentities |
ApiManagementServiceIdentityUserAssignedIdentities
| 名前 | 説明 | 値 |
|---|---|---|
| {カスタマイズされたプロパティ} | UserIdentityProperties |
UserIdentityProperties
| 名前 | 説明 | 値 |
|---|---|---|
| clientId | ユーザー割り当て ID のクライアント ID。 | string |
| principalId | ユーザー割り当て ID のプリンシパル ID。 | string |
ApiManagementServiceProperties
| 名前 | 説明 | 値 |
|---|---|---|
| additionalLocations | API Management サービスの追加のデータセンターの場所。 | AdditionalLocation[] |
| apiVersionConstraint | API Management サービスのコントロール プレーン Apis バージョン制約。 | ApiVersionConstraint |
| certificates | API Management サービスにインストールする必要がある証明書の一覧。 インストールできるサポートされる証明書の最大数は 10 です。 | CertificateConfiguration[] |
| configurationApi | API Management サービスの構成 API 構成。 | ConfigurationApi |
| customProperties | 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 False 年 4 月 1 日以前に作成されたかどうか、それ以外の場合です。 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 値です。注: 次の暗号は、内部プラットフォーム コンポーネントで必要であるため無効にできません: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 |
ApiManagementServiceBasePropertiesCustomProperties |
| developerPortalStatus | このAPI Management サービスの開発者ポータルの状態。 | 'Disabled' 'Enabled' |
| disableGateway | プロパティは、複数の場所にデプロイされた Api Management サービスに対してのみ有効です。 これは、マスター リージョンでゲートウェイを無効にするために使用できます。 | [bool] |
| enableClientCertificate | プロパティは、従量課金 SKU サービスにのみ使用されます。 これにより、ゲートウェイへの各要求にクライアント証明書が提示されます。 これにより、ゲートウェイのポリシーで証明書を認証することもできます。 | [bool] |
| hostnameConfigurations | API Management サービスのカスタム ホスト名の構成。 | HostnameConfiguration[] |
| legacyPortalStatus | API Management サービスのレガシ ポータルの状態。 | 'Disabled' 'Enabled' |
| natGatewayState | プロパティを使用して、このAPI Management サービスの NAT ゲートウェイを有効にすることができます。 | 'Disabled' 'Enabled' |
| notificationSenderEmail | 通知の送信先となるアドレスをEmailします。 | string |
| privateEndpointConnections | このサービスのプライベート エンドポイント接続の一覧。 | RemotePrivateEndpointConnectionWrapper[] |
| publicIpAddressId | リージョンにデプロイされたサービスに関連付けられるパブリック Standard SKU IP V4 ベースの IP アドレスVirtual Network。 Virtual Networkにデプロイされている Developer SKU と Premium SKU でのみサポートされます。 | string |
| publicNetworkAccess | このAPI Management サービスに対してパブリック エンドポイント アクセスが許可されているかどうか。 値は省略可能ですが、渡される場合は、'Enabled' または 'Disabled' である必要があります。 "無効" の場合、プライベート エンドポイントは排他アクセス方法です。 既定値は 'Enabled' です | 'Disabled' 'Enabled' |
| publisherEmail | 発行元の電子メール。 | string (必須) |
| publisherName | 発行元名。 | string (必須) |
| 復元 | 以前に論理的に削除された場合は、Api Management サービスの削除を取り消します。 このフラグを指定し、True に設定すると、他のすべてのプロパティは無視されます。 | [bool] |
| virtualNetworkConfiguration | API Management サービスの仮想ネットワーク構成。 | VirtualNetworkConfiguration |
| virtualNetworkType | API Management サービスを構成する必要がある VPN の種類。 None (既定値) は、API Management サービスがVirtual Networkに含まれていないことを意味し、External はインターネットに接続するエンドポイントを持つVirtual Network内にAPI Management展開が設定されていることを意味し、内部はAPI Management展開は、イントラネットに接続するエンドポイントのみを持つVirtual Network内で設定されます。 | 'External' 'Internal' 'None' |
AdditionalLocation
| 名前 | 説明 | 値 |
|---|---|---|
| disableGateway | プロパティは、複数の場所にデプロイされた Api Management サービスに対してのみ有効です。 これを使用して、この追加の場所でゲートウェイを無効にすることができます。 | [bool] |
| location | Azure データ センター リージョン間の追加リージョンの場所名。 | string (必須) |
| natGatewayState | プロパティを使用して、このAPI Management サービスの NAT ゲートウェイを有効にすることができます。 | 'Disabled' 'Enabled' |
| publicIpAddressId | 場所にデプロイされたサービスVirtual Network関連付けるパブリック Standard SKU IP V4 ベースの IP アドレス。 Virtual Networkにデプロイされている Premium SKU でのみサポートされます。 | string |
| sku | API Management サービスの SKU プロパティ。 | ApiManagementServiceSkuProperties (必須) |
| virtualNetworkConfiguration | 場所の仮想ネットワーク構成。 | VirtualNetworkConfiguration |
| ゾーン | リソースの取得元を表す可用性ゾーンの一覧。 | string[] |
ApiManagementServiceSkuProperties
| 名前 | 説明 | 値 |
|---|---|---|
| capacity | SKU の容量 (SKU のデプロイされたユニットの数)。 従量課金 SKU の容量は 0 として指定する必要があります。 | int (必須) |
| name | Sku の名前。 | 'Basic' 'BasicV2' 'Consumption' 'Developer' 'Isolated' 'Premium' 'Standard' 'StandardV2' (必須) |
VirtualNetworkConfiguration
| 名前 | 説明 | 値 |
|---|---|---|
| subnetResourceId | API Management サービスをデプロイする仮想ネットワーク内のサブネットの完全なリソース ID。 | string |
ApiVersionConstraint
| 名前 | 説明 | 値 |
|---|---|---|
| minApiVersion | コントロール プレーン API 呼び出しを、この値以上のバージョンAPI Managementサービスに制限します。 | string |
CertificateConfiguration
| 名前 | 説明 | 値 |
|---|---|---|
| 証明書 (certificate) | 証明書情報。 | CertificateInformation |
| certificatePassword | 証明書のパスワード。 | string |
| encodedCertificate | Base64 でエンコードされた証明書。 | string |
| storeName | System.Security.Cryptography.x509certificates.StoreName 証明書ストアの場所。 Root と CertificateAuthority のみが有効な場所です。 | 'CertificateAuthority' 'Root' (必須) |
CertificateInformation
| 名前 | 説明 | 値 |
|---|---|---|
| expiry | 証明書の有効期限。 日付は、ISO 8601 標準で指定されている形式 yyyy-MM-ddTHH:mm:ssZ に準拠しています。 |
string (必須) |
| subject | 証明書のサブジェクト。 | string (必須) |
| thumbprint | 証明書の拇印。 | string (必須) |
ConfigurationApi
| 名前 | 説明 | 値 |
|---|---|---|
| legacyApi | API Management サービスでレガシ構成 API (v1) を公開する必要があるかどうかを示します。 値は省略可能ですが、'Enabled' または 'Disabled' である必要があります。 "無効" の場合、レガシ構成 API (v1) はセルフホステッド ゲートウェイでは使用できません。 既定値は 'Enabled' です | 'Disabled' 'Enabled' |
ApiManagementServiceBasePropertiesCustomProperties
| 名前 | 説明 | 値 |
|---|---|---|
| {カスタマイズされたプロパティ} | string |
HostnameConfiguration
| 名前 | 説明 | 値 |
|---|---|---|
| 証明書 (certificate) | 証明書情報。 | CertificateInformation |
| certificatePassword | 証明書パスワード。 | string |
| certificateSource | 証明書ソース。 | 'BuiltIn' 'Custom' 'KeyVault' 'Managed' |
| certificateStatus | 証明書の状態。 | 'Completed' 'Failed' 'InProgress' |
| defaultSslBinding | このホスト名に関連付けられている証明書を既定の SSL 証明書として設定するには、true を指定します。 クライアントが SNI ヘッダーを送信しない場合、これはチャレンジされる証明書になります。 プロパティは、サービスで複数のカスタム ホスト名が有効になっており、既定の ssl 証明書を決定する必要がある場合に便利です。 設定は、ゲートウェイのホスト名の種類にのみ適用されます。 | [bool] |
| encodedCertificate | Base64 でエンコードされた証明書。 | string |
| hostName | Api Management サービスで構成するホスト名。 | string (必須) |
| identityClientId | Azure AD によって生成されたシステムまたはユーザー割り当てマネージド ID clientId。SSL 証明書を含む keyVault への GET アクセス権を持ちます。 | string |
| keyVaultId | Ssl 証明書を含む KeyVault シークレットの URL。 バージョンを含む絶対 URL が指定されている場合、ssl 証明書の自動更新は機能しません。 これには、api Management サービスを aka.ms/apimmsi で構成する必要があります。 シークレットの種類は application/x-pkcs12 である必要があります | string |
| negotiateClientCertificate | ホスト名で常にクライアント証明書をネゴシエートするには、true を指定します。 既定値は false です。 | [bool] |
| 型 | ホスト名の種類。 | 'ConfigurationApi' 'DeveloperPortal' 'Management' 'Portal' 'Proxy' 'Scm' (必須) |
RemotePrivateEndpointConnectionWrapper
| 名前 | 説明 | 値 |
|---|---|---|
| id | プライベート エンドポイント接続リソース ID | string |
| name | プライベート エンドポイント接続名 | string |
| properties | リソースのプロパティ。 | PrivateEndpointConnectionWrapperProperties |
| 型 | プライベート エンドポイント接続リソースの種類 | string |
PrivateEndpointConnectionWrapperProperties
| 名前 | 説明 | 値 |
|---|---|---|
| privateEndpoint | プライベート エンドポイントのリソース。 | ArmIdWrapper |
| privateLinkServiceConnectionState | サービス コンシューマーとプロバイダー間の接続の状態に関する情報のコレクション。 | PrivateLinkServiceConnectionState (必須) |
ArmIdWrapper
このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。
PrivateLinkServiceConnectionState
| 名前 | 説明 | 値 |
|---|---|---|
| actionsRequired | サービス プロバイダーの変更にコンシューマーに対する更新が必要かどうかを示すメッセージ。 | string |
| description | 接続の承認/拒否の理由。 | string |
| status | サービスの所有者によって接続が承認/拒否/削除されたかどうかを示します。 | '承認済み' '保留中' 'Rejected' |
クイック スタート テンプレート
次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。
| Template | 説明 |
|---|---|
| テンプレートを使用して API Management インスタンスとそのすべてのサブリソースを作成する |
このテンプレートでは、API Management サービスを作成し、サブエンティティを構成する方法を示します |
| 外部Azure Cache for Redisを使用してAPI Managementをデプロイする |
このテンプレートでは、外部Azure Cache for Redis インスタンスをAPI Management外部キャッシュとして使用層に Azure API Management のインスタンスを作成する方法を示します。 |
| パブリック IP を使用して外部 VNet にAPI Managementをデプロイする |
このテンプレートでは、外部モードで仮想ネットワークのサブネット内の Premium レベルに Azure API Management のインスタンスを作成し、サブネットで推奨される NSG 規則を構成する方法を示します。 インスタンスは 2 つの可用性ゾーンにデプロイされます。 このテンプレートでは、サブスクリプションからのパブリック IP アドレスも構成されます。 |
| カスタム ホスト名を使用してAPI Management インスタンスを作成する |
このテンプレートでは、ポータル用のカスタム ホスト名とプロキシ用の複数のカスタム ホスト名を使用して Azure API Managementのインスタンスを作成する方法を示します |
| App Gateway を使用して内部 VNet にAPI Managementを作成する |
このテンプレートでは、Azure Application Gatewayによって保護されたプライベート ネットワーク上に Azure API Management のインスタンスを作成する方法を示します。 |
| パブリック IP を使用して内部 VNet にAPI Managementをデプロイする |
このテンプレートでは、仮想ネットワークのサブネット内の Premium レベルで Azure API Management のインスタンスを内部モードで作成し、サブネットで推奨される NSG 規則を構成する方法を示します。 インスタンスは 2 つの可用性ゾーンにデプロイされます。 このテンプレートでは、サブスクリプションからのパブリック IP アドレスも構成されます。 |
| MSI ID を持つAPI Management インスタンスを作成する |
このテンプレートは、MSI ID を持つ Azure API Managementの開発者インスタンスを作成します |
| マルチリージョン Premium レベル API Management インスタンスを作成する |
このテンプレートでは、追加の場所を使用してAPI Management インスタンスを作成する方法を示します。 プライマリの場所は、リソース グループの場所と同じです。 追加の場所の場合、テンプレートには NorthCentralUs と米国東部 2 が表示されます。 プライマリの場所は、追加の場所とは異なる必要があります。 |
| KeyVault を使用してカスタム プロキシ ssl を使用してAPI Managementを作成する |
このテンプレートでは、Azure API Managementのインスタンスを作成し、keyvault から ssl 証明書を使用してプロキシのカスタム ホスト名を構成する方法を示します。 |
| KeyVault から SSL を使用してAPI Management サービスを作成する |
このテンプレートは、ユーザー割り当て ID で構成されたAPI Management サービスをデプロイします。 この ID を使用して KeyVault から SSL 証明書をフェッチし、4 時間ごとに確認することで更新を維持します。 |
| API Management インスタンスの作成と監視 |
このテンプレートは、Azure API Management サービスと Log Analytics ワークスペースのインスタンスを作成し、Log Analytics を使用してAPI Management サービスの監視を設定します |
| プライベート エンドポイントを使用してAPI Management サービスを作成する |
このテンプレートでは、API Management サービス、仮想ネットワーク、およびAPI Management サービスを仮想ネットワークに公開するプライベート エンドポイントが作成されます。 |
| Availability Zones に API Management をデプロイする |
このテンプレートは、Azure API Managementの Premium インスタンスを作成し、可用性ゾーンにデプロイします |
| テンプレートを使用して API Management インスタンスを作成する |
このテンプレートは、Azure API Managementの開発者インスタンスを作成します |
| Front Door Standard/Premium とAPI Managementオリジン |
このテンプレートは、Front Door Premium とAPI Management インスタンスを作成し、NSG とグローバル API Management ポリシーを使用して、トラフィックが Front Door の配信元を通過したことを検証します。 |
| Azure API Managementの前に Azure Front Door を作成する |
このサンプルでは、Azure Front Door を Azure API Managementの前でグローバル ロード バランサーとして使用する方法を示します。 |
| 内部API Managementと Web アプリを使用したApplication Gateway |
Application Gateway、Azure Web アプリでホストされている Web API をサービスするインスタンスAPI Management仮想ネットワーク (内部モード) にインターネット トラフィックをルーティングします。 |
Terraform (AzAPI プロバイダー) リソース定義
サービス リソースの種類は、次を対象とする操作でデプロイできます。
- リソース グループ
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.ApiManagement/service リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service@2023-05-01-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
{customized property} = "string"
identity {
type = "string"
identity_ids = []
}
body = jsonencode({
properties = {
additionalLocations = [
{
disableGateway = bool
location = "string"
natGatewayState = "string"
publicIpAddressId = "string"
sku = {
capacity = int
name = "string"
}
virtualNetworkConfiguration = {
subnetResourceId = "string"
}
zones = [
"string"
]
}
]
apiVersionConstraint = {
minApiVersion = "string"
}
certificates = [
{
certificate = {
expiry = "string"
subject = "string"
thumbprint = "string"
}
certificatePassword = "string"
encodedCertificate = "string"
storeName = "string"
}
]
configurationApi = {
legacyApi = "string"
}
customProperties = {
{customized property} = "string"
}
developerPortalStatus = "string"
disableGateway = bool
enableClientCertificate = bool
hostnameConfigurations = [
{
certificate = {
expiry = "string"
subject = "string"
thumbprint = "string"
}
certificatePassword = "string"
certificateSource = "string"
certificateStatus = "string"
defaultSslBinding = bool
encodedCertificate = "string"
hostName = "string"
identityClientId = "string"
keyVaultId = "string"
negotiateClientCertificate = bool
type = "string"
}
]
legacyPortalStatus = "string"
natGatewayState = "string"
notificationSenderEmail = "string"
privateEndpointConnections = [
{
id = "string"
name = "string"
properties = {
privateEndpoint = {}
privateLinkServiceConnectionState = {
actionsRequired = "string"
description = "string"
status = "string"
}
}
type = "string"
}
]
publicIpAddressId = "string"
publicNetworkAccess = "string"
publisherEmail = "string"
publisherName = "string"
restore = bool
virtualNetworkConfiguration = {
subnetResourceId = "string"
}
virtualNetworkType = "string"
}
zones = [
"string"
]
sku = {
capacity = int
name = "string"
}
})
}
プロパティ値
サービス (service)
| 名前 | 説明 | 値 |
|---|---|---|
| type | リソースの種類 | "Microsoft.ApiManagement/service@2023-05-01-preview" |
| name | リソース名 | string (必須) 文字数制限: 1 から 50 有効な文字: 英数字とハイフン。 先頭は文字、末尾は英数字にします。 リソース名は、Azure 全体で一意である必要があります。 |
| location | リソースの場所。 | string (必須) |
| parent_id | リソース グループにデプロイするには、そのリソース グループの ID を使用します。 | string (必須) |
| tags | リソース タグ。 | タグ名と値のディクショナリ。 |
| sku | API Management サービスの SKU プロパティ。 | ApiManagementServiceSkuProperties (必須) |
| identity | Api Management サービスのマネージド サービス ID。 | ApiManagementServiceIdentity |
| properties | API Management サービスのプロパティ。 | ApiManagementServiceProperties (必須) |
| ゾーン | リソースの取得元を表す可用性ゾーンの一覧。 | string[] |
ApiManagementServiceIdentity
| 名前 | 説明 | 値 |
|---|---|---|
| type | リソースに使用される ID の種類。 種類 "SystemAssigned、UserAssigned" には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' は、サービスから ID を削除します。 | "SystemAssigned" "SystemAssigned、UserAssigned" "UserAssigned" (必須) |
| identity_ids | リソースに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ キー参照は、次の形式の ARM リソース ID になります。 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' |
ユーザー ID ID の配列。 |
ApiManagementServiceIdentityUserAssignedIdentities
| 名前 | 説明 | 値 |
|---|---|---|
| {カスタマイズされたプロパティ} | UserIdentityProperties |
UserIdentityProperties
| 名前 | 説明 | 値 |
|---|---|---|
| clientId | ユーザー割り当て ID のクライアント ID。 | string |
| principalId | ユーザー割り当て ID のプリンシパル ID。 | string |
ApiManagementServiceProperties
| 名前 | 説明 | 値 |
|---|---|---|
| additionalLocations | API Management サービスの追加のデータセンターの場所。 | AdditionalLocation[] |
| apiVersionConstraint | API Management サービスのコントロール プレーン Apis バージョン制約。 | ApiVersionConstraint |
| certificates | API Management サービスにインストールする必要がある証明書の一覧。 インストールできるサポートされる証明書の最大数は 10 です。 | CertificateConfiguration[] |
| configurationApi | API Management サービスの構成 API 構成。 | ConfigurationApi |
| customProperties | 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 False 年 4 月 1 日以前に作成されたかどうか、それ以外の場合です。 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 値です。注: 次の暗号は、内部プラットフォーム コンポーネントで必要であるため無効にできません: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 |
ApiManagementServiceBasePropertiesCustomProperties |
| developerPortalStatus | このAPI Management サービスの開発者ポータルの状態。 | "無効" "有効" |
| disableGateway | プロパティは、複数の場所にデプロイされた Api Management サービスに対してのみ有効です。 これは、マスター リージョンのゲートウェイを無効にするために使用できます。 | [bool] |
| enableClientCertificate | プロパティは、従量課金 SKU サービスにのみ使用されることを意味します。 これにより、ゲートウェイへの要求ごとにクライアント証明書が提示されます。 これにより、ゲートウェイのポリシーで証明書を認証することもできます。 | [bool] |
| hostnameConfigurations | API Management サービスのカスタム ホスト名構成。 | HostnameConfiguration[] |
| legacyPortalStatus | API Management サービスのレガシ ポータルの状態。 | "無効" "有効" |
| natGatewayState | プロパティを使用して、このAPI Management サービスの NAT ゲートウェイを有効にすることができます。 | "無効" "有効" |
| notificationSenderEmail | 通知の送信先となるアドレスをEmailします。 | string |
| privateEndpointConnections | このサービスのプライベート エンドポイント接続の一覧。 | RemotePrivateEndpointConnectionWrapper[] |
| publicIpAddressId | リージョンにデプロイされたサービスVirtual Network関連付けるパブリック Standard SKU IP V4 ベースの IP アドレス。 Virtual Networkにデプロイされている Developer SKU と Premium SKU でのみサポートされます。 | string |
| publicNetworkAccess | このAPI Management サービスに対してパブリック エンドポイント アクセスが許可されるかどうか。 値は省略可能ですが、渡される場合は、'Enabled' または 'Disabled' である必要があります。 "無効" の場合、プライベート エンドポイントは排他アクセス方法です。 既定値は 'Enabled' です | "無効" "有効" |
| publisherEmail | 発行元の電子メール。 | string (必須) |
| publisherName | 発行元名。 | string (必須) |
| 復元 | 以前に論理的に削除された場合は、Api Management サービスの削除を取り消します。 このフラグを指定し、True に設定すると、他のすべてのプロパティは無視されます。 | [bool] |
| virtualNetworkConfiguration | API Management サービスの仮想ネットワーク構成。 | VirtualNetworkConfiguration |
| virtualNetworkType | API Management サービスを構成する必要がある VPN の種類。 None (既定値) は、API Management サービスがVirtual Networkに含まれていないことを意味し、External はインターネットに接続するエンドポイントを持つVirtual Network内にAPI Management展開が設定されていることを意味し、内部はAPI Management展開は、イントラネットに接続するエンドポイントのみを持つVirtual Network内で設定されます。 | "External" "Internal" "None" |
AdditionalLocation
| 名前 | 説明 | 値 |
|---|---|---|
| disableGateway | プロパティは、複数の場所にデプロイされた Api Management サービスに対してのみ有効です。 これを使用して、この追加の場所でゲートウェイを無効にすることができます。 | [bool] |
| location | Azure データ センター リージョン間の追加リージョンの場所名。 | string (必須) |
| natGatewayState | プロパティを使用して、このAPI Management サービスの NAT ゲートウェイを有効にすることができます。 | "無効" "有効" |
| publicIpAddressId | 場所にデプロイされたサービスVirtual Network関連付けるパブリック Standard SKU IP V4 ベースの IP アドレス。 Virtual Networkにデプロイされている Premium SKU でのみサポートされます。 | string |
| sku | API Management サービスの SKU プロパティ。 | ApiManagementServiceSkuProperties (必須) |
| virtualNetworkConfiguration | 場所の仮想ネットワーク構成。 | VirtualNetworkConfiguration |
| ゾーン | リソースの取得元を表す可用性ゾーンの一覧。 | string[] |
ApiManagementServiceSkuProperties
| 名前 | 説明 | 値 |
|---|---|---|
| capacity | SKU の容量 (SKU のデプロイされたユニットの数)。 従量課金 SKU の容量は 0 として指定する必要があります。 | int (必須) |
| name | Sku の名前。 | "Basic" "BasicV2" "従量課金" "Developer" "Isolated" "Premium" "Standard" "StandardV2" (必須) |
VirtualNetworkConfiguration
| 名前 | 説明 | 値 |
|---|---|---|
| subnetResourceId | API Management サービスをデプロイする仮想ネットワーク内のサブネットの完全なリソース ID。 | string |
ApiVersionConstraint
| 名前 | 説明 | 値 |
|---|---|---|
| minApiVersion | コントロール プレーン API 呼び出しを、この値以上のバージョンAPI Managementサービスに制限します。 | string |
CertificateConfiguration
| 名前 | 説明 | 値 |
|---|---|---|
| 証明書 (certificate) | 証明書情報。 | CertificateInformation |
| certificatePassword | 証明書のパスワード。 | string |
| encodedCertificate | Base64 でエンコードされた証明書。 | string |
| storeName | System.Security.Cryptography.x509certificates.StoreName 証明書ストアの場所。 Root と CertificateAuthority のみが有効な場所です。 | "CertificateAuthority" "Root" (必須) |
CertificateInformation
| 名前 | 説明 | 値 |
|---|---|---|
| expiry | 証明書の有効期限。 日付は、ISO 8601 標準で指定されている形式 yyyy-MM-ddTHH:mm:ssZ に準拠しています。 |
string (必須) |
| subject | 証明書のサブジェクト。 | string (必須) |
| thumbprint | 証明書の拇印。 | string (必須) |
ConfigurationApi
| 名前 | 説明 | 値 |
|---|---|---|
| legacyApi | レガシ構成 API (v1) をAPI Management サービスで公開する必要があるかどうかを示します。 値は省略可能ですが、'Enabled' または 'Disabled' である必要があります。 "無効" の場合、レガシ構成 API (v1) はセルフホステッド ゲートウェイでは使用できません。 既定値は 'Enabled' です | "無効" "有効" |
ApiManagementServiceBasePropertiesCustomProperties
| 名前 | 説明 | 値 |
|---|---|---|
| {カスタマイズされたプロパティ} | string |
HostnameConfiguration
| 名前 | 説明 | 値 |
|---|---|---|
| 証明書 (certificate) | 証明書情報。 | CertificateInformation |
| certificatePassword | 証明書のパスワード。 | string |
| certificateSource | 証明書のソース。 | "BuiltIn" "Custom" "KeyVault" "Managed" |
| certificateStatus | 証明書の状態。 | "完了" "Failed" "InProgress" |
| defaultSslBinding | このホスト名に関連付けられている証明書を既定の SSL 証明書として設定するには、true を指定します。 クライアントが SNI ヘッダーを送信しない場合、これはチャレンジされる証明書になります。 プロパティは、サービスで複数のカスタム ホスト名が有効になっており、既定の ssl 証明書を決定する必要がある場合に便利です。 設定は、ゲートウェイのホスト名の種類にのみ適用されます。 | [bool] |
| encodedCertificate | Base64 でエンコードされた証明書。 | string |
| hostName | Api Management サービスで構成するホスト名。 | string (必須) |
| identityClientId | Azure AD によって生成されたシステムまたはユーザー割り当てマネージド ID clientId。SSL 証明書を含む keyVault への GET アクセス権を持ちます。 | string |
| keyVaultId | Ssl 証明書を含む KeyVault シークレットの URL。 バージョンを含む絶対 URL が指定されている場合、ssl 証明書の自動更新は機能しません。 そのためには、api Management サービスを aka.ms/apimmsi で構成する必要があります。 シークレットの種類は application/x-pkcs12 である必要があります | string |
| negotiateClientCertificate | ホスト名のクライアント証明書を常にネゴシエートするには、true を指定します。 既定値は false です。 | [bool] |
| 型 | ホスト名の種類。 | "ConfigurationApi" "DeveloperPortal" "Management" "ポータル" "Proxy" "Scm" (必須) |
RemotePrivateEndpointConnectionWrapper
| 名前 | 説明 | 値 |
|---|---|---|
| id | プライベート エンドポイント接続リソース ID | string |
| name | プライベート エンドポイント接続名 | string |
| properties | リソースのプロパティ。 | PrivateEndpointConnectionWrapperProperties |
| 型 | プライベート エンドポイント接続リソースの種類 | string |
PrivateEndpointConnectionWrapperProperties
| 名前 | 説明 | 値 |
|---|---|---|
| privateEndpoint | プライベート エンドポイントのリソース。 | ArmIdWrapper |
| privateLinkServiceConnectionState | サービス コンシューマーとプロバイダー間の接続の状態に関する情報のコレクション。 | PrivateLinkServiceConnectionState (必須) |
ArmIdWrapper
このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。
PrivateLinkServiceConnectionState
| 名前 | 説明 | 値 |
|---|---|---|
| actionsRequired | サービス プロバイダーの変更にコンシューマーに対する更新が必要かどうかを示すメッセージ。 | string |
| description | 接続の承認/拒否の理由。 | string |
| status | サービスの所有者によって接続が承認/拒否/削除されたかどうかを示します。 | "承認済み" "保留中" "Rejected" |
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示