Skip to content

Latest commit

 

History

History
499 lines (394 loc) · 22.7 KB

readme.md

File metadata and controls

499 lines (394 loc) · 22.7 KB
Raw

PostgreSQL

see https://aka.ms/autorest

This is the AutoRest configuration file for Sql.

Getting Started

To build the SDK for PostgreSQL, simply Install AutoRest and in this folder, run:

autorest

To see additional help and options, run:

autorest --help

Configuration

Basic Information

These are the global settings for the PostgreSQL API.

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.
openapi-type: arm
tag: package-flexibleserver-2024-03-01-preview
tag: package-flexibleserver-2024-03-01-preview
tag: package-2020-01-01

Tag: package-flexibleserver-2024-03-preview

These settings apply only when --tag=package-flexibleserver-2024-03-01-preview is specified on the command line.

input-file:
  - Microsoft.DBforPostgreSQL/preview/2024-03-01-preview/Administrators.json
  - Microsoft.DBforPostgreSQL/preview/2024-03-01-preview/Backups.json
  - Microsoft.DBforPostgreSQL/preview/2024-03-01-preview/Capabilities.json
  - Microsoft.DBforPostgreSQL/preview/2024-03-01-preview/CheckNameAvailability.json
  - Microsoft.DBforPostgreSQL/preview/2024-03-01-preview/Configuration.json
  - Microsoft.DBforPostgreSQL/preview/2024-03-01-preview/Databases.json
  - Microsoft.DBforPostgreSQL/preview/2024-03-01-preview/FirewallRules.json
  - Microsoft.DBforPostgreSQL/preview/2024-03-01-preview/FlexibleServers.json
  - Microsoft.DBforPostgreSQL/preview/2024-03-01-preview/LongTermRetentionOperation.json
  - Microsoft.DBforPostgreSQL/preview/2024-03-01-preview/Migrations.json
  - Microsoft.DBforPostgreSQL/preview/2024-03-01-preview/Operations.json
  - Microsoft.DBforPostgreSQL/preview/2024-03-01-preview/PrivateDnsZone.json
  - Microsoft.DBforPostgreSQL/preview/2024-03-01-preview/PrivateEndpointConnections.json
  - Microsoft.DBforPostgreSQL/preview/2024-03-01-preview/PrivateLinkResources.json
  - Microsoft.DBforPostgreSQL/preview/2024-03-01-preview/QuotaUsages.json
  - Microsoft.DBforPostgreSQL/preview/2024-03-01-preview/Replicas.json
  - Microsoft.DBforPostgreSQL/preview/2024-03-01-preview/ServerLogs.json
  - Microsoft.DBforPostgreSQL/preview/2024-03-01-preview/ServerStartStopRestart.json
  - Microsoft.DBforPostgreSQL/preview/2024-03-01-preview/ThreatProtection.json
  - Microsoft.DBforPostgreSQL/preview/2024-03-01-preview/VirtualEndpoints.json
  - Microsoft.DBforPostgreSQL/preview/2024-03-01-preview/VirtualNetwork.json
suppressions:
  - code: PutResponseCodes
    from: PrivateEndpointConnections.json
    reason: FlexibleServers namespace is already returning 202 as response for PUT. These APIs are under same namespace and hence keeping it as-is.
  - code: ProvisioningStateSpecifiedForLROPut
    from: ThreatProtection.json
    reason: FlexibleServers namespace is already returning 202 as response for PUT. These APIs are under same namespace and hence keeping it as-is.
  - code: PutResponseCodes
    from: ThreatProtection.json
    reason: FlexibleServers namespace is already returning 202 as response for PUT. These APIs are under same namespace and hence keeping it as-is.
  - code: ProvisioningStateSpecifiedForLROPut
    from: VirtualEndpoints.json
    reason: FlexibleServers namespace is already returning 202 as response for PUT. These APIs are under same namespace and hence keeping it as-is.
  - code: ProvisioningStateSpecifiedForLROPatch
    from: VirtualEndpoints.json
    reason: FlexibleServers namespace is already returning 202 as response for PUT. These APIs are under same namespace and hence keeping it as-is.
  - code: PutResponseCodes
    from: VirtualEndpoints.json
    reason: FlexibleServers namespace is already returning 202 as response for PUT. These APIs are under same namespace and hence keeping it as-is.
  - code: PutResponseCodes
    from: Backups.json
    reason: FlexibleServers namespace is already returning 202 as response for PUT. These APIs are under same namespace and hence keeping it as-is.
  - code: ProvisioningStateSpecifiedForLROPut
    from: Backups.json
    reason: FlexibleServers namespace is already returning 202 as response for PUT. These APIs are under same namespace and hence keeping it as-is.

