Servers - Update

Služba:

PostgreSQL

Verze rozhraní API:

2024-11-01-preview

Aktualizuje existující server. Tělo požadavku může obsahovat jednu až mnoho vlastností, které jsou přítomné v normální definici serveru.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}?api-version=2024-11-01-preview

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
resourceGroupName	path	True	string	Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
serverName	path	True	string	Název serveru. Vzor regulárního výrazu: ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*
subscriptionId	path	True	string uuid	ID cílového předplatného. Hodnota musí být UUID.
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name	Typ	Description
parameters	ServerForUpdate	Požadované parametry pro aktualizaci serveru.

Odpovědi

Name	Typ	Description
200 OK	Server	OK
202 Accepted		Přijal Hlavičky Location: string
Other Status Codes	ErrorResponse	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

Promote a replica server as a Standalone server as forced, i.e. it will promote a replica server immediately without waiting for primary and replica to be in sync.

Promote a replica server as a Standalone server as planned, i.e. it will wait for replication to complete.

ServerUpdate

ServerUpdateWithAadAuthEnabled

ServerUpdateWithCustomerMaintenanceWindow

ServerUpdateWithDataEncryptionEnabled

ServerUpdateWithMajorVersionUpgrade

SwitchOver a replica server as forced, i.e. it will replica as Primary and original primary as replica immediately without waiting for primary and replica to be in sync.

SwitchOver a replica server as planned, i.e. it will wait for replication to complete before promoting replica as Primary and original primary as replica.

Promote a replica server as a Standalone server as forced, i.e. it will promote a replica server immediately without waiting for primary and replica to be in sync.

Ukázkový požadavek

HTTP

PATCH https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testResourceGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4-replica?api-version=2024-11-01-preview

{
  "properties": {
    "replica": {
      "promoteMode": "standalone",
      "promoteOption": "forced"
    }
  }
}

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.postgresqlflexibleservers import PostgreSQLManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-postgresqlflexibleservers
# USAGE
    python promote_replica_as_forced_standalone_server.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="ffffffff-ffff-ffff-ffff-ffffffffffff",
    )

    response = client.servers.begin_update(
        resource_group_name="testResourceGroup",
        server_name="pgtestsvc4-replica",
        parameters={"properties": {"replica": {"promoteMode": "standalone", "promoteOption": "forced"}}},
    ).result()
    print(response)


# x-ms-original-file: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2024-11-01-preview/examples/PromoteReplicaAsForcedStandaloneServer.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

Ukázková odpověď

Stavový kód:

200

{
  "sku": {
    "name": "Standard_D8s_v3",
    "tier": "GeneralPurpose"
  },
  "properties": {
    "fullyQualifiedDomainName": "pgtestsvc4-replica.postgres.database.azure.com",
    "version": "12",
    "minorVersion": "6",
    "administratorLogin": "cloudsa",
    "state": "Ready",
    "availabilityZone": "1",
    "dataEncryption": {
      "type": "SystemManaged"
    },
    "authConfig": {
      "activeDirectoryAuth": "Disabled",
      "passwordAuth": "Enabled"
    },
    "storage": {
      "storageSizeGB": 1024,
      "autoGrow": "Enabled",
      "tier": "P30",
      "iops": 5000
    },
    "backup": {
      "backupRetentionDays": 20,
      "geoRedundantBackup": "Disabled",
      "earliestRestoreDate": "2021-05-26T01:16:58.3723361+00:00"
    },
    "network": {
      "publicNetworkAccess": "Disabled",
      "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet",
      "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com"
    },
    "highAvailability": {
      "mode": "ZoneRedundant",
      "state": "Healthy",
      "standbyAvailabilityZone": "2"
    },
    "maintenanceWindow": {
      "customWindow": "Disabled",
      "dayOfWeek": 0,
      "startHour": 0,
      "startMinute": 0
    },
    "replica": {
      "role": "None",
      "capacity": 0
    }
  },
  "location": "westus",
  "tags": {
    "ElasticServer": "1"
  },
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4-replica",
  "name": "pgtestsvc4-replica",
  "type": "Microsoft.DBforPostgreSQL/flexibleServers"
}

Stavový kód:

202

Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-11-01-preview
Location: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-11-01-preview

Promote a replica server as a Standalone server as planned, i.e. it will wait for replication to complete.

Ukázkový požadavek

HTTP

PATCH https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testResourceGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4-replica?api-version=2024-11-01-preview

{
  "properties": {
    "replica": {
      "promoteMode": "standalone",
      "promoteOption": "planned"
    }
  }
}

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.postgresqlflexibleservers import PostgreSQLManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-postgresqlflexibleservers
# USAGE
    python promote_replica_as_planned_standalone_server.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="ffffffff-ffff-ffff-ffff-ffffffffffff",
    )

    response = client.servers.begin_update(
        resource_group_name="testResourceGroup",
        server_name="pgtestsvc4-replica",
        parameters={"properties": {"replica": {"promoteMode": "standalone", "promoteOption": "planned"}}},
    ).result()
    print(response)


# x-ms-original-file: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2024-11-01-preview/examples/PromoteReplicaAsPlannedStandaloneServer.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

Ukázková odpověď

Stavový kód:

200

{
  "sku": {
    "name": "Standard_D8s_v3",
    "tier": "GeneralPurpose"
  },
  "properties": {
    "fullyQualifiedDomainName": "pgtestsvc4-replica.postgres.database.azure.com",
    "version": "12",
    "minorVersion": "6",
    "administratorLogin": "cloudsa",
    "state": "Ready",
    "availabilityZone": "1",
    "dataEncryption": {
      "type": "SystemManaged"
    },
    "authConfig": {
      "activeDirectoryAuth": "Disabled",
      "passwordAuth": "Enabled"
    },
    "storage": {
      "storageSizeGB": 1024,
      "autoGrow": "Enabled",
      "tier": "P30",
      "iops": 5000
    },
    "backup": {
      "backupRetentionDays": 20,
      "geoRedundantBackup": "Disabled",
      "earliestRestoreDate": "2021-05-26T01:16:58.3723361+00:00"
    },
    "network": {
      "publicNetworkAccess": "Disabled",
      "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet",
      "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com"
    },
    "highAvailability": {
      "mode": "ZoneRedundant",
      "state": "Healthy",
      "standbyAvailabilityZone": "2"
    },
    "maintenanceWindow": {
      "customWindow": "Disabled",
      "dayOfWeek": 0,
      "startHour": 0,
      "startMinute": 0
    },
    "replica": {
      "role": "None",
      "capacity": 0
    }
  },
  "location": "westus",
  "tags": {
    "ElasticServer": "1"
  },
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4-replica",
  "name": "pgtestsvc4-replica",
  "type": "Microsoft.DBforPostgreSQL/flexibleServers"
}

