@azure/arm-cosmosdbforpostgresql package

Klasser

CosmosDBForPostgreSQL

Gränssnitt

Cluster	Representerar ett kluster.
ClusterConfigurationListResult	En lista över klusterkonfigurationer.
ClusterForUpdate	Representerar ett kluster för uppdatering.
ClusterListResult	En lista över kluster.
ClusterServer	Representerar en server i ett kluster.
ClusterServerListResult	En lista över servrar i ett kluster.
ClusterServerProperties	Egenskaperna för en server i klustret.
Clusters	Gränssnitt som representerar ett kluster.
ClustersCheckNameAvailabilityOptionalParams	Valfria parametrar.
ClustersCreateHeaders	Definierar rubriker för Clusters_create åtgärd.
ClustersCreateOptionalParams	Valfria parametrar.
ClustersDeleteHeaders	Definierar rubriker för Clusters_delete åtgärd.
ClustersDeleteOptionalParams	Valfria parametrar.
ClustersGetOptionalParams	Valfria parametrar.
ClustersListByResourceGroupNextOptionalParams	Valfria parametrar.
ClustersListByResourceGroupOptionalParams	Valfria parametrar.
ClustersListNextOptionalParams	Valfria parametrar.
ClustersListOptionalParams	Valfria parametrar.
ClustersPromoteReadReplicaHeaders	Definierar rubriker för Clusters_promoteReadReplica åtgärd.
ClustersPromoteReadReplicaOptionalParams	Valfria parametrar.
ClustersRestartHeaders	Definierar rubriker för Clusters_restart åtgärd.
ClustersRestartOptionalParams	Valfria parametrar.
ClustersStartHeaders	Definierar rubriker för Clusters_start åtgärd.
ClustersStartOptionalParams	Valfria parametrar.
ClustersStopHeaders	Definierar rubriker för Clusters_stop åtgärd.
ClustersStopOptionalParams	Valfria parametrar.
ClustersUpdateHeaders	Definierar rubriker för Clusters_update åtgärd.
ClustersUpdateOptionalParams	Valfria parametrar.
Configuration	Representerar konfigurationsinformation för koordinator och nod.
Configurations	Gränssnitt som representerar en konfiguration.
ConfigurationsGetCoordinatorOptionalParams	Valfria parametrar.
ConfigurationsGetNodeOptionalParams	Valfria parametrar.
ConfigurationsGetOptionalParams	Valfria parametrar.
ConfigurationsListByClusterNextOptionalParams	Valfria parametrar.
ConfigurationsListByClusterOptionalParams	Valfria parametrar.
ConfigurationsListByServerNextOptionalParams	Valfria parametrar.
ConfigurationsListByServerOptionalParams	Valfria parametrar.
ConfigurationsUpdateOnCoordinatorHeaders	Definierar rubriker för Configurations_updateOnCoordinator åtgärd.
ConfigurationsUpdateOnCoordinatorOptionalParams	Valfria parametrar.
ConfigurationsUpdateOnNodeHeaders	Definierar rubriker för Configurations_updateOnNode åtgärd.
ConfigurationsUpdateOnNodeOptionalParams	Valfria parametrar.
CosmosDBForPostgreSQLOptionalParams	Valfria parametrar.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Vanligt felsvar för alla Azure Resource Manager-API:er för att returnera felinformation för misslyckade åtgärder. (Detta följer även formatet för OData-felsvar.).
FirewallRule	Representerar en brandväggsregel för kluster.
FirewallRuleListResult	En lista över brandväggsregler.
FirewallRules	Gränssnitt som representerar en FirewallRules.
FirewallRulesCreateOrUpdateHeaders	Definierar rubriker för FirewallRules_createOrUpdate åtgärd.
FirewallRulesCreateOrUpdateOptionalParams	Valfria parametrar.
FirewallRulesDeleteHeaders	Definierar rubriker för FirewallRules_delete åtgärd.
FirewallRulesDeleteOptionalParams	Valfria parametrar.
FirewallRulesGetOptionalParams	Valfria parametrar.
FirewallRulesListByClusterOptionalParams	Valfria parametrar.
MaintenanceWindow	Schemalägg inställningar för regelbundna klusteruppdateringar.
NameAvailability	Representerar tillgänglighet för klusternamn.
NameAvailabilityRequest	Begär från klienten för att kontrollera tillgängligheten för klusternamn.
Operation	REST API-åtgärdsdefinition.
OperationDisplay	Visa metadata som är associerade med åtgärden.
OperationListResult	En lista över resursprovideråtgärder.
Operations	Gränssnitt som representerar en operation.
OperationsListOptionalParams	Valfria parametrar.
PrivateEndpoint	Den privata slutpunktsresursen.
PrivateEndpointConnection	Den privata slutpunktsanslutningsresursen.
PrivateEndpointConnectionListResult	Lista över privata slutpunktsanslutningar som är associerade med den angivna resursen.
PrivateEndpointConnections	Gränssnitt som representerar en PrivateEndpointConnections.
PrivateEndpointConnectionsCreateOrUpdateHeaders	Definierar rubriker för PrivateEndpointConnections_createOrUpdate åtgärd.
PrivateEndpointConnectionsCreateOrUpdateOptionalParams	Valfria parametrar.
PrivateEndpointConnectionsDeleteHeaders	Definierar rubriker för PrivateEndpointConnections_delete åtgärd.
PrivateEndpointConnectionsDeleteOptionalParams	Valfria parametrar.
PrivateEndpointConnectionsGetOptionalParams	Valfria parametrar.
PrivateEndpointConnectionsListByClusterOptionalParams	Valfria parametrar.
PrivateEndpointProperty	Egenskap som representerar resurs-ID för den privata slutpunkten.
PrivateLinkResource	En privat länkresurs.
PrivateLinkResourceListResult	En lista över privata länkresurser.
PrivateLinkResources	Gränssnitt som representerar en PrivateLinkResources.
PrivateLinkResourcesGetOptionalParams	Valfria parametrar.
PrivateLinkResourcesListByClusterOptionalParams	Valfria parametrar.
PrivateLinkServiceConnectionState	En samling med information om tillståndet för anslutningen mellan tjänstkonsumenten och leverantören.
ProxyResource	Resursmodelldefinitionen för en Azure Resource Manager-proxyresurs. Det kommer inte att ha taggar och en plats
Resource	Vanliga fält som returneras i svaret för alla Azure Resource Manager-resurser
Role	Representerar en klusterroll.
RoleListResult	En lista över roller.
Roles	Gränssnitt som representerar en roll.
RolesCreateHeaders	Definierar rubriker för Roles_create åtgärd.
RolesCreateOptionalParams	Valfria parametrar.
RolesDeleteHeaders	Definierar rubriker för Roles_delete åtgärd.
RolesDeleteOptionalParams	Valfria parametrar.
RolesGetOptionalParams	Valfria parametrar.
RolesListByClusterOptionalParams	Valfria parametrar.
ServerConfiguration	Representerar en konfiguration.
ServerConfigurationListResult	En lista över serverkonfigurationer.
ServerNameItem	Namnobjektet för en server.
ServerProperties	Egenskaperna för en server.
ServerRoleGroupConfiguration	Representerar konfigurationsvärdet för serverrollgrupper.
Servers	Gränssnitt som representerar en server.
ServersGetOptionalParams	Valfria parametrar.
ServersListByClusterOptionalParams	Valfria parametrar.
SimplePrivateEndpointConnection	En privat slutpunktsanslutning.
SystemData	Metadata som rör skapande och senaste ändring av resursen.
TrackedResource	Resursmodelldefinitionen för en Azure Resource Manager-spårad resurs på den översta nivån som har "taggar" och en "plats"

