Categorygithub.com/Azure/azure-sdk-for-go/sdk/resourcemanager/postgresql/armpostgresqlflexibleservers
modulepackage
0.5.0
Repository: https://github.com/azure/azure-sdk-for-go.git
Documentation: pkg.go.dev

# README

Azure Database for PostgreSQL Module for Go

PkgGoDev

The armpostgresqlflexibleservers module provides operations for working with Azure Database for PostgreSQL.

Source code

Getting started

Prerequisites

Install the package

This project uses Go modules for versioning and dependency management.

Install the Azure Database for PostgreSQL module:

go get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/postgresql/armpostgresqlflexibleservers

Authorization

When creating a client, you will need to provide a credential for authenticating with Azure Database for PostgreSQL. The azidentity module provides facilities for various ways of authenticating with Azure including client/secret, certificate, managed identity, and more.

cred, err := azidentity.NewDefaultAzureCredential(nil)

For more information on authentication, please see the documentation for azidentity at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azidentity.

Clients

Azure Database for PostgreSQL modules consist of one or more clients. A client groups a set of related APIs, providing access to its functionality within the specified subscription. Create one or more clients to access the APIs you require using your credential.

client, err := armpostgresqlflexibleservers.NewVirtualNetworkSubnetUsageClient(<subscription ID>, cred, nil)

You can use ClientOptions in package github.com/Azure/azure-sdk-for-go/sdk/azcore/arm to set endpoint to connect with public and sovereign clouds as well as Azure Stack. For more information, please see the documentation for azcore at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azcore.

options := arm.ClientOptions {
    ClientOptions: azcore.ClientOptions {
        Cloud: cloud.AzureChina,
    },
}
client, err := armpostgresqlflexibleservers.NewVirtualNetworkSubnetUsageClient(<subscription ID>, cred, &options)

Provide Feedback

If you encounter bugs or have suggestions, please open an issue and assign the Database for PostgreSQL label.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information, see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

# Functions

NewCheckNameAvailabilityClient creates a new instance of CheckNameAvailabilityClient with the specified values.
NewConfigurationsClient creates a new instance of ConfigurationsClient with the specified values.
NewDatabasesClient creates a new instance of DatabasesClient with the specified values.
NewFirewallRulesClient creates a new instance of FirewallRulesClient with the specified values.
NewGetPrivateDNSZoneSuffixClient creates a new instance of GetPrivateDNSZoneSuffixClient with the specified values.
NewLocationBasedCapabilitiesClient creates a new instance of LocationBasedCapabilitiesClient with the specified values.
NewOperationsClient creates a new instance of OperationsClient with the specified values.
NewServersClient creates a new instance of ServersClient with the specified values.
NewVirtualNetworkSubnetUsageClient creates a new instance of VirtualNetworkSubnetUsageClient with the specified values.
PossibleConfigurationDataTypeValues returns the possible values for the ConfigurationDataType const type.
PossibleCreatedByTypeValues returns the possible values for the CreatedByType const type.
PossibleCreateModeForUpdateValues returns the possible values for the CreateModeForUpdate const type.
PossibleCreateModeValues returns the possible values for the CreateMode const type.
PossibleFailoverModeValues returns the possible values for the FailoverMode const type.
PossibleGeoRedundantBackupEnumValues returns the possible values for the GeoRedundantBackupEnum const type.
PossibleHighAvailabilityModeValues returns the possible values for the HighAvailabilityMode const type.
PossibleOperationOriginValues returns the possible values for the OperationOrigin const type.
PossibleReasonValues returns the possible values for the Reason const type.
PossibleServerHAStateValues returns the possible values for the ServerHAState const type.
PossibleServerPublicNetworkAccessStateValues returns the possible values for the ServerPublicNetworkAccessState const type.
PossibleServerStateValues returns the possible values for the ServerState const type.
PossibleServerVersionValues returns the possible values for the ServerVersion const type.
PossibleSKUTierValues returns the possible values for the SKUTier const type.

# Constants

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

Backup properties of a server.
CapabilitiesListResult - location capability.
CapabilityProperties - Location capabilities.
CheckNameAvailabilityClient contains the methods for the CheckNameAvailability group.
CheckNameAvailabilityClientExecuteOptions contains the optional parameters for the CheckNameAvailabilityClient.Execute method.
CheckNameAvailabilityClientExecuteResponse contains the response from method CheckNameAvailabilityClient.Execute.
CloudError - An error response from the Batch service.
Configuration - Represents a Configuration.
ConfigurationListResult - A list of server configurations.
ConfigurationProperties - The properties of a configuration.
ConfigurationsClient contains the methods for the Configurations group.
ConfigurationsClientBeginPutOptions contains the optional parameters for the ConfigurationsClient.BeginPut method.
ConfigurationsClientBeginUpdateOptions contains the optional parameters for the ConfigurationsClient.BeginUpdate method.
ConfigurationsClientGetOptions contains the optional parameters for the ConfigurationsClient.Get method.
ConfigurationsClientGetResponse contains the response from method ConfigurationsClient.Get.
ConfigurationsClientListByServerOptions contains the optional parameters for the ConfigurationsClient.ListByServer method.
ConfigurationsClientListByServerResponse contains the response from method ConfigurationsClient.ListByServer.
ConfigurationsClientPutResponse contains the response from method ConfigurationsClient.Put.
ConfigurationsClientUpdateResponse contains the response from method ConfigurationsClient.Update.
Database - Represents a Database.
DatabaseListResult - A List of databases.
DatabaseProperties - The properties of a database.
DatabasesClient contains the methods for the Databases group.
DatabasesClientBeginCreateOptions contains the optional parameters for the DatabasesClient.BeginCreate method.
DatabasesClientBeginDeleteOptions contains the optional parameters for the DatabasesClient.BeginDelete method.
DatabasesClientCreateResponse contains the response from method DatabasesClient.Create.
DatabasesClientDeleteResponse contains the response from method DatabasesClient.Delete.
DatabasesClientGetOptions contains the optional parameters for the DatabasesClient.Get method.
DatabasesClientGetResponse contains the response from method DatabasesClient.Get.
DatabasesClientListByServerOptions contains the optional parameters for the DatabasesClient.ListByServer method.
DatabasesClientListByServerResponse contains the response from method DatabasesClient.ListByServer.
DelegatedSubnetUsage - Delegated subnet usage data.
ErrorAdditionalInfo - The resource management error additional info.
ErrorResponse - Common error response for all Azure Resource Manager APIs to return error details for failed operations.
FirewallRule - Represents a server firewall rule.
FirewallRuleListResult - A list of firewall rules.
FirewallRuleProperties - The properties of a server firewall rule.
FirewallRulesClient contains the methods for the FirewallRules group.
FirewallRulesClientBeginCreateOrUpdateOptions contains the optional parameters for the FirewallRulesClient.BeginCreateOrUpdate method.
FirewallRulesClientBeginDeleteOptions contains the optional parameters for the FirewallRulesClient.BeginDelete method.
FirewallRulesClientCreateOrUpdateResponse contains the response from method FirewallRulesClient.CreateOrUpdate.
FirewallRulesClientDeleteResponse contains the response from method FirewallRulesClient.Delete.
FirewallRulesClientGetOptions contains the optional parameters for the FirewallRulesClient.Get method.
FirewallRulesClientGetResponse contains the response from method FirewallRulesClient.Get.
FirewallRulesClientListByServerOptions contains the optional parameters for the FirewallRulesClient.ListByServer method.
FirewallRulesClientListByServerResponse contains the response from method FirewallRulesClient.ListByServer.
FlexibleServerEditionCapability - Flexible server edition capabilities.
GetPrivateDNSZoneSuffixClient contains the methods for the GetPrivateDNSZoneSuffix group.
GetPrivateDNSZoneSuffixClientExecuteOptions contains the optional parameters for the GetPrivateDNSZoneSuffixClient.Execute method.
GetPrivateDNSZoneSuffixClientExecuteResponse contains the response from method GetPrivateDNSZoneSuffixClient.Execute.
HighAvailability - High availability properties of a server.
HyperscaleNodeEditionCapability - Hyperscale node edition capabilities.
LocationBasedCapabilitiesClient contains the methods for the LocationBasedCapabilities group.
LocationBasedCapabilitiesClientExecuteOptions contains the optional parameters for the LocationBasedCapabilitiesClient.Execute method.
LocationBasedCapabilitiesClientExecuteResponse contains the response from method LocationBasedCapabilitiesClient.Execute.
MaintenanceWindow - Maintenance window properties of a server.
NameAvailability - Represents a resource name availability.
NameAvailabilityRequest - Request from client to check resource name availability.
Network properties of a server.
NodeTypeCapability - node type capability.
Operation - REST API operation definition.
OperationDisplay - Display metadata associated with the operation.
OperationListResult - A list of resource provider operations.
OperationsClient contains the methods for the Operations group.
OperationsClientListOptions contains the optional parameters for the OperationsClient.List method.
OperationsClientListResponse contains the response from method OperationsClient.List.
ProxyResource - The resource model definition for a Azure Resource Manager proxy resource.
Resource - Common fields that are returned in the response for all Azure Resource Manager resources.
RestartParameter - Represents server restart parameters.
Server - Represents a server.
ServerForUpdate - Represents a server to be updated.
ServerListResult - A list of servers.
ServerProperties - The properties of a server.
No description provided by the author
ServersClient contains the methods for the Servers group.
ServersClientBeginCreateOptions contains the optional parameters for the ServersClient.BeginCreate method.
ServersClientBeginDeleteOptions contains the optional parameters for the ServersClient.BeginDelete method.
ServersClientBeginRestartOptions contains the optional parameters for the ServersClient.BeginRestart method.
ServersClientBeginStartOptions contains the optional parameters for the ServersClient.BeginStart method.
ServersClientBeginStopOptions contains the optional parameters for the ServersClient.BeginStop method.
ServersClientBeginUpdateOptions contains the optional parameters for the ServersClient.BeginUpdate method.
ServersClientCreateResponse contains the response from method ServersClient.Create.
ServersClientDeleteResponse contains the response from method ServersClient.Delete.
ServersClientGetOptions contains the optional parameters for the ServersClient.Get method.
ServersClientGetResponse contains the response from method ServersClient.Get.
ServersClientListByResourceGroupOptions contains the optional parameters for the ServersClient.ListByResourceGroup method.
ServersClientListByResourceGroupResponse contains the response from method ServersClient.ListByResourceGroup.
ServersClientListOptions contains the optional parameters for the ServersClient.List method.
ServersClientListResponse contains the response from method ServersClient.List.
ServersClientRestartResponse contains the response from method ServersClient.Restart.
ServersClientStartResponse contains the response from method ServersClient.Start.
ServersClientStopResponse contains the response from method ServersClient.Stop.
ServersClientUpdateResponse contains the response from method ServersClient.Update.
ServerVersionCapability - Server version capabilities.
SKU - Sku information related properties of a server.
Storage properties of a server.
StorageEditionCapability - storage edition capability.
StorageMBCapability - storage size in MB capability.
SystemData - Metadata pertaining to creation and last modification of the resource.
TrackedResource - The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'.
VcoreCapability - Vcores capability.
VirtualNetworkSubnetUsageClient contains the methods for the VirtualNetworkSubnetUsage group.
VirtualNetworkSubnetUsageClientExecuteOptions contains the optional parameters for the VirtualNetworkSubnetUsageClient.Execute method.
VirtualNetworkSubnetUsageClientExecuteResponse contains the response from method VirtualNetworkSubnetUsageClient.Execute.
VirtualNetworkSubnetUsageParameter - Virtual network subnet usage parameter.
VirtualNetworkSubnetUsageResult - Virtual network subnet usage data.

# Type aliases

ConfigurationDataType - Data type of the configuration.
CreatedByType - The type of identity that created the resource.
CreateMode - The mode to create a new PostgreSQL server.
CreateModeForUpdate - The mode to update a new PostgreSQL server.
FailoverMode - Failover mode.
GeoRedundantBackupEnum - A value indicating whether Geo-Redundant backup is enabled on the server.
HighAvailabilityMode - The HA mode for the server.
OperationOrigin - The intended executor of the operation.
Reason - The name availability reason.
ServerHAState - A state of a HA server that is visible to user.
ServerPublicNetworkAccessState - public network access is enabled or not.
ServerState - A state of a server that is visible to user.
ServerVersion - The version of a server.
SKUTier - The tier of the particular SKU, e.g.