Api Management Service - Update
既存の API Management サービスを更新します。
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}?api-version=2024-05-01
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
resource
|
path | True |
string minLength: 1maxLength: 90 |
リソース グループの名前。 名前では大文字と小文字が区別されません。 |
service
|
path | True |
string minLength: 1maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ |
API Management サービスの名前。 |
subscription
|
path | True |
string (uuid) |
ターゲット サブスクリプションの ID。 値は UUID である必要があります。 |
api-version
|
query | True |
string minLength: 1 |
この操作に使用する API バージョン。 |
要求本文
名前 | 型 | 説明 |
---|---|---|
identity |
Api Management サービスのマネージド サービス ID。 |
|
properties.additionalLocations |
API Management サービスの追加のデータセンターの場所。 |
|
properties.apiVersionConstraint |
API Management サービスのコントロール プレーン API のバージョン制約。 |
|
properties.certificates |
API Management サービスにインストールする必要がある証明書の一覧。 インストールできるサポートされる証明書の最大数は 10 です。 |
|
properties.configurationApi |
API Management サービスの構成 API 構成。 |
|
properties.customProperties |
object |
API Management サービスのカスタム プロパティ。 |
properties.developerPortalStatus |
この API Management サービスの開発者ポータルの状態。 |
|
properties.disableGateway |
boolean |
プロパティは、複数の場所にデプロイされた Api Management サービスに対してのみ有効です。 これを使用して、マスター リージョンのゲートウェイを無効にすることができます。 |
properties.enableClientCertificate |
boolean |
プロパティは、従量課金 SKU サービスにのみ使用されます。 これにより、ゲートウェイへの各要求にクライアント証明書が提示されます。 これにより、ゲートウェイのポリシーで証明書を認証することもできます。 |
properties.hostnameConfigurations |
API Management サービスのカスタム ホスト名構成。 |
|
properties.legacyPortalStatus |
API Management サービスのレガシ ポータルの状態。 |
|
properties.natGatewayState |
プロパティを使用して、この API Management サービスの NAT ゲートウェイを有効にすることができます。 |
|
properties.notificationSenderEmail |
string maxLength: 100 |
通知の送信先となる電子メール アドレス。 |
properties.privateEndpointConnections |
このサービスのプライベート エンドポイント接続の一覧。 |
|
properties.publicIpAddressId |
string |
リージョンにデプロイされた Virtual Network サービスに関連付けられるパブリック Standard SKU IP V4 ベースの IP アドレス。 Virtual Network にデプロイされている Developer SKU と Premium SKU でのみサポートされます。 |
properties.publicNetworkAccess |
この API Management サービスに対してパブリック エンドポイント アクセスが許可されているかどうか。 値は省略可能ですが、渡される場合は 'Enabled' または 'Disabled' である必要があります。 "無効" の場合、プライベート エンドポイントは排他アクセス方法です。 既定値は 'Enabled' です |
|
properties.publisherEmail |
string maxLength: 100 |
発行元の電子メール。 |
properties.publisherName |
string maxLength: 100 |
発行元名。 |
properties.restore |
boolean |
以前に論理的に削除された場合は、Api Management サービスの削除を取り消します。 このフラグを指定し、True に設定すると、他のすべてのプロパティは無視されます。 |
properties.virtualNetworkConfiguration |
API Management サービスの仮想ネットワーク構成。 |
|
properties.virtualNetworkType |
API Management サービスを構成する必要がある VPN の種類。 None (既定値) は、API Management サービスが仮想ネットワークに含まれていないことを意味し、外部は、インターネットに接続するエンドポイントを持つ仮想ネットワーク内に API Management デプロイが設定されていることを意味し、内部はイントラネットに接続するエンドポイントのみを持つ仮想ネットワーク内で API Management のデプロイが設定されることを意味します。 |
|
sku |
API Management サービスの SKU プロパティ。 |
|
tags |
object |
リソース タグ。 |
zones |
string[] |
リソースの取得場所を表す可用性ゾーンの一覧。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
サービスが正常に更新されました。 |
|
202 Accepted |
サービス更新要求が受け入れられました。 ヘッダー location: string |
|
Other Status Codes |
操作が失敗した理由を説明するエラー応答。 |
セキュリティ
azure_auth
Azure Active Directory OAuth2 フロー。
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/authorize
スコープ
名前 | 説明 |
---|---|
user_impersonation | ユーザー アカウントを偽装する |
例
Api |
Api |
Api |
ApiManagementUpdateServiceDisableTls10
要求のサンプル
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"
}
}
}
応答のサンプル
Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-05-01&asyncResponse
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-05-01&asyncResponse
{
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
"name": "apimService1",
"type": "Microsoft.ApiManagement/service",
"tags": {
"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
要求のサンプル
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"
}
}
応答のサンプル
Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-05-01&asyncResponse
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-05-01&asyncResponse
{
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
"name": "apimService1",
"type": "Microsoft.ApiManagement/service",
"tags": {
"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
要求のサンプル
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"
]
}
応答のサンプル
Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-05-01&asyncResponse
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-05-01&asyncResponse
{
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
"name": "apimService1",
"type": "Microsoft.ApiManagement/service",
"location": "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"
}
}
定義
名前 | 説明 |
---|---|
Additional |
追加の API Management リソースの場所の説明。 |
Api |
Api Management サービス リソースの ID プロパティ。 |
Api |
List または Get 応答の単一の API Management サービス リソース。 |
Api |
API Management サービス リソース SKU のプロパティ。 |
Api |
Update Api Management サービスに指定されたパラメーター。 |
Apim |
リソースに使用される ID の種類。 型 'SystemAssigned, UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' は、サービスからすべての ID を削除します。 |
Api |
API Management サービスのコントロール プレーン API のバージョン制約。 |
Arm |
ARM リソース ID のラッパー |
Certificate |
信頼されていない中間証明書とルート証明書で構成される証明書の構成。 |
Certificate |
SSL 証明書情報。 |
Certificate |
証明書ソース。 |
Certificate |
証明書の状態。 |
Configuration |
API Management サービスの構成 API に関する情報。 |
created |
リソースを作成した ID の種類。 |
developer |
この API Management サービスの開発者ポータルの状態。 |
Error |
リソース管理エラーの追加情報。 |
Error |
エラーの詳細。 |
Error |
エラー応答 |
Hostname |
カスタム ホスト名の構成。 |
Hostname |
ホスト名の種類。 |
Legacy |
レガシ構成 API (v1) を API Management サービスで公開する必要があるかどうかを示します。 値は省略可能ですが、'Enabled' または 'Disabled' である必要があります。 "無効" の場合、レガシ構成 API (v1) はセルフホステッド ゲートウェイでは使用できません。 既定値は 'Enabled' です |
Legacy |
API Management サービスのレガシ ポータルの状態。 |
Nat |
プロパティを使用して、この API Management サービスの NAT ゲートウェイを有効にすることができます。 |
Platform |
サービスを実行しているコンピューティング プラットフォームのバージョン。 |
Private |
プライベート エンドポイント接続の状態。 |
Private |
サービス コンシューマーとプロバイダー間の接続の状態に関する情報のコレクション。 |
Public |
この API Management サービスに対してパブリック エンドポイント アクセスが許可されているかどうか。 値は省略可能ですが、渡される場合は 'Enabled' または 'Disabled' である必要があります。 "無効" の場合、プライベート エンドポイントは排他アクセス方法です。 既定値は 'Enabled' です |
Remote |
リモート プライベート エンドポイント接続リソース。 |
Sku |
SKU の名前。 |
system |
リソースの作成と最後の変更に関連するメタデータ。 |
User |
|
Virtual |
API Management サービスのデプロイ先となる仮想ネットワークの構成。 |
Virtual |
API Management サービスを構成する必要がある VPN の種類。 None (既定値) は、API Management サービスが仮想ネットワークに含まれていないことを意味し、外部は、インターネットに接続するエンドポイントを持つ仮想ネットワーク内に API Management デプロイが設定されていることを意味し、内部はイントラネットに接続するエンドポイントのみを持つ仮想ネットワーク内で API Management のデプロイが設定されることを意味します。 |
AdditionalLocation
追加の API Management リソースの場所の説明。
名前 | 型 | 規定値 | 説明 |
---|---|---|---|
disableGateway |
boolean |
False |
プロパティは、複数の場所にデプロイされた Api Management サービスに対してのみ有効です。 これを使用して、この追加の場所でゲートウェイを無効にすることができます。 |
gatewayRegionalUrl |
string |
リージョン内の API Management サービスのゲートウェイ URL。 |
|
location |
string |
Azure データ センター リージョン間の追加リージョンの場所名。 |
|
natGatewayState | Disabled |
プロパティを使用して、この API Management サービスの NAT ゲートウェイを有効にすることができます。 |
|
outboundPublicIPAddresses |
string[] |
NAT ゲートウェイでデプロイされたサービスに関連付けられている送信パブリック IPV4 アドレス プレフィックス。 stv2 プラットフォームの Premium SKU でのみ使用できます。 |
|
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 |
API Management サービスの SKU プロパティ。 |
||
virtualNetworkConfiguration |
場所の仮想ネットワーク構成。 |
||
zones |
string[] |
リソースの取得場所を表す可用性ゾーンの一覧。 |
ApiManagementServiceIdentity
Api Management サービス リソースの ID プロパティ。
名前 | 型 | 説明 |
---|---|---|
principalId |
string (uuid) |
ID のプリンシパル ID。 |
tenantId |
string (uuid) |
ID のクライアント テナント ID。 |
type |
リソースに使用される ID の種類。 型 'SystemAssigned, UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' は、サービスからすべての ID を削除します。 |
|
userAssignedIdentities |
<string,
User |
リソースに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ のキー参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。 |
ApiManagementServiceResource
List または Get 応答の単一の API Management サービス リソース。
名前 | 型 | 規定値 | 説明 |
---|---|---|---|
etag |
string |
リソースの ETag。 |
|
id |
string |
リソース ID。 |
|
identity |
Api Management サービスのマネージド サービス ID。 |
||
location |
string |
リソースの場所。 |
|
name |
string |
リソース名。 |
|
properties.additionalLocations |
API Management サービスの追加のデータセンターの場所。 |
||
properties.apiVersionConstraint |
API Management サービスのコントロール プレーン API のバージョン制約。 |
||
properties.certificates |
API Management サービスにインストールする必要がある証明書の一覧。 インストールできるサポートされる証明書の最大数は 10 です。 |
||
properties.configurationApi |
API Management サービスの構成 API 構成。 |
||
properties.createdAtUtc |
string (date-time) |
API Management サービスの作成 UTC 日付。日付は、ISO 8601 標準で指定された |
|
properties.customProperties |
object |
API Management サービスのカスタム プロパティ。 |
|
properties.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 |
API Management サービスのカスタム ホスト名構成。 |
||
properties.legacyPortalStatus | Enabled |
API Management サービスのレガシ ポータルの状態。 |
|
properties.managementApiUrl |
string |
API Management サービスの管理 API エンドポイント URL。 |
|
properties.natGatewayState | Disabled |
プロパティを使用して、この API Management サービスの NAT ゲートウェイを有効にすることができます。 |
|
properties.notificationSenderEmail |
string maxLength: 100 |
通知の送信先となる電子メール アドレス。 |
|
properties.outboundPublicIPAddresses |
string[] |
NAT ゲートウェイでデプロイされたサービスに関連付けられている送信パブリック IPV4 アドレス プレフィックス。 stv2 プラットフォームの Premium SKU でのみ使用できます。 |
|
properties.platformVersion |
この場所でサービスを実行しているコンピューティング プラットフォーム のバージョン。 |
||
properties.portalUrl |
string |
API Management サービスのパブリッシャー ポータル エンドポイント URL。 |
|
properties.privateEndpointConnections |
このサービスのプライベート エンドポイント接続の一覧。 |
||
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 |
この 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 |
API Management サービスの仮想ネットワーク構成。 |
||
properties.virtualNetworkType | None |
API Management サービスを構成する必要がある VPN の種類。 None (既定値) は、API Management サービスが仮想ネットワークに含まれていないことを意味し、外部は、インターネットに接続するエンドポイントを持つ仮想ネットワーク内に API Management デプロイが設定されていることを意味し、内部はイントラネットに接続するエンドポイントのみを持つ仮想ネットワーク内で API Management のデプロイが設定されることを意味します。 |
|
sku |
API Management サービスの SKU プロパティ。 |
||
systemData |
リソースの作成と最後の変更に関連するメタデータ。 |
||
tags |
object |
リソース タグ。 |
|
type |
string |
API Management リソースのリソースの種類が Microsoft.ApiManagement に設定されています。 |
|
zones |
string[] |
リソースの取得場所を表す可用性ゾーンの一覧。 |
ApiManagementServiceSkuProperties
API Management サービス リソース SKU のプロパティ。
名前 | 型 | 説明 |
---|---|---|
capacity |
integer (int32) |
SKU の容量 (SKU のデプロイされたユニットの数)。 従量課金 SKU の容量は 0 として指定する必要があります。 |
name |
SKU の名前。 |
ApiManagementServiceUpdateParameters
Update Api Management サービスに指定されたパラメーター。
名前 | 型 | 規定値 | 説明 |
---|---|---|---|
etag |
string |
リソースの ETag。 |
|
id |
string |
リソース ID。 |
|
identity |
Api Management サービスのマネージド サービス ID。 |
||
name |
string |
リソース名。 |
|
properties.additionalLocations |
API Management サービスの追加のデータセンターの場所。 |
||
properties.apiVersionConstraint |
API Management サービスのコントロール プレーン API のバージョン制約。 |
||
properties.certificates |
API Management サービスにインストールする必要がある証明書の一覧。 インストールできるサポートされる証明書の最大数は 10 です。 |
||
properties.configurationApi |
API Management サービスの構成 API 構成。 |
||
properties.createdAtUtc |
string (date-time) |
API Management サービスの作成 UTC 日付。日付は、ISO 8601 標準で指定された |
|
properties.customProperties |
object |
API Management サービスのカスタム プロパティ。 |
|
properties.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 |
API Management サービスのカスタム ホスト名構成。 |
||
properties.legacyPortalStatus | Enabled |
API Management サービスのレガシ ポータルの状態。 |
|
properties.managementApiUrl |
string |
API Management サービスの管理 API エンドポイント URL。 |
|
properties.natGatewayState | Disabled |
プロパティを使用して、この API Management サービスの NAT ゲートウェイを有効にすることができます。 |
|
properties.notificationSenderEmail |
string maxLength: 100 |
通知の送信先となる電子メール アドレス。 |
|
properties.outboundPublicIPAddresses |
string[] |
NAT ゲートウェイでデプロイされたサービスに関連付けられている送信パブリック IPV4 アドレス プレフィックス。 stv2 プラットフォームの Premium SKU でのみ使用できます。 |
|
properties.platformVersion |
この場所でサービスを実行しているコンピューティング プラットフォーム のバージョン。 |
||
properties.portalUrl |
string |
API Management サービスのパブリッシャー ポータル エンドポイント URL。 |
|
properties.privateEndpointConnections |
このサービスのプライベート エンドポイント接続の一覧。 |
||
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 |
この 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 |
API Management サービスの仮想ネットワーク構成。 |
||
properties.virtualNetworkType | None |
API Management サービスを構成する必要がある VPN の種類。 None (既定値) は、API Management サービスが仮想ネットワークに含まれていないことを意味し、外部は、インターネットに接続するエンドポイントを持つ仮想ネットワーク内に API Management デプロイが設定されていることを意味し、内部はイントラネットに接続するエンドポイントのみを持つ仮想ネットワーク内で API Management のデプロイが設定されることを意味します。 |
|
sku |
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
API Management サービスのコントロール プレーン API のバージョン制約。
名前 | 型 | 説明 |
---|---|---|
minApiVersion |
string |
この値以上のバージョンを使用して、API Management サービスへのコントロール プレーン API 呼び出しを制限します。 |
ArmIdWrapper
ARM リソース ID のラッパー
名前 | 型 | 説明 |
---|---|---|
id |
string |
CertificateConfiguration
信頼されていない中間証明書とルート証明書で構成される証明書の構成。
名前 | 型 | 説明 |
---|---|---|
certificate |
証明書情報。 |
|
certificatePassword |
string |
証明書パスワード。 |
encodedCertificate |
string |
Base64 でエンコードされた証明書。 |
storeName |
enum:
|
System.Security.Cryptography.x509certificates.StoreName 証明書ストアの場所。 有効な場所は Root と CertificateAuthority だけです。 |
CertificateInformation
SSL 証明書情報。
名前 | 型 | 説明 |
---|---|---|
expiry |
string (date-time) |
証明書の有効期限。 日付は、ISO 8601 標準で指定された |
subject |
string |
証明書のサブジェクト。 |
thumbprint |
string |
証明書の拇印。 |
CertificateSource
証明書ソース。
値 | 説明 |
---|---|
BuiltIn | |
Custom | |
KeyVault | |
Managed |
CertificateStatus
証明書の状態。
値 | 説明 |
---|---|
Completed | |
Failed | |
InProgress |
ConfigurationApi
API Management サービスの構成 API に関する情報。
名前 | 型 | 規定値 | 説明 |
---|---|---|---|
legacyApi | Enabled |
レガシ構成 API (v1) を API Management サービスで公開する必要があるかどうかを示します。 値は省略可能ですが、'Enabled' または 'Disabled' である必要があります。 "無効" の場合、レガシ構成 API (v1) はセルフホステッド ゲートウェイでは使用できません。 既定値は 'Enabled' です |
createdByType
リソースを作成した ID の種類。
値 | 説明 |
---|---|
Application | |
Key | |
ManagedIdentity | |
User |
developerPortalStatus
この API Management サービスの開発者ポータルの状態。
値 | 説明 |
---|---|
Disabled |
開発者ポータルは、サービスに対して無効になっています。 |
Enabled |
開発者ポータルは、サービスに対して有効になっています。 |
ErrorAdditionalInfo
リソース管理エラーの追加情報。
名前 | 型 | 説明 |
---|---|---|
info |
object |
追加情報。 |
type |
string |
追加情報の種類。 |
ErrorDetail
エラーの詳細。
名前 | 型 | 説明 |
---|---|---|
additionalInfo |
エラーの追加情報。 |
|
code |
string |
エラー コード。 |
details |
エラーの詳細。 |
|
message |
string |
エラー メッセージ。 |
target |
string |
エラーターゲット。 |
ErrorResponse
エラー応答
名前 | 型 | 説明 |
---|---|---|
error |
エラー オブジェクト。 |
HostnameConfiguration
カスタム ホスト名の構成。
名前 | 型 | 規定値 | 説明 |
---|---|---|---|
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
ホスト名の種類。
値 | 説明 |
---|---|
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
サービス コンシューマーとプロバイダー間の接続の状態に関する情報のコレクション。
名前 | 型 | 説明 |
---|---|---|
actionsRequired |
string |
サービス プロバイダーの変更にコンシューマーの更新が必要かどうかを示すメッセージ。 |
description |
string |
接続の承認/拒否の理由。 |
status |
接続がサービスの所有者によって承認/拒否/削除されたかどうかを示します。 |
PublicNetworkAccess
この API Management サービスに対してパブリック エンドポイント アクセスが許可されているかどうか。 値は省略可能ですが、渡される場合は 'Enabled' または 'Disabled' である必要があります。 "無効" の場合、プライベート エンドポイントは排他アクセス方法です。 既定値は 'Enabled' です
値 | 説明 |
---|---|
Disabled | |
Enabled |
RemotePrivateEndpointConnectionWrapper
リモート プライベート エンドポイント接続リソース。
名前 | 型 | 説明 |
---|---|---|
id |
string |
プライベート エンドポイント接続リソース ID |
name |
string |
プライベート エンドポイント接続名 |
properties.groupIds |
string[] |
すべてのグループ ID。 |
properties.privateEndpoint |
プライベート エンドポイントのリソース。 |
|
properties.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
リソースの作成と最後の変更に関連するメタデータ。
名前 | 型 | 説明 |
---|---|---|
createdAt |
string (date-time) |
リソース作成のタイムスタンプ (UTC)。 |
createdBy |
string |
リソースを作成した ID。 |
createdByType |
リソースを作成した ID の種類。 |
|
lastModifiedAt |
string (date-time) |
リソースの最終変更のタイムスタンプ (UTC) |
lastModifiedBy |
string |
リソースを最後に変更した ID。 |
lastModifiedByType |
リソースを最後に変更した ID の種類。 |
UserIdentityProperties
名前 | 型 | 説明 |
---|---|---|
clientId |
string |
ユーザー割り当て ID のクライアント ID。 |
principalId |
string |
ユーザー割り当て ID のプリンシパル ID。 |
VirtualNetworkConfiguration
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 |
サービスは仮想ネットワークの一部ではありません。 |