Stavový kód:

202

Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-11-01-preview
Location: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-11-01-preview

ServerUpdate

Ukázkový požadavek

HTTP

PATCH https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4?api-version=2024-11-01-preview

{
  "sku": {
    "tier": "GeneralPurpose",
    "name": "Standard_D8s_v3"
  },
  "properties": {
    "administratorLoginPassword": "newpassword",
    "createMode": "Update",
    "storage": {
      "storageSizeGB": 1024,
      "autoGrow": "Enabled",
      "tier": "P30"
    },
    "backup": {
      "backupRetentionDays": 20
    }
  }
}

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.postgresqlflexibleservers import PostgreSQLManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-postgresqlflexibleservers
# USAGE
    python server_update.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="ffffffff-ffff-ffff-ffff-ffffffffffff",
    )

    response = client.servers.begin_update(
        resource_group_name="TestGroup",
        server_name="pgtestsvc4",
        parameters={
            "properties": {
                "administratorLoginPassword": "newpassword",
                "backup": {"backupRetentionDays": 20},
                "createMode": "Update",
                "storage": {"autoGrow": "Enabled", "storageSizeGB": 1024, "tier": "P30"},
            },
            "sku": {"name": "Standard_D8s_v3", "tier": "GeneralPurpose"},
        },
    ).result()
    print(response)


# x-ms-original-file: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2024-11-01-preview/examples/ServerUpdate.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

Ukázková odpověď

Stavový kód:

200

{
  "sku": {
    "name": "Standard_D8s_v3",
    "tier": "GeneralPurpose"
  },
  "properties": {
    "fullyQualifiedDomainName": "c7d7483a8ceb.test-private-dns-zone.postgres.database.azure.com",
    "version": "12",
    "minorVersion": "6",
    "administratorLogin": "cloudsa",
    "state": "Ready",
    "availabilityZone": "1",
    "dataEncryption": {
      "type": "SystemManaged"
    },
    "authConfig": {
      "activeDirectoryAuth": "Disabled",
      "passwordAuth": "Enabled"
    },
    "storage": {
      "storageSizeGB": 1024,
      "autoGrow": "Enabled",
      "tier": "P30",
      "iops": 5000
    },
    "backup": {
      "backupRetentionDays": 20,
      "geoRedundantBackup": "Disabled",
      "earliestRestoreDate": "2021-05-26T01:16:58.3723361+00:00"
    },
    "network": {
      "publicNetworkAccess": "Disabled",
      "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet",
      "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com"
    },
    "highAvailability": {
      "mode": "ZoneRedundant",
      "state": "Healthy",
      "standbyAvailabilityZone": "2"
    },
    "maintenanceWindow": {
      "customWindow": "Disabled",
      "dayOfWeek": 0,
      "startHour": 0,
      "startMinute": 0
    }
  },
  "location": "westus",
  "tags": {
    "ElasticServer": "1"
  },
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4",
  "name": "pgtestsvc4",
  "type": "Microsoft.DBforPostgreSQL/flexibleServers"
}

Stavový kód:

202

Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-11-01-preview
Location: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-11-01-preview

ServerUpdateWithAadAuthEnabled

Ukázkový požadavek

HTTP

PATCH https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4?api-version=2024-11-01-preview

{
  "sku": {
    "tier": "GeneralPurpose",
    "name": "Standard_D8s_v3"
  },
  "properties": {
    "administratorLoginPassword": "newpassword",
    "createMode": "Update",
    "authConfig": {
      "activeDirectoryAuth": "Enabled",
      "passwordAuth": "Enabled",
      "tenantId": "tttttt-tttt-tttt-tttt-tttttttttttt"
    },
    "storage": {
      "storageSizeGB": 1024,
      "autoGrow": "Disabled",
      "tier": "P30"
    },
    "backup": {
      "backupRetentionDays": 20
    }
  }
}

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.postgresqlflexibleservers import PostgreSQLManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-postgresqlflexibleservers
# USAGE
    python server_update_with_aad_auth_enabled.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="ffffffff-ffff-ffff-ffff-ffffffffffff",
    )

    response = client.servers.begin_update(
        resource_group_name="TestGroup",
        server_name="pgtestsvc4",
        parameters={
            "properties": {
                "administratorLoginPassword": "newpassword",
                "authConfig": {
                    "activeDirectoryAuth": "Enabled",
                    "passwordAuth": "Enabled",
                    "tenantId": "tttttt-tttt-tttt-tttt-tttttttttttt",
                },
                "backup": {"backupRetentionDays": 20},
                "createMode": "Update",
                "storage": {"autoGrow": "Disabled", "storageSizeGB": 1024, "tier": "P30"},
            },
            "sku": {"name": "Standard_D8s_v3", "tier": "GeneralPurpose"},
        },
    ).result()
    print(response)


# x-ms-original-file: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2024-11-01-preview/examples/ServerUpdateWithAadAuthEnabled.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

Ukázková odpověď

Stavový kód:

200

{
  "sku": {
    "name": "Standard_D8s_v3",
    "tier": "GeneralPurpose"
  },
  "properties": {
    "fullyQualifiedDomainName": "c7d7483a8ceb.test-private-dns-zone.postgres.database.azure.com",
    "version": "12",
    "minorVersion": "6",
    "administratorLogin": "cloudsa",
    "state": "Ready",
    "availabilityZone": "1",
    "dataEncryption": {
      "type": "SystemManaged"
    },
    "authConfig": {
      "activeDirectoryAuth": "Enabled",
      "passwordAuth": "Enabled",
      "tenantId": "tttttt-tttt-tttt-tttt-tttttttttttt"
    },
    "storage": {
      "storageSizeGB": 1024,
      "autoGrow": "Disabled",
      "tier": "P30",
      "iops": 5000
    },
    "backup": {
      "backupRetentionDays": 20,
      "geoRedundantBackup": "Disabled",
      "earliestRestoreDate": "2021-05-26T01:16:58.3723361+00:00"
    },
    "network": {
      "publicNetworkAccess": "Disabled",
      "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet",
      "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com"
    },
    "highAvailability": {
      "mode": "ZoneRedundant",
      "state": "Healthy",
      "standbyAvailabilityZone": "2"
    },
    "maintenanceWindow": {
      "customWindow": "Disabled",
      "dayOfWeek": 0,
      "startHour": 0,
      "startMinute": 0
    }
  },
  "location": "westus",
  "tags": {
    "ElasticServer": "1"
  },
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4",
  "name": "pgtestsvc4",
  "type": "Microsoft.DBforPostgreSQL/flexibleServers"
}

