Freigeben über


@azure/arm-cosmosdbforpostgresql package

Klassen

CosmosDBForPostgreSQL

Schnittstellen

Cluster

Stellt einen Cluster dar.

ClusterConfigurationListResult

Eine Liste von Clusterkonfigurationen.

ClusterForUpdate

Stellt einen Cluster für die Aktualisierung dar.

ClusterListResult

Eine Liste mit 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 Header für Clusters_create Vorgang.

ClustersCreateOptionalParams

Optionale Parameter.

ClustersDeleteHeaders

Definiert Header 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 Header für Clusters_promoteReadReplica Vorgang.

ClustersPromoteReadReplicaOptionalParams

Optionale Parameter.

ClustersRestartHeaders

Definiert Header für Clusters_restart Vorgang.

ClustersRestartOptionalParams

Optionale Parameter.

ClustersStartHeaders

Definiert Header für Clusters_start Vorgang.

ClustersStartOptionalParams

Optionale Parameter.

ClustersStopHeaders

Definiert Header für Clusters_stop Vorgang.

ClustersStopOptionalParams

Optionale Parameter.

ClustersUpdateHeaders

Definiert Header 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 Header für Configurations_updateOnCoordinator Vorgang.

ConfigurationsUpdateOnCoordinatorOptionalParams

Optionale Parameter.

ConfigurationsUpdateOnNodeHeaders

Definiert Header für Configurations_updateOnNode Vorgang.

ConfigurationsUpdateOnNodeOptionalParams

Optionale Parameter.

CosmosDBForPostgreSQLOptionalParams

Optionale Parameter.

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

ErrorDetail

Die Fehlerdetails.

ErrorResponse

Allgemeine Fehlerantwort für alle Azure Resource Manager-APIs, zur Rückgabe von Fehlerdetails für fehlgeschlagene Vorgänge. (Dies folgt auch dem OData-Fehlerantwortformat.).

FirewallRule

Stellt eine Clusterfirewallregel dar.

FirewallRuleListResult

Eine Liste von Firewallregeln.

FirewallRules

Schnittstelle, die eine FirewallRules darstellt.

FirewallRulesCreateOrUpdateHeaders

Definiert Header für FirewallRules_createOrUpdate Vorgang.

FirewallRulesCreateOrUpdateOptionalParams

Optionale Parameter.

FirewallRulesDeleteHeaders

Definiert Header 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 an, die Verfügbarkeit des Clusternamens zu überprüfen.

Operation

Rest-API-Vorgangsdefinition.

OperationDisplay

Zeigen Sie metadaten an, die dem Vorgang zugeordnet sind.

OperationListResult

Eine Liste von Ressourcenanbietervorgängen.

Operations

Schnittstelle, die einen Vorgang darstellt.

OperationsListOptionalParams

Optionale Parameter.

PrivateEndpoint

Die private Endpunktressource.

PrivateEndpointConnection

Die Verbindungsressource des privaten Endpunkts.

PrivateEndpointConnectionListResult

Liste der privaten Endpunktverbindungen, die der angegebenen Ressource zugeordnet sind.

PrivateEndpointConnections

Schnittstelle, die eine PrivateEndpointConnections darstellt.

PrivateEndpointConnectionsCreateOrUpdateHeaders

Definiert Header für PrivateEndpointConnections_createOrUpdate Vorgang.

PrivateEndpointConnectionsCreateOrUpdateOptionalParams

Optionale Parameter.

PrivateEndpointConnectionsDeleteHeaders

Definiert Header für PrivateEndpointConnections_delete Vorgang.

PrivateEndpointConnectionsDeleteOptionalParams

Optionale Parameter.

PrivateEndpointConnectionsGetOptionalParams

Optionale Parameter.

PrivateEndpointConnectionsListByClusterOptionalParams

Optionale Parameter.

PrivateEndpointProperty

Eigenschaft, um die Ressourcen-ID des privaten Endpunkts darzustellen.

PrivateLinkResource

Eine Private Link-Ressource.

