@azure/arm-cosmosdbforpostgresql package

Klassen

CosmosDBForPostgreSQL

Schnittstellen

Cluster	Stellt einen Cluster dar.
ClusterConfigurationListResult	Eine Liste der Clusterkonfigurationen.
ClusterForUpdate	Stellt einen Cluster für die Aktualisierung dar.
ClusterListResult	Eine Liste von Clustern.
ClusterServer	Stellt einen Server in einem Cluster dar.
ClusterServerListResult	Eine Liste der Server in einem Cluster.
ClusterServerProperties	Die Eigenschaften eines Servers im Cluster.
Clusters	Schnittstelle, die einen Cluster darstellt.
ClustersCheckNameAvailabilityOptionalParams	Optionale Parameter.
ClustersCreateHeaders	Definiert Kopfzeilen für Clusters_create Vorgang.
ClustersCreateOptionalParams	Optionale Parameter.
ClustersDeleteHeaders	Definiert Kopfzeilen für Clusters_delete Vorgang.
ClustersDeleteOptionalParams	Optionale Parameter.
ClustersGetOptionalParams	Optionale Parameter.
ClustersListByResourceGroupNextOptionalParams	Optionale Parameter.
ClustersListByResourceGroupOptionalParams	Optionale Parameter.
ClustersListNextOptionalParams	Optionale Parameter.
ClustersListOptionalParams	Optionale Parameter.
ClustersPromoteReadReplicaHeaders	Definiert Kopfzeilen für Clusters_promoteReadReplica Vorgang.
ClustersPromoteReadReplicaOptionalParams	Optionale Parameter.
ClustersRestartHeaders	Definiert Kopfzeilen für Clusters_restart Vorgang.
ClustersRestartOptionalParams	Optionale Parameter.
ClustersStartHeaders	Definiert Kopfzeilen für Clusters_start Vorgang.
ClustersStartOptionalParams	Optionale Parameter.
ClustersStopHeaders	Definiert Kopfzeilen für Clusters_stop Vorgang.
ClustersStopOptionalParams	Optionale Parameter.
ClustersUpdateHeaders	Definiert Kopfzeilen für Clusters_update Vorgang.
ClustersUpdateOptionalParams	Optionale Parameter.
Configuration	Stellt Konfigurationsdetails für Koordinator und Knoten dar.
Configurations	Schnittstelle, die eine Konfiguration darstellt.
ConfigurationsGetCoordinatorOptionalParams	Optionale Parameter.
ConfigurationsGetNodeOptionalParams	Optionale Parameter.
ConfigurationsGetOptionalParams	Optionale Parameter.
ConfigurationsListByClusterNextOptionalParams	Optionale Parameter.
ConfigurationsListByClusterOptionalParams	Optionale Parameter.
ConfigurationsListByServerNextOptionalParams	Optionale Parameter.
ConfigurationsListByServerOptionalParams	Optionale Parameter.
ConfigurationsUpdateOnCoordinatorHeaders	Definiert Kopfzeilen für Configurations_updateOnCoordinator Vorgang.
ConfigurationsUpdateOnCoordinatorOptionalParams	Optionale Parameter.
ConfigurationsUpdateOnNodeHeaders	Definiert Kopfzeilen für Configurations_updateOnNode Vorgang.
ConfigurationsUpdateOnNodeOptionalParams	Optionale Parameter.
CosmosDBForPostgreSQLOptionalParams	Optionale Parameter.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Häufige Fehlerantwort für alle Azure Resource Manager-APIs, um Fehlerdetails für fehlgeschlagene Vorgänge zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.)
FirewallRule	Stellt eine Clusterfirewallregel dar.
FirewallRuleListResult	Eine Liste der Firewallregeln.
FirewallRules	Schnittstelle, die eine FirewallRules darstellt.
FirewallRulesCreateOrUpdateHeaders	Definiert Kopfzeilen für FirewallRules_createOrUpdate Vorgang.
FirewallRulesCreateOrUpdateOptionalParams	Optionale Parameter.
FirewallRulesDeleteHeaders	Definiert Kopfzeilen für FirewallRules_delete Vorgang.
FirewallRulesDeleteOptionalParams	Optionale Parameter.
FirewallRulesGetOptionalParams	Optionale Parameter.
FirewallRulesListByClusterOptionalParams	Optionale Parameter.
MaintenanceWindow	Planen Sie Einstellungen für regelmäßige Clusterupdates.
NameAvailability	Stellt die Verfügbarkeit des Clusternamens dar.
NameAvailabilityRequest	Fordern Sie vom Client die Verfügbarkeit des Clusternamens an.
Operation	REST-API-Vorgangsdefinition.
OperationDisplay	Zeigt Metadaten an, die dem Vorgang zugeordnet sind.
OperationListResult	Eine Liste der Ressourcenanbietervorgänge.
Operations	Schnittstelle, die eine Operation darstellt.
OperationsListOptionalParams	Optionale Parameter.
PrivateEndpoint	Die private Endpunktressource.
PrivateEndpointConnection	Die private Endpunktverbindungsressource.
PrivateEndpointConnectionListResult	Liste der privaten Endpunktverbindungen, die der angegebenen Ressource zugeordnet sind.
PrivateEndpointConnections	Schnittstelle, die eine PrivateEndpointConnections darstellt.
PrivateEndpointConnectionsCreateOrUpdateHeaders	Definiert Kopfzeilen für PrivateEndpointConnections_createOrUpdate Vorgang.
PrivateEndpointConnectionsCreateOrUpdateOptionalParams	Optionale Parameter.
PrivateEndpointConnectionsDeleteHeaders	Definiert Kopfzeilen für PrivateEndpointConnections_delete Vorgang.
PrivateEndpointConnectionsDeleteOptionalParams	Optionale Parameter.
PrivateEndpointConnectionsGetOptionalParams	Optionale Parameter.
PrivateEndpointConnectionsListByClusterOptionalParams	Optionale Parameter.
PrivateEndpointProperty	Eigenschaft, die die Ressourcen-ID des privaten Endpunkts darstellt.
PrivateLinkResource	Eine private Verknüpfungsressource.
PrivateLinkResourceListResult	Eine Liste der privaten Linkressourcen.
PrivateLinkResources	Schnittstelle, die eine PrivateLinkResources darstellt.
PrivateLinkResourcesGetOptionalParams	Optionale Parameter.
PrivateLinkResourcesListByClusterOptionalParams	Optionale Parameter.
PrivateLinkServiceConnectionState	Eine Sammlung von Informationen über den Status der Verbindung zwischen Service Consumer und Provider.
ProxyResource	Die Ressourcenmodelldefinition für eine Azure Resource Manager-Proxyressource. Es enthält keine Tags und einen Speicherort.
Resource	Allgemeine Felder, die in der Antwort für alle Azure Resource Manager-Ressourcen zurückgegeben werden
Role	Stellt eine Clusterrolle dar.
RoleListResult	Eine Liste der Rollen.
Roles	Schnittstelle, die eine Rolle darstellt.
RolesCreateHeaders	Definiert Kopfzeilen für Roles_create Vorgang.
RolesCreateOptionalParams	Optionale Parameter.
RolesDeleteHeaders	Definiert Kopfzeilen für Roles_delete Vorgang.
RolesDeleteOptionalParams	Optionale Parameter.
RolesGetOptionalParams	Optionale Parameter.
RolesListByClusterOptionalParams	Optionale Parameter.
ServerConfiguration	Stellt eine Konfiguration dar.
ServerConfigurationListResult	Eine Liste der Serverkonfigurationen.
ServerNameItem	Das Name-Objekt für einen Server.
ServerProperties	Die Eigenschaften eines Servers.
ServerRoleGroupConfiguration	Stellt den Konfigurationswert der Serverrollengruppe dar.
Servers	Schnittstelle, die einen Server darstellt.
ServersGetOptionalParams	Optionale Parameter.
ServersListByClusterOptionalParams	Optionale Parameter.
SimplePrivateEndpointConnection	Eine private Endpunktverbindung.
SystemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
TrackedResource	Die Ressourcenmodelldefinition für eine Azure Resource Manager-Ressource auf oberster Ebene mit "Tags" und einem "Speicherort"