Stavový kód:

202

Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-11-01-preview
Location: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-11-01-preview

ServerUpdateWithCustomerMaintenanceWindow

Ukázkový požadavek

HTTP

PATCH https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4?api-version=2024-11-01-preview

{
  "properties": {
    "createMode": "Update",
    "maintenanceWindow": {
      "customWindow": "Enabled",
      "dayOfWeek": 0,
      "startHour": 8,
      "startMinute": 0
    }
  }
}

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.postgresqlflexibleservers import PostgreSQLManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-postgresqlflexibleservers
# USAGE
    python server_update_with_customer_maintenance_window.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="ffffffff-ffff-ffff-ffff-ffffffffffff",
    )

    response = client.servers.begin_update(
        resource_group_name="testrg",
        server_name="pgtestsvc4",
        parameters={
            "properties": {
                "createMode": "Update",
                "maintenanceWindow": {"customWindow": "Enabled", "dayOfWeek": 0, "startHour": 8, "startMinute": 0},
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2024-11-01-preview/examples/ServerUpdateWithCustomerMaintenanceWindow.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

Ukázková odpověď

Stavový kód:

200

{
  "sku": {
    "name": "Standard_D4s_v3",
    "tier": "GeneralPurpose"
  },
  "properties": {
    "fullyQualifiedDomainName": "c7d7483a8ceb.test-private-dns-zone.postgres.database.azure.com",
    "version": "12",
    "minorVersion": "6",
    "administratorLogin": "cloudsa",
    "state": "Ready",
    "availabilityZone": "1",
    "storage": {
      "storageSizeGB": 512,
      "autoGrow": "Disabled",
      "tier": "P20",
      "iops": 2300
    },
    "dataEncryption": {
      "type": "SystemManaged"
    },
    "authConfig": {
      "activeDirectoryAuth": "Disabled",
      "passwordAuth": "Enabled"
    },
    "backup": {
      "backupRetentionDays": 7,
      "geoRedundantBackup": "Disabled",
      "earliestRestoreDate": "2021-05-26T01:16:58.3723361+00:00"
    },
    "network": {
      "publicNetworkAccess": "Disabled",
      "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet",
      "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com"
    },
    "highAvailability": {
      "mode": "ZoneRedundant",
      "state": "Healthy",
      "standbyAvailabilityZone": "2"
    },
    "maintenanceWindow": {
      "customWindow": "Enabled",
      "dayOfWeek": 0,
      "startHour": 8,
      "startMinute": 0
    }
  },
  "location": "westus",
  "tags": {
    "ElasticServer": "1"
  },
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4",
  "name": "pgtestsvc4",
  "type": "Microsoft.DBforPostgreSQL/flexibleServers"
}

Stavový kód:

202

Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-11-01-preview
Location: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-11-01-preview

ServerUpdateWithDataEncryptionEnabled

Ukázkový požadavek

HTTP

PATCH https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4?api-version=2024-11-01-preview

{
  "sku": {
    "tier": "GeneralPurpose",
    "name": "Standard_D8s_v3"
  },
  "identity": {
    "userAssignedIdentities": {
      "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-usermanagedidentity": {},
      "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-geo-usermanagedidentity": {}
    },
    "type": "UserAssigned"
  },
  "properties": {
    "administratorLoginPassword": "newpassword",
    "createMode": "Update",
    "dataEncryption": {
      "type": "AzureKeyVault",
      "primaryKeyURI": "https://test-kv.vault.azure.net/keys/test-key1/77f57315bab34b0189daa113fbc78787",
      "primaryUserAssignedIdentityId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-usermanagedidentity",
      "geoBackupKeyURI": "https://test-geo-kv.vault.azure.net/keys/test-key1/66f57315bab34b0189daa113fbc78787",
      "geoBackupUserAssignedIdentityId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-geo-usermanagedidentity"
    },
    "backup": {
      "backupRetentionDays": 20
    }
  }
}

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.postgresqlflexibleservers import PostgreSQLManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-postgresqlflexibleservers
# USAGE
    python server_update_with_data_encryption_enabled.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="ffffffff-ffff-ffff-ffff-ffffffffffff",
    )

    response = client.servers.begin_update(
        resource_group_name="TestGroup",
        server_name="pgtestsvc4",
        parameters={
            "identity": {
                "type": "UserAssigned",
                "userAssignedIdentities": {
                    "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-geo-usermanagedidentity": {},
                    "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-usermanagedidentity": {},
                },
            },
            "properties": {
                "administratorLoginPassword": "newpassword",
                "backup": {"backupRetentionDays": 20},
                "createMode": "Update",
                "dataEncryption": {
                    "geoBackupKeyURI": "https://test-geo-kv.vault.azure.net/keys/test-key1/66f57315bab34b0189daa113fbc78787",
                    "geoBackupUserAssignedIdentityId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-geo-usermanagedidentity",
                    "primaryKeyURI": "https://test-kv.vault.azure.net/keys/test-key1/77f57315bab34b0189daa113fbc78787",
                    "primaryUserAssignedIdentityId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-usermanagedidentity",
                    "type": "AzureKeyVault",
                },
            },
            "sku": {"name": "Standard_D8s_v3", "tier": "GeneralPurpose"},
        },
    ).result()
    print(response)


# x-ms-original-file: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2024-11-01-preview/examples/ServerUpdateWithDataEncryptionEnabled.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

Ukázková odpověď

Stavový kód:

200

{
  "sku": {
    "name": "Standard_D8s_v3",
    "tier": "GeneralPurpose"
  },
  "identity": {
    "userAssignedIdentities": {
      "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-usermanagedidentity": {
        "principalId": "0a4e0c6e-7751-4078-ae1f-a477306c11e9",
        "clientId": "72f988bf-86f1-41af-91ab-2d7cd011db47"
      },
      "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-usermanagedidentity-1": {
        "principalId": "90008082-e024-4cc3-8fcf-63bcdb9cf6b6",
        "clientId": "72f988bf-86f1-41af-91ab-2d7cd011db47"
      },
      "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-geo-usermanagedidentity": {
        "principalId": "0a4e0c6e-7751-4078-ae1f-a477306c11e9",
        "clientId": "72f988bf-86f1-41af-91ab-2d7cd011db47"
      }
    },
    "type": "UserAssigned"
  },
  "properties": {
    "fullyQualifiedDomainName": "c7d7483a8ceb.test-private-dns-zone.postgres.database.azure.com",
    "version": "12",
    "minorVersion": "6",
    "administratorLogin": "cloudsa",
    "state": "Ready",
    "availabilityZone": "1",
    "authConfig": {
      "activeDirectoryAuth": "Disabled",
      "passwordAuth": "Enabled"
    },
    "dataEncryption": {
      "type": "AzureKeyVault",
      "primaryKeyURI": "https://test-kv.vault.azure.net/keys/test-key1/77f57315bab34b0189daa113fbc78787",
      "primaryUserAssignedIdentityId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-usermanagedidentity",
      "geoBackupKeyURI": "https://test-geo-kv.vault.azure.net/keys/test-key1/66f57315bab34b0189daa113fbc78787",
      "geoBackupUserAssignedIdentityId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-geo-usermanagedidentity",
      "primaryEncryptionKeyStatus": "Valid",
      "geoBackupEncryptionKeyStatus": "Valid"
    },
    "storage": {
      "storageSizeGB": 1024,
      "autoGrow": "Disabled",
      "tier": "P30",
      "iops": 5000
    },
    "backup": {
      "backupRetentionDays": 20,
      "geoRedundantBackup": "Enabled",
      "earliestRestoreDate": "2021-05-26T01:16:58.3723361+00:00"
    },
    "network": {
      "publicNetworkAccess": "Disabled",
      "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet",
      "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com"
    },
    "highAvailability": {
      "mode": "ZoneRedundant",
      "state": "Healthy",
      "standbyAvailabilityZone": "2"
    },
    "maintenanceWindow": {
      "customWindow": "Disabled",
      "dayOfWeek": 0,
      "startHour": 0,
      "startMinute": 0
    }
  },
  "location": "westus",
  "tags": {
    "ElasticServer": "1"
  },
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4",
  "name": "pgtestsvc4",
  "type": "Microsoft.DBforPostgreSQL/flexibleServers"
}

Stavový kód:

202

Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-11-01-preview
Location: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-11-01-preview

ServerUpdateWithMajorVersionUpgrade

Ukázkový požadavek

HTTP

PATCH https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4?api-version=2024-11-01-preview

{
  "properties": {
    "createMode": "Update",
    "version": "14"
  }
}

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.postgresqlflexibleservers import PostgreSQLManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-postgresqlflexibleservers
# USAGE
    python server_update_with_major_version_upgrade.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="ffffffff-ffff-ffff-ffff-ffffffffffff",
    )

    response = client.servers.begin_update(
        resource_group_name="testrg",
        server_name="pgtestsvc4",
        parameters={"properties": {"createMode": "Update", "version": "14"}},
    ).result()
    print(response)


# x-ms-original-file: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2024-11-01-preview/examples/ServerUpdateWithMajorVersionUpgrade.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

Ukázková odpověď

Stavový kód:

200

{
  "sku": {
    "name": "Standard_D4s_v3",
    "tier": "GeneralPurpose"
  },
  "properties": {
    "fullyQualifiedDomainName": "c7d7483a8ceb.test-private-dns-zone.postgres.database.azure.com",
    "version": "14",
    "minorVersion": "6",
    "administratorLogin": "cloudsa",
    "state": "Ready",
    "availabilityZone": "1",
    "storage": {
      "storageSizeGB": 512,
      "autoGrow": "Enabled",
      "tier": "P20",
      "iops": 2300
    },
    "dataEncryption": {
      "type": "SystemManaged"
    },
    "authConfig": {
      "activeDirectoryAuth": "Disabled",
      "passwordAuth": "Enabled"
    },
    "backup": {
      "backupRetentionDays": 7,
      "geoRedundantBackup": "Disabled",
      "earliestRestoreDate": "2021-05-26T01:16:58.3723361+00:00"
    },
    "network": {
      "publicNetworkAccess": "Disabled",
      "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet",
      "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com"
    },
    "highAvailability": {
      "mode": "ZoneRedundant",
      "state": "Healthy",
      "standbyAvailabilityZone": "2"
    },
    "maintenanceWindow": {
      "customWindow": "Disabled",
      "dayOfWeek": 0,
      "startHour": 0,
      "startMinute": 0
    }
  },
  "location": "westus",
  "tags": {
    "ElasticServer": "1"
  },
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4",
  "name": "pgtestsvc4",
  "type": "Microsoft.DBforPostgreSQL/flexibleServers"
}

Stavový kód:

202

Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-11-01-preview
Location: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-11-01-preview

SwitchOver a replica server as forced, i.e. it will replica as Primary and original primary as replica immediately without waiting for primary and replica to be in sync.

Ukázkový požadavek

HTTP

PATCH https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testResourceGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4-replica?api-version=2024-11-01-preview

{
  "properties": {
    "replica": {
      "promoteMode": "switchover",
      "promoteOption": "forced"
    }
  }
}

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.postgresqlflexibleservers import PostgreSQLManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-postgresqlflexibleservers
# USAGE
    python promote_replica_as_forced_switchover.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="ffffffff-ffff-ffff-ffff-ffffffffffff",
    )

    response = client.servers.begin_update(
        resource_group_name="testResourceGroup",
        server_name="pgtestsvc4-replica",
        parameters={"properties": {"replica": {"promoteMode": "switchover", "promoteOption": "forced"}}},
    ).result()
    print(response)


