PostgreSqlFlexibleServerResource Class

Definition

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 GetResource method. Otherwise you can get one from its parent resource ResourceGroupResource using the GetPostgreSqlFlexibleServers 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
PostgreSqlFlexibleServerResource
Implements

Constructors

Name Description
PostgreSqlFlexibleServerResource()

Initializes a new instance of PostgreSqlFlexibleServerResource for mocking.

Fields

Name Description
ResourceType

Gets the resource type for the operations.

Properties

Name Description
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

Name Description
AddTag(String, String, CancellationToken)

Add a tag to the current resource.

AddTagAsync(String, String, CancellationToken)

Add a tag to the current resource.

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)

Checks if a proposed migration name is valid and available.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/checkMigrationNameAvailability.
  • Operation Id. : Servers_CheckNameAvailability.
  • Default Api Version. : 2026-04-01-preview.
  • Resource. : PostgreSqlFlexibleServerResource.
CheckPostgreSqlMigrationNameAvailabilityAsync(PostgreSqlCheckMigrationNameAvailabilityContent, CancellationToken)

Checks if a proposed migration name is valid and available.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/checkMigrationNameAvailability.
  • Operation Id. : Servers_CheckNameAvailability.
  • Default Api Version. : 2026-04-01-preview.
  • Resource. : PostgreSqlFlexibleServerResource.
CreateResourceIdentifier(String, String, String)

Generate the resource identifier for this resource.

Delete(WaitUntil, CancellationToken)

Deletes or drops an existing server.

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

Deletes or drops an existing server.

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

Gets information about an existing server.

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

Gets information about an existing server.

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

Lists all available geo-locations.

(Inherited from ArmResource)
GetAvailableLocationsAsync(CancellationToken)

Lists all available geo-locations.

(Inherited from ArmResource)
GetMaintenanceEvent(String, CancellationToken)

Gets information about a maintenance event for a flexible server.

GetMaintenanceEventAsync(String, CancellationToken)

Gets information about a maintenance event for a flexible server.

GetMaintenanceEvents()

Gets a collection of MaintenanceEvents in the PostgreSqlFlexibleServerResource.

GetMajorVersionUpgradePrecheck(String, CancellationToken)

Gets information about a major version upgrade precheck for a flexible server.

GetMajorVersionUpgradePrecheckAsync(String, CancellationToken)

Gets information about a major version upgrade precheck for a flexible server.

GetMajorVersionUpgradePrechecks()

Gets a collection of MajorVersionUpgradePrechecks in the PostgreSqlFlexibleServerResource.

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)
GetPostgreSqlFlexibleServerBackup(String, CancellationToken)

Gets information of an on demand backup, given its name.

GetPostgreSqlFlexibleServerBackupAsync(String, CancellationToken)

Gets information of an on demand backup, given its name.

GetPostgreSqlFlexibleServerBackups()

Gets a collection of PostgreSqlFlexibleServerBackups in the PostgreSqlFlexibleServerResource.

GetPostgreSqlFlexibleServerConfiguration(String, CancellationToken)

Gets information about a specific configuration (also known as server parameter) of a server.

GetPostgreSqlFlexibleServerConfigurationAsync(String, CancellationToken)

Gets information about a specific configuration (also known as server parameter) of a server.

GetPostgreSqlFlexibleServerConfigurations()

Gets a collection of PostgreSqlFlexibleServerConfigurations in the PostgreSqlFlexibleServerResource.

GetPostgreSqlFlexibleServerDatabase(String, CancellationToken)

Gets information about an existing database.

GetPostgreSqlFlexibleServerDatabaseAsync(String, CancellationToken)

Gets information about an existing database.

GetPostgreSqlFlexibleServerDatabases()

Gets a collection of PostgreSqlFlexibleServerDatabases in the PostgreSqlFlexibleServerResource.

GetPostgreSqlFlexibleServerFirewallRule(String, CancellationToken)

Gets information about a firewall rule in a server.

