ApiManagementServiceResource interface

リファレンス

パッケージ:: @azure/arm-apimanagement

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

Extends: ApimResource

プロパティ

additionalLocations	API Management サービスの追加のデータセンターの場所。
apiVersionConstraint	API Management サービスのコントロールプレーン Apis バージョン制約。
certificates	API Management サービスにインストールする必要がある証明書の一覧。インストールできるサポートされる証明書の最大数は 10 です。
createdAtUtc	API Management サービスの作成 UTC 日付。日付は、ISO 8601 標準で指定されている形式`yyyy-MM-ddTHH:mm:ssZ`に準拠しています。注: このプロパティはシリアル化されません。これは、サーバーによってのみ設定できます。
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
developerPortalUrl	API Management サービスの DEveloper Portal エンドポイント URL。注: このプロパティはシリアル化されません。これは、サーバーによってのみ設定できます。
disableGateway	プロパティは、複数の場所にデプロイされた Api Management サービスに対してのみ有効です。これは、マスターリージョンでゲートウェイを無効にするために使用できます。
enableClientCertificate	プロパティは、従量課金 SKU サービスにのみ使用されます。これにより、ゲートウェイへの各要求にクライアント証明書が提示されます。これにより、ゲートウェイのポリシーで証明書を認証することもできます。
etag	リソースの ETag。注: このプロパティはシリアル化されません。これは、サーバーによってのみ設定できます。
gatewayRegionalUrl	既定のリージョンのAPI Management サービスのゲートウェイ URL。注: このプロパティはシリアル化されません。これは、サーバーによってのみ設定できます。
gatewayUrl	API Management サービスのゲートウェイ URL。注: このプロパティはシリアル化されません。これは、サーバーによってのみ設定できます。
hostnameConfigurations	API Management サービスのカスタムホスト名の構成。
identity	Api Management サービスのマネージドサービス ID。
location	リソースの場所。
managementApiUrl	API Management サービスの管理 API エンドポイント URL。注: このプロパティはシリアル化されません。これは、サーバーによってのみ設定できます。
natGatewayState	プロパティを使用して、このAPI Management サービスの NAT ゲートウェイを有効にすることができます。
notificationSenderEmail	通知の送信先となるアドレスをEmailします。
outboundPublicIPAddresses	NAT Gateway によってデプロイされたサービスに関連付けられている送信パブリック IPV4 アドレスプレフィックス。 stv2 プラットフォームの Premium SKU でのみ使用できます。注: このプロパティはシリアル化されません。これは、サーバーによってのみ設定できます。
platformVersion	この場所でサービスを実行しているコンピューティングプラットフォームのバージョン。注: このプロパティはシリアル化されません。これは、サーバーによってのみ設定できます。
portalUrl	API Management サービスのパブリッシャーポータルエンドポイント URL。注: このプロパティはシリアル化されません。これは、サーバーによってのみ設定できます。
privateEndpointConnections	このサービスのプライベートエンドポイント接続の一覧。
privateIPAddresses	内部Virtual NetworkにデプロイされているプライマリリージョンのAPI Management サービスのプライベート静的負荷分散 IP アドレス。 Basic、Standard、Premium、Isolated SKU でのみ使用できます。注: このプロパティはシリアル化されません。これは、サーバーによってのみ設定できます。
provisioningState	API Management サービスの現在のプロビジョニング状態。次のいずれかになります。Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted。注: このプロパティはシリアル化されません。これは、サーバーによってのみ設定できます。
publicIPAddresses	プライマリリージョンのAPI Management サービスのパブリック静的負荷分散 IP アドレス。 Basic、Standard、Premium、Isolated SKU でのみ使用できます。注: このプロパティはシリアル化されません。これは、サーバーによってのみ設定できます。
publicIpAddressId	リージョンにデプロイされたサービスに関連付けられるパブリック Standard SKU IP V4 ベースの IP アドレスVirtual Network。 Virtual Networkにデプロイされている Developer SKU と Premium SKU でのみサポートされます。
publicNetworkAccess	このAPI Management サービスに対してパブリックエンドポイントアクセスが許可されているかどうか。値は省略可能ですが、渡される場合は、'Enabled' または 'Disabled' である必要があります。 "無効" の場合、プライベートエンドポイントは排他アクセス方法です。既定値は 'Enabled' です
publisherEmail	発行元の電子メール。
publisherName	発行元名。
restore	以前に論理的に削除された場合は、Api Management サービスの削除を取り消します。このフラグを指定し、True に設定すると、他のすべてのプロパティは無視されます。
scmUrl	API Management サービスの SCM エンドポイント URL。注: このプロパティはシリアル化されません。これは、サーバーによってのみ設定できます。
sku	API Management サービスの SKU プロパティ。
systemData	リソースの作成と最後の変更に関連するメタデータ。注: このプロパティはシリアル化されません。これは、サーバーによってのみ設定できます。
targetProvisioningState	API Management サービスのプロビジョニング状態。これは、サービスで開始された実行時間の長い操作を対象とします。注: このプロパティはシリアル化されません。これは、サーバーによってのみ設定できます。
virtualNetworkConfiguration	API Management サービスの仮想ネットワーク構成。
virtualNetworkType	API Management サービスを構成する必要がある VPN の種類。 None (既定値) は、API Management サービスがVirtual Networkに含まれていないことを意味し、External はインターネットに接続するエンドポイントを持つVirtual Network内にAPI Management展開が設定されていることを意味し、内部はAPI Management展開は、イントラネット接続エンドポイントのみを持つVirtual Network内で設定されます。
zones	リソースの取得元を表す可用性ゾーンの一覧。