# x-ms-original-file: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2024-11-01-preview/examples/PromoteReplicaAsForcedSwitchover.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

Ukázková odpověď

Stavový kód:

200

{
  "sku": {
    "name": "Standard_D8s_v3",
    "tier": "GeneralPurpose"
  },
  "properties": {
    "fullyQualifiedDomainName": "pgtestsvc4-replica.postgres.database.azure.com",
    "version": "12",
    "minorVersion": "6",
    "administratorLogin": "cloudsa",
    "state": "Ready",
    "availabilityZone": "1",
    "dataEncryption": {
      "type": "SystemManaged"
    },
    "authConfig": {
      "activeDirectoryAuth": "Disabled",
      "passwordAuth": "Enabled"
    },
    "storage": {
      "storageSizeGB": 1024,
      "autoGrow": "Enabled",
      "tier": "P30",
      "iops": 5000
    },
    "backup": {
      "backupRetentionDays": 20,
      "geoRedundantBackup": "Disabled",
      "earliestRestoreDate": "2021-05-26T01:16:58.3723361+00:00"
    },
    "network": {
      "publicNetworkAccess": "Disabled",
      "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet",
      "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com"
    },
    "highAvailability": {
      "mode": "ZoneRedundant",
      "state": "Healthy",
      "standbyAvailabilityZone": "2"
    },
    "maintenanceWindow": {
      "customWindow": "Disabled",
      "dayOfWeek": 0,
      "startHour": 0,
      "startMinute": 0
    },
    "replica": {
      "role": "Primary",
      "capacity": 5
    }
  },
  "location": "westus",
  "tags": {
    "ElasticServer": "1"
  },
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4-replica",
  "name": "pgtestsvc4-replica",
  "type": "Microsoft.DBforPostgreSQL/flexibleServers"
}