Typaliase

ClustersCheckNameAvailabilityResponse	Enthält Antwortdaten für den CheckNameAvailability-Vorgang.
ClustersCreateResponse	Enthält Antwortdaten für den Erstellungsvorgang.
ClustersGetResponse	Enthält Antwortdaten für den Get-Vorgang.
ClustersListByResourceGroupNextResponse	Enthält Antwortdaten für den ListByResourceGroupNext-Vorgang.
ClustersListByResourceGroupResponse	Enthält Antwortdaten für den listByResourceGroup-Vorgang.
ClustersListNextResponse	Enthält Antwortdaten für den listNext-Vorgang.
ClustersListResponse	Enthält Antwortdaten für den Listenvorgang.
ClustersPromoteReadReplicaResponse	Enthält Antwortdaten für den promoteReadReplica-Vorgang.
ClustersRestartResponse	Enthält Antwortdaten für den Neustartvorgang.
ClustersUpdateResponse	Enthält Antwortdaten für den Aktualisierungsvorgang.
ConfigurationDataType	Definiert Werte für ConfigurationDataType. KnownConfigurationDataType austauschbar mit ConfigurationDataType verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden booleschen numerischen ganze Zahl Enumeration
ConfigurationsGetCoordinatorResponse	Enthält Antwortdaten für den getCoordinator-Vorgang.
ConfigurationsGetNodeResponse	Enthält Antwortdaten für den getNode-Vorgang.
ConfigurationsGetResponse	Enthält Antwortdaten für den Get-Vorgang.
ConfigurationsListByClusterNextResponse	Enthält Antwortdaten für den listByClusterNext-Vorgang.
ConfigurationsListByClusterResponse	Enthält Antwortdaten für den listByCluster-Vorgang.
ConfigurationsListByServerNextResponse	Enthält Antwortdaten für den listByServerNext-Vorgang.
ConfigurationsListByServerResponse	Enthält Antwortdaten für den listByServer-Vorgang.
ConfigurationsUpdateOnCoordinatorResponse	Enthält Antwortdaten für den UpdateOnCoordinator-Vorgang.
ConfigurationsUpdateOnNodeResponse	Enthält Antwortdaten für den UpdateOnNode-Vorgang.
CreatedByType	Definiert Werte für CreatedByType. KnownCreatedByType austauschbar mit CreatedByType verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden Application ManagedIdentity- Key-
FirewallRulesCreateOrUpdateResponse	Enthält Antwortdaten für den createOrUpdate-Vorgang.
FirewallRulesDeleteResponse	Enthält Antwortdaten für den Löschvorgang.
FirewallRulesGetResponse	Enthält Antwortdaten für den Get-Vorgang.
FirewallRulesListByClusterResponse	Enthält Antwortdaten für den listByCluster-Vorgang.
OperationOrigin	Definiert Werte für OperationOrigin. KnownOperationOrigin austauschbar mit OperationOrigin verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden notSpecified System-
OperationsListResponse	Enthält Antwortdaten für den Listenvorgang.
PrivateEndpointConnectionProvisioningState	Definiert Werte für PrivateEndpointConnectionProvisioningState. KnownPrivateEndpointConnectionProvisioningState- austauschbar mit PrivateEndpointConnectionProvisioningState verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden erfolgreich Erstellen von Löschen von Fehlgeschlagene
PrivateEndpointConnectionsCreateOrUpdateResponse	Enthält Antwortdaten für den createOrUpdate-Vorgang.
PrivateEndpointConnectionsDeleteResponse	Enthält Antwortdaten für den Löschvorgang.
PrivateEndpointConnectionsGetResponse	Enthält Antwortdaten für den Get-Vorgang.
PrivateEndpointConnectionsListByClusterResponse	Enthält Antwortdaten für den listByCluster-Vorgang.
PrivateEndpointServiceConnectionStatus	Definiert Werte für PrivateEndpointServiceConnectionStatus. KnownPrivateEndpointServiceConnectionStatus austauschbar mit PrivateEndpointServiceConnectionStatus verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden ausstehende genehmigte Abgelehnte
PrivateLinkResourcesGetResponse	Enthält Antwortdaten für den Get-Vorgang.
PrivateLinkResourcesListByClusterResponse	Enthält Antwortdaten für den listByCluster-Vorgang.
ProvisioningState	Definiert Werte für ProvisioningState. KnownProvisioningState austauschbar mit ProvisioningState verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden erfolgreich Abgebrochene InProgress- Fehlgeschlagene
RolesCreateResponse	Enthält Antwortdaten für den Erstellungsvorgang.
RolesDeleteResponse	Enthält Antwortdaten für den Löschvorgang.
RolesGetResponse	Enthält Antwortdaten für den Get-Vorgang.
RolesListByClusterResponse	Enthält Antwortdaten für den listByCluster-Vorgang.
ServerRole	Definiert Werte für ServerRole. KnownServerRole austauschbar mit ServerRole verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden Koordinator Worker-
ServersGetResponse	Enthält Antwortdaten für den Get-Vorgang.
ServersListByClusterResponse	Enthält Antwortdaten für den listByCluster-Vorgang.