GetPostgreSqlFlexibleServerFirewallRuleAsync(String, CancellationToken)

Gets information about a firewall rule in a server.

GetPostgreSqlFlexibleServerFirewallRules()

Gets a collection of PostgreSqlFlexibleServerFirewallRules in the PostgreSqlFlexibleServerResource.

GetPostgreSqlFlexibleServerLogFiles(CancellationToken)

Lists all captured logs for download in a server.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/logFiles.
  • Operation Id. : Servers_ListByServer.
  • Default Api Version. : 2026-04-01-preview.
  • Resource. : PostgreSqlFlexibleServerResource.
GetPostgreSqlFlexibleServerLogFilesAsync(CancellationToken)

Lists all captured logs for download in a server.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/logFiles.
  • Operation Id. : Servers_ListByServer.
  • Default Api Version. : 2026-04-01-preview.
  • Resource. : PostgreSqlFlexibleServerResource.
GetPostgreSqlFlexibleServerMicrosoftEntraAdministrator(String, CancellationToken)

Gets information about a server administrator associated to a Microsoft Entra principal.

GetPostgreSqlFlexibleServerMicrosoftEntraAdministratorAsync(String, CancellationToken)

Gets information about a server administrator associated to a Microsoft Entra principal.

GetPostgreSqlFlexibleServerMicrosoftEntraAdministrators()

Gets a collection of PostgreSqlFlexibleServerMicrosoftEntraAdministrators in the PostgreSqlFlexibleServerResource.

GetPostgreSqlFlexibleServersPrivateEndpointConnection(String, CancellationToken)

Gets a private endpoint connection.

GetPostgreSqlFlexibleServersPrivateEndpointConnectionAsync(String, CancellationToken)

Gets a private endpoint connection.

GetPostgreSqlFlexibleServersPrivateEndpointConnections()

Gets a collection of PostgreSqlFlexibleServersPrivateEndpointConnections in the PostgreSqlFlexibleServerResource.

GetPostgreSqlFlexibleServersPrivateLinkResource(String, CancellationToken)

Gets a private link resource for PostgreSQL server.

GetPostgreSqlFlexibleServersPrivateLinkResourceAsync(String, CancellationToken)

Gets a private link resource for PostgreSQL server.

GetPostgreSqlFlexibleServersPrivateLinkResources()

Gets a collection of PostgreSqlFlexibleServersPrivateLinkResources in the PostgreSqlFlexibleServerResource.

GetPostgreSqlFlexibleServerTuningOption(PostgreSqlFlexibleServerTuningOptionType, CancellationToken)

Gets the tuning options of a server.

GetPostgreSqlFlexibleServerTuningOptionAsync(PostgreSqlFlexibleServerTuningOptionType, CancellationToken)

Gets the tuning options of a server.

GetPostgreSqlFlexibleServerTuningOptions()

Gets a collection of PostgreSqlFlexibleServerTuningOptions in the PostgreSqlFlexibleServerResource.

GetPostgreSqlLtrServerBackupOperation(String, CancellationToken)

Gets the results of a long retention backup operation for a server.

GetPostgreSqlLtrServerBackupOperationAsync(String, CancellationToken)

Gets the results of a long retention backup operation for a server.

GetPostgreSqlLtrServerBackupOperations()

Gets a collection of PostgreSqlLtrServerBackupOperations in the PostgreSqlFlexibleServerResource.

GetPostgreSqlMigration(String, CancellationToken)

Gets information about a migration.

GetPostgreSqlMigrationAsync(String, CancellationToken)

Gets information about a migration.

GetPostgreSqlMigrations()

Gets a collection of PostgreSqlMigrations in the PostgreSqlFlexibleServerResource.

GetReplicas(CancellationToken)

Lists all read replicas of a server.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/replicas.
  • Operation Id. : Servers_ReplicasListByServer.
  • Default Api Version. : 2026-04-01-preview.
  • Resource. : PostgreSqlFlexibleServerResource.