Stavový kód:

202

Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-11-01-preview
Location: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-11-01-preview

SwitchOver a replica server as planned, i.e. it will wait for replication to complete before promoting replica as Primary and original primary as replica.

Ukázkový požadavek

HTTP

PATCH https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testResourceGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4-replica?api-version=2024-11-01-preview

{
  "properties": {
    "replica": {
      "promoteMode": "switchover",
      "promoteOption": "planned"
    }
  }
}

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.postgresqlflexibleservers import PostgreSQLManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-postgresqlflexibleservers
# USAGE
    python promote_replica_as_planned_switchover.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="ffffffff-ffff-ffff-ffff-ffffffffffff",
    )

    response = client.servers.begin_update(
        resource_group_name="testResourceGroup",
        server_name="pgtestsvc4-replica",
        parameters={"properties": {"replica": {"promoteMode": "switchover", "promoteOption": "planned"}}},
    ).result()
    print(response)


# x-ms-original-file: specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2024-11-01-preview/examples/PromoteReplicaAsPlannedSwitchover.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

Ukázková odpověď

Stavový kód:

200

{
  "sku": {
    "name": "Standard_D8s_v3",
    "tier": "GeneralPurpose"
  },
  "properties": {
    "fullyQualifiedDomainName": "pgtestsvc4-replica.postgres.database.azure.com",
    "version": "12",
    "minorVersion": "6",
    "administratorLogin": "cloudsa",
    "state": "Ready",
    "availabilityZone": "1",
    "dataEncryption": {
      "type": "SystemManaged"
    },
    "authConfig": {
      "activeDirectoryAuth": "Disabled",
      "passwordAuth": "Enabled"
    },
    "storage": {
      "storageSizeGB": 1024,
      "autoGrow": "Enabled",
      "tier": "P30",
      "iops": 5000
    },
    "backup": {
      "backupRetentionDays": 20,
      "geoRedundantBackup": "Disabled",
      "earliestRestoreDate": "2021-05-26T01:16:58.3723361+00:00"
    },
    "network": {
      "publicNetworkAccess": "Disabled",
      "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet",
      "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com"
    },
    "highAvailability": {
      "mode": "ZoneRedundant",
      "state": "Healthy",
      "standbyAvailabilityZone": "2"
    },
    "maintenanceWindow": {
      "customWindow": "Disabled",
      "dayOfWeek": 0,
      "startHour": 0,
      "startMinute": 0
    },
    "replica": {
      "role": "Primary",
      "capacity": 5
    }
  },
  "location": "westus",
  "tags": {
    "ElasticServer": "1"
  },
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4-replica",
  "name": "pgtestsvc4-replica",
  "type": "Microsoft.DBforPostgreSQL/flexibleServers"
}

Stavový kód:

202

Azure-AsyncOperation: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-11-01-preview
Location: https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-11-01-preview

Definice

Name	Description
activeDirectoryAuthEnum	Pokud je povoleno, je povolené ověřování Azure Active Directory.
ArmServerKeyType	Typ šifrování dat, který se má znázornit, pokud se jedná o službu System Managed vs. Azure Key Vault.
AuthConfig	Vlastnosti AuthConfig serveru
AzureManagedDiskPerformanceTiers	Název úrovně úložiště pro IOPS
Backup	Vlastnosti zálohování serveru
Cluster	Vlastnosti clusteru serveru
createdByType	Typ identity, která prostředek vytvořila.
CreateMode	Režim vytvoření nového serveru PostgreSQL.
CreateModeForUpdate	Režim aktualizace nového serveru PostgreSQL.
DataEncryption	Vlastnosti šifrování dat serveru
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
GeoRedundantBackupEnum	Hodnota označující, zda je na serveru povolená Geo-Redundant zálohování.
HighAvailability	Vlastnosti vysoké dostupnosti serveru
HighAvailabilityMode	Režim vysoké dostupnosti pro server.
IdentityType	typy identit přidružených k tomuto prostředku
keyStatusEnum	Stav primárního šifrovacího klíče pro server s povoleným šifrováním dat
MaintenanceWindow	Vlastnosti časového období údržby serveru
Network	Vlastnosti sítě serveru Tato vlastnost Sítě se musí předávat pouze v případě, že chcete, aby server byl serverem privátního přístupu.
passwordAuthEnum	Pokud je povoleno, je povolené ověřování heslem.
PrivateEndpoint	Prostředek privátního koncového bodu.
PrivateEndpointConnection	Seznam připojení privátních koncových bodů přidružených k zadanému prostředku
PrivateEndpointConnectionProvisioningState	Stav zřizování prostředku připojení privátního koncového bodu.
PrivateEndpointServiceConnectionStatus	Určuje, jestli bylo připojení schváleno, odmítnuto nebo odebráno vlastníkem služby.
PrivateLinkServiceConnectionState	Kolekce informací o stavu připojení mezi příjemcem služeb a poskytovatelem.
ReadReplicaPromoteMode	Nastaví režim povýšení pro server repliky. Toto je vlastnost jen pro zápis.
Replica	Vlastnosti repliky serveru Tyto vlastnosti repliky musí být předány pouze v případě, že chcete zvýšit úroveň serveru.
ReplicationPromoteOption	Nastaví možnosti zvýšení úrovně pro server repliky. Toto je vlastnost jen pro zápis.
ReplicationRole	Role replikace serveru
ReplicationState	Získá stav replikace serveru repliky. Tato vlastnost se vrátí pouze pro volání rozhraní API replik. Podporované hodnoty jsou Aktivní, Zachytávání, Zřizování, Aktualizace, Přerušeno, Změna konfigurace.
Server	Představuje server.
ServerForUpdate	Požadované parametry pro aktualizaci serveru.
ServerHAState	Stav serveru vysoké dostupnosti, který je viditelný pro uživatele.
ServerPublicNetworkAccessState	Přístup k veřejné síti je povolený nebo není
ServerState	Stav serveru, který je viditelný pro uživatele.
ServerVersion	Verze serveru PostgreSQL.
Sku	Skladová položka (cenová úroveň) serveru.
SkuTier	Úroveň konkrétní skladové položky, například nárazové.
Storage	Vlastnosti úložiště serveru
StorageAutoGrow	Příznak pro povolení nebo zakázání automatického zvětšování úložiště pro flexibilní server
StorageType	Typ úložiště pro server. Povolené hodnoty jsou Premium_LRS, PremiumV2_LRS a UltraSSD_LRS. Výchozí hodnota je Premium_LRS, pokud není zadána.
systemData	Metadata Azure Resource Manageru obsahující informace createdBy a modifiedBy
UserAssignedIdentity	Popisuje identitu aplikace.
UserIdentity	Popisuje jednu identitu přiřazenou uživatelem přidruženou k aplikaci.

