DB Agent - Create Or Update

Service:

PostgreSQL

API Version:

2026-07-01-preview

Enables or disables the database agent for a flexible server.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/dbAgents/Default?api-version=2026-07-01-preview

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
serverName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*	The name of the server.
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Body

Name	Required	Type	Description
properties	True	DbAgentForUpdateProperties	The requested database agent properties.

Responses

Name	Type	Description
202 Accepted	DbAgent	The response returned when a database agent write is accepted. Headers Azure-AsyncOperation: string Location: string Retry-After: integer
Other Status Codes	ErrorResponse	An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Disable the singleton Default database agent for a server.

Enable the singleton Default database agent for a server.

Disable the singleton Default database agent for a server.

Sample request

HTTP

PUT https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/exampleserver/dbAgents/Default?api-version=2026-07-01-preview

{
  "properties": {
    "state": "Disabled"
  }
}

Java

import com.azure.resourcemanager.postgresqlflexibleserver.models.DbAgentForUpdate;
import com.azure.resourcemanager.postgresqlflexibleserver.models.DbAgentForUpdateProperties;
import com.azure.resourcemanager.postgresqlflexibleserver.models.DbAgentForUpdateState;

/**
 * Samples for DbAgents CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: 2026-07-01-preview/DBAgentUpdateDisable.json
     */
    /**
     * Sample code: Disable the singleton Default database agent for a server.
     * 
     * @param manager Entry point to PostgreSqlManager.
     */
    public static void disableTheSingletonDefaultDatabaseAgentForAServer(
        com.azure.resourcemanager.postgresqlflexibleserver.PostgreSqlManager manager) {
        manager.dbAgents().createOrUpdate("exampleresourcegroup", "exampleserver",
            new DbAgentForUpdate()
                .withProperties(new DbAgentForUpdateProperties().withState(DbAgentForUpdateState.DISABLED)),
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.postgresqlflexibleservers import PostgreSQLManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-postgresqlflexibleservers
# USAGE
    python db_agent_update_disable.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = PostgreSQLManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.db_agents.begin_create_or_update(
        resource_group_name="exampleresourcegroup",
        server_name="exampleserver",
        resource={"properties": {"state": "Disabled"}},
    ).result()
    print(response)


# x-ms-original-file: 2026-07-01-preview/DBAgentUpdateDisable.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armpostgresqlflexibleservers_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/postgresql/armpostgresqlflexibleservers/v6"
)

// Generated from example definition: 2026-07-01-preview/DBAgentUpdateDisable.json
func ExampleDbAgentsClient_BeginCreateOrUpdate_disableTheSingletonDefaultDatabaseAgentForAServer() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armpostgresqlflexibleservers.NewClientFactory("ffffffff-ffff-ffff-ffff-ffffffffffff", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewDbAgentsClient().BeginCreateOrUpdate(ctx, "exampleresourcegroup", "exampleserver", armpostgresqlflexibleservers.DbAgentForUpdate{
		Properties: &armpostgresqlflexibleservers.DbAgentForUpdateProperties{
			State: to.Ptr(armpostgresqlflexibleservers.DbAgentForUpdateStateDisabled),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to poll the result: %v", err)
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { PostgreSQLManagementFlexibleServerClient } = require("@azure/arm-postgresql-flexible");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to enables or disables the database agent for a flexible server.
 *
 * @summary enables or disables the database agent for a flexible server.
 * x-ms-original-file: 2026-07-01-preview/DBAgentUpdateDisable.json
 */
async function disableTheSingletonDefaultDatabaseAgentForAServer() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "ffffffff-ffff-ffff-ffff-ffffffffffff";
  const client = new PostgreSQLManagementFlexibleServerClient(credential, subscriptionId);
  const result = await client.dbAgents.createOrUpdate("exampleresourcegroup", "exampleserver", {
    properties: { state: "Disabled" },
  });
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

202

Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/eastus/azureAsyncOperation/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa?api-version=2026-07-01-preview
Location: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/eastus/operationResults/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb?api-version=2026-07-01-preview

{
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/exampleserver/dbAgents/Default",
  "name": "Default",
  "type": "Microsoft.DBforPostgreSQL/flexibleServers/dbAgents",
  "properties": {
    "state": "Disabling",
    "provisioningState": "InProgress",
    "lastModifiedTime": "2026-08-28T15:30:00Z"
  }
}

Enable the singleton Default database agent for a server.

Sample request

HTTP

PUT https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/exampleserver/dbAgents/Default?api-version=2026-07-01-preview

{
  "properties": {
    "state": "Enabled"
  }
}

Java

import com.azure.resourcemanager.postgresqlflexibleserver.models.DbAgentForUpdate;
import com.azure.resourcemanager.postgresqlflexibleserver.models.DbAgentForUpdateProperties;
import com.azure.resourcemanager.postgresqlflexibleserver.models.DbAgentForUpdateState;

/**
 * Samples for DbAgents CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: 2026-07-01-preview/DBAgentUpdateEnable.json
     */
    /**
     * Sample code: Enable the singleton Default database agent for a server.
     * 
     * @param manager Entry point to PostgreSqlManager.
     */
    public static void enableTheSingletonDefaultDatabaseAgentForAServer(
        com.azure.resourcemanager.postgresqlflexibleserver.PostgreSqlManager manager) {
        manager.dbAgents().createOrUpdate("exampleresourcegroup", "exampleserver",
            new DbAgentForUpdate()
                .withProperties(new DbAgentForUpdateProperties().withState(DbAgentForUpdateState.ENABLED)),
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.postgresqlflexibleservers import PostgreSQLManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-postgresqlflexibleservers
# USAGE
    python db_agent_update_enable.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = PostgreSQLManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.db_agents.begin_create_or_update(
        resource_group_name="exampleresourcegroup",
        server_name="exampleserver",
        resource={"properties": {"state": "Enabled"}},
    ).result()
    print(response)


# x-ms-original-file: 2026-07-01-preview/DBAgentUpdateEnable.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armpostgresqlflexibleservers_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/postgresql/armpostgresqlflexibleservers/v6"
)

// Generated from example definition: 2026-07-01-preview/DBAgentUpdateEnable.json
func ExampleDbAgentsClient_BeginCreateOrUpdate_enableTheSingletonDefaultDatabaseAgentForAServer() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armpostgresqlflexibleservers.NewClientFactory("ffffffff-ffff-ffff-ffff-ffffffffffff", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewDbAgentsClient().BeginCreateOrUpdate(ctx, "exampleresourcegroup", "exampleserver", armpostgresqlflexibleservers.DbAgentForUpdate{
		Properties: &armpostgresqlflexibleservers.DbAgentForUpdateProperties{
			State: to.Ptr(armpostgresqlflexibleservers.DbAgentForUpdateStateEnabled),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to poll the result: %v", err)
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { PostgreSQLManagementFlexibleServerClient } = require("@azure/arm-postgresql-flexible");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to enables or disables the database agent for a flexible server.
 *
 * @summary enables or disables the database agent for a flexible server.
 * x-ms-original-file: 2026-07-01-preview/DBAgentUpdateEnable.json
 */
async function enableTheSingletonDefaultDatabaseAgentForAServer() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "ffffffff-ffff-ffff-ffff-ffffffffffff";
  const client = new PostgreSQLManagementFlexibleServerClient(credential, subscriptionId);
  const result = await client.dbAgents.createOrUpdate("exampleresourcegroup", "exampleserver", {
    properties: { state: "Enabled" },
  });
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

202

Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/eastus/azureAsyncOperation/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa?api-version=2026-07-01-preview
Location: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/eastus/operationResults/bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb?api-version=2026-07-01-preview

{
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/exampleserver/dbAgents/Default",
  "name": "Default",
  "type": "Microsoft.DBforPostgreSQL/flexibleServers/dbAgents",
  "properties": {
    "state": "Enabling",
    "provisioningState": "InProgress",
    "lastModifiedTime": "2026-08-28T15:30:00Z"
  }
}

Definitions

Name	Description
createdByType	The type of identity that created the resource.
DbAgent	The database agent configuration for a PostgreSQL flexible server.
DbAgentForUpdate	A request to enable or disable the database agent.
DbAgentForUpdateProperties	Writable properties of the database agent configuration.
DbAgentForUpdateState	The database agent states accepted in a write request.
DbAgentProperties	Properties of the database agent configuration.
DbAgentProvisioningState	The provisioning state of the database agent resource.
DbAgentState	The state of the database agent.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
systemData	Metadata pertaining to creation and last modification of the resource.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

DbAgent

Object

The database agent configuration for a PostgreSQL flexible server.

Name	Type	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	DbAgentProperties	The resource-specific properties for this resource.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

DbAgentForUpdate

Object

A request to enable or disable the database agent.

Name	Type	Description
properties	DbAgentForUpdateProperties	The requested database agent properties.

DbAgentForUpdateProperties

Object

Writable properties of the database agent configuration.

Name	Type	Description
state	DbAgentForUpdateState	The requested state of the database agent.

DbAgentForUpdateState

Enumeration

The database agent states accepted in a write request.

Value	Description
Enabled	Enable the database agent.
Disabled	Disable the database agent.

DbAgentProperties

Object

Properties of the database agent configuration.

Name	Type	Description
lastModifiedTime	string (date-time)	The time when the database agent configuration was last modified.
provisioningState	DbAgentProvisioningState	The provisioning state of the database agent resource.
state	DbAgentState	The state of the database agent.

DbAgentProvisioningState

Enumeration

The provisioning state of the database agent resource.

Value	Description
Succeeded	Resource has been created.
Failed	Resource creation failed.
Canceled	Resource creation was canceled.
InProgress	The database agent lifecycle operation is in progress.

DbAgentState

Enumeration

The state of the database agent.

Value	Description
Enabling	The database agent is being enabled.
Enabled	The database agent is enabled.
Disabling	The database agent is being disabled.
Disabled	The database agent is disabled.
Failed	The database agent lifecycle operation failed.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.