Delen via


@azure/arm-cosmosdbforpostgresql package

Klassen

CosmosDBForPostgreSQL

Interfaces

Cluster

Vertegenwoordigt een cluster.

ClusterConfigurationListResult

Een lijst met clusterconfiguraties.

ClusterForUpdate

Vertegenwoordigt een cluster voor update.

ClusterListResult

Een lijst met clusters.

ClusterServer

Vertegenwoordigt een server in een cluster.

ClusterServerListResult

Een lijst met servers in een cluster.

ClusterServerProperties

De eigenschappen van een server in het cluster.

Clusters

Interface die een cluster vertegenwoordigt.

ClustersCheckNameAvailabilityOptionalParams

Optionele parameters.

ClustersCreateHeaders

Hiermee definieert u headers voor Clusters_create bewerking.

ClustersCreateOptionalParams

Optionele parameters.

ClustersDeleteHeaders

Hiermee definieert u headers voor Clusters_delete bewerking.

ClustersDeleteOptionalParams

Optionele parameters.

ClustersGetOptionalParams

Optionele parameters.

ClustersListByResourceGroupNextOptionalParams

Optionele parameters.

ClustersListByResourceGroupOptionalParams

Optionele parameters.

ClustersListNextOptionalParams

Optionele parameters.

ClustersListOptionalParams

Optionele parameters.

ClustersPromoteReadReplicaHeaders

Hiermee definieert u headers voor Clusters_promoteReadReplica bewerking.

ClustersPromoteReadReplicaOptionalParams

Optionele parameters.

ClustersRestartHeaders

Hiermee definieert u headers voor Clusters_restart bewerking.

ClustersRestartOptionalParams

Optionele parameters.

ClustersStartHeaders

Hiermee definieert u headers voor Clusters_start bewerking.

ClustersStartOptionalParams

Optionele parameters.

ClustersStopHeaders

Hiermee definieert u headers voor Clusters_stop bewerking.

ClustersStopOptionalParams

Optionele parameters.

ClustersUpdateHeaders

Hiermee definieert u headers voor Clusters_update bewerking.

ClustersUpdateOptionalParams

Optionele parameters.

Configuration

Vertegenwoordigt configuratiedetails voor coördinator en knooppunt.

Configurations

Interface die een configuratie vertegenwoordigt.

ConfigurationsGetCoordinatorOptionalParams

Optionele parameters.

ConfigurationsGetNodeOptionalParams

Optionele parameters.

ConfigurationsGetOptionalParams

Optionele parameters.

ConfigurationsListByClusterNextOptionalParams

Optionele parameters.

ConfigurationsListByClusterOptionalParams

Optionele parameters.

ConfigurationsListByServerNextOptionalParams

Optionele parameters.

ConfigurationsListByServerOptionalParams

Optionele parameters.

ConfigurationsUpdateOnCoordinatorHeaders

Hiermee definieert u headers voor Configurations_updateOnCoordinator bewerking.

ConfigurationsUpdateOnCoordinatorOptionalParams

Optionele parameters.

ConfigurationsUpdateOnNodeHeaders

Hiermee definieert u headers voor Configurations_updateOnNode bewerking.

ConfigurationsUpdateOnNodeOptionalParams

Optionele parameters.

CosmosDBForPostgreSQLOptionalParams

Optionele parameters.

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

ErrorDetail

De foutdetails.

ErrorResponse

Algemene foutreactie voor alle Azure Resource Manager-API's om foutdetails voor mislukte bewerkingen te retourneren. (Dit volgt ook de indeling van de OData-foutreactie.)

FirewallRule

Vertegenwoordigt een clusterfirewallregel.

FirewallRuleListResult

Een lijst met firewallregels.

FirewallRules

Interface die een FirewallRules vertegenwoordigt.

FirewallRulesCreateOrUpdateHeaders

Hiermee definieert u headers voor FirewallRules_createOrUpdate bewerking.

FirewallRulesCreateOrUpdateOptionalParams