GetReplicasAsync(CancellationToken)

Lists all read replicas of a server.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/replicas.
  • Operation Id. : Servers_ReplicasListByServer.
  • Default Api Version. : 2026-04-01-preview.
  • Resource. : PostgreSqlFlexibleServerResource.
GetServerCapabilities(CancellationToken)

Lists the capabilities available for a given server.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/capabilities.
  • Operation Id. : Servers_List.
  • Default Api Version. : 2026-04-01-preview.
  • Resource. : PostgreSqlFlexibleServerResource.
GetServerCapabilitiesAsync(CancellationToken)

Lists the capabilities available for a given server.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/capabilities.
  • Operation Id. : Servers_List.
  • Default Api Version. : 2026-04-01-preview.
  • Resource. : PostgreSqlFlexibleServerResource.
GetServerThreatProtectionSettingsModel(ThreatProtectionName, CancellationToken)

Gets state of advanced threat protection settings for a server.

GetServerThreatProtectionSettingsModelAsync(ThreatProtectionName, CancellationToken)

Gets state of advanced threat protection settings for a server.

GetServerThreatProtectionSettingsModels()

Gets a collection of ServerThreatProtectionSettingsModels in the PostgreSqlFlexibleServerResource.

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 pair of virtual endpoints.

GetVirtualEndpointResourceAsync(String, CancellationToken)

Gets information about a pair of virtual endpoints.

GetVirtualEndpointResources()

Gets a collection of VirtualEndpointResources in the PostgreSqlFlexibleServerResource.

MigrateNetworkMode(WaitUntil, CancellationToken)

Migrates an Azure Database for PostgreSQL server from VNet integration to a Private Link network model.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/migrateNetwork.
  • Operation Id. : Servers_MigrateNetworkMode.
  • Default Api Version. : 2026-04-01-preview.
  • Resource. : PostgreSqlFlexibleServerResource.
MigrateNetworkModeAsync(WaitUntil, CancellationToken)

Migrates an Azure Database for PostgreSQL server from VNet integration to a Private Link network model.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/migrateNetwork.
  • Operation Id. : Servers_MigrateNetworkMode.
  • Default Api Version. : 2026-04-01-preview.
  • Resource. : PostgreSqlFlexibleServerResource.
RemoveTag(String, CancellationToken)

Removes a tag by key from the resource.

RemoveTagAsync(String, CancellationToken)

Removes a tag by key from the resource.

Restart(WaitUntil, PostgreSqlFlexibleServerRestartParameter, CancellationToken)

Restarts PostgreSQL database engine in a server.

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

Restarts PostgreSQL database engine in a server.

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

Replace the tags on the resource with the given set.

SetTagsAsync(IDictionary<String,String>, CancellationToken)

Replace the tags on the resource with the given set.

Start(WaitUntil, CancellationToken)

Starts a stopped server.

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

Starts a stopped server.

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

Initiates a long term retention backup.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/startLtrBackup.
  • Operation Id. : Servers_Start.
  • Default Api Version. : 2026-04-01-preview.
  • Resource. : PostgreSqlFlexibleServerResource.
StartLtrBackupFlexibleServerAsync(WaitUntil, PostgreSqlFlexibleServerLtrBackupContent, CancellationToken)

Initiates a long term retention backup.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/startLtrBackup.
  • Operation Id. : Servers_Start.
  • Default Api Version. : 2026-04-01-preview.
  • Resource. : PostgreSqlFlexibleServerResource.
StartMajorVersionUpgradePrecheck(WaitUntil, StartMajorVersionUpgradePrecheckContent, CancellationToken)

Start Major Version Upgrade Prechecks.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/startMajorVersionUpgradePrecheck.
  • Operation Id. : Servers_StartMajorVersionUpgradePrecheck.
  • Default Api Version. : 2026-04-01-preview.
  • Resource. : PostgreSqlFlexibleServerResource.
StartMajorVersionUpgradePrecheckAsync(WaitUntil, StartMajorVersionUpgradePrecheckContent, CancellationToken)