Typalias

ClustersCheckNameAvailabilityResponse	Innehåller svarsdata för åtgärden checkNameAvailability.
ClustersCreateResponse	Innehåller svarsdata för skapandeåtgärden.
ClustersGetResponse	Innehåller svarsdata för get-åtgärden.
ClustersListByResourceGroupNextResponse	Innehåller svarsdata för åtgärden listByResourceGroupNext.
ClustersListByResourceGroupResponse	Innehåller svarsdata för åtgärden listByResourceGroup.
ClustersListNextResponse	Innehåller svarsdata för listNästa åtgärden.
ClustersListResponse	Innehåller svarsdata för liståtgärden.
ClustersPromoteReadReplicaResponse	Innehåller svarsdata för åtgärden promoteReadReplica.
ClustersRestartResponse	Innehåller svarsdata för omstartsåtgärden.
ClustersUpdateResponse	Innehåller svarsdata för uppdateringsåtgärden.
ConfigurationDataType	Definierar värden för ConfigurationDataType. KnownConfigurationDataType kan användas utbytbart med ConfigurationDataType innehåller den här uppräkningen de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten boolesk numeriska Heltal uppräkning
ConfigurationsGetCoordinatorResponse	Innehåller svarsdata för åtgärden getCoordinator.
ConfigurationsGetNodeResponse	Innehåller svarsdata för getNode-åtgärden.
ConfigurationsGetResponse	Innehåller svarsdata för get-åtgärden.
ConfigurationsListByClusterNextResponse	Innehåller svarsdata för åtgärden listByClusterNext.
ConfigurationsListByClusterResponse	Innehåller svarsdata för listByCluster-åtgärden.
ConfigurationsListByServerNextResponse	Innehåller svarsdata för åtgärden listByServerNext.
ConfigurationsListByServerResponse	Innehåller svarsdata för listByServer-åtgärden.
ConfigurationsUpdateOnCoordinatorResponse	Innehåller svarsdata för åtgärden updateOnCoordinator.
ConfigurationsUpdateOnNodeResponse	Innehåller svarsdata för åtgärden updateOnNode.
CreatedByType	Definierar värden för CreatedByType. KnownCreatedByType- kan användas utbytbart med CreateByType innehåller det här uppräkningen de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten användare Program ManagedIdentity nyckel
FirewallRulesCreateOrUpdateResponse	Innehåller svarsdata för åtgärden createOrUpdate.
FirewallRulesDeleteResponse	Innehåller svarsdata för borttagningsåtgärden.
FirewallRulesGetResponse	Innehåller svarsdata för get-åtgärden.
FirewallRulesListByClusterResponse	Innehåller svarsdata för listByCluster-åtgärden.
OperationOrigin	Definierar värden för OperationOrigin. KnownOperationOrigin kan användas utbytbart med OperationOrigin innehåller det här uppräkningen de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten NotSpecified användare system
OperationsListResponse	Innehåller svarsdata för liståtgärden.
PrivateEndpointConnectionProvisioningState	Definierar värden för PrivateEndpointConnectionProvisioningState. KnownPrivateEndpointConnectionProvisioningState kan användas utbytbart med PrivateEndpointConnectionProvisioningState innehåller det här uppräkningen de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten lyckades Skapa ta bort misslyckades
PrivateEndpointConnectionsCreateOrUpdateResponse	Innehåller svarsdata för åtgärden createOrUpdate.
PrivateEndpointConnectionsDeleteResponse	Innehåller svarsdata för borttagningsåtgärden.
PrivateEndpointConnectionsGetResponse	Innehåller svarsdata för get-åtgärden.
PrivateEndpointConnectionsListByClusterResponse	Innehåller svarsdata för listByCluster-åtgärden.
PrivateEndpointServiceConnectionStatus	Definierar värden för PrivateEndpointServiceConnectionStatus. KnownPrivateEndpointServiceConnectionStatus kan användas utbytbart med PrivateEndpointServiceConnectionStatus innehåller det här uppräkningen de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten väntar på Godkänd avvisade
PrivateLinkResourcesGetResponse	Innehåller svarsdata för get-åtgärden.
PrivateLinkResourcesListByClusterResponse	Innehåller svarsdata för listByCluster-åtgärden.
ProvisioningState	Definierar värden för ProvisioningState. KnownProvisioningState kan användas omväxlande med ProvisioningState innehåller den här uppräkningen de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten lyckades avbröts InProgress misslyckades
RolesCreateResponse	Innehåller svarsdata för skapandeåtgärden.
RolesDeleteResponse	Innehåller svarsdata för borttagningsåtgärden.
RolesGetResponse	Innehåller svarsdata för get-åtgärden.
RolesListByClusterResponse	Innehåller svarsdata för listByCluster-åtgärden.
ServerRole	Definierar värden för ServerRole. KnownServerRole- kan användas omväxlande med ServerRole innehåller den här uppräkningen de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten koordinator Worker
ServersGetResponse	Innehåller svarsdata för get-åtgärden.
ServersListByClusterResponse	Innehåller svarsdata för listByCluster-åtgärden.