Optionele parameters.

FirewallRulesDeleteHeaders

Hiermee definieert u headers voor FirewallRules_delete bewerking.

FirewallRulesDeleteOptionalParams

Optionele parameters.

FirewallRulesGetOptionalParams

Optionele parameters.

FirewallRulesListByClusterOptionalParams

Optionele parameters.

MaintenanceWindow

Planningsinstellingen voor reguliere clusterupdates.

NameAvailability

Vertegenwoordigt de beschikbaarheid van clusternamen.

NameAvailabilityRequest

Aanvraag van client om de beschikbaarheid van de clusternaam te controleren.

Operation

Definitie van REST API-bewerking.

OperationDisplay

Metagegevens weergeven die zijn gekoppeld aan de bewerking.

OperationListResult

Een lijst met bewerkingen van resourceproviders.

Operations

Interface die een bewerking vertegenwoordigt.

OperationsListOptionalParams

Optionele parameters.

PrivateEndpoint

De resource van het privé-eindpunt.

PrivateEndpointConnection

De verbindingsresource voor het privé-eindpunt.

PrivateEndpointConnectionListResult

Lijst met privé-eindpuntverbindingen die zijn gekoppeld aan de opgegeven resource.

PrivateEndpointConnections

Interface die een PrivateEndpointConnections vertegenwoordigt.

PrivateEndpointConnectionsCreateOrUpdateHeaders

Hiermee definieert u headers voor PrivateEndpointConnections_createOrUpdate bewerking.

PrivateEndpointConnectionsCreateOrUpdateOptionalParams

Optionele parameters.

PrivateEndpointConnectionsDeleteHeaders

Hiermee definieert u headers voor PrivateEndpointConnections_delete bewerking.

PrivateEndpointConnectionsDeleteOptionalParams

Optionele parameters.

PrivateEndpointConnectionsGetOptionalParams

Optionele parameters.

PrivateEndpointConnectionsListByClusterOptionalParams

Optionele parameters.

PrivateEndpointProperty

Eigenschap voor resource-id van het privé-eindpunt.

PrivateLinkResource

Een Private Link-resource.

PrivateLinkResourceListResult

Een lijst met privékoppelingsresources.

PrivateLinkResources

Interface die een PrivateLinkResources vertegenwoordigt.

PrivateLinkResourcesGetOptionalParams

Optionele parameters.

PrivateLinkResourcesListByClusterOptionalParams

Optionele parameters.

PrivateLinkServiceConnectionState

Een verzameling informatie over de status van de verbinding tussen de servicegebruiker en de provider.

ProxyResource

De definitie van het resourcemodel voor een Azure Resource Manager proxyresource. Het heeft geen tags en een locatie

Resource

Algemene velden die worden geretourneerd in het antwoord voor alle Azure Resource Manager-resources

Role

Vertegenwoordigt een clusterrol.

RoleListResult

Een lijst met rollen.

Roles

Interface die een rollen vertegenwoordigt.

RolesCreateHeaders

Hiermee definieert u headers voor Roles_create bewerking.

RolesCreateOptionalParams

Optionele parameters.

RolesDeleteHeaders

Hiermee definieert u headers voor Roles_delete bewerking.

RolesDeleteOptionalParams

Optionele parameters.

RolesGetOptionalParams

Optionele parameters.

RolesListByClusterOptionalParams

Optionele parameters.

ServerConfiguration

Vertegenwoordigt een configuratie.

ServerConfigurationListResult

Een lijst met serverconfiguraties.

ServerNameItem

Het naamobject voor een server.

ServerProperties

De eigenschappen van een server.

ServerRoleGroupConfiguration

Vertegenwoordigt de configuratiewaarde van de serverrolgroep.

Servers

Interface die een server vertegenwoordigt.

ServersGetOptionalParams

Optionele parameters.

ServersListByClusterOptionalParams

Optionele parameters.

SimplePrivateEndpointConnection