activeDirectoryAuthEnum

Enumeration

Pokud je povoleno, je povolené ověřování Azure Active Directory.

Hodnota	Description
Disabled
Enabled

ArmServerKeyType

Enumeration

Typ šifrování dat, který se má znázornit, pokud se jedná o službu System Managed vs. Azure Key Vault.

Hodnota	Description
AzureKeyVault
SystemManaged

AuthConfig

Object

Vlastnosti AuthConfig serveru

Name	Typ	Default value	Description
activeDirectoryAuth	activeDirectoryAuthEnum		Pokud je povoleno, je povolené ověřování Azure Active Directory.
passwordAuth	passwordAuthEnum	Enabled	Pokud je povoleno, je povolené ověřování heslem.
tenantId	string		ID tenanta serveru.

AzureManagedDiskPerformanceTiers

Enumeration

Název úrovně úložiště pro IOPS

Hodnota	Description
P1
P10
P15
P2
P20
P3
P30
P4
P40
P50
P6
P60
P70
P80

Backup

Object

Vlastnosti zálohování serveru

Name	Typ	Default value	Description
backupRetentionDays	integer	7	Doba uchovávání záloh pro server.
earliestRestoreDate	string		Nejstarší formát bodu obnovení (ISO8601) pro server.
geoRedundantBackup	GeoRedundantBackupEnum	Disabled	Hodnota označující, zda je na serveru povolená Geo-Redundant zálohování.

Cluster

Object

Vlastnosti clusteru serveru

Name	Typ	Default value	Description
clusterSize	integer	0	Počet uzlů pro cluster.

createdByType

Enumeration

Typ identity, která prostředek vytvořila.

Hodnota	Description
Application
Key
ManagedIdentity
User

CreateMode

Enumeration

Režim vytvoření nového serveru PostgreSQL.

Hodnota	Description
Create
Default
GeoRestore
PointInTimeRestore
Replica
ReviveDropped
Update

CreateModeForUpdate

Enumeration

Režim aktualizace nového serveru PostgreSQL.

Hodnota	Description
Default
Update

DataEncryption

Object

Vlastnosti šifrování dat serveru

Name	Typ	Description
geoBackupEncryptionKeyStatus	keyStatusEnum	Stav šifrovacího klíče geografické zálohy pro server s povoleným šifrováním dat
geoBackupKeyURI	string	Identifikátor URI klíče v keyvault pro šifrování dat pro geografickou zálohu serveru.
geoBackupUserAssignedIdentityId	string	ID prostředku pro identitu přiřazenou uživatelem, která se má použít k šifrování dat pro geografickou zálohu serveru.
primaryEncryptionKeyStatus	keyStatusEnum	Stav primárního šifrovacího klíče pro server s povoleným šifrováním dat
primaryKeyURI	string	Identifikátor URI klíče v keyvault pro šifrování dat primárního serveru.
primaryUserAssignedIdentityId	string	ID prostředku pro identitu přiřazenou uživatelem, která se má použít k šifrování dat primárního serveru.
type	ArmServerKeyType	Typ šifrování dat, který se má znázornit, pokud se jedná o službu System Managed vs. Azure Key Vault.

ErrorAdditionalInfo

Object

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Object

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Object

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

GeoRedundantBackupEnum

Enumeration

Hodnota označující, zda je na serveru povolená Geo-Redundant zálohování.

Hodnota	Description
Disabled
Enabled

HighAvailability

Object

Vlastnosti vysoké dostupnosti serveru

Name	Typ	Default value	Description
mode	HighAvailabilityMode	Disabled	Režim vysoké dostupnosti pro server.
standbyAvailabilityZone	string		informace o zóně dostupnosti pohotovostního režimu.
state	ServerHAState		Stav serveru vysoké dostupnosti, který je viditelný pro uživatele.

HighAvailabilityMode

Enumeration

Režim vysoké dostupnosti pro server.

Hodnota	Description
Disabled
SameZone
ZoneRedundant

IdentityType

Enumeration

typy identit přidružených k tomuto prostředku

Hodnota	Description
None
SystemAssigned
UserAssigned

keyStatusEnum

Enumeration

Stav primárního šifrovacího klíče pro server s povoleným šifrováním dat

Hodnota	Description
Invalid
Valid

MaintenanceWindow

Object

Vlastnosti časového období údržby serveru

Name	Typ	Default value	Description
customWindow	string	Disabled	označuje, jestli je vlastní okno povolené nebo zakázané.
dayOfWeek	integer	0	den v týdnu pro časové období údržby
startHour	integer	0	počáteční hodina pro časové období údržby
startMinute	integer	0	počáteční minuta pro časové období údržby

