Managed Instance - List by Resource Group - REST API (Azure SQL Database) (2023)

rescueGroupName

string

The name of the resource group that contains the resource. You can get this value from the Azure Resource Manager API or portal.

SubscriptionID

string

Subscription ID that identifies your Azure subscription.

API version

string

The API version used in the request.

$expand

string

Sub-resources to include in the response.

Managed instances list results

Successfully fetched list of managed instances.

*** Error response: ***

• 400 MiGeoRestoreWithWrongBackupStorageRedundancy - Offsite restore is not allowed for managed instances with LRS/ZRS backup storage redundancy.

• 400 UpdatingInstanceAndBackupRedundancy - Instance space redundancy and backup storage redundancy cannot be updated in the same request.

• 400 ProvisioningDisabled - Error message from resource operation authorization as it is, no changes required

• 400 AadOnlyAuthenticationIsEnabled - Only Azure Active Directory authentication is enabled. Contact your system administrator.

• 400 ManagementServiceFeatureDisabled - User attempted to use a disabled feature.

• 404 SubscriptionNotFound - The requested subscription was not found.

• 404 ManagedInstanceNotInSubscriptionResourceGroup - The specified managed instance does not exist in the specified resource group and subscription.

• 404 ServerNotInSubscription - The specified server does not exist in the specified subscription.

• 404 SubscriptionNotFound - The requested subscription was not found.

• 404 ResourceNotFound - The requested resource was not found.

• 409 ConflictingManagedInstanceOperation - Managed instance operation is currently in progress.

• 409 BackupRedundancyUpdateAndInstanceRedundancyConflict - The instance is multi-zone, but the backup storage is being updated from zone-redundant to non-zone-redundant.

• 409 InstanceRedundancyUpdateWhileBackupRedundancyUpdateInProgress - Unable to update instance redundancy as backup storage redundancy update is in progress.

• 409 InstanceRedundancyUpdateAndBackupRedundancyConflict - Backup storage is not zone-redundant, but instance redundancy is updated to zone-redundant.

• 409 BackupRedundancyUpdateConflict - Unable to update backup storage redundancy because backup storage redundancy update is already in progress.

• 409 MiDropFailedOnAuthLocks - User attempted to delete the last managed instance on the subnet where a lock was applied to the resource.

• 409 MiCreateFailedNonDelegatedSubnet - User attempted to deploy a managed instance or managed instance pool in a subnet not delegated to Microsoft.Sql/managedInstances.

• 412 InstanceNotReadyForBackupRedundancyUpdate - Unable to update backup storage redundancy because the instance is not ready.

• 429 SubscriptionTooManyRequests - A request that exceeds the maximum number of requests that the available resources can handle.

• 429 SubscriptionTooManyCreateUpdateRequests - A request that exceeds the maximum number of requests that can be handled by available resources.

• 429 SubscriptionTooManyCreateUpdateRequests - A request that exceeds the maximum number of requests that can be handled by available resources.

• 429 SubscriptionTooManyRequests - A request that exceeds the maximum number of requests that the available resources can handle.

• 429 ConflictingSubscriptionOperation - Subscription operation is currently in progress.

• 503 TooManyRequests - A request that exceeds the maximum number of requests that the available resources can handle.

• 503 TooManyRequests - A request that exceeds the maximum number of requests that the available resources can handle.

• 504 RequestTimeout - The service request exceeded the allowed time limit.

• 504 RequestTimeout - The service request exceeded the allowed time limit.

Server admin type.

The type of storage account used to store backups for this instance. The options are LocallyRedundantStorage, ZoneRedundantStorage, GeoRedundantStorage, and GeoZoneRedundantStorage

identity type. Set it to "SystemAssigned" to automatically create and assign an Azure Active Directory principal to the resource.

Azure SQL Managed Instance.

Atrybuty administratora Active Directory.

License type. Possible values ​​are "LicenseIncluded" (normal price includes a new SQL license) and "BasePrice" (price with AHB discount for bringing your own SQL license).

List of managed instances.

Private endpoint connections within managed instances

Private endpoint connection properties.

The type of connection used to connect to the instance.

Specifies the database creation scheme.

Default: create instances periodically.

Restore: Create an instance by restoring a backup set to a specific point in time. RestorePointInTime and SourceManagedInstanceId must be specified.

The main type for server administrators.

Azure Active Directory identity configuration for the resource.

Configuration of the service principal for the managed resource instance.

The main type of service.

ARM resource SKUs.

Azure Active Directory identity configuration for the resource.

string

string

string

string

string

string

string

string

string

string

Resource ID.

Resource ID

The Azure Active Directory identity for the managed instance.

string

resource location.

string

Resource name.

string

Managed instance administrator username. Can only be specified when creating a managed instance (and is required to create).

string

