@azure/arm-postgresqlhsc package

インターフェイス

AuthConfig

クラスターの認証構成。

Cluster

クラスターを表します。

ClusterForUpdate

更新対象のクラスターを表します。

ClusterProperties

クラスターのプロパティ。

ClusterPropertiesForUpdate

クラスタを更新するために使われたプロパティ。

ClusterServer

クラスター内のサーバーを表します。

ClusterServerProperties

クラスタ内のサーバーのプロパティ。

ClustersCheckNameAvailabilityOptionalParams

省略可能なパラメーター。

ClustersCreateOptionalParams

省略可能なパラメーター。

ClustersDeleteOptionalParams

省略可能なパラメーター。

ClustersGetOptionalParams

省略可能なパラメーター。

ClustersListByResourceGroupOptionalParams

省略可能なパラメーター。

ClustersListOptionalParams

省略可能なパラメーター。

ClustersOperations

クラスタ操作を表すインターフェイス。

ClustersPromoteReadReplicaOptionalParams

省略可能なパラメーター。

ClustersRestartOptionalParams

省略可能なパラメーター。

ClustersStartOptionalParams

省略可能なパラメーター。

ClustersStopOptionalParams

省略可能なパラメーター。

ClustersUpdateOptionalParams

省略可能なパラメーター。

Configuration

コーディネーターとノードの構成の詳細を表します。

ConfigurationProperties

構成の性質。

ConfigurationsGetCoordinatorOptionalParams

省略可能なパラメーター。

ConfigurationsGetNodeOptionalParams

省略可能なパラメーター。

ConfigurationsGetOptionalParams

省略可能なパラメーター。

ConfigurationsListByClusterOptionalParams

省略可能なパラメーター。

ConfigurationsListByServerOptionalParams

省略可能なパラメーター。

ConfigurationsOperations

インターフェースは構成操作を表すものです。

ConfigurationsUpdateOnCoordinatorOptionalParams

省略可能なパラメーター。

ConfigurationsUpdateOnNodeOptionalParams

省略可能なパラメーター。

DBforPostgreSQLClientOptionalParams

クライアントのオプションのパラメーター。

DataEncryption

クラスターのデータ暗号化プロパティ。

ErrorAdditionalInfo

リソース管理エラーの追加情報

ErrorDetail

エラーの詳細。

ErrorResponse

すべてのAzure Resource Manager APIで失敗した操作に対してエラー詳細を返す共通のエラー応答です。

FirewallRule

クラスター ファイアウォール規則を表します。

FirewallRuleProperties

クラスタファイアウォールルールの特性。

FirewallRulesCreateOrUpdateOptionalParams

省略可能なパラメーター。

FirewallRulesDeleteOptionalParams

省略可能なパラメーター。

FirewallRulesGetOptionalParams

省略可能なパラメーター。

FirewallRulesListByClusterOptionalParams

省略可能なパラメーター。

FirewallRulesOperations

FirewallRules 操作を表すインターフェイス。

IdentityProperties

クラスターの ID について説明します。

MaintenanceWindow

定期的なクラスター更新プログラムの設定をスケジュールします。

NameAvailability

クラスター名の可用性を表します。

NameAvailabilityRequest

クラスター名の可用性を確認するようにクライアントから要求します。

Operation

リソース プロバイダー操作 API から返される REST API 操作の詳細

OperationDisplay

作戦のためのローカライズされた表示情報。

OperationsListOptionalParams

省略可能なパラメーター。

OperationsOperations

オペレーション操作を表すインターフェイス。

PageSettings

byPage メソッドのオプション

PagedAsyncIterableIterator

完了まで、およびページごとに非同期反復可能な反復を許可するインターフェイス。

PrivateEndpoint

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

PrivateEndpointConnection

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

PrivateEndpointConnectionProperties

プライベート エンドポイント接続のプロパティ。

PrivateEndpointConnectionSimpleProperties

プライベートエンドポイント接続におけるプロパティ

PrivateEndpointConnectionsCreateOrUpdateOptionalParams

省略可能なパラメーター。

PrivateEndpointConnectionsDeleteOptionalParams

省略可能なパラメーター。

PrivateEndpointConnectionsGetOptionalParams

省略可能なパラメーター。

PrivateEndpointConnectionsListByClusterOptionalParams

省略可能なパラメーター。

PrivateEndpointConnectionsOperations

PrivateEndpointConnections 操作を表すインターフェイス。

PrivateEndpointProperty

プライベート エンドポイントのリソース ID を表すプロパティ。

PrivateLinkResource

プライベート リンク リソース。

PrivateLinkResourceProperties

プライベート リンク リソースのプロパティ。

PrivateLinkResourcesGetOptionalParams

省略可能なパラメーター。

PrivateLinkResourcesListByClusterOptionalParams

省略可能なパラメーター。

PrivateLinkResourcesOperations

PrivateLinkResources 操作を表すインターフェイス。

PrivateLinkServiceConnectionState

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

PromoteRequest

geo 冗長レプリカの昇格をクライアントから要求する

ProxyResource

Azure Resource Manager プロキシ リソースのリソース モデル定義。 タグと場所はありません

Resource

すべての Azure Resource Manager リソースの応答で返される共通フィールド

RestorePollerOptions
Role

クラスター ロールを表します。

RoleProperties

クラスタ役割の性質。

RolePropertiesExternalIdentity

model interface RolePropertiesExternalIdentity

RolesCreateOptionalParams

省略可能なパラメーター。

RolesDeleteOptionalParams

省略可能なパラメーター。

RolesGetOptionalParams

省略可能なパラメーター。

RolesListByClusterOptionalParams

省略可能なパラメーター。

RolesOperations

役割操作を表すインターフェース。

ServerConfiguration

構成を表します。

ServerConfigurationProperties

構成のプロパティ。

ServerNameItem

サーバーの名前オブジェクト。

ServerProperties

サーバーの特性。

ServerRoleGroupConfiguration

サーバー役割グループの構成値を表します。

ServersGetOptionalParams

省略可能なパラメーター。

ServersListByClusterOptionalParams

省略可能なパラメーター。

ServersOperations

サーバー操作を表すインターフェース。

SimplePrivateEndpointConnection

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

SystemData

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

TrackedResource

Azure Resource Manager のリソース モデル定義は、"タグ" と "場所" を持つ最上位リソースを追跡しました

UserAssignedIdentity

ユーザー割り当て ID プロパティ

型エイリアス

AadEnabledEnum

クラスターが AAD 認証を使用して作成されたかどうかを示します。
KnownAadEnabledEnum はAadEnabledEnumと同義使用可能で、このenumはサービスがサポートする既知の値を含む。

サービスでサポートされている既知の値

有効
無効

ActionType

拡張可能な列挙型。 アクションの種類を示します。 "内部" とは、内部のみの API に対するアクションを指します。
KnownActionType ActionType と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

内部: アクションは内部専用 API 用です。

ActiveDirectoryAuth

ActiveDirectory認証の種類

AzureSupportedClouds

文字列リテラル型としてのクラウド設定でサポートされている値

CheckNameAvailabilityResourceType

名前の可用性の検証に使用されるリソースの種類。

ConfigurationDataType

構成のデータ型。
KnownConfigurationDataType ConfigurationDataType と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

ブーリアン
Numeric
整数
リスト

ContinuablePage

結果のページを記述するインターフェース。

CreatedByType

リソースを作成したエンティティの種類。
KnownCreatedByType は CreatedByType と同じ意味で使用できます。この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

ユーザー: エンティティはユーザーによって作成されました。
アプリケーション: エンティティはアプリケーションによって作成されました。
ManagedIdentity: エンティティはマネージド ID によって作成されました。
キー: エンティティはキーによって作成されました。

DataEncryptionType

DataEncryptionTypeの種類

IdentityType

アイデンティティタイプの種類

Origin

操作の目的の実行プログラム。リソース ベースのアクセス制御 (RBAC) と監査ログ UX と同様です。 既定値は "user,system" です
KnownOrigin を Origin と同じ意味で使用できる 、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

ユーザー: 操作がユーザーによって開始されたことを示します。
システム: 操作がシステムによって開始されたことを示します。
ユーザー、システム: 操作がユーザーまたはシステムによって開始されたことを示します。

PasswordAuth

パスワード認証の種類

PasswordEnabledEnum

クラスターがパスワードで作成されたか、AAD 認証を使用して作成されたかを示します。
KnownPasswordEnabledEnum はPasswordEnabledEnumと同義使用可能で、このenumにはサービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

有効
無効

PrincipalType

PrincipalType の種類

PrivateEndpointConnectionProvisioningState

現在のプロビジョニング状態。
KnownPrivateEndpointConnectionProvisioningState PrivateEndpointConnectionProvisioningState と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

成功した: 接続がプロビジョニングされました
の作成: 接続が作成されています
の削除: 接続が削除されています
失敗した: 接続のプロビジョニングに失敗しました

PrivateEndpointServiceConnectionStatus

プライベート エンドポイント接続の状態。
KnownPrivateEndpointServiceConnectionStatus PrivateEndpointServiceConnectionStatus と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

保留中: 承認または拒否を待機している接続
承認済み: 接続が承認されました
拒否された: 接続が拒否されました

ProvisioningState

現在のプロビジョニング状態。
KnownProvisioningState ProvisioningState と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。

サービスでサポートされている既知の値

成功しました
取り消されました
InProgress
失敗 しました

RoleType

ロールタイプの種類

ServerRole

サーバーの役割。
KnownServerRole はServerRoleと互換的に使用可能で、この列挙はサービスがサポートする既知の値を含む。

サービスでサポートされている既知の値

コーディネーター
ワーカー

列挙型

AzureClouds

Azure Cloud 環境を説明するための列挙式です。

KnownAadEnabledEnum

クラスターが AAD 認証を使用して作成されたかどうかを示します。

KnownActionType

拡張可能な列挙型。 アクションの種類を示します。 "内部" とは、内部のみの API に対するアクションを指します。

KnownActiveDirectoryAuth

サービスが受け入れる既知の ActiveDirectoryAuth の値。

KnownConfigurationDataType

構成のデータ型。

KnownCreatedByType

リソースを作成したエンティティの種類。

KnownDataEncryptionType

サービスが受け入れる既知の DataEncryptionType の値。

KnownIdentityType

IdentityType の既知の値は、サービスが受け入れる

KnownOrigin

操作の目的の実行プログラム。リソース ベースのアクセス制御 (RBAC) と監査ログ UX と同様です。 既定値は "user,system" です

KnownPasswordAuth

サービスが受け入れている既知の PasswordAuth の値。

KnownPasswordEnabledEnum

クラスターがパスワードで作成されたか、AAD 認証を使用して作成されたかを示します。

KnownPrincipalType

PrincipalType の既知の値は、サービスが受け入れる

KnownPrivateEndpointConnectionProvisioningState

現在のプロビジョニング状態。

KnownPrivateEndpointServiceConnectionStatus

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

KnownProvisioningState

現在のプロビジョニング状態。

KnownRoleType

サービスが受け入れる既知の RoleType の数値。

KnownServerRole

サーバーの役割。

KnownVersions

使用可能な API バージョン。

関数

isRestError(unknown)

RestError の Typeguard

restorePoller<TResponse, TResult>(DBforPostgreSQLClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

別のポーラーのシリアル化された状態からポーラーを作成します。 これは、別のホストにポーラーを作成する場合や、元のポーラーがスコープ内にない後にポーラーを構築する必要がある場合に便利です。

変数

RestError

失敗したパイプライン要求のカスタム エラーの種類。

関数の詳細

isRestError(unknown)

RestError の Typeguard

function isRestError(e: unknown): e

パラメーター

e

unknown

catch 句によってキャッチされる何か。

返品

e

restorePoller<TResponse, TResult>(DBforPostgreSQLClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

別のポーラーのシリアル化された状態からポーラーを作成します。 これは、別のホストにポーラーを作成する場合や、元のポーラーがスコープ内にない後にポーラーを構築する必要がある場合に便利です。

function restorePoller<TResponse, TResult>(client: DBforPostgreSQLClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

パラメーター

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

返品

PollerLike<OperationState<TResult>, TResult>

変数の詳細

RestError

失敗したパイプライン要求のカスタム エラーの種類。

RestError: RestErrorConstructor