継承されたプロパティ

id	リソースの ID 注: このプロパティはシリアル化されません。サーバーによってのみ設定できます。
name	リソース名。注: このプロパティはシリアル化されません。サーバーによってのみ設定できます。
tags	リソースタグ。
type	API Management リソースのリソースの種類は Microsoft.ApiManagement に設定されています。注: このプロパティはシリアル化されません。これは、サーバーによってのみ設定できます。

プロパティの詳細

additionalLocations

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

additionalLocations?: AdditionalLocation[]

プロパティ値

AdditionalLocation[]

apiVersionConstraint

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

apiVersionConstraint?: ApiVersionConstraint

プロパティ値

ApiVersionConstraint

certificates

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

certificates?: CertificateConfiguration[]

プロパティ値

CertificateConfiguration[]

createdAtUtc

API Management サービスの作成 UTC 日付。日付は、ISO 8601 標準で指定されている形式yyyy-MM-ddTHH:mm:ssZに準拠しています。注: このプロパティはシリアル化されません。これは、サーバーによってのみ設定できます。

createdAtUtc?: Date

プロパティ値

Date

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

customProperties?: {[propertyName: string]: string}

プロパティ値

{[propertyName: string]: string}

developerPortalUrl

API Management サービスの DEveloper Portal エンドポイント URL。注: このプロパティはシリアル化されません。これは、サーバーによってのみ設定できます。

developerPortalUrl?: string

プロパティ値

string

disableGateway

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

disableGateway?: boolean

プロパティ値

boolean

enableClientCertificate

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

enableClientCertificate?: boolean

プロパティ値

boolean

etag

リソースの ETag。注: このプロパティはシリアル化されません。これは、サーバーによってのみ設定できます。

etag?: string

プロパティ値

string

gatewayRegionalUrl

既定のリージョンのAPI Management サービスのゲートウェイ URL。注: このプロパティはシリアル化されません。これは、サーバーによってのみ設定できます。

gatewayRegionalUrl?: string

プロパティ値

string

gatewayUrl

API Management サービスのゲートウェイ URL。注: このプロパティはシリアル化されません。これは、サーバーによってのみ設定できます。

gatewayUrl?: string

プロパティ値

string

hostnameConfigurations

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

hostnameConfigurations?: HostnameConfiguration[]

プロパティ値

HostnameConfiguration[]

identity

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

identity?: ApiManagementServiceIdentity

プロパティ値

ApiManagementServiceIdentity

location

リソースの場所。

location: string

プロパティ値

string

managementApiUrl

API Management サービスの管理 API エンドポイント URL。注: このプロパティはシリアル化されません。これは、サーバーによってのみ設定できます。

managementApiUrl?: string

プロパティ値

string

natGatewayState

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

natGatewayState?: string

プロパティ値

string

notificationSenderEmail

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

notificationSenderEmail?: string

プロパティ値

string

outboundPublicIPAddresses

NAT Gateway によってデプロイされたサービスに関連付けられている送信パブリック IPV4 アドレスプレフィックス。 stv2 プラットフォームの Premium SKU でのみ使用できます。注: このプロパティはシリアル化されません。これは、サーバーによってのみ設定できます。

outboundPublicIPAddresses?: string[]

プロパティ値

string[]

platformVersion

この場所でサービスを実行しているコンピューティングプラットフォームのバージョン。注: このプロパティはシリアル化されません。これは、サーバーによってのみ設定できます。

platformVersion?: string

プロパティ値

string

portalUrl

API Management サービスのパブリッシャーポータルエンドポイント URL。注: このプロパティはシリアル化されません。これは、サーバーによってのみ設定できます。

portalUrl?: string

プロパティ値