Admin login password (required when creating a managed instance).

External administrator of the managed instance

The Azure Active Directory administrator for the instance. This can only be used when creating an instance. It will be ignored or will cause an error if used to update an instance. A separate API is required for updates.

string

Managed instance sorting.

backup storage redundancy

The type of storage account used to store backups for this instance. The options are LocallyRedundantStorage, ZoneRedundantStorage, GeoRedundantStorage, and GeoZoneRedundantStorage

string

The DNS zone where the managed instance is located.

string

Resource ID of another managed instance that will share its DNS zone when created.

string

The fully qualified domain name of the managed instance.

string

The ID of the instance pool this managed server belongs to.

string

The CMK URI of the key used for encryption.

Managed instance license types

License type. Possible values ​​are "LicenseIncluded" (normal price includes a new SQL license) and "BasePrice" (price with AHB discount for bringing your own SQL license).

string

Specifies the maintenance configuration ID to apply to this managed instance.

Managed server creation mode

Specifies the database creation scheme.

Default: create instances periodically.

Restore: Create an instance by restoring a backup set to a specific point in time. RestorePointInTime and SourceManagedInstanceId must be specified.

string

Minimal TLS version. Allowed values: "none", "1.0", "1.1", "1.2"

string

The resource ID of the user-assigned identity used by default.

ManagedInstancePecProperty[]

A list of private endpoint connections on the managed instance.

• adopted
• Cancel
• Created
• create
• deleted
• remove
• Malfunction
• NOSpecified
• register
• action
• it worked
• timinggo out
• unknown
• unrecognizable
• update

ManagedInstanceProxyOverride

The type of connection used to connect to the instance.

A logical value

Specifies whether to enable the public data endpoint.

backup storage redundancy

The type of storage account used to store backups for this instance. The options are LocallyRedundantStorage, ZoneRedundantStorage, GeoRedundantStorage, and GeoZoneRedundantStorage

string

Specifies the point in time (in ISO8601 format) of the source database that will be restored to create a new database.

the object of the service

The service principal for the managed instance.

string

Resource ID of the source managed instance associated with the creation operation of this instance.

string

Managed instance status.

integer

Memory size in GB. Minimum value: 32. Maximum value: 16384. Only 32GB increments are allowed. The maximum value depends on the selected hardware family and the number of vCores.

string

Managed instance subnet resource ID.

string

Time zone ID. Allowed values ​​are time zones supported by Windows. Windows stores detailed information about supported time zones, including identifiers, in the registry under KEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones. You can get these registry values ​​from sys.time_zone_info by SQL Server by querying SELECT name AS timezone_id. You can also get a list of IDs by doing [System.TimeZoneInfo]::GetSystemTimeZones() in PowerShell. Examples of valid time zone identifiers are "Pacific Standard Time" or "Western European Standard Time".

integer

Number of vCores. Allowed values: 8, 16, 24, 32, 40, 64, 80.

A logical value

Whether the multi-az function is enabled.

Sku

Managed Instance SKU. Allowed values ​​for sku.name: GP_Gen5, GP_G8IM, GP_G8IH, BC_Gen5, BC_G8IM, BC_G8IH

Intention

resource tag.

string

Resource type.

administrator type

Server admin type.

A logical value

Authentication is only enabled for Azure Active Directory.

string

The login name of the server administrator.

entity type

The main type for server administrators.

string

SID (object identifier) ​​of the server administrator.

string

Admin tenant ID.

string

string

string

Link to download next page of results.

managed instance[]

score board.

string

Resource ID.

ManagedInstancePrivateEndpointConnectionProperties

Private endpoint connection properties

ManagedInstancePrivateEndpointProperty

The private endpoint to which the connection belongs.

ManagedInstancePrivateLinkServiceConnectionStateProperty

Private endpoint connection status.

string

Private endpoint connection status.

string

The resource ID of the private endpoint.

string

A description of the private link service connection.

string

A description of the private link service connection.

string

Connection status to the private link service.

string

string

string

string

string

string

string

string

string

Azure Active Directory Subject ID.

string

Azure Active Directory tenant ID.

identity type

identity type. Set it to "SystemAssigned" to automatically create and assign an Azure Active Directory principal to the resource.

User ID>

The resource ID of the user-assigned identity to use

string

Azure Active Directory application client ID.

string

The object ID of the Azure Active Directory application.

string

Azure Active Directory tenant ID.

The main type of service

The main type of service.

string

string

integer

The capacity of a specific SKU.

string

If your service has different generations of hardware for the same SKU, this can be captured here.

string

The name of the SKU, usually a letter + number, such as P3.

string

Dimensions for specific SKUs

string

The level or edition of a specific SKU, e.g. Basic, Premium.

string

Identyfikator klienta Azure Active Directory.

string

Azure Active Directory Subject ID.