Dela via

PostgreSqlFlexibleServerResource Class

  • Reference

Definition

Namespace:
Azure.ResourceManager.PostgreSql.FlexibleServers
Assembly:
Azure.ResourceManager.PostgreSql.dll
Package:
Azure.ResourceManager.PostgreSql v1.2.0
Package:
Azure.ResourceManager.PostgreSql v1.2.0-beta.6
Source:
PostgreSqlFlexibleServerResource.cs
Source:
PostgreSqlFlexibleServerResource.cs

A Class representing a PostgreSqlFlexibleServer along with the instance operations that can be performed on it. If you have a ResourceIdentifier you can construct a PostgreSqlFlexibleServerResource from an instance of ArmClient using the GetPostgreSqlFlexibleServerResource method. Otherwise you can get one from its parent resource ResourceGroupResource using the GetPostgreSqlFlexibleServer method.

public class PostgreSqlFlexibleServerResource : Azure.ResourceManager.ArmResource, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.PostgreSql.FlexibleServers.PostgreSqlFlexibleServerData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.PostgreSql.FlexibleServers.PostgreSqlFlexibleServerData>
type PostgreSqlFlexibleServerResource = class
    inherit ArmResource
    interface IJsonModel<PostgreSqlFlexibleServerData>
    interface IPersistableModel<PostgreSqlFlexibleServerData>
Public Class PostgreSqlFlexibleServerResource
Inherits ArmResource
Implements IJsonModel(Of PostgreSqlFlexibleServerData), IPersistableModel(Of PostgreSqlFlexibleServerData)
Inheritance
Object
ArmResource
PostgreSqlFlexibleServerResource
Implements
IJsonModel<PostgreSqlFlexibleServerData> IPersistableModel<PostgreSqlFlexibleServerData> IPersistableModel<T>

Constructors

PostgreSqlFlexibleServerResource()

Initializes a new instance of the PostgreSqlFlexibleServerResource class for mocking.

Fields

ResourceType

Gets the resource type for the operations.

Properties

Client

Gets the ArmClient this resource client was created from.

(Inherited from ArmResource)
Data

Gets the data representing this Feature.
Diagnostics

Gets the diagnostic options for this resource client.

(Inherited from ArmResource)
Endpoint

Gets the base uri for this resource client.

(Inherited from ArmResource)
HasData

Gets whether or not the current instance has data.
Id

Gets the resource identifier.

(Inherited from ArmResource)
Pipeline

Gets the pipeline for this resource client.

(Inherited from ArmResource)

Methods

AddTag(String, String, CancellationToken)

Add a tag to the current resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}
  • Operation Id: Servers_Get
  • Default Api Version: 2024-08-01
  • Resource: PostgreSqlFlexibleServerResource
AddTagAsync(String, String, CancellationToken)

Add a tag to the current resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}
  • Operation Id: Servers_Get
  • Default Api Version: 2024-08-01
  • Resource: PostgreSqlFlexibleServerResource
CanUseTagResource(CancellationToken)

Checks to see if the TagResource API is deployed in the current environment.

(Inherited from ArmResource)
CanUseTagResourceAsync(CancellationToken)

Checks to see if the TagResource API is deployed in the current environment.

(Inherited from ArmResource)
CheckPostgreSqlMigrationNameAvailability(PostgreSqlCheckMigrationNameAvailabilityContent, CancellationToken)

This method checks whether a proposed migration name is valid and available.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{targetDbServerName}/checkMigrationNameAvailability
  • Operation Id: CheckMigrationNameAvailability
  • Default Api Version: 2024-08-01
CheckPostgreSqlMigrationNameAvailabilityAsync(PostgreSqlCheckMigrationNameAvailabilityContent, CancellationToken)

This method checks whether a proposed migration name is valid and available.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{targetDbServerName}/checkMigrationNameAvailability
  • Operation Id: CheckMigrationNameAvailability
  • Default Api Version: 2024-08-01
CreateResourceIdentifier(String, String, String)

Generate the resource identifier of a PostgreSqlFlexibleServerResource instance.
Delete(WaitUntil, CancellationToken)

Deletes a server.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}
  • Operation Id: Servers_Delete
  • Default Api Version: 2024-08-01
  • Resource: PostgreSqlFlexibleServerResource
