Sdílet prostřednictvím


@azure/arm-cosmosdbforpostgresql package

Třídy

CosmosDBForPostgreSQL

Rozhraní

Cluster

Představuje cluster.

ClusterConfigurationListResult

Seznam konfigurací clusteru

ClusterForUpdate

Představuje cluster pro aktualizaci.

ClusterListResult

Seznam clusterů

ClusterServer

Představuje server v clusteru.

ClusterServerListResult

Seznam serverů v clusteru

ClusterServerProperties

Vlastnosti serveru v clusteru

Clusters

Rozhraní představující clustery

ClustersCheckNameAvailabilityOptionalParams

Volitelné parametry.

ClustersCreateHeaders

Definuje hlavičky pro operaci Clusters_create.

ClustersCreateOptionalParams

Volitelné parametry.

ClustersDeleteHeaders

Definuje hlavičky pro operaci Clusters_delete.

ClustersDeleteOptionalParams

Volitelné parametry.

ClustersGetOptionalParams

Volitelné parametry.

ClustersListByResourceGroupNextOptionalParams

Volitelné parametry.

ClustersListByResourceGroupOptionalParams

Volitelné parametry.

ClustersListNextOptionalParams

Volitelné parametry.

ClustersListOptionalParams

Volitelné parametry.

ClustersPromoteReadReplicaHeaders

Definuje hlavičky pro operaci Clusters_promoteReadReplica.

ClustersPromoteReadReplicaOptionalParams

Volitelné parametry.

ClustersRestartHeaders

Definuje hlavičky pro operaci Clusters_restart.

ClustersRestartOptionalParams

Volitelné parametry.

ClustersStartHeaders

Definuje hlavičky pro operaci Clusters_start.

ClustersStartOptionalParams

Volitelné parametry.

ClustersStopHeaders

Definuje hlavičky pro operaci Clusters_stop.

ClustersStopOptionalParams

Volitelné parametry.

ClustersUpdateHeaders

Definuje hlavičky pro operaci Clusters_update.

ClustersUpdateOptionalParams

Volitelné parametry.

Configuration

Představuje podrobnosti konfigurace pro koordinátora a uzel.

Configurations

Rozhraní představující konfiguraci

ConfigurationsGetCoordinatorOptionalParams

Volitelné parametry.

ConfigurationsGetNodeOptionalParams

Volitelné parametry.

ConfigurationsGetOptionalParams

Volitelné parametry.

ConfigurationsListByClusterNextOptionalParams

Volitelné parametry.

ConfigurationsListByClusterOptionalParams

Volitelné parametry.

ConfigurationsListByServerNextOptionalParams

Volitelné parametry.

ConfigurationsListByServerOptionalParams

Volitelné parametry.

ConfigurationsUpdateOnCoordinatorHeaders

Definuje hlavičky pro operaci Configurations_updateOnCoordinator.

ConfigurationsUpdateOnCoordinatorOptionalParams

Volitelné parametry.

ConfigurationsUpdateOnNodeHeaders

Definuje hlavičky pro operaci Configurations_updateOnNode.

ConfigurationsUpdateOnNodeOptionalParams

Volitelné parametry.

CosmosDBForPostgreSQLOptionalParams

Volitelné parametry.

ErrorAdditionalInfo

Další informace o chybě správy prostředků

ErrorDetail

Podrobnosti o chybě.

ErrorResponse

Běžná chybová odpověď pro všechna rozhraní API Azure Resource Manageru pro vrácení podrobností o chybě pro neúspěšné operace (To se také řídí formátem odpovědi na chybu OData.)

FirewallRule

Představuje pravidlo brány firewall clusteru.

FirewallRuleListResult

Seznam pravidel brány firewall

FirewallRules

Rozhraní představující pravidlo brány firewall

FirewallRulesCreateOrUpdateHeaders

Definuje hlavičky pro operaci FirewallRules_createOrUpdate.

FirewallRulesCreateOrUpdateOptionalParams

Volitelné parametry.

FirewallRulesDeleteHeaders

Definuje hlavičky pro operaci FirewallRules_delete.

FirewallRulesDeleteOptionalParams

Volitelné parametry.

FirewallRulesGetOptionalParams

Volitelné parametry.

FirewallRulesListByClusterOptionalParams

Volitelné parametry.

MaintenanceWindow

Naplánujte nastavení pro pravidelné aktualizace clusteru.

NameAvailability

Představuje dostupnost názvu clusteru.

NameAvailabilityRequest

Požádejte klienta o kontrolu dostupnosti názvu clusteru.

Operation

Definice operace rozhraní REST API

OperationDisplay

Zobrazí metadata přidružená k operaci.

OperationListResult

Seznam operací poskytovatele prostředků

Operations

Rozhraní představující operace

OperationsListOptionalParams

Volitelné parametry.

