Api Management Service - MigrateToStv2

API Management サービスを Stv2 プラットフォームにアップグレードします。 詳細については、 を https://aka.ms/apim-migrate-stv2参照してください。 この変更は元に戻すことはできません。 これは実行時間の長い操作であり、完了までに数分かかる場合があります。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/migrateToStv2?api-version=2022-08-01

URI パラメーター

名前 / 必須 説明
resourceGroupName
path True

string

リソース グループの名前。 名前の大文字と小文字は区別されます。

serviceName
path True

string

API Management サービスの名前。

正規表現パターン: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

ターゲット サブスクリプションの ID。

api-version
query True

string

この操作に使用する API バージョン。

応答

名前 説明
200 OK

ApiManagementServiceResource

サービスが正常に移行されました。

202 Accepted

移行要求が送信されました。

ヘッダー

location: string

Other Status Codes

ErrorResponse

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

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

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

スコープ

名前 説明
user_impersonation ユーザー アカウントの借用

ApiManagementMigrateService

要求のサンプル

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/migrateToStv2?api-version=2022-08-01

応答のサンプル

location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2022-08-01
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimservice1",
  "name": "apimservice1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {},
  "location": "West US",
  "etag": "AAAAAADqC0c=",
  "properties": {
    "publisherEmail": "abcs@contoso.com",
    "publisherName": "contoso publisher",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2019-12-02T01:42:09.1268424Z",
    "gatewayUrl": "https://apimservice1.azure-api.net",
    "gatewayRegionalUrl": "https://apimservice1-westus-01.regional.azure-api.net",
    "portalUrl": "https://apimservice1.portal.azure-api.net",
    "developerPortalUrl": "https://apimService1.developer.azure-api.net",
    "managementApiUrl": "https://apimservice1.management.azure-api.net",
    "scmUrl": "https://apimservice1.scm.azure-api.net",
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "hostName": "apimService1.azure-api.net",
        "negotiateClientCertificate": false,
        "defaultSslBinding": false,
        "certificateSource": "BuiltIn"
      },
      {
        "type": "Proxy",
        "hostName": "apimgatewaytest.preview.net",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2019-08-16T16:51:34+00:00",
          "thumbprint": "B4330123DBAXXXXXXXXX1F35E84493476",
          "subject": "CN=*.preview.net"
        },
        "defaultSslBinding": true,
        "certificateSource": "Custom"
      }
    ],
    "publicIPAddresses": [
      "137.XXX.11.74"
    ],
    "privateIPAddresses": [
      "172.XX.0.5"
    ],
    "additionalLocations": [
      {
        "location": "West US 2",
        "sku": {
          "name": "Premium",
          "capacity": 1
        },
        "publicIPAddresses": [
          "40.XXX.79.187"
        ],
        "privateIPAddresses": [
          "10.0.X.6"
        ],
        "virtualNetworkConfiguration": {
          "subnetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/APIMVNet/subnets/apim-internal-sub"
        },
        "gatewayRegionalUrl": "https://apimservice1-westus2-01.regional.azure-api.net",
        "disableGateway": false
      }
    ],
    "virtualNetworkConfiguration": {
      "subnetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/apim-appGateway-vnet/subnets/apim-subnet"
    },
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False"
    },
    "virtualNetworkType": "Internal",
    "disableGateway": false,
    "apiVersionConstraint": {},
    "platformVersion": "stv1"
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  }
}

定義

名前 説明
AdditionalLocation

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

ApiManagementServiceIdentity

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

ApiManagementServiceResource

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

ApiManagementServiceSkuProperties

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

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

ホスト名の種類。

NatGatewayState

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

PlatformVersion

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

PrivateEndpointServiceConnectionStatus

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

PrivateLinkServiceConnectionState

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

PublicNetworkAccess

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

RemotePrivateEndpointConnectionWrapper

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

SkuType

SKU の名前。

systemData

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

UserIdentityProperties
VirtualNetworkConfiguration

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

VirtualNetworkType

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

AdditionalLocation

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

名前 規定値 説明
disableGateway

boolean

False

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

gatewayRegionalUrl

string

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

location

string

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

natGatewayState

NatGatewayState

Disabled

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

outboundPublicIPAddresses

string[]

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

platformVersion

PlatformVersion

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

privateIPAddresses

string[]

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

publicIPAddresses

string[]

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

publicIpAddressId

string

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

sku

ApiManagementServiceSkuProperties

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

virtualNetworkConfiguration

VirtualNetworkConfiguration

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

zones

string[]

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

ApiManagementServiceIdentity

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

名前 説明
principalId

string

ID のプリンシパル ID。

tenantId

string

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

type

ApimIdentityType

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

userAssignedIdentities

<string,  UserIdentityProperties>

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

ApiManagementServiceResource

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

名前 規定値 説明
etag

string

リソースの ETag。

id

string

リソースの ID

identity

ApiManagementServiceIdentity

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

location

string

リソースの場所。

name

string

リソース名。

properties.additionalLocations

AdditionalLocation[]

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

properties.apiVersionConstraint

ApiVersionConstraint

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

properties.certificates

CertificateConfiguration[]

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 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

properties.developerPortalUrl

string

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