Tag: package-preview-2023-12

These settings apply only when --tag=package-flexibleserver-2023-12-01-preview is specified on the command line.

input-file:
  - Microsoft.DBforPostgreSQL/preview/2023-12-01-preview/Administrators.json
  - Microsoft.DBforPostgreSQL/preview/2023-12-01-preview/Backups.json
  - Microsoft.DBforPostgreSQL/preview/2023-12-01-preview/Capabilities.json
  - Microsoft.DBforPostgreSQL/preview/2023-12-01-preview/CheckNameAvailability.json
  - Microsoft.DBforPostgreSQL/preview/2023-12-01-preview/Configuration.json
  - Microsoft.DBforPostgreSQL/preview/2023-12-01-preview/Databases.json
  - Microsoft.DBforPostgreSQL/preview/2023-12-01-preview/FirewallRules.json
  - Microsoft.DBforPostgreSQL/preview/2023-12-01-preview/FlexibleServers.json
  - Microsoft.DBforPostgreSQL/preview/2023-12-01-preview/LongTermRetentionOperation.json
  - Microsoft.DBforPostgreSQL/preview/2023-12-01-preview/Migrations.json
  - Microsoft.DBforPostgreSQL/preview/2023-12-01-preview/Operations.json
  - Microsoft.DBforPostgreSQL/preview/2023-12-01-preview/PrivateDnsZone.json
  - Microsoft.DBforPostgreSQL/preview/2023-12-01-preview/PrivateEndpointConnections.json
  - Microsoft.DBforPostgreSQL/preview/2023-12-01-preview/PrivateLinkResources.json
  - Microsoft.DBforPostgreSQL/preview/2023-12-01-preview/QuotaUsages.json
  - Microsoft.DBforPostgreSQL/preview/2023-12-01-preview/Replicas.json
  - Microsoft.DBforPostgreSQL/preview/2023-12-01-preview/ServerLogs.json
  - Microsoft.DBforPostgreSQL/preview/2023-12-01-preview/ServerStartStopRestart.json
  - Microsoft.DBforPostgreSQL/preview/2023-12-01-preview/ThreatProtection.json
  - Microsoft.DBforPostgreSQL/preview/2023-12-01-preview/VirtualEndpoints.json
  - Microsoft.DBforPostgreSQL/preview/2023-12-01-preview/VirtualNetwork.json
suppressions:
  - code: PutResponseCodes
    from: PrivateEndpointConnections.json
    reason: FlexibleServers namespace is already returning 202 as response for PUT. These APIs are under same namespace and hence keeping it as-is.
  - code: ProvisioningStateSpecifiedForLROPut
    from: ThreatProtection.json
    reason: FlexibleServers namespace is already returning 202 as response for PUT. These APIs are under same namespace and hence keeping it as-is.
  - code: PutResponseCodes
    from: ThreatProtection.json
    reason: FlexibleServers namespace is already returning 202 as response for PUT. These APIs are under same namespace and hence keeping it as-is.
  - code: ProvisioningStateSpecifiedForLROPut
    from: VirtualEndpoints.json
    reason: FlexibleServers namespace is already returning 202 as response for PUT. These APIs are under same namespace and hence keeping it as-is.
  - code: ProvisioningStateSpecifiedForLROPatch
    from: VirtualEndpoints.json
    reason: FlexibleServers namespace is already returning 202 as response for PUT. These APIs are under same namespace and hence keeping it as-is.
  - code: PutResponseCodes
    from: VirtualEndpoints.json
    reason: FlexibleServers namespace is already returning 202 as response for PUT. These APIs are under same namespace and hence keeping it as-is.

Tag: package-preview-2023-06

These settings apply only when --tag=package-flexibleserver-2023-06-01-preview is specified on the command line.

input-file:
  - Microsoft.DBforPostgreSQL/preview/2023-06-01-preview/Administrators.json
  - Microsoft.DBforPostgreSQL/preview/2023-06-01-preview/Backups.json
  - Microsoft.DBforPostgreSQL/preview/2023-06-01-preview/Capabilities.json
  - Microsoft.DBforPostgreSQL/preview/2023-06-01-preview/CheckNameAvailability.json
  - Microsoft.DBforPostgreSQL/preview/2023-06-01-preview/Configuration.json
  - Microsoft.DBforPostgreSQL/preview/2023-06-01-preview/Databases.json
  - Microsoft.DBforPostgreSQL/preview/2023-06-01-preview/FirewallRules.json
  - Microsoft.DBforPostgreSQL/preview/2023-06-01-preview/FlexibleServers.json
  - Microsoft.DBforPostgreSQL/preview/2023-06-01-preview/LongTermRetentionOperation.json
  - Microsoft.DBforPostgreSQL/preview/2023-06-01-preview/Migrations.json
  - Microsoft.DBforPostgreSQL/preview/2023-06-01-preview/Operations.json
  - Microsoft.DBforPostgreSQL/preview/2023-06-01-preview/PrivateDnsZone.json
  - Microsoft.DBforPostgreSQL/preview/2023-06-01-preview/PrivateEndpointConnections.json
  - Microsoft.DBforPostgreSQL/preview/2023-06-01-preview/PrivateLinkResources.json
  - Microsoft.DBforPostgreSQL/preview/2023-06-01-preview/QuotaUsages.json
  - Microsoft.DBforPostgreSQL/preview/2023-06-01-preview/Replicas.json
  - Microsoft.DBforPostgreSQL/preview/2023-06-01-preview/ServerLogs.json
  - Microsoft.DBforPostgreSQL/preview/2023-06-01-preview/ServerStartStopRestart.json
  - Microsoft.DBforPostgreSQL/preview/2023-06-01-preview/ThreatProtection.json
  - Microsoft.DBforPostgreSQL/preview/2023-06-01-preview/VirtualEndpoints.json
  - Microsoft.DBforPostgreSQL/preview/2023-06-01-preview/VirtualNetwork.json
suppressions:
  - code: PutResponseCodes
    from: PrivateEndpointConnections.json
    reason: FlexibleServers namespace is already returning 202 as response for PUT. These APIs are under same namespace and hence keeping it as-is.
  - code: ProvisioningStateSpecifiedForLROPut
    from: ThreatProtection.json
    reason: FlexibleServers namespace is already returning 202 as response for PUT. These APIs are under same namespace and hence keeping it as-is.
  - code: PutResponseCodes
    from: ThreatProtection.json
    reason: FlexibleServers namespace is already returning 202 as response for PUT. These APIs are under same namespace and hence keeping it as-is.
  - code: ProvisioningStateSpecifiedForLROPut
    from: VirtualEndpoints.json
    reason: FlexibleServers namespace is already returning 202 as response for PUT. These APIs are under same namespace and hence keeping it as-is.
  - code: ProvisioningStateSpecifiedForLROPatch
    from: VirtualEndpoints.json
    reason: FlexibleServers namespace is already returning 202 as response for PUT. These APIs are under same namespace and hence keeping it as-is.
  - code: PutResponseCodes
    from: VirtualEndpoints.json
    reason: FlexibleServers namespace is already returning 202 as response for PUT. These APIs are under same namespace and hence keeping it as-is.

Tag: package-flexibleserver-2023-03-01-preview

These settings apply only when --tag=package-flexibleserver-2023-03-01-preview is specified on the command line.

input-file:
  - Microsoft.DBforPostgreSQL/preview/2023-03-01-preview/Administrators.json
  - Microsoft.DBforPostgreSQL/preview/2023-03-01-preview/Backups.json
  - Microsoft.DBforPostgreSQL/preview/2023-03-01-preview/Capabilities.json
  - Microsoft.DBforPostgreSQL/preview/2023-03-01-preview/CheckNameAvailability.json
  - Microsoft.DBforPostgreSQL/preview/2023-03-01-preview/Configuration.json
  - Microsoft.DBforPostgreSQL/preview/2023-03-01-preview/Databases.json
  - Microsoft.DBforPostgreSQL/preview/2023-03-01-preview/FirewallRules.json
  - Microsoft.DBforPostgreSQL/preview/2023-03-01-preview/FlexibleServers.json
  - Microsoft.DBforPostgreSQL/preview/2023-03-01-preview/Migrations.json
  - Microsoft.DBforPostgreSQL/preview/2023-03-01-preview/Operations.json
  - Microsoft.DBforPostgreSQL/preview/2023-03-01-preview/PrivateDnsZone.json
  - Microsoft.DBforPostgreSQL/preview/2023-03-01-preview/Replicas.json
  - Microsoft.DBforPostgreSQL/preview/2023-03-01-preview/ServerLogs.json
  - Microsoft.DBforPostgreSQL/preview/2023-03-01-preview/ServerStartStopRestart.json
  - Microsoft.DBforPostgreSQL/preview/2023-03-01-preview/VirtualNetwork.json
  - Microsoft.DBforPostgreSQL/preview/2023-03-01-preview/LongTermRetentionOperation.json

Tag: package-flexibleserver-2022-12-01

These settings apply only when --tag=package-flexibleserver-2022-12-01 is specified on the command line.

input-file:
  - Microsoft.DBforPostgreSQL/stable/2022-12-01/Administrators.json
  - Microsoft.DBforPostgreSQL/stable/2022-12-01/Backups.json
  - Microsoft.DBforPostgreSQL/stable/2022-12-01/Capabilities.json
  - Microsoft.DBforPostgreSQL/stable/2022-12-01/CheckNameAvailability.json
  - Microsoft.DBforPostgreSQL/stable/2022-12-01/Configuration.json
  - Microsoft.DBforPostgreSQL/stable/2022-12-01/Databases.json
  - Microsoft.DBforPostgreSQL/stable/2022-12-01/FirewallRules.json
  - Microsoft.DBforPostgreSQL/stable/2022-12-01/FlexibleServers.json
  - Microsoft.DBforPostgreSQL/stable/2022-12-01/Operations.json
  - Microsoft.DBforPostgreSQL/stable/2022-12-01/PrivateDnsZone.json
  - Microsoft.DBforPostgreSQL/stable/2022-12-01/Replicas.json
  - Microsoft.DBforPostgreSQL/stable/2022-12-01/ServerStartStopRestart.json
  - Microsoft.DBforPostgreSQL/stable/2022-12-01/VirtualNetwork.json

Tag: package-flexibleserver-2022-05-01-preview-only

These settings apply only when --tag=package-flexibleserver-2022-05-01-preview-only is specified on the command line.

input-file:
  - Microsoft.DBforPostgreSQL/preview/2022-05-01-preview/Migrations.json
  - Microsoft.DBforPostgreSQL/preview/2022-05-01-preview/Operations.json

Tag: package-flexibleserver-2022-03-preview

These settings apply only when --tag=package-flexibleserver-2022-03-preview is specified on the command line.

input-file:
  - Microsoft.DBforPostgreSQL/preview/2022-03-08-preview/Administrators.json
  - Microsoft.DBforPostgreSQL/preview/2022-03-08-preview/Backups.json
  - Microsoft.DBforPostgreSQL/preview/2022-03-08-preview/Capabilities.json
  - Microsoft.DBforPostgreSQL/preview/2022-03-08-preview/CheckNameAvailability.json
  - Microsoft.DBforPostgreSQL/preview/2022-03-08-preview/Configuration.json
  - Microsoft.DBforPostgreSQL/preview/2022-03-08-preview/Databases.json
  - Microsoft.DBforPostgreSQL/preview/2022-03-08-preview/FirewallRules.json
  - Microsoft.DBforPostgreSQL/preview/2022-03-08-preview/FlexibleServers.json
  - Microsoft.DBforPostgreSQL/preview/2022-03-08-preview/Operations.json
  - Microsoft.DBforPostgreSQL/preview/2022-03-08-preview/PrivateDnsZone.json
  - Microsoft.DBforPostgreSQL/preview/2022-03-08-preview/Replicas.json
  - Microsoft.DBforPostgreSQL/preview/2022-03-08-preview/VirtualNetwork.json
  - Microsoft.DBforPostgreSQL/preview/2022-03-08-preview/ServerStartStopRestart.json

Tag: package-flexibleserver-2022-03-privatepreview

These settings apply only when --tag=package-flexibleserver-2022-03-privatepreview is specified on the command line.

input-file:
- Microsoft.DBforPostgreSQL/preview/2022-03-08-privatepreview/getCachedServerName.json
- Microsoft.DBforPostgreSQL/preview/2022-01-20-preview/Databases.json
- Microsoft.DBforPostgreSQL/preview/2022-01-20-preview/PrivateDnsZone.json
- Microsoft.DBforPostgreSQL/preview/2022-01-20-preview/postgresql.json

Tag: package-flexibleserver-2022-01-preview

These settings apply only when --tag=package-flexibleserver-2022-01-preview is specified on the command line.

input-file:
  - Microsoft.DBforPostgreSQL/preview/2022-01-20-preview/Databases.json
  - Microsoft.DBforPostgreSQL/preview/2022-01-20-preview/PrivateDnsZone.json
  - Microsoft.DBforPostgreSQL/preview/2022-01-20-preview/postgresql.json

Tag: package-2021-06-15-privatepreview

These settings apply only when --tag=package-2021-06-15-privatepreview is specified on the command line.

input-file:
- Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/Migrations.json
- Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/postgresql.json

Tag: package-flexibleserver-2021-06

These settings apply only when --tag=package-flexibleserver-2021-06 is specified on the command line.

input-file:
- Microsoft.DBforPostgreSQL/stable/2021-06-01/postgresql.json
- Microsoft.DBforPostgreSQL/stable/2021-06-01/Databases.json
- Microsoft.DBforPostgreSQL/stable/2021-06-01/PrivateDnsZone.json

Tag: package-flexibleserver-2021-06-preview

These settings apply only when --tag=package-flexibleserver-2021-06-preview is specified on the command line.cd ..

input-file:
- Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/postgresql.json
- Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/Databases.json
- Microsoft.DBforPostgreSQL/preview/2021-03-31-privatepreview/PrivateDnsZone.json
- Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/IntelligentPerformance.json
- Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/QueryPerformanceInsights.json

Tag: package-2021-04-10-privatepreview

These settings apply only when --tag=package-2021-04-10-privatepreview is specified on the command line.

input-file:
- Microsoft.DBforPostgreSQL/preview/2020-11-05-preview/Databases.json
- Microsoft.DBforPostgreSQL/preview/2021-03-31-privatepreview/PrivateDnsZone.json
- Microsoft.DBforPostgreSQL/preview/2021-04-10-privatepreview/postgresql.json

Tag: package-2021-03-31-privatepreview

These settings apply only when --tag=package-2021-03-31-privatepreview is specified on the command line.

input-file:
- Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/postgresql.json
- Microsoft.DBforPostgreSQL/preview/2020-11-05-preview/Databases.json
- Microsoft.DBforPostgreSQL/preview/2021-03-31-privatepreview/PrivateDnsZone.json

Tag: package-2020-11-05-preview

These settings apply only when --tag=package-2020-11-05-preview is specified on the command line.

input-file:
- Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/postgresql.json
- Microsoft.DBforPostgreSQL/preview/2020-11-05-preview/Databases.json

Tag: package-2020-02-14-preview

These settings apply only when --tag=package-2020-02-14-preview is specified on the command line.

input-file:
- Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/postgresql.json

Tag: package-2020-02-14-privatepreview

These settings apply only when --tag=package-2020-02-14-privatepreview is specified on the command line.

input-file:
- Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/postgresql.json

Tag: package-2020-01-01-privatepreview

These settings apply only when --tag=package-2020-01-01-privatepreview is specified on the command line.

input-file:
- Microsoft.DBforPostgreSQL/preview/2020-01-01-privatepreview/DataEncryptionKeys.json

Tag: package-2020-01-01

These settings apply only when --tag=package-2020-01-01 is specified on the command line.

input-file:
- Microsoft.DBforPostgreSQL/stable/2017-12-01/postgresql.json
- Microsoft.DBforPostgreSQL/stable/2017-12-01/ServerSecurityAlertPolicies.json
- Microsoft.DBforPostgreSQL/stable/2018-06-01/PrivateEndpointConnections.json
- Microsoft.DBforPostgreSQL/stable/2018-06-01/PrivateLinkResources.json
- Microsoft.DBforPostgreSQL/stable/2020-01-01/DataEncryptionKeys.json

Tag: package-2018-06-01-privatepreview

These settings apply only when --tag=package-2018-06-01-privatepreview is specified on the command line.

input-file:
- Microsoft.DBforPostgreSQL/preview/2018-06-01-privatepreview/PrivateEndpointConnections.json
- Microsoft.DBforPostgreSQL/preview/2018-06-01-privatepreview/PrivateLinkResources.json

Tag: package-2018-06-01

These settings apply only when --tag=package-2018-06-01 is specified on the command line.

input-file:
- Microsoft.DBforPostgreSQL/stable/2017-12-01/postgresql.json
- Microsoft.DBforPostgreSQL/stable/2017-12-01/ServerSecurityAlertPolicies.json
- Microsoft.DBforPostgreSQL/stable/2018-06-01/PrivateEndpointConnections.json
- Microsoft.DBforPostgreSQL/stable/2018-06-01/PrivateLinkResources.json
- Microsoft.DBforPostgreSQL/stable/2018-06-01/QueryPerformanceInsights.json
- Microsoft.DBforPostgreSQL/stable/2018-06-01/PerformanceRecommendations.json

Tag: package-2017-12-01-preview

These settings apply only when --tag=package-2017-12-01-preview is specified on the command line.

input-file:
- Microsoft.DBforPostgreSQL/preview/2017-12-01-preview/postgresql.json

Tag: package-2017-12-01

These settings apply only when --tag=package-2017-12-01 is specified on the command line.

input-file:
- Microsoft.DBforPostgreSQL/stable/2017-12-01/postgresql.json
- Microsoft.DBforPostgreSQL/stable/2017-12-01/ServerSecurityAlertPolicies.json

Suppression

directive:
  - suppress: PathResourceProviderNamePascalCase
    reason: The name of the provider is DBforPostgreSQL

Code Generation

Swagger to SDK

This section describes what SDK should be generated by the automatic system. This is not used by Autorest itself.

swagger-to-sdk:
  - repo: azure-sdk-for-net-track2
  - repo: azure-sdk-for-python
  - repo: azure-sdk-for-java
  - repo: azure-sdk-for-go
  - repo: azure-sdk-for-js
  - repo: azure-resource-manager-schemas
  - repo: azure-powershell

C#

These settings apply only when --csharp is specified on the command line. Please also specify --csharp-sdks-folder=<path to "SDKs" directory of your azure-sdk-for-net clone>.

csharp:
  azure-arm: true
  license-header: MICROSOFT_MIT_NO_VERSION
  namespace: Microsoft.Azure.Management.PostgreSQL
  output-folder: $(csharp-sdks-folder)/postgresql/Microsoft.Azure.Management.PostgreSQL/src/postgresql/Generated
  clear-output-folder: true

Python

See configuration in readme.python.md

Go

See configuration in readme.go.md

Java

See configuration in readme.java.md

TypeScript

See configuration in readme.typescript.md