PrivateEndpoint

Prostředek privátního koncového bodu.

PrivateEndpointConnection

Prostředek připojení privátního koncového bodu.

PrivateEndpointConnectionListResult

Seznam připojení privátních koncových bodů přidružených k zadanému prostředku

PrivateEndpointConnections

Rozhraní představující PrivateEndpointConnections

PrivateEndpointConnectionsCreateOrUpdateHeaders

Definuje hlavičky pro operaci PrivateEndpointConnections_createOrUpdate.

PrivateEndpointConnectionsCreateOrUpdateOptionalParams

Volitelné parametry.

PrivateEndpointConnectionsDeleteHeaders

Definuje hlavičky pro operaci PrivateEndpointConnections_delete.

PrivateEndpointConnectionsDeleteOptionalParams

Volitelné parametry.

PrivateEndpointConnectionsGetOptionalParams

Volitelné parametry.

PrivateEndpointConnectionsListByClusterOptionalParams

Volitelné parametry.

PrivateEndpointProperty

Vlastnost představující ID prostředku privátního koncového bodu

PrivateLinkResource

Prostředek privátního propojení.

PrivateLinkResourceListResult

Seznam prostředků privátního propojení

PrivateLinkResources

Rozhraní představující PrivateLinkResources

PrivateLinkResourcesGetOptionalParams

Volitelné parametry.

PrivateLinkResourcesListByClusterOptionalParams

Volitelné parametry.

PrivateLinkServiceConnectionState

Kolekce informací o stavu připojení mezi příjemcem služeb a poskytovatelem.

ProxyResource

Definice modelu prostředků pro prostředek proxy serveru Azure Resource Manageru. Nebude obsahovat značky a umístění.

Resource

Běžná pole vrácená v odpovědi pro všechny prostředky Azure Resource Manageru

Role

Představuje roli clusteru.

RoleListResult

Seznam rolí.

Roles

Rozhraní představující role

RolesCreateHeaders

Definuje hlavičky pro operaci Roles_create.

RolesCreateOptionalParams

Volitelné parametry.

RolesDeleteHeaders

Definuje hlavičky pro operaci Roles_delete.

RolesDeleteOptionalParams

Volitelné parametry.

RolesGetOptionalParams

Volitelné parametry.

RolesListByClusterOptionalParams

Volitelné parametry.

ServerConfiguration

Představuje konfiguraci.

ServerConfigurationListResult

Seznam konfigurací serveru.

ServerNameItem

Objekt name pro server.

ServerProperties

Vlastnosti serveru.

ServerRoleGroupConfiguration

Představuje hodnotu konfigurace skupiny rolí serveru.

Servers

Rozhraní představující servery

ServersGetOptionalParams

Volitelné parametry.

ServersListByClusterOptionalParams

Volitelné parametry.

SimplePrivateEndpointConnection

Připojení privátního koncového bodu.

SystemData

Metadata týkající se vytvoření a poslední změny prostředku.

TrackedResource

Definice modelu prostředků pro Prostředek Azure Resource Manageru sledovala prostředek nejvyšší úrovně, který má značky a umístění.

Aliasy typu

ClustersCheckNameAvailabilityResponse

Obsahuje data odpovědí pro operaci checkNameAvailability.

ClustersCreateResponse

Obsahuje data odpovědí pro operaci vytvoření.

ClustersGetResponse

Obsahuje data odpovědí pro operaci get.

ClustersListByResourceGroupNextResponse

Obsahuje data odpovědi pro operaci listByResourceGroupNext.

ClustersListByResourceGroupResponse

Obsahuje data odpovědi pro operaci listByResourceGroup.

ClustersListNextResponse

Obsahuje data odpovědi pro operaci listNext.

ClustersListResponse

Obsahuje data odpovědí pro operaci seznamu.

ClustersPromoteReadReplicaResponse

Obsahuje data odpovědí pro operaci promoteReadReplica.

ClustersRestartResponse

Obsahuje data odpovědí pro operaci restartování.

ClustersUpdateResponse

Obsahuje data odpovědí pro operaci aktualizace.

ConfigurationDataType

Definuje hodnoty pro ConfigurationDataType.
PoleConfigurationDataType lze použít zaměnitelně s ConfigurationDataType, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

logických
číselných
celočíselná
výčtu

ConfigurationsGetCoordinatorResponse

Obsahuje data odpovědí pro operaci getCoordinator.

ConfigurationsGetNodeResponse

Obsahuje data odpovědi pro operaci getNode.

ConfigurationsGetResponse

Obsahuje data odpovědí pro operaci get.

ConfigurationsListByClusterNextResponse

Obsahuje data odpovědi pro operaci listByClusterNext.

ConfigurationsListByClusterResponse

Obsahuje data odpovědi pro operaci listByCluster.

ConfigurationsListByServerNextResponse