properties.disableGateway

boolean

False

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

properties.enableClientCertificate

boolean

False

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

properties.gatewayRegionalUrl

string

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

properties.gatewayUrl

string

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

properties.hostnameConfigurations

HostnameConfiguration[]

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

properties.managementApiUrl

string

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

properties.natGatewayState

NatGatewayState

Disabled

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

properties.notificationSenderEmail

string

通知の送信先となるアドレスをEmailします。

properties.outboundPublicIPAddresses

string[]

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

properties.platformVersion

PlatformVersion

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

properties.portalUrl

string

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

properties.privateEndpointConnections

RemotePrivateEndpointConnectionWrapper[]

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

properties.privateIPAddresses

string[]

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

properties.provisioningState

string

API Management サービスの現在のプロビジョニング状態。次のいずれかになります。Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted。

properties.publicIPAddresses

string[]

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

properties.publicIpAddressId

string

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

properties.publicNetworkAccess

PublicNetworkAccess

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

properties.publisherEmail

string

発行元の電子メール。

properties.publisherName

string

発行元名。

properties.restore

boolean

False

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

properties.scmUrl

string

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

properties.targetProvisioningState

string

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

properties.virtualNetworkConfiguration

VirtualNetworkConfiguration

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

properties.virtualNetworkType

VirtualNetworkType

None

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

sku

ApiManagementServiceSkuProperties

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

systemData

systemData

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

tags

object

リソース タグ。

type

string

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

zones

string[]

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

ApiManagementServiceSkuProperties

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

名前 説明
capacity

integer

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

name

SkuType

SKU の名前。

ApimIdentityType

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

名前 説明
None

string

SystemAssigned

string

SystemAssigned, UserAssigned

string

UserAssigned

string

ApiVersionConstraint

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

名前 説明
minApiVersion

string

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

ArmIdWrapper

ARM リソース ID のラッパー

名前 説明
id

string

CertificateConfiguration

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

名前 説明
certificate

CertificateInformation

証明書情報。

certificatePassword

string

証明書パスワード。

encodedCertificate

string

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

storeName enum:
  • CertificateAuthority
  • Root

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

CertificateInformation

SSL 証明書情報。

名前 説明
expiry

string

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

subject

string

証明書のサブジェクト。

thumbprint

string

証明書の拇印。

CertificateSource

証明書ソース。

名前 説明
BuiltIn

string

Custom

string

KeyVault

string

Managed

string

CertificateStatus

証明書の状態。

名前 説明
Completed

string

Failed

string

InProgress

string

createdByType

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

名前 説明
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorFieldContract

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

名前 説明
code

string

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

message

string

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

target

string

プロパティ名。

ErrorResponse

エラー応答。

名前 説明
error.code

string

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

error.details

ErrorFieldContract[]

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

error.message

string

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

HostnameConfiguration

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

名前 規定値 説明
certificate

CertificateInformation

証明書情報。

certificatePassword

string

証明書パスワード。

certificateSource

CertificateSource

証明書ソース。

certificateStatus

CertificateStatus

証明書の状態。

defaultSslBinding

boolean

False

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

encodedCertificate

string

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

hostName

string

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

identityClientId

string

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

keyVaultId

string

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

negotiateClientCertificate

boolean

False

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

type

HostnameType

ホスト名の種類。

HostnameType

ホスト名の種類。

名前 説明
DeveloperPortal

string

Management

string

Portal

string

Proxy

string

Scm

string

NatGatewayState

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

名前 説明
Disabled

string

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

Enabled

string

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

PlatformVersion

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

名前 説明
mtv1

string

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

stv1

string

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

stv2

string

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

undetermined

string

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

PrivateEndpointServiceConnectionStatus

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

名前 説明
Approved

string

Pending

string

Rejected

string

PrivateLinkServiceConnectionState

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

名前 説明
actionsRequired

string

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

description

string

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

status

PrivateEndpointServiceConnectionStatus

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

PublicNetworkAccess

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

名前 説明
Disabled

string

Enabled

string

RemotePrivateEndpointConnectionWrapper

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

名前 説明
id

string

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

name

string

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

properties.groupIds

string[]

すべてのグループ ID。

properties.privateEndpoint

ArmIdWrapper

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

properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

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

properties.provisioningState

string

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

type

string

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

SkuType

SKU の名前。

名前 説明
Basic

string

Api Management の Basic SKU。

Consumption

string

Api Management の従量課金 SKU。

Developer

string

Api Management の開発者 SKU。

Isolated

string

Api Management の分離された SKU。

Premium

string

Api Management の Premium SKU。

Standard

string

Api Management の Standard SKU。

systemData

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

名前 説明
createdAt

string

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

createdBy

string

リソースを作成した ID。

createdByType

createdByType

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

lastModifiedAt

string

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

lastModifiedBy

string

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

lastModifiedByType

createdByType

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

UserIdentityProperties

名前 説明
clientId

string

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

principalId

string

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

VirtualNetworkConfiguration

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

名前 説明
subnetResourceId

string

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

subnetname

string

サブネットの名前。

vnetid

string

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

VirtualNetworkType

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

名前 説明
External

string

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

Internal

string

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

None

string

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