Uppräkningar

KnownConfigurationDataType	Kända värden för ConfigurationDataType som tjänsten accepterar.
KnownCreatedByType	Kända värden för CreatedByType- som tjänsten accepterar.
KnownOperationOrigin	Kända värden för OperationOrigin som tjänsten accepterar.
KnownPrivateEndpointConnectionProvisioningState	Kända värden för PrivateEndpointConnectionProvisioningState som tjänsten accepterar.
KnownPrivateEndpointServiceConnectionStatus	Kända värden för PrivateEndpointServiceConnectionStatus som tjänsten accepterar.
KnownProvisioningState	Kända värden för ProvisioningState som tjänsten accepterar.
KnownServerRole	Kända värden för ServerRole- som tjänsten accepterar.

Funktioner

getContinuationToken(unknown)

Med tanke på den senaste .value som skapades av iteratorn byPage returnerar en fortsättningstoken som kan användas för att börja söka från den punkten senare.

Funktionsinformation

getContinuationToken(unknown)

Med tanke på den senaste .value som skapades av iteratorn byPage returnerar en fortsättningstoken som kan användas för att börja söka från den punkten senare.

function getContinuationToken(page: unknown): string | undefined

Parametrar

page

unknown

Ett objekt från att komma åt value på IteratorResult från en byPage iterator.

Returer

string | undefined

Fortsättningstoken som kan skickas till byPage() under framtida anrop.