PrivateLinkResourceListResult

Eine Liste mit Private Link-Ressourcen.

PrivateLinkResources

Schnittstelle, die eine PrivateLinkResources darstellt.

PrivateLinkResourcesGetOptionalParams

Optionale Parameter.

PrivateLinkResourcesListByClusterOptionalParams

Optionale Parameter.

PrivateLinkServiceConnectionState

Eine Sammlung von Informationen über den Status der Verbindung zwischen dem Dienst consumer und dem Anbieter.

ProxyResource

Die Ressourcenmodelldefinition für eine Azure Resource Manager-Proxyressource. Es verfügt nicht über 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 von Rollen.

Roles

Schnittstelle, die eine Rolle darstellt.

RolesCreateHeaders

Definiert Header für Roles_create Vorgang.

RolesCreateOptionalParams

Optionale Parameter.

RolesDeleteHeaders

Definiert Header 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 Namensobjekt 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, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

TrackedResource

Die Ressourcenmodelldefinition für eine Azure-Resource Manager nachverfolgte Ressource der obersten Ebene mit "Tags" und einem "Standort"

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 Vorgang promoteReadReplica.

ClustersRestartResponse

Enthält Antwortdaten für den Neustartvorgang.

ClustersUpdateResponse

Enthält Antwortdaten für den Aktualisierungsvorgang.

ConfigurationDataType

Definiert Werte für ConfigurationDataType.
KnownConfigurationDataType kann austauschbar mit ConfigurationDataType verwendet werden. Diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt.

Vom Dienst unterstützte bekannte Werte

Boolescher Wert
Numerisch
Integer
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 Vorgang updateOnCoordinator.

ConfigurationsUpdateOnNodeResponse

Enthält Antwortdaten für den Vorgang updateOnNode.

CreatedByType

Definiert Werte für CreatedByType.
KnownCreatedByType kann austauschbar mit CreatedByType verwendet werden. Diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt.

Vom Dienst unterstützte bekannte Werte

Benutzer
Anwendung
ManagedIdentity
Schlüssel

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 kann austauschbar mit OperationOrigin verwendet werden. Diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt.

Vom Dienst unterstützte bekannte Werte

NotSpecified
user
System

OperationsListResponse

Enthält Antwortdaten für den Listenvorgang.

PrivateEndpointConnectionProvisioningState

Definiert Werte für PrivateEndpointConnectionProvisioningState.
KnownPrivateEndpointConnectionProvisioningState kann austauschbar mit PrivateEndpointConnectionProvisioningState verwendet werden. Diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt.

Vom Dienst unterstützte bekannte Werte

Erfolgreich
Wird erstellt
Wird gelöscht.
Fehler

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 kann austauschbar mit PrivateEndpointServiceConnectionStatus verwendet werden. Diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt.

Vom Dienst unterstützte bekannte Werte

Ausstehend
Genehmigt
Rejected (Abgelehnt)

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 kann austauschbar mit ProvisioningState verwendet werden. Diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt.

Vom Dienst unterstützte bekannte Werte

Erfolgreich
Canceled
InProgress
Fehler

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 kann austauschbar mit ServerRole verwendet werden. Diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt.

Vom Dienst unterstützte bekannte Werte

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)

Bei der letzten .value , die byPage vom Iterator erzeugt wurde, gibt ein Fortsetzungstoken zurück, das verwendet werden kann, um die Paging von diesem Punkt später zu beginnen.

Details zur Funktion

getContinuationToken(unknown)

Bei der letzten .value , die byPage vom Iterator erzeugt wurde, gibt ein Fortsetzungstoken zurück, das verwendet werden kann, um die Paging von diesem Punkt später zu beginnen.

function getContinuationToken(page: unknown): string | undefined

Parameter

page

unknown

Ein Objekt, das von einem byPage Iterator auf iteratorResult zugreiftvalue.

Gibt zurück

string | undefined

Das Fortsetzungstoken, das bei zukünftigen Aufrufen an byPage() übergeben werden kann.