ApiManagementServiceUpdateProperties interface

発行元の電子メール。

publisherEmail?: string

プロパティ値

発行元名。

publisherName?: string

プロパティ値

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

additionalLocations?: AdditionalLocation[]

プロパティ値

ApiManagementServiceBaseProperties.additionalLocationsから継承

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

apiVersionConstraint?: ApiVersionConstraint

プロパティ値

継承元ApiManagementServiceBaseProperties.apiVersionConstraint

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

certificates?: CertificateConfiguration[]

プロパティ値

ApiManagementServiceBaseProperties.certificatesから継承

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

createdAtUtc?: Date

プロパティ値

ApiManagementServiceBaseProperties.createdAtUtcから継承

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}

プロパティ値

ApiManagementServiceBaseProperties.customPropertiesから継承

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

developerPortalUrl?: string

プロパティ値

ApiManagementServiceBaseProperties.developerPortalUrlから継承されます

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

disableGateway?: boolean

プロパティ値

ApiManagementServiceBaseProperties.disableGatewayから継承

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

enableClientCertificate?: boolean

プロパティ値

ApiManagementServiceBaseProperties.enableClientCertificateから継承

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

gatewayRegionalUrl?: string

プロパティ値

ApiManagementServiceBaseProperties.gatewayRegionalUrlから継承されます

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

gatewayUrl?: string

プロパティ値

ApiManagementServiceBaseProperties.gatewayUrlから継承されます

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

hostnameConfigurations?: HostnameConfiguration[]

プロパティ値

継承元ApiManagementServiceBaseProperties.hostnameConfigurations

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

managementApiUrl?: string

プロパティ値

ApiManagementServiceBaseProperties.managementApiUrlから継承されます

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

natGatewayState?: string

プロパティ値

ApiManagementServiceBaseProperties.natGatewayStateから継承されます

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

notificationSenderEmail?: string

プロパティ値

ApiManagementServiceBaseProperties.notificationSenderEmailから継承

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

outboundPublicIPAddresses?: string[]

プロパティ値

ApiManagementServiceBaseProperties.outboundPublicIPAddressesから継承されます

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

platformVersion?: string

プロパティ値

ApiManagementServiceBaseProperties.platformVersionから継承

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

portalUrl?: string

プロパティ値

ApiManagementServiceBaseProperties.portalUrlから継承

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

privateEndpointConnections?: RemotePrivateEndpointConnectionWrapper[]

プロパティ値

ApiManagementServiceBaseProperties.privateEndpointConnectionsから継承

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

privateIPAddresses?: string[]

プロパティ値

ApiManagementServiceBaseProperties.privateIPAddressesから継承

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

provisioningState?: string

プロパティ値

ApiManagementServiceBaseProperties.provisioningStateから継承

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

publicIPAddresses?: string[]

プロパティ値

ApiManagementServiceBaseProperties.publicIPAddressesから継承

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

publicIpAddressId?: string

プロパティ値

ApiManagementServiceBaseProperties.publicIpAddressIdから継承されます

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

publicNetworkAccess?: string

プロパティ値

ApiManagementServiceBaseProperties.publicNetworkAccessから継承

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

restore?: boolean

プロパティ値

ApiManagementServiceBaseProperties.restoreから継承

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

scmUrl?: string

プロパティ値

ApiManagementServiceBaseProperties.scmUrlから継承

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

targetProvisioningState?: string

プロパティ値

ApiManagementServiceBaseProperties.targetProvisioningStateから継承

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

virtualNetworkConfiguration?: VirtualNetworkConfiguration

プロパティ値

ApiManagementServiceBaseProperties.virtualNetworkConfigurationから継承

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

virtualNetworkType?: string

プロパティ値

ApiManagementServiceBaseProperties.virtualNetworkTypeから継承