@azure/arm-mysql-flexible package
Interfaces
| AdministratorListResult |
A List of azure ad administrators. |
| AdvancedThreatProtection |
A server's Advanced Threat Protection. |
| AdvancedThreatProtectionForUpdate |
Parameters allowed to update advanced threat protection for a server. |
| AdvancedThreatProtectionListResult |
A list of the server's Advanced Threat Protection configurations. |
| AdvancedThreatProtectionSettings |
Interface representing a AdvancedThreatProtectionSettings. |
| AdvancedThreatProtectionSettingsGetOptionalParams |
Optional parameters. |
| AdvancedThreatProtectionSettingsListNextOptionalParams |
Optional parameters. |
| AdvancedThreatProtectionSettingsListOptionalParams |
Optional parameters. |
| AdvancedThreatProtectionSettingsUpdateHeaders |
Defines headers for AdvancedThreatProtectionSettings_update operation. |
| AdvancedThreatProtectionSettingsUpdateOptionalParams |
Optional parameters. |
| AdvancedThreatProtectionSettingsUpdatePutHeaders |
Defines headers for AdvancedThreatProtectionSettings_updatePut operation. |
| AdvancedThreatProtectionSettingsUpdatePutOptionalParams |
Optional parameters. |
| AzureADAdministrator |
Represents a Administrator. |
| AzureADAdministrators |
Interface representing a AzureADAdministrators. |
| AzureADAdministratorsCreateOrUpdateOptionalParams |
Optional parameters. |
| AzureADAdministratorsDeleteOptionalParams |
Optional parameters. |
| AzureADAdministratorsGetOptionalParams |
Optional parameters. |
| AzureADAdministratorsListByServerNextOptionalParams |
Optional parameters. |
| AzureADAdministratorsListByServerOptionalParams |
Optional parameters. |
| Backup |
Storage Profile properties of a server |
| BackupAndExport |
Interface representing a BackupAndExport. |
| BackupAndExportCreateHeaders |
Defines headers for BackupAndExport_create operation. |
| BackupAndExportCreateOptionalParams |
Optional parameters. |
| BackupAndExportRequest |
BackupAndExport API Request |
| BackupAndExportResponse |
Represents BackupAndExport API Response |
| 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. |
| Backups |
Interface representing a Backups. |
| BackupsGetOptionalParams |
Optional parameters. |
| BackupsListByServerNextOptionalParams |
Optional parameters. |
| BackupsListByServerOptionalParams |
Optional parameters. |
| BackupsPutOptionalParams |
Optional parameters. |
| CapabilitiesListResult |
location capability |
| Capability |
Represents a location capability set. |
| CapabilityProperties |
Location capabilities. |
| CapabilitySetsList |
location capability set |
| CheckNameAvailability |
Interface representing a CheckNameAvailability. |
| CheckNameAvailabilityExecuteOptionalParams |
Optional parameters. |
| CheckNameAvailabilityWithoutLocation |
Interface representing a CheckNameAvailabilityWithoutLocation. |
| CheckNameAvailabilityWithoutLocationExecuteOptionalParams |
Optional parameters. |
| CheckVirtualNetworkSubnetUsage |
Interface representing a CheckVirtualNetworkSubnetUsage. |
| CheckVirtualNetworkSubnetUsageExecuteOptionalParams |
Optional parameters. |
| Configuration |
Represents a Configuration. |
| ConfigurationForBatchUpdate |
Represents a Configuration. |
| ConfigurationListForBatchUpdate |
A list of server configurations to update. |
| ConfigurationListResult |
A list of server configurations. |
| Configurations |
Interface representing a Configurations. |
| ConfigurationsBatchUpdateOptionalParams |
Optional parameters. |
| ConfigurationsCreateOrUpdateHeaders |
Defines headers for Configurations_createOrUpdate operation. |
| ConfigurationsCreateOrUpdateOptionalParams |
Optional parameters. |
| ConfigurationsGetOptionalParams |
Optional parameters. |
| ConfigurationsListByServerNextOptionalParams |
Optional parameters. |
| ConfigurationsListByServerOptionalParams |
Optional parameters. |
| ConfigurationsUpdateOptionalParams |
Optional parameters. |
| DataEncryption |
The date encryption for cmk. |
| Database |
Represents a Database. |
| DatabaseListResult |
A List of databases. |
| Databases |
Interface representing a Databases. |
| DatabasesCreateOrUpdateOptionalParams |
Optional parameters. |
| DatabasesDeleteOptionalParams |
Optional parameters. |
| DatabasesGetOptionalParams |
Optional parameters. |
| DatabasesListByServerNextOptionalParams |
Optional parameters. |
| DatabasesListByServerOptionalParams |
Optional parameters. |
| 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. (This also follows the OData error response format.). |
| FirewallRule |
Represents a server firewall rule. |
| FirewallRuleListResult |
A list of firewall rules. |
| FirewallRules |
Interface representing a FirewallRules. |
| FirewallRulesCreateOrUpdateOptionalParams |
Optional parameters. |
| FirewallRulesDeleteOptionalParams |
Optional parameters. |
| FirewallRulesGetOptionalParams |
Optional parameters. |
| FirewallRulesListByServerNextOptionalParams |
Optional parameters. |
| FirewallRulesListByServerOptionalParams |
Optional parameters. |
| FullBackupStoreDetails |
FullBackupStoreDetails is used for scenarios where backup data is streamed/copied over to a storage destination. |
| GetPrivateDnsZoneSuffix |
Interface representing a GetPrivateDnsZoneSuffix. |
| GetPrivateDnsZoneSuffixExecuteOptionalParams |
Optional parameters. |
| 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. |
| LocationBasedCapabilities |
Interface representing a LocationBasedCapabilities. |
| LocationBasedCapabilitiesListNextOptionalParams |
Optional parameters. |
| LocationBasedCapabilitiesListOptionalParams |
Optional parameters. |
| LocationBasedCapabilitySet |
Interface representing a LocationBasedCapabilitySet. |
| LocationBasedCapabilitySetGetOptionalParams |
Optional parameters. |
| LocationBasedCapabilitySetListNextOptionalParams |
Optional parameters. |
| LocationBasedCapabilitySetListOptionalParams |
Optional parameters. |
| LogFile |
Represents a logFile. |
| LogFileListResult |
A List of logFiles. |
| LogFiles |
Interface representing a LogFiles. |
| LogFilesListByServerNextOptionalParams |
Optional parameters. |
| LogFilesListByServerOptionalParams |
Optional parameters. |
| LongRunningBackup |
Interface representing a LongRunningBackup. |
| LongRunningBackupCreateHeaders |
Defines headers for LongRunningBackup_create operation. |
| LongRunningBackupCreateOptionalParams |
Optional parameters. |
| LongRunningBackups |
Interface representing a LongRunningBackups. |
| LongRunningBackupsGetOptionalParams |
Optional parameters. |
| LongRunningBackupsListNextOptionalParams |
Optional parameters. |
| LongRunningBackupsListOptionalParams |
Optional parameters. |
| Maintenance |
Represents a maintenance. |
| MaintenanceListResult |
A list of maintenances. |
| MaintenanceUpdate |
Represents a maintenance update parameter. |
| MaintenanceWindow |
Maintenance window of a server. |
| Maintenances |
Interface representing a Maintenances. |
| MaintenancesListNextOptionalParams |
Optional parameters. |
| MaintenancesListOptionalParams |
Optional parameters. |
| MaintenancesReadOptionalParams |
Optional parameters. |
| MaintenancesUpdateHeaders |
Defines headers for Maintenances_update operation. |
| MaintenancesUpdateOptionalParams |
Optional parameters. |
| MySQLManagementFlexibleServerClientOptionalParams |
Optional parameters. |
| 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 |
REST API operation definition. |
| OperationDisplay |
Display metadata associated with the operation. |
| OperationListResult |
A list of resource provider operations. |
| OperationProgress |
Interface representing a OperationProgress. |
| OperationProgressGetOptionalParams |
Optional parameters. |
| OperationProgressResponseType |
Represents the response properties specific to the operation |
| OperationProgressResult |
Represents Operation Results API Response |
| OperationResults |
Interface representing a OperationResults. |
| OperationResultsGetOptionalParams |
Optional parameters. |
| OperationStatusExtendedResult |
Represents Operation Results API Response |
| OperationStatusResult |
The current status of an async operation. |
| Operations |
Interface representing a Operations. |
| OperationsListNextOptionalParams |
Optional parameters. |
| OperationsListOptionalParams |
Optional parameters. |
| PrivateEndpoint |
The private endpoint resource. |
| PrivateEndpointConnection |
The private endpoint connection resource. |
| PrivateLinkServiceConnectionState |
A collection of information about the state of the connection between service consumer and provider. |
| Provisioning |
Server backup properties |
| ProxyResource |
The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location |
| Replicas |
Interface representing a Replicas. |
| ReplicasListByServerNextOptionalParams |
Optional parameters. |
| ReplicasListByServerOptionalParams |
Optional parameters. |
| Resource |
Common fields that are returned in the response for all Azure Resource Manager resources |
| Server |
Represents a server. |
| ServerBackup |
Server backup properties |
| ServerBackupListResult |
A list of server backups. |
| ServerBackupV2 |
Server backup properties |
| ServerBackupV2ListResult |
A list of server backups. |
| ServerEditionCapability |
Server edition capabilities. |
| ServerEditionCapabilityV2 |
Server edition capabilities. |
| ServerForUpdate |
Parameters allowed to update for a server. |
| ServerGtidSetParameter |
Server Gtid set parameters. |
| ServerListResult |
A list of servers. |
| ServerRestartParameter |
Server restart parameters. |
| ServerVersionCapability |
Server version capabilities. |
| ServerVersionCapabilityV2 |
Server version capabilities. |
| Servers |
Interface representing a Servers. |
| ServersCreateHeaders |
Defines headers for Servers_create operation. |
| ServersCreateOptionalParams |
Optional parameters. |
| ServersDeleteHeaders |
Defines headers for Servers_delete operation. |
| ServersDeleteOptionalParams |
Optional parameters. |
| ServersFailoverHeaders |
Defines headers for Servers_failover operation. |
| ServersFailoverOptionalParams |
Optional parameters. |
| ServersGetOptionalParams |
Optional parameters. |
| ServersListByResourceGroupNextOptionalParams |
Optional parameters. |
| ServersListByResourceGroupOptionalParams |
Optional parameters. |
| ServersListNextOptionalParams |
Optional parameters. |
| ServersListOptionalParams |
Optional parameters. |
| ServersMigration |
Interface representing a ServersMigration. |
| ServersMigrationCutoverMigrationHeaders |
Defines headers for ServersMigration_cutoverMigration operation. |
| ServersMigrationCutoverMigrationOptionalParams |
Optional parameters. |
| ServersResetGtidHeaders |
Defines headers for Servers_resetGtid operation. |
| ServersResetGtidOptionalParams |
Optional parameters. |
| ServersRestartHeaders |
Defines headers for Servers_restart operation. |
| ServersRestartOptionalParams |
Optional parameters. |
| ServersStartHeaders |
Defines headers for Servers_start operation. |
| ServersStartOptionalParams |
Optional parameters. |
| ServersStopHeaders |
Defines headers for Servers_stop operation. |
| ServersStopOptionalParams |
Optional parameters. |
| ServersUpdateHeaders |
Defines headers for Servers_update operation. |
| ServersUpdateOptionalParams |
Optional parameters. |
| ServersValidateEstimateHighAvailabilityOptionalParams |
Optional parameters. |
| 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 |
| VirtualNetworkSubnetUsageParameter |
Virtual network subnet usage parameter |
| VirtualNetworkSubnetUsageResult |
Virtual network subnet usage data. |
Type Aliases
| AdministratorName |
Defines values for AdministratorName. Known values supported by the serviceActiveDirectory |
| AdministratorType |
Defines values for AdministratorType. Known values supported by the serviceActiveDirectory |
| AdvancedThreatProtectionName |
Defines values for AdvancedThreatProtectionName. Known values supported by the serviceDefault |
| AdvancedThreatProtectionProvisioningState |
Defines values for AdvancedThreatProtectionProvisioningState. Known values supported by the serviceSucceeded |
| AdvancedThreatProtectionSettingsGetResponse |
Contains response data for the get operation. |
| AdvancedThreatProtectionSettingsListNextResponse |
Contains response data for the listNext operation. |
| AdvancedThreatProtectionSettingsListResponse |
Contains response data for the list operation. |
| AdvancedThreatProtectionSettingsUpdatePutResponse |
Contains response data for the updatePut operation. |
| AdvancedThreatProtectionSettingsUpdateResponse |
Contains response data for the update operation. |
| AdvancedThreatProtectionState |
Defines values for AdvancedThreatProtectionState. Known values supported by the serviceEnabled |
| AzureADAdministratorsCreateOrUpdateResponse |
Contains response data for the createOrUpdate operation. |
| AzureADAdministratorsGetResponse |
Contains response data for the get operation. |
| AzureADAdministratorsListByServerNextResponse |
Contains response data for the listByServerNext operation. |
| AzureADAdministratorsListByServerResponse |
Contains response data for the listByServer operation. |
| BackupAndExportCreateResponse |
Contains response data for the create operation. |
| BackupAndExportValidateBackupResponse |
Contains response data for the validateBackup operation. |
| BackupFormat |
Defines values for BackupFormat. Known values supported by the serviceCollatedFormat |
| BackupStoreDetailsUnion | |
| BackupType |
Defines values for BackupType. Known values supported by the serviceFULL |
| BackupsGetResponse |
Contains response data for the get operation. |
| BackupsListByServerNextResponse |
Contains response data for the listByServerNext operation. |
| BackupsListByServerResponse |
Contains response data for the listByServer operation. |
| BackupsPutResponse |
Contains response data for the put operation. |
| CheckNameAvailabilityExecuteResponse |
Contains response data for the execute operation. |
| CheckNameAvailabilityWithoutLocationExecuteResponse |
Contains response data for the execute operation. |
| CheckVirtualNetworkSubnetUsageExecuteResponse |
Contains response data for the execute operation. |
| ConfigurationSource |
Defines values for ConfigurationSource. Known values supported by the servicesystem-default |
| ConfigurationsBatchUpdateResponse |
Contains response data for the batchUpdate operation. |
| ConfigurationsCreateOrUpdateResponse |
Contains response data for the createOrUpdate operation. |
| ConfigurationsGetResponse |
Contains response data for the get operation. |
| ConfigurationsListByServerNextResponse |
Contains response data for the listByServerNext operation. |
| ConfigurationsListByServerResponse |
Contains response data for the listByServer operation. |
| ConfigurationsUpdateResponse |
Contains response data for the update operation. |
| CreateMode |
Defines values for CreateMode. Known values supported by the serviceDefault |
| CreatedByType |
Defines values for CreatedByType. Known values supported by the serviceUser |
| DataEncryptionType |
Defines values for DataEncryptionType. |
| DatabasesCreateOrUpdateResponse |
Contains response data for the createOrUpdate operation. |
| DatabasesGetResponse |
Contains response data for the get operation. |
| DatabasesListByServerNextResponse |
Contains response data for the listByServerNext operation. |
| DatabasesListByServerResponse |
Contains response data for the listByServer operation. |
| EnableStatusEnum |
Defines values for EnableStatusEnum. Known values supported by the serviceEnabled |
| FirewallRulesCreateOrUpdateResponse |
Contains response data for the createOrUpdate operation. |
| FirewallRulesGetResponse |
Contains response data for the get operation. |
| FirewallRulesListByServerNextResponse |
Contains response data for the listByServerNext operation. |
| FirewallRulesListByServerResponse |
Contains response data for the listByServer operation. |
| GetPrivateDnsZoneSuffixExecuteResponse |
Contains response data for the execute operation. |
| HighAvailabilityMode |
Defines values for HighAvailabilityMode. Known values supported by the serviceDisabled |
| HighAvailabilityState |
Defines values for HighAvailabilityState. Known values supported by the serviceNotEnabled |
| ImportSourceStorageType |
Defines values for ImportSourceStorageType. Known values supported by the serviceAzureBlob |
| IsConfigPendingRestart |
Defines values for IsConfigPendingRestart. Known values supported by the serviceTrue |
| IsDynamicConfig |
Defines values for IsDynamicConfig. Known values supported by the serviceTrue |
| IsReadOnly |
Defines values for IsReadOnly. Known values supported by the serviceTrue |
| LocationBasedCapabilitiesListNextResponse |
Contains response data for the listNext operation. |
| LocationBasedCapabilitiesListResponse |
Contains response data for the list operation. |
| LocationBasedCapabilitySetGetResponse |
Contains response data for the get operation. |
| LocationBasedCapabilitySetListNextResponse |
Contains response data for the listNext operation. |
| LocationBasedCapabilitySetListResponse |
Contains response data for the list operation. |
| LogFilesListByServerNextResponse |
Contains response data for the listByServerNext operation. |
| LogFilesListByServerResponse |
Contains response data for the listByServer operation. |
| LongRunningBackupCreateResponse |
Contains response data for the create operation. |
| LongRunningBackupsGetResponse |
Contains response data for the get operation. |
| LongRunningBackupsListNextResponse |
Contains response data for the listNext operation. |
| LongRunningBackupsListResponse |
Contains response data for the list operation. |
| MaintenanceProvisioningState |
Defines values for MaintenanceProvisioningState. Known values supported by the serviceSucceeded |
| MaintenanceState |
Defines values for MaintenanceState. Known values supported by the serviceScheduled |
| MaintenanceType |
Defines values for MaintenanceType. Known values supported by the serviceRoutineMaintenance |
| MaintenancesListNextResponse |
Contains response data for the listNext operation. |
| MaintenancesListResponse |
Contains response data for the list operation. |
| MaintenancesReadResponse |
Contains response data for the read operation. |
| MaintenancesUpdateResponse |
Contains response data for the update operation. |
| ManagedServiceIdentityType |
Defines values for ManagedServiceIdentityType. Known values supported by the serviceUserAssigned |
| ObjectType |
Defines values for ObjectType. Known values supported by the serviceBackupAndExportResponse |
| OperationProgressGetResponse |
Contains response data for the get operation. |
| OperationProgressResponseTypeUnion | |
| OperationResultsGetResponse |
Contains response data for the get operation. |
| OperationStatus |
Defines values for OperationStatus. |
| OperationsListNextResponse |
Contains response data for the listNext operation. |
| OperationsListResponse |
Contains response data for the list operation. |
| PrivateEndpointConnectionProvisioningState |
Defines values for PrivateEndpointConnectionProvisioningState. Known values supported by the serviceSucceeded |
| PrivateEndpointServiceConnectionStatus |
Defines values for PrivateEndpointServiceConnectionStatus. Known values supported by the servicePending |
| ProvisioningState |
Defines values for ProvisioningState. Known values supported by the serviceSucceeded |
| ReplicasListByServerNextResponse |
Contains response data for the listByServerNext operation. |
| ReplicasListByServerResponse |
Contains response data for the listByServer operation. |
| ReplicationRole |
Defines values for ReplicationRole. Known values supported by the serviceNone |
| ResetAllToDefault |
Defines values for ResetAllToDefault. Known values supported by the serviceTrue |
| ServerSkuTier |
Defines values for ServerSkuTier. Known values supported by the serviceBurstable |
| ServerState |
Defines values for ServerState. Known values supported by the serviceReady |
| ServerVersion |
Defines values for ServerVersion. Known values supported by the service5.7 |
| ServersCreateResponse |
Contains response data for the create operation. |
| ServersGetResponse |
Contains response data for the get operation. |
| ServersListByResourceGroupNextResponse |
Contains response data for the listByResourceGroupNext operation. |
| ServersListByResourceGroupResponse |
Contains response data for the listByResourceGroup operation. |
| ServersListNextResponse |
Contains response data for the listNext operation. |
| ServersListResponse |
Contains response data for the list operation. |
| ServersMigrationCutoverMigrationResponse |
Contains response data for the cutoverMigration operation. |
| ServersUpdateResponse |
Contains response data for the update operation. |
| ServersValidateEstimateHighAvailabilityResponse |
Contains response data for the validateEstimateHighAvailability operation. |
Enums
| KnownAdministratorName |
Known values of AdministratorName that the service accepts. |
| KnownAdministratorType |
Known values of AdministratorType that the service accepts. |
| KnownAdvancedThreatProtectionName |
Known values of AdvancedThreatProtectionName that the service accepts. |
| KnownAdvancedThreatProtectionProvisioningState |
Known values of AdvancedThreatProtectionProvisioningState that the service accepts. |
| KnownAdvancedThreatProtectionState |
Known values of AdvancedThreatProtectionState that the service accepts. |
| KnownBackupFormat |
Known values of BackupFormat that the service accepts. |
| KnownBackupType |
Known values of BackupType that the service accepts. |
| KnownConfigurationSource |
Known values of ConfigurationSource that the service accepts. |
| KnownCreateMode |
Known values of CreateMode that the service accepts. |
| KnownCreatedByType |
Known values of CreatedByType that the service accepts. |
| KnownEnableStatusEnum |
Known values of EnableStatusEnum that the service accepts. |
| KnownHighAvailabilityMode |
Known values of HighAvailabilityMode that the service accepts. |
| KnownHighAvailabilityState |
Known values of HighAvailabilityState that the service accepts. |
| KnownImportSourceStorageType |
Known values of ImportSourceStorageType that the service accepts. |
| KnownIsConfigPendingRestart |
Known values of IsConfigPendingRestart that the service accepts. |
| KnownIsDynamicConfig |
Known values of IsDynamicConfig that the service accepts. |
| KnownIsReadOnly |
Known values of IsReadOnly that the service accepts. |
| KnownMaintenanceProvisioningState |
Known values of MaintenanceProvisioningState that the service accepts. |
| KnownMaintenanceState |
Known values of MaintenanceState that the service accepts. |
| KnownMaintenanceType |
Known values of MaintenanceType that the service accepts. |
| KnownManagedServiceIdentityType |
Known values of ManagedServiceIdentityType that the service accepts. |
| KnownObjectType |
Known values of ObjectType that the service accepts. |
| KnownPrivateEndpointConnectionProvisioningState |
Known values of PrivateEndpointConnectionProvisioningState that the service accepts. |
| KnownPrivateEndpointServiceConnectionStatus |
Known values of PrivateEndpointServiceConnectionStatus that the service accepts. |
| KnownProvisioningState |
Known values of ProvisioningState that the service accepts. |
| KnownReplicationRole |
Known values of ReplicationRole that the service accepts. |
| KnownResetAllToDefault |
Known values of ResetAllToDefault that the service accepts. |
| KnownServerSkuTier |
Known values of ServerSkuTier that the service accepts. |
| KnownServerState |
Known values of ServerState that the service accepts. |
| KnownServerVersion |
Known values of ServerVersion that the service accepts. |
Functions
| get |
Given the last |
Function Details
getContinuationToken(unknown)
Given the last .value produced by the byPage iterator,
returns a continuation token that can be used to begin paging from
that point later.
function getContinuationToken(page: unknown): string | undefined
Parameters
- page
-
unknown
An object from accessing value on the IteratorResult from a byPage iterator.
Returns
string | undefined
The continuation token that can be passed into byPage() during future calls.