Enumerationen

KnownConfigurationDataType	Bekannte Werte von ConfigurationDataType, die der Dienst akzeptiert.
KnownCreatedByType	Bekannte Werte von CreatedByType, die der Dienst akzeptiert.
KnownOperationOrigin	Bekannte Werte von OperationOrigin, die der Dienst akzeptiert.
KnownPrivateEndpointConnectionProvisioningState	Bekannte Werte von PrivateEndpointConnectionProvisioningState, die der Dienst akzeptiert.
KnownPrivateEndpointServiceConnectionStatus	Bekannte Werte von PrivateEndpointServiceConnectionStatus, die der Dienst akzeptiert.
KnownProvisioningState	Bekannte Werte von ProvisioningState, die der Dienst akzeptiert.
KnownServerRole	Bekannte Werte von ServerRole, die der Dienst akzeptiert.

Functions

getContinuationToken(unknown)

Gibt aufgrund der letzten .value, die vom byPage Iterator erstellt wurde, ein Fortsetzungstoken zurück, das verwendet werden kann, um mit dem Paging ab diesem Zeitpunkt zu beginnen.

Details zur Funktion

getContinuationToken(unknown)

Gibt aufgrund der letzten .value, die vom byPage Iterator erstellt wurde, ein Fortsetzungstoken zurück, das verwendet werden kann, um mit dem Paging ab diesem Zeitpunkt zu beginnen.

function getContinuationToken(page: unknown): string | undefined

Parameter

page

unknown

Ein Objekt vom Zugriff auf value im IteratorResult aus einem byPage Iterator.

Gibt zurück

string | undefined

Das Fortsetzungstoken, das während zukünftiger Aufrufe an byPage() übergeben werden kann.