Een privé-eindpuntverbinding.

SystemData

Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.

TrackedResource

De definitie van het resourcemodel voor een Azure Resource Manager bijgehouden resource op het hoogste niveau die 'tags' en een 'locatie' heeft

Type-aliassen

ClustersCheckNameAvailabilityResponse

Bevat antwoordgegevens voor de bewerking checkNameAvailability.

ClustersCreateResponse

Bevat antwoordgegevens voor de maakbewerking.

ClustersGetResponse

Bevat antwoordgegevens voor de get-bewerking.

ClustersListByResourceGroupNextResponse

Bevat antwoordgegevens voor de bewerking listByResourceGroupNext.

ClustersListByResourceGroupResponse

Bevat antwoordgegevens voor de bewerking listByResourceGroup.

ClustersListNextResponse

Bevat antwoordgegevens voor de bewerking listNext.

ClustersListResponse

Bevat antwoordgegevens voor de lijstbewerking.

ClustersPromoteReadReplicaResponse

Bevat antwoordgegevens voor de bewerking promoteReadReplica.

ClustersRestartResponse

Bevat antwoordgegevens voor de herstartbewerking.

ClustersUpdateResponse

Bevat antwoordgegevens voor de updatebewerking.

ConfigurationDataType

Definieert waarden voor ConfigurationDataType.
KnownConfigurationDataType kan door elkaar worden gebruikt met ConfigurationDataType. Deze opsomming bevat de bekende waarden die de service ondersteunt.

Bekende waarden die door de service worden ondersteund

Booleaanse
Numeriek
Geheel getal
Inventarisatie

ConfigurationsGetCoordinatorResponse

Bevat antwoordgegevens voor de bewerking getCoordinator.

ConfigurationsGetNodeResponse

Bevat antwoordgegevens voor de getNode-bewerking.

ConfigurationsGetResponse

Bevat antwoordgegevens voor de get-bewerking.

ConfigurationsListByClusterNextResponse

Bevat antwoordgegevens voor de bewerking listByClusterNext.

ConfigurationsListByClusterResponse

Bevat antwoordgegevens voor de bewerking listByCluster.

ConfigurationsListByServerNextResponse

Bevat antwoordgegevens voor de bewerking listByServerNext.

ConfigurationsListByServerResponse

Bevat antwoordgegevens voor de listByServer-bewerking.

ConfigurationsUpdateOnCoordinatorResponse

Bevat antwoordgegevens voor de bewerking updateOnCoordinator.

ConfigurationsUpdateOnNodeResponse

Bevat antwoordgegevens voor de bewerking updateOnNode.

CreatedByType

Definieert waarden voor CreatedByType.
KnownCreatedByType kan door elkaar worden gebruikt met CreatedByType. Deze opsomming bevat de bekende waarden die door de service worden ondersteund.

Bekende waarden die door de service worden ondersteund

Gebruiker
Toepassing
ManagedIdentity
Sleutel

FirewallRulesCreateOrUpdateResponse

Bevat antwoordgegevens voor de bewerking createOrUpdate.

FirewallRulesDeleteResponse

Bevat antwoordgegevens voor de verwijderbewerking.

FirewallRulesGetResponse

Bevat antwoordgegevens voor de get-bewerking.

FirewallRulesListByClusterResponse

Bevat antwoordgegevens voor de bewerking listByCluster.

OperationOrigin

Definieert waarden voor OperationOrigin.
KnownOperationOrigin kan door elkaar worden gebruikt met OperationOrigin. Deze opsomming bevat de bekende waarden die door de service worden ondersteund.

Bekende waarden die door de service worden ondersteund

Niet opgegeven
gebruiker
systeem

OperationsListResponse

Bevat antwoordgegevens voor de lijstbewerking.

PrivateEndpointConnectionProvisioningState

Definieert waarden voor PrivateEndpointConnectionProvisioningState.
KnownPrivateEndpointConnectionProvisioningState kan door elkaar worden gebruikt met PrivateEndpointConnectionProvisioningState. Deze opsomming bevat de bekende waarden die de service ondersteunt.

