@azure/arm-mysql-flexible package

Classes

MySQLManagementFlexibleServerClient

Interfaces

AdministratorProperties	The properties of an administrator.
AdvancedThreatProtection	A server's Advanced Threat Protection.
AdvancedThreatProtectionForUpdate	Parameters allowed to update advanced threat protection for a server.
AdvancedThreatProtectionProperties	Properties of an Advanced Threat Protection setting.
AdvancedThreatProtectionSettingsGetOptionalParams	Optional parameters.
AdvancedThreatProtectionSettingsListOptionalParams	Optional parameters.
AdvancedThreatProtectionSettingsOperations	Interface representing a AdvancedThreatProtectionSettings operations.
AdvancedThreatProtectionSettingsUpdateOptionalParams	Optional parameters.
AdvancedThreatProtectionSettingsUpdatePutOptionalParams	Optional parameters.
AdvancedThreatProtectionUpdateProperties	Properties of Advanced Threat Protection that can be updated.
AzureADAdministrator	Represents a Administrator.
AzureADAdministratorsCreateOrUpdateOptionalParams	Optional parameters.
AzureADAdministratorsDeleteOptionalParams	Optional parameters.
AzureADAdministratorsGetOptionalParams	Optional parameters.
AzureADAdministratorsListByServerOptionalParams	Optional parameters.
AzureADAdministratorsOperations	Interface representing a AzureADAdministrators operations.
Backup	Storage Profile properties of a server
BackupAndExportCreateOptionalParams	Optional parameters.
BackupAndExportOperations	Interface representing a BackupAndExport operations.
BackupAndExportRequest	BackupAndExport API Request
BackupAndExportResponse	Represents BackupAndExportAPI Response
BackupAndExportResponseProperties	BackupAndExport Response Properties
BackupAndExportResponseType	BackupAndExport Response Properties
BackupAndExportValidateBackupOptionalParams	Optional parameters.
BackupRequestBase	BackupRequestBase is the base for all backup request.
BackupSettings	Backup Settings
BackupStoreDetails	Details about the target where the backup content will be stored.
BackupsGetOptionalParams	Optional parameters.
BackupsListByServerOptionalParams	Optional parameters.
BackupsOperations	Interface representing a Backups operations.
BackupsPutOptionalParams	Optional parameters.
Capability	Represents a location capability set.
CapabilityProperties	Location capabilities.
CapabilityPropertiesV2	Location capability.
CheckNameAvailabilityExecuteOptionalParams	Optional parameters.
CheckNameAvailabilityOperations	Interface representing a CheckNameAvailability operations.
CheckNameAvailabilityWithoutLocationExecuteOptionalParams	Optional parameters.
CheckNameAvailabilityWithoutLocationOperations	Interface representing a CheckNameAvailabilityWithoutLocation operations.
CheckVirtualNetworkSubnetUsageExecuteOptionalParams	Optional parameters.
CheckVirtualNetworkSubnetUsageOperations	Interface representing a CheckVirtualNetworkSubnetUsage operations.
Configuration	Represents a Configuration.
ConfigurationForBatchUpdate	Represents a Configuration.
ConfigurationForBatchUpdateProperties	The properties can be updated for a configuration.
ConfigurationListForBatchUpdate	A list of server configurations to update.
ConfigurationListResult	The response of a Configuration list operation.
ConfigurationProperties	The properties of a configuration.
ConfigurationsBatchUpdateOptionalParams	Optional parameters.
ConfigurationsCreateOrUpdateOptionalParams	Optional parameters.
ConfigurationsGetOptionalParams	Optional parameters.
ConfigurationsListByServerOptionalParams	Optional parameters.
ConfigurationsOperations	Interface representing a Configurations operations.
ConfigurationsUpdateOptionalParams	Optional parameters.
DataEncryption	The date encryption for cmk.
Database	Represents a Database.
DatabaseProperties	The properties of a database.
DatabasesCreateOrUpdateOptionalParams	Optional parameters.
DatabasesDeleteOptionalParams	Optional parameters.
DatabasesGetOptionalParams	Optional parameters.
DatabasesListByServerOptionalParams	Optional parameters.
DatabasesOperations	Interface representing a Databases operations.
DelegatedSubnetUsage	Delegated subnet usage data.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Common error response for all Azure Resource Manager APIs to return error details for failed operations.
FeatureProperty	Server version capabilities.
FirewallRule	Represents a server firewall rule.
FirewallRuleProperties	The properties of a server firewall rule.
FirewallRulesCreateOrUpdateOptionalParams	Optional parameters.
FirewallRulesDeleteOptionalParams	Optional parameters.
FirewallRulesGetOptionalParams	Optional parameters.
FirewallRulesListByServerOptionalParams	Optional parameters.
FirewallRulesOperations	Interface representing a FirewallRules operations.
FullBackupStoreDetails	FullBackupStoreDetails is used for scenarios where backup data is streamed/copied over to a storage destination.
GetPrivateDnsZoneSuffixExecuteOptionalParams	Optional parameters.
GetPrivateDnsZoneSuffixOperations	Interface representing a GetPrivateDnsZoneSuffix operations.
GetPrivateDnsZoneSuffixResponse	The response of get private dns zone suffix.
HighAvailability	High availability properties of a server
HighAvailabilityValidationEstimation	High availability validation properties of a server
ImportFromStorageResponseType	ImportFromStorage Response Properties
ImportSourceProperties	Import source related properties.
LocationBasedCapabilitiesListOptionalParams	Optional parameters.
LocationBasedCapabilitiesOperations	Interface representing a LocationBasedCapabilities operations.
LocationBasedCapabilitySetGetOptionalParams	Optional parameters.
LocationBasedCapabilitySetListOptionalParams	Optional parameters.
LocationBasedCapabilitySetOperations	Interface representing a LocationBasedCapabilitySet operations.
LogFile	Represents a logFile.
LogFileProperties	The properties of a logFile.
LogFilesListByServerOptionalParams	Optional parameters.
LogFilesOperations	Interface representing a LogFiles operations.
LongRunningBackupCreateOptionalParams	Optional parameters.
LongRunningBackupDeleteOptionalParams	Optional parameters.
LongRunningBackupOperations	Interface representing a LongRunningBackup operations.
LongRunningBackupsGetOptionalParams	Optional parameters.
LongRunningBackupsListOptionalParams	Optional parameters.
LongRunningBackupsOperations	Interface representing a LongRunningBackups operations.
Maintenance	Represents a maintenance.
MaintenancePolicy	Maintenance policy of a server.
MaintenanceProperties	The properties of a maintenance resource.
MaintenancePropertiesForUpdate	The properties of a maintenance update parameter.
MaintenanceUpdate	Represents a maintenance update parameter.
MaintenanceWindow	Maintenance window of a server.
MaintenancesListOptionalParams	Optional parameters.
MaintenancesOperations	Interface representing a Maintenances operations.
MaintenancesReadOptionalParams	Optional parameters.
MaintenancesUpdateOptionalParams	Optional parameters.
MySQLManagementFlexibleServerClientOptionalParams	Optional parameters for the client.
MySQLServerIdentity	Properties to configure Identity for Bring your Own Keys
MySQLServerSku	Billing information related properties of a server.
NameAvailability	Represents a resource name availability.
NameAvailabilityRequest	Request from client to check resource name availability.
Network	Network related properties of a server
Operation	Details of a REST API operation, returned from the Resource Provider Operations API
OperationDisplay	Display metadata associated with the operation.
OperationProgressGetOptionalParams	Optional parameters.
OperationProgressOperations	Interface representing a OperationProgress operations.
OperationProgressResponseType	Represents the response properties specific to the operation
OperationProgressResult	Represents Operation Results API Response
OperationResultsGetOptionalParams	Optional parameters.
OperationResultsOperations	Interface representing a OperationResults operations.
OperationStatusExtendedResult	Represents Operation Results API Response
OperationStatusResult	The current status of an async operation.
OperationsListOptionalParams	Optional parameters.
OperationsOperations	Interface representing a Operations operations.
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
PrivateEndpoint	The private endpoint resource.
PrivateEndpointConnection	A private endpoint connection resource
PrivateEndpointConnectionListResult	The response of a PrivateEndpointConnection list operation.
PrivateEndpointConnectionProperties	Properties of the private endpoint connection.
PrivateEndpointConnectionsCreateOrUpdateOptionalParams	Optional parameters.
PrivateEndpointConnectionsDeleteOptionalParams	Optional parameters.
PrivateEndpointConnectionsGetOptionalParams	Optional parameters.
PrivateEndpointConnectionsListByServerOptionalParams	Optional parameters.
PrivateEndpointConnectionsOperations	Interface representing a PrivateEndpointConnections operations.
PrivateLinkResource	A private link resource.
PrivateLinkResourceProperties	Properties of a private link resource.
PrivateLinkResourcesGetOptionalParams	Optional parameters.
PrivateLinkResourcesListByServerOptionalParams	Optional parameters.
PrivateLinkResourcesOperations	Interface representing a PrivateLinkResources operations.
PrivateLinkServiceConnectionState	A collection of information about the state of the connection between service consumer and provider.
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
ReplicasListByServerOptionalParams	Optional parameters.
ReplicasOperations	Interface representing a Replicas operations.
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
RestorePollerOptions
Server	Represents a server.
ServerBackup	Server backup properties
ServerBackupProperties	The properties of a server backup.
ServerBackupPropertiesV2	The properties of a server backup.
ServerBackupV2	Server backup properties
ServerDetachVNetParameter	Parameters to detach Vnet.
ServerEditionCapability	Server edition capabilities.
ServerEditionCapabilityV2	Server edition capabilities.
ServerForUpdate	Parameters allowed to update for a server.
ServerGtidSetParameter	Server Gtid set parameters: Replication with Global Transaction Identifiers.
ServerProperties	The properties of a server.
ServerPropertiesForUpdate	The properties that can be updated for a server.
ServerRestartParameter	Server restart parameters.
ServerVersionCapability	Server version capabilities.
ServerVersionCapabilityV2	Server version capabilities.
ServersCreateOptionalParams	Optional parameters.
ServersDeleteOptionalParams	Optional parameters.
ServersDetachVNetOptionalParams	Optional parameters.
ServersFailoverOptionalParams	Optional parameters.
ServersGetOptionalParams	Optional parameters.
ServersListByResourceGroupOptionalParams	Optional parameters.
ServersListOptionalParams	Optional parameters.
ServersMigrationCutoverMigrationOptionalParams	Optional parameters.
ServersMigrationOperations	Interface representing a ServersMigration operations.
ServersOperations	Interface representing a Servers operations.
ServersResetGtidOptionalParams	Optional parameters.
ServersRestartOptionalParams	Optional parameters.
ServersStartOptionalParams	Optional parameters.
ServersStopOptionalParams	Optional parameters.
ServersUpdateOptionalParams	Optional parameters.
ServersValidateEstimateHighAvailabilityOptionalParams	Optional parameters.
SimplePollerLike	A simple poller that can be used to poll a long running operation.
SkuCapability	Sku capability
SkuCapabilityV2	Sku capability
Storage	Storage Profile properties of a server
StorageEditionCapability	storage edition 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'
UserAssignedIdentity	Metadata of user assigned identity.
ValidateBackupResponse	Represents ValidateBackup API Response
ValidateBackupResponseProperties	ValidateBackup Response Properties
VirtualNetworkSubnetUsageParameter	Virtual network subnet usage parameter
VirtualNetworkSubnetUsageResult	Virtual network subnet usage data.

Type Aliases

AdministratorName	Type of AdministratorName
AdministratorType	Type of the sever administrator. KnownAdministratorType can be used interchangeably with AdministratorType, this enum contains the known values that the service supports. Known values supported by the service ActiveDirectory
AdvancedThreatProtectionName	Type of AdvancedThreatProtectionName
AdvancedThreatProtectionProvisioningState	The current provisioning state. KnownAdvancedThreatProtectionProvisioningState can be used interchangeably with AdvancedThreatProtectionProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Succeeded Updating Canceled Failed
AdvancedThreatProtectionState	Specifies the state of the Advanced Threat Protection, whether it is enabled or disabled on the server. KnownAdvancedThreatProtectionState can be used interchangeably with AdvancedThreatProtectionState, this enum contains the known values that the service supports. Known values supported by the service Enabled Disabled
AzureSupportedClouds	The supported values for cloud setting as a string literal type
BackupFormat	Backup Format for the current backup. (CollatedFormat is INTERNAL – DO NOT USE) KnownBackupFormat can be used interchangeably with BackupFormat, this enum contains the known values that the service supports. Known values supported by the service CollatedFormat Raw
BackupStoreDetailsUnion	Alias for BackupStoreDetailsUnion
BackupType	Type of BackupType
BatchOfMaintenance	The batch of maintenance when enabled the custom managed maintenance window of a server. KnownBatchOfMaintenance can be used interchangeably with BatchOfMaintenance, this enum contains the known values that the service supports. Known values supported by the service Default Batch1 Batch2
ConfigurationSource	Source of the configuration. KnownConfigurationSource can be used interchangeably with ConfigurationSource, this enum contains the known values that the service supports. Known values supported by the service system-default user-override
ContinuablePage	An interface that describes a page of results.
CreateMode	The mode to create a new MySQL server. KnownCreateMode can be used interchangeably with CreateMode, this enum contains the known values that the service supports. Known values supported by the service Default PointInTimeRestore Replica GeoRestore
CreatedByType	The kind of entity that created the resource. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User: The entity was created by a user. Application: The entity was created by an application. ManagedIdentity: The entity was created by a managed identity. Key: The entity was created by a key.
DataEncryptionType	The key type, AzureKeyVault for enable cmk, SystemManaged for disable cmk.
EnableStatusEnum	Enum to indicate whether value is 'Enabled' or 'Disabled' KnownEnableStatusEnum can be used interchangeably with EnableStatusEnum, this enum contains the known values that the service supports. Known values supported by the service Enabled Disabled
HighAvailabilityMode	High availability mode for a server. KnownHighAvailabilityMode can be used interchangeably with HighAvailabilityMode, this enum contains the known values that the service supports. Known values supported by the service Disabled ZoneRedundant SameZone
HighAvailabilityState	The state of server high availability. KnownHighAvailabilityState can be used interchangeably with HighAvailabilityState, this enum contains the known values that the service supports. Known values supported by the service NotEnabled CreatingStandby Healthy FailingOver RemovingStandby
ImportSourceStorageType	Storage type of import source. KnownImportSourceStorageType can be used interchangeably with ImportSourceStorageType, this enum contains the known values that the service supports. Known values supported by the service AzureBlob
IsConfigPendingRestart	If is the configuration pending restart or not. KnownIsConfigPendingRestart can be used interchangeably with IsConfigPendingRestart, this enum contains the known values that the service supports. Known values supported by the service True False
IsDynamicConfig	If is the configuration dynamic. KnownIsDynamicConfig can be used interchangeably with IsDynamicConfig, this enum contains the known values that the service supports. Known values supported by the service True False
IsReadOnly	If is the configuration read only. KnownIsReadOnly can be used interchangeably with IsReadOnly, this enum contains the known values that the service supports. Known values supported by the service True False
MaintenanceProvisioningState	The current provisioning state. KnownMaintenanceProvisioningState can be used interchangeably with MaintenanceProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Succeeded Creating Deleting Failed
MaintenanceState	The current status of this maintenance. KnownMaintenanceState can be used interchangeably with MaintenanceState, this enum contains the known values that the service supports. Known values supported by the service Scheduled ReScheduled InPreparation Processing Completed Canceled
MaintenanceType	The type of this maintenance. KnownMaintenanceType can be used interchangeably with MaintenanceType, this enum contains the known values that the service supports. Known values supported by the service RoutineMaintenance MinorVersionUpgrade SecurityPatches HotFixes
ManagedServiceIdentityType	Type of managed service identity. KnownManagedServiceIdentityType can be used interchangeably with ManagedServiceIdentityType, this enum contains the known values that the service supports. Known values supported by the service UserAssigned
ObjectType	Identifies the type of source operation KnownObjectType can be used interchangeably with ObjectType, this enum contains the known values that the service supports. Known values supported by the service BackupAndExportResponse ImportFromStorageResponse
OperationProgressResponseTypeUnion	Alias for OperationProgressResponseTypeUnion
OperationStatus	The operation status
Origin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports. Known values supported by the service user: Indicates the operation is initiated by a user. system: Indicates the operation is initiated by a system. user,system: Indicates the operation is initiated by a user or system.
PatchStrategy	Enum to indicate the patch strategy of a server KnownPatchStrategy can be used interchangeably with PatchStrategy, this enum contains the known values that the service supports. Known values supported by the service Regular VirtualCanary
PrivateEndpointConnectionProvisioningState	The current provisioning state. KnownPrivateEndpointConnectionProvisioningState can be used interchangeably with PrivateEndpointConnectionProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Succeeded: Connection has been provisioned Creating: Connection is being created Deleting: Connection is being deleted Failed: Connection provisioning has failed
PrivateEndpointServiceConnectionStatus	The private endpoint connection status. KnownPrivateEndpointServiceConnectionStatus can be used interchangeably with PrivateEndpointServiceConnectionStatus, this enum contains the known values that the service supports. Known values supported by the service Pending: Connection waiting for approval or rejection Approved: Connection approved Rejected: Connection Rejected
ProvisioningState	The current provisioning state. KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Succeeded Creating Deleting Failed Canceled
ReplicationMode	The replication Mode KnownReplicationMode can be used interchangeably with ReplicationMode, this enum contains the known values that the service supports. Known values supported by the service BinaryLog: Binary log replication RedoLog: Redo log replication
ReplicationRole	The replication role. KnownReplicationRole can be used interchangeably with ReplicationRole, this enum contains the known values that the service supports. Known values supported by the service None Source Replica
ResetAllToDefault	Whether to reset all server parameters to default. KnownResetAllToDefault can be used interchangeably with ResetAllToDefault, this enum contains the known values that the service supports. Known values supported by the service True False
ServerSkuTier	The tier of the particular SKU, e.g. GeneralPurpose. KnownServerSkuTier can be used interchangeably with ServerSkuTier, this enum contains the known values that the service supports. Known values supported by the service Burstable GeneralPurpose MemoryOptimized
ServerState	The state of a server. KnownServerState can be used interchangeably with ServerState, this enum contains the known values that the service supports. Known values supported by the service Ready Dropping Disabled Starting Stopping Stopped Updating
ServerVersion	The major version of a server. 8.0.21 stands for MySQL 8.0, 5.7.44 stands for MySQL 5.7 KnownServerVersion can be used interchangeably with ServerVersion, this enum contains the known values that the service supports. Known values supported by the service 5.7 8.0.21 8.4
StorageRedundancyEnum	Enum to indicate whether storage sku value is 'ZoneRedundancy' or 'LocalRedundancy' KnownStorageRedundancyEnum can be used interchangeably with StorageRedundancyEnum, this enum contains the known values that the service supports. Known values supported by the service LocalRedundancy ZoneRedundancy

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownAdministratorName	Known values of AdministratorName that the service accepts.
KnownAdministratorType	Type of the sever administrator.
KnownAdvancedThreatProtectionName	Known values of AdvancedThreatProtectionName that the service accepts.
KnownAdvancedThreatProtectionProvisioningState	The current provisioning state.
KnownAdvancedThreatProtectionState	Specifies the state of the Advanced Threat Protection, whether it is enabled or disabled on the server.
KnownBackupFormat	Backup Format for the current backup. (CollatedFormat is INTERNAL – DO NOT USE)
KnownBackupType	Known values of BackupType that the service accepts.
KnownBatchOfMaintenance	The batch of maintenance when enabled the custom managed maintenance window of a server.
KnownConfigurationSource	Source of the configuration.
KnownCreateMode	The mode to create a new MySQL server.
KnownCreatedByType	The kind of entity that created the resource.
KnownEnableStatusEnum	Enum to indicate whether value is 'Enabled' or 'Disabled'
KnownHighAvailabilityMode	High availability mode for a server.
KnownHighAvailabilityState	The state of server high availability.
KnownImportSourceStorageType	Storage type of import source.
KnownIsConfigPendingRestart	If is the configuration pending restart or not.
KnownIsDynamicConfig	If is the configuration dynamic.
KnownIsReadOnly	If is the configuration read only.
KnownMaintenanceProvisioningState	The current provisioning state.
KnownMaintenanceState	The current status of this maintenance.
KnownMaintenanceType	The type of this maintenance.
KnownManagedServiceIdentityType	Type of managed service identity.
KnownObjectType	Identifies the type of source operation
KnownOrigin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
KnownPatchStrategy	Enum to indicate the patch strategy of a server
KnownPrivateEndpointConnectionProvisioningState	The current provisioning state.
KnownPrivateEndpointServiceConnectionStatus	The private endpoint connection status.
KnownProvisioningState	The current provisioning state.
KnownReplicationMode	The replication Mode
KnownReplicationRole	The replication role.
KnownResetAllToDefault	Whether to reset all server parameters to default.
KnownServerSkuTier	The tier of the particular SKU, e.g. GeneralPurpose.
KnownServerState	The state of a server.
KnownServerVersion	The major version of a server. 8.0.21 stands for MySQL 8.0, 5.7.44 stands for MySQL 5.7
KnownStorageRedundancyEnum	Enum to indicate whether storage sku value is 'ZoneRedundancy' or 'LocalRedundancy'
KnownVersions	The available API versions.

Functions

isRestError(unknown)	Typeguard for RestError
restorePoller<TResponse, TResult>(MySQLManagementFlexibleServerClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)	Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

Variables

RestError

A custom error type for failed pipeline requests.

Function Details

isRestError(unknown)

Typeguard for RestError

function isRestError(e: unknown): e

Parameters

e

unknown

Something caught by a catch clause.

Returns

e

restorePoller<TResponse, TResult>(MySQLManagementFlexibleServerClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

function restorePoller<TResponse, TResult>(client: MySQLManagementFlexibleServerClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

client

MySQLManagementFlexibleServerClient

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>

Variable Details

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type

RestErrorConstructor