azure.mgmt.rdbms.postgresql.models module

class azure.mgmt.rdbms.postgresql.models.Configuration(*, value: Optional[str] = None, source: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.rdbms.postgresql.models._models_py3.ProxyResource

Represents a Configuration.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • description (str) – Description of the configuration.

  • default_value (str) – Default value of the configuration.

  • data_type (str) – Data type of the configuration.

  • allowed_values (str) – Allowed values of the configuration.

Parameters
  • value (str) – Value of the configuration.

  • source (str) – Source of the configuration.

class azure.mgmt.rdbms.postgresql.models.ConfigurationListResult(*, value: Optional[List[azure.mgmt.rdbms.postgresql.models._models_py3.Configuration]] = None, **kwargs)[source]

Bases: msrest.serialization.Model

A list of server configurations.

Parameters

value (list[Configuration]) – The list of server configurations.

class azure.mgmt.rdbms.postgresql.models.CreateMode(value)[source]

Bases: str, enum.Enum

The mode to create a new server.

DEFAULT = 'Default'
GEO_RESTORE = 'GeoRestore'
POINT_IN_TIME_RESTORE = 'PointInTimeRestore'
REPLICA = 'Replica'
class azure.mgmt.rdbms.postgresql.models.Database(*, charset: Optional[str] = None, collation: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.rdbms.postgresql.models._models_py3.ProxyResource

Represents a Database.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

Parameters
  • charset (str) – The charset of the database.

  • collation (str) – The collation of the database.

class azure.mgmt.rdbms.postgresql.models.DatabaseListResult(*, value: Optional[List[azure.mgmt.rdbms.postgresql.models._models_py3.Database]] = None, **kwargs)[source]

Bases: msrest.serialization.Model

A List of databases.

Parameters

value (list[Database]) – The list of databases housed in a server.

class azure.mgmt.rdbms.postgresql.models.ErrorAdditionalInfo(**kwargs)[source]

Bases: msrest.serialization.Model

The resource management error additional info.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • type (str) – The additional info type.

  • info (any) – The additional info.

class azure.mgmt.rdbms.postgresql.models.ErrorResponse(**kwargs)[source]

Bases: msrest.serialization.Model

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

Variables are only populated by the server, and will be ignored when sending a request.

Variables
class azure.mgmt.rdbms.postgresql.models.FirewallRule(*, start_ip_address: str, end_ip_address: str, **kwargs)[source]

Bases: azure.mgmt.rdbms.postgresql.models._models_py3.ProxyResource

Represents a server firewall rule.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables
  • id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

Parameters
  • start_ip_address (str) – Required. The start IP address of the server firewall rule. Must be IPv4 format.

  • end_ip_address (str) – Required. The end IP address of the server firewall rule. Must be IPv4 format.

class azure.mgmt.rdbms.postgresql.models.FirewallRuleListResult(*, value: Optional[List[azure.mgmt.rdbms.postgresql.models._models_py3.FirewallRule]] = None, **kwargs)[source]

Bases: msrest.serialization.Model

A list of firewall rules.

Parameters

value (list[FirewallRule]) – The list of firewall rules in a server.

class azure.mgmt.rdbms.postgresql.models.GeoRedundantBackup(value)[source]

Bases: str, enum.Enum

Enable Geo-redundant or not for server backup.

DISABLED = 'Disabled'
ENABLED = 'Enabled'
class azure.mgmt.rdbms.postgresql.models.IdentityType(value)[source]

Bases: str, enum.Enum

The identity type. Set this to ‘SystemAssigned’ in order to automatically create and assign an Azure Active Directory principal for the resource.

SYSTEM_ASSIGNED = 'SystemAssigned'
class azure.mgmt.rdbms.postgresql.models.InfrastructureEncryption(value)[source]

Bases: str, enum.Enum

Add a second layer of encryption for your data using new encryption algorithm which gives additional data protection. Value is optional but if passed in, must be ‘Disabled’ or ‘Enabled’.

DISABLED = 'Disabled'

Additional (2nd) layer of encryption for data at rest.

ENABLED = 'Enabled'

Default value for single layer of encryption for data at rest.

class azure.mgmt.rdbms.postgresql.models.LogFile(*, size_in_kb: Optional[int] = None, type_properties_type: Optional[str] = None, url: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.rdbms.postgresql.models._models_py3.ProxyResource

Represents a log file.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • created_time (datetime) – Creation timestamp of the log file.

  • last_modified_time (datetime) – Last modified timestamp of the log file.

Parameters
  • size_in_kb (long) – Size of the log file.

  • type_properties_type (str) – Type of the log file.

  • url (str) – The url to download the log file from.

class azure.mgmt.rdbms.postgresql.models.LogFileListResult(*, value: Optional[List[azure.mgmt.rdbms.postgresql.models._models_py3.LogFile]] = None, **kwargs)[source]

Bases: msrest.serialization.Model

A list of log files.

Parameters

value (list[LogFile]) – The list of log files.

class azure.mgmt.rdbms.postgresql.models.MinimalTlsVersionEnum(value)[source]

Bases: str, enum.Enum

Enforce a minimal Tls version for the server.

TLS1_0 = 'TLS1_0'
TLS1_1 = 'TLS1_1'
TLS1_2 = 'TLS1_2'
TLS_ENFORCEMENT_DISABLED = 'TLSEnforcementDisabled'
class azure.mgmt.rdbms.postgresql.models.NameAvailability(*, message: Optional[str] = None, name_available: Optional[bool] = None, reason: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Represents a resource name availability.

Parameters
  • message (str) – Error Message.

  • name_available (bool) – Indicates whether the resource name is available.

  • reason (str) – Reason for name being unavailable.

class azure.mgmt.rdbms.postgresql.models.NameAvailabilityRequest(*, name: str, type: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Request from client to check resource name availability.

All required parameters must be populated in order to send to Azure.

Parameters
  • name (str) – Required. Resource name to verify.

  • type (str) – Resource type used for verification.

class azure.mgmt.rdbms.postgresql.models.Operation(**kwargs)[source]

Bases: msrest.serialization.Model

REST API operation definition.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • name (str) – The name of the operation being performed on this particular object.

  • display (OperationDisplay) – The localized display information for this particular operation or action.

  • origin (str or OperationOrigin) – The intended executor of the operation. Possible values include: “NotSpecified”, “user”, “system”.

  • properties (dict[str, any]) – Additional descriptions for the operation.

class azure.mgmt.rdbms.postgresql.models.OperationDisplay(**kwargs)[source]

Bases: msrest.serialization.Model

Display metadata associated with the operation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • provider (str) – Operation resource provider name.

  • resource (str) – Resource on which the operation is performed.

  • operation (str) – Localized friendly name for the operation.

  • description (str) – Operation description.

class azure.mgmt.rdbms.postgresql.models.OperationListResult(*, value: Optional[List[azure.mgmt.rdbms.postgresql.models._models_py3.Operation]] = None, **kwargs)[source]

Bases: msrest.serialization.Model

A list of resource provider operations.

Parameters

value (list[Operation]) – The list of resource provider operations.

class azure.mgmt.rdbms.postgresql.models.OperationOrigin(value)[source]

Bases: str, enum.Enum

The intended executor of the operation.

NOT_SPECIFIED = 'NotSpecified'
SYSTEM = 'system'
USER = 'user'
class azure.mgmt.rdbms.postgresql.models.PerformanceTierListResult(*, value: Optional[List[azure.mgmt.rdbms.postgresql.models._models_py3.PerformanceTierProperties]] = None, **kwargs)[source]

Bases: msrest.serialization.Model

A list of performance tiers.

Parameters

value (list[PerformanceTierProperties]) – The list of performance tiers.

class azure.mgmt.rdbms.postgresql.models.PerformanceTierProperties(*, id: Optional[str] = None, max_backup_retention_days: Optional[int] = None, min_backup_retention_days: Optional[int] = None, max_storage_mb: Optional[int] = None, min_large_storage_mb: Optional[int] = None, max_large_storage_mb: Optional[int] = None, min_storage_mb: Optional[int] = None, service_level_objectives: Optional[List[azure.mgmt.rdbms.postgresql.models._models_py3.PerformanceTierServiceLevelObjectives]] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Performance tier properties.

Parameters
  • id (str) – ID of the performance tier.

  • max_backup_retention_days (int) – Maximum Backup retention in days for the performance tier edition.

  • min_backup_retention_days (int) – Minimum Backup retention in days for the performance tier edition.

  • max_storage_mb (int) – Max storage allowed for a server.

  • min_large_storage_mb (int) – Max storage allowed for a server.

  • max_large_storage_mb (int) – Max storage allowed for a server.

  • min_storage_mb (int) – Max storage allowed for a server.

  • service_level_objectives (list[PerformanceTierServiceLevelObjectives]) – Service level objectives associated with the performance tier.

class azure.mgmt.rdbms.postgresql.models.PerformanceTierServiceLevelObjectives(*, id: Optional[str] = None, edition: Optional[str] = None, v_core: Optional[int] = None, hardware_generation: Optional[str] = None, max_backup_retention_days: Optional[int] = None, min_backup_retention_days: Optional[int] = None, max_storage_mb: Optional[int] = None, min_storage_mb: Optional[int] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Service level objectives for performance tier.

Parameters
  • id (str) – ID for the service level objective.

  • edition (str) – Edition of the performance tier.

  • v_core (int) – vCore associated with the service level objective.

  • hardware_generation (str) – Hardware generation associated with the service level objective.

  • max_backup_retention_days (int) – Maximum Backup retention in days for the performance tier edition.

  • min_backup_retention_days (int) – Minimum Backup retention in days for the performance tier edition.

  • max_storage_mb (int) – Max storage allowed for a server.

  • min_storage_mb (int) – Max storage allowed for a server.

class azure.mgmt.rdbms.postgresql.models.PrivateEndpointConnection(*, private_endpoint: Optional[azure.mgmt.rdbms.postgresql.models._models_py3.PrivateEndpointProperty] = None, private_link_service_connection_state: Optional[azure.mgmt.rdbms.postgresql.models._models_py3.PrivateLinkServiceConnectionStateProperty] = None, **kwargs)[source]

Bases: azure.mgmt.rdbms.postgresql.models._models_py3.ProxyResource

A private endpoint connection.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • provisioning_state (str) – State of the private endpoint connection.

Parameters
class azure.mgmt.rdbms.postgresql.models.PrivateEndpointConnectionListResult(**kwargs)[source]

Bases: msrest.serialization.Model

A list of private endpoint connections.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
class azure.mgmt.rdbms.postgresql.models.PrivateEndpointProperty(*, id: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

PrivateEndpointProperty.

Parameters

id (str) – Resource id of the private endpoint.

class azure.mgmt.rdbms.postgresql.models.PrivateEndpointProvisioningState(value)[source]

Bases: str, enum.Enum

State of the private endpoint connection.

APPROVING = 'Approving'
DROPPING = 'Dropping'
FAILED = 'Failed'
READY = 'Ready'
REJECTING = 'Rejecting'
class azure.mgmt.rdbms.postgresql.models.PrivateLinkResource(**kwargs)[source]

Bases: azure.mgmt.rdbms.postgresql.models._models_py3.ProxyResource

A private link resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • properties (PrivateLinkResourceProperties) – The private link resource group id.

class azure.mgmt.rdbms.postgresql.models.PrivateLinkResourceListResult(**kwargs)[source]

Bases: msrest.serialization.Model

A list of private link resources.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
class azure.mgmt.rdbms.postgresql.models.PrivateLinkResourceProperties(**kwargs)[source]

Bases: msrest.serialization.Model

Properties of a private link resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • group_id (str) – The private link resource group id.

  • required_members (list[str]) – The private link resource required member names.

class azure.mgmt.rdbms.postgresql.models.PrivateLinkServiceConnectionStateActionsRequire(value)[source]

Bases: str, enum.Enum

The actions required for private link service connection.

NONE = 'None'
class azure.mgmt.rdbms.postgresql.models.PrivateLinkServiceConnectionStateProperty(*, status: str, description: str, **kwargs)[source]

Bases: msrest.serialization.Model

PrivateLinkServiceConnectionStateProperty.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters
  • status (str) – Required. The private link service connection status.

  • description (str) – Required. The private link service connection description.

Variables

actions_required (str) – The actions required for private link service connection.

class azure.mgmt.rdbms.postgresql.models.PrivateLinkServiceConnectionStateStatus(value)[source]

Bases: str, enum.Enum

The private link service connection status.

APPROVED = 'Approved'
DISCONNECTED = 'Disconnected'
PENDING = 'Pending'
REJECTED = 'Rejected'
class azure.mgmt.rdbms.postgresql.models.ProxyResource(**kwargs)[source]

Bases: azure.mgmt.rdbms.postgresql.models._models_py3.Resource

The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

class azure.mgmt.rdbms.postgresql.models.PublicNetworkAccessEnum(value)[source]

Bases: str, enum.Enum

Whether or not public network access is allowed for this server. Value is optional but if passed in, must be ‘Enabled’ or ‘Disabled’

DISABLED = 'Disabled'
ENABLED = 'Enabled'
class azure.mgmt.rdbms.postgresql.models.RecoverableServerResource(**kwargs)[source]

Bases: azure.mgmt.rdbms.postgresql.models._models_py3.ProxyResource

A recoverable server resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • last_available_backup_date_time (str) – The last available backup date time.

  • service_level_objective (str) – The service level objective.

  • edition (str) – Edition of the performance tier.

  • v_core (int) – vCore associated with the service level objective.

  • hardware_generation (str) – Hardware generation associated with the service level objective.

  • version (str) – The PostgreSQL version.

class azure.mgmt.rdbms.postgresql.models.Resource(**kwargs)[source]

Bases: msrest.serialization.Model

Common fields that are returned in the response for all Azure Resource Manager resources.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

class azure.mgmt.rdbms.postgresql.models.ResourceIdentity(*, type: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Azure Active Directory identity configuration for a resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • principal_id (str) – The Azure Active Directory principal id.

  • tenant_id (str) – The Azure Active Directory tenant id.

Parameters

type (str or IdentityType) – The identity type. Set this to ‘SystemAssigned’ in order to automatically create and assign an Azure Active Directory principal for the resource. Possible values include: “SystemAssigned”.

class azure.mgmt.rdbms.postgresql.models.SecurityAlertPolicyName(value)[source]

Bases: str, enum.Enum

An enumeration.

DEFAULT = 'Default'
class azure.mgmt.rdbms.postgresql.models.Server(*, location: str, tags: Optional[Dict[str, str]] = None, identity: Optional[azure.mgmt.rdbms.postgresql.models._models_py3.ResourceIdentity] = None, sku: Optional[azure.mgmt.rdbms.postgresql.models._models_py3.Sku] = None, administrator_login: Optional[str] = None, version: Optional[str] = None, ssl_enforcement: Optional[str] = None, minimal_tls_version: Optional[str] = None, infrastructure_encryption: Optional[str] = None, user_visible_state: Optional[str] = None, fully_qualified_domain_name: Optional[str] = None, earliest_restore_date: Optional[datetime.datetime] = None, storage_profile: Optional[azure.mgmt.rdbms.postgresql.models._models_py3.StorageProfile] = None, replication_role: Optional[str] = None, master_server_id: Optional[str] = None, replica_capacity: Optional[int] = None, public_network_access: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.rdbms.postgresql.models._models_py3.TrackedResource

Represents a server.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables
  • id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • byok_enforcement (str) – Status showing whether the server data encryption is enabled with customer-managed keys.

  • private_endpoint_connections (list[ServerPrivateEndpointConnection]) – List of private endpoint connections on a server.

Parameters
  • tags (dict[str, str]) – A set of tags. Resource tags.

  • location (str) – Required. The geo-location where the resource lives.

  • identity (ResourceIdentity) – The Azure Active Directory identity of the server.

  • sku (Sku) – The SKU (pricing tier) of the server.

  • administrator_login (str) – The administrator’s login name of a server. Can only be specified when the server is being created (and is required for creation).

  • version (str or ServerVersion) – Server version. Possible values include: “9.5”, “9.6”, “10”, “10.0”, “10.2”, “11”.

  • ssl_enforcement (str or SslEnforcementEnum) – Enable ssl enforcement or not when connect to server. Possible values include: “Enabled”, “Disabled”.

  • minimal_tls_version (str or MinimalTlsVersionEnum) – Enforce a minimal Tls version for the server. Possible values include: “TLS1_0”, “TLS1_1”, “TLS1_2”, “TLSEnforcementDisabled”.

  • infrastructure_encryption (str or InfrastructureEncryption) – Status showing whether the server enabled infrastructure encryption. Possible values include: “Enabled”, “Disabled”.

  • user_visible_state (str or ServerState) – A state of a server that is visible to user. Possible values include: “Ready”, “Dropping”, “Disabled”, “Inaccessible”.

  • fully_qualified_domain_name (str) – The fully qualified domain name of a server.

  • earliest_restore_date (datetime) – Earliest restore point creation time (ISO8601 format).

  • storage_profile (StorageProfile) – Storage profile of a server.

  • replication_role (str) – The replication role of the server.

  • master_server_id (str) – The master server id of a replica server.

  • replica_capacity (int) – The maximum number of replicas that a master server can have.

  • public_network_access (str or PublicNetworkAccessEnum) – Whether or not public network access is allowed for this server. Value is optional but if passed in, must be ‘Enabled’ or ‘Disabled’. Possible values include: “Enabled”, “Disabled”.

class azure.mgmt.rdbms.postgresql.models.ServerAdministratorResource(*, administrator_type: Optional[str] = None, login: Optional[str] = None, sid: Optional[str] = None, tenant_id: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.rdbms.postgresql.models._models_py3.ProxyResource

Represents a and external administrator to be created.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

Parameters
  • administrator_type (str) – The type of administrator. The only acceptable values to pass in are None and “ActiveDirectory”. The default value is None.

  • login (str) – The server administrator login account name.

  • sid (str) – The server administrator Sid (Secure ID).

  • tenant_id (str) – The server Active Directory Administrator tenant id.

class azure.mgmt.rdbms.postgresql.models.ServerAdministratorResourceListResult(*, value: Optional[List[azure.mgmt.rdbms.postgresql.models._models_py3.ServerAdministratorResource]] = None, **kwargs)[source]

Bases: msrest.serialization.Model

The response to a list Active Directory Administrators request.

Parameters

value (list[ServerAdministratorResource]) – The list of server Active Directory Administrators for the server.

class azure.mgmt.rdbms.postgresql.models.ServerForCreate(*, properties: azure.mgmt.rdbms.postgresql.models._models_py3.ServerPropertiesForCreate, location: str, identity: Optional[azure.mgmt.rdbms.postgresql.models._models_py3.ResourceIdentity] = None, sku: Optional[azure.mgmt.rdbms.postgresql.models._models_py3.Sku] = None, tags: Optional[Dict[str, str]] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Represents a server to be created.

All required parameters must be populated in order to send to Azure.

Parameters
  • identity (ResourceIdentity) – The Azure Active Directory identity of the server.

  • sku (Sku) – The SKU (pricing tier) of the server.

  • properties (ServerPropertiesForCreate) – Required. Properties of the server.

  • location (str) – Required. The location the resource resides in.

  • tags (dict[str, str]) – A set of tags. Application-specific metadata in the form of key-value pairs.

class azure.mgmt.rdbms.postgresql.models.ServerKey(*, server_key_type: Optional[str] = None, uri: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.rdbms.postgresql.models._models_py3.ProxyResource

A PostgreSQL Server key.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • kind (str) – Kind of encryption protector used to protect the key.

  • creation_date (datetime) – The key creation date.

Parameters
  • server_key_type (str or ServerKeyType) – The key type like ‘AzureKeyVault’. Possible values include: “AzureKeyVault”.

  • uri (str) – The URI of the key.

class azure.mgmt.rdbms.postgresql.models.ServerKeyListResult(**kwargs)[source]

Bases: msrest.serialization.Model

A list of PostgreSQL Server keys.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • value (list[ServerKey]) – A list of PostgreSQL Server keys.

  • next_link (str) – Link to retrieve next page of results.

class azure.mgmt.rdbms.postgresql.models.ServerKeyType(value)[source]

Bases: str, enum.Enum

The key type like ‘AzureKeyVault’.

AZURE_KEY_VAULT = 'AzureKeyVault'
class azure.mgmt.rdbms.postgresql.models.ServerListResult(*, value: Optional[List[azure.mgmt.rdbms.postgresql.models._models_py3.Server]] = None, **kwargs)[source]

Bases: msrest.serialization.Model

A list of servers.

Parameters

value (list[Server]) – The list of servers.

class azure.mgmt.rdbms.postgresql.models.ServerPrivateEndpointConnection(**kwargs)[source]

Bases: msrest.serialization.Model

A private endpoint connection under a server.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
class azure.mgmt.rdbms.postgresql.models.ServerPrivateEndpointConnectionProperties(*, private_endpoint: Optional[azure.mgmt.rdbms.postgresql.models._models_py3.PrivateEndpointProperty] = None, private_link_service_connection_state: Optional[azure.mgmt.rdbms.postgresql.models._models_py3.ServerPrivateLinkServiceConnectionStateProperty] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Properties of a private endpoint connection.

Variables are only populated by the server, and will be ignored when sending a request.

Parameters
Variables

provisioning_state (str or PrivateEndpointProvisioningState) – State of the private endpoint connection. Possible values include: “Approving”, “Ready”, “Dropping”, “Failed”, “Rejecting”.

class azure.mgmt.rdbms.postgresql.models.ServerPrivateLinkServiceConnectionStateProperty(*, status: str, description: str, **kwargs)[source]

Bases: msrest.serialization.Model

ServerPrivateLinkServiceConnectionStateProperty.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters
  • status (str or PrivateLinkServiceConnectionStateStatus) – Required. The private link service connection status. Possible values include: “Approved”, “Pending”, “Rejected”, “Disconnected”.

  • description (str) – Required. The private link service connection description.

Variables

actions_required (str or PrivateLinkServiceConnectionStateActionsRequire) – The actions required for private link service connection. Possible values include: “None”.

class azure.mgmt.rdbms.postgresql.models.ServerPropertiesForCreate(*, version: Optional[str] = None, ssl_enforcement: Optional[str] = None, minimal_tls_version: Optional[str] = None, infrastructure_encryption: Optional[str] = None, public_network_access: Optional[str] = None, storage_profile: Optional[azure.mgmt.rdbms.postgresql.models._models_py3.StorageProfile] = None, **kwargs)[source]

Bases: msrest.serialization.Model

The properties used to create a new server.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: ServerPropertiesForDefaultCreate, ServerPropertiesForGeoRestore, ServerPropertiesForRestore, ServerPropertiesForReplica.

All required parameters must be populated in order to send to Azure.

Parameters
  • version (str or ServerVersion) – Server version. Possible values include: “9.5”, “9.6”, “10”, “10.0”, “10.2”, “11”.

  • ssl_enforcement (str or SslEnforcementEnum) – Enable ssl enforcement or not when connect to server. Possible values include: “Enabled”, “Disabled”.

  • minimal_tls_version (str or MinimalTlsVersionEnum) – Enforce a minimal Tls version for the server. Possible values include: “TLS1_0”, “TLS1_1”, “TLS1_2”, “TLSEnforcementDisabled”.

  • infrastructure_encryption (str or InfrastructureEncryption) – Status showing whether the server enabled infrastructure encryption. Possible values include: “Enabled”, “Disabled”.

  • public_network_access (str or PublicNetworkAccessEnum) – Whether or not public network access is allowed for this server. Value is optional but if passed in, must be ‘Enabled’ or ‘Disabled’. Possible values include: “Enabled”, “Disabled”.

  • storage_profile (StorageProfile) – Storage profile of a server.

  • create_mode (str or CreateMode) – Required. The mode to create a new server.Constant filled by server. Possible values include: “Default”, “PointInTimeRestore”, “GeoRestore”, “Replica”.

class azure.mgmt.rdbms.postgresql.models.ServerPropertiesForDefaultCreate(*, administrator_login: str, administrator_login_password: str, version: Optional[str] = None, ssl_enforcement: Optional[str] = None, minimal_tls_version: Optional[str] = None, infrastructure_encryption: Optional[str] = None, public_network_access: Optional[str] = None, storage_profile: Optional[azure.mgmt.rdbms.postgresql.models._models_py3.StorageProfile] = None, **kwargs)[source]

Bases: azure.mgmt.rdbms.postgresql.models._models_py3.ServerPropertiesForCreate

The properties used to create a new server.

All required parameters must be populated in order to send to Azure.

Parameters
  • version (str or ServerVersion) – Server version. Possible values include: “9.5”, “9.6”, “10”, “10.0”, “10.2”, “11”.

  • ssl_enforcement (str or SslEnforcementEnum) – Enable ssl enforcement or not when connect to server. Possible values include: “Enabled”, “Disabled”.

  • minimal_tls_version (str or MinimalTlsVersionEnum) – Enforce a minimal Tls version for the server. Possible values include: “TLS1_0”, “TLS1_1”, “TLS1_2”, “TLSEnforcementDisabled”.

  • infrastructure_encryption (str or InfrastructureEncryption) – Status showing whether the server enabled infrastructure encryption. Possible values include: “Enabled”, “Disabled”.

  • public_network_access (str or PublicNetworkAccessEnum) – Whether or not public network access is allowed for this server. Value is optional but if passed in, must be ‘Enabled’ or ‘Disabled’. Possible values include: “Enabled”, “Disabled”.

  • storage_profile (StorageProfile) – Storage profile of a server.

  • create_mode (str or CreateMode) – Required. The mode to create a new server.Constant filled by server. Possible values include: “Default”, “PointInTimeRestore”, “GeoRestore”, “Replica”.

  • administrator_login (str) – Required. The administrator’s login name of a server. Can only be specified when the server is being created (and is required for creation).

  • administrator_login_password (str) – Required. The password of the administrator login.

class azure.mgmt.rdbms.postgresql.models.ServerPropertiesForGeoRestore(*, source_server_id: str, version: Optional[str] = None, ssl_enforcement: Optional[str] = None, minimal_tls_version: Optional[str] = None, infrastructure_encryption: Optional[str] = None, public_network_access: Optional[str] = None, storage_profile: Optional[azure.mgmt.rdbms.postgresql.models._models_py3.StorageProfile] = None, **kwargs)[source]

Bases: azure.mgmt.rdbms.postgresql.models._models_py3.ServerPropertiesForCreate

The properties used to create a new server by restoring to a different region from a geo replicated backup.

All required parameters must be populated in order to send to Azure.

Parameters
  • version (str or ServerVersion) – Server version. Possible values include: “9.5”, “9.6”, “10”, “10.0”, “10.2”, “11”.

  • ssl_enforcement (str or SslEnforcementEnum) – Enable ssl enforcement or not when connect to server. Possible values include: “Enabled”, “Disabled”.

  • minimal_tls_version (str or MinimalTlsVersionEnum) – Enforce a minimal Tls version for the server. Possible values include: “TLS1_0”, “TLS1_1”, “TLS1_2”, “TLSEnforcementDisabled”.

  • infrastructure_encryption (str or InfrastructureEncryption) – Status showing whether the server enabled infrastructure encryption. Possible values include: “Enabled”, “Disabled”.

  • public_network_access (str or PublicNetworkAccessEnum) – Whether or not public network access is allowed for this server. Value is optional but if passed in, must be ‘Enabled’ or ‘Disabled’. Possible values include: “Enabled”, “Disabled”.

  • storage_profile (StorageProfile) – Storage profile of a server.

  • create_mode (str or CreateMode) – Required. The mode to create a new server.Constant filled by server. Possible values include: “Default”, “PointInTimeRestore”, “GeoRestore”, “Replica”.

  • source_server_id (str) – Required. The source server id to restore from.

class azure.mgmt.rdbms.postgresql.models.ServerPropertiesForReplica(*, source_server_id: str, version: Optional[str] = None, ssl_enforcement: Optional[str] = None, minimal_tls_version: Optional[str] = None, infrastructure_encryption: Optional[str] = None, public_network_access: Optional[str] = None, storage_profile: Optional[azure.mgmt.rdbms.postgresql.models._models_py3.StorageProfile] = None, **kwargs)[source]

Bases: azure.mgmt.rdbms.postgresql.models._models_py3.ServerPropertiesForCreate

The properties to create a new replica.

All required parameters must be populated in order to send to Azure.

Parameters
  • version (str or ServerVersion) – Server version. Possible values include: “9.5”, “9.6”, “10”, “10.0”, “10.2”, “11”.

  • ssl_enforcement (str or SslEnforcementEnum) – Enable ssl enforcement or not when connect to server. Possible values include: “Enabled”, “Disabled”.

  • minimal_tls_version (str or MinimalTlsVersionEnum) – Enforce a minimal Tls version for the server. Possible values include: “TLS1_0”, “TLS1_1”, “TLS1_2”, “TLSEnforcementDisabled”.

  • infrastructure_encryption (str or InfrastructureEncryption) – Status showing whether the server enabled infrastructure encryption. Possible values include: “Enabled”, “Disabled”.

  • public_network_access (str or PublicNetworkAccessEnum) – Whether or not public network access is allowed for this server. Value is optional but if passed in, must be ‘Enabled’ or ‘Disabled’. Possible values include: “Enabled”, “Disabled”.

  • storage_profile (StorageProfile) – Storage profile of a server.

  • create_mode (str or CreateMode) – Required. The mode to create a new server.Constant filled by server. Possible values include: “Default”, “PointInTimeRestore”, “GeoRestore”, “Replica”.

  • source_server_id (str) – Required. The master server id to create replica from.

class azure.mgmt.rdbms.postgresql.models.ServerPropertiesForRestore(*, source_server_id: str, restore_point_in_time: datetime.datetime, version: Optional[str] = None, ssl_enforcement: Optional[str] = None, minimal_tls_version: Optional[str] = None, infrastructure_encryption: Optional[str] = None, public_network_access: Optional[str] = None, storage_profile: Optional[azure.mgmt.rdbms.postgresql.models._models_py3.StorageProfile] = None, **kwargs)[source]

Bases: azure.mgmt.rdbms.postgresql.models._models_py3.ServerPropertiesForCreate

The properties used to create a new server by restoring from a backup.

All required parameters must be populated in order to send to Azure.

Parameters
  • version (str or ServerVersion) – Server version. Possible values include: “9.5”, “9.6”, “10”, “10.0”, “10.2”, “11”.

  • ssl_enforcement (str or SslEnforcementEnum) – Enable ssl enforcement or not when connect to server. Possible values include: “Enabled”, “Disabled”.

  • minimal_tls_version (str or MinimalTlsVersionEnum) – Enforce a minimal Tls version for the server. Possible values include: “TLS1_0”, “TLS1_1”, “TLS1_2”, “TLSEnforcementDisabled”.

  • infrastructure_encryption (str or InfrastructureEncryption) – Status showing whether the server enabled infrastructure encryption. Possible values include: “Enabled”, “Disabled”.

  • public_network_access (str or PublicNetworkAccessEnum) – Whether or not public network access is allowed for this server. Value is optional but if passed in, must be ‘Enabled’ or ‘Disabled’. Possible values include: “Enabled”, “Disabled”.

  • storage_profile (StorageProfile) – Storage profile of a server.

  • create_mode (str or CreateMode) – Required. The mode to create a new server.Constant filled by server. Possible values include: “Default”, “PointInTimeRestore”, “GeoRestore”, “Replica”.

  • source_server_id (str) – Required. The source server id to restore from.

  • restore_point_in_time (datetime) – Required. Restore point creation time (ISO8601 format), specifying the time to restore from.

class azure.mgmt.rdbms.postgresql.models.ServerSecurityAlertPolicy(*, state: Optional[str] = None, disabled_alerts: Optional[List[str]] = None, email_addresses: Optional[List[str]] = None, email_account_admins: Optional[bool] = None, storage_endpoint: Optional[str] = None, storage_account_access_key: Optional[str] = None, retention_days: Optional[int] = None, **kwargs)[source]

Bases: azure.mgmt.rdbms.postgresql.models._models_py3.ProxyResource

A server security alert policy.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

Parameters
  • state (str or ServerSecurityAlertPolicyState) – Specifies the state of the policy, whether it is enabled or disabled. Possible values include: “Enabled”, “Disabled”.

  • disabled_alerts (list[str]) – Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly.

  • email_addresses (list[str]) – Specifies an array of e-mail addresses to which the alert is sent.

  • email_account_admins (bool) – Specifies that the alert is sent to the account administrators.

  • storage_endpoint (str) – Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.

  • storage_account_access_key (str) – Specifies the identifier key of the Threat Detection audit storage account.

  • retention_days (int) – Specifies the number of days to keep in the Threat Detection audit logs.

class azure.mgmt.rdbms.postgresql.models.ServerSecurityAlertPolicyListResult(**kwargs)[source]

Bases: msrest.serialization.Model

A list of the server’s security alert policies.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
class azure.mgmt.rdbms.postgresql.models.ServerSecurityAlertPolicyState(value)[source]

Bases: str, enum.Enum

Specifies the state of the policy, whether it is enabled or disabled.

DISABLED = 'Disabled'
ENABLED = 'Enabled'
class azure.mgmt.rdbms.postgresql.models.ServerState(value)[source]

Bases: str, enum.Enum

A state of a server that is visible to user.

DISABLED = 'Disabled'
DROPPING = 'Dropping'
INACCESSIBLE = 'Inaccessible'
READY = 'Ready'
class azure.mgmt.rdbms.postgresql.models.ServerUpdateParameters(*, identity: Optional[azure.mgmt.rdbms.postgresql.models._models_py3.ResourceIdentity] = None, sku: Optional[azure.mgmt.rdbms.postgresql.models._models_py3.Sku] = None, tags: Optional[Dict[str, str]] = None, storage_profile: Optional[azure.mgmt.rdbms.postgresql.models._models_py3.StorageProfile] = None, administrator_login_password: Optional[str] = None, version: Optional[str] = None, ssl_enforcement: Optional[str] = None, minimal_tls_version: Optional[str] = None, public_network_access: Optional[str] = None, replication_role: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Parameters allowed to update for a server.

Parameters
  • identity (ResourceIdentity) – The Azure Active Directory identity of the server.

  • sku (Sku) – The SKU (pricing tier) of the server.

  • tags (dict[str, str]) – A set of tags. Application-specific metadata in the form of key-value pairs.

  • storage_profile (StorageProfile) – Storage profile of a server.

  • administrator_login_password (str) – The password of the administrator login.

  • version (str or ServerVersion) – The version of a server. Possible values include: “9.5”, “9.6”, “10”, “10.0”, “10.2”, “11”.

  • ssl_enforcement (str or SslEnforcementEnum) – Enable ssl enforcement or not when connect to server. Possible values include: “Enabled”, “Disabled”.

  • minimal_tls_version (str or MinimalTlsVersionEnum) – Enforce a minimal Tls version for the server. Possible values include: “TLS1_0”, “TLS1_1”, “TLS1_2”, “TLSEnforcementDisabled”.

  • public_network_access (str or PublicNetworkAccessEnum) – Whether or not public network access is allowed for this server. Value is optional but if passed in, must be ‘Enabled’ or ‘Disabled’. Possible values include: “Enabled”, “Disabled”.

  • replication_role (str) – The replication role of the server.

class azure.mgmt.rdbms.postgresql.models.ServerVersion(value)[source]

Bases: str, enum.Enum

The version of a server.

ELEVEN = '11'
NINE5 = '9.5'
NINE6 = '9.6'
TEN = '10'
TEN0 = '10.0'
TEN2 = '10.2'
class azure.mgmt.rdbms.postgresql.models.Sku(*, name: str, tier: Optional[str] = None, capacity: Optional[int] = None, size: Optional[str] = None, family: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Billing information related properties of a server.

All required parameters must be populated in order to send to Azure.

Parameters
  • name (str) – Required. The name of the sku, typically, tier + family + cores, e.g. B_Gen4_1, GP_Gen5_8.

  • tier (str or SkuTier) – The tier of the particular SKU, e.g. Basic. Possible values include: “Basic”, “GeneralPurpose”, “MemoryOptimized”.

  • capacity (int) – The scale up/out capacity, representing server’s compute units.

  • size (str) – The size code, to be interpreted by resource as appropriate.

  • family (str) – The family of hardware.

class azure.mgmt.rdbms.postgresql.models.SkuTier(value)[source]

Bases: str, enum.Enum

The tier of the particular SKU, e.g. Basic.

BASIC = 'Basic'
GENERAL_PURPOSE = 'GeneralPurpose'
MEMORY_OPTIMIZED = 'MemoryOptimized'
class azure.mgmt.rdbms.postgresql.models.SslEnforcementEnum(value)[source]

Bases: str, enum.Enum

Enable ssl enforcement or not when connect to server.

DISABLED = 'Disabled'
ENABLED = 'Enabled'
class azure.mgmt.rdbms.postgresql.models.StorageAutogrow(value)[source]

Bases: str, enum.Enum

Enable Storage Auto Grow.

DISABLED = 'Disabled'
ENABLED = 'Enabled'
class azure.mgmt.rdbms.postgresql.models.StorageProfile(*, backup_retention_days: Optional[int] = None, geo_redundant_backup: Optional[str] = None, storage_mb: Optional[int] = None, storage_autogrow: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Storage Profile properties of a server.

Parameters
  • backup_retention_days (int) – Backup retention days for the server.

  • geo_redundant_backup (str or GeoRedundantBackup) – Enable Geo-redundant or not for server backup. Possible values include: “Enabled”, “Disabled”.

  • storage_mb (int) – Max storage allowed for a server.

  • storage_autogrow (str or StorageAutogrow) – Enable Storage Auto Grow. Possible values include: “Enabled”, “Disabled”.

class azure.mgmt.rdbms.postgresql.models.TagsObject(*, tags: Optional[Dict[str, str]] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Tags object for patch operations.

Parameters

tags (dict[str, str]) – A set of tags. Resource tags.

class azure.mgmt.rdbms.postgresql.models.TrackedResource(*, location: str, tags: Optional[Dict[str, str]] = None, **kwargs)[source]

Bases: azure.mgmt.rdbms.postgresql.models._models_py3.Resource

The resource model definition for an Azure Resource Manager tracked top level resource which has ‘tags’ and a ‘location’.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables
  • id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

Parameters
  • tags (dict[str, str]) – A set of tags. Resource tags.

  • location (str) – Required. The geo-location where the resource lives.

class azure.mgmt.rdbms.postgresql.models.VirtualNetworkRule(*, virtual_network_subnet_id: Optional[str] = None, ignore_missing_vnet_service_endpoint: Optional[bool] = None, **kwargs)[source]

Bases: azure.mgmt.rdbms.postgresql.models._models_py3.ProxyResource

A virtual network rule.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • state (str or VirtualNetworkRuleState) – Virtual Network Rule State. Possible values include: “Initializing”, “InProgress”, “Ready”, “Deleting”, “Unknown”.

Parameters
  • virtual_network_subnet_id (str) – The ARM resource id of the virtual network subnet.

  • ignore_missing_vnet_service_endpoint (bool) – Create firewall rule before the virtual network has vnet service endpoint enabled.

class azure.mgmt.rdbms.postgresql.models.VirtualNetworkRuleListResult(**kwargs)[source]

Bases: msrest.serialization.Model

A list of virtual network rules.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
class azure.mgmt.rdbms.postgresql.models.VirtualNetworkRuleState(value)[source]

Bases: str, enum.Enum

Virtual Network Rule State

DELETING = 'Deleting'
INITIALIZING = 'Initializing'
IN_PROGRESS = 'InProgress'
READY = 'Ready'
UNKNOWN = 'Unknown'