Obsahuje data odpovědi pro operaci listByServerNext.

ConfigurationsListByServerResponse

Obsahuje data odpovědi pro operaci listByServer.

ConfigurationsUpdateOnCoordinatorResponse

Obsahuje data odpovědi pro operaci updateOnCoordinator.

ConfigurationsUpdateOnNodeResponse

Obsahuje data odpovědi pro operaci updateOnNode.

CreatedByType

Definuje hodnoty pro CreatedByType.
PoleCreatedByType lze použít zaměnitelně s CreatedByType, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

uživatele
aplikace
ManagedIdentity
klíč

FirewallRulesCreateOrUpdateResponse

Obsahuje data odpovědí pro operaci createOrUpdate.

FirewallRulesDeleteResponse

Obsahuje data odpovědí pro operaci odstranění.

FirewallRulesGetResponse

Obsahuje data odpovědí pro operaci get.

FirewallRulesListByClusterResponse

Obsahuje data odpovědi pro operaci listByCluster.

OperationOrigin

Definuje hodnoty pro OperationOrigin.
PoleOperationOrigin lze použít zaměnitelně s OperationOrigin, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

nezadaná
uživatele
systémová

OperationsListResponse

Obsahuje data odpovědí pro operaci seznamu.

PrivateEndpointConnectionProvisioningState

Definuje hodnoty pro PrivateEndpointConnectionProvisioningState.
PolePrivateEndpointConnectionProvisioningState lze použít zaměnitelně s PrivateEndpointConnectionProvisioningState, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

úspěšné
vytváření
odstranění
selhalo

PrivateEndpointConnectionsCreateOrUpdateResponse

Obsahuje data odpovědí pro operaci createOrUpdate.

PrivateEndpointConnectionsDeleteResponse

Obsahuje data odpovědí pro operaci odstranění.

PrivateEndpointConnectionsGetResponse

Obsahuje data odpovědí pro operaci get.

PrivateEndpointConnectionsListByClusterResponse

Obsahuje data odpovědi pro operaci listByCluster.

PrivateEndpointServiceConnectionStatus

Definuje hodnoty pro PrivateEndpointServiceConnectionStatus.
KnownPrivateEndpointServiceConnectionStatus lze použít zaměnitelně s PrivateEndpointServiceConnectionStatus, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

čekající
schválené
odmítnuté

PrivateLinkResourcesGetResponse

Obsahuje data odpovědí pro operaci get.

PrivateLinkResourcesListByClusterResponse

Obsahuje data odpovědi pro operaci listByCluster.

ProvisioningState

Definuje hodnoty pro ProvisioningState.
KnownProvisioningState lze použít zaměnitelně s ProvisioningState, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

úspěšné
Zrušené
InProgress
selhalo

RolesCreateResponse

Obsahuje data odpovědí pro operaci vytvoření.

RolesDeleteResponse

Obsahuje data odpovědí pro operaci odstranění.

RolesGetResponse

Obsahuje data odpovědí pro operaci get.

RolesListByClusterResponse

Obsahuje data odpovědi pro operaci listByCluster.

ServerRole

Definuje hodnoty pro ServerRole.
PoleServerRole lze použít zaměnitelně s ServerRole, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

koordinátoru
pracovního

ServersGetResponse

Obsahuje data odpovědí pro operaci get.

ServersListByClusterResponse

Obsahuje data odpovědi pro operaci listByCluster.

Výčty

KnownConfigurationDataType

Známé hodnoty ConfigurationDataType, které služba přijímá.

KnownCreatedByType

Známé hodnoty CreatedByType, které služba přijímá.

KnownOperationOrigin

Známé hodnoty OperationOrigin, které služba přijímá.

KnownPrivateEndpointConnectionProvisioningState

Známé hodnoty PrivateEndpointConnectionProvisioningState, které služba přijímá.

KnownPrivateEndpointServiceConnectionStatus

Známé hodnoty PrivateEndpointServiceConnectionStatus, které služba přijímá.

KnownProvisioningState

Známé hodnoty ProvisioningState, které služba přijímá.

KnownServerRole

Známé hodnoty ServerRole, které služba přijímá.

Funkce

getContinuationToken(unknown)

Vzhledem k poslednímu .value vytvořenému iterátorem byPage vrátí token pokračování, který lze použít k pozdějšímu zahájení stránkování.

Podrobnosti funkce

getContinuationToken(unknown)

Vzhledem k poslednímu .value vytvořenému iterátorem byPage vrátí token pokračování, který lze použít k pozdějšímu zahájení stránkování.

function getContinuationToken(page: unknown): string | undefined

Parametry

page

unknown

Objekt z přístupu k value na IteratorResult z byPage iterátoru.

Návraty

string | undefined

Token pokračování, který lze předat do byPage() během budoucích volání.