Network

Object

Vlastnosti sítě serveru Tato vlastnost Sítě se musí předávat pouze v případě, že chcete, aby server byl serverem privátního přístupu.

Name	Typ	Description
delegatedSubnetResourceId	string	ID prostředku arm delegovaná podsíť To je potřeba předat během vytváření, v případě, že chceme, aby se server vložil do virtuální sítě, tj. server privátního přístupu. Během aktualizace to předejte jenom v případě, že chceme aktualizovat hodnotu zóny Privátní DNS.
privateDnsZoneArmResourceId	string	ID prostředku arm zóny privátního dns. To je potřeba předat během vytváření, v případě, že chceme, aby se server vložil do virtuální sítě, tj. server privátního přístupu. Během aktualizace to předejte jenom v případě, že chceme aktualizovat hodnotu zóny Privátní DNS.
publicNetworkAccess	ServerPublicNetworkAccessState	Přístup k veřejné síti je povolený nebo není

passwordAuthEnum

Enumeration

Pokud je povoleno, je povolené ověřování heslem.

Hodnota	Description
Disabled
Enabled

PrivateEndpoint

Object

Prostředek privátního koncového bodu.

Name	Typ	Description
id	string	Identifikátor ARM pro privátní koncový bod.

PrivateEndpointConnection

Object

Seznam připojení privátních koncových bodů přidružených k zadanému prostředku

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku pro prostředek. Například /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Název prostředku
properties.groupIds	string[]	ID skupiny pro prostředek privátního koncového bodu.
properties.privateEndpoint	PrivateEndpoint	Prostředek privátního koncového bodu.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Kolekce informací o stavu připojení mezi příjemcem služeb a poskytovatelem.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Stav zřizování prostředku připojení privátního koncového bodu.
systemData	systemData	Metadata Azure Resource Manageru obsahující informace createdBy a modifiedBy
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

PrivateEndpointConnectionProvisioningState

Enumeration

Stav zřizování prostředku připojení privátního koncového bodu.

Hodnota	Description
Creating
Deleting
Failed
Succeeded

PrivateEndpointServiceConnectionStatus

Enumeration

Určuje, jestli bylo připojení schváleno, odmítnuto nebo odebráno vlastníkem služby.

Hodnota	Description
Approved
Pending
Rejected

PrivateLinkServiceConnectionState

Object

Kolekce informací o stavu připojení mezi příjemcem služeb a poskytovatelem.

Name	Typ	Description
actionsRequired	string	Zpráva, která indikuje, jestli změny poskytovatele služeb vyžadují aktualizace příjemce.
description	string	Důvod schválení nebo zamítnutí připojení.
status	PrivateEndpointServiceConnectionStatus	Určuje, jestli bylo připojení schváleno, odmítnuto nebo odebráno vlastníkem služby.

ReadReplicaPromoteMode

Enumeration

Nastaví režim povýšení pro server repliky. Toto je vlastnost jen pro zápis.

Hodnota	Description
standalone
switchover

Replica

Object

Vlastnosti repliky serveru Tyto vlastnosti repliky musí být předány pouze v případě, že chcete zvýšit úroveň serveru.

Name	Typ	Description
capacity	integer	Repliky povolené pro server
promoteMode	ReadReplicaPromoteMode	Nastaví režim povýšení pro server repliky. Toto je vlastnost jen pro zápis.
promoteOption	ReplicationPromoteOption	Nastaví možnosti zvýšení úrovně pro server repliky. Toto je vlastnost jen pro zápis.
replicationState	ReplicationState	Získá stav replikace serveru repliky. Tato vlastnost se vrátí pouze pro volání rozhraní API replik. Podporované hodnoty jsou Aktivní, Zachytávání, Zřizování, Aktualizace, Přerušeno, Změna konfigurace.
role	ReplicationRole	Slouží k označení role serveru v sadě replikace.

ReplicationPromoteOption

Enumeration

Nastaví možnosti zvýšení úrovně pro server repliky. Toto je vlastnost jen pro zápis.

Hodnota	Description
forced
planned

ReplicationRole

Enumeration

Role replikace serveru

Hodnota	Description
AsyncReplica
GeoAsyncReplica
None
Primary

ReplicationState

Enumeration

Získá stav replikace serveru repliky. Tato vlastnost se vrátí pouze pro volání rozhraní API replik. Podporované hodnoty jsou Aktivní, Zachytávání, Zřizování, Aktualizace, Přerušeno, Změna konfigurace.

Hodnota	Description
Active
Broken
Catchup
Provisioning
Reconfiguring
Updating

Server

Object

Představuje server.

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku pro prostředek. Například /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	UserAssignedIdentity	Popisuje identitu aplikace.
location	string	Geografické umístění, ve kterém se nachází zdroj
name	string	Název prostředku
properties.administratorLogin	string	Přihlašovací jméno serveru správce. Je možné zadat pouze při vytváření serveru (a vyžaduje se k vytvoření).
properties.administratorLoginPassword	string	Přihlašovací heslo správce (vyžaduje se k vytvoření serveru).
properties.authConfig	AuthConfig	Vlastnosti AuthConfig serveru
properties.availabilityZone	string	informace o zóně dostupnosti serveru.
properties.backup	Backup	Vlastnosti zálohování serveru
properties.cluster	Cluster	Vlastnosti clusteru serveru
properties.createMode	CreateMode	Režim vytvoření nového serveru PostgreSQL.
properties.dataEncryption	DataEncryption	Vlastnosti šifrování dat serveru
properties.fullyQualifiedDomainName	string	Plně kvalifikovaný název domény serveru.
properties.highAvailability	HighAvailability	Vlastnosti vysoké dostupnosti serveru
properties.maintenanceWindow	MaintenanceWindow	Vlastnosti časového období údržby serveru
properties.minorVersion	string	Podverze serveru.
properties.network	Network	Vlastnosti sítě serveru Tato vlastnost Sítě se musí předávat pouze v případě, že chcete, aby server byl serverem privátního přístupu.
properties.pointInTimeUTC	string	Doba vytvoření bodu obnovení (formát ISO8601) určující čas, ze které se má provést obnovení. Vyžaduje se v případě, že createMode je PointInTimeRestore nebo GeoRestore nebo OživitDropped.
properties.privateEndpointConnections	PrivateEndpointConnection[]	Seznam připojení privátních koncových bodů přidružených k zadanému prostředku
properties.replica	Replica	Vlastnosti repliky serveru Tyto vlastnosti repliky musí být předány pouze v případě, že chcete zvýšit úroveň serveru.
properties.replicaCapacity	integer	Repliky povolené pro server
properties.replicationRole	ReplicationRole	Role replikace serveru
properties.sourceServerResourceId	string	ID prostředku zdrojového serveru, ze které se má obnovit. Vyžaduje se v případě, že createMode je PointInTimeRestore nebo GeoRestore nebo Replika nebo OživitDropped. Tato vlastnost se vrátí pouze pro server repliky.
properties.state	ServerState	Stav serveru, který je viditelný pro uživatele.
properties.storage	Storage	Vlastnosti úložiště serveru
properties.version	ServerVersion	Verze serveru PostgreSQL.
sku	Sku	Skladová položka (cenová úroveň) serveru.
systemData	systemData	Metadata Azure Resource Manageru obsahující informace createdBy a modifiedBy
tags	object	Značky prostředků
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