Bekende waarden die door de service worden ondersteund

Geslaagd
Maken
Verwijderen
Mislukt

PrivateEndpointConnectionsCreateOrUpdateResponse

Bevat antwoordgegevens voor de bewerking createOrUpdate.

PrivateEndpointConnectionsDeleteResponse

Bevat antwoordgegevens voor de verwijderbewerking.

PrivateEndpointConnectionsGetResponse

Bevat antwoordgegevens voor de get-bewerking.

PrivateEndpointConnectionsListByClusterResponse

Bevat antwoordgegevens voor de bewerking listByCluster.

PrivateEndpointServiceConnectionStatus

Definieert waarden voor PrivateEndpointServiceConnectionStatus.
KnownPrivateEndpointServiceConnectionStatus kan door elkaar worden gebruikt met PrivateEndpointServiceConnectionStatus. Deze opsomming bevat de bekende waarden die door de service worden ondersteund.

Bekende waarden die door de service worden ondersteund

In behandeling
Goedgekeurd
Afgewezen

PrivateLinkResourcesGetResponse

Bevat antwoordgegevens voor de get-bewerking.

PrivateLinkResourcesListByClusterResponse

Bevat antwoordgegevens voor de bewerking listByCluster.

ProvisioningState

Definieert waarden voor ProvisioningState.
KnownProvisioningState kan door elkaar worden gebruikt met ProvisioningState. Deze opsomming bevat de bekende waarden die de service ondersteunt.

Bekende waarden die door de service worden ondersteund

Geslaagd
Geannuleerd
Wordt uitgevoerd
Mislukt

RolesCreateResponse

Bevat antwoordgegevens voor de maakbewerking.

RolesDeleteResponse

Bevat antwoordgegevens voor de verwijderbewerking.

RolesGetResponse

Bevat antwoordgegevens voor de get-bewerking.

RolesListByClusterResponse

Bevat antwoordgegevens voor de bewerking listByCluster.

ServerRole

Definieert waarden voor ServerRole.
KnownServerRole kan door elkaar worden gebruikt met ServerRole. Deze opsomming bevat de bekende waarden die door de service worden ondersteund.

Bekende waarden die door de service worden ondersteund

Coördinator
Werknemer

ServersGetResponse

Bevat antwoordgegevens voor de get-bewerking.

ServersListByClusterResponse

Bevat antwoordgegevens voor de bewerking listByCluster.

Enums

KnownConfigurationDataType

Bekende waarden van ConfigurationDataType die de service accepteert.

KnownCreatedByType

Bekende waarden van CreatedByType die de service accepteert.

KnownOperationOrigin

Bekende waarden van OperationOrigin die de service accepteert.

KnownPrivateEndpointConnectionProvisioningState

Bekende waarden van PrivateEndpointConnectionProvisioningState die de service accepteert.

KnownPrivateEndpointServiceConnectionStatus

Bekende waarden van PrivateEndpointServiceConnectionStatus die de service accepteert.

KnownProvisioningState

Bekende waarden van ProvisioningState die de service accepteert.

KnownServerRole

Bekende waarden van ServerRole die de service accepteert.

Functies

getContinuationToken(unknown)

Gezien de laatste .value die door de byPage iterator is geproduceerd, wordt een vervolgtoken geretourneerd dat kan worden gebruikt om later vanaf dat punt met paging te beginnen.

Functiedetails

getContinuationToken(unknown)

Gezien de laatste .value die door de byPage iterator is geproduceerd, wordt een vervolgtoken geretourneerd dat kan worden gebruikt om later vanaf dat punt met paging te beginnen.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

Een object dat vanuit een byPage iterator toegang krijgt value tot de IteratorResult.

Retouren

string | undefined

Het vervolgtoken dat tijdens toekomstige aanroepen kan worden doorgegeven aan byPage().