diff --git a/specification/postgresql/cspell.yaml b/specification/postgresql/cspell.yaml index 97073652653e..dd1325461716 100644 --- a/specification/postgresql/cspell.yaml +++ b/specification/postgresql/cspell.yaml @@ -7,6 +7,7 @@ import: - ../../cspell.yaml words: + - Apsara - byok - citus - rdbms diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/Administrators.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/Administrators.json index 20ada5b15111..078ec1bbe39b 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/Administrators.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/Administrators.json @@ -2,7 +2,7 @@ "swagger": "2.0", "info": { "title": "PostgreSQLManagementClient", - "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.", + "description": "The Azure Database for PostgreSQL management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, network configuration, security alert policies, log files and configurations with new business model.", "version": "2025-01-01-preview" }, "host": "management.azure.com", @@ -41,11 +41,11 @@ ], "operationId": "Administrators_Create", "x-ms-examples": { - "Adds an Microsoft Entra Administrator for the server": { + "Add a server administrator associated to a Microsoft Entra principal.": { "$ref": "./examples/AdministratorAdd.json" } }, - "description": "Creates a new server.", + "description": "Creates a new server administrator associated to a Microsoft Entra principal.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" @@ -69,7 +69,7 @@ "schema": { "$ref": "#/definitions/ActiveDirectoryAdministratorAdd" }, - "description": "The required parameters for adding an Microsoft Entra Administrator for a server." + "description": "Required parameters for adding a server administrator associated to a Microsoft Entra principal." } ], "responses": { @@ -111,11 +111,11 @@ ], "operationId": "Administrators_Delete", "x-ms-examples": { - "AdministratorDelete": { + "Delete a server administrator associated to a Microsoft Entra principal.": { "$ref": "./examples/AdministratorDelete.json" } }, - "description": "Deletes an Microsoft Entra Administrator associated with the server.", + "description": "Deletes an existing server administrator associated to a Microsoft Entra principal.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" @@ -166,11 +166,11 @@ ], "operationId": "Administrators_Get", "x-ms-examples": { - "ServerGet": { + "Get information about a server administrator associated to a Microsoft Entra principal.": { "$ref": "./examples/AdministratorGet.json" } }, - "description": "Gets information about a server.", + "description": "Gets information about a server administrator associated to a Microsoft Entra principal.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" @@ -211,11 +211,11 @@ ], "operationId": "Administrators_ListByServer", "x-ms-examples": { - "AdministratorsListByServer": { + "List information about all server administrators associated to Microsoft Entra principals.": { "$ref": "./examples/AdministratorsListByServer.json" } }, - "description": "List all the AAD administrators for a given server.", + "description": "List all server administrators associated to a Microsoft Entra principal.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" @@ -257,17 +257,17 @@ "properties": { "$ref": "#/definitions/AdministratorPropertiesForAdd", "x-ms-client-flatten": true, - "description": "Properties of the Microsoft Entra Administrator." + "description": "Properties of the server administrator associated to a Microsoft Entra principal." } }, - "description": "Represents an Microsoft Entra Administrator." + "description": "Server administrator associated to a Microsoft Entra principal." }, "AdministratorPropertiesForAdd": { "type": "object", "properties": { "principalType": { "type": "string", - "description": "The principal type used to represent the type of Microsoft Entra Administrator.", + "description": "The type of Microsoft Entra principal to which the server administrator is associated.", "enum": [ "Unknown", "User", @@ -286,7 +286,7 @@ }, "principalName": { "type": "string", - "description": "Microsoft Entra Administrator principal name.", + "description": "Name of the Microsoft Entra principal.", "x-ms-mutability": [ "create", "update", @@ -295,21 +295,21 @@ }, "tenantId": { "type": "string", - "description": "The tenantId of the Microsoft Entra Administrator.", + "description": "Identifier of the tenant in which the Microsoft Entra principal exists.", "x-ms-mutability": [ "create", "update" ] } }, - "description": "The properties of an Microsoft Entra Administrator." + "description": "Properties of a server administrator associated to a Microsoft Entra principal." }, "AdministratorProperties": { "type": "object", "properties": { "principalType": { "type": "string", - "description": "The principal type used to represent the type of Microsoft Entra Administrator.", + "description": "Type of Microsoft Entra principal to which the server administrator is associated.", "enum": [ "Unknown", "User", @@ -328,7 +328,7 @@ }, "principalName": { "type": "string", - "description": "Microsoft Entra Administrator principal name.", + "description": "Name of the Microsoft Entra principal.", "x-ms-mutability": [ "create", "update", @@ -337,7 +337,7 @@ }, "objectId": { "type": "string", - "description": "The objectId of the Microsoft Entra Administrator.", + "description": "Object identifier of the Microsoft Entra principal.", "x-ms-mutability": [ "create", "update", @@ -346,7 +346,7 @@ }, "tenantId": { "type": "string", - "description": "The tenantId of the Microsoft Entra Administrator.", + "description": "Identifier of the tenant in which the Microsoft Entra principal exists.", "x-ms-mutability": [ "create", "update", @@ -354,7 +354,7 @@ ] } }, - "description": "The properties of an Microsoft Entra Administrator." + "description": "Properties of a server administrator associated to a Microsoft Entra principal." }, "ActiveDirectoryAdministrator": { "type": "object", @@ -362,7 +362,7 @@ "properties": { "$ref": "#/definitions/AdministratorProperties", "x-ms-client-flatten": true, - "description": "Properties of the Microsoft Entra Administrator." + "description": "Properties of a server administrator associated to a Microsoft Entra principal." } }, "allOf": [ @@ -373,7 +373,7 @@ "required": [ "properties" ], - "description": "Represents an Microsoft Entra Administrator." + "description": "Server administrator associated to a Microsoft Entra principal." }, "AdministratorListResult": { "type": "object", @@ -383,14 +383,14 @@ "items": { "$ref": "#/definitions/ActiveDirectoryAdministrator" }, - "description": "The list of Microsoft Entra Administrators" + "description": "List of server administrators associated to Microsoft Entra principals." }, "nextLink": { - "description": "The link used to get the next page of Microsoft Entra administrators.", + "description": "Link used to get the next page of results.", "type": "string" } }, - "description": "A list of Microsoft Entra Administrators." + "description": "List of server administrators associated to Microsoft Entra principals." } }, "parameters": { @@ -399,7 +399,7 @@ "in": "path", "required": true, "type": "string", - "description": "Guid of the objectId for the administrator.", + "description": "Object identifier of the Microsoft Entra principal.", "x-ms-parameter-location": "method" } } diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/Backups.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/Backups.json index 559a34458f28..324b8feeaaf6 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/Backups.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/Backups.json @@ -2,7 +2,7 @@ "swagger": "2.0", "info": { "title": "PostgreSQLManagementClient", - "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.", + "description": "The Azure Database for PostgreSQL management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, network configuration, security alert policies, log files and configurations with new business model.", "version": "2025-01-01-preview" }, "host": "management.azure.com", @@ -41,11 +41,11 @@ ], "operationId": "Backups_Create", "x-ms-examples": { - "Create a new Backup for a flexible server": { + "Create an on demand backup of a flexible server.": { "$ref": "./examples/BackupCreate.json" } }, - "description": "Create a specific backup for PostgreSQL flexible server.", + "description": "Creates an on demand backup of a flexible server.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" @@ -102,11 +102,11 @@ ], "operationId": "Backups_Delete", "x-ms-examples": { - "Delete a specific backup": { + "Delete an on demand backup, given its name.": { "$ref": "./examples/BackupDelete.json" } }, - "description": "Deletes a specific backup.", + "description": "Deletes a specific backup, given its name.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" @@ -154,11 +154,11 @@ ], "operationId": "Backups_Get", "x-ms-examples": { - "Get a backup for a server": { + "Get an on demand backup, given its name.": { "$ref": "./examples/BackupGet.json" } }, - "description": "Get specific backup for a given server.", + "description": "Gets information of an on demand backup, given its name.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" @@ -199,11 +199,11 @@ ], "operationId": "Backups_ListByServer", "x-ms-examples": { - "List backups for a server": { + "List all available backups of a flexible server.": { "$ref": "./examples/BackupListByServer.json" } }, - "description": "List all the backups for a given server.", + "description": "Lists all available backups of a flexible server.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" @@ -244,7 +244,7 @@ "properties": { "backupType": { "type": "string", - "description": "Backup type.", + "description": "Type of backup.", "enum": [ "Full", "Customer On-Demand" @@ -257,14 +257,14 @@ "completedTime": { "type": "string", "format": "date-time", - "description": "Backup completed time (ISO8601 format)." + "description": "Time(ISO8601 format) at which the backup was completed." }, "source": { "type": "string", - "description": "Backup source" + "description": "Source of the backup." } }, - "description": "The properties of a server backup." + "description": "Properties of a backup." }, "ServerBackup": { "type": "object", @@ -272,7 +272,7 @@ "properties": { "$ref": "#/definitions/ServerBackupProperties", "x-ms-client-flatten": true, - "description": "The properties of a server backup." + "description": "Properties of a backup." } }, "allOf": [ @@ -280,7 +280,7 @@ "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ], - "description": "Server backup properties" + "description": "Properties of a backup." }, "ServerBackupListResult": { "type": "object", @@ -290,14 +290,14 @@ "items": { "$ref": "#/definitions/ServerBackup" }, - "description": "The list of backups of a server." + "description": "List of available backups." }, "nextLink": { - "description": "The link used to get the next page of operations.", + "description": "Link used to get the next page of results.", "type": "string" } }, - "description": "A list of server backups." + "description": "List of backups." } }, "parameters": { @@ -306,7 +306,7 @@ "in": "path", "required": true, "type": "string", - "description": "The name of the backup.", + "description": "Name of the backup.", "minLength": 1, "pattern": "^[-\\w\\._]+$", "x-ms-parameter-location": "method" diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/Capabilities.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/Capabilities.json index 1fabc7dfd47a..16ac8f543533 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/Capabilities.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/Capabilities.json @@ -2,7 +2,7 @@ "swagger": "2.0", "info": { "title": "PostgreSQLManagementClient", - "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.", + "description": "The Azure Database for PostgreSQL management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, network configuration, security alert policies, log files and configurations with new business model.", "version": "2025-01-01-preview" }, "host": "management.azure.com", @@ -41,11 +41,11 @@ ], "operationId": "LocationBasedCapabilities_Execute", "x-ms-examples": { - "CapabilitiesList": { + "List the capabilities available in a given location for a specific subscription.": { "$ref": "./examples/CapabilitiesByLocation.json" } }, - "description": "Get capabilities at specified location in a given subscription.", + "description": "Lists the capabilities available in a given location for a specific subscription.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" @@ -83,11 +83,11 @@ ], "operationId": "ServerCapabilities_List", "x-ms-examples": { - "ServerCapabilitiesList": { + "List the capabilities available for a given flexible server.": { "$ref": "./examples/ServerCapabilities.json" } }, - "description": "Get capabilities for a flexible server.", + "description": "Lists the capabilities available for a given flexible server.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" @@ -125,17 +125,17 @@ "definitions": { "StorageTierCapability": { "type": "object", - "description": "Represents capability of a storage tier", + "description": "Capability of a storage tier.", "properties": { "name": { "type": "string", - "description": "Name to represent Storage tier capability", + "description": "Name of the storage tier.", "readOnly": true }, "iops": { "type": "integer", "format": "int32", - "description": "Supported IOPS for this storage tier", + "description": "Supported IOPS for the storage tier.", "readOnly": true } }, @@ -151,47 +151,47 @@ "supportedIops": { "type": "integer", "format": "int32", - "description": "Supported IOPS", + "description": "Minimum IOPS supported by the storage size.", "readOnly": true }, "supportedMaximumIops": { "type": "integer", "format": "int32", - "description": "Maximum IOPS supported by this #Vcores or PremiumV2_LRS Storage Size", + "description": "Maximum IOPS supported by the storage size.", "readOnly": true }, "storageSizeMb": { "type": "integer", "format": "int64", - "description": "Storage size in MB", + "description": "Minimum supported size (in MB) of storage.", "readOnly": true }, "maximumStorageSizeMb": { "type": "integer", "format": "int64", - "description": "Maximum value of Storage size in MB", + "description": "Maximum supported size (in MB) of storage.", "readOnly": true }, "supportedThroughput": { "type": "integer", "format": "int32", - "description": "Values of throughput in MB/s", + "description": "Minimum supported throughput (in MB/s) of storage.", "readOnly": true }, "supportedMaximumThroughput": { "type": "integer", "format": "int32", - "description": "Maximum values of throughput in MB/s", + "description": "Maximum supported throughput (in MB/s) of storage.", "readOnly": true }, "defaultIopsTier": { "type": "string", - "description": "Default tier for IOPS", + "description": "Default IOPS for this tier and storage size.", "readOnly": true }, "supportedIopsTiers": { "type": "array", - "description": "List of available options to upgrade the storage performance", + "description": "List of all supported storage tiers for this tier and storage size.", "items": { "$ref": "#/definitions/StorageTierCapability" }, @@ -206,37 +206,37 @@ "$ref": "../../../types/common-types.json#/definitions/CapabilityBase" } ], - "description": "storage size in MB capability" + "description": "Storage size (in MB) capability." }, "ServerSkuCapability": { "type": "object", "properties": { "name": { "type": "string", - "description": "Sku name", + "description": "Name of the compute (SKU).", "readOnly": true }, "vCores": { "type": "integer", "format": "int32", - "description": "Supported vCores", + "description": "vCores available for this compute.", "readOnly": true }, "supportedIops": { "type": "integer", "format": "int32", - "description": "Supported IOPS", + "description": "Maximum IOPS supported by this compute.", "readOnly": true }, "supportedMemoryPerVcoreMb": { "type": "integer", "format": "int64", - "description": "Supported memory per vCore in MB", + "description": "Supported memory (in MB) per virtual core assigned to this compute.", "readOnly": true }, "supportedZones": { "type": "array", - "description": "List of supported Availability Zones. E.g. \"1\", \"2\", \"3\"", + "description": "List of supported availability zones. E.g. \"1\", \"2\", \"3\"", "items": { "type": "string" }, @@ -246,7 +246,7 @@ "type": "array", "items": { "type": "string", - "description": "HA mode supported for a server.", + "description": "Modes of high availability supported for this compute.", "enum": [ "SameZone", "ZoneRedundant" @@ -256,12 +256,12 @@ "modelAsString": true } }, - "description": "Supported high availability mode", + "description": "Modes of high availability supported for this compute.", "readOnly": true }, "supportedFeatures": { "type": "array", - "description": "The supported features.", + "description": "Features supported.", "items": { "$ref": "#/definitions/SupportedFeature" }, @@ -272,7 +272,7 @@ }, "securityProfile": { "type": "string", - "description": "The value of security profile indicating if its confidential vm", + "description": "Security profile of the compute. Indicates if it's a Confidential Compute virtual machine.", "readOnly": true } }, @@ -281,11 +281,11 @@ "$ref": "../../../types/common-types.json#/definitions/CapabilityBase" } ], - "description": "Sku capability" + "description": "Capabilities in terms of compute." }, "ServerVersion": { "type": "string", - "description": "The version of a server.", + "description": "Major version of PostgreSQL database engine.", "enum": [ "17", "16", @@ -305,7 +305,7 @@ "properties": { "name": { "type": "string", - "description": "Server version", + "description": "Major version of PostgreSQL database engine.", "readOnly": true }, "supportedVersionsToUpgrade": { @@ -313,12 +313,12 @@ "items": { "type": "string" }, - "description": "Supported servers versions to upgrade", + "description": "Major versions of PostgreSQL database engine to which this version can be automatically upgraded.", "readOnly": true }, "supportedFeatures": { "type": "array", - "description": "The supported features.", + "description": "Features supported.", "items": { "$ref": "#/definitions/SupportedFeature" }, @@ -333,25 +333,25 @@ "$ref": "../../../types/common-types.json#/definitions/CapabilityBase" } ], - "description": "Server version capabilities." + "description": "Capabilities in terms of major versions of PostgreSQL database engine." }, "StorageEditionCapability": { "type": "object", "properties": { "name": { "type": "string", - "description": "Storage edition name", + "description": "Name of storage tier.", "readOnly": true }, "defaultStorageSizeMb": { "type": "integer", "format": "int64", - "description": "Default storage size in MB for storage edition", + "description": "Default storage size (in MB) for this storage tier.", "readOnly": true }, "supportedStorageMb": { "type": "array", - "description": "Flexible server supported storage range in MB", + "description": "Configurations of storage supported for this storage tier.", "items": { "$ref": "#/definitions/StorageMbCapability" }, @@ -366,20 +366,20 @@ "$ref": "../../../types/common-types.json#/definitions/CapabilityBase" } ], - "description": "Storage edition capability" + "description": "Capabilities in terms of storage tier." }, "SupportedFeature": { "type": "object", - "description": "The supported features.", + "description": "Features supported.", "properties": { "name": { "type": "string", - "description": "Name of feature", + "description": "Name of the feature.", "readOnly": true }, "status": { "type": "string", - "description": "Status of feature ", + "description": "Status of the feature. Indicates if the feature is enabled or not.", "readOnly": true, "enum": [ "Enabled", @@ -394,32 +394,32 @@ }, "FastProvisioningEditionCapability": { "type": "object", - "description": "Represents capability of a fast provisioning edition", + "description": "Capability of a fast provisioning compute tier.", "properties": { "supportedTier": { "type": "string", - "description": "Fast provisioning supported tier name", + "description": "Compute tier supporting fast provisioning.", "readOnly": true }, "supportedSku": { "type": "string", - "description": "Fast provisioning supported sku name", + "description": "Compute name (SKU) supporting fast provisioning.", "readOnly": true }, "supportedStorageGb": { "type": "integer", "format": "int32", - "description": "Fast provisioning supported storage in Gb", + "description": "Storage size (in GB) supporting fast provisioning.", "readOnly": true }, "supportedServerVersions": { "type": "string", - "description": "Fast provisioning supported version", + "description": "Major version of PostgreSQL database engine supporting fast provisioning.", "readOnly": true }, "serverCount": { "type": "integer", - "description": "Count of servers in cache matching the spec", + "description": "Count of servers in cache matching this specification.", "format": "int32", "readOnly": true } @@ -440,12 +440,12 @@ "properties": { "name": { "type": "string", - "description": "Server edition name", + "description": "Name of compute tier.", "readOnly": true }, "defaultSkuName": { "type": "string", - "description": "Default sku name for the server edition", + "description": "Default compute name (SKU) for this computer tier.", "readOnly": true }, "supportedStorageEditions": { @@ -453,7 +453,7 @@ "items": { "$ref": "#/definitions/StorageEditionCapability" }, - "description": "The list of editions supported by this server edition.", + "description": "List of storage editions supported by this compute tier and compute name.", "readOnly": true, "x-ms-identifiers": [ "name" @@ -461,7 +461,7 @@ }, "supportedServerSkus": { "type": "array", - "description": "List of supported server SKUs.", + "description": "List of supported compute names (SKUs).", "items": { "$ref": "#/definitions/ServerSkuCapability" }, @@ -471,7 +471,7 @@ "readOnly": true } }, - "description": "Flexible server edition capabilities." + "description": "Capabilities in terms of compute tier." }, "FlexibleServerCapability": { "type": "object", @@ -483,7 +483,7 @@ "properties": { "name": { "type": "string", - "description": "Name of flexible servers capability" + "description": "Name of flexible servers capabilities." }, "supportedServerEditions": { "type": "array", @@ -494,7 +494,7 @@ "name" ], "readOnly": true, - "description": "List of supported flexible server editions" + "description": "List of supported compute tiers." }, "supportedServerVersions": { "type": "array", @@ -504,12 +504,12 @@ "x-ms-identifiers": [ "name" ], - "description": "The list of server versions supported for this capability.", + "description": "List of supported major versions of PostgreSQL database engine.", "readOnly": true }, "supportedFeatures": { "type": "array", - "description": "The supported features.", + "description": "Features supported.", "items": { "$ref": "#/definitions/SupportedFeature" }, @@ -520,7 +520,7 @@ }, "fastProvisioningSupported": { "type": "string", - "description": "Gets a value indicating whether fast provisioning is supported. \"Enabled\" means fast provisioning is supported. \"Disabled\" stands for fast provisioning is not supported. Will be deprecated in future, please look to Supported Features for \"FastProvisioning\".", + "description": "Indicates if fast provisioning is supported. \"Enabled\" means fast provisioning is supported. \"Disabled\" stands for fast provisioning is not supported. Will be deprecated in the future. Look to Supported Features for \"FastProvisioning\".", "readOnly": true, "enum": [ "Enabled", @@ -533,7 +533,7 @@ }, "supportedFastProvisioningEditions": { "type": "array", - "description": "List of supported server editions for fast provisioning", + "description": "List of compute tiers supporting fast provisioning.", "items": { "$ref": "#/definitions/FastProvisioningEditionCapability" }, @@ -544,7 +544,7 @@ }, "geoBackupSupported": { "type": "string", - "description": "Determines if geo-backup is supported in this region. \"Enabled\" means geo-backup is supported. \"Disabled\" stands for geo-back is not supported. Will be deprecated in future, please look to Supported Features for \"GeoBackup\".", + "description": "Indicates if geographically redundant backups are supported in this location. \"Enabled\" means geographically redundant backups are supported. \"Disabled\" stands for geographically redundant backup is not supported. Will be deprecated in the future. Look to Supported Features for \"GeoBackup\".", "readOnly": true, "enum": [ "Enabled", @@ -557,7 +557,7 @@ }, "zoneRedundantHaSupported": { "type": "string", - "description": "A value indicating whether Zone Redundant HA is supported in this region. \"Enabled\" means zone redundant HA is supported. \"Disabled\" stands for zone redundant HA is not supported. Will be deprecated in future, please look to Supported Features for \"ZoneRedundantHa\".", + "description": "Indicates if high availability with zone redundancy is supported in this location. \"Enabled\" means high availability with zone redundancy is supported. \"Disabled\" stands for high availability with zone redundancy is not supported. Will be deprecated in the future. Look to Supported Features for \"ZoneRedundantHa\".", "readOnly": true, "enum": [ "Enabled", @@ -570,7 +570,7 @@ }, "zoneRedundantHaAndGeoBackupSupported": { "type": "string", - "description": "A value indicating whether Zone Redundant HA and Geo-backup is supported in this region. \"Enabled\" means zone redundant HA and geo-backup is supported. \"Disabled\" stands for zone redundant HA and geo-backup is not supported. Will be deprecated in future, please look to Supported Features for \"ZoneRedundantHaAndGeoBackup\".", + "description": "Indicates if high availability with zone redundancy is supported in conjunction with geographically redundant backups in this location. \"Enabled\" means high availability with zone redundancy is supported in conjunction with geographically redundant backups is supported. \"Disabled\" stands for high availability with zone redundancy is supported in conjunction with geographically redundant backups is not supported. Will be deprecated in the future. Look to Supported Features for \"ZoneRedundantHaAndGeoBackup\".", "readOnly": true, "enum": [ "Enabled", @@ -583,7 +583,7 @@ }, "storageAutoGrowthSupported": { "type": "string", - "description": "A value indicating whether storage auto-grow is supported in this region. \"Enabled\" means storage auto-grow is supported. \"Disabled\" stands for storage auto-grow is not supported. Will be deprecated in future, please look to Supported Features for \"StorageAutoGrowth\".", + "description": "Indicates if storage autogrow is supported in this location. \"Enabled\" means storage autogrow is supported. \"Disabled\" stands for storage autogrow is not supported. Will be deprecated in the future. Look to Supported Features for \"StorageAutoGrowth\".", "readOnly": true, "enum": [ "Enabled", @@ -596,7 +596,7 @@ }, "onlineResizeSupported": { "type": "string", - "description": "A value indicating whether online resize is supported in this region for the given subscription. \"Enabled\" means storage online resize is supported. \"Disabled\" means storage online resize is not supported. Will be deprecated in future, please look to Supported Features for \"OnlineResize\".", + "description": "Indicates if resizing the storage without interrupting the operation of the database engine is supported in this location for the given subscription. \"Enabled\" means resizing the storage without interrupting the operation of the database engine is supported. \"Disabled\" means resizing the storage without interrupting the operation of the database engine is not supported. Will be deprecated in the future. Look to Supported Features for \"OnlineResize\".", "readOnly": true, "enum": [ "Enabled", @@ -609,7 +609,7 @@ }, "restricted": { "type": "string", - "description": "A value indicating whether this region is restricted. \"Enabled\" means region is restricted. \"Disabled\" stands for region is not restricted. Will be deprecated in future, please look to Supported Features for \"Restricted\".", + "description": "Indicates if this location is restricted. \"Enabled\" means location is restricted. \"Disabled\" stands for location is not restricted. Will be deprecated in the future. Look to Supported Features for \"Restricted\".", "readOnly": true, "enum": [ "Enabled", @@ -621,13 +621,13 @@ } } }, - "description": "Capability for the PostgreSQL server" + "description": "Capability for the Azure Database for PostgreSQL flexible server." }, "CapabilitiesListResult": { "type": "object", "properties": { "value": { - "description": "A list of supported capabilities.", + "description": "List of supported capabilities.", "type": "array", "items": { "$ref": "#/definitions/FlexibleServerCapability" @@ -643,7 +643,7 @@ "readOnly": true } }, - "description": "Capability for the PostgreSQL server" + "description": "Capability for the Azure Database for PostgreSQL flexible server." } }, "parameters": {} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/CheckNameAvailability.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/CheckNameAvailability.json index 3a732aad2dce..bc79b5240f4a 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/CheckNameAvailability.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/CheckNameAvailability.json @@ -2,7 +2,7 @@ "swagger": "2.0", "info": { "title": "PostgreSQLManagementClient", - "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.", + "description": "The Azure Database for PostgreSQL management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, network configuration, security alert policies, log files and configurations with new business model.", "version": "2025-01-01-preview" }, "host": "management.azure.com", @@ -41,11 +41,11 @@ ], "operationId": "CheckNameAvailability_Execute", "x-ms-examples": { - "NameAvailability": { + "Check the validity and availability of the given name, to assign it to a new flexible server.": { "$ref": "./examples/CheckNameAvailability.json" } }, - "description": "Check the availability of name for resource", + "description": "Checks the validity and availability of the given name, to assign it to a new flexible server.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" @@ -60,7 +60,7 @@ "schema": { "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/CheckNameAvailabilityRequest" }, - "description": "The required parameters for checking if resource name is available." + "description": "Parameters required to check if a server name is valid and available to assign it to a new flexible server." } ], "responses": { @@ -86,7 +86,7 @@ ], "operationId": "CheckNameAvailabilityWithLocation_Execute", "x-ms-examples": { - "NameAvailability": { + "Check the validity and availability of the given server name in the given location, to assign it to a new flexible server": { "$ref": "./examples/CheckNameAvailabilityLocationBased.json" } }, @@ -108,7 +108,7 @@ "schema": { "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/CheckNameAvailabilityRequest" }, - "description": "The required parameters for checking if resource name is available." + "description": "Parameters required to check if server name is available." } ], "responses": { @@ -134,16 +134,16 @@ "properties": { "name": { "type": "string", - "description": "name of the PostgreSQL server.", + "description": "Name of the PostgreSQL flexible server.", "readOnly": true }, "type": { "type": "string", - "description": "type of the server", + "description": "Type of the server.", "readOnly": true } }, - "description": "Represents a resource name availability.", + "description": "Availability of a server name.", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/CheckNameAvailabilityResponse" diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/Configuration.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/Configuration.json index 7576128e8f33..e1cb8adcced8 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/Configuration.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/Configuration.json @@ -2,7 +2,7 @@ "swagger": "2.0", "info": { "title": "PostgreSQLManagementClient", - "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.", + "description": "The Azure Database for PostgreSQL management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, network configuration, security alert policies, log files and configurations with new business model.", "version": "2025-01-01-preview" }, "host": "management.azure.com", @@ -41,11 +41,11 @@ ], "operationId": "Configurations_ListByServer", "x-ms-examples": { - "ConfigurationList": { + "List all server parameters (also known as configurations) of a flexible server.": { "$ref": "./examples/ConfigurationListByServer.json" } }, - "description": "List all the configurations in a given server.", + "description": "Lists all server parameters (also known as configurations) of a flexible server.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" @@ -86,11 +86,11 @@ ], "operationId": "Configurations_Get", "x-ms-examples": { - "ConfigurationGet": { + "Get information about a specific server parameter of a flexible server.": { "$ref": "./examples/ConfigurationGet.json" } }, - "description": "Gets information about a configuration of server.", + "description": "Gets information about a specific server parameter of a flexible server.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" @@ -129,11 +129,11 @@ ], "operationId": "Configurations_Update", "x-ms-examples": { - "Update a user configuration": { - "$ref": "./examples/ConfigurationUpdate.json" + "Update, using Patch verb, the value assigned to a specific modifiable server parameter of a flexible server.": { + "$ref": "./examples/ConfigurationUpdateUsingPatch.json" } }, - "description": "Updates a configuration of a server.", + "description": "Updates, using Patch verb, the value assigned to a specific modifiable server parameter of a flexible server.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" @@ -157,7 +157,7 @@ "schema": { "$ref": "#/definitions/ConfigurationForUpdate" }, - "description": "The required parameters for updating a server configuration." + "description": "Parameters required to update the value of a specific modifiable server parameter." } ], "responses": { @@ -199,11 +199,11 @@ ], "operationId": "Configurations_Put", "x-ms-examples": { - "Update a user configuration": { - "$ref": "./examples/ConfigurationUpdate.json" + "Update, using Put verb, the value assigned to a specific modifiable server parameter of a flexible server.": { + "$ref": "./examples/ConfigurationUpdateUsingPut.json" } }, - "description": "Updates a configuration of a server.", + "description": "Updates, using Put verb, the value assigned to a specific modifiable server parameter of a flexible server.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" @@ -227,7 +227,7 @@ "schema": { "$ref": "#/definitions/Configuration" }, - "description": "The required parameters for updating a server configuration." + "description": "Parameters required to update the value of a specific modifiable server parameter." } ], "responses": { @@ -271,22 +271,22 @@ "properties": { "value": { "type": "string", - "description": "Value of the configuration. Required to update the configuration." + "description": "Value of the server parameter (also known as configuration). Required to update the value assigned to a specific modifiable server parameter." }, "description": { "type": "string", "readOnly": true, - "description": "Description of the configuration." + "description": "Description of the server parameter." }, "defaultValue": { "type": "string", "readOnly": true, - "description": "Default value of the configuration." + "description": "Value assigned by default to the server parameter." }, "dataType": { "type": "string", "readOnly": true, - "description": "Data type of the configuration.", + "description": "Data type of the server parameter.", "enum": [ "Boolean", "Numeric", @@ -301,39 +301,39 @@ "allowedValues": { "type": "string", "readOnly": true, - "description": "Allowed values of the configuration." + "description": "Allowed values of the server parameter." }, "source": { "type": "string", - "description": "Source of the configuration. Required to update the configuration." + "description": "Source of the value assigned to the server parameter. Required to update the value assigned to a specific modifiable server parameter." }, "isDynamicConfig": { "type": "boolean", "readOnly": true, - "description": "Configuration dynamic or static." + "description": "Indicates if it's a dynamic (true) or static (false) server parameter. Static server parameters require a server restart after changing the value assigned to it, for the change to take effect. Dynamic server parameters do not require a server restart after changing the value assigned to it, for the change to take effect." }, "isReadOnly": { "type": "boolean", "readOnly": true, - "description": "Configuration read-only or not." + "description": "Indicates if it's a read-only (true) or modifiable (false) server parameter." }, "isConfigPendingRestart": { "type": "boolean", "readOnly": true, - "description": "Configuration is pending restart or not." + "description": "Indicates if the value assigned to the server parameter is pending a server restart for the value to take effect." }, "unit": { "type": "string", "readOnly": true, - "description": "Configuration unit." + "description": "Units in which the server parameter value is expressed." }, "documentationLink": { "type": "string", "readOnly": true, - "description": "Configuration documentation link." + "description": "Link pointing to the documentation of the server parameter." } }, - "description": "The properties of a configuration." + "description": "Properties of a server parameter." }, "Configuration": { "type": "object", @@ -341,7 +341,7 @@ "properties": { "$ref": "#/definitions/ConfigurationProperties", "x-ms-client-flatten": true, - "description": "The properties of a configuration." + "description": "Properties of a server parameter." } }, "allOf": [ @@ -349,7 +349,7 @@ "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ], - "description": "Represents a Configuration." + "description": "Server parameter." }, "ConfigurationForUpdate": { "type": "object", @@ -357,10 +357,10 @@ "properties": { "$ref": "#/definitions/ConfigurationProperties", "x-ms-client-flatten": true, - "description": "The properties of a configuration." + "description": "Properties of a server parameter." } }, - "description": "Represents a Configuration." + "description": "Server parameter." }, "ConfigurationListResult": { "type": "object", @@ -370,14 +370,14 @@ "items": { "$ref": "#/definitions/Configuration" }, - "description": "The list of server configurations." + "description": "List of server parameters." }, "nextLink": { - "description": "The link used to get the next page of operations.", + "description": "Link used to get the next page of results.", "type": "string" } }, - "description": "A list of server configurations." + "description": "List of server parameters." } }, "parameters": { @@ -386,7 +386,7 @@ "in": "path", "required": true, "type": "string", - "description": "The name of the server configuration.", + "description": "Name of the server parameter.", "minLength": 1, "pattern": "^[-\\w\\._]+$", "x-ms-parameter-location": "method" diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/Databases.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/Databases.json index c098a0c0b23d..7e31c3c719c2 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/Databases.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/Databases.json @@ -2,7 +2,7 @@ "swagger": "2.0", "info": { "title": "PostgreSQLManagementClient", - "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.", + "description": "The Azure Database for PostgreSQL management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, network configuration, security alert policies, log files and configurations with new business model.", "version": "2025-01-01-preview" }, "host": "management.azure.com", @@ -41,11 +41,11 @@ ], "operationId": "Databases_Create", "x-ms-examples": { - "Create a database": { + "Create a database.": { "$ref": "./examples/DatabaseCreate.json" } }, - "description": "Creates a new database or updates an existing database.", + "description": "Creates a new database.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" @@ -69,7 +69,7 @@ "schema": { "$ref": "#/definitions/Database" }, - "description": "The required parameters for creating or updating a database." + "description": "Parameters required to create a new database." } ], "responses": { @@ -111,11 +111,11 @@ ], "operationId": "Databases_Delete", "x-ms-examples": { - "Delete a database": { + "Delete an existing database": { "$ref": "./examples/DatabaseDelete.json" } }, - "description": "Deletes a database.", + "description": "Deletes an existing database.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" @@ -166,11 +166,11 @@ ], "operationId": "Databases_Get", "x-ms-examples": { - "Get a database": { + "Get information about an existing database.": { "$ref": "./examples/DatabaseGet.json" } }, - "description": "Gets information about a database.", + "description": "Gets information about an existing database.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" @@ -211,11 +211,11 @@ ], "operationId": "Databases_ListByServer", "x-ms-examples": { - "List databases in a server": { + "List all databases in a flexible server.": { "$ref": "./examples/DatabasesListByServer.json" } }, - "description": "List all the databases in a given server.", + "description": "Lists all databases in a flexible server.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" @@ -256,16 +256,16 @@ "properties": { "charset": { "type": "string", - "description": "The charset of the database.", + "description": "Character set of the database.", "pattern": "^[a-zA-Z]+\\w*$" }, "collation": { "type": "string", - "description": "The collation of the database.", + "description": "Collation of the database.", "pattern": "^[a-zA-Z\\-]+([. ]|\\w)*$" } }, - "description": "The properties of a database." + "description": "Properties of a database." }, "Database": { "type": "object", @@ -273,7 +273,7 @@ "properties": { "$ref": "#/definitions/DatabaseProperties", "x-ms-client-flatten": true, - "description": "The properties of a database." + "description": "Properties of a database." } }, "allOf": [ @@ -291,15 +291,15 @@ "items": { "$ref": "#/definitions/Database" }, - "description": "The list of databases housed in a server" + "description": "List of all databases in a flexible server." }, "nextLink": { - "description": "The link used to get the next page of databases.", + "description": "Link used to get the next page of results.", "type": "string", "format": "uri" } }, - "description": "A List of databases." + "description": "List of all databases in a flexible server." } }, "parameters": { @@ -308,7 +308,7 @@ "in": "path", "required": true, "type": "string", - "description": "The name of the database.", + "description": "Name of the database.", "minLength": 1, "pattern": "^[a-zA-Z_][a-zA-Z0-9_]{0,30}$", "x-ms-parameter-location": "method" diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/FirewallRules.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/FirewallRules.json index 0a7d240e7fdf..6edd389ef326 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/FirewallRules.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/FirewallRules.json @@ -2,7 +2,7 @@ "swagger": "2.0", "info": { "title": "PostgreSQLManagementClient", - "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.", + "description": "The Azure Database for PostgreSQL management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, network configuration, security alert policies, log files and configurations with new business model.", "version": "2025-01-01-preview" }, "host": "management.azure.com", @@ -41,7 +41,7 @@ ], "operationId": "FirewallRules_CreateOrUpdate", "x-ms-examples": { - "FirewallRuleCreate": { + "Create a new firewall rule or update an existing firewall rule.": { "$ref": "./examples/FirewallRuleCreate.json" } }, @@ -69,7 +69,7 @@ "schema": { "$ref": "#/definitions/FirewallRule" }, - "description": "The required parameters for creating or updating a firewall rule." + "description": "Parameters required for creating or updating a firewall rule." } ], "responses": { @@ -111,11 +111,11 @@ ], "operationId": "FirewallRules_Delete", "x-ms-examples": { - "FirewallRuleDelete": { + "Delete an existing firewall rule.": { "$ref": "./examples/FirewallRuleDelete.json" } }, - "description": "Deletes a PostgreSQL server firewall rule.", + "description": "Deletes an existing firewall rule.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" @@ -166,11 +166,11 @@ ], "operationId": "FirewallRules_Get", "x-ms-examples": { - "FirewallRuleList": { + "Get information about a firewall rule in a flexible server.": { "$ref": "./examples/FirewallRuleGet.json" } }, - "description": "List all the firewall rules in a given server.", + "description": "Gets information about a firewall rule in a flexible server.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" @@ -211,11 +211,11 @@ ], "operationId": "FirewallRules_ListByServer", "x-ms-examples": { - "FirewallRuleList": { + "List information about all firewall rules in a flexible server.": { "$ref": "./examples/FirewallRuleListByServer.json" } }, - "description": "List all the firewall rules in a given PostgreSQL server.", + "description": "Lists information about all firewall rules in a flexible server.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" @@ -257,19 +257,19 @@ "startIpAddress": { "type": "string", "pattern": "^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$", - "description": "The start IP address of the server firewall rule. Must be IPv4 format." + "description": "IP address defining the start of the range of addresses of a firewall rule. Must be expressed in IPv4 format." }, "endIpAddress": { "type": "string", "pattern": "^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$", - "description": "The end IP address of the server firewall rule. Must be IPv4 format." + "description": "IP address defining the end of the range of addresses of a firewall rule. Must be expressed in IPv4 format." } }, "required": [ "startIpAddress", "endIpAddress" ], - "description": "The properties of a server firewall rule." + "description": "Properties of a firewall rule." }, "FirewallRule": { "type": "object", @@ -277,7 +277,7 @@ "properties": { "$ref": "#/definitions/FirewallRuleProperties", "x-ms-client-flatten": true, - "description": "The properties of a firewall rule." + "description": "Properties of a firewall rule." } }, "allOf": [ @@ -288,7 +288,7 @@ "required": [ "properties" ], - "description": "Represents a server firewall rule." + "description": "Firewall rule." }, "FirewallRuleListResult": { "type": "object", @@ -298,14 +298,14 @@ "items": { "$ref": "#/definitions/FirewallRule" }, - "description": "The list of firewall rules in a server." + "description": "List of firewall rules in a flexible server." }, "nextLink": { - "description": "The link used to get the next page of operations.", + "description": "Link to retrieve next page of results.", "type": "string" } }, - "description": "A list of firewall rules." + "description": "List of firewall rules." } }, "parameters": { @@ -314,7 +314,7 @@ "in": "path", "required": true, "type": "string", - "description": "The name of the server firewall rule.", + "description": "Name of the firewall rule.", "minLength": 1, "pattern": "^[-\\w\\._]+$", "x-ms-parameter-location": "method" diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/FlexibleServers.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/FlexibleServers.json index 5df9847a8bd2..4678d4252fa5 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/FlexibleServers.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/FlexibleServers.json @@ -2,7 +2,7 @@ "swagger": "2.0", "info": { "title": "PostgreSQLManagementClient", - "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.", + "description": "The Azure Database for PostgreSQL management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, network configuration, security alert policies, log files and configurations with new business model.", "version": "2025-01-01-preview" }, "host": "management.azure.com", @@ -41,28 +41,28 @@ ], "operationId": "Servers_Create", "x-ms-examples": { - "Create a new server": { + "Create a new flexible server.": { "$ref": "./examples/ServerCreate.json" }, - "Create a new server with Microsoft Entra authentication enabled": { + "Create a new flexible server with Microsoft Entra authentication enabled.": { "$ref": "./examples/ServerCreateWithMicrosoftEntraEnabled.json" }, - "ServerCreateWithDataEncryptionEnabled": { + "Create a new flexible server with data encryption based on customer managed key.": { "$ref": "./examples/ServerCreateWithDataEncryptionEnabled.json" }, - "Create a database as a point in time restore": { + "Create a new flexible server using a point in time restore of a backup of an existing flexible server.": { "$ref": "./examples/ServerCreatePointInTimeRestore.json" }, - "Create a database as a geo-restore in geo-paired location": { + "Create a new flexible server using a restore of a geographically redundant backup of an existing flexible server, with data encryption based on customer managed key.": { "$ref": "./examples/ServerCreateGeoRestoreWithDataEncryptionEnabled.json" }, - "ServerCreateReplica": { + "Create a read replica of an existing flexible server.": { "$ref": "./examples/ServerCreateReplica.json" }, - "ServerCreateReviveDropped": { + "Create a new flexible server using a backup of a flexible server that was deleted or dropped recently.": { "$ref": "./examples/ServerCreateReviveDropped.json" }, - "ClusterCreate": { + "Create a new elastic cluster.": { "$ref": "./examples/ClusterCreate.json" } }, @@ -87,7 +87,7 @@ "schema": { "$ref": "#/definitions/Server" }, - "description": "The required parameters for creating or updating a server." + "description": "Parameters required to create a new flexible server or to update an existing flexible server." } ], "responses": { @@ -129,35 +129,35 @@ ], "operationId": "Servers_Update", "x-ms-examples": { - "ServerUpdate": { + "Update an existing flexible server.": { "$ref": "./examples/ServerUpdate.json" }, - "ServerUpdateWithMicrosoftEntraEnabled": { + "Update an existing flexible server with Microsoft Entra authentication enabled.": { "$ref": "./examples/ServerUpdateWithMicrosoftEntraEnabled.json" }, - "ServerUpdateWithDataEncryptionEnabled": { + "Update an existing flexible server with data encryption based on customer managed key.": { "$ref": "./examples/ServerUpdateWithDataEncryptionEnabled.json" }, - "ServerUpdateWithCustomerMaintenanceWindow": { - "$ref": "./examples/ServerUpdateWithCustomerMaintenanceWindow.json" + "Update an existing flexible server with custom maintenance window.": { + "$ref": "./examples/ServerUpdateWithCustomMaintenanceWindow.json" }, - "ServerUpdateWithMajorVersionUpgrade": { + "Update an existing flexible server to upgrade the major version of PostgreSQL database engine.": { "$ref": "./examples/ServerUpdateWithMajorVersionUpgrade.json" }, - "Promote a replica server as a Standalone server as planned, i.e. it will wait for replication to complete.": { + "Promote a read replica to a standalone server with planned data synchronization. Meaning that it waits for data in the read replica to be fully synchronized with its source server before it initiates the promotion to a standalone server.": { "$ref": "./examples/PromoteReplicaAsPlannedStandaloneServer.json" }, - "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 read replica to a standalone server with forced data synchronization. Meaning that it doesn't wait for data in the read replica to be synchronized with its source server before it initiates the promotion to a standalone server.": { "$ref": "./examples/PromoteReplicaAsForcedStandaloneServer.json" }, - "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.": { + "Switch over a read replica to primary server with planned data synchronization. Meaning that it waits for data in the read replica to be fully synchronized with its source server before it initiates the switching of roles between the read replica and the primary server.": { "$ref": "./examples/PromoteReplicaAsPlannedSwitchover.json" }, - "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.": { + "Switch over a read replica to primary server with forced data synchronization. Meaning that it doesn't wait for data in the read replica to be synchronized with its source server before it initiates the switching of roles between the read replica and the primary server.": { "$ref": "./examples/PromoteReplicaAsForcedSwitchover.json" } }, - "description": "Updates an existing server. The request body can contain one to many of the properties present in the normal server definition.", + "description": "Updates an existing server. The request body can contain one or multiple of the properties present in the normal server definition.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" @@ -178,7 +178,7 @@ "schema": { "$ref": "#/definitions/ServerForUpdate" }, - "description": "The required parameters for updating a server." + "description": "Parameters required to update a flexible server." } ], "responses": { @@ -214,11 +214,11 @@ ], "operationId": "Servers_Delete", "x-ms-examples": { - "ServerDelete": { + "Delete or drop an existing flexible server.": { "$ref": "./examples/ServerDelete.json" } }, - "description": "Deletes a server.", + "description": "Deletes or drops an existing flexible server.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" @@ -266,17 +266,17 @@ ], "operationId": "Servers_Get", "x-ms-examples": { - "ServerGet": { + "Get information about an existing flexible server.": { "$ref": "./examples/ServerGet.json" }, - "ServerGetWithVnet": { + "Get information about an existing flexible server that is integrated into a virtual network provided by customer.": { "$ref": "./examples/ServerGetWithVnet.json" }, - "ServerGetWithPrivateEndpoints": { + "Get information about an existing flexible server that isn't integrated into a virtual network provided by customer and has private endpoint connections.": { "$ref": "./examples/ServerGetWithPrivateEndpoints.json" } }, - "description": "Gets information about a server.", + "description": "Gets information about an existing flexible server.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" @@ -314,11 +314,11 @@ ], "operationId": "Servers_ListByResourceGroup", "x-ms-examples": { - "ServerListByResourceGroup": { + "List all flexible servers in a resource group.": { "$ref": "./examples/ServerListByResourceGroup.json" } }, - "description": "List all the servers in a given resource group.", + "description": "Lists all flexible servers in a resource group.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" @@ -356,11 +356,11 @@ ], "operationId": "Servers_List", "x-ms-examples": { - "ServerList": { + "List all flexible servers in a subscription.": { "$ref": "./examples/ServerList.json" } }, - "description": "List all the servers in a given subscription.", + "description": "Lists all flexible servers in a subscription.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" @@ -392,7 +392,7 @@ "definitions": { "ServerVersion": { "type": "string", - "description": "The version of a server.", + "description": "Major version of PostgreSQL database engine.", "enum": [ "17", "16", @@ -409,16 +409,16 @@ }, "Replica": { "type": "object", - "description": "Replica properties of a server", + "description": "Replica properties of a flexible server.", "properties": { "role": { "$ref": "#/definitions/ReplicationRole", - "description": "Used to indicate role of the server in replication set." + "description": "Role of the server in a replication set." }, "capacity": { "type": "integer", "format": "int32", - "description": "Replicas allowed for a server.", + "description": "Maximum number of read replicas allowed for a flexible server.", "readOnly": true }, "replicationState": { @@ -435,12 +435,12 @@ "name": "ReplicationState", "modelAsString": true }, - "description": "Gets the replication state of a replica server. This property is returned only for replicas api call. Supported values are Active, Catchup, Provisioning, Updating, Broken, Reconfiguring", + "description": "Indicates the replication state of a read replica. This property is returned only when the target flexible server is a read replica. Possible values are Active, Broken, Catchup, Provisioning, Reconfiguring, and Updating", "readOnly": true }, "promoteMode": { "type": "string", - "description": "Sets the promote mode for a replica server. This is a write only property.", + "description": "Type of operation to apply on the read replica. This property is write only. Standalone means that the read replica will be promoted to a standalone server, and will become a completely independent entity from the replication set. Switchover means that the read replica will roles with the primary server.", "enum": [ "standalone", "switchover" @@ -455,7 +455,7 @@ }, "promoteOption": { "type": "string", - "description": "Sets the promote options for a replica server. This is a write only property.", + "description": "Data synchronization option to use when processing the operation specified in the promoteMode property This property is write only. Planned means that the operation will wait for data in the read replica to be fully synchronized with its source server before it initiates the operation. Forced means that the operation will not wait for data in the read replica to be synchronized with its source server before it initiates the operation.", "enum": [ "planned", "forced" @@ -475,7 +475,7 @@ "properties": { "administratorLogin": { "type": "string", - "description": "The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation).", + "description": "Name of the login designated as the first password based administrator assigned to your instance of PostgreSQL. Must be specified the first time that you enable password based authentication on a server. Once set to a given value, it cannot be changed for the rest of the life of a server. If you disable password based authentication on a server which had it enabled, this password based role isn't deleted.", "x-ms-mutability": [ "create", "read" @@ -483,7 +483,7 @@ }, "administratorLoginPassword": { "type": "string", - "description": "The administrator login password (required for server creation).", + "description": "Password assigned to the administrator login. As long as password authentication is enabled, this password can be changed at any time.", "x-ms-secret": true, "format": "password", "x-ms-mutability": [ @@ -493,16 +493,16 @@ }, "version": { "$ref": "#/definitions/ServerVersion", - "description": "PostgreSQL Server version." + "description": "Major version of PostgreSQL database engine." }, "minorVersion": { "type": "string", - "description": "The minor version of the server.", + "description": "Minor version of PostgreSQL database engine.", "readOnly": true }, "state": { "type": "string", - "description": "A state of a server that is visible to user.", + "description": "Possible states of a flexible server.", "readOnly": true, "enum": [ "Ready", @@ -523,43 +523,43 @@ }, "fullyQualifiedDomainName": { "type": "string", - "description": "The fully qualified domain name of a server.", + "description": "Fully qualified domain name of a flexible server.", "readOnly": true }, "storage": { "$ref": "#/definitions/Storage", "default": null, - "description": "Storage properties of a server." + "description": "Storage properties of a flexible server." }, "authConfig": { "$ref": "#/definitions/AuthConfig", "default": null, - "description": "AuthConfig properties of a server." + "description": "Authentication configuration properties of a flexible server." }, "dataEncryption": { "$ref": "#/definitions/DataEncryption", "default": null, - "description": "Data encryption properties of a server." + "description": "Data encryption properties of a flexible server." }, "backup": { "$ref": "#/definitions/Backup", "default": null, - "description": "Backup properties of a server." + "description": "Backup properties of a flexible server." }, "network": { "$ref": "#/definitions/Network", "default": null, - "description": "Network properties of a server. This Network property is required to be passed only in case you want the server to be Private access server." + "description": "Network properties of a flexible server. Only required if you want your server to be integrated into a virtual network provided by customer." }, "highAvailability": { "$ref": "#/definitions/HighAvailability", "default": null, - "description": "High availability properties of a server." + "description": "High availability properties of a flexible server." }, "maintenanceWindow": { "$ref": "#/definitions/MaintenanceWindow", "default": null, - "description": "Maintenance window properties of a server.", + "description": "Maintenance window properties of a flexible server.", "x-ms-mutability": [ "update", "read" @@ -574,7 +574,7 @@ } ] }, - "description": "The source server resource ID to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'GeoRestore' or 'Replica' or 'ReviveDropped'. This property is returned only for Replica server", + "description": "Identifier of the flexible server to be used as the source of the new flexible server. Required when 'createMode' is 'PointInTimeRestore', 'GeoRestore', 'Replica', or 'ReviveDropped'. This property is returned only when the target flexible server is a read replica.", "x-ms-mutability": [ "create", "read" @@ -583,7 +583,7 @@ "pointInTimeUTC": { "type": "string", "format": "date-time", - "description": "Restore point creation time (ISO8601 format), specifying the time to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'GeoRestore' or 'ReviveDropped'.", + "description": "Creation time (in ISO8601 format) of the backup which you want to restore in the new flexible server. It's required when 'createMode' is 'PointInTimeRestore', 'GeoRestore', or 'ReviveDropped'.", "x-ms-mutability": [ "create" ] @@ -591,7 +591,7 @@ "availabilityZone": { "type": "string", "default": "", - "description": "availability zone information of the server.", + "description": "Availability zone of a flexible server.", "x-ms-mutability": [ "create", "read" @@ -599,17 +599,17 @@ }, "replicationRole": { "$ref": "#/definitions/ReplicationRole", - "description": "Replication role of the server" + "description": "Role of the server in a replication set." }, "replicaCapacity": { "type": "integer", "format": "int32", - "description": "Replicas allowed for a server.", + "description": "Maximum number of read replicas allowed for a flexible server.", "readOnly": true }, "replica": { "$ref": "#/definitions/Replica", - "description": "Replica properties of a server. These Replica properties are required to be passed only in case you want to Promote a server.", + "description": "Read replica properties of a flexible server. Required only in case that you want to promote a server.", "x-ms-mutability": [ "read", "update" @@ -617,7 +617,7 @@ }, "createMode": { "type": "string", - "description": "The mode to create a new PostgreSQL server.", + "description": "Creation mode of a new flexible server.", "enum": [ "Default", "Create", @@ -641,13 +641,13 @@ "items": { "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection" }, - "description": "List of private endpoint connections associated with the specified resource.", + "description": "List of private endpoint connections associated with the specified flexible server.", "readOnly": true }, "cluster": { "$ref": "#/definitions/Cluster", "default": null, - "description": "Cluster properties of a server.", + "description": "Cluster properties of a flexible server.", "x-ms-mutability": [ "create", "read", @@ -655,23 +655,23 @@ ] } }, - "description": "The properties of a server." + "description": "Properties of a flexible server." }, "Server": { "type": "object", "properties": { "sku": { "$ref": "#/definitions/Sku", - "description": "The SKU (pricing tier) of the server." + "description": "Compute tier and size of a flexible server." }, "identity": { "$ref": "#/definitions/UserAssignedIdentity", - "description": "Describes the identity of the application." + "description": "User assigned managed identities assigned to the flexible server." }, "properties": { "$ref": "#/definitions/ServerProperties", "x-ms-client-flatten": true, - "description": "Properties of the server." + "description": "Properties of a flexible server." } }, "allOf": [ @@ -679,14 +679,14 @@ "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/TrackedResource" } ], - "description": "Represents a server." + "description": "Flexible server." }, "ServerPropertiesForUpdate": { "type": "object", "properties": { "administratorLogin": { "type": "string", - "description": "The administrator's login name of a server. Can only be specified when the server is trying to switch to password authentication and does not have default administrator login.", + "description": "Name of the login designated as the first password based administrator assigned to your instance of PostgreSQL. Must be specified the first time that you enable password based authentication on a server. Once set to a given value, it cannot be changed for the rest of the life of a server. If you disable password based authentication on a server which had it enabled, this password based role isn't deleted.", "x-ms-mutability": [ "update", "read" @@ -694,36 +694,36 @@ }, "administratorLoginPassword": { "type": "string", + "description": "Password assigned to the administrator login. As long as password authentication is enabled, this password can be changed at any time.", "x-ms-secret": true, "format": "password", - "description": "The password of the administrator login.", "x-ms-mutability": [ "update" ] }, "version": { "$ref": "#/definitions/ServerVersion", - "description": "PostgreSQL Server version. Version 17 is currently not supported for MVU." + "description": "Major version of PostgreSQL database engine." }, "storage": { "$ref": "#/definitions/Storage", "default": null, - "description": "Storage properties of a server." + "description": "Storage properties of a flexible server." }, "backup": { "$ref": "#/definitions/Backup", "default": null, - "description": "Backup properties of a server." + "description": "Backup properties of a flexible server." }, "highAvailability": { "$ref": "#/definitions/HighAvailability", "default": null, - "description": "High availability properties of a server." + "description": "High availability properties of a flexible server." }, "maintenanceWindow": { "$ref": "#/definitions/MaintenanceWindow", "default": null, - "description": "Maintenance window properties of a server.", + "description": "Maintenance window properties of a flexible server.", "x-ms-mutability": [ "update", "read" @@ -732,16 +732,16 @@ "authConfig": { "$ref": "#/definitions/AuthConfig", "default": null, - "description": "AuthConfig properties of a server." + "description": "Authentication configuration properties of a flexible server." }, "dataEncryption": { "$ref": "#/definitions/DataEncryption", "default": null, - "description": "Data encryption properties of a server." + "description": "Data encryption properties of a flexible server." }, "createMode": { "type": "string", - "description": "The mode to update a new PostgreSQL server.", + "description": "Update mode of an existing flexible server.", "enum": [ "Default", "Update" @@ -756,11 +756,11 @@ }, "replicationRole": { "$ref": "#/definitions/ReplicationRole", - "description": "Replication role of the server" + "description": "Role of the server in a replication set." }, "replica": { "$ref": "#/definitions/Replica", - "description": "Replica properties of a server. These Replica properties are required to be passed only in case you want to Promote a server.", + "description": "Read replica properties of a flexible server. Required only in case that you want to promote a server.", "x-ms-mutability": [ "read", "update" @@ -769,12 +769,12 @@ "network": { "$ref": "#/definitions/Network", "default": null, - "description": "Network properties of a server. These are required to be passed only in case if server is a private access server." + "description": "Network properties of a flexible server. Only required if you want your server to be integrated into a virtual network provided by customer." }, "cluster": { "$ref": "#/definitions/Cluster", "default": null, - "description": "Cluster properties of a server.", + "description": "Cluster properties of a flexible server.", "x-ms-mutability": [ "create", "read", @@ -788,7 +788,7 @@ "properties": { "sku": { "$ref": "#/definitions/Sku", - "description": "The SKU (pricing tier) of the server." + "description": "Compute tier and size of a flexible server." }, "identity": { "$ref": "#/definitions/UserAssignedIdentity", @@ -831,11 +831,11 @@ "properties": { "name": { "type": "string", - "description": "The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3." + "description": "Name by which is known a given compute size assigned to a flexible server." }, "tier": { "type": "string", - "description": "The tier of the particular SKU, e.g. Burstable.", + "description": "Tier of the compute assigned to a flexible server.", "enum": [ "Burstable", "GeneralPurpose", @@ -851,7 +851,7 @@ "name", "tier" ], - "description": "Sku information related properties of a server." + "description": "Compute information of a flexible server." }, "Storage": { "type": "object", @@ -859,11 +859,11 @@ "storageSizeGB": { "type": "integer", "format": "int32", - "description": "Max storage allowed for a server." + "description": "Size of storage assigned to a flexible server." }, "autoGrow": { "type": "string", - "description": "Flag to enable / disable Storage Auto grow for flexible server.", + "description": "Flag to enable or disable the automatic growth of storage size of a flexible server when available space is nearing zero and conditions allow for automatically growing storage size.", "enum": [ "Enabled", "Disabled" @@ -875,7 +875,7 @@ }, "tier": { "type": "string", - "description": "Name of storage tier for IOPS.", + "description": "Storage tier of a flexible server.", "enum": [ "P1", "P2", @@ -900,12 +900,12 @@ "iops": { "type": "integer", "format": "int32", - "description": "Storage IOPS quantity. This property is required to be set for storage Type PremiumV2_LRS and UltraSSD_LRS." + "description": "Maximum IOPS supported for storage. Required when type of storage is PremiumV2_LRS or UltraSSD_LRS." }, "throughput": { "type": "integer", "format": "int32", - "description": "Storage throughput for the server. This is required to be set for storage Type PremiumV2_LRS and UltraSSD_LRS." + "description": "Maximum throughput supported for storage. Required when type of storage is PremiumV2_LRS or UltraSSD_LRS." }, "type": { "type": "string", @@ -918,17 +918,17 @@ "name": "StorageType", "modelAsString": true }, - "description": "Storage type for the server. Allowed values are Premium_LRS, PremiumV2_LRS, and UltraSSD_LRS. Default is Premium_LRS if not specified" + "description": "Type of storage assigned to a flexible server. Allowed values are Premium_LRS, PremiumV2_LRS, or UltraSSD_LRS. If not specified, it defaults to Premium_LRS." } }, - "description": "Storage properties of a server" + "description": "Storage properties of a flexible server." }, "AuthConfig": { "type": "object", "properties": { "activeDirectoryAuth": { "type": "string", - "description": "If Enabled, Microsoft Entra authentication is enabled.", + "description": "Indicates if the server supports Microsoft Entra authentication.", "enum": [ "Enabled", "Disabled" @@ -941,7 +941,7 @@ "passwordAuth": { "type": "string", "default": "Enabled", - "description": "If Enabled, Password authentication is enabled.", + "description": "Indicates if the server supports password based authentication.", "enum": [ "Enabled", "Disabled" @@ -954,33 +954,33 @@ "tenantId": { "type": "string", "default": "", - "description": "Tenant id of the server." + "description": "Identifier of the tenant of the delegated resource." } }, - "description": "Authentication configuration properties of a server" + "description": "Authentication configuration properties of a flexible server." }, "DataEncryption": { "type": "object", "properties": { "primaryKeyURI": { "type": "string", - "description": "URI for the key in keyvault for data encryption of the primary server." + "description": "URI of the key in Azure Key Vault used for data encryption of the primary storage associated to a flexible server." }, "primaryUserAssignedIdentityId": { "type": "string", - "description": "Resource Id for the User assigned identity to be used for data encryption of the primary server." + "description": "Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the primary storage associated to a flexible server." }, "geoBackupKeyURI": { "type": "string", - "description": "URI for the key in keyvault for data encryption for geo-backup of server." + "description": "Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the geographically redundant storage associated to a flexible server that is configured to support geographically redundant backups." }, "geoBackupUserAssignedIdentityId": { "type": "string", - "description": "Resource Id for the User assigned identity to be used for data encryption for geo-backup of server." + "description": "Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the geographically redundant storage associated to a flexible server that is configured to support geographically redundant backups." }, "type": { "type": "string", - "description": "Data encryption type to depict if it is System Managed vs Azure Key vault.", + "description": "Data encryption type used by a flexible server.", "enum": [ "SystemManaged", "AzureKeyVault" @@ -992,7 +992,7 @@ }, "primaryEncryptionKeyStatus": { "type": "string", - "description": "Primary encryption key status for Data encryption enabled server.", + "description": "Status of key used by a flexible server configured with data encryption based on customer managed key, to encrypt the primary storage associated to the server.", "x-ms-mutability": [ "read" ], @@ -1007,7 +1007,7 @@ }, "geoBackupEncryptionKeyStatus": { "type": "string", - "description": "Geo-backup encryption key status for Data encryption enabled server.", + "description": "Status of key used by a flexible server configured with data encryption based on customer managed key, to encrypt the geographically redundant storage associated to the server when it is configured to support geographically redundant backups.", "x-ms-mutability": [ "read" ], @@ -1021,25 +1021,25 @@ } } }, - "description": "Data encryption properties of a server" + "description": "Data encryption properties of a flexible server." }, "UserIdentity": { - "description": "Describes a single user-assigned identity associated with the application.", + "description": "User assigned managed identity associated with a flexible server.", "type": "object", "properties": { "principalId": { "type": "string", - "description": "the object identifier of the Service Principal which this identity represents." + "description": "Identifier of the object of the service principal associated to the user assigned managed identity." }, "clientId": { "type": "string", - "description": "the client identifier of the Service Principal which this identity represents." + "description": "Identifier of the client of the service principal associated to the user assigned managed identity." } } }, "UserAssignedIdentityMap": { "type": "object", - "description": "Defines a map that contains user assigned identities.", + "description": "Map of user assigned managed identities.", "additionalProperties": { "$ref": "#/definitions/UserIdentity" } @@ -1049,15 +1049,15 @@ "properties": { "userAssignedIdentities": { "$ref": "#/definitions/UserAssignedIdentityMap", - "description": "represents user assigned identities map." + "description": "Map of user assigned managed identities." }, "principalId": { "type": "string", - "description": "the identity principal Id of the server." + "description": "Identifier of the object of the service principal associated to the user assigned managed identity." }, "type": { "type": "string", - "description": "the types of identities associated with this resource", + "description": "Types of identities associated with a flexible server.", "enum": [ "None", "UserAssigned", @@ -1071,18 +1071,18 @@ }, "tenantId": { "type": "string", - "description": "Tenant id of the server.", + "description": "Identifier of the tenant of a flexible server.", "readOnly": true } }, "required": [ "type" ], - "description": "Information describing the identities associated with this application." + "description": "Identities associated with a flexible server." }, "ReplicationRole": { "type": "string", - "description": "Used to indicate role of the server in replication set.", + "description": "Role of the flexible server in a replication set.", "enum": [ "None", "Primary", @@ -1101,12 +1101,12 @@ "type": "integer", "format": "int32", "default": 7, - "description": "Backup retention days for the server." + "description": "Backup retention days for the flexible server." }, "geoRedundantBackup": { "type": "string", "default": "Disabled", - "description": "A value indicating whether Geo-Redundant backup is enabled on the server.", + "description": "Indicates if the server is configured to create geographically redundant backups.", "enum": [ "Enabled", "Disabled" @@ -1123,18 +1123,18 @@ "earliestRestoreDate": { "type": "string", "format": "date-time", - "description": "The earliest restore point time (ISO8601 format) for server.", + "description": "Earliest restore point time (ISO8601 format) for a flexible server.", "readOnly": true } }, - "description": "Backup properties of a server" + "description": "Backup properties of a flexible server." }, "Network": { "type": "object", "properties": { "publicNetworkAccess": { "type": "string", - "description": "public network access is enabled or not", + "description": "Indicates if public network access is enabled or not.", "enum": [ "Enabled", "Disabled" @@ -1153,7 +1153,7 @@ } ] }, - "description": "Delegated subnet arm resource id. This is required to be passed during create, in case we want the server to be VNET injected, i.e. Private access server. During update, pass this only if we want to update the value for Private DNS zone." + "description": "Resource identifier of the delegated subnet. Required during creation of a new server, in case you want the server to be integrated into your own virtual network. For an update operation, you only have to provide this property if you want to change the value assigned for the private DNS zone." }, "privateDnsZoneArmResourceId": { "type": "string", @@ -1164,10 +1164,10 @@ } ] }, - "description": "Private dns zone arm resource id. This is required to be passed during create, in case we want the server to be VNET injected, i.e. Private access server. During update, pass this only if we want to update the value for Private DNS zone." + "description": "Identifier of the private DNS zone. Required during creation of a new server, in case you want the server to be integrated into your own virtual network. For an update operation, you only have to provide this property if you want to change the value assigned for the private DNS zone." } }, - "description": "Network properties of a server." + "description": "Network properties of a flexible server." }, "HighAvailability": { "type": "object", @@ -1175,7 +1175,7 @@ "mode": { "type": "string", "default": "Disabled", - "description": "The HA mode for the server.", + "description": "High availability mode for a flexible server.", "enum": [ "Disabled", "ZoneRedundant", @@ -1188,7 +1188,7 @@ }, "state": { "type": "string", - "description": "A state of a HA server that is visible to user.", + "description": "Possible states of the standby server created when high availability is set to SameZone or ZoneRedundant.", "enum": [ "NotEnabled", "CreatingStandby", @@ -1206,49 +1206,49 @@ "standbyAvailabilityZone": { "type": "string", "default": "", - "description": "availability zone information of the standby." + "description": "Availability zone associated to the standby server created when high availability is set to SameZone or ZoneRedundant." } }, - "description": "High availability properties of a server" + "description": "High availability properties of a flexible server." }, "MaintenanceWindow": { "type": "object", - "description": "Maintenance window properties of a server.", + "description": "Maintenance window properties of a flexible server.", "properties": { "customWindow": { "type": "string", "default": "Disabled", - "description": "indicates whether custom window is enabled or disabled" + "description": "Indicates whether custom window is enabled or disabled." }, "startHour": { "type": "integer", "format": "int32", "default": 0, - "description": "start hour for maintenance window" + "description": "Start hour to be used for maintenance window." }, "startMinute": { "type": "integer", "format": "int32", "default": 0, - "description": "start minute for maintenance window" + "description": "Start minute to be used for maintenance window." }, "dayOfWeek": { "type": "integer", "format": "int32", "default": 0, - "description": "day of week for maintenance window" + "description": "Day of the week to be used for maintenance window." } } }, "Cluster": { "type": "object", - "description": "Cluster properties of a server.", + "description": "Cluster properties of a flexible server.", "properties": { "clusterSize": { "type": "integer", "format": "int32", "default": 0, - "description": "The node count for the cluster." + "description": "Number of nodes assigned to the elastic cluster." } } } diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/LongTermRetentionOperation.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/LongTermRetentionOperation.json index efbdec119bb0..16c92dcc6829 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/LongTermRetentionOperation.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/LongTermRetentionOperation.json @@ -2,7 +2,7 @@ "swagger": "2.0", "info": { "title": "PostgreSQLManagementClient", - "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.", + "description": "The Azure Database for PostgreSQL management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, network configuration, security alert policies, log files and configurations with new business model.", "version": "2025-01-01-preview" }, "host": "management.azure.com", @@ -36,7 +36,7 @@ "paths": { "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/ltrPreBackup": { "post": { - "description": "PreBackup operation performs all the checks that are needed for the subsequent long term retention backup operation to succeed.", + "description": "Performs all checks required so that a subsequent long term retention backup operation succeeds.", "tags": [ "LongTermRetentionBackup" ], diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/Migrations.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/Migrations.json index bdb2fffffcf3..2d4c279c944b 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/Migrations.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/Migrations.json @@ -2,7 +2,7 @@ "swagger": "2.0", "info": { "title": "PostgreSQLManagementClient", - "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.", + "description": "The Azure Database for PostgreSQL management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, network configuration, security alert policies, log files and configurations with new business model.", "version": "2025-01-01-preview" }, "host": "management.azure.com", @@ -41,25 +41,25 @@ ], "operationId": "Migrations_Create", "x-ms-examples": { - "Migrations_Create": { + "Create a migration.": { "$ref": "./examples/Migrations_Create.json" }, - "Migrations Create by passing user names": { + "Create a migration specifying user names.": { "$ref": "./examples/Migrations_Create_With_Other_Users.json" }, - "Migrations Create with roles": { + "Create a migration with roles.": { "$ref": "./examples/Migrations_Create_With_Roles.json" }, - "Migrations Create with private endpoint": { + "Create a migration with private endpoint.": { "$ref": "./examples/Migrations_Create_With_PrivateEndpoint_Servers.json" }, - "Create Migration with other source types for Validate and Migrate": { + "Create a migration with other source type for validating and migrating.": { "$ref": "./examples/Migrations_Create_Other_SourceTypes_Validate_Migrate.json" }, - "Create Pre-migration Validation": { + "Create a migration for validating only.": { "$ref": "./examples/Migrations_Create_Validate_Only.json" }, - "Migrations Create with fully qualified domain name": { + "Create a migration with fully qualified domain names for source and target servers.": { "$ref": "./examples/Migrations_Create_With_FullyQualifiedDomainName.json" } }, @@ -87,12 +87,12 @@ "schema": { "$ref": "#/definitions/MigrationResource" }, - "description": "The required parameters for creating a migration." + "description": "Parameters required for creating a migration." } ], "responses": { "200": { - "description": "Successfully set or update the Migration for a server", + "description": "Successfully set or update the Migration for a server.", "schema": { "$ref": "#/definitions/MigrationResource" } @@ -117,23 +117,23 @@ ], "operationId": "Migrations_Get", "x-ms-examples": { - "Migrations_Get": { + "Get information about a migration.": { "$ref": "./examples/Migrations_Get.json" }, - "Migrations_GetMigrationWithValidationFailures": { + "Get information about a migration with validation failures.": { "$ref": "./examples/Migrations_GetMigrationWithValidationFailures.json" }, - "Migrations_GetMigrationWithSuccessfulValidationOnly": { + "Get information about a migration with successful validation only.": { "$ref": "./examples/Migrations_GetMigrationWithSuccessfulValidationOnly.json" }, - "Migrations_GetMigrationWithSuccessfulValidationButMigrationFailure": { + "Get information about a migration with successful validation but failed migration.": { "$ref": "./examples/Migrations_GetMigrationWithSuccessfulValidationButMigrationFailure.json" }, - "Migrations_GetMigrationWithSuccessfulValidationAndMigration": { + "Get information about a migration with successful validation and successful migration.": { "$ref": "./examples/Migrations_GetMigrationWithSuccessfulValidationAndMigration.json" } }, - "description": "Gets details of a migration.", + "description": "Gets information about a migration.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" @@ -172,10 +172,10 @@ ], "operationId": "Migrations_Update", "x-ms-examples": { - "Migrations_Update": { + "Update an existing migration.": { "$ref": "./examples/Migrations_Update.json" }, - "Cancel migration": { + "Cancel an existing migration.": { "$ref": "./examples/Migrations_Cancel.json" } }, @@ -203,7 +203,7 @@ "schema": { "$ref": "#/definitions/MigrationResourceForPatch" }, - "description": "The required parameters for updating a migration." + "description": "Parameters required to update an existing migration." } ], "responses": { @@ -227,11 +227,11 @@ ], "operationId": "Migrations_Delete", "x-ms-examples": { - "Migrations_Delete": { + "Delete an existing migration.": { "$ref": "./examples/Migrations_Delete.json" } }, - "description": "Deletes a migration.", + "description": "Deletes an existing migration.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" @@ -272,11 +272,11 @@ ], "operationId": "Migrations_ListByTargetServer", "x-ms-examples": { - "Migrations_ListByTargetServer": { + "List all migrations of a target flexible server.": { "$ref": "./examples/Migrations_ListByTargetServer.json" } }, - "description": "List all the migrations on a given target server.", + "description": "Lists all migrations of a target flexible server.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" @@ -315,15 +315,15 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{targetDbServerName}/checkMigrationNameAvailability": { "post": { - "summary": "Check migration name validity and availability", - "description": "This method checks whether a proposed migration name is valid and available.", + "summary": "Check the validity and availability of the given name, to assign it to a new migration.", + "description": "Checks if a proposed migration name is valid and available.", "tags": [ "Custom operation", "POST" ], "operationId": "CheckMigrationNameAvailability", "x-ms-examples": { - "CheckMigrationNameAvailability": { + "Check the validity and availability of the given name, to assign it to a new migration.": { "$ref": "./examples/CheckMigrationNameAvailability.json" } }, @@ -347,7 +347,7 @@ "schema": { "$ref": "#/definitions/MigrationNameAvailabilityResource" }, - "description": "The required parameters for checking if a migration name is available." + "description": "Parameters required to check if a migration name is valid and available." } ], "responses": { @@ -373,7 +373,7 @@ "properties": { "properties": { "$ref": "#/definitions/MigrationResourceProperties", - "description": "Migration resource properties.", + "description": "Migration properties.", "x-ms-client-flatten": true } }, @@ -382,7 +382,7 @@ "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/TrackedResource" } ], - "description": "Represents a migration resource." + "description": "Migration." }, "MigrationResourceProperties": { "type": "object", @@ -390,64 +390,64 @@ "migrationId": { "type": "string", "readOnly": true, - "description": "ID for migration, a GUID." + "description": "Identifier of a migration." }, "currentStatus": { "$ref": "#/definitions/MigrationStatus", "readOnly": true, - "description": "Current status of migration" + "description": "Current status of a migration." }, "migrationInstanceResourceId": { "type": "string", "format": "arm-id", - "description": "ResourceId of the private endpoint migration instance" + "description": "Identifier of the private endpoint migration instance." }, "migrationMode": { "$ref": "#/definitions/MigrationMode", - "description": "There are two types of migration modes Online and Offline" + "description": "Mode used to perform the migration: Online or Offline." }, "migrationOption": { "$ref": "#/definitions/MigrationOption", - "description": "This indicates the supported Migration option for the migration" + "description": "Supported option for a migration." }, "sourceType": { "$ref": "#/definitions/SourceType", - "description": "migration source server type : OnPremises, AWS, GCP, AzureVM, PostgreSQLSingleServer, AWS_RDS, AWS_AURORA, AWS_EC2, GCP_CloudSQL, GCP_AlloyDB, GCP_Compute, EDB, EDB_Oracle_Server, EDB_PostgreSQL, PostgreSQLFlexibleServer, PostgreSQLCosmosDB, Huawei_RDS, Huawei_Compute, Heroku_PostgreSQL, Crunchy_PostgreSQL, ApsaraDB_RDS, Digital_Ocean_Droplets, Digital_Ocean_PostgreSQL, or Supabase_PostgreSQL" + "description": "Source server type used for the migration: ApsaraDB_RDS, AWS, AWS_AURORA, AWS_EC2, AWS_RDS, AzureVM, Crunchy_PostgreSQL, Digital_Ocean_Droplets, Digital_Ocean_PostgreSQL, EDB, EDB_Oracle_Server, EDB_PostgreSQL, GCP, GCP_AlloyDB, GCP_CloudSQL, GCP_Compute, Heroku_PostgreSQL, Huawei_Compute, Huawei_RDS, OnPremises, PostgreSQLCosmosDB, PostgreSQLFlexibleServer, PostgreSQLSingleServer, or Supabase_PostgreSQL" }, "sslMode": { "$ref": "#/definitions/SslMode", - "description": "SSL modes for migration. Default SSL mode for PostgreSQLSingleServer is VerifyFull and Prefer for other source types" + "description": "SSL mode used by a migration. Default SSL mode for 'PostgreSQLSingleServer' is 'VerifyFull'. Default SSL mode for other source types is 'Prefer'." }, "sourceDbServerMetadata": { "$ref": "#/definitions/DbServerMetadata", "readOnly": true, - "description": "Metadata of the source database server" + "description": "Metadata of source database server." }, "targetDbServerMetadata": { "$ref": "#/definitions/DbServerMetadata", "readOnly": true, - "description": "Metadata of the target database server" + "description": "Metadata of target database server." }, "sourceDbServerResourceId": { "type": "string", - "description": "ResourceId of the source database server in case the sourceType is PostgreSQLSingleServer. For other source types this should be ipaddress:port@username or hostname:port@username" + "description": "Identifier of the source database server resource, when 'sourceType' is 'PostgreSQLSingleServer'. For other source types this must be set to ipaddress:port@username or hostname:port@username." }, "sourceDbServerFullyQualifiedDomainName": { "type": "string", - "description": "Source server fully qualified domain name (FQDN) or IP address. It is a optional value, if customer provide it, migration service will always use it for connection" + "description": "Fully qualified domain name (FQDN) or IP address of the source server. This property is optional. When provided, the migration service will always use it to connect to the source server." }, "targetDbServerResourceId": { "type": "string", "readOnly": true, - "description": "ResourceId of the source database server" + "description": "Identifier of the target database server resource." }, "targetDbServerFullyQualifiedDomainName": { "type": "string", - "description": "Target server fully qualified domain name (FQDN) or IP address. It is a optional value, if customer provide it, migration service will always use it for connection" + "description": "Fully qualified domain name (FQDN) or IP address of the target server. This property is optional. When provided, the migration service will always use it to connect to the target server." }, "secretParameters": { "$ref": "#/definitions/MigrationSecretParameters", - "description": "Migration secret parameters" + "description": "Migration secret parameters." }, "dbsToMigrate": { "maxItems": 50, @@ -455,7 +455,7 @@ "items": { "type": "string" }, - "description": "Number of databases to migrate", + "description": "Names of databases to migrate.", "x-ms-identifiers": [] }, "setupLogicalReplicationOnSourceDbIfNeeded": { @@ -468,7 +468,7 @@ "name": "LogicalReplicationOnSourceDbEnum", "modelAsString": true }, - "description": "Indicates whether to setup LogicalReplicationOnSourceDb, if needed" + "description": "Indicates whether to setup LogicalReplicationOnSourceDb, if needed." }, "overwriteDbsInTarget": { "type": "string", @@ -480,17 +480,17 @@ "name": "OverwriteDbsInTargetEnum", "modelAsString": true }, - "description": "Indicates whether the databases on the target server can be overwritten, if already present. If set to False, the migration workflow will wait for a confirmation, if it detects that the database already exists." + "description": "Indicates if databases on the target server can be overwritten when already present. If set to 'False', when the migration workflow detects that the database already exists on the target server, it will wait for a confirmation." }, "migrationWindowStartTimeInUtc": { "format": "date-time", "type": "string", - "description": "Start time in UTC for migration window" + "description": "Start time (UTC) for migration window." }, "migrationWindowEndTimeInUtc": { "format": "date-time", "type": "string", - "description": "End time in UTC for migration window" + "description": "End time (UTC) for migration window." }, "migrateRoles": { "type": "string", @@ -502,7 +502,7 @@ "name": "MigrateRolesEnum", "modelAsString": true }, - "description": "To migrate roles and permissions we need to send this flag as True" + "description": "Indicates if roles and permissions must be migrated." }, "startDataMigration": { "type": "string", @@ -514,7 +514,7 @@ "name": "StartDataMigrationEnum", "modelAsString": true }, - "description": "Indicates whether the data migration should start right away" + "description": "Indicates if data migration must start right away." }, "triggerCutover": { "type": "string", @@ -526,14 +526,14 @@ "name": "TriggerCutoverEnum", "modelAsString": true }, - "description": "To trigger cutover for entire migration we need to send this flag as True" + "description": "Indicates if cutover must be triggered for the entire migration." }, "dbsToTriggerCutoverOn": { "type": "array", "items": { "type": "string" }, - "description": "When you want to trigger cutover for specific databases send triggerCutover flag as True and database names in this array", + "description": "When you want to trigger cutover for specific databases set 'triggerCutover' to 'True' and the names of the specific databases in this array.", "x-ms-identifiers": [] }, "cancel": { @@ -546,18 +546,18 @@ "name": "CancelEnum", "modelAsString": true }, - "description": "To trigger cancel for entire migration we need to send this flag as True" + "description": "Indicates if cancel must be triggered for the entire migration." }, "dbsToCancelMigrationOn": { "type": "array", "items": { "type": "string" }, - "description": "When you want to trigger cancel for specific databases send cancel flag as True and database names in this array", + "description": "When you want to trigger cancel for specific databases set 'triggerCutover' to 'True' and the names of the specific databases in this array.", "x-ms-identifiers": [] } }, - "description": "Migration resource properties." + "description": "Migration." }, "MigrationResourceListResult": { "type": "object", @@ -568,23 +568,23 @@ "$ref": "#/definitions/MigrationResource" }, "readOnly": true, - "description": "A list of migration resources.", + "description": "List of migrations.", "x-ms-identifiers": [] }, "nextLink": { - "description": "The link used to get the next page of migrations.", + "description": "Link used to get the next page of results.", "type": "string", "readOnly": true } }, - "description": "A list of migration resources." + "description": "List of migrations." }, "MigrationResourceForPatch": { "type": "object", "properties": { "properties": { "$ref": "#/definitions/MigrationResourcePropertiesForPatch", - "description": "Migration resource properties.", + "description": "Migration properties.", "x-ms-client-flatten": true }, "tags": { @@ -595,26 +595,26 @@ "description": "Application-specific metadata in the form of key-value pairs." } }, - "description": "Represents a migration resource for patch." + "description": "Migration." }, "MigrationResourcePropertiesForPatch": { "type": "object", "properties": { "sourceDbServerResourceId": { "type": "string", - "description": "ResourceId of the source database server" + "description": "Identifier of the source database server resource, when 'sourceType' is 'PostgreSQLSingleServer'. For other source types this must be set to ipaddress:port@username or hostname:port@username." }, "sourceDbServerFullyQualifiedDomainName": { "type": "string", - "description": "Source server fully qualified domain name (FQDN) or IP address. It is a optional value, if customer provide it, migration service will always use it for connection" + "description": "Fully qualified domain name (FQDN) or IP address of the source server. This property is optional. When provided, the migration service will always use it to connect to the source server." }, "targetDbServerFullyQualifiedDomainName": { "type": "string", - "description": "Target server fully qualified domain name (FQDN) or IP address. It is a optional value, if customer provide it, migration service will always use it for connection" + "description": "Fully qualified domain name (FQDN) or IP address of the target server. This property is optional. When provided, the migration service will always use it to connect to the target server." }, "secretParameters": { "$ref": "#/definitions/MigrationSecretParameters", - "description": "Migration secret parameters" + "description": "Migration secret parameters." }, "dbsToMigrate": { "maxItems": 50, @@ -622,7 +622,7 @@ "items": { "type": "string" }, - "description": "Number of databases to migrate", + "description": "Names of databases to migrate.", "x-ms-identifiers": [] }, "setupLogicalReplicationOnSourceDbIfNeeded": { @@ -635,7 +635,7 @@ "name": "LogicalReplicationOnSourceDbEnum", "modelAsString": true }, - "description": "Indicates whether to setup LogicalReplicationOnSourceDb, if needed" + "description": "Indicates whether to setup LogicalReplicationOnSourceDb, if needed." }, "overwriteDbsInTarget": { "type": "string", @@ -647,12 +647,12 @@ "name": "OverwriteDbsInTargetEnum", "modelAsString": true }, - "description": "Indicates whether the databases on the target server can be overwritten, if already present. If set to False, the migration workflow will wait for a confirmation, if it detects that the database already exists." + "description": "Indicates if databases on the target server can be overwritten when already present. If set to 'False', when the migration workflow detects that the database already exists on the target server, it will wait for a confirmation." }, "migrationWindowStartTimeInUtc": { "format": "date-time", "type": "string", - "description": "Start time in UTC for migration window" + "description": "Start time (UTC) for migration window." }, "migrateRoles": { "type": "string", @@ -664,7 +664,7 @@ "name": "MigrateRolesEnum", "modelAsString": true }, - "description": "To migrate roles and permissions we need to send this flag as True" + "description": "Indicates if roles and permissions must be migrated." }, "startDataMigration": { "type": "string", @@ -676,7 +676,7 @@ "name": "StartDataMigrationEnum", "modelAsString": true }, - "description": "Indicates whether the data migration should start right away" + "description": "Indicates if data migration must start right away." }, "triggerCutover": { "type": "string", @@ -688,14 +688,14 @@ "name": "TriggerCutoverEnum", "modelAsString": true }, - "description": "To trigger cutover for entire migration we need to send this flag as True" + "description": "Indicates if cutover must be triggered for the entire migration." }, "dbsToTriggerCutoverOn": { "type": "array", "items": { "type": "string" }, - "description": "When you want to trigger cutover for specific databases send triggerCutover flag as True and database names in this array", + "description": "When you want to trigger cutover for specific databases set 'triggerCutover' to 'True' and the names of the specific databases in this array.", "x-ms-identifiers": [] }, "cancel": { @@ -708,22 +708,22 @@ "name": "CancelEnum", "modelAsString": true }, - "description": "To trigger cancel for entire migration we need to send this flag as True" + "description": "Indicates if cancel must be triggered for the entire migration." }, "dbsToCancelMigrationOn": { "type": "array", "items": { "type": "string" }, - "description": "When you want to trigger cancel for specific databases send cancel flag as True and database names in this array", + "description": "When you want to trigger cancel for specific databases set 'triggerCutover' to 'True' and the names of the specific databases in this array.", "x-ms-identifiers": [] }, "migrationMode": { "$ref": "#/definitions/MigrationMode", - "description": "There are two types of migration modes Online and Offline" + "description": "Mode used to perform the migration: Online or Offline." } }, - "description": "Migration resource properties for patch." + "description": "Migration properties." }, "MigrationSecretParameters": { "required": [ @@ -735,7 +735,7 @@ "x-ms-secret": true, "x-ms-external": true, "$ref": "#/definitions/AdminCredentials", - "description": "Admin credentials for source and target servers" + "description": "Credentials of administrator users for source and target servers." }, "sourceServerUsername": { "type": "string", @@ -743,7 +743,7 @@ "create", "update" ], - "description": "Gets or sets the username for the source server. This user need not be an admin." + "description": "Gets or sets the name of the user for the source server. This user doesn't need to be an administrator." }, "targetServerUsername": { "type": "string", @@ -751,7 +751,7 @@ "create", "update" ], - "description": "Gets or sets the username for the target server. This user need not be an admin." + "description": "Gets or sets the name of the user for the target server. This user doesn't need to be an administrator." } }, "description": "Migration secret parameters." @@ -771,7 +771,7 @@ "create", "update" ], - "description": "Password for source server." + "description": "Password for the user of the source server." }, "targetServerPassword": { "type": "string", @@ -781,17 +781,17 @@ "create", "update" ], - "description": "Password for target server." + "description": "Password for the user of the target server." } }, - "description": "Server admin credentials." + "description": "Credentials of administrator users for source and target servers." }, "DbServerMetadata": { "type": "object", "properties": { "location": { "type": "string", - "description": "Location of database server", + "description": "Location of database server.", "x-ms-mutability": [ "read" ], @@ -799,16 +799,16 @@ }, "version": { "type": "string", - "description": "Version for database engine" + "description": "Major version of PostgreSQL database engine." }, "storageMb": { "format": "int32", "type": "integer", - "description": "Storage size in MB for database server" + "description": "Storage size (in MB) for database server." }, "sku": { "$ref": "#/definitions/ServerSku", - "description": "SKU for the database server. This object is empty for PG single server" + "description": "Compute tier and size of the database server. This object is empty for an Azure Database for PostgreSQL single server." } }, "description": "Database server metadata." @@ -820,7 +820,7 @@ "Full" ], "type": "string", - "description": "Migration details level.", + "description": "Level of details of a migration.", "x-ms-enum": { "name": "MigrationDetailsLevel", "modelAsString": true @@ -832,7 +832,7 @@ "Online" ], "type": "string", - "description": "There are two types of migration modes Online and Offline", + "description": "Mode used to perform the migration: Online or Offline.", "x-ms-enum": { "name": "MigrationMode", "modelAsString": true @@ -845,7 +845,7 @@ "ValidateAndMigrate" ], "type": "string", - "description": "Supported types of migration request include Validate, Migrate and ValidateAndMigrate", + "description": "Supported option for a migration", "x-ms-enum": { "name": "MigrationOption", "modelAsString": true @@ -862,7 +862,7 @@ "CleaningUp" ], "type": "string", - "description": "Migration state.", + "description": "State of migration.", "x-ms-enum": { "name": "MigrationState", "modelAsString": true @@ -874,20 +874,20 @@ "state": { "$ref": "#/definitions/MigrationState", "readOnly": true, - "description": "State of migration" + "description": "State of migration." }, "error": { "type": "string", "readOnly": true, - "description": "Error message, if any, for the migration state" + "description": "Error message, if any, for the migration state." }, "currentSubStateDetails": { "$ref": "#/definitions/MigrationSubStateDetails", "readOnly": true, - "description": "Current Migration sub state details." + "description": "Current migration sub state details." } }, - "description": "Migration status." + "description": "State of migration." }, "MigrationSubState": { "enum": [ @@ -905,7 +905,7 @@ "ValidationInProgress" ], "type": "string", - "description": "Migration sub state.", + "description": "Substate of migration.", "x-ms-enum": { "name": "MigrationSubState", "modelAsString": true @@ -928,19 +928,19 @@ "$ref": "#/definitions/ValidationDetails" } }, - "description": "Migration sub state details." + "description": "Details of migration substate." }, "DbMigrationStatus": { "type": "object", - "description": "Migration status of an individual database", + "description": "Migration status of a database.", "properties": { "databaseName": { "type": "string", - "description": "Name of the database" + "description": "Name of database." }, "migrationState": { "type": "string", - "description": "Migration db state of an individual database", + "description": "Migration state of a database.", "enum": [ "InProgress", "WaitingForCutoverTrigger", @@ -956,77 +956,77 @@ }, "migrationOperation": { "type": "string", - "description": "Migration operation of an individual database" + "description": "Migration operation of a database." }, "startedOn": { "type": "string", "format": "date-time", - "description": "Start date-time of a migration state" + "description": "Start time of a migration state." }, "endedOn": { "type": "string", "format": "date-time", - "description": "End date-time of a migration state" + "description": "End time of a migration state." }, "fullLoadQueuedTables": { "format": "int32", "type": "integer", - "description": "Number of tables queued for the migration of a DB" + "description": "Number of tables queued for the migration of a database." }, "fullLoadErroredTables": { "format": "int32", "type": "integer", - "description": "Number of tables errored out during the migration of a DB" + "description": "Number of tables encountering errors during the migration of a database." }, "fullLoadLoadingTables": { "format": "int32", "type": "integer", - "description": "Number of tables loading during the migration of a DB" + "description": "Number of tables loading during the migration of a database." }, "fullLoadCompletedTables": { "format": "int32", "type": "integer", - "description": "Number of tables loaded during the migration of a DB" + "description": "Number of tables loaded during the migration of a database." }, "cdcUpdateCounter": { "format": "int32", "type": "integer", - "description": "CDC update counter" + "description": "Change Data Capture update counter." }, "cdcDeleteCounter": { "format": "int32", "type": "integer", - "description": "CDC delete counter" + "description": "Change Data Capture delete counter." }, "cdcInsertCounter": { "format": "int32", "type": "integer", - "description": "CDC insert counter" + "description": "Change Data Capture insert counter." }, "appliedChanges": { "format": "int32", "type": "integer", - "description": "CDC applied changes counter" + "description": "Change Data Capture applied changes counter." }, "incomingChanges": { "format": "int32", "type": "integer", - "description": "CDC incoming changes counter" + "description": "Change Data Capture incoming changes counter." }, "latency": { "format": "int32", "type": "integer", - "description": "Lag in seconds between source and target during online phase" + "description": "Lag in seconds between source and target during online phase." }, "message": { "type": "string", - "description": "Error message, if any, for the migration state" + "description": "Error message, if any, for the migration state." } } }, "ValidationDetails": { "type": "object", - "description": "Details for the validation for migration", + "description": "Details for the validation for migration.", "properties": { "status": { "$ref": "#/definitions/ValidationState" @@ -1034,19 +1034,19 @@ "validationStartTimeInUtc": { "type": "string", "format": "date-time", - "description": "Validation Start date-time in UTC" + "description": "Start time (UTC) for validation." }, "validationEndTimeInUtc": { "type": "string", "format": "date-time", - "description": "Validation End date-time in UTC" + "description": "End time (UTC) for validation." }, "serverLevelValidationDetails": { "type": "array", "items": { "$ref": "#/definitions/ValidationSummaryItem" }, - "description": "Details of server level validations", + "description": "Details of server level validations.", "x-ms-identifiers": [] }, "dbLevelValidationDetails": { @@ -1054,7 +1054,7 @@ "items": { "$ref": "#/definitions/DbLevelValidationStatus" }, - "description": "Details of server level validations", + "description": "Details of server level validations.", "x-ms-identifiers": [ "databaseName" ] @@ -1063,39 +1063,39 @@ }, "DbLevelValidationStatus": { "type": "object", - "description": "Validation status summary for an individual database", + "description": "Validation status summary for a database.", "properties": { "databaseName": { "type": "string", - "description": "Name of the database" + "description": "Name of database." }, "startedOn": { "type": "string", "format": "date-time", - "description": "Start date-time of a database level validation" + "description": "Start time of a database level validation." }, "endedOn": { "type": "string", "format": "date-time", - "description": "End date-time of a database level validation" + "description": "End time of a database level validation." }, "summary": { "type": "array", "items": { "$ref": "#/definitions/ValidationSummaryItem" }, - "description": "Summary of database level validations", + "description": "Summary of database level validations.", "x-ms-identifiers": [] } } }, "ValidationSummaryItem": { "type": "object", - "description": "Validation summary object", + "description": "Validation summary object.", "properties": { "type": { "type": "string", - "description": "Validation type" + "description": "Validation type." }, "state": { "$ref": "#/definitions/ValidationState" @@ -1105,28 +1105,28 @@ "items": { "$ref": "#/definitions/ValidationMessage" }, - "description": "Validation messages", + "description": "Validation messages.", "x-ms-identifiers": [] } } }, "ValidationMessage": { "type": "object", - "description": "Validation message object", + "description": "Validation message object.", "properties": { "state": { "$ref": "#/definitions/ValidationState", - "description": "Severity of validation message" + "description": "Severity of validation message." }, "message": { "type": "string", - "description": "Validation message string" + "description": "Validation message string." } } }, "ValidationState": { "type": "string", - "description": "Validation status for migration", + "description": "Validation status for migration.", "enum": [ "Failed", "Succeeded", @@ -1165,7 +1165,7 @@ "Supabase_PostgreSQL" ], "type": "string", - "description": "Migration source server type : OnPremises, AWS, GCP, AzureVM, PostgreSQLSingleServer, AWS_RDS, AWS_AURORA, AWS_EC2, GCP_CloudSQL, GCP_AlloyDB, GCP_Compute, EDB, EDB_Oracle_Server, EDB_PostgreSQL, PostgreSQLFlexibleServer, PostgreSQLCosmosDB, Huawei_RDS, Huawei_Compute, Heroku_PostgreSQL, Crunchy_PostgreSQL, ApsaraDB_RDS, Digital_Ocean_Droplets, Digital_Ocean_PostgreSQL, or Supabase_PostgreSQL", + "description": "Source server type used for the migration: ApsaraDB_RDS, AWS, AWS_AURORA, AWS_EC2, AWS_RDS, AzureVM, Crunchy_PostgreSQL, Digital_Ocean_Droplets, Digital_Ocean_PostgreSQL, EDB, EDB_Oracle_Server, EDB_PostgreSQL, GCP, GCP_AlloyDB, GCP_CloudSQL, GCP_Compute, Heroku_PostgreSQL, Huawei_Compute, Huawei_RDS, OnPremises, PostgreSQLCosmosDB, PostgreSQLFlexibleServer, PostgreSQLSingleServer, or Supabase_PostgreSQL", "x-ms-enum": { "name": "SourceType", "modelAsString": true @@ -1179,7 +1179,7 @@ "VerifyFull" ], "type": "string", - "description": "Supported SSL modes for migration. VerifyFull is the recommended SSL mode for Single server migration. Prefer, Require are recommended SSL modes for other source types", + "description": "SSL mode used by a migration. Default SSL mode for 'PostgreSQLSingleServer' is 'VerifyFull'. Default SSL mode for other source types is 'Prefer'.", "x-ms-enum": { "name": "SslMode", "modelAsString": true @@ -1190,11 +1190,11 @@ "properties": { "name": { "type": "string", - "description": "The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3." + "description": "Compute tier and size of the database server. This object is empty for an Azure Database for PostgreSQL single server." }, "tier": { "type": "string", - "description": "The tier of the particular SKU, e.g. Burstable.", + "description": "Tier of the compute assigned to a flexible server.", "enum": [ "Burstable", "GeneralPurpose", @@ -1206,7 +1206,7 @@ } } }, - "description": "Sku information related properties of a server." + "description": "Compute information of a flexible server." }, "MigrationNameAvailabilityReason": { "enum": [ @@ -1229,20 +1229,20 @@ "properties": { "name": { "type": "string", - "description": "The resource name to verify." + "description": "Name of the migration to check for validity and availability." }, "type": { "type": "string", - "description": "The type of the resource." + "description": "Type of resource." }, "nameAvailable": { "type": "boolean", - "description": "Indicates whether the resource name is available.", + "description": "Indicates if the migration name is available.", "readOnly": true }, "reason": { "$ref": "#/definitions/MigrationNameAvailabilityReason", - "description": "Migration name availability reason", + "description": "Migration name availability reason.", "readOnly": true }, "message": { @@ -1251,7 +1251,7 @@ "readOnly": true } }, - "description": "Represents a migration name's availability." + "description": "Availability of a migration name." } }, "parameters": { @@ -1260,7 +1260,7 @@ "in": "path", "required": true, "type": "string", - "description": "The subscription ID of the target database server.", + "description": "Identifier of subscription of target database server.", "pattern": "([a-z0-9]){8,8}[-]([a-z0-9]){4,4}[-]([a-z0-9]){4,4}[-]([a-z0-9]){4,4}[-]([a-z0-9]){12,12}", "x-ms-parameter-location": "method" }, @@ -1269,7 +1269,7 @@ "in": "path", "required": true, "type": "string", - "description": "The resource group name of the target database server.", + "description": "Name of resource group of target database server.", "pattern": "^[-a-z0-9A-Z._()]+[^.]$", "x-ms-parameter-location": "method" }, @@ -1278,7 +1278,7 @@ "in": "path", "required": true, "type": "string", - "description": "The name of the target database server.", + "description": "Name of target database server.", "pattern": "([-a-z0-9]){3,63}", "x-ms-parameter-location": "method" }, @@ -1287,7 +1287,7 @@ "in": "path", "required": true, "type": "string", - "description": "The name of the migration.", + "description": "Name of migration.", "pattern": "^[a-z][a-z0-9]*$", "x-ms-parameter-location": "method" }, diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/Operations.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/Operations.json index 7e53778286ac..23202edff22f 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/Operations.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/Operations.json @@ -2,7 +2,7 @@ "swagger": "2.0", "info": { "title": "PostgreSQLManagementClient", - "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.", + "description": "The Azure Database for PostgreSQL management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, network configuration, security alert policies, log files and configurations with new business model.", "version": "2025-01-01-preview" }, "host": "management.azure.com", @@ -41,11 +41,11 @@ ], "operationId": "Operations_List", "x-ms-examples": { - "OperationList": { + "List all available REST API operations.": { "$ref": "./examples/OperationList.json" } }, - "description": "Lists all of the available REST API operations.", + "description": "Lists all available REST API operations.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" @@ -78,22 +78,22 @@ "provider": { "type": "string", "readOnly": true, - "description": "Operation resource provider name." + "description": "Name of the resource provider." }, "resource": { "type": "string", "readOnly": true, - "description": "Resource on which the operation is performed." + "description": "Type of resource on which the operation is performed." }, "operation": { "type": "string", "readOnly": true, - "description": "Localized friendly name for the operation." + "description": "Name of the operation." }, "description": { "type": "string", "readOnly": true, - "description": "Operation description." + "description": "Description of the operation." } }, "description": "Display metadata associated with the operation." @@ -104,21 +104,21 @@ "name": { "type": "string", "readOnly": true, - "description": "The name of the operation being performed on this particular object." + "description": "Name of the operation being performed on this particular object." }, "display": { "$ref": "#/definitions/OperationDisplay", "readOnly": true, - "description": "The localized display information for this particular operation or action." + "description": "Localized display information for this particular operation or action." }, "isDataAction": { - "description": "Indicates whether the operation is a data action", + "description": "Indicates if the operation is a data action.", "type": "boolean" }, "origin": { "type": "string", "readOnly": true, - "description": "The intended executor of the operation.", + "description": "Intended executor of the operation.", "enum": [ "NotSpecified", "user", @@ -142,7 +142,7 @@ "description": "REST API operation definition." }, "OperationListResult": { - "description": "A list of resource provider operations.", + "description": "List of resource provider operations.", "type": "object", "properties": { "value": { @@ -157,7 +157,7 @@ ] }, "nextLink": { - "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "description": "Link used to get the next page of results.", "type": "string" } } diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/PrivateDnsZone.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/PrivateDnsZone.json index e58dfed79fe1..d0fad3779d39 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/PrivateDnsZone.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/PrivateDnsZone.json @@ -1,9 +1,9 @@ { "swagger": "2.0", "info": { - "version": "2025-01-01-preview", "title": "PostgreSQLManagementClient", - "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model." + "description": "The Azure Database for PostgreSQL management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, network configuration, security alert policies, log files and configurations with new business model.", + "version": "2025-01-01-preview" }, "host": "management.azure.com", "schemes": [ @@ -41,11 +41,11 @@ ], "operationId": "GetPrivateDnsZoneSuffix_Execute", "x-ms-examples": { - "GetPrivateDnsZoneSuffix": { + "Get the private DNS suffix.": { "$ref": "./examples/GetPrivateDnsZoneSuffix.json" } }, - "description": "Get private DNS zone suffix in the cloud", + "description": "Gets the private DNS zone suffix.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" @@ -71,7 +71,7 @@ "definitions": { "PrivateDnsZoneSuffix": { "type": "string", - "description": "Represents a resource name availability." + "description": "Private DNS suffix." } } } diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/PrivateEndpointConnections.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/PrivateEndpointConnections.json index bbcd9a2450df..018635325040 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/PrivateEndpointConnections.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/PrivateEndpointConnections.json @@ -2,7 +2,7 @@ "swagger": "2.0", "info": { "title": "PostgreSQLManagementClient", - "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.", + "description": "The Azure Database for PostgreSQL management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, network configuration, security alert policies, log files and configurations with new business model.", "version": "2025-01-01-preview" }, "host": "management.azure.com", @@ -73,7 +73,7 @@ } }, "x-ms-examples": { - "Gets private endpoint connection.": { + "Get a private endpoint connection.": { "$ref": "./examples/PrivateEndpointConnectionGet.json" } } @@ -82,7 +82,7 @@ "tags": [ "PrivateEndpointConnections" ], - "description": "Approve or reject a private endpoint connection with a given name.", + "description": "Approves or rejects a private endpoint connection.", "operationId": "PrivateEndpointConnection_Update", "parameters": [ { @@ -107,7 +107,7 @@ "schema": { "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection" }, - "description": "The required parameters for updating private endpoint connection." + "description": "Parameters required to update a private endpoint connection." } ], "responses": { @@ -140,7 +140,7 @@ }, "x-ms-long-running-operation": true, "x-ms-examples": { - "Approve or reject a private endpoint connection with a given name.": { + "Approve or reject a private endpoint connection.": { "$ref": "./examples/PrivateEndpointConnectionUpdate.json" } } @@ -149,7 +149,7 @@ "tags": [ "PrivateEndpointConnections" ], - "description": "Deletes a private endpoint connection with a given name.", + "description": "Deletes a private endpoint connection.", "operationId": "PrivateEndpointConnection_Delete", "parameters": [ { @@ -192,7 +192,7 @@ "final-state-via": "azure-async-operation" }, "x-ms-examples": { - "Deletes a private endpoint connection with a given name.": { + "Delete a private endpoint connection.": { "$ref": "./examples/PrivateEndpointConnectionDelete.json" } } @@ -203,7 +203,7 @@ "tags": [ "PrivateEndpointConnections" ], - "description": "Gets all private endpoint connections on a server.", + "description": "Lists all private endpoint connections on a flexible server.", "operationId": "PrivateEndpointConnections_ListByServer", "parameters": [ { @@ -237,7 +237,7 @@ "nextLinkName": "nextLink" }, "x-ms-examples": { - "Gets list of private endpoint connections on a server.": { + "List all private endpoint connections on a flexible server.": { "$ref": "./examples/PrivateEndpointConnectionList.json" } } @@ -246,7 +246,7 @@ }, "definitions": { "PrivateEndpointConnectionListResult": { - "description": "A list of private endpoint connections.", + "description": "List of private endpoint connections.", "type": "object", "properties": { "value": { @@ -258,7 +258,7 @@ "readOnly": true }, "nextLink": { - "description": "The URL to get the next set of results.", + "description": "Link used to get the next page of results.", "type": "string", "format": "uri", "readOnly": true diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/PrivateLinkResources.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/PrivateLinkResources.json index 25d5167bdb03..cf6c5d7ae6bb 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/PrivateLinkResources.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/PrivateLinkResources.json @@ -2,7 +2,7 @@ "swagger": "2.0", "info": { "title": "PostgreSQLManagementClient", - "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.", + "description": "The Azure Database for PostgreSQL management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, network configuration, security alert policies, log files and configurations with new business model.", "version": "2025-01-01-preview" }, "host": "management.azure.com", diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/QuotaUsages.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/QuotaUsages.json index ed4ca8c57cdb..cfc8479f4ee7 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/QuotaUsages.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/QuotaUsages.json @@ -2,7 +2,7 @@ "swagger": "2.0", "info": { "title": "PostgreSQLManagementClient", - "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.", + "description": "The Azure Database for PostgreSQL management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, network configuration, security alert policies, log files and configurations with new business model.", "version": "2025-01-01-preview" }, "host": "management.azure.com", diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/Replicas.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/Replicas.json index 97c07e673d6f..f08d22c9ece1 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/Replicas.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/Replicas.json @@ -2,7 +2,7 @@ "swagger": "2.0", "info": { "title": "PostgreSQLManagementClient", - "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.", + "description": "The Azure Database for PostgreSQL management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, network configuration, security alert policies, log files and configurations with new business model.", "version": "2025-01-01-preview" }, "host": "management.azure.com", @@ -41,11 +41,11 @@ ], "operationId": "Replicas_ListByServer", "x-ms-examples": { - "ReplicasListByServer": { + "List all read replicas of a flexible server.": { "$ref": "./examples/ReplicasListByServer.json" } }, - "description": "List all the replicas for a given server.", + "description": "Lists all read replicas of a flexible server.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/ServerLogs.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/ServerLogs.json index a1dac50b682d..a2a3c853f997 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/ServerLogs.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/ServerLogs.json @@ -2,7 +2,7 @@ "swagger": "2.0", "info": { "title": "PostgreSQLManagementClient", - "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.", + "description": "The Azure Database for PostgreSQL management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, network configuration, security alert policies, log files and configurations with new business model.", "version": "2025-01-01-preview" }, "host": "management.azure.com", @@ -41,11 +41,11 @@ ], "operationId": "LogFiles_ListByServer", "x-ms-examples": { - "List all server log files for a server": { + "List all captured logs for download in a flexible server.": { "$ref": "./examples/LogFilesListByServer.json" } }, - "description": "List all the server log files in a given server.", + "description": "Lists all captured logs for download in a flexible server.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" @@ -97,18 +97,18 @@ "sizeInKb": { "type": "integer", "format": "int64", - "description": "The size in kb of the logFile." + "description": "Size (in KB) of the log file." }, "type": { "type": "string", - "description": "Type of the log file." + "description": "Type of log file. Can be 'ServerLogs' or 'UpgradeLogs'." }, "url": { "type": "string", - "description": "The url to download the log file from." + "description": "URL to download the log file from." } }, - "description": "The properties of a logFile." + "description": "Properties of a log file." }, "LogFile": { "type": "object", @@ -116,7 +116,7 @@ "properties": { "$ref": "#/definitions/LogFileProperties", "x-ms-client-flatten": true, - "description": "The properties of a logFile." + "description": "Properties of a log file." } }, "allOf": [ @@ -124,7 +124,7 @@ "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ], - "description": "Represents a logFile." + "description": "Log file." }, "LogFileListResult": { "type": "object", @@ -134,14 +134,14 @@ "items": { "$ref": "#/definitions/LogFile" }, - "description": "The list of logFiles in a server" + "description": "List of log files in a flexible server." }, "nextLink": { - "description": "The link used to get the next page of operations.", + "description": "Link used to get the next page of results.", "type": "string" } }, - "description": "A List of logFiles." + "description": "List of log files." } }, "parameters": {} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/ServerStartStopRestart.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/ServerStartStopRestart.json index 643252603bbd..5ed6e29e9f8a 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/ServerStartStopRestart.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/ServerStartStopRestart.json @@ -2,7 +2,7 @@ "swagger": "2.0", "info": { "title": "PostgreSQLManagementClient", - "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.", + "description": "The Azure Database for PostgreSQL management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, network configuration, security alert policies, log files and configurations with new business model.", "version": "2025-01-01-preview" }, "host": "management.azure.com", @@ -41,14 +41,14 @@ ], "operationId": "Servers_Restart", "x-ms-examples": { - "ServerRestart": { + "Restart PostgreSQL database engine in a flexible server.": { "$ref": "./examples/ServerRestart.json" }, - "ServerRestartWithFailover": { + "Restart PostgreSQL database engine in a flexible server with a forced failover to standby server.": { "$ref": "./examples/ServerRestartWithFailover.json" } }, - "description": "Restarts a server.", + "description": "Restarts PostgreSQL database engine in a flexible server.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" @@ -68,7 +68,7 @@ "schema": { "$ref": "#/definitions/RestartParameter" }, - "description": "The parameters for restarting a server." + "description": "Parameters to restart a flexible server." } ], "responses": { @@ -103,11 +103,11 @@ ], "operationId": "Servers_Start", "x-ms-examples": { - "ServerStart": { + "Start a stopped flexible server.": { "$ref": "./examples/ServerStart.json" } }, - "description": "Starts a server.", + "description": "Starts a stopped flexible server.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" @@ -154,11 +154,11 @@ ], "operationId": "Servers_Stop", "x-ms-examples": { - "ServerStop": { + "Stop a flexible server.": { "$ref": "./examples/ServerStop.json" } }, - "description": "Stops a server.", + "description": "Stops a flexible server.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" @@ -205,7 +205,7 @@ "properties": { "restartWithFailover": { "type": "boolean", - "description": "Indicates whether to restart the server with failover." + "description": "Indicates if restart the PostgreSQL database engine should failover or switch over from primary to standby. This only works if flexible server has high availability enabled." }, "failoverMode": { "type": "string", @@ -222,7 +222,7 @@ } } }, - "description": "Represents server restart parameters." + "description": "PostgreSQL database engine restart parameters." } }, "parameters": {} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/ThreatProtection.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/ThreatProtection.json index e5a95eb1e105..d59705a86025 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/ThreatProtection.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/ThreatProtection.json @@ -2,7 +2,7 @@ "swagger": "2.0", "info": { "title": "PostgreSQLManagementClient", - "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, administrators, log files, configurations, migrations, advanced threat protection settings with new business model.", + "description": "The Azure Database for PostgreSQL management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, administrators, log files, configurations, migrations, advanced threat protection settings with new business model.", "version": "2025-01-01-preview" }, "host": "management.azure.com", @@ -39,7 +39,7 @@ "tags": [ "AdvancedThreatProtectionSettings" ], - "description": "Get a list of server's Threat Protection state.", + "description": "Lists state of advanced threat protection settings for a flexible server.", "operationId": "ServerThreatProtectionSettings_ListByServer", "parameters": [ { @@ -70,7 +70,7 @@ } }, "x-ms-examples": { - "Get a server's Advanced Threat Protection settings": { + "List state of advanced threat protection settings for a flexible server.": { "$ref": "./examples/ServerThreatProtectionSettingsListByServer.json" } }, @@ -84,7 +84,7 @@ "tags": [ "AdvancedThreatProtectionSettings" ], - "description": "Get a server's Advanced Threat Protection settings.", + "description": "Gets state of advanced threat protection settings for a flexible server.", "operationId": "ServerThreatProtectionSettings_Get", "parameters": [ { @@ -118,7 +118,7 @@ } }, "x-ms-examples": { - "Get a server's Threat Protection settings": { + "Get state of advanced threat protection settings for a flexible server.": { "$ref": "./examples/ServerThreatProtectionSettingsGet.json" } } @@ -197,14 +197,14 @@ }, "definitions": { "ServerThreatProtectionProperties": { - "description": "Properties of server Threat Protection state.", + "description": "Properties of advanced threat protection state for a flexible server.", "required": [ "state" ], "type": "object", "properties": { "state": { - "description": "Specifies the state of the Threat Protection, whether it is enabled or disabled or a state has not been applied yet on the specific server.", + "description": "Specifies the state of the advanced threat protection, whether it is enabled, disabled, or a state has not been applied yet on the flexible server.", "enum": [ "Enabled", "Disabled" @@ -217,14 +217,14 @@ }, "creationTime": { "format": "date-time", - "description": "Specifies the UTC creation time of the policy.", + "description": "Specifies the creation time (UTC) of the policy.", "type": "string", "readOnly": true } } }, "ServerThreatProtectionSettingsModel": { - "description": "Server's Advanced Threat Protection settings.", + "description": "Advanced threat protection settings of the flexible server.", "type": "object", "allOf": [ { @@ -234,13 +234,13 @@ "properties": { "properties": { "$ref": "#/definitions/ServerThreatProtectionProperties", - "description": "Advanced Threat Protection properties.", + "description": "Advanced threat protection properties.", "x-ms-client-flatten": true } } }, "ServerThreatProtectionListResult": { - "description": "A list of the server's Advanced Threat Protection settings.", + "description": "List of advanced threat protection settings for a flexible server.", "type": "object", "properties": { "value": { @@ -252,7 +252,7 @@ "readOnly": true }, "nextLink": { - "description": "Link to retrieve next page of results.", + "description": "Link used to get the next page of results.", "type": "string", "readOnly": true } @@ -263,7 +263,7 @@ "ThreatProtectionNameParameter": { "name": "threatProtectionName", "in": "path", - "description": "The name of the Threat Protection state.", + "description": "Name of the advanced threat protection settings.", "required": true, "type": "string", "enum": [ diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/TuningOptions.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/TuningOptions.json index 10672cc71da9..fe1708da05ed 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/TuningOptions.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/TuningOptions.json @@ -2,7 +2,7 @@ "swagger": "2.0", "info": { "title": "PostgreSQLManagementClient", - "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.", + "description": "The Azure Database for PostgreSQL management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, network configuration, security alert policies, log files and configurations with new business model.", "version": "2025-01-01-preview" }, "host": "management.azure.com", @@ -41,11 +41,11 @@ ], "operationId": "TuningOptions_Get", "x-ms-examples": { - "TuningOptions_Get": { + "Get the tuning options of a flexible server.": { "$ref": "./examples/Tuning_GetTuningOption.json" } }, - "description": "Retrieve the tuning option on a server.", + "description": "Gets the tuning options of a flexible server.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" @@ -86,14 +86,14 @@ ], "operationId": "TuningIndex_ListRecommendations", "x-ms-examples": { - "TuningIndex_ListRecommendations": { + "List available recommendations produced by index tuning.": { "$ref": "./examples/TuningIndex_GetRecommendations.json" }, - "TuningIndex_ListFilteredRecommendations": { + "List available recommendations produced by index tuning, exclusively those of create index type.": { "$ref": "./examples/TuningIndex_GetFilteredRecommendations.json" } }, - "description": "Retrieve the list of available tuning index recommendations.", + "description": "Lists available recommendations produced by index tuning.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" @@ -452,11 +452,11 @@ ], "operationId": "TuningOptions_ListByServer", "x-ms-examples": { - "TuningOptions_ListByServer": { + "List the tuning options of a flexible server.": { "$ref": "./examples/Tuning_ListTuningOptions.json" } }, - "description": "Retrieve the list of available tuning options.", + "description": "Lists the tuning options of a flexible server.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" @@ -497,24 +497,24 @@ "properties": { "dimensionName": { "type": "string", - "description": "Dimension name" + "description": "Dimension name." }, "unit": { "type": "string", - "description": "Dimension unit" + "description": "Dimension unit." }, "queryId": { "type": "integer", "format": "int64", - "description": "Optional property that can be used to store the QueryId if the metric is for a specific query." + "description": "Optional property that can be used to store the identifier of the query, if the metric is for a specific query." }, "absoluteValue": { "type": "number", "format": "double", - "description": "Absolute value" + "description": "Absolute value." } }, - "description": "Stores property that features impact on some metric if this recommended action is applied." + "description": "Impact on some metric if this recommended action is applied." }, "IndexRecommendationDetails": { "type": "object", @@ -563,17 +563,17 @@ "initialRecommendedTime": { "type": "string", "format": "date-time", - "description": "Creation time of this recommendation in UTC date-time string format." + "description": "Creation time (UTC) of this recommendation." }, "lastRecommendedTime": { "type": "string", "format": "date-time", - "description": "The last refresh of this recommendation in UTC date-time string format." + "description": "Last time (UTC) that this recommendation was produced." }, "timesRecommended": { "format": "int32", "type": "integer", - "description": "The number of times this recommendation has encountered." + "description": "Number of times this recommendation has been produced." }, "improvedQueryIds": { "type": "array", @@ -581,7 +581,7 @@ "type": "integer", "format": "int64" }, - "description": "The ImprovedQueryIds. The list will only be populated for CREATE INDEX recommendations." + "description": "List of identifiers for all queries identified as targets for improvement if the recommendation is applied. The list is only populated for CREATE INDEX recommendations." }, "recommendationReason": { "type": "string", @@ -605,14 +605,14 @@ "properties": { "method": { "type": "string", - "description": "Method of implementation for recommended action" + "description": "Method of implementation for recommended action." }, "script": { "type": "string", - "description": "Implementation script for the recommended action" + "description": "Implementation script for the recommended action." } }, - "description": "Stores implementation details for the recommended action." + "description": "Implementation details for the recommended action." }, "analyzedWorkload": { "type": "object", @@ -620,20 +620,20 @@ "startTime": { "type": "string", "format": "date-time", - "description": "Workload start time in UTC date-time string format." + "description": "Start time (UTC) of the workload analyzed." }, "endTime": { "type": "string", "format": "date-time", - "description": "Workload end time in UTC date-time string format." + "description": "End time (UTC) of the workload analyzed." }, "queryCount": { "format": "int32", "type": "integer", - "description": "Workload query examined count. For DROP INDEX will be 0." + "description": "Number of queries from the workload that were examined to produce this recommendation. For DROP INDEX recommendations it's 0 (zero)." } }, - "description": "Stores workload information for the recommended action." + "description": "Workload information for the recommended action." }, "estimatedImpact": { "type": "array", @@ -644,11 +644,11 @@ "dimensionName" ], "readOnly": true, - "description": "The estimated impact of this recommended action" + "description": "Estimated impact of this recommended action." }, "details": { "$ref": "#/definitions/IndexRecommendationDetails", - "description": "Stores recommendation details for the recommended action." + "description": "Recommendation details for the recommended action." } }, "description": "Index recommendation properties.", @@ -671,11 +671,11 @@ "description": "Index recommendation properties." }, "IndexRecommendationListResult": { - "description": "A list of available index recommendations.", + "description": "List of available index recommendations.", "type": "object", "properties": { "value": { - "description": "A list of available index recommendations.", + "description": "List of available index recommendations.", "uniqueItems": false, "type": "array", "items": { @@ -686,7 +686,7 @@ ] }, "nextLink": { - "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "description": "Link used to get the next page of results.", "type": "string" } } @@ -698,14 +698,14 @@ "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ], - "description": "Stores property that features impact on some metric if this recommended action is applied." + "description": "Impact on some metric if this recommended action is applied." }, "TuningOptionsListResult": { - "description": "A list of server tuning options.", + "description": "List of server tuning options.", "type": "object", "properties": { "value": { - "description": "A list of available tuning options.", + "description": "List of available tuning options.", "uniqueItems": false, "type": "array", "items": { @@ -716,7 +716,7 @@ ] }, "nextLink": { - "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "description": "Link used to get the next page of results.", "type": "string" } } @@ -726,41 +726,41 @@ "properties": { "sessionStartTime": { "type": "string", - "description": "the tuning session start time." + "description": "Start time of the tuning session." }, "sessionId": { "type": "string", - "description": "Session id." + "description": "Identifier of the tuning session." }, "status": { "type": "string", - "description": "The status of the tuning session." + "description": "Status of the tuning session." }, "preTuningAqr": { "type": "string", - "description": "The pre tuning aqr." + "description": "Average query runtime before tuning starts." }, "postTuningAqr": { "type": "string", - "description": "The post tuning aqr." + "description": "Average query runtime after tuning completes." }, "preTuningTps": { "type": "string", - "description": "The pre tuning tps." + "description": "Transactions per second before tuning starts." }, "postTuningTps": { "type": "string", - "description": "The post tuning tps." + "description": "Transactions per second after tuning completes." } }, "description": "Session resource properties." }, "SessionsListResult": { - "description": "A list of tuning configuration sessions.", + "description": "List of tuning configuration sessions.", "type": "object", "properties": { "value": { - "description": "A list of tuning configuration sessions.", + "description": "List of tuning configuration sessions.", "uniqueItems": false, "type": "array", "items": { @@ -771,7 +771,7 @@ ] }, "nextLink": { - "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "description": "Link used to get the next page of results.", "type": "string" } } @@ -822,7 +822,7 @@ ] }, "nextLink": { - "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "description": "Link used to get the next page of results.", "type": "string" } } @@ -860,7 +860,7 @@ "index", "configuration" ], - "description": "The name of the tuning option.", + "description": "Name of the tuning option.", "x-ms-enum": { "name": "TuningOptionEnum", "modelAsString": true diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/VirtualEndpoints.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/VirtualEndpoints.json index efac29cdabd1..6c04e5817ea3 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/VirtualEndpoints.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2025-01-01-preview/VirtualEndpoints.json @@ -2,7 +2,7 @@ "swagger": "2.0", "info": { "title": "PostgreSQLManagementClient", - "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.", + "description": "The Azure Database for PostgreSQL management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, network configuration, security alert policies, log files and configurations with new business model.", "version": "2025-01-01-preview" }, "host": "management.azure.com", @@ -41,11 +41,11 @@ ], "operationId": "VirtualEndpoints_Create", "x-ms-examples": { - "Create a new virtual endpoint for a flexible server": { + "Create a pair of virtual endpoints for a flexible server.": { "$ref": "./examples/VirtualEndpointCreate.json" } }, - "description": "Creates a new virtual endpoint for PostgreSQL flexible server.", + "description": "Creates a pair of virtual endpoints for a flexible server.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" @@ -69,7 +69,7 @@ "schema": { "$ref": "#/definitions/VirtualEndpointResource" }, - "description": "The required parameters for creating or updating virtual endpoints." + "description": "Parameters required to create or update a pair of virtual endpoints." } ], "responses": { @@ -111,11 +111,11 @@ ], "operationId": "VirtualEndpoints_Update", "x-ms-examples": { - "Update a virtual endpoint for a server to update the ": { + "Update a pair of virtual endpoints for a flexible server.": { "$ref": "./examples/VirtualEndpointUpdate.json" } }, - "description": "Updates an existing virtual endpoint. The request body can contain one to many of the properties present in the normal virtual endpoint definition.", + "description": "Updates a pair of virtual endpoints for a flexible server.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" @@ -139,7 +139,7 @@ "schema": { "$ref": "#/definitions/VirtualEndpointResourceForPatch" }, - "description": "The required parameters for updating a server." + "description": "Parameters required to update a pair of virtual endpoints." } ], "responses": { @@ -175,11 +175,11 @@ ], "operationId": "VirtualEndpoints_Delete", "x-ms-examples": { - "Delete a virtual endpoint": { + "Delete a pair of virtual endpoints.": { "$ref": "./examples/VirtualEndpointDelete.json" } }, - "description": "Deletes a virtual endpoint.", + "description": "Deletes a pair of virtual endpoints.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" @@ -227,11 +227,11 @@ ], "operationId": "VirtualEndpoints_Get", "x-ms-examples": { - "Get a virtual endpoint": { + "Get information about a pair of virtual endpoints.": { "$ref": "./examples/VirtualEndpointsGet.json" } }, - "description": "Gets information about a virtual endpoint.", + "description": "Gets information about a pair of virtual endpoints.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" @@ -272,11 +272,11 @@ ], "operationId": "VirtualEndpoints_ListByServer", "x-ms-examples": { - "VirtualEndpointListByServer": { + "List pair of virtual endpoints associated to a flexible server.": { "$ref": "./examples/VirtualEndpointsListByServer.json" } }, - "description": "List all the servers in a given resource group.", + "description": "Lists pair of virtual endpoints associated to a flexible server.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" @@ -317,7 +317,7 @@ "properties": { "endpointType": { "type": "string", - "description": "The endpoint type for the virtual endpoint.", + "description": "Type of endpoint for the virtual endpoints.", "enum": [ "ReadWrite" ], @@ -330,21 +330,21 @@ "type": "array", "items": { "type": "string", - "description": "Member for the virtual endpoint." + "description": "Flexible server that one of the virtual endpoints can refer to." }, - "description": "List of members for a virtual endpoint" + "description": "List of flexible servers that one of the virtual endpoints can refer to." }, "virtualEndpoints": { "type": "array", "items": { "type": "string", - "description": "Virtual endpoint for a server." + "description": "Virtual endpoints for a flexible server." }, - "description": "List of virtual endpoints for a server", + "description": "List of virtual endpoints for a flexible server.", "readOnly": true } }, - "description": "The properties of a virtual endpoint." + "description": "Properties of a pair of virtual endpoints." }, "VirtualEndpointResource": { "type": "object", @@ -356,7 +356,7 @@ "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/Resource" } ], - "description": "Represents a virtual endpoint for a server." + "description": "Pair of virtual endpoints for a flexible server." }, "VirtualEndpointResourceForPatch": { "type": "object", @@ -364,10 +364,10 @@ "properties": { "$ref": "#/definitions/VirtualEndpointResourceProperties", "x-ms-client-flatten": true, - "description": "Properties of the virtual endpoint resource." + "description": "Properties of the pair of virtual endpoints." } }, - "description": "Represents a virtual endpoint for a server." + "description": "Pair of virtual endpoints for a flexible server." }, "VirtualEndpointsListResult": { "type": "object", @@ -377,14 +377,14 @@ "items": { "$ref": "#/definitions/VirtualEndpointResource" }, - "description": "The list of virtual endpoints" + "description": "List of virtual endpoints." }, "nextLink": { - "description": "The link used to get the next page of operations.", + "description": "Link used to get the next page of results.", "type": "string" } }, - "description": "A list of virtual endpoints." + "description": "List of virtual endpoints." } }, "parameters": { @@ -393,7 +393,7 @@ "in": "path", "required": true, "type": "string", - "description": "The name of the virtual endpoint.", + "description": "Base name of the virtual endpoints.", "pattern": "^[A-Za-z0-9][A-Za-z0-9-]{0,62}(?