Managed Instances - Get

Reference

Service:: SQL Database

API Version:: 2023-08-01

Gets a managed instance.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}?api-version=2023-08-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}?$expand={$expand}&api-version=2023-08-01

URI Parameters

Name	In	Required	Type	Description
managedInstanceName	path	True	string	The name of the managed instance.
resourceGroupName	path	True	string	The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
subscriptionId	path	True	string	The subscription ID that identifies an Azure subscription.
api-version	query	True	string	The API version to use for the request.
$expand	query		string	The child resources to include in the response.

Responses

Name	Type	Description
200 OK	ManagedInstance	Successfully retrieved the specified managed instance.
Other Status Codes	ErrorResponse	* Error Responses: * 400 SubnetMissingRequiredDelegation - Selected subnet is not delegated for SQL Managed Instance. 400 ManagementServiceManagedServerDisabled - Operation failed since Managed Instance '{0}' is disabled. Please enable Managed Instance and try again. 400 MiGeoRestoreWithWrongBackupStorageRedundancy - Geo-Restore is not allowed for managed instances with LRS/ZRS backup storage redundancy. 400 LastBackupNameHasNewline - Please do not use forbidden characters ('\n', '\r') in lastBackupName. 400 LastBackupNameHasNonAsciiCharacter - The operation was aborted because the 'LastBackupName' parameter contains invalid characters. Only ASCII characters are allowed. 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes 400 LRSCutoverDatabaseDoesNotExist - The operation was aborted because the database name specified in the request doesn't match any database name on the specified server. 400 LRSCutoverDatabaseNotInRestoringState - The operation was aborted because the specified database is not in restoring state. 400 LRSCutoverDatabaseAlreadyRestored - The operation was aborted because the specified database was already restored. 400 LRSCutoverAlreadyInitiated - The operation was aborted because a cutover for the specified database is already in progress. 400 ManagementServiceFeatureDisabled - User attempted to use a feature which is disabled. 400 AadOnlyAuthenticationIsEnabled - Azure Active Directory Only Authentication is enabled. Please contact your system administrator. 400 UpdatingInstanceAndBackupRedundancy - Instance zone redundancy and backup storage redundancy cannot be updated in the same request. 400 DeleteOfManagedInstanceIsDisabled - Delete operation of managed instance is disabled. 400 RequestCantLandOnPaaSv2Platform - Request needs to land on PaaSv2 platform but PaaSv2 is not enabled. 400 CustomMaintenanceWindowIsDisabled - Custom maintenance window is not enabled. 400 DeleteOfVersion2VirtualClusterIsDisabled - Delete of virtual cluster with version 2 is not enabled. 400 DeleteOfVirtualClusterIsDisabled - Delete of virtual cluster is not enabled. 400 MICantBeMovedFromOrToInstancePool - Existing managed instance can't be moved to managed instance pool. 400 DnsRefreshOnVirtualClusterIsDisabled - Refresh of DNS records on virtual cluster is not enabled. 404 SubscriptionNotFound - The requested subscription was not found. 404 ManagedInstanceNotInSubscriptionResourceGroup - Specified managed instance does not exist in the specified resource group and subscription. 404 SubscriptionNotFound - The requested subscription was not found. 404 ServerNotInSubscription - Specified server does not exist on the specified subscription. 404 ResourceNotFound - The requested resource was not found. 409 MiCreateFailedNonDelegatedSubnet - User tried to deploy Managed Instance or Managed Instance pool in subnet that is not delegated to Microsoft.Sql/managedInstances. 409 InstancePoolBusy - An instance pool is busy with another ongoing operation 409 ConflictingManagedInstanceOperation - An operation is currently in progress for the managed instance. 409 BackupRedundancyUpdateAndInstanceRedundancyConflict - The instance is multi-az but backup storage is being updated from zone redundant to non-zone redundant. 409 InstanceRedundancyUpdateWhileBackupRedundancyUpdateInProgress - Cannot update instance redundancy because backup storage redundancy update is in progress. 409 InstanceRedundancyUpdateAndBackupRedundancyConflict - The backup storage is non-zone redundant but instance redundancy is being updated to zone redundant. 409 BackupRedundancyUpdateConflict - Cannot update backup storage redundancy because a backup storage redundancy update is already in progress. 409 MiDropFailedOnAuthLocks - User tried to drop last Managed Instance in subnet that has Lock applied on resource(s). 412 InstanceNotReadyForBackupRedundancyUpdate - Cannot update backup storage redundancy because the instance is not ready. 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources. 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources. 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources. 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources. 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources. 429 ConflictingSubscriptionOperation - An operation is currently in progress for the subscription. 503 TooManyRequests - Requests beyond max requests that can be processed by available resources. 503 TooManyRequests - Requests beyond max requests that can be processed by available resources. 503 TooManyRequests - Requests beyond max requests that can be processed by available resources. 504 RequestTimeout - Service request exceeded the allowed timeout. 504 RequestTimeout - Service request exceeded the allowed timeout.

Name

Type

Description

200 OK

ManagedInstance

Successfully retrieved the specified managed instance.

Other Status Codes

ErrorResponse

*** Error Responses: ***

400 SubnetMissingRequiredDelegation - Selected subnet is not delegated for SQL Managed Instance.
400 ManagementServiceManagedServerDisabled - Operation failed since Managed Instance '{0}' is disabled. Please enable Managed Instance and try again.
400 MiGeoRestoreWithWrongBackupStorageRedundancy - Geo-Restore is not allowed for managed instances with LRS/ZRS backup storage redundancy.
400 LastBackupNameHasNewline - Please do not use forbidden characters ('\n', '\r') in lastBackupName.
400 LastBackupNameHasNonAsciiCharacter - The operation was aborted because the 'LastBackupName' parameter contains invalid characters. Only ASCII characters are allowed.
400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes
400 LRSCutoverDatabaseDoesNotExist - The operation was aborted because the database name specified in the request doesn't match any database name on the specified server.
400 LRSCutoverDatabaseNotInRestoringState - The operation was aborted because the specified database is not in restoring state.
400 LRSCutoverDatabaseAlreadyRestored - The operation was aborted because the specified database was already restored.
400 LRSCutoverAlreadyInitiated - The operation was aborted because a cutover for the specified database is already in progress.
400 ManagementServiceFeatureDisabled - User attempted to use a feature which is disabled.
400 AadOnlyAuthenticationIsEnabled - Azure Active Directory Only Authentication is enabled. Please contact your system administrator.
400 UpdatingInstanceAndBackupRedundancy - Instance zone redundancy and backup storage redundancy cannot be updated in the same request.
400 DeleteOfManagedInstanceIsDisabled - Delete operation of managed instance is disabled.
400 RequestCantLandOnPaaSv2Platform - Request needs to land on PaaSv2 platform but PaaSv2 is not enabled.
400 CustomMaintenanceWindowIsDisabled - Custom maintenance window is not enabled.
400 DeleteOfVersion2VirtualClusterIsDisabled - Delete of virtual cluster with version 2 is not enabled.
400 DeleteOfVirtualClusterIsDisabled - Delete of virtual cluster is not enabled.
400 MICantBeMovedFromOrToInstancePool - Existing managed instance can't be moved to managed instance pool.
400 DnsRefreshOnVirtualClusterIsDisabled - Refresh of DNS records on virtual cluster is not enabled.
404 SubscriptionNotFound - The requested subscription was not found.
404 ManagedInstanceNotInSubscriptionResourceGroup - Specified managed instance does not exist in the specified resource group and subscription.
404 SubscriptionNotFound - The requested subscription was not found.
404 ServerNotInSubscription - Specified server does not exist on the specified subscription.
404 ResourceNotFound - The requested resource was not found.
409 MiCreateFailedNonDelegatedSubnet - User tried to deploy Managed Instance or Managed Instance pool in subnet that is not delegated to Microsoft.Sql/managedInstances.
409 InstancePoolBusy - An instance pool is busy with another ongoing operation
409 ConflictingManagedInstanceOperation - An operation is currently in progress for the managed instance.
409 BackupRedundancyUpdateAndInstanceRedundancyConflict - The instance is multi-az but backup storage is being updated from zone redundant to non-zone redundant.
409 InstanceRedundancyUpdateWhileBackupRedundancyUpdateInProgress - Cannot update instance redundancy because backup storage redundancy update is in progress.
409 InstanceRedundancyUpdateAndBackupRedundancyConflict - The backup storage is non-zone redundant but instance redundancy is being updated to zone redundant.
409 BackupRedundancyUpdateConflict - Cannot update backup storage redundancy because a backup storage redundancy update is already in progress.
409 MiDropFailedOnAuthLocks - User tried to drop last Managed Instance in subnet that has Lock applied on resource(s).
412 InstanceNotReadyForBackupRedundancyUpdate - Cannot update backup storage redundancy because the instance is not ready.
429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.
429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.
429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.
429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.
429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.
429 ConflictingSubscriptionOperation - An operation is currently in progress for the subscription.
503 TooManyRequests - Requests beyond max requests that can be processed by available resources.
503 TooManyRequests - Requests beyond max requests that can be processed by available resources.
503 TooManyRequests - Requests beyond max requests that can be processed by available resources.
504 RequestTimeout - Service request exceeded the allowed timeout.
504 RequestTimeout - Service request exceeded the allowed timeout.

Examples

Get managed instance

Get managed instance while resource is updating

Get managed instance with $expand=administrators/activedirectory

Get managed instance

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testinstance?api-version=2023-08-01

Sample response

Status code:: 200

{
  "sku": {
    "name": "GP_Gen5",
    "tier": "GeneralPurpose",
    "capacity": 8,
    "family": "Gen5"
  },
  "properties": {
    "fullyQualifiedDomainName": "testinstance.1b4e2caff2530.database.windows.net",
    "administratorLogin": "dummylogin",
    "subnetId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1",
    "state": "Ready",
    "provisioningState": "Succeeded",
    "vCores": 8,
    "storageSizeInGB": 1024,
    "licenseType": "LicenseIncluded",
    "collation": "SQL_Latin1_General_CP1_CI_AS",
    "publicDataEndpointEnabled": false,
    "proxyOverride": "Default",
    "minimalTlsVersion": "1.2",
    "dnsZone": "1b4e2caff2530",
    "instancePoolId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Sql/instancePools/instancePool1",
    "maintenanceConfigurationId": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_JapanEast_MI_1",
    "currentBackupStorageRedundancy": "Geo",
    "requestedBackupStorageRedundancy": "Geo",
    "virtualClusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Sql/virtualClusters/vc-5555555-6666-7777-8888-999999999999",
    "servicePrincipal": {
      "principalId": "00000011-1111-2222-2222-123456789111",
      "clientId": "00000011-1111-2222-2222-123456789111",
      "tenantId": "00000011-1111-2222-2222-123456789111",
      "type": "SystemAssigned"
    },
    "externalGovernanceStatus": "Enabled",
    "hybridSecondaryUsage": "Passive",
    "authenticationMetadata": "Windows",
    "pricingModel": "Regular",
    "createTime": "2022-11-01T01:01:01.011Z",
    "databaseFormat": "SQLServer2022"
  },
  "location": "japaneast",
  "tags": {
    "key": "value"
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testinstance",
  "name": "testinstance",
  "type": "Microsoft.Sql/managedInstances"
}

Get managed instance while resource is updating

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testinstance?api-version=2023-08-01

Sample response

Status code:: 200

{
  "sku": {
    "name": "GP_Gen5",
    "tier": "GeneralPurpose",
    "capacity": 8,
    "family": "Gen5"
  },
  "properties": {
    "fullyQualifiedDomainName": "testinstance.1b4e2caff2530.database.windows.net",
    "administratorLogin": "dummylogin",
    "subnetId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1",
    "state": "Ready",
    "provisioningState": "Updating",
    "vCores": 8,
    "storageSizeInGB": 1024,
    "licenseType": "LicenseIncluded",
    "collation": "SQL_Latin1_General_CP1_CI_AS",
    "publicDataEndpointEnabled": false,
    "proxyOverride": "Default",
    "minimalTlsVersion": "1.2",
    "dnsZone": "1b4e2caff2530",
    "instancePoolId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Sql/instancePools/instancePool1",
    "maintenanceConfigurationId": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_JapanEast_MI_1",
    "virtualClusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Sql/virtualClusters/vc-5555555-6666-7777-8888-999999999999",
    "externalGovernanceStatus": "Enabled",
    "pricingModel": "Regular",
    "createTime": "2022-11-01T01:01:01.011Z",
    "authenticationMetadata": "Windows",
    "databaseFormat": "SQLServer2022"
  },
  "location": "japaneast",
  "tags": {
    "key": "value"
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testinstance",
  "name": "testinstance",
  "type": "Microsoft.Sql/managedInstances"
}

Get managed instance with $expand=administrators/activedirectory

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testinstance?api-version=2023-08-01

Sample response

Status code:: 200

{
  "sku": {
    "name": "GP_Gen5",
    "tier": "GeneralPurpose",
    "capacity": 8,
    "family": "Gen5"
  },
  "properties": {
    "fullyQualifiedDomainName": "testinstance.1b4e2caff2530.database.windows.net",
    "administratorLogin": "dummylogin",
    "subnetId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1",
    "state": "Ready",
    "provisioningState": "Succeeded",
    "vCores": 8,
    "storageSizeInGB": 1024,
    "licenseType": "LicenseIncluded",
    "collation": "SQL_Latin1_General_CP1_CI_AS",
    "publicDataEndpointEnabled": false,
    "proxyOverride": "Default",
    "minimalTlsVersion": "1.2",
    "dnsZone": "1b4e2caff2530",
    "instancePoolId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Sql/instancePools/instancePool1",
    "maintenanceConfigurationId": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_JapanEast_MI_1",
    "virtualClusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Sql/virtualClusters/vc-5555555-6666-7777-8888-999999999999",
    "currentBackupStorageRedundancy": "Geo",
    "requestedBackupStorageRedundancy": "Geo",
    "administrators": {
      "principalType": "User",
      "login": "[email protected]",
      "sid": "00000011-1111-2222-2222-123456789111",
      "tenantId": "00000011-1111-2222-2222-123456789111",
      "azureADOnlyAuthentication": true
    },
    "externalGovernanceStatus": "Enabled",
    "hybridSecondaryUsage": "Passive",
    "authenticationMetadata": "Windows",
    "pricingModel": "Regular",
    "createTime": "2022-11-01T01:01:01.011Z",
    "databaseFormat": "SQLServer2022"
  },
  "location": "japaneast",
  "tags": {
    "key": "value"
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testinstance",
  "name": "testinstance",
  "type": "Microsoft.Sql/managedInstances"
}

Definitions

Name	Description
AdministratorType	Type of the sever administrator.
AuthMetadataLookupModes	The managed instance's authentication metadata lookup mode.
BackupStorageRedundancy	The storage account type used to store backups for this instance. The options are Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) and GeoZone(GeoZoneRedundantStorage)
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ExternalGovernanceStatus	Status of external governance.
HybridSecondaryUsage	Hybrid secondary usage. Possible values are 'Active' (default value) and 'Passive' (customer uses the secondary as Passive DR).
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).
IdentityType	The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource.
ManagedInstance	An Azure SQL managed instance.
ManagedInstanceDatabaseFormat	Specifies the internal format of instance databases specific to the SQL engine version.
ManagedInstanceExternalAdministrator	Properties of a active directory administrator.
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).
ManagedInstancePecProperty	A private endpoint connection under a managed instance
ManagedInstancePrivateEndpointConnectionProperties	Properties of a private endpoint connection.
ManagedInstancePrivateEndpointProperty
ManagedInstancePrivateLinkServiceConnectionStateProperty
ManagedInstanceProxyOverride	Connection type used for connecting to the instance.
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.
PricingModel	Pricing model of Managed Instance.
PrincipalType	Principal Type of the sever administrator.
ProvisioningState	Provisioning state of managed instance.
ResourceIdentity	Azure Active Directory identity configuration for a resource.
ServicePrincipal	The managed instance's service principal configuration for a resource.
ServicePrincipalType	Service principal type.
Sku	An ARM Resource SKU.
UserIdentity	Azure Active Directory identity configuration for a resource.

AdministratorType

Enumeration

Type of the sever administrator.

Value	Description
ActiveDirectory

AuthMetadataLookupModes

Enumeration

The managed instance's authentication metadata lookup mode.

Value	Description
AzureAD
Paired
Windows

BackupStorageRedundancy

Enumeration

The storage account type used to store backups for this instance. The options are Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) and GeoZone(GeoZoneRedundantStorage)

Value	Description
Geo
GeoZone
Local
Zone

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

ExternalGovernanceStatus

Enumeration

Status of external governance.

Value	Description
Disabled
Enabled

HybridSecondaryUsage

Enumeration

Hybrid secondary usage. Possible values are 'Active' (default value) and 'Passive' (customer uses the secondary as Passive DR).

Value	Description
Active
Passive

HybridSecondaryUsageDetected

Enumeration

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).

Value	Description
Active
Passive

IdentityType

Enumeration

The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource.

Value	Description
None
SystemAssigned
SystemAssigned,UserAssigned
UserAssigned

ManagedInstance

Object

An Azure SQL managed instance.

Name	Type	Description
id	string	Resource ID.
identity	ResourceIdentity	The Azure Active Directory identity of the managed instance.
location	string	Resource location.
name	string	Resource name.
properties.administratorLogin	string	Administrator username for the managed instance. Can only be specified when the managed instance is being created (and is required for creation).
properties.administratorLoginPassword	string	The administrator login password (required for managed instance creation).
properties.administrators	ManagedInstanceExternalAdministrator	The Azure Active Directory administrator of the instance. This can only be used at instance create time. If used for instance update, it will be ignored or it will result in an error. For updates individual APIs will need to be used.
properties.authenticationMetadata	AuthMetadataLookupModes	The managed instance's authentication metadata lookup mode.
properties.collation	string	Collation of the managed instance.
properties.createTime	string (date-time)	Specifies the point in time (ISO8601 format) of the Managed Instance creation.
properties.currentBackupStorageRedundancy	BackupStorageRedundancy	The storage account type used to store backups for this instance. The options are Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) and GeoZone(GeoZoneRedundantStorage)
properties.databaseFormat	ManagedInstanceDatabaseFormat	Specifies the internal format of instance databases specific to the SQL engine version.
properties.dnsZone	string	The Dns Zone that the managed instance is in.
properties.dnsZonePartner	string (arm-id)	The resource id of another managed instance whose DNS zone this managed instance will share after creation.
properties.externalGovernanceStatus	ExternalGovernanceStatus	Status of external governance.
properties.fullyQualifiedDomainName	string	The fully qualified domain name of the managed instance.
properties.hybridSecondaryUsage	HybridSecondaryUsage	Hybrid secondary usage. Possible values are 'Active' (default value) and 'Passive' (customer uses the secondary as Passive DR).
properties.hybridSecondaryUsageDetected	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).
properties.instancePoolId	string	The Id of the instance pool this managed server belongs to.
properties.isGeneralPurposeV2	boolean	Whether or not this is a GPv2 variant of General Purpose edition.
properties.keyId	string	A CMK URI of the key to use for encryption.
properties.licenseType	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).
properties.maintenanceConfigurationId	string	Specifies maintenance configuration id to apply to this managed instance.
properties.managedInstanceCreateMode	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.
properties.minimalTlsVersion	string	Minimal TLS version. Allowed values: 'None', '1.0', '1.1', '1.2'
properties.pricingModel	PricingModel	Pricing model of Managed Instance.
properties.primaryUserAssignedIdentityId	string (arm-id)	The resource id of a user assigned identity to be used by default.
properties.privateEndpointConnections	ManagedInstancePecProperty[]	List of private endpoint connections on a managed instance.
properties.provisioningState	ProvisioningState	Provisioning state of managed instance.
properties.proxyOverride	ManagedInstanceProxyOverride	Connection type used for connecting to the instance.
properties.publicDataEndpointEnabled	boolean	Whether or not the public data endpoint is enabled.
properties.requestedBackupStorageRedundancy	BackupStorageRedundancy	The storage account type to be used to store backups for this instance. The options are Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) and GeoZone(GeoZoneRedundantStorage)
properties.restorePointInTime	string (date-time)	Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database.
properties.servicePrincipal	ServicePrincipal	The managed instance's service principal.
properties.sourceManagedInstanceId	string (arm-id)	The resource identifier of the source managed instance associated with create operation of this instance.
properties.state	string	The state of the managed instance.
properties.storageIOps	integer (int32)	Storage IOps. Minimum value: 300. Maximum value: 80000. Increments of 1 IOps allowed only. Maximum value depends on the selected hardware family and number of vCores.
properties.storageSizeInGB	integer (int32)	Storage size in GB. Minimum value: 32. Maximum value: 16384. Increments of 32 GB allowed only. Maximum value depends on the selected hardware family and number of vCores.
properties.storageThroughputMBps	integer (int32)	Storage throughput MBps parameter is not supported in the instance create/update operation.
properties.subnetId	string (arm-id)	Subnet resource ID for the managed instance.
properties.timezoneId	string	Id of the timezone. Allowed values are timezones supported by Windows. Windows keeps details on supported timezones, including the id, in registry under KEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones. You can get those registry values via SQL Server by querying SELECT name AS timezone_id FROM sys.time_zone_info. List of Ids can also be obtained by executing [System.TimeZoneInfo]::GetSystemTimeZones() in PowerShell. An example of valid timezone id is "Pacific Standard Time" or "W. Europe Standard Time".
properties.vCores	integer (int32)	The number of vCores. Allowed values: 8, 16, 24, 32, 40, 64, 80.
properties.virtualClusterId	string	Virtual cluster resource id for the Managed Instance.
properties.zoneRedundant	boolean	Whether or not the multi-az is enabled.
sku	Sku	Managed instance SKU. Allowed values for sku.name: GP_Gen5, GP_G8IM, GP_G8IH, BC_Gen5, BC_G8IM, BC_G8IH
tags	object	Resource tags.
type	string	Resource type.

ManagedInstanceDatabaseFormat

Enumeration

Specifies the internal format of instance databases specific to the SQL engine version.

Value	Description
AlwaysUpToDate
SQLServer2022

ManagedInstanceExternalAdministrator

Object

Properties of a active directory administrator.

Name	Type	Description
administratorType	AdministratorType	Type of the sever administrator.
azureADOnlyAuthentication	boolean	Azure Active Directory only Authentication enabled.
login	string	Login name of the server administrator.
principalType	PrincipalType	Principal Type of the sever administrator.
sid	string (uuid)	SID (object ID) of the server administrator.
tenantId	string (uuid)	Tenant ID of the administrator.

ManagedInstanceLicenseType

Enumeration

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).

Value	Description
BasePrice
LicenseIncluded

ManagedInstancePecProperty

Object

A private endpoint connection under a managed instance

Name	Type	Description
id	string	Resource ID.
properties	ManagedInstancePrivateEndpointConnectionProperties	Private endpoint connection properties

ManagedInstancePrivateEndpointConnectionProperties

Object

Properties of a private endpoint connection.

Name	Type	Description
privateEndpoint	ManagedInstancePrivateEndpointProperty	Private endpoint which the connection belongs to.
privateLinkServiceConnectionState	ManagedInstancePrivateLinkServiceConnectionStateProperty	Connection State of the Private Endpoint Connection.
provisioningState	string	State of the Private Endpoint Connection.

ManagedInstancePrivateEndpointProperty

Object

Name	Type	Description
id	string	Resource id of the private endpoint.

ManagedInstancePrivateLinkServiceConnectionStateProperty

Object

Name	Type	Description
actionsRequired	string	The private link service connection description.
description	string	The private link service connection description.
status	string	The private link service connection status.

ManagedInstanceProxyOverride

Enumeration

Connection type used for connecting to the instance.

Value	Description
Default
Proxy
Redirect

ManagedServerCreateMode

Enumeration

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.

Value	Description
Default
PointInTimeRestore

PricingModel

Enumeration

Pricing model of Managed Instance.

Value	Description
Freemium
Regular

PrincipalType

Enumeration

Principal Type of the sever administrator.

Value	Description
Application
Group
User

ProvisioningState

Enumeration

Provisioning state of managed instance.

Value	Description
Canceled
Created
Failed
InProgress
Succeeded

ResourceIdentity

Object

Azure Active Directory identity configuration for a resource.

Name	Type	Description
principalId	string (uuid)	The Azure Active Directory principal id.
tenantId	string (uuid)	The Azure Active Directory tenant id.
type	IdentityType	The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource.
userAssignedIdentities	<string, UserIdentity>	The resource ids of the user assigned identities to use

ServicePrincipal

Object

The managed instance's service principal configuration for a resource.

Name	Type	Description
clientId	string	The Azure Active Directory application client id.
principalId	string	The Azure Active Directory application object id.
tenantId	string	The Azure Active Directory tenant id.
type	ServicePrincipalType	Service principal type.

ServicePrincipalType

Enumeration

Service principal type.

Value	Description
None
SystemAssigned

Sku

Object

An ARM Resource SKU.

Name	Type	Description
capacity	integer (int32)	Capacity of the particular SKU.
family	string	If the service has different generations of hardware, for the same SKU, then that can be captured here.
name	string	The name of the SKU, typically, a letter + Number code, e.g. P3.
size	string	Size of the particular SKU
tier	string	The tier or edition of the particular SKU, e.g. Basic, Premium.

UserIdentity

Object

Azure Active Directory identity configuration for a resource.

Name	Type	Description
clientId	string (uuid)	The Azure Active Directory client id.
principalId	string (uuid)	The Azure Active Directory principal id.

Share via

Managed Instances - Get

URI Parameters

Responses

Examples

Get managed instance

Sample request

Sample response

Get managed instance while resource is updating

Sample request

Sample response

Get managed instance with $expand=administrators/activedirectory

Sample request

Sample response

Definitions

AdministratorType

AuthMetadataLookupModes

BackupStorageRedundancy

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ExternalGovernanceStatus

HybridSecondaryUsage

HybridSecondaryUsageDetected

IdentityType

ManagedInstance

ManagedInstanceDatabaseFormat

ManagedInstanceExternalAdministrator

ManagedInstanceLicenseType

ManagedInstancePecProperty

ManagedInstancePrivateEndpointConnectionProperties

ManagedInstancePrivateEndpointProperty

ManagedInstancePrivateLinkServiceConnectionStateProperty

ManagedInstanceProxyOverride

ManagedServerCreateMode

PricingModel

PrincipalType

ProvisioningState

ResourceIdentity

ServicePrincipal

ServicePrincipalType

Sku

UserIdentity