ServerForUpdate

Object

Požadované parametry pro aktualizaci serveru.

Name	Typ	Description
identity	UserAssignedIdentity	Popisuje identitu aplikace.
properties.administratorLogin	string	Přihlašovací jméno serveru správce. Je možné zadat pouze v případech, kdy se server pokouší přepnout na ověřování heslem a nemá výchozí přihlašovací jméno správce.
properties.administratorLoginPassword	string	Heslo pro přihlášení správce.
properties.authConfig	AuthConfig	Vlastnosti AuthConfig serveru
properties.backup	Backup	Vlastnosti zálohování serveru
properties.cluster	Cluster	Vlastnosti clusteru serveru
properties.createMode	CreateModeForUpdate	Režim aktualizace nového serveru PostgreSQL.
properties.dataEncryption	DataEncryption	Vlastnosti šifrování dat serveru
properties.highAvailability	HighAvailability	Vlastnosti vysoké dostupnosti serveru
properties.maintenanceWindow	MaintenanceWindow	Vlastnosti časového období údržby serveru
properties.network	Network	Vlastnosti sítě serveru Ty se musí předávat jenom v případě, že je server privátním přístupovým serverem.
properties.replica	Replica	Vlastnosti repliky serveru Tyto vlastnosti repliky musí být předány pouze v případě, že chcete zvýšit úroveň serveru.
properties.replicationRole	ReplicationRole	Role replikace serveru
properties.storage	Storage	Vlastnosti úložiště serveru
properties.version	ServerVersion	Verze serveru PostgreSQL. Pro MVU se v současné době nepodporuje verze 16.
sku	Sku	Skladová položka (cenová úroveň) serveru.
tags	object	Metadata specifická pro aplikaci ve formě párů klíč-hodnota.

ServerHAState

Enumeration

Stav serveru vysoké dostupnosti, který je viditelný pro uživatele.

Hodnota	Description
CreatingStandby
FailingOver
Healthy
NotEnabled
RemovingStandby
ReplicatingData

ServerPublicNetworkAccessState

Enumeration

Přístup k veřejné síti je povolený nebo není

Hodnota	Description
Disabled
Enabled

ServerState

Enumeration

Stav serveru, který je viditelný pro uživatele.

Hodnota	Description
Disabled
Dropping
Ready
Starting
Stopped
Stopping
Updating

ServerVersion

Enumeration

Verze serveru PostgreSQL.

Hodnota	Description
11
12
13
14
15
16
17

Sku

Object

Skladová položka (cenová úroveň) serveru.

Name	Typ	Description
name	string	Název skladové položky, obvykle úroveň + řada + jádra, například Standard_D4s_v3.
tier	SkuTier	Úroveň konkrétní skladové položky, například nárazové.

SkuTier

Enumeration

Úroveň konkrétní skladové položky, například nárazové.

Hodnota	Description
Burstable
GeneralPurpose
MemoryOptimized

Storage

Object

Vlastnosti úložiště serveru

Name	Typ	Description
autoGrow	StorageAutoGrow	Příznak pro povolení nebo zakázání automatického zvětšování úložiště pro flexibilní server
iops	integer	Množství IOPS úrovně úložiště Tato vlastnost musí být nastavena pro typ úložiště PremiumV2_LRS a UltraSSD_LRS.
storageSizeGB	integer	Maximální povolené úložiště pro server.
throughput	integer	Propustnost úložiště pro server. To je potřeba nastavit pro typ úložiště PremiumV2_LRS a UltraSSD_LRS.
tier	AzureManagedDiskPerformanceTiers	Název úrovně úložiště pro IOPS
type	StorageType	Typ úložiště pro server. Povolené hodnoty jsou Premium_LRS, PremiumV2_LRS a UltraSSD_LRS. Výchozí hodnota je Premium_LRS, pokud není zadána.

StorageAutoGrow

Enumeration

Příznak pro povolení nebo zakázání automatického zvětšování úložiště pro flexibilní server

Hodnota	Description
Disabled
Enabled

StorageType

Enumeration

Typ úložiště pro server. Povolené hodnoty jsou Premium_LRS, PremiumV2_LRS a UltraSSD_LRS. Výchozí hodnota je Premium_LRS, pokud není zadána.

Hodnota	Description
PremiumV2_LRS
Premium_LRS
UltraSSD_LRS

systemData

Object

Metadata Azure Resource Manageru obsahující informace createdBy a modifiedBy

Name	Typ	Description
createdAt	string	Časové razítko vytvoření prostředku (UTC).
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string	Časové razítko poslední změny zdroje (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.

UserAssignedIdentity

Object

Popisuje identitu aplikace.

Name	Typ	Description
principalId	string	ID objektu zabezpečení identity serveru.
tenantId	string	ID tenanta serveru.
type	IdentityType	typy identit přidružených k tomuto prostředku
userAssignedIdentities	<string,  UserIdentity>	představuje mapování identit přiřazených uživatelem.

UserIdentity

Object

Popisuje jednu identitu přiřazenou uživatelem přidruženou k aplikaci.

Name	Typ	Description
clientId	string	identifikátor klienta instančního objektu, který tato identita představuje.
principalId	string	identifikátor objektu instančního objektu, který tato identita představuje.