dbforpostgresql.azure.com/v1api20230601preview
dbforpostgresql.azure.com/v1api20230601preview
Package v1api20230601preview contains API Schema definitions for the dbforpostgresql v1api20230601preview API group
APIVersion
(string
alias)
Value | Description |
---|---|
"2023-06-01-preview" |
AuthConfig
(Appears on:FlexibleServer_Spec)
Authentication configuration properties of a server
Field | Description |
---|---|
activeDirectoryAuth AuthConfig_ActiveDirectoryAuth |
ActiveDirectoryAuth: If Enabled, Azure Active Directory authentication is enabled. |
passwordAuth AuthConfig_PasswordAuth |
PasswordAuth: If Enabled, Password authentication is enabled. |
tenantId string |
TenantId: Tenant id of the server. |
AuthConfig_ActiveDirectoryAuth
(string
alias)
(Appears on:AuthConfig)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
AuthConfig_ActiveDirectoryAuth_STATUS
(string
alias)
(Appears on:AuthConfig_STATUS)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
AuthConfig_PasswordAuth
(string
alias)
(Appears on:AuthConfig)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
AuthConfig_PasswordAuth_STATUS
(string
alias)
(Appears on:AuthConfig_STATUS)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
AuthConfig_STATUS
(Appears on:FlexibleServer_STATUS)
Authentication configuration properties of a server
Field | Description |
---|---|
activeDirectoryAuth AuthConfig_ActiveDirectoryAuth_STATUS |
ActiveDirectoryAuth: If Enabled, Azure Active Directory authentication is enabled. |
passwordAuth AuthConfig_PasswordAuth_STATUS |
PasswordAuth: If Enabled, Password authentication is enabled. |
tenantId string |
TenantId: Tenant id of the server. |
Backup
(Appears on:FlexibleServer_Spec)
Backup properties of a server
Field | Description |
---|---|
backupRetentionDays int |
BackupRetentionDays: Backup retention days for the server. |
geoRedundantBackup Backup_GeoRedundantBackup |
GeoRedundantBackup: A value indicating whether Geo-Redundant backup is enabled on the server. |
Backup_GeoRedundantBackup
(string
alias)
(Appears on:Backup)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
Backup_GeoRedundantBackup_STATUS
(string
alias)
(Appears on:Backup_STATUS)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
Backup_STATUS
(Appears on:FlexibleServer_STATUS)
Backup properties of a server
Field | Description |
---|---|
backupRetentionDays int |
BackupRetentionDays: Backup retention days for the server. |
earliestRestoreDate string |
EarliestRestoreDate: The earliest restore point time (ISO8601 format) for server. |
geoRedundantBackup Backup_GeoRedundantBackup_STATUS |
GeoRedundantBackup: A value indicating whether Geo-Redundant backup is enabled on the server. |
ConfigurationProperties_DataType_STATUS
(string
alias)
(Appears on:FlexibleServersConfiguration_STATUS)
Value | Description |
---|---|
"Boolean" |
|
"Enumeration" |
|
"Integer" |
|
"Numeric" |
DataEncryption
(Appears on:FlexibleServer_Spec)
Data encryption properties of a server
Field | Description |
---|---|
geoBackupEncryptionKeyStatus DataEncryption_GeoBackupEncryptionKeyStatus |
GeoBackupEncryptionKeyStatus: Geo-backup encryption key status for Data encryption enabled server. |
geoBackupKeyURI string |
GeoBackupKeyURI: URI for the key in keyvault for data encryption for geo-backup of server. |
geoBackupKeyURIFromConfig genruntime.ConfigMapReference |
GeoBackupKeyURIFromConfig: URI for the key in keyvault for data encryption for geo-backup of server. |
geoBackupUserAssignedIdentityReference genruntime.ResourceReference |
GeoBackupUserAssignedIdentityReference: Resource Id for the User assigned identity to be used for data encryption for geo-backup of server. |
primaryEncryptionKeyStatus DataEncryption_PrimaryEncryptionKeyStatus |
PrimaryEncryptionKeyStatus: Primary encryption key status for Data encryption enabled server. |
primaryKeyURI string |
PrimaryKeyURI: URI for the key in keyvault for data encryption of the primary server. |
primaryKeyURIFromConfig genruntime.ConfigMapReference |
PrimaryKeyURIFromConfig: URI for the key in keyvault for data encryption of the primary server. |
primaryUserAssignedIdentityReference genruntime.ResourceReference |
PrimaryUserAssignedIdentityReference: Resource Id for the User assigned identity to be used for data encryption of the primary server. |
type DataEncryption_Type |
Type: Data encryption type to depict if it is System Managed vs Azure Key vault. |
DataEncryption_GeoBackupEncryptionKeyStatus
(string
alias)
(Appears on:DataEncryption)
Value | Description |
---|---|
"Invalid" |
|
"Valid" |
DataEncryption_GeoBackupEncryptionKeyStatus_STATUS
(string
alias)
(Appears on:DataEncryption_STATUS)
Value | Description |
---|---|
"Invalid" |
|
"Valid" |
DataEncryption_PrimaryEncryptionKeyStatus
(string
alias)
(Appears on:DataEncryption)
Value | Description |
---|---|
"Invalid" |
|
"Valid" |
DataEncryption_PrimaryEncryptionKeyStatus_STATUS
(string
alias)
(Appears on:DataEncryption_STATUS)
Value | Description |
---|---|
"Invalid" |
|
"Valid" |
DataEncryption_STATUS
(Appears on:FlexibleServer_STATUS)
Data encryption properties of a server
Field | Description |
---|---|
geoBackupEncryptionKeyStatus DataEncryption_GeoBackupEncryptionKeyStatus_STATUS |
GeoBackupEncryptionKeyStatus: Geo-backup encryption key status for Data encryption enabled server. |
geoBackupKeyURI string |
GeoBackupKeyURI: URI for the key in keyvault for data encryption for geo-backup of server. |
geoBackupUserAssignedIdentityId string |
GeoBackupUserAssignedIdentityId: Resource Id for the User assigned identity to be used for data encryption for geo-backup of server. |
primaryEncryptionKeyStatus DataEncryption_PrimaryEncryptionKeyStatus_STATUS |
PrimaryEncryptionKeyStatus: Primary encryption key status for Data encryption enabled server. |
primaryKeyURI string |
PrimaryKeyURI: URI for the key in keyvault for data encryption of the primary server. |
primaryUserAssignedIdentityId string |
PrimaryUserAssignedIdentityId: Resource Id for the User assigned identity to be used for data encryption of the primary server. |
type DataEncryption_Type_STATUS |
Type: Data encryption type to depict if it is System Managed vs Azure Key vault. |
DataEncryption_Type
(string
alias)
(Appears on:DataEncryption)
Value | Description |
---|---|
"AzureKeyVault" |
|
"SystemManaged" |
DataEncryption_Type_STATUS
(string
alias)
(Appears on:DataEncryption_STATUS)
Value | Description |
---|---|
"AzureKeyVault" |
|
"SystemManaged" |
FlexibleServer
Generator information: - Generated from: /postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2023-06-01-preview/FlexibleServers.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}p>
Field | Description | ||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||||||||||||||||||||||||||||||||
spec FlexibleServer_Spec |
|
||||||||||||||||||||||||||||||||||||||||||||||
status FlexibleServer_STATUS |
FlexibleServerOperatorConfigMaps
(Appears on:FlexibleServerOperatorSpec)
Field | Description |
---|---|
fullyQualifiedDomainName genruntime.ConfigMapDestination |
FullyQualifiedDomainName: indicates where the FullyQualifiedDomainName config map should be placed. If omitted, no config map will be created. |
FlexibleServerOperatorSecrets
(Appears on:FlexibleServerOperatorSpec)
Field | Description |
---|---|
fullyQualifiedDomainName genruntime.SecretDestination |
FullyQualifiedDomainName: indicates where the FullyQualifiedDomainName secret should be placed. If omitted, the secret will not be retrieved from Azure. |
FlexibleServerOperatorSpec
(Appears on:FlexibleServer_Spec)
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Field | Description |
---|---|
configMapExpressions []genruntime/core.DestinationExpression |
ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). |
configMaps FlexibleServerOperatorConfigMaps |
ConfigMaps: configures where to place operator written ConfigMaps. |
secretExpressions []genruntime/core.DestinationExpression |
SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). |
secrets FlexibleServerOperatorSecrets |
Secrets: configures where to place Azure generated secrets. |
FlexibleServer_STATUS
(Appears on:FlexibleServer)
Field | Description |
---|---|
administratorLogin string |
AdministratorLogin: The administrator’s login name of a server. Can only be specified when the server is being created (and is required for creation). |
authConfig AuthConfig_STATUS |
AuthConfig: AuthConfig properties of a server. |
availabilityZone string |
AvailabilityZone: availability zone information of the server. |
backup Backup_STATUS |
Backup: Backup properties of a server. |
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
createMode ServerProperties_CreateMode_STATUS |
CreateMode: The mode to create a new PostgreSQL server. |
dataEncryption DataEncryption_STATUS |
DataEncryption: Data encryption properties of a server. |
fullyQualifiedDomainName string |
FullyQualifiedDomainName: The fully qualified domain name of a server. |
highAvailability HighAvailability_STATUS |
HighAvailability: High availability properties of a server. |
id string |
Id: Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”p> |
identity UserAssignedIdentity_STATUS |
Identity: Describes the identity of the application. |
location string |
Location: The geo-location where the resource lives |
maintenanceWindow MaintenanceWindow_STATUS |
MaintenanceWindow: Maintenance window properties of a server. |
minorVersion string |
MinorVersion: The minor version of the server. |
name string |
Name: The name of the resource |
network Network_STATUS |
Network: 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. |
pointInTimeUTC string |
PointInTimeUTC: Restore point creation time (ISO8601 format), specifying the time to restore from. It’s required when ‘createMode’ is ‘PointInTimeRestore’ or ‘GeoRestore’ or ‘ReviveDropped’. |
privateEndpointConnections []PrivateEndpointConnection_STATUS |
PrivateEndpointConnections: List of private endpoint connections associated with the specified resource. |
replica Replica_STATUS |
Replica: Replica properties of a server. These Replica properties are required to be passed only in case you want to Promote a server. |
replicaCapacity int |
ReplicaCapacity: Replicas allowed for a server. |
replicationRole ReplicationRole_STATUS |
ReplicationRole: Replication role of the server |
sku Sku_STATUS |
Sku: The SKU (pricing tier) of the server. |
sourceServerResourceId string |
SourceServerResourceId: 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 |
state ServerProperties_State_STATUS |
State: A state of a server that is visible to user. |
storage Storage_STATUS |
Storage: Storage properties of a server. |
systemData SystemData_STATUS |
SystemData: Azure Resource Manager metadata containing createdBy and modifiedBy information. |
tags map[string]string |
Tags: Resource tags. |
type string |
Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” |
version ServerVersion_STATUS |
Version: PostgreSQL Server version. |
FlexibleServer_Spec
(Appears on:FlexibleServer)
Field | Description |
---|---|
administratorLogin string |
AdministratorLogin: The administrator’s login name of a server. Can only be specified when the server is being created (and is required for creation). |
administratorLoginPassword genruntime.SecretReference |
AdministratorLoginPassword: The administrator login password (required for server creation). |
authConfig AuthConfig |
AuthConfig: AuthConfig properties of a server. |
availabilityZone string |
AvailabilityZone: availability zone information of the server. |
azureName string |
AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. |
backup Backup |
Backup: Backup properties of a server. |
createMode ServerProperties_CreateMode |
CreateMode: The mode to create a new PostgreSQL server. |
dataEncryption DataEncryption |
DataEncryption: Data encryption properties of a server. |
highAvailability HighAvailability |
HighAvailability: High availability properties of a server. |
identity UserAssignedIdentity |
Identity: Describes the identity of the application. |
location string |
Location: The geo-location where the resource lives |
maintenanceWindow MaintenanceWindow |
MaintenanceWindow: Maintenance window properties of a server. |
network Network |
Network: 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. |
operatorSpec FlexibleServerOperatorSpec |
OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure |
owner genruntime.KnownResourceReference |
Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource |
pointInTimeUTC string |
PointInTimeUTC: Restore point creation time (ISO8601 format), specifying the time to restore from. It’s required when ‘createMode’ is ‘PointInTimeRestore’ or ‘GeoRestore’ or ‘ReviveDropped’. |
replica Replica |
Replica: Replica properties of a server. These Replica properties are required to be passed only in case you want to Promote a server. |
replicationRole ReplicationRole |
ReplicationRole: Replication role of the server |
sku Sku |
Sku: The SKU (pricing tier) of the server. |
sourceServerResourceReference genruntime.ResourceReference |
SourceServerResourceReference: 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 |
storage Storage |
Storage: Storage properties of a server. |
tags map[string]string |
Tags: Resource tags. |
version ServerVersion |
Version: PostgreSQL Server version. |
FlexibleServersConfiguration
Generator information: - Generated from: /postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2023-06-01-preview/Configuration.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/configurations/{configurationName}p>
Field | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||
spec FlexibleServersConfiguration_Spec |
|
||||||||||
status FlexibleServersConfiguration_STATUS |
FlexibleServersConfigurationOperatorSpec
(Appears on:FlexibleServersConfiguration_Spec)
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Field | Description |
---|---|
configMapExpressions []genruntime/core.DestinationExpression |
ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). |
secretExpressions []genruntime/core.DestinationExpression |
SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). |
FlexibleServersConfiguration_STATUS
(Appears on:FlexibleServersConfiguration)
Field | Description |
---|---|
allowedValues string |
AllowedValues: Allowed values of the configuration. |
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
dataType ConfigurationProperties_DataType_STATUS |
DataType: Data type of the configuration. |
defaultValue string |
DefaultValue: Default value of the configuration. |
description string |
Description: Description of the configuration. |
documentationLink string |
DocumentationLink: Configuration documentation link. |
id string |
Id: Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”p> |
isConfigPendingRestart bool |
IsConfigPendingRestart: Configuration is pending restart or not. |
isDynamicConfig bool |
IsDynamicConfig: Configuration dynamic or static. |
isReadOnly bool |
IsReadOnly: Configuration read-only or not. |
name string |
Name: The name of the resource |
source string |
Source: Source of the configuration. |
systemData SystemData_STATUS |
SystemData: Azure Resource Manager metadata containing createdBy and modifiedBy information. |
type string |
Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” |
unit string |
Unit: Configuration unit. |
value string |
Value: Value of the configuration. |
FlexibleServersConfiguration_Spec
(Appears on:FlexibleServersConfiguration)
Field | Description |
---|---|
azureName string |
AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. |
operatorSpec FlexibleServersConfigurationOperatorSpec |
OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure |
owner genruntime.KnownResourceReference |
Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a dbforpostgresql.azure.com/FlexibleServer resource |
source string |
Source: Source of the configuration. |
value string |
Value: Value of the configuration. |
FlexibleServersDatabase
Generator information: - Generated from: /postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2023-06-01-preview/Databases.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/databases/{databaseName}p>
Field | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||
spec FlexibleServersDatabase_Spec |
|
||||||||||
status FlexibleServersDatabase_STATUS |
FlexibleServersDatabaseOperatorSpec
(Appears on:FlexibleServersDatabase_Spec)
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Field | Description |
---|---|
configMapExpressions []genruntime/core.DestinationExpression |
ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). |
secretExpressions []genruntime/core.DestinationExpression |
SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). |
FlexibleServersDatabase_STATUS
(Appears on:FlexibleServersDatabase)
Field | Description |
---|---|
charset string |
Charset: The charset of the database. |
collation string |
Collation: The collation of the database. |
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
id string |
Id: Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”p> |
name string |
Name: The name of the resource |
systemData SystemData_STATUS |
SystemData: Azure Resource Manager metadata containing createdBy and modifiedBy information. |
type string |
Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” |
FlexibleServersDatabase_Spec
(Appears on:FlexibleServersDatabase)
Field | Description |
---|---|
azureName string |
AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. |
charset string |
Charset: The charset of the database. |
collation string |
Collation: The collation of the database. |
operatorSpec FlexibleServersDatabaseOperatorSpec |
OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure |
owner genruntime.KnownResourceReference |
Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a dbforpostgresql.azure.com/FlexibleServer resource |
FlexibleServersFirewallRule
Generator information: - Generated from: /postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2023-06-01-preview/FirewallRules.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/firewallRules/{firewallRuleName}p>
Field | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||
spec FlexibleServersFirewallRule_Spec |
|
||||||||||
status FlexibleServersFirewallRule_STATUS |
FlexibleServersFirewallRuleOperatorSpec
(Appears on:FlexibleServersFirewallRule_Spec)
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Field | Description |
---|---|
configMapExpressions []genruntime/core.DestinationExpression |
ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). |
secretExpressions []genruntime/core.DestinationExpression |
SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). |
FlexibleServersFirewallRule_STATUS
(Appears on:FlexibleServersFirewallRule)
Field | Description |
---|---|
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
endIpAddress string |
EndIpAddress: The end IP address of the server firewall rule. Must be IPv4 format. |
id string |
Id: Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”p> |
name string |
Name: The name of the resource |
startIpAddress string |
StartIpAddress: The start IP address of the server firewall rule. Must be IPv4 format. |
systemData SystemData_STATUS |
SystemData: Azure Resource Manager metadata containing createdBy and modifiedBy information. |
type string |
Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” |
FlexibleServersFirewallRule_Spec
(Appears on:FlexibleServersFirewallRule)
Field | Description |
---|---|
azureName string |
AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. |
endIpAddress string |
EndIpAddress: The end IP address of the server firewall rule. Must be IPv4 format. |
operatorSpec FlexibleServersFirewallRuleOperatorSpec |
OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure |
owner genruntime.KnownResourceReference |
Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a dbforpostgresql.azure.com/FlexibleServer resource |
startIpAddress string |
StartIpAddress: The start IP address of the server firewall rule. Must be IPv4 format. |
HighAvailability
(Appears on:FlexibleServer_Spec)
High availability properties of a server
Field | Description |
---|---|
mode HighAvailability_Mode |
Mode: The HA mode for the server. |
standbyAvailabilityZone string |
StandbyAvailabilityZone: availability zone information of the standby. |
HighAvailability_Mode
(string
alias)
(Appears on:HighAvailability)
Value | Description |
---|---|
"Disabled" |
|
"SameZone" |
|
"ZoneRedundant" |
HighAvailability_Mode_STATUS
(string
alias)
(Appears on:HighAvailability_STATUS)
Value | Description |
---|---|
"Disabled" |
|
"SameZone" |
|
"ZoneRedundant" |
HighAvailability_STATUS
(Appears on:FlexibleServer_STATUS)
High availability properties of a server
Field | Description |
---|---|
mode HighAvailability_Mode_STATUS |
Mode: The HA mode for the server. |
standbyAvailabilityZone string |
StandbyAvailabilityZone: availability zone information of the standby. |
state HighAvailability_State_STATUS |
State: A state of a HA server that is visible to user. |
HighAvailability_State_STATUS
(string
alias)
(Appears on:HighAvailability_STATUS)
Value | Description |
---|---|
"CreatingStandby" |
|
"FailingOver" |
|
"Healthy" |
|
"NotEnabled" |
|
"RemovingStandby" |
|
"ReplicatingData" |
MaintenanceWindow
(Appears on:FlexibleServer_Spec)
Maintenance window properties of a server.
Field | Description |
---|---|
customWindow string |
CustomWindow: indicates whether custom window is enabled or disabled |
dayOfWeek int |
DayOfWeek: day of week for maintenance window |
startHour int |
StartHour: start hour for maintenance window |
startMinute int |
StartMinute: start minute for maintenance window |
MaintenanceWindow_STATUS
(Appears on:FlexibleServer_STATUS)
Maintenance window properties of a server.
Field | Description |
---|---|
customWindow string |
CustomWindow: indicates whether custom window is enabled or disabled |
dayOfWeek int |
DayOfWeek: day of week for maintenance window |
startHour int |
StartHour: start hour for maintenance window |
startMinute int |
StartMinute: start minute for maintenance window |
Network
(Appears on:FlexibleServer_Spec)
Network properties of a server.
Field | Description |
---|---|
delegatedSubnetResourceReference genruntime.ResourceReference |
DelegatedSubnetResourceReference: 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. |
privateDnsZoneArmResourceReference genruntime.ResourceReference |
PrivateDnsZoneArmResourceReference: 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. |
publicNetworkAccess Network_PublicNetworkAccess |
PublicNetworkAccess: public network access is enabled or not |
Network_PublicNetworkAccess
(string
alias)
(Appears on:Network)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
Network_PublicNetworkAccess_STATUS
(string
alias)
(Appears on:Network_STATUS)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
Network_STATUS
(Appears on:FlexibleServer_STATUS)
Network properties of a server.
Field | Description |
---|---|
delegatedSubnetResourceId string |
DelegatedSubnetResourceId: 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. |
privateDnsZoneArmResourceId string |
PrivateDnsZoneArmResourceId: 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. |
publicNetworkAccess Network_PublicNetworkAccess_STATUS |
PublicNetworkAccess: public network access is enabled or not |
PrivateEndpointConnection_STATUS
(Appears on:FlexibleServer_STATUS)
The private endpoint connection resource.
Field | Description |
---|---|
id string |
Id: Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”p> |
Replica
(Appears on:FlexibleServer_Spec)
Replica properties of a server
Field | Description |
---|---|
promoteMode Replica_PromoteMode |
PromoteMode: Sets the promote mode for a replica server. This is a write only property. |
promoteOption Replica_PromoteOption |
PromoteOption: Sets the promote options for a replica server. This is a write only property. |
role ReplicationRole |
Role: Used to indicate role of the server in replication set. |
Replica_PromoteMode
(string
alias)
(Appears on:Replica)
Value | Description |
---|---|
"standalone" |
|
"switchover" |
Replica_PromoteMode_STATUS
(string
alias)
(Appears on:Replica_STATUS)
Value | Description |
---|---|
"standalone" |
|
"switchover" |
Replica_PromoteOption
(string
alias)
(Appears on:Replica)
Value | Description |
---|---|
"forced" |
|
"planned" |
Replica_PromoteOption_STATUS
(string
alias)
(Appears on:Replica_STATUS)
Value | Description |
---|---|
"forced" |
|
"planned" |
Replica_ReplicationState_STATUS
(string
alias)
(Appears on:Replica_STATUS)
Value | Description |
---|---|
"Active" |
|
"Broken" |
|
"Catchup" |
|
"Provisioning" |
|
"Reconfiguring" |
|
"Updating" |
Replica_STATUS
(Appears on:FlexibleServer_STATUS)
Replica properties of a server
Field | Description |
---|---|
capacity int |
Capacity: Replicas allowed for a server. |
promoteMode Replica_PromoteMode_STATUS |
PromoteMode: Sets the promote mode for a replica server. This is a write only property. |
promoteOption Replica_PromoteOption_STATUS |
PromoteOption: Sets the promote options for a replica server. This is a write only property. |
replicationState Replica_ReplicationState_STATUS |
ReplicationState: 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 |
role ReplicationRole_STATUS |
Role: Used to indicate role of the server in replication set. |
ReplicationRole
(string
alias)
(Appears on:FlexibleServer_Spec, Replica)
Used to indicate role of the server in replication set.
Value | Description |
---|---|
"AsyncReplica" |
|
"GeoAsyncReplica" |
|
"None" |
|
"Primary" |
ReplicationRole_STATUS
(string
alias)
(Appears on:FlexibleServer_STATUS, Replica_STATUS)
Used to indicate role of the server in replication set.
Value | Description |
---|---|
"AsyncReplica" |
|
"GeoAsyncReplica" |
|
"None" |
|
"Primary" |
ServerProperties_CreateMode
(string
alias)
(Appears on:FlexibleServer_Spec)
Value | Description |
---|---|
"Create" |
|
"Default" |
|
"GeoRestore" |
|
"PointInTimeRestore" |
|
"Replica" |
|
"ReviveDropped" |
|
"Update" |
ServerProperties_CreateMode_STATUS
(string
alias)
(Appears on:FlexibleServer_STATUS)
Value | Description |
---|---|
"Create" |
|
"Default" |
|
"GeoRestore" |
|
"PointInTimeRestore" |
|
"Replica" |
|
"ReviveDropped" |
|
"Update" |
ServerProperties_State_STATUS
(string
alias)
(Appears on:FlexibleServer_STATUS)
Value | Description |
---|---|
"Disabled" |
|
"Dropping" |
|
"Ready" |
|
"Starting" |
|
"Stopped" |
|
"Stopping" |
|
"Updating" |
ServerVersion
(string
alias)
(Appears on:FlexibleServer_Spec)
The version of a server.
Value | Description |
---|---|
"11" |
|
"12" |
|
"13" |
|
"14" |
|
"15" |
|
"16" |
ServerVersion_STATUS
(string
alias)
(Appears on:FlexibleServer_STATUS)
The version of a server.
Value | Description |
---|---|
"11" |
|
"12" |
|
"13" |
|
"14" |
|
"15" |
|
"16" |
Sku
(Appears on:FlexibleServer_Spec)
Sku information related properties of a server.
Field | Description |
---|---|
name string |
Name: The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3. |
tier Sku_Tier |
Tier: The tier of the particular SKU, e.g. Burstable. |
Sku_STATUS
(Appears on:FlexibleServer_STATUS)
Sku information related properties of a server.
Field | Description |
---|---|
name string |
Name: The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3. |
tier Sku_Tier_STATUS |
Tier: The tier of the particular SKU, e.g. Burstable. |
Sku_Tier
(string
alias)
(Appears on:Sku)
Value | Description |
---|---|
"Burstable" |
|
"GeneralPurpose" |
|
"MemoryOptimized" |
Sku_Tier_STATUS
(string
alias)
(Appears on:Sku_STATUS)
Value | Description |
---|---|
"Burstable" |
|
"GeneralPurpose" |
|
"MemoryOptimized" |
Storage
(Appears on:FlexibleServer_Spec)
Storage properties of a server
Field | Description |
---|---|
autoGrow Storage_AutoGrow |
AutoGrow: Flag to enable / disable Storage Auto grow for flexible server. |
iops int |
Iops: Storage tier IOPS quantity. This property is required to be set for storage Type PremiumV2_LRS |
storageSizeGB int |
StorageSizeGB: Max storage allowed for a server. |
throughput int |
Throughput: Storage throughput for the server. This is required to be set for storage Type PremiumV2_LRS |
tier Storage_Tier |
Tier: Name of storage tier for IOPS. |
type Storage_Type |
Type: Storage type for the server. Allowed values are Premium_LRS and PremiumV2_LRS, and default is Premium_LRS if not specified |
Storage_AutoGrow
(string
alias)
(Appears on:Storage)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
Storage_AutoGrow_STATUS
(string
alias)
(Appears on:Storage_STATUS)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
Storage_STATUS
(Appears on:FlexibleServer_STATUS)
Storage properties of a server
Field | Description |
---|---|
autoGrow Storage_AutoGrow_STATUS |
AutoGrow: Flag to enable / disable Storage Auto grow for flexible server. |
iops int |
Iops: Storage tier IOPS quantity. This property is required to be set for storage Type PremiumV2_LRS |
storageSizeGB int |
StorageSizeGB: Max storage allowed for a server. |
throughput int |
Throughput: Storage throughput for the server. This is required to be set for storage Type PremiumV2_LRS |
tier Storage_Tier_STATUS |
Tier: Name of storage tier for IOPS. |
type Storage_Type_STATUS |
Type: Storage type for the server. Allowed values are Premium_LRS and PremiumV2_LRS, and default is Premium_LRS if not specified |
Storage_Tier
(string
alias)
(Appears on:Storage)
Value | Description |
---|---|
"P1" |
|
"P10" |
|
"P15" |
|
"P2" |
|
"P20" |
|
"P3" |
|
"P30" |
|
"P4" |
|
"P40" |
|
"P50" |
|
"P6" |
|
"P60" |
|
"P70" |
|
"P80" |
Storage_Tier_STATUS
(string
alias)
(Appears on:Storage_STATUS)
Value | Description |
---|---|
"P1" |
|
"P10" |
|
"P15" |
|
"P2" |
|
"P20" |
|
"P3" |
|
"P30" |
|
"P4" |
|
"P40" |
|
"P50" |
|
"P6" |
|
"P60" |
|
"P70" |
|
"P80" |
Storage_Type
(string
alias)
(Appears on:Storage)
Value | Description |
---|---|
"PremiumV2_LRS" |
|
"Premium_LRS" |
Storage_Type_STATUS
(string
alias)
(Appears on:Storage_STATUS)
Value | Description |
---|---|
"PremiumV2_LRS" |
|
"Premium_LRS" |
SystemData_CreatedByType_STATUS
(string
alias)
(Appears on:SystemData_STATUS)
Value | Description |
---|---|
"Application" |
|
"Key" |
|
"ManagedIdentity" |
|
"User" |
SystemData_LastModifiedByType_STATUS
(string
alias)
(Appears on:SystemData_STATUS)
Value | Description |
---|---|
"Application" |
|
"Key" |
|
"ManagedIdentity" |
|
"User" |
SystemData_STATUS
(Appears on:FlexibleServer_STATUS, FlexibleServersConfiguration_STATUS, FlexibleServersDatabase_STATUS, FlexibleServersFirewallRule_STATUS)
Metadata pertaining to creation and last modification of the resource.
Field | Description |
---|---|
createdAt string |
CreatedAt: The timestamp of resource creation (UTC). |
createdBy string |
CreatedBy: The identity that created the resource. |
createdByType SystemData_CreatedByType_STATUS |
CreatedByType: The type of identity that created the resource. |
lastModifiedAt string |
LastModifiedAt: The timestamp of resource last modification (UTC) |
lastModifiedBy string |
LastModifiedBy: The identity that last modified the resource. |
lastModifiedByType SystemData_LastModifiedByType_STATUS |
LastModifiedByType: The type of identity that last modified the resource. |
UserAssignedIdentity
(Appears on:FlexibleServer_Spec)
Information describing the identities associated with this application.
Field | Description |
---|---|
type UserAssignedIdentity_Type |
Type: the types of identities associated with this resource; currently restricted to ‘None and UserAssigned’ |
userAssignedIdentities []UserAssignedIdentityDetails |
UserAssignedIdentities: represents user assigned identities map. |
UserAssignedIdentityDetails
(Appears on:UserAssignedIdentity)
Information about the user assigned identity for the resource
Field | Description |
---|---|
reference genruntime.ResourceReference |
UserAssignedIdentity_STATUS
(Appears on:FlexibleServer_STATUS)
Information describing the identities associated with this application.
Field | Description |
---|---|
tenantId string |
TenantId: Tenant id of the server. |
type UserAssignedIdentity_Type_STATUS |
Type: the types of identities associated with this resource; currently restricted to ‘None and UserAssigned’ |
userAssignedIdentities map[string]./api/dbforpostgresql/v1api20230601preview.UserIdentity_STATUS |
UserAssignedIdentities: represents user assigned identities map. |
UserAssignedIdentity_Type
(string
alias)
(Appears on:UserAssignedIdentity)
Value | Description |
---|---|
"None" |
|
"UserAssigned" |
UserAssignedIdentity_Type_STATUS
(string
alias)
(Appears on:UserAssignedIdentity_STATUS)
Value | Description |
---|---|
"None" |
|
"UserAssigned" |
UserIdentity_STATUS
(Appears on:UserAssignedIdentity_STATUS)
Describes a single user-assigned identity associated with the application.
Field | Description |
---|---|
clientId string |
ClientId: the client identifier of the Service Principal which this identity represents. |
principalId string |
PrincipalId: the object identifier of the Service Principal which this identity represents. |