Managed Instances - Get

Gets a managed instance.

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

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

Successfully retrieved the specified managed instance.

Other Status Codes

*** Error Responses: ***

  • 400 SubscriptionNotFound - The requested subscription was not found.

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

  • 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes

  • 400 AadOnlyAuthenticationIsEnabled - Azure Active Directory Only Authentication is enabled. Please contact your system administrator.

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

  • 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.

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

  • 404 ResourceNotFound - The requested resource was not found.

  • 409 ConflictingManagedInstanceOperation - An operation is currently in progress for the managed instance.

  • 409 MiDropFailedOnAuthLocks - User tried to drop last Managed Instance in subnet that has Lock applied on resource(s).

  • 409 MiCreateFailedNonDelegatedSubnet - User tried to deploy Managed Instance or Managed Instance pool in subnet that is not delegated to Microsoft.Sql/managedInstances.

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

  • 504 RequestTimeout - Service request exceeded the allowed timeout.

  • 504 RequestTimeout - Service request exceeded the allowed timeout.

Examples

Get managed instance
Get managed instance with $expand=administrators

Get managed instance

Sample Request

GET https://management.azure.com/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testinstance?api-version=2020-11-01-preview

Sample Response

{
  "sku": {
    "name": "GP_Gen4",
    "tier": "GeneralPurpose",
    "capacity": 8,
    "family": "Gen4"
  },
  "properties": {
    "fullyQualifiedDomainName": "testinstance.1b4e2caff2530.database.windows.net",
    "administratorLogin": "dummylogin",
    "subnetId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/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/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/testrg/providers/Microsoft.Sql/instancePools/instancePool1",
    "maintenanceConfigurationId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_JapanEast_MI_1",
    "storageAccountType": "GRS"
  },
  "location": "japaneast",
  "tags": {
    "key": "value"
  },
  "id": "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testinstance",
  "name": "testinstance",
  "type": "Microsoft.Sql/managedInstances"
}

Get managed instance with $expand=administrators

Sample Request

GET https://management.azure.com/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testinstance?api-version=2020-11-01-preview

Sample Response

{
  "sku": {
    "name": "GP_Gen4",
    "tier": "GeneralPurpose",
    "capacity": 8,
    "family": "Gen4"
  },
  "properties": {
    "fullyQualifiedDomainName": "testinstance.1b4e2caff2530.database.windows.net",
    "administratorLogin": "dummylogin",
    "subnetId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/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/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/testrg/providers/Microsoft.Sql/instancePools/instancePool1",
    "maintenanceConfigurationId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_JapanEast_MI_1",
    "storageAccountType": "GRS",
    "administrators": {
      "principalType": "User",
      "login": "bob@contoso.com",
      "sid": "00000011-1111-2222-2222-123456789111",
      "tenantId": "00000011-1111-2222-2222-123456789111",
      "azureADOnlyAuthentication": true
    }
  },
  "location": "japaneast",
  "tags": {
    "key": "value"
  },
  "id": "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testinstance",
  "name": "testinstance",
  "type": "Microsoft.Sql/managedInstances"
}

Definitions

AdministratorType

Type of the sever administrator.

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.

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.

PrincipalType

Principal Type of the sever administrator.

ResourceIdentityWithUserAssignedIdentities

Azure Active Directory identity configuration for a resource.

Sku

An ARM Resource SKU.

StorageAccountType

The storage account type used to store backups for this instance. The options are LRS (LocallyRedundantStorage), ZRS (ZoneRedundantStorage) and GRS (GeoRedundantStorage)

UserIdentity

Azure Active Directory identity configuration for a resource.

AdministratorType

Type of the sever administrator.

Name Type Description
ActiveDirectory
  • string

IdentityType

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

Name Type Description
None
  • string
SystemAssigned
  • string
UserAssigned
  • string

ManagedInstance

An Azure SQL managed instance.

Name Type Description
id
  • string

Resource ID.

identity

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

The Azure Active Directory administrator of the server.

properties.collation
  • string

Collation of the managed instance.

properties.dnsZone
  • string

The Dns Zone that the managed instance is in.

properties.dnsZonePartner
  • string

The resource id of another managed instance whose DNS zone this managed instance will share after creation.

properties.fullyQualifiedDomainName
  • string

The fully qualified domain name of the managed instance.

properties.instancePoolId
  • string

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

properties.keyId
  • string

A CMK URI of the key to use for encryption.

properties.licenseType

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

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.primaryUserAssignedIdentityId
  • string

The resource id of a user assigned identity to be used by default.

properties.privateEndpointConnections

List of private endpoint connections on a managed instance.

properties.provisioningState enum:
  • Creating
  • Deleting
  • Failed
  • Succeeded
  • Unknown
  • Updating
properties.proxyOverride

Connection type used for connecting to the instance.

properties.publicDataEndpointEnabled
  • boolean

Whether or not the public data endpoint is enabled.

properties.restorePointInTime
  • string

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

properties.sourceManagedInstanceId
  • string

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

The storage account type used to store backups for this instance. The options are LRS (LocallyRedundantStorage), ZRS (ZoneRedundantStorage) and GRS (GeoRedundantStorage)

properties.storageSizeInGB
  • integer

Storage size in GB. Minimum value: 32. Maximum value: 8192. Increments of 32 GB allowed only.

properties.subnetId
  • string

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

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

properties.zoneRedundant
  • boolean

Whether or not the multi-az is enabled.

sku

Managed instance SKU. Allowed values for sku.name: GP_Gen4, GP_Gen5, BC_Gen4, BC_Gen5

tags
  • object

Resource tags.

type
  • string

Resource type.

ManagedInstanceExternalAdministrator

Properties of a active directory administrator.

Name Type Description
administratorType

Type of the sever administrator.

azureADOnlyAuthentication
  • boolean

Azure Active Directory only Authentication enabled.

login
  • string

Login name of the server administrator.

principalType

Principal Type of the sever administrator.

sid
  • string

SID (object ID) of the server administrator.

tenantId
  • string

Tenant ID of the 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).

Name Type Description
BasePrice
  • string
LicenseIncluded
  • string

ManagedInstancePecProperty

A private endpoint connection under a managed instance

Name Type Description
id
  • string

Resource ID.

properties

Private endpoint connection properties

ManagedInstancePrivateEndpointConnectionProperties

Properties of a private endpoint connection.

Name Type Description
privateEndpoint

Private endpoint which the connection belongs to.

privateLinkServiceConnectionState

Connection State of the Private Endpoint Connection.

provisioningState
  • string

State of the Private Endpoint Connection.

ManagedInstancePrivateEndpointProperty

Name Type Description
id
  • string

Resource id of the private endpoint.

ManagedInstancePrivateLinkServiceConnectionStateProperty

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

Connection type used for connecting to the instance.

Name Type Description
Default
  • string
Proxy
  • string
Redirect
  • string

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.

Name Type Description
Default
  • string
PointInTimeRestore
  • string

PrincipalType

Principal Type of the sever administrator.

Name Type Description
Application
  • string
Group
  • string
User
  • string

ResourceIdentityWithUserAssignedIdentities

Azure Active Directory identity configuration for a resource.

Name Type Description
principalId
  • string

The Azure Active Directory principal id.

tenantId
  • string

The Azure Active Directory tenant id.

type

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

userAssignedIdentities

The resource ids of the user assigned identities to use

Sku

An ARM Resource SKU.

Name Type Description
capacity
  • integer

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.

StorageAccountType

The storage account type used to store backups for this instance. The options are LRS (LocallyRedundantStorage), ZRS (ZoneRedundantStorage) and GRS (GeoRedundantStorage)

Name Type Description
GRS
  • string
LRS
  • string
ZRS
  • string

UserIdentity

Azure Active Directory identity configuration for a resource.

Name Type Description
clientId
  • string

The Azure Active Directory client id.

principalId
  • string

The Azure Active Directory principal id.