string

privateEndpointConnections

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

privateEndpointConnections?: RemotePrivateEndpointConnectionWrapper[]

プロパティ値

RemotePrivateEndpointConnectionWrapper[]

privateIPAddresses

内部Virtual NetworkにデプロイされているプライマリリージョンのAPI Management サービスのプライベート静的負荷分散 IP アドレス。 Basic、Standard、Premium、Isolated SKU でのみ使用できます。注: このプロパティはシリアル化されません。これは、サーバーによってのみ設定できます。

privateIPAddresses?: string[]

プロパティ値

string[]

provisioningState

API Management サービスの現在のプロビジョニング状態。次のいずれかになります。Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted。注: このプロパティはシリアル化されません。これは、サーバーによってのみ設定できます。

provisioningState?: string

プロパティ値

string

publicIPAddresses

プライマリリージョンのAPI Management サービスのパブリック静的負荷分散 IP アドレス。 Basic、Standard、Premium、Isolated SKU でのみ使用できます。注: このプロパティはシリアル化されません。これは、サーバーによってのみ設定できます。

publicIPAddresses?: string[]

プロパティ値

string[]

publicIpAddressId

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

publicIpAddressId?: string

プロパティ値

string

publicNetworkAccess

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

publicNetworkAccess?: string

プロパティ値

string

publisherEmail

発行元の電子メール。

publisherEmail: string

プロパティ値

string

publisherName

発行元名。

publisherName: string

プロパティ値

string

restore

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

restore?: boolean

プロパティ値

boolean

scmUrl

API Management サービスの SCM エンドポイント URL。注: このプロパティはシリアル化されません。これは、サーバーによってのみ設定できます。

scmUrl?: string

プロパティ値

string

sku

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

sku: ApiManagementServiceSkuProperties

プロパティ値

ApiManagementServiceSkuProperties

systemData

リソースの作成と最後の変更に関連するメタデータ。注: このプロパティはシリアル化されません。これは、サーバーによってのみ設定できます。

systemData?: SystemData

プロパティ値

SystemData

targetProvisioningState

API Management サービスのプロビジョニング状態。これは、サービスで開始された実行時間の長い操作を対象とします。注: このプロパティはシリアル化されません。これは、サーバーによってのみ設定できます。

targetProvisioningState?: string

プロパティ値

string

virtualNetworkConfiguration

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

virtualNetworkConfiguration?: VirtualNetworkConfiguration

プロパティ値

VirtualNetworkConfiguration

virtualNetworkType

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

virtualNetworkType?: string

プロパティ値

string

zones

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

zones?: string[]

プロパティ値

string[]

継承されたプロパティの詳細

id

リソースの ID 注: このプロパティはシリアル化されません。サーバーによってのみ設定できます。

id?: string

プロパティ値

string

ApimResource.idから継承

name

リソース名。注: このプロパティはシリアル化されません。サーバーによってのみ設定できます。

name?: string

プロパティ値

string

ApimResource.nameから継承

type

API Management リソースのリソースの種類は Microsoft.ApiManagement に設定されています。注: このプロパティはシリアル化されません。これは、サーバーによってのみ設定できます。

type?: string

プロパティ値

string

ApimResource.typeから継承

次の方法で共有

ApiManagementServiceResource interface

プロパティ

継承されたプロパティ

プロパティの詳細

additionalLocations

プロパティ値

apiVersionConstraint

プロパティ値

certificates

プロパティ値

createdAtUtc

プロパティ値

customProperties

プロパティ値

developerPortalUrl

プロパティ値

disableGateway

プロパティ値

enableClientCertificate

プロパティ値

etag

プロパティ値

gatewayRegionalUrl

プロパティ値

gatewayUrl

プロパティ値

hostnameConfigurations

プロパティ値

identity

プロパティ値

location

プロパティ値

managementApiUrl

プロパティ値

natGatewayState

プロパティ値

notificationSenderEmail

プロパティ値

outboundPublicIPAddresses

プロパティ値

platformVersion

プロパティ値

portalUrl

プロパティ値

privateEndpointConnections

プロパティ値

privateIPAddresses

プロパティ値

provisioningState

プロパティ値

publicIPAddresses

プロパティ値

publicIpAddressId

プロパティ値

publicNetworkAccess

プロパティ値

publisherEmail

プロパティ値

publisherName

プロパティ値

restore

プロパティ値

scmUrl

プロパティ値

sku

プロパティ値

systemData

プロパティ値

targetProvisioningState

プロパティ値

virtualNetworkConfiguration

プロパティ値

virtualNetworkType

プロパティ値

zones

プロパティ値

継承されたプロパティの詳細

id

プロパティ値