@azure/arm-sql package
Classes
| SqlManagementClient |
Interfaces
Type Aliases
| AdministratorName |
Type of AdministratorName |
| AdministratorType |
Type of the sever administrator. Known values supported by the serviceActiveDirectory: ActiveDirectory |
| AdvancedThreatProtectionName |
Type of AdvancedThreatProtectionName |
| AdvancedThreatProtectionState |
Specifies the state of the Advanced Threat Protection, whether it is enabled or disabled or a state has not been applied yet on the specific database or server. |
| AdvisorStatus |
Gets the status of availability of this advisor to customers. Possible values are 'GA', 'PublicPreview', 'LimitedPublicPreview' and 'PrivatePreview'. |
| AggregationFunctionType |
Type of AggregationFunctionType |
| AlwaysEncryptedEnclaveType |
Type of enclave requested on the database i.e. Default or VBS enclaves. Known values supported by the serviceDefault: Default |
| AuthMetadataLookupModes |
The managed instance's authentication metadata lookup mode. Known values supported by the serviceAzureAD: AzureAD |
| AuthenticationName |
Type of AuthenticationName |
| AutoExecuteStatus |
Gets the auto-execute status (whether to let the system execute the recommendations) of this advisor. Possible values are 'Enabled' and 'Disabled' |
| AutoExecuteStatusInheritedFrom |
Gets the resource from which current value of auto-execute status is inherited. Auto-execute status can be set on (and inherited from) different levels in the resource hierarchy. Possible values are 'Subscription', 'Server', 'ElasticPool', 'Database' and 'Default' (when status is not explicitly set on any level). |
| AutomaticTuningDisabledReason |
Reason description if desired and actual state are different. |
| AutomaticTuningMode |
Automatic tuning desired state. |
| AutomaticTuningOptionModeActual |
Automatic tuning option actual state. |
| AutomaticTuningOptionModeDesired |
Automatic tuning option desired state. |
| AutomaticTuningServerMode |
Automatic tuning desired state. |
| AutomaticTuningServerReason |
Reason description if desired and actual state are different. |
| AvailabilityZoneType |
Specifies the availability zone the database is pinned to. Known values supported by the serviceNoPreference: NoPreference |
| AzureSupportedClouds |
The supported values for cloud setting as a string literal type |
| BackupStorageAccessTier |
The BackupStorageAccessTier for the LTR backup Known values supported by the serviceHot: Hot |
| BackupStorageRedundancy |
The storage account type used to store backups for this database. Known values supported by the serviceGeo: Geo |
| BaselineName |
Type of BaselineName |
| BlobAuditingPolicyState |
Specifies the state of the audit. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. |
| CapabilityGroup |
Type of CapabilityGroup |
| CapabilityStatus |
The status of the capability. |
| CatalogCollationType |
Collation of the metadata catalog. Known values supported by the serviceDATABASE_DEFAULT: DATABASE_DEFAULT |
| CheckNameAvailabilityReason |
The reason code explaining why the name is unavailable. Will be undefined if the name is available. |
| CheckNameAvailabilityResourceType |
Type of CheckNameAvailabilityResourceType |
| ClientClassificationSource |
Type of ClientClassificationSource |
| ColumnDataType |
The column data type. Known values supported by the serviceimage: image |
| ConnectionPolicyName |
Type of ConnectionPolicyName |
| ContinuablePage |
An interface that describes a page of results. |
| CreateMode |
Specifies the mode of database creation. Default: regular database creation. Copy: creates a database as a copy of an existing database. sourceDatabaseId must be specified as the resource ID of the source database. Secondary: creates a database as a secondary replica of an existing database. sourceDatabaseId must be specified as the resource ID of the existing primary database. PointInTimeRestore: Creates a database by restoring a point in time backup of an existing database. sourceDatabaseId must be specified as the resource ID of the existing database, and restorePointInTime must be specified. Recovery: Creates a database by restoring a geo-replicated backup. sourceDatabaseId must be specified as the recoverable database resource ID to restore. Restore: Creates a database by restoring a backup of a deleted database. sourceDatabaseId must be specified. If sourceDatabaseId is the database's original resource ID, then sourceDatabaseDeletionDate must be specified. Otherwise sourceDatabaseId must be the restorable dropped database resource ID and sourceDatabaseDeletionDate is ignored. restorePointInTime may also be specified to restore from an earlier point in time. RestoreLongTermRetentionBackup: Creates a database by restoring from a long term retention vault. recoveryServicesRecoveryPointResourceId must be specified as the recovery point resource ID. Copy, Secondary, and RestoreLongTermRetentionBackup are not supported for DataWarehouse edition. Known values supported by the serviceDefault: Default |
| CreatedByType |
The kind of entity that created the resource. Known values supported by the serviceUser: The entity was created by a user. |
| DNSRefreshOperationStatus |
The status of the DNS refresh operation. Known values supported by the serviceSucceeded: Succeeded |
| DataMaskingFunction |
The masking function that is used for the data masking rule. |
| DataMaskingRuleState |
The rule state. Used to delete a rule. To delete an existing rule, specify the schemaName, tableName, columnName, maskingFunction, and specify ruleState as disabled. However, if the rule doesn't already exist, the rule will be created with ruleState set to enabled, regardless of the provided value of ruleState. |
| DataMaskingState |
The state of the data masking policy. |
| DataWarehouseUserActivityName |
Type of DataWarehouseUserActivityName |
| DatabaseIdentityType |
The identity type Known values supported by the serviceNone: None |
| DatabaseKeyType |
The database key type. Only supported value is 'AzureKeyVault'. Known values supported by the serviceAzureKeyVault: AzureKeyVault |
| DatabaseLicenseType |
The license type to apply for this database. Known values supported by the serviceLicenseIncluded: LicenseIncluded |
| DatabaseReadScale |
The state of read-only routing. If enabled, connections that have application intent set to readonly in their connection string may be routed to a readonly secondary replica in the same region. Not applicable to a Hyperscale database within an elastic pool. Known values supported by the serviceEnabled: Enabled |
| DatabaseState |
Type of DatabaseState |
| DatabaseStatus |
The status of the database. Known values supported by the serviceOnline: Online |
| DayOfWeek |
Day of maintenance window. Known values supported by the serviceSunday: Sunday |
| DevOpsAuditingSettingsName |
Type of DevOpsAuditingSettingsName |
| DiffBackupIntervalInHours |
The differential backup interval in hours. This is how many interval hours between each differential backup will be supported. This is only applicable to live databases but not dropped databases. Known values supported by the service12: 12 |
| DtcName |
Type of DtcName |
| ElasticPoolLicenseType |
The license type to apply for this elastic pool. Known values supported by the serviceLicenseIncluded: LicenseIncluded |
| ElasticPoolState |
The state of the elastic pool. Known values supported by the serviceCreating: Creating |
| EncryptionProtectorName |
Type of EncryptionProtectorName |
| ErrorType |
Error type (e.g. None, User). Known values supported by the serviceNone: None |
| ExternalGovernanceStatus |
Status of external governance. Known values supported by the serviceEnabled: Enabled |
| FailoverGroupDatabasesSecondaryType |
Databases secondary type on partner server. Known values supported by the serviceGeo: Geo |
| FailoverGroupReplicationRole |
Local replication role of the failover group instance. Known values supported by the servicePrimary: Primary |
| FailoverModeType |
The link failover mode - can be Manual if intended to be used for two-way failover with a supported SQL Server, or None for one-way failover to Azure. Known values supported by the serviceNone: None |
| FailoverType |
The failover type, can be ForcedAllowDataLoss or Planned. Known values supported by the serviceForcedAllowDataLoss: ForcedAllowDataLoss |
| FreeLimitExhaustionBehavior |
Specifies the behavior when monthly free limits are exhausted for the free database. AutoPause: The database will be auto paused upon exhaustion of free limits for remainder of the month. BillForUsage: The database will continue to be online upon exhaustion of free limits and any overage will be billed. Known values supported by the serviceAutoPause: AutoPause |
| GeoBackupPolicyName |
Type of GeoBackupPolicyName |
| GeoBackupPolicyState |
The state of the geo backup policy. |
| HybridSecondaryUsage |
Hybrid secondary usage. Possible values are 'Active' (default value) and 'Passive' (customer uses the secondary as Passive DR). Known values supported by the serviceActive: Active |
| HybridSecondaryUsageDetected |
Hybrid secondary usage detected. Possible values are 'Active' (customer does not meet the requirements to use the secondary as Passive DR) and 'Passive' (customer meets the requirements to use the secondary as Passive DR). Known values supported by the serviceActive: Active |
| IdentityType |
The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. Known values supported by the serviceNone: None |
| ImplementationMethod |
Gets the method in which this recommended action can be manually implemented. e.g., TSql, AzurePowerShell. |
| InaccessibilityReason |
Root cause kind. Allowed values are “TransparentDataEncryption”, “DatabaseReplication”, and “Unknown”. Known values supported by the serviceUnknown: Unknown |
| InstanceFailoverGroupReplicationRole |
Local replication role of the failover group instance. Known values supported by the servicePrimary: Primary |
| InstancePoolLicenseType |
The license type. Possible values are 'LicenseIncluded' (price for SQL license is included) and 'BasePrice' (without SQL license price). Known values supported by the serviceLicenseIncluded: LicenseIncluded |
| InstanceRole |
New role of managed instance in a distributed availability group, can be Primary or Secondary. Known values supported by the servicePrimary: Primary |
| IsRetryable |
Gets whether the error could be ignored and recommended action could be retried. Possible values are: Yes/No |
| JobAgentIdentityType |
The job agent identity type Known values supported by the serviceNone: None |
| JobAgentState |
The state of the job agent. Known values supported by the serviceCreating: Creating |
| JobExecutionLifecycle |
The detailed state of the job execution. Known values supported by the serviceCreated: Created |
| JobScheduleType |
Schedule interval type |
| JobStepActionSource |
The source of the action to execute. Known values supported by the serviceInline: Inline |
| JobStepActionType |
Type of action being executed by the job step. Known values supported by the serviceTSql: TSql |
| JobStepOutputType |
The output destination type. Known values supported by the serviceSqlDatabase: SqlDatabase |
| JobTargetGroupMembershipType |
Whether the target is included or excluded from the group. |
| JobTargetType |
The type of the target. Known values supported by the serviceTargetGroup: TargetGroup |
| LedgerDigestUploadsName |
Type of LedgerDigestUploadsName |
| LedgerDigestUploadsState |
Specifies the state of ledger digest upload. |
| LinkRole |
SQL server side link role Known values supported by the servicePrimary: Primary |
| LogSizeUnit |
The units that the limit is expressed in. Known values supported by the serviceMegabytes: Megabytes |
| LongTermRetentionPolicyName |
Type of LongTermRetentionPolicyName |
| ManagedDatabaseCreateMode |
Managed database create mode. PointInTimeRestore: Create a database by restoring a point in time backup of an existing database. SourceDatabaseName, SourceManagedInstanceName and PointInTime must be specified. RestoreExternalBackup: Create a database by restoring from external backup files. Collation, StorageContainerUri and StorageContainerSasToken must be specified. Recovery: Creates a database by restoring a geo-replicated backup. RecoverableDatabaseId must be specified as the recoverable database resource ID to restore. RestoreLongTermRetentionBackup: Create a database by restoring from a long term retention backup (longTermRetentionBackupResourceId required). Known values supported by the serviceDefault: Default |
| ManagedDatabaseStatus |
Status of the database. Known values supported by the serviceOnline: Online |
| ManagedInstanceAdministratorType |
Type of the managed instance administrator. Known values supported by the serviceActiveDirectory: ActiveDirectory |
| ManagedInstanceDatabaseFormat |
Specifies the internal format of instance databases specific to the SQL engine version. Known values supported by the serviceAlwaysUpToDate: AlwaysUpToDate |
| ManagedInstanceLicenseType |
The license type. Possible values are 'LicenseIncluded' (regular price inclusive of a new SQL license) and 'BasePrice' (discounted AHB price for bringing your own SQL licenses). Known values supported by the serviceLicenseIncluded: LicenseIncluded |
| ManagedInstanceLongTermRetentionPolicyName |
Type of ManagedInstanceLongTermRetentionPolicyName |
| ManagedInstanceProxyOverride |
Connection type used for connecting to the instance. Known values supported by the serviceProxy: Proxy |
| ManagedLedgerDigestUploadsName |
Type of ManagedLedgerDigestUploadsName |
| ManagedLedgerDigestUploadsState |
Specifies the state of ledger digest upload. Known values supported by the serviceEnabled: Enabled |
| ManagedServerCreateMode |
Specifies the mode of database creation. Default: Regular instance creation. Restore: Creates an instance by restoring a set of backups to specific point in time. RestorePointInTime and SourceManagedInstanceId must be specified. Known values supported by the serviceDefault: Default |
| ManagedShortTermRetentionPolicyName |
Type of ManagedShortTermRetentionPolicyName |
| ManagementOperationState |
The operation state. Known values supported by the servicePending: Pending |
| MaxSizeUnit |
The units that the limit is expressed in. Known values supported by the serviceMegabytes: Megabytes |
| MetricType |
Type of MetricType |
| MinimalTlsVersion |
Minimal TLS version. Allowed values: 'None', 1.0', '1.1', '1.2', '1.3' Known values supported by the serviceNone: None |
| MoveOperationMode |
Operation mode. Known values supported by the serviceMove: Move |
| OperationMode |
Operation mode of the operation: Import, Export, or PolybaseImport. Known values supported by the servicePolybaseImport: PolybaseImport |
| OperationOrigin |
The intended executor of the operation. Known values supported by the serviceuser: user |
| PauseDelayTimeUnit |
Unit of time that delay is expressed in Known values supported by the serviceMinutes: Minutes |
| PerformanceLevelUnit |
Unit type used to measure performance level. Known values supported by the serviceDTU: DTU |
| Phase |
The operation phase. Known values supported by the serviceLogTransitionInProgress: LogTransitionInProgress |
| PricingModel |
Pricing model of Managed Instance. Known values supported by the serviceRegular: Regular |
| PrincipalType |
Principal Type of the sever administrator. Known values supported by the serviceUser: User |
| PrivateEndpointProvisioningState |
State of the private endpoint connection. Known values supported by the serviceApproving: Approving |
| PrivateLinkServiceConnectionStateActionsRequire |
The actions required for private link service connection. Known values supported by the serviceNone: None |
| PrivateLinkServiceConnectionStateStatus |
The private link service connection status. Known values supported by the serviceApproved: Approved |
| ProvisioningState |
The ARM provisioning state of the job execution. Known values supported by the serviceCreated: Created |
| QueryMetricUnitType |
The unit of the metric. Known values supported by the servicepercentage: percentage |
| QueryTimeGrainType |
Interval type (length). Known values supported by the servicePT1H: PT1H |
| ReadOnlyEndpointFailoverPolicy |
Failover policy of the read-only endpoint for the failover group. Known values supported by the serviceDisabled: Disabled |
| ReadWriteEndpointFailoverPolicy |
Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. Known values supported by the serviceManual: Manual |
| RecommendedActionCurrentState |
Current state the recommended action is in. Some commonly used states are: Active -> recommended action is active and no action has been taken yet. Pending -> recommended action is approved for and is awaiting execution. Executing -> recommended action is being applied on the user database. Verifying -> recommended action was applied and is being verified of its usefulness by the system. Success -> recommended action was applied and improvement found during verification. Pending Revert -> verification found little or no improvement so recommended action is queued for revert or user has manually reverted. Reverting -> changes made while applying recommended action are being reverted on the user database. Reverted -> successfully reverted the changes made by recommended action on user database. Ignored -> user explicitly ignored/discarded the recommended action. Known values supported by the serviceActive: Active |
| RecommendedActionInitiatedBy |
Gets if approval for applying this recommended action was given by user/system. |
| RecommendedSensitivityLabelUpdateKind |
Type of RecommendedSensitivityLabelUpdateKind |
| ReplicaConnectedState |
Link connected state Known values supported by the serviceDISCONNECTED: DISCONNECTED |
| ReplicaSynchronizationHealth |
Link health state Known values supported by the serviceNOT_HEALTHY: NOT_HEALTHY |
| ReplicaType |
Type of ReplicaType |
| ReplicationLinkType |
Link type (GEO, NAMED, STANDBY). Update operation does not support NAMED. Known values supported by the serviceGEO: GEO |
| ReplicationModeType |
Replication mode of the link Known values supported by the serviceAsync: Async |
| ReplicationRole |
Local replication role. |
| ReplicationState |
Replication state (PENDING, SEEDING, CATCHUP, SUSPENDED). Known values supported by the servicePENDING: PENDING |
| RestoreDetailsName |
Type of RestoreDetailsName |
| RestorePointType |
The type of restore point |
| RoleChangeType |
The type of the role change, can be Planned or Forced. Known values supported by the serviceForced: Forced |
| RuleSeverity |
SQL Vulnerability Assessment rule severity. Known values supported by the serviceHigh: High |
| RuleStatus |
SQL Vulnerability Assessment baseline status Known values supported by the serviceNonFinding: NonFinding |
| RuleType |
SQL Vulnerability Assessment rule type. Known values supported by the serviceBinary: Binary |
| SampleName |
The name of the sample schema to apply when creating this database. Known values supported by the serviceAdventureWorksLT: AdventureWorksLT |
| SecondaryInstanceType |
Type of the geo-secondary instance. Set 'Standby' if the instance is used as a DR option only. Known values supported by the serviceGeo: Geo |
| SecondaryType |
The secondary type of the database if it is a secondary. Valid values are Geo, Named and Standby. Known values supported by the serviceGeo: Geo |
| SecurityAlertPolicyName |
Type of SecurityAlertPolicyName |
| SecurityAlertPolicyState |
Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database. |
| SecurityAlertsPolicyState |
Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database. |
| SecurityEventType |
The type of the security event. |
| SeedingModeType |
Database seeding mode – can be Automatic (default), or Manual for supported scenarios. Known values supported by the serviceAutomatic: Automatic |
| SensitivityLabelRank |
Type of SensitivityLabelRank |
| SensitivityLabelSource |
Type of SensitivityLabelSource |
| SensitivityLabelUpdateKind |
Type of SensitivityLabelUpdateKind |
| ServerConfigurationOptionName |
Type of ServerConfigurationOptionName |
| ServerConnectionType |
The server connection type. Known values supported by the serviceDefault: Default |
| ServerCreateMode |
Create mode for server, only valid values for this are Normal and Restore. Known values supported by the serviceNormal: Normal |
| ServerKeyType |
The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. Known values supported by the serviceServiceManaged: ServiceManaged |
| ServerNetworkAccessFlag |
Whether or not to restrict outbound network access for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' Known values supported by the serviceEnabled: Enabled |
| ServerPublicNetworkAccessFlag |
Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' or 'SecuredByPerimeter' Known values supported by the serviceEnabled: Enabled |
| ServerTrustGroupPropertiesTrustScopesItem |
Type of ServerTrustGroupPropertiesTrustScopesItem |
| ServerWorkspaceFeature |
Whether or not existing server has a workspace created and if it allows connection from workspace Known values supported by the serviceConnected: Connected |
| ServicePrincipalType |
Service principal type. Known values supported by the serviceNone: None |
| SetLegalHoldImmutability |
The setting for whether LegalHold is enabled or disabled on the LTR backup. When LegalHold is enabled, the backup cannot be deleted until the LegalHold is removed. Known values supported by the serviceEnabled: Enabled |
| ShortTermRetentionPolicyName |
Type of ShortTermRetentionPolicyName |
| SqlAgentConfigurationPropertiesState |
The state of Sql Agent. Known values supported by the serviceEnabled: Enabled |
| SqlVulnerabilityAssessmentName |
Type of SqlVulnerabilityAssessmentName |
| SqlVulnerabilityAssessmentState |
Specifies the state of the SQL Vulnerability Assessment, whether it is enabled or disabled or a state has not been applied yet on the specific database or server. |
| StartStopScheduleName |
Type of StartStopScheduleName |
| StorageCapabilityStorageAccountType |
The storage account type for the database's backups. Known values supported by the serviceGRS: GRS |
| StorageKeyType |
Storage key type: StorageAccessKey, SharedAccessKey or ManagedIdentity. Known values supported by the serviceSharedAccessKey: SharedAccessKey |
| SyncAgentState |
State of the sync agent. Known values supported by the serviceOnline: Online |
| SyncConflictResolutionPolicy |
Conflict resolution policy of the sync group. Known values supported by the serviceHubWin: HubWin |
| SyncDirection |
Sync direction of the sync member. Known values supported by the serviceBidirectional: Bidirectional |
| SyncGroupLogType |
Type of the sync group log. Known values supported by the serviceAll: All |
| SyncGroupState |
Sync state of the sync group. Known values supported by the serviceNotReady: NotReady |
| SyncGroupsType |
Type of SyncGroupsType |
| SyncMemberDbType |
Type of the sync agent linked database. Known values supported by the serviceAzureSqlDatabase: AzureSqlDatabase |
| SyncMemberState |
Sync state of the sync member. Known values supported by the serviceSyncInProgress: SyncInProgress |
| TableTemporalType |
The table temporal type. Known values supported by the serviceNonTemporalTable: NonTemporalTable |
| TimeBasedImmutability |
The setting for whether or not time-based immutability is enabled for the LTR backup. When time-based immutability is enabled and locked, the backup cannot be deleted until BackupExpirationTime. Known values supported by the serviceEnabled: Enabled |
| TimeBasedImmutabilityMode |
The time-based immutability mode. Only applicable if time-based immutability is enabled. Known values supported by the serviceLocked: Locked |
| TransparentDataEncryptionName |
Type of TransparentDataEncryptionName |
| TransparentDataEncryptionScanState |
Specifies the encryption scan state of the transparent data encryption. Known values supported by the serviceNone: None |
| TransparentDataEncryptionState |
Specifies the state of the transparent data encryption. |
| UpsertManagedServerOperationStepWithEstimatesAndDurationStatus |
Type of UpsertManagedServerOperationStepWithEstimatesAndDurationStatus |
| VirtualNetworkRuleState |
Virtual Network Rule State Known values supported by the serviceInitializing: Initializing |
| VulnerabilityAssessmentName |
Type of VulnerabilityAssessmentName |
| VulnerabilityAssessmentPolicyBaselineName |
Type of VulnerabilityAssessmentPolicyBaselineName |
| VulnerabilityAssessmentScanState |
The scan status. Known values supported by the servicePassed: Passed |
| VulnerabilityAssessmentScanTriggerType |
The scan trigger type. Known values supported by the serviceOnDemand: OnDemand |
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. |
| KnownAggregationFunctionType |
Known values of AggregationFunctionType that the service accepts. |
| KnownAlwaysEncryptedEnclaveType |
Type of enclave requested on the database i.e. Default or VBS enclaves. |
| KnownAuthMetadataLookupModes |
The managed instance's authentication metadata lookup mode. |
| KnownAuthenticationName |
Known values of AuthenticationName that the service accepts. |
| KnownAvailabilityZoneType |
Specifies the availability zone the database is pinned to. |
| KnownBackupStorageAccessTier |
The BackupStorageAccessTier for the LTR backup |
| KnownBackupStorageRedundancy |
The storage account type used to store backups for this database. |
| KnownBaselineName |
Known values of BaselineName that the service accepts. |
| KnownCapabilityGroup |
Known values of CapabilityGroup that the service accepts. |
| KnownCatalogCollationType |
Collation of the metadata catalog. |
| KnownClientClassificationSource |
Known values of ClientClassificationSource that the service accepts. |
| KnownColumnDataType |
The column data type. |
| KnownConnectionPolicyName |
Known values of ConnectionPolicyName that the service accepts. |
| KnownCreateMode |
Specifies the mode of database creation. Default: regular database creation. Copy: creates a database as a copy of an existing database. sourceDatabaseId must be specified as the resource ID of the source database. Secondary: creates a database as a secondary replica of an existing database. sourceDatabaseId must be specified as the resource ID of the existing primary database. PointInTimeRestore: Creates a database by restoring a point in time backup of an existing database. sourceDatabaseId must be specified as the resource ID of the existing database, and restorePointInTime must be specified. Recovery: Creates a database by restoring a geo-replicated backup. sourceDatabaseId must be specified as the recoverable database resource ID to restore. Restore: Creates a database by restoring a backup of a deleted database. sourceDatabaseId must be specified. If sourceDatabaseId is the database's original resource ID, then sourceDatabaseDeletionDate must be specified. Otherwise sourceDatabaseId must be the restorable dropped database resource ID and sourceDatabaseDeletionDate is ignored. restorePointInTime may also be specified to restore from an earlier point in time. RestoreLongTermRetentionBackup: Creates a database by restoring from a long term retention vault. recoveryServicesRecoveryPointResourceId must be specified as the recovery point resource ID. Copy, Secondary, and RestoreLongTermRetentionBackup are not supported for DataWarehouse edition. |
| KnownCreatedByType |
The kind of entity that created the resource. |
| KnownDNSRefreshOperationStatus |
The status of the DNS refresh operation. |
| KnownDataWarehouseUserActivityName |
Known values of DataWarehouseUserActivityName that the service accepts. |
| KnownDatabaseIdentityType |
The identity type |
| KnownDatabaseKeyType |
The database key type. Only supported value is 'AzureKeyVault'. |
| KnownDatabaseLicenseType |
The license type to apply for this database. |
| KnownDatabaseReadScale |
The state of read-only routing. If enabled, connections that have application intent set to readonly in their connection string may be routed to a readonly secondary replica in the same region. Not applicable to a Hyperscale database within an elastic pool. |
| KnownDatabaseState |
Known values of DatabaseState that the service accepts. |
| KnownDatabaseStatus |
The status of the database. |
| KnownDayOfWeek |
Day of maintenance window. |
| KnownDevOpsAuditingSettingsName |
Known values of DevOpsAuditingSettingsName that the service accepts. |
| KnownDiffBackupIntervalInHours |
The differential backup interval in hours. This is how many interval hours between each differential backup will be supported. This is only applicable to live databases but not dropped databases. |
| KnownDtcName |
Known values of DtcName that the service accepts. |
| KnownElasticPoolLicenseType |
The license type to apply for this elastic pool. |
| KnownElasticPoolState |
The state of the elastic pool. |
| KnownEncryptionProtectorName |
Known values of EncryptionProtectorName that the service accepts. |
| KnownErrorType |
Error type (e.g. None, User). |
| KnownExternalGovernanceStatus |
Status of external governance. |
| KnownFailoverGroupDatabasesSecondaryType |
Databases secondary type on partner server. |
| KnownFailoverGroupReplicationRole |
Local replication role of the failover group instance. |
| KnownFailoverModeType |
The link failover mode - can be Manual if intended to be used for two-way failover with a supported SQL Server, or None for one-way failover to Azure. |
| KnownFailoverType |
The failover type, can be ForcedAllowDataLoss or Planned. |
| KnownFreeLimitExhaustionBehavior |
Specifies the behavior when monthly free limits are exhausted for the free database. AutoPause: The database will be auto paused upon exhaustion of free limits for remainder of the month. BillForUsage: The database will continue to be online upon exhaustion of free limits and any overage will be billed. |
| KnownGeoBackupPolicyName |
Known values of GeoBackupPolicyName that the service accepts. |
| KnownHybridSecondaryUsage |
Hybrid secondary usage. Possible values are 'Active' (default value) and 'Passive' (customer uses the secondary as Passive DR). |
| KnownHybridSecondaryUsageDetected |
Hybrid secondary usage detected. Possible values are 'Active' (customer does not meet the requirements to use the secondary as Passive DR) and 'Passive' (customer meets the requirements to use the secondary as Passive DR). |
| KnownIdentityType |
The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. |
| KnownInaccessibilityReason |
Root cause kind. Allowed values are “TransparentDataEncryption”, “DatabaseReplication”, and “Unknown”. |
| KnownInstanceFailoverGroupReplicationRole |
Local replication role of the failover group instance. |
| KnownInstancePoolLicenseType |
The license type. Possible values are 'LicenseIncluded' (price for SQL license is included) and 'BasePrice' (without SQL license price). |
| KnownInstanceRole |
New role of managed instance in a distributed availability group, can be Primary or Secondary. |
| KnownJobAgentIdentityType |
The job agent identity type |
| KnownJobAgentState |
The state of the job agent. |
| KnownJobExecutionLifecycle |
The detailed state of the job execution. |
| KnownJobStepActionSource |
The source of the action to execute. |
| KnownJobStepActionType |
Type of action being executed by the job step. |
| KnownJobStepOutputType |
The output destination type. |
| KnownJobTargetType |
The type of the target. |
| KnownLedgerDigestUploadsName |
Known values of LedgerDigestUploadsName that the service accepts. |
| KnownLinkRole |
SQL server side link role |
| KnownLogSizeUnit |
The units that the limit is expressed in. |
| KnownLongTermRetentionPolicyName |
Known values of LongTermRetentionPolicyName that the service accepts. |
| KnownManagedDatabaseCreateMode |
Managed database create mode. PointInTimeRestore: Create a database by restoring a point in time backup of an existing database. SourceDatabaseName, SourceManagedInstanceName and PointInTime must be specified. RestoreExternalBackup: Create a database by restoring from external backup files. Collation, StorageContainerUri and StorageContainerSasToken must be specified. Recovery: Creates a database by restoring a geo-replicated backup. RecoverableDatabaseId must be specified as the recoverable database resource ID to restore. RestoreLongTermRetentionBackup: Create a database by restoring from a long term retention backup (longTermRetentionBackupResourceId required). |
| KnownManagedDatabaseStatus |
Status of the database. |
| KnownManagedInstanceAdministratorType |
Type of the managed instance administrator. |
| KnownManagedInstanceDatabaseFormat |
Specifies the internal format of instance databases specific to the SQL engine version. |
| KnownManagedInstanceLicenseType |
The license type. Possible values are 'LicenseIncluded' (regular price inclusive of a new SQL license) and 'BasePrice' (discounted AHB price for bringing your own SQL licenses). |
| KnownManagedInstanceLongTermRetentionPolicyName |
Known values of ManagedInstanceLongTermRetentionPolicyName that the service accepts. |
| KnownManagedInstanceProxyOverride |
Connection type used for connecting to the instance. |
| KnownManagedLedgerDigestUploadsName |
Known values of ManagedLedgerDigestUploadsName that the service accepts. |
| KnownManagedLedgerDigestUploadsState |
Specifies the state of ledger digest upload. |
| KnownManagedServerCreateMode |
Specifies the mode of database creation. Default: Regular instance creation. Restore: Creates an instance by restoring a set of backups to specific point in time. RestorePointInTime and SourceManagedInstanceId must be specified. |
| KnownManagedShortTermRetentionPolicyName |
Known values of ManagedShortTermRetentionPolicyName that the service accepts. |
| KnownManagementOperationState |
The operation state. |
| KnownMaxSizeUnit |
The units that the limit is expressed in. |
| KnownMetricType |
Known values of MetricType that the service accepts. |
| KnownMinimalTlsVersion |
Minimal TLS version. Allowed values: 'None', 1.0', '1.1', '1.2', '1.3' |
| KnownMoveOperationMode |
Operation mode. |
| KnownOperationMode |
Operation mode of the operation: Import, Export, or PolybaseImport. |
| KnownOperationOrigin |
The intended executor of the operation. |
| KnownPauseDelayTimeUnit |
Unit of time that delay is expressed in |
| KnownPerformanceLevelUnit |
Unit type used to measure performance level. |
| KnownPhase |
The operation phase. |
| KnownPricingModel |
Pricing model of Managed Instance. |
| KnownPrincipalType |
Principal Type of the sever administrator. |
| KnownPrivateEndpointProvisioningState |
State of the private endpoint connection. |
| KnownPrivateLinkServiceConnectionStateActionsRequire |
The actions required for private link service connection. |
| KnownPrivateLinkServiceConnectionStateStatus |
The private link service connection status. |
| KnownProvisioningState |
The ARM provisioning state of the job execution. |
| KnownQueryMetricUnitType |
The unit of the metric. |
| KnownQueryTimeGrainType |
Interval type (length). |
| KnownReadOnlyEndpointFailoverPolicy |
Failover policy of the read-only endpoint for the failover group. |
| KnownReadWriteEndpointFailoverPolicy |
Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. |
| KnownRecommendedActionCurrentState |
Current state the recommended action is in. Some commonly used states are: Active -> recommended action is active and no action has been taken yet. Pending -> recommended action is approved for and is awaiting execution. Executing -> recommended action is being applied on the user database. Verifying -> recommended action was applied and is being verified of its usefulness by the system. Success -> recommended action was applied and improvement found during verification. Pending Revert -> verification found little or no improvement so recommended action is queued for revert or user has manually reverted. Reverting -> changes made while applying recommended action are being reverted on the user database. Reverted -> successfully reverted the changes made by recommended action on user database. Ignored -> user explicitly ignored/discarded the recommended action. |
| KnownReplicaConnectedState |
Link connected state |
| KnownReplicaSynchronizationHealth |
Link health state |
| KnownReplicaType |
Known values of ReplicaType that the service accepts. |
| KnownReplicationLinkType |
Link type (GEO, NAMED, STANDBY). Update operation does not support NAMED. |
| KnownReplicationModeType |
Replication mode of the link |
| KnownReplicationState |
Replication state (PENDING, SEEDING, CATCHUP, SUSPENDED). |
| KnownRestoreDetailsName |
Known values of RestoreDetailsName that the service accepts. |
| KnownRoleChangeType |
The type of the role change, can be Planned or Forced. |
| KnownRuleSeverity |
SQL Vulnerability Assessment rule severity. |
| KnownRuleStatus |
SQL Vulnerability Assessment baseline status |
| KnownRuleType |
SQL Vulnerability Assessment rule type. |
| KnownSampleName |
The name of the sample schema to apply when creating this database. |
| KnownSecondaryInstanceType |
Type of the geo-secondary instance. Set 'Standby' if the instance is used as a DR option only. |
| KnownSecondaryType |
The secondary type of the database if it is a secondary. Valid values are Geo, Named and Standby. |
| KnownSecurityAlertPolicyName |
Known values of SecurityAlertPolicyName that the service accepts. |
| KnownSeedingModeType |
Database seeding mode – can be Automatic (default), or Manual for supported scenarios. |
| KnownServerConfigurationOptionName |
Known values of ServerConfigurationOptionName that the service accepts. |
| KnownServerConnectionType |
The server connection type. |
| KnownServerCreateMode |
Create mode for server, only valid values for this are Normal and Restore. |
| KnownServerKeyType |
The encryption protector type like 'ServiceManaged', 'AzureKeyVault'. |
| KnownServerNetworkAccessFlag |
Whether or not to restrict outbound network access for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' |
| KnownServerPublicNetworkAccessFlag |
Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' or 'SecuredByPerimeter' |
| KnownServerTrustGroupPropertiesTrustScopesItem |
Known values of ServerTrustGroupPropertiesTrustScopesItem that the service accepts. |
| KnownServerWorkspaceFeature |
Whether or not existing server has a workspace created and if it allows connection from workspace |
| KnownServicePrincipalType |
Service principal type. |
| KnownSetLegalHoldImmutability |
The setting for whether LegalHold is enabled or disabled on the LTR backup. When LegalHold is enabled, the backup cannot be deleted until the LegalHold is removed. |
| KnownShortTermRetentionPolicyName |
Known values of ShortTermRetentionPolicyName that the service accepts. |
| KnownSqlAgentConfigurationPropertiesState |
The state of Sql Agent. |
| KnownSqlVulnerabilityAssessmentName |
Known values of SqlVulnerabilityAssessmentName that the service accepts. |
| KnownStartStopScheduleName |
Known values of StartStopScheduleName that the service accepts. |
| KnownStorageCapabilityStorageAccountType |
The storage account type for the database's backups. |
| KnownStorageKeyType |
Storage key type: StorageAccessKey, SharedAccessKey or ManagedIdentity. |
| KnownSyncAgentState |
State of the sync agent. |
| KnownSyncConflictResolutionPolicy |
Conflict resolution policy of the sync group. |
| KnownSyncDirection |
Sync direction of the sync member. |
| KnownSyncGroupLogType |
Type of the sync group log. |
| KnownSyncGroupState |
Sync state of the sync group. |
| KnownSyncGroupsType |
Known values of SyncGroupsType that the service accepts. |
| KnownSyncMemberDbType |
Type of the sync agent linked database. |
| KnownSyncMemberState |
Sync state of the sync member. |
| KnownTableTemporalType |
The table temporal type. |
| KnownTimeBasedImmutability |
The setting for whether or not time-based immutability is enabled for the LTR backup. When time-based immutability is enabled and locked, the backup cannot be deleted until BackupExpirationTime. |
| KnownTimeBasedImmutabilityMode |
The time-based immutability mode. Only applicable if time-based immutability is enabled. |
| KnownTransparentDataEncryptionName |
Known values of TransparentDataEncryptionName that the service accepts. |
| KnownTransparentDataEncryptionScanState |
Specifies the encryption scan state of the transparent data encryption. |
| KnownUpsertManagedServerOperationStepWithEstimatesAndDurationStatus |
Known values of UpsertManagedServerOperationStepWithEstimatesAndDurationStatus that the service accepts. |
| KnownVersions |
The available API versions. |
| KnownVirtualNetworkRuleState |
Virtual Network Rule State |
| KnownVulnerabilityAssessmentName |
Known values of VulnerabilityAssessmentName that the service accepts. |
| KnownVulnerabilityAssessmentScanState |
The scan status. |
| KnownVulnerabilityAssessmentScanTriggerType |
The scan trigger type. |
Functions
| is |
Typeguard for RestError |
| restore |
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
| Rest |
A custom error type for failed pipeline requests. |
Function Details
isRestError(unknown)
Typeguard for RestError
function isRestError(e: unknown): eParameters
- e
-
unknown
Something caught by a catch clause.
Returns
e
restorePoller<TResponse, TResult>(SqlManagementClient, 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: SqlManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>Parameters
- client
- SqlManagementClient
- 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