DeleteAsync(WaitUntil, CancellationToken)

Deletes a server.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}
  • Operation Id: Servers_Delete
  • Default Api Version: 2024-08-01
  • Resource: PostgreSqlFlexibleServerResource
Get(CancellationToken)

Gets information about a server.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}
  • Operation Id: Servers_Get
  • Default Api Version: 2024-08-01
  • Resource: PostgreSqlFlexibleServerResource
GetAsync(CancellationToken)

Gets information about a server.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}
  • Operation Id: Servers_Get
  • Default Api Version: 2024-08-01
  • Resource: PostgreSqlFlexibleServerResource
GetAvailableLocations(CancellationToken)

Lists all available geo-locations.

(Inherited from ArmResource)
GetAvailableLocationsAsync(CancellationToken)

Lists all available geo-locations.

(Inherited from ArmResource)
GetManagementLock(String, CancellationToken)

Get a management lock by scope.

  • Request Path: /{scope}/providers/Microsoft.Authorization/locks/{lockName}
  • Operation Id: ManagementLocks_GetByScope
  • Default Api Version: 2020-05-01
  • Resource: ManagementLockResource
(Inherited from ArmResource)
GetManagementLockAsync(String, CancellationToken)

Get a management lock by scope.

  • Request Path: /{scope}/providers/Microsoft.Authorization/locks/{lockName}
  • Operation Id: ManagementLocks_GetByScope
  • Default Api Version: 2020-05-01
  • Resource: ManagementLockResource
(Inherited from ArmResource)
GetManagementLocks()

Gets a collection of ManagementLockResources in the ArmResource.

(Inherited from ArmResource)
GetPolicyAssignment(String, CancellationToken)

This operation retrieves a single policy assignment, given its name and the scope it was created at.

  • Request Path: /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}
  • Operation Id: PolicyAssignments_Get
  • Default Api Version: 2022-06-01
  • Resource: PolicyAssignmentResource
(Inherited from ArmResource)
GetPolicyAssignmentAsync(String, CancellationToken)

This operation retrieves a single policy assignment, given its name and the scope it was created at.

  • Request Path: /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}
  • Operation Id: PolicyAssignments_Get
  • Default Api Version: 2022-06-01
  • Resource: PolicyAssignmentResource
(Inherited from ArmResource)
GetPolicyAssignments()

Gets a collection of PolicyAssignmentResources in the ArmResource.

(Inherited from ArmResource)
GetPostgreSqlFlexibleServerActiveDirectoryAdministrator(String, CancellationToken)

Gets information about a server.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/administrators/{objectId}
  • Operation Id: Administrators_Get
  • Default Api Version: 2024-08-01
  • Resource: PostgreSqlFlexibleServerActiveDirectoryAdministratorResource
GetPostgreSqlFlexibleServerActiveDirectoryAdministratorAsync(String, CancellationToken)

Gets information about a server.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/administrators/{objectId}
  • Operation Id: Administrators_Get
  • Default Api Version: 2024-08-01
  • Resource: PostgreSqlFlexibleServerActiveDirectoryAdministratorResource
GetPostgreSqlFlexibleServerActiveDirectoryAdministrators()

Gets a collection of PostgreSqlFlexibleServerActiveDirectoryAdministratorResources in the PostgreSqlFlexibleServer.
GetPostgreSqlFlexibleServerBackup(String, CancellationToken)

Get specific backup for a given server.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/backups/{backupName}
  • Operation Id: Backups_Get
  • Default Api Version: 2024-08-01
  • Resource: PostgreSqlFlexibleServerBackupResource
GetPostgreSqlFlexibleServerBackupAsync(String, CancellationToken)

Get specific backup for a given server.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/backups/{backupName}
  • Operation Id: Backups_Get
  • Default Api Version: 2024-08-01
  • Resource: PostgreSqlFlexibleServerBackupResource
GetPostgreSqlFlexibleServerBackups()

Gets a collection of PostgreSqlFlexibleServerBackupResources in the PostgreSqlFlexibleServer.
GetPostgreSqlFlexibleServerConfiguration(String, CancellationToken)

Gets information about a configuration of server.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/configurations/{configurationName}
  • Operation Id: Configurations_Get
  • Default Api Version: 2024-08-01
  • Resource: PostgreSqlFlexibleServerConfigurationResource
GetPostgreSqlFlexibleServerConfigurationAsync(String, CancellationToken)

Gets information about a configuration of server.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/configurations/{configurationName}
  • Operation Id: Configurations_Get
  • Default Api Version: 2024-08-01
  • Resource: PostgreSqlFlexibleServerConfigurationResource
GetPostgreSqlFlexibleServerConfigurations()

Gets a collection of PostgreSqlFlexibleServerConfigurationResources in the PostgreSqlFlexibleServer.
GetPostgreSqlFlexibleServerDatabase(String, CancellationToken)

Gets information about a database.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/databases/{databaseName}
  • Operation Id: Databases_Get
  • Default Api Version: 2024-08-01
  • Resource: PostgreSqlFlexibleServerDatabaseResource
GetPostgreSqlFlexibleServerDatabaseAsync(String, CancellationToken)

Gets information about a database.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/databases/{databaseName}
  • Operation Id: Databases_Get
  • Default Api Version: 2024-08-01
  • Resource: PostgreSqlFlexibleServerDatabaseResource
GetPostgreSqlFlexibleServerDatabases()

Gets a collection of PostgreSqlFlexibleServerDatabaseResources in the PostgreSqlFlexibleServer.
GetPostgreSqlFlexibleServerFirewallRule(String, CancellationToken)

List all the firewall rules in a given server.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/firewallRules/{firewallRuleName}
  • Operation Id: FirewallRules_Get
  • Default Api Version: 2024-08-01
  • Resource: PostgreSqlFlexibleServerFirewallRuleResource
GetPostgreSqlFlexibleServerFirewallRuleAsync(String, CancellationToken)

List all the firewall rules in a given server.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/firewallRules/{firewallRuleName}
  • Operation Id: FirewallRules_Get
  • Default Api Version: 2024-08-01
  • Resource: PostgreSqlFlexibleServerFirewallRuleResource
GetPostgreSqlFlexibleServerFirewallRules()

Gets a collection of PostgreSqlFlexibleServerFirewallRuleResources in the PostgreSqlFlexibleServer.
GetPostgreSqlFlexibleServerLogFiles(CancellationToken)

List all the server log files in a given server.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/logFiles
  • Operation Id: LogFiles_ListByServer
  • Default Api Version: 2024-08-01
GetPostgreSqlFlexibleServerLogFilesAsync(CancellationToken)

List all the server log files in a given server.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/logFiles
  • Operation Id: LogFiles_ListByServer
  • Default Api Version: 2024-08-01
GetPostgreSqlFlexibleServersPrivateEndpointConnection(String, CancellationToken)

Gets a private endpoint connection.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/privateEndpointConnections/{privateEndpointConnectionName}
  • Operation Id: PrivateEndpointConnections_Get
  • Default Api Version: 2024-08-01
  • Resource: PostgreSqlFlexibleServersPrivateEndpointConnectionResource
GetPostgreSqlFlexibleServersPrivateEndpointConnectionAsync(String, CancellationToken)

Gets a private endpoint connection.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/privateEndpointConnections/{privateEndpointConnectionName}
  • Operation Id: PrivateEndpointConnections_Get
  • Default Api Version: 2024-08-01
  • Resource: PostgreSqlFlexibleServersPrivateEndpointConnectionResource
GetPostgreSqlFlexibleServersPrivateEndpointConnections()

Gets a collection of PostgreSqlFlexibleServersPrivateEndpointConnectionResources in the PostgreSqlFlexibleServer.
GetPostgreSqlFlexibleServersPrivateLinkResource(String, CancellationToken)

Gets a private link resource for PostgreSQL server.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/privateLinkResources/{groupName}
  • Operation Id: PrivateLinkResources_Get
  • Default Api Version: 2024-08-01
  • Resource: PostgreSqlFlexibleServersPrivateLinkResource
GetPostgreSqlFlexibleServersPrivateLinkResourceAsync(String, CancellationToken)

Gets a private link resource for PostgreSQL server.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/privateLinkResources/{groupName}
  • Operation Id: PrivateLinkResources_Get
  • Default Api Version: 2024-08-01
  • Resource: PostgreSqlFlexibleServersPrivateLinkResource
GetPostgreSqlFlexibleServersPrivateLinkResources()

Gets a collection of PostgreSqlFlexibleServersPrivateLinkResources in the PostgreSqlFlexibleServer.
GetPostgreSqlLtrServerBackupOperation(String, CancellationToken)

Gets the result of the give long term retention backup operation for the flexible server.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/ltrBackupOperations/{backupName}
  • Operation Id: ltrBackupOperations_Get
  • Default Api Version: 2024-08-01
  • Resource: PostgreSqlLtrServerBackupOperationResource
GetPostgreSqlLtrServerBackupOperationAsync(String, CancellationToken)

Gets the result of the give long term retention backup operation for the flexible server.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/ltrBackupOperations/{backupName}
  • Operation Id: ltrBackupOperations_Get
  • Default Api Version: 2024-08-01
  • Resource: PostgreSqlLtrServerBackupOperationResource
GetPostgreSqlLtrServerBackupOperations()

Gets a collection of PostgreSqlLtrServerBackupOperationResources in the PostgreSqlFlexibleServer.
GetPostgreSqlMigration(String, CancellationToken)

Gets details of a migration.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{targetDbServerName}/migrations/{migrationName}
  • Operation Id: Migrations_Get
  • Default Api Version: 2024-08-01
  • Resource: PostgreSqlMigrationResource
GetPostgreSqlMigrationAsync(String, CancellationToken)

Gets details of a migration.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{targetDbServerName}/migrations/{migrationName}
  • Operation Id: Migrations_Get
  • Default Api Version: 2024-08-01
  • Resource: PostgreSqlMigrationResource
GetPostgreSqlMigrations()

Gets a collection of PostgreSqlMigrationResources in the PostgreSqlFlexibleServer.
GetServerCapabilities(CancellationToken)

Get capabilities for a flexible server.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/capabilities
  • Operation Id: ServerCapabilities_List
  • Default Api Version: 2024-08-01
GetServerCapabilitiesAsync(CancellationToken)

Get capabilities for a flexible server.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/capabilities
  • Operation Id: ServerCapabilities_List
  • Default Api Version: 2024-08-01
GetServerThreatProtectionSettingsModel(ThreatProtectionName, CancellationToken)

Get a server's Advanced Threat Protection settings.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/advancedThreatProtectionSettings/{threatProtectionName}
  • Operation Id: ServerThreatProtectionSettings_Get
  • Default Api Version: 2024-08-01
  • Resource: ServerThreatProtectionSettingsModelResource
GetServerThreatProtectionSettingsModelAsync(ThreatProtectionName, CancellationToken)

Get a server's Advanced Threat Protection settings.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/advancedThreatProtectionSettings/{threatProtectionName}
  • Operation Id: ServerThreatProtectionSettings_Get
  • Default Api Version: 2024-08-01
  • Resource: ServerThreatProtectionSettingsModelResource
GetServerThreatProtectionSettingsModels()

Gets a collection of ServerThreatProtectionSettingsModelResources in the PostgreSqlFlexibleServer.
GetTagResource()

Gets an object representing a TagResource along with the instance operations that can be performed on it in the ArmResource.

(Inherited from ArmResource)
GetVirtualEndpointResource(String, CancellationToken)

Gets information about a virtual endpoint.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/virtualendpoints/{virtualEndpointName}
  • Operation Id: VirtualEndpoints_Get
  • Default Api Version: 2024-08-01
  • Resource: VirtualEndpointResource
GetVirtualEndpointResourceAsync(String, CancellationToken)

Gets information about a virtual endpoint.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/virtualendpoints/{virtualEndpointName}
  • Operation Id: VirtualEndpoints_Get
  • Default Api Version: 2024-08-01
  • Resource: VirtualEndpointResource
GetVirtualEndpointResources()

Gets a collection of VirtualEndpointResources in the PostgreSqlFlexibleServer.
RemoveTag(String, CancellationToken)

Removes a tag by key from the resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}
  • Operation Id: Servers_Get
  • Default Api Version: 2024-08-01
  • Resource: PostgreSqlFlexibleServerResource
RemoveTagAsync(String, CancellationToken)

Removes a tag by key from the resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}
  • Operation Id: Servers_Get
  • Default Api Version: 2024-08-01
  • Resource: PostgreSqlFlexibleServerResource
Restart(WaitUntil, PostgreSqlFlexibleServerRestartParameter, CancellationToken)

Restarts a server.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/restart
  • Operation Id: Servers_Restart
  • Default Api Version: 2024-08-01
  • Resource: PostgreSqlFlexibleServerResource
RestartAsync(WaitUntil, PostgreSqlFlexibleServerRestartParameter, CancellationToken)

Restarts a server.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/restart
  • Operation Id: Servers_Restart
  • Default Api Version: 2024-08-01
  • Resource: PostgreSqlFlexibleServerResource
SetTags(IDictionary<String,String>, CancellationToken)

Replace the tags on the resource with the given set.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}
  • Operation Id: Servers_Get
  • Default Api Version: 2024-08-01
  • Resource: PostgreSqlFlexibleServerResource
SetTagsAsync(IDictionary<String,String>, CancellationToken)

Replace the tags on the resource with the given set.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}
  • Operation Id: Servers_Get
  • Default Api Version: 2024-08-01
  • Resource: PostgreSqlFlexibleServerResource
Start(WaitUntil, CancellationToken)

Starts a server.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/start
  • Operation Id: Servers_Start
  • Default Api Version: 2024-08-01
  • Resource: PostgreSqlFlexibleServerResource
StartAsync(WaitUntil, CancellationToken)

Starts a server.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/start
  • Operation Id: Servers_Start
  • Default Api Version: 2024-08-01
  • Resource: PostgreSqlFlexibleServerResource
StartLtrBackupFlexibleServer(WaitUntil, PostgreSqlFlexibleServerLtrBackupContent, CancellationToken)

Start the Long Term Retention Backup operation

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/startLtrBackup
  • Operation Id: FlexibleServer_StartLtrBackup
  • Default Api Version: 2024-08-01
StartLtrBackupFlexibleServerAsync(WaitUntil, PostgreSqlFlexibleServerLtrBackupContent, CancellationToken)

Start the Long Term Retention Backup operation

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/startLtrBackup
  • Operation Id: FlexibleServer_StartLtrBackup
  • Default Api Version: 2024-08-01
Stop(WaitUntil, CancellationToken)

Stops a server.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/stop
  • Operation Id: Servers_Stop
  • Default Api Version: 2024-08-01
  • Resource: PostgreSqlFlexibleServerResource
StopAsync(WaitUntil, CancellationToken)

Stops a server.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/stop
  • Operation Id: Servers_Stop
  • Default Api Version: 2024-08-01
  • Resource: PostgreSqlFlexibleServerResource
TriggerLtrPreBackupFlexibleServer(PostgreSqlFlexibleServerLtrPreBackupContent, CancellationToken)

PreBackup operation performs all the checks that are needed for the subsequent long term retention backup operation to succeed.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/ltrPreBackup
  • Operation Id: FlexibleServer_TriggerLtrPreBackup
  • Default Api Version: 2024-08-01
TriggerLtrPreBackupFlexibleServerAsync(PostgreSqlFlexibleServerLtrPreBackupContent, CancellationToken)

PreBackup operation performs all the checks that are needed for the subsequent long term retention backup operation to succeed.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/ltrPreBackup
  • Operation Id: FlexibleServer_TriggerLtrPreBackup
  • Default Api Version: 2024-08-01
TryGetApiVersion(ResourceType, String)

Gets the api version override if it has been set for the current client options.

(Inherited from ArmResource)
Update(WaitUntil, PostgreSqlFlexibleServerPatch, CancellationToken)

Updates an existing server. The request body can contain one to many of the properties present in the normal server definition.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}
  • Operation Id: Servers_Update
  • Default Api Version: 2024-08-01
  • Resource: PostgreSqlFlexibleServerResource
UpdateAsync(WaitUntil, PostgreSqlFlexibleServerPatch, CancellationToken)

Updates an existing server. The request body can contain one to many of the properties present in the normal server definition.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}
  • Operation Id: Servers_Update
  • Default Api Version: 2024-08-01
  • Resource: PostgreSqlFlexibleServerResource

Explicit Interface Implementations

IJsonModel<PostgreSqlFlexibleServerData>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<PostgreSqlFlexibleServerData>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.
IPersistableModel<PostgreSqlFlexibleServerData>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.
IPersistableModel<PostgreSqlFlexibleServerData>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<PostgreSqlFlexibleServerData>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Extension Methods

GetAuthorizationRoleDefinition(ArmResource, ResourceIdentifier, CancellationToken)

Get role definition by name (GUID).

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId}
  • Operation Id: RoleDefinitions_Get
  • Default Api Version: 2022-04-01
  • Resource: AuthorizationRoleDefinitionResource
GetAuthorizationRoleDefinitionAsync(ArmResource, ResourceIdentifier, CancellationToken)

Get role definition by name (GUID).

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId}
  • Operation Id: RoleDefinitions_Get
  • Default Api Version: 2022-04-01
  • Resource: AuthorizationRoleDefinitionResource
GetAuthorizationRoleDefinitions(ArmResource)

Gets a collection of AuthorizationRoleDefinitionResources in the ArmResource. MockingTo mock this method, please mock GetAuthorizationRoleDefinitions() instead.
GetDenyAssignment(ArmResource, String, CancellationToken)

Get the specified deny assignment.

  • Request Path: /{scope}/providers/Microsoft.Authorization/denyAssignments/{denyAssignmentId}
  • Operation Id: DenyAssignments_Get
  • Default Api Version: 2022-04-01
  • Resource: DenyAssignmentResource
GetDenyAssignmentAsync(ArmResource, String, CancellationToken)

Get the specified deny assignment.

  • Request Path: /{scope}/providers/Microsoft.Authorization/denyAssignments/{denyAssignmentId}
  • Operation Id: DenyAssignments_Get
  • Default Api Version: 2022-04-01
  • Resource: DenyAssignmentResource
GetDenyAssignments(ArmResource)

Gets a collection of DenyAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetDenyAssignments() instead.
GetRoleAssignment(ArmResource, String, String, CancellationToken)

Get a role assignment by scope and name.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}
  • Operation Id: RoleAssignments_Get
  • Default Api Version: 2022-04-01
  • Resource: RoleAssignmentResource
GetRoleAssignmentAsync(ArmResource, String, String, CancellationToken)

Get a role assignment by scope and name.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}
  • Operation Id: RoleAssignments_Get
  • Default Api Version: 2022-04-01
  • Resource: RoleAssignmentResource
GetRoleAssignments(ArmResource)

Gets a collection of RoleAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignments() instead.
GetRoleAssignmentSchedule(ArmResource, String, CancellationToken)

Get the specified role assignment schedule for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentSchedules/{roleAssignmentScheduleName}
  • Operation Id: RoleAssignmentSchedules_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleResource
GetRoleAssignmentScheduleAsync(ArmResource, String, CancellationToken)

Get the specified role assignment schedule for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentSchedules/{roleAssignmentScheduleName}
  • Operation Id: RoleAssignmentSchedules_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleResource
GetRoleAssignmentScheduleInstance(ArmResource, String, CancellationToken)

Gets the specified role assignment schedule instance.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleInstances/{roleAssignmentScheduleInstanceName}
  • Operation Id: RoleAssignmentScheduleInstances_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleInstanceResource
GetRoleAssignmentScheduleInstanceAsync(ArmResource, String, CancellationToken)

Gets the specified role assignment schedule instance.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleInstances/{roleAssignmentScheduleInstanceName}
  • Operation Id: RoleAssignmentScheduleInstances_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleInstanceResource
GetRoleAssignmentScheduleInstances(ArmResource)

Gets a collection of RoleAssignmentScheduleInstanceResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentScheduleInstances() instead.
GetRoleAssignmentScheduleRequest(ArmResource, String, CancellationToken)

Get the specified role assignment schedule request.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleRequests/{roleAssignmentScheduleRequestName}
  • Operation Id: RoleAssignmentScheduleRequests_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleRequestResource
GetRoleAssignmentScheduleRequestAsync(ArmResource, String, CancellationToken)

Get the specified role assignment schedule request.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleRequests/{roleAssignmentScheduleRequestName}
  • Operation Id: RoleAssignmentScheduleRequests_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleRequestResource
GetRoleAssignmentScheduleRequests(ArmResource)

Gets a collection of RoleAssignmentScheduleRequestResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentScheduleRequests() instead.
GetRoleAssignmentSchedules(ArmResource)

Gets a collection of RoleAssignmentScheduleResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentSchedules() instead.
GetRoleEligibilitySchedule(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilitySchedules/{roleEligibilityScheduleName}
  • Operation Id: RoleEligibilitySchedules_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleResource
GetRoleEligibilityScheduleAsync(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilitySchedules/{roleEligibilityScheduleName}
  • Operation Id: RoleEligibilitySchedules_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleResource
GetRoleEligibilityScheduleInstance(ArmResource, String, CancellationToken)

Gets the specified role eligibility schedule instance.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleInstances/{roleEligibilityScheduleInstanceName}
  • Operation Id: RoleEligibilityScheduleInstances_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleInstanceResource
GetRoleEligibilityScheduleInstanceAsync(ArmResource, String, CancellationToken)

Gets the specified role eligibility schedule instance.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleInstances/{roleEligibilityScheduleInstanceName}
  • Operation Id: RoleEligibilityScheduleInstances_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleInstanceResource
GetRoleEligibilityScheduleInstances(ArmResource)

Gets a collection of RoleEligibilityScheduleInstanceResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilityScheduleInstances() instead.
GetRoleEligibilityScheduleRequest(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule request.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleRequests/{roleEligibilityScheduleRequestName}
  • Operation Id: RoleEligibilityScheduleRequests_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleRequestResource
GetRoleEligibilityScheduleRequestAsync(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule request.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleRequests/{roleEligibilityScheduleRequestName}
  • Operation Id: RoleEligibilityScheduleRequests_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleRequestResource
GetRoleEligibilityScheduleRequests(ArmResource)

Gets a collection of RoleEligibilityScheduleRequestResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilityScheduleRequests() instead.
GetRoleEligibilitySchedules(ArmResource)

Gets a collection of RoleEligibilityScheduleResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilitySchedules() instead.
GetRoleManagementPolicies(ArmResource)

Gets a collection of RoleManagementPolicyResources in the ArmResource. MockingTo mock this method, please mock GetRoleManagementPolicies() instead.
GetRoleManagementPolicy(ArmResource, String, CancellationToken)

Get the specified role management policy for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicies/{roleManagementPolicyName}
  • Operation Id: RoleManagementPolicies_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleManagementPolicyResource
GetRoleManagementPolicyAssignment(ArmResource, String, CancellationToken)

Get the specified role management policy assignment for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicyAssignments/{roleManagementPolicyAssignmentName}
  • Operation Id: RoleManagementPolicyAssignments_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleManagementPolicyAssignmentResource
GetRoleManagementPolicyAssignmentAsync(ArmResource, String, CancellationToken)

Get the specified role management policy assignment for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicyAssignments/{roleManagementPolicyAssignmentName}
  • Operation Id: RoleManagementPolicyAssignments_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleManagementPolicyAssignmentResource
GetRoleManagementPolicyAssignments(ArmResource)

Gets a collection of RoleManagementPolicyAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetRoleManagementPolicyAssignments() instead.
GetRoleManagementPolicyAsync(ArmResource, String, CancellationToken)

Get the specified role management policy for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicies/{roleManagementPolicyName}
  • Operation Id: RoleManagementPolicies_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleManagementPolicyResource
GetSystemAssignedIdentity(ArmResource)

Gets an object representing a SystemAssignedIdentityResource along with the instance operations that can be performed on it in the ArmResource. MockingTo mock this method, please mock GetSystemAssignedIdentity() instead.
GetLinkerResource(ArmResource, String, CancellationToken)

Returns Linker resource for a given name.

  • Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}
  • Operation Id: Linker_Get
GetLinkerResourceAsync(ArmResource, String, CancellationToken)

Returns Linker resource for a given name.

  • Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}
  • Operation Id: Linker_Get
GetLinkerResources(ArmResource)

Gets a collection of LinkerResources in the ArmResource. MockingTo mock this method, please mock GetLinkerResources() instead.

Applies to