Start Major Version Upgrade Prechecks.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/startMajorVersionUpgradePrecheck.
  • Operation Id. : Servers_StartMajorVersionUpgradePrecheck.
  • Default Api Version. : 2026-04-01-preview.
  • Resource. : PostgreSqlFlexibleServerResource.
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. : 2026-04-01-preview.
  • 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. : 2026-04-01-preview.
  • Resource. : PostgreSqlFlexibleServerResource.
TriggerLtrPreBackupFlexibleServer(PostgreSqlFlexibleServerLtrPreBackupContent, CancellationToken)

Performs all checks required for a long term retention backup operation to succeed.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/ltrPreBackup.
  • Operation Id. : Servers_CheckPrerequisites.
  • Default Api Version. : 2026-04-01-preview.
  • Resource. : PostgreSqlFlexibleServerResource.
TriggerLtrPreBackupFlexibleServerAsync(PostgreSqlFlexibleServerLtrPreBackupContent, CancellationToken)

Performs all checks required for a long term retention backup operation to succeed.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/ltrPreBackup.
  • Operation Id. : Servers_CheckPrerequisites.
  • Default Api Version. : 2026-04-01-preview.
  • Resource. : PostgreSqlFlexibleServerResource.
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 or multiple 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. : 2026-04-01-preview.
  • Resource. : PostgreSqlFlexibleServerResource.
UpdateAsync(WaitUntil, PostgreSqlFlexibleServerPatch, CancellationToken)

Updates an existing server. The request body can contain one or multiple 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. : 2026-04-01-preview.
  • Resource. : PostgreSqlFlexibleServerResource.

Explicit Interface Implementations

Name Description
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

Name Description
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
<item>MockingTo mock this method, please mock GetAuthorizationRoleDefinition(ResourceIdentifier, CancellationToken) instead.</item>
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
<item>MockingTo mock this method, please mock GetAuthorizationRoleDefinitionAsync(ResourceIdentifier, CancellationToken) instead.</item>
GetAuthorizationRoleDefinitions(ArmResource)

Gets a collection of AuthorizationRoleDefinitionResources in the ArmResource. <item>MockingTo mock this method, please mock GetAuthorizationRoleDefinitions() instead.</item>

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
<item>MockingTo mock this method, please mock GetDenyAssignment(String, CancellationToken) instead.</item>
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
<item>MockingTo mock this method, please mock GetDenyAssignmentAsync(String, CancellationToken) instead.</item>
GetDenyAssignments(ArmResource)

Gets a collection of DenyAssignmentResources in the ArmResource. <item>MockingTo mock this method, please mock GetDenyAssignments() instead.</item>

GetLinkerResource(ArmResource, String, CancellationToken)

Returns Linker resource for a given name.

  • Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}
  • Operation Id: Linker_Get
  • Default Api Version: 2022-05-01
  • Resource: LinkerResource
<item>MockingTo mock this method, please mock GetLinkerResource(String, CancellationToken) instead.</item>
GetLinkerResourceAsync(ArmResource, String, CancellationToken)

Returns Linker resource for a given name.

  • Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}
  • Operation Id: Linker_Get
  • Default Api Version: 2022-05-01
  • Resource: LinkerResource
<item>MockingTo mock this method, please mock GetLinkerResourceAsync(String, CancellationToken) instead.</item>
GetLinkerResources(ArmResource)

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

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
<item>MockingTo mock this method, please mock GetRoleAssignment(String, String, CancellationToken) instead.</item>
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
<item>MockingTo mock this method, please mock GetRoleAssignmentAsync(String, String, CancellationToken) instead.</item>
GetRoleAssignments(ArmResource)

Gets a collection of RoleAssignmentResources in the ArmResource. <item>MockingTo mock this method, please mock GetRoleAssignments() instead.</item>

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
<item>MockingTo mock this method, please mock GetRoleAssignmentSchedule(String, CancellationToken) instead.</item>
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
<item>MockingTo mock this method, please mock GetRoleAssignmentScheduleAsync(String, CancellationToken) instead.</item>
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
<item>MockingTo mock this method, please mock GetRoleAssignmentScheduleInstance(String, CancellationToken) instead.</item>
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
<item>MockingTo mock this method, please mock GetRoleAssignmentScheduleInstanceAsync(String, CancellationToken) instead.</item>
GetRoleAssignmentScheduleInstances(ArmResource)

Gets a collection of RoleAssignmentScheduleInstanceResources in the ArmResource. <item>MockingTo mock this method, please mock GetRoleAssignmentScheduleInstances() instead.</item>

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
<item>MockingTo mock this method, please mock GetRoleAssignmentScheduleRequest(String, CancellationToken) instead.</item>
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
<item>MockingTo mock this method, please mock GetRoleAssignmentScheduleRequestAsync(String, CancellationToken) instead.</item>
GetRoleAssignmentScheduleRequests(ArmResource)

Gets a collection of RoleAssignmentScheduleRequestResources in the ArmResource. <item>MockingTo mock this method, please mock GetRoleAssignmentScheduleRequests() instead.</item>

GetRoleAssignmentSchedules(ArmResource)

Gets a collection of RoleAssignmentScheduleResources in the ArmResource. <item>MockingTo mock this method, please mock GetRoleAssignmentSchedules() instead.</item>

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
<item>MockingTo mock this method, please mock GetRoleEligibilitySchedule(String, CancellationToken) instead.</item>
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
<item>MockingTo mock this method, please mock GetRoleEligibilityScheduleAsync(String, CancellationToken) instead.</item>
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
<item>MockingTo mock this method, please mock GetRoleEligibilityScheduleInstance(String, CancellationToken) instead.</item>
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
<item>MockingTo mock this method, please mock GetRoleEligibilityScheduleInstanceAsync(String, CancellationToken) instead.</item>
GetRoleEligibilityScheduleInstances(ArmResource)

Gets a collection of RoleEligibilityScheduleInstanceResources in the ArmResource. <item>MockingTo mock this method, please mock GetRoleEligibilityScheduleInstances() instead.</item>

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
<item>MockingTo mock this method, please mock GetRoleEligibilityScheduleRequest(String, CancellationToken) instead.</item>
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
<item>MockingTo mock this method, please mock GetRoleEligibilityScheduleRequestAsync(String, CancellationToken) instead.</item>
GetRoleEligibilityScheduleRequests(ArmResource)

Gets a collection of RoleEligibilityScheduleRequestResources in the ArmResource. <item>MockingTo mock this method, please mock GetRoleEligibilityScheduleRequests() instead.</item>

GetRoleEligibilitySchedules(ArmResource)

Gets a collection of RoleEligibilityScheduleResources in the ArmResource. <item>MockingTo mock this method, please mock GetRoleEligibilitySchedules() instead.</item>

GetRoleManagementPolicies(ArmResource)

Gets a collection of RoleManagementPolicyResources in the ArmResource. <item>MockingTo mock this method, please mock GetRoleManagementPolicies() instead.</item>

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
<item>MockingTo mock this method, please mock GetRoleManagementPolicy(String, CancellationToken) instead.</item>
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
<item>MockingTo mock this method, please mock GetRoleManagementPolicyAssignment(String, CancellationToken) instead.</item>
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
<item>MockingTo mock this method, please mock GetRoleManagementPolicyAssignmentAsync(String, CancellationToken) instead.</item>
GetRoleManagementPolicyAssignments(ArmResource)

Gets a collection of RoleManagementPolicyAssignmentResources in the ArmResource. <item>MockingTo mock this method, please mock GetRoleManagementPolicyAssignments() instead.</item>

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
<item>MockingTo mock this method, please mock GetRoleManagementPolicyAsync(String, CancellationToken) instead.</item>
GetSystemAssignedIdentity(ArmResource)

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

Applies to