Managed Instances - Get

Gets a managed instance.

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

URI Parameters

Name In Required Type Description
subscriptionId
path True
  • string

The subscription ID that identifies an Azure subscription.

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.

managedInstanceName
path True
  • string

The name of the managed instance.

api-version
query True
  • string

The API version to use for the request.

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.

  • 404 SubscriptionDoesNotHaveManagedInstance - The requested managed instance was not found

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

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

  • 504 RequestTimeout - Service request exceeded the allowed timeout.

Examples

Get managed instance

Sample Request

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

Sample Response

{
  "sku": {
    "name": "CLS3",
    "tier": "Standard",
    "capacity": 1,
    "family": "Gen4"
  },
  "properties": {
    "fullyQualifiedDomainName": "testcl.1b4e2caff2530.database.windows.net",
    "administratorLogin": "cloudSA",
    "state": "Ready",
    "vCores": 8,
    "storageSizeInGB": 1024,
    "licenseType": "Full",
    "collation": "SQL_Latin1_General_CP1_CI_AS",
    "dnsZone": "1b4e2caff2530",
    "publicDataEndpointEnabled": false,
    "proxyOverride": "Default"
  },
  "location": "onebox",
  "id": "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testcl",
  "name": "testcl",
  "type": "Microsoft.Sql/managedInstances"
}

Definitions

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.

ManagedInstanceProxyOverride

Connection type used for connecting to the instance.

ResourceIdentity

Azure Active Directory identity configuration for a resource.

Sku

The resource model definition representing SKU

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
SystemAssigned
  • 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.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.licenseType
  • string

The license type. Possible values are 'LicenseIncluded' and 'BasePrice'.

properties.proxyOverride

Connection type used for connecting to the instance.

properties.publicDataEndpointEnabled
  • boolean

Whether or not the public data endpoint is enabled.

properties.state
  • string

The state of the managed instance.

properties.storageSizeInGB
  • integer

The maximum storage size in GB.

properties.subnetId
  • string

Subnet resource ID for the managed instance.

properties.vCores
  • integer

The number of VCores.

sku

Managed instance sku

tags
  • object

Resource tags.

type
  • string

Resource type.

ManagedInstanceProxyOverride

Connection type used for connecting to the instance.

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

ResourceIdentity

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.

Sku

The resource model definition representing SKU

Name Type Description
capacity
  • integer

If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.

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. Ex - P3. It is typically a letter+number code

size
  • string

The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.

tier
  • string

This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.