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

  • reference
Serve:
SQL database
API version:
2022-08-01-Preview

Get a list of all managed instances in your subscription.

Download https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Sql/managedInstances?api-version=2022-08-01-preview

Use optional parameters:

Download https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Sql/managedInstances?$expand={$expand}&api-version=2022-08-01-preview

Parameter URI

Nameexistnecessarytypdescribe

SubscriptionID

pathtrue

string

Subscription ID that identifies your Azure subscription.

API version

asktrue

string

The API version used in the request.

$expand

ask

string

Sub-resources to include in the response.

react

Nametypdescribe
200 good

Managed instances list results

Successfully fetched list of managed instances.

other status codes

*** Error response: ***

example

list managed instances
List managed instances with $expand=administrators/activedirectory

list managed instances

ask for samples

  • HTTP
  • Python
  • JavaScript
Download https://management.azure.com/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/providers/Microsoft.Sql/managedInstances?api-version=2022-08-01-preview

sample answer

Status code:
200
{ "value": [ { "location": "japaneast", "id": "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/Test1/providers/Microsoft.Sql/managedInstances/testinstance1", "name ": "testinstance1", "type": "Microsoft.Sql/managedInstances", "sku": { "name": "GP_Gen4", "layer": "general", "capacity": 8, "series":" GEN4"},"Properties": {"FullyqualiFiedDomainname":"TestInstance1.1b4e2caff2530.dataBase.windows.net","AdministratorLogin":"Dummylogin","Sub"Netid":/Subscriptions/20D7082A-0C7-4468-82BD- 542694D5042B /resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", "state": "Done", "provisioningState": "success", "virtual cores": 8, "storageSizeInGB": 1024, " licenseType ": "LicenseIncluded", "collation": "SQL_Latin1_General_CP1_CI_AS", "publicDataEndpointEnabled": false, "proxyOverride": "default", "minimalTlsVersion": "1.2", "dnsZone": "1b4e2caff2530", "maintenanceConfigurationId": " /subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/PROVIRES/MICROSOFT.MAINTENCES/pastionMaintMaintEnanceConfigurations/sql_jjapaneast_mi_1 "Japan", "id": "/subscriptions/20d7082a-0fc7-4468-82bd-54 26 9 4d5042b/resourceGroups/Test1 /providers/Microsoft.Sql/managedInstances/testinstance2", "name": "testinstance2", "type": "Microsoft.Sql/managedInstances", "sku": { "name": "BC_Gen5", "tier": " BusinessCritical", "capacity": 16, "family": "Gen4" }, "properties": { "fullQualifiedDomainName": "testinstance2.2c3d1bdae3412.database.windows.net", "administratorLogin": "dummylogin", "subnetId" : " /subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/vnet2/subnet/subnet2", "state": "ready", "provisioningState": "success", "virtual cores": 16, "storageSizeInGB": 1024, "licenseType": "Full", "sort": "SQL_Latin1_General_CP1_CI_AS", "publicDataEndpointEnabled": false, "proxyOverride": "Default", "minimalTlsVersion": "1.2" , "dnsZone": "2c3d1bdae3412", "maintenanceConfigurationId": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_JapanEast_MI_1", "currentBackupS storageRedundancy": "G eo", "request edBackupStorageRedundancy ": "geo" } } ]}

List managed instances with $expand=administrators/activedirectory

ask for samples

  • HTTP
  • Python
  • JavaScript
Download https://management.azure.com/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/providers/Microsoft.Sql/managedInstances?api-version=2022-08-01-preview

sample answer

Status code:
200
{ "value": [ { "location": "japaneast", "id": "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/Test1/providers/Microsoft.Sql/managedInstances/testinstance1", "name ": "testinstance1", "type": "Microsoft.Sql/managedInstances", "sku": { "name": "GP_Gen4", "layer": "general", "capacity": 8, "series":" GEN4"},"Properties": {"FullyqualiFiedDomainname":"TestInstance1.1b4e2caff2530.dataBase.windows.net","AdministratorLogin":"DummyLogin","Sub"Netid":/Subscriptions/20D7082A-0C7-4468-82BD- 542694D5042B /resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", "state": "Done", "provisioningState": "success", "virtual cores": 8, "storageSizeInGB": 1024, " licenseType ": "LicenseIncluded", "collation": "SQL_Latin1_General_CP1_CI_AS", "publicDataEndpointEnabled": false, "proxyOverride": "default", "minimalTlsVersion": "1.2", "dnsZone": "1b4e2caff2530", "maintenanceConfigurationId": " /Subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_JapanEast_MI_1", "currentBackupStorageRedundancy": "Geo", "requestedBackupStorageRedundancy": "Geo", "administrators": { "pri ncip alTyp" :" user", "login": "bob@contoso.com", "sid": "00000011-1111-2222-2222-123456789111", "tenantId": "00000011-1111-2222-2222-123456789111", " azureADOnlyAuthentication" :true}}},{"location":"japaneast", "id":"/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/Test1/providers/Microsoft.Sql/managedInstances/testinstance2", "name": "testinstance2", "type": "Microsoft.Sql/managedInstances", "sku": { "name": "BC_Gen5", "tier": "BusinessCritical", "capacity": 16, "family" : " Gen4 " }, "properties": { "fullyQualifiedDomainName": "testinstance2.2c3d1bdae3412.database.windows.net", "administratorLogin": "dummylogin", "subnetId": "/subscriptions/20D7082A-0FC7-4468-82BD -542694D5042B /resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/subnet2", "state": "Done", "provisioningState": "success", "virtual cores": 16, "storageSizeInGB": 1024, " licenseType ": "full", "collation": "SQL_Latin1_General_CP1_CI_AS", "publicDataEndpointEnabled": false, "proxyOverride": "default", "minimalTlsVersion": "1.2", "dnsZone": "2c3d1bdae3412", "maintenanceConfigurationId ": " /Subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_JapanEast_MI_2", "currentBackupStorageRedundancy": "Geo", "requestedBackupStorageRedundancy": "Geo", "administrators": { "princip alTyp": " "User". thecentication " : true } } } ]}

definition

Namedescribe
administrator type

Server admin type.

backup storage redundancy

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

identity type

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

managed instance

Azure SQL Managed Instance.

External administrator of the managed instance

Atrybuty administratora Active Directory.

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

Managed instances list results

List of managed instances.

ManagedInstancePecProperty

Private endpoint connections within managed instances

ManagedInstancePrivateEndpointConnectionProperties

Private endpoint connection properties.

ManagedInstancePrivateEndpointProperty
ManagedInstancePrivateLinkServiceConnectionStateProperty
ManagedInstanceProxyOverride

The type of connection used to connect to the 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.

entity type

The main type for server administrators.

Resource ID

Azure Active Directory identity configuration for the resource.

the object of the service

Configuration of the service principal for the managed resource instance.

The main type of service

The main type of service.

Sku

ARM resource SKUs.

User ID

Azure Active Directory identity configuration for the resource.

administrator type

Server admin type.

Nametypdescribe
active directory

string

backup storage redundancy

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

Nametypdescribe
geography

string

geographical area

string

Local

string

district

string

identity type

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

Nametypdescribe
no

string

system allocation

string

system assignment, user assignment

string

user assignment

string

managed instance

Azure SQL Managed Instance.

Nametypdescribe
ID

string

Resource ID.

identity

Resource ID

The Azure Active Directory identity for the managed instance.

Place

string

resource location.

Name

string

Resource name.

Property.adminLogin

string

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

attribute.administratorLoginPassword

string

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

properties.admins

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.

properties list

string

Managed instance sorting.

properties.currentBackupStorageRedundancja

backup storage redundancy

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

properties.dnsStrefa

string

The DNS zone where the managed instance is located.

properties.dnsZonePartner

string

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

properties.fully qualifiedDomainName

string

The fully qualified domain name of the managed instance.

atrybut.instancePoolId

string

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

property.keyId

string

The CMK URI of the key used for encryption.

property.License type

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

Property.maintenanceConfigurationId

string

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

atrybut.managedInstanceCreateMode

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.

property.minimalTlsVersion

string

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

properties.primaryUserAssignedIdentityId

string

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

properties.privateEndpointConnections

ManagedInstancePecProperty[]

A list of private endpoint connections on the managed instance.

properties.provisioningStatecalculate:
  • adopted
  • Cancel
  • Created
  • create
  • deleted
  • remove
  • Malfunction
  • NOSpecified
  • register
  • action
  • it worked
  • timinggo out
  • unknown
  • unrecognizable
  • update
property.proxyOverride

ManagedInstanceProxyOverride

The type of connection used to connect to the instance.

properties.publicDataEndpointEnabled

A logical value

Specifies whether to enable the public data endpoint.

properties.requestedBackupStorageRedundancja

backup storage redundancy

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

property.restorePointInTime

string

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

properties.servicePrincipal

the object of the service

The service principal for the managed instance.

Property.sourceManagedInstanceId

string

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

property.state

string

Managed instance status.

property.storageSizeInGB

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.

property.subnet ID

string

Managed instance subnet resource ID.

property.timezoneId

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

properties. Virtual cores

integer

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

properties.zoneZbędne

A logical value

Whether the multi-az function is enabled.

warehouse

Sku

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

Label

Intention

resource tag.

typ

string

Resource type.

External administrator of the managed instance

Atrybuty administratora Active Directory.

Nametypdescribe
administrator type

administrator type

Server admin type.

azureADOnlyAuthentication

A logical value

Authentication is only enabled for Azure Active Directory.

Log in

string

The login name of the server administrator.

entity type

entity type

The main type for server administrators.

Database

string

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

tenant ID

string

Admin tenant ID.

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

Nametypdescribe
basic price

string

license included

string

Managed instances list results

List of managed instances.

Nametypdescribe
next link

string

Link to download next page of results.

value

managed instance[]

score board.

ManagedInstancePecProperty

Private endpoint connections within managed instances

Nametypdescribe
ID

string

Resource ID.

Characteristic

ManagedInstancePrivateEndpointConnectionProperties

Private endpoint connection properties

ManagedInstancePrivateEndpointConnectionProperties

Private endpoint connection properties.

Nametypdescribe
private endpoint

ManagedInstancePrivateEndpointProperty

The private endpoint to which the connection belongs.

Connection status to the private link service

ManagedInstancePrivateLinkServiceConnectionStateProperty

Private endpoint connection status.

configuration status

string

Private endpoint connection status.

ManagedInstancePrivateEndpointProperty

Nametypdescribe
ID

string

The resource ID of the private endpoint.

ManagedInstancePrivateLinkServiceConnectionStateProperty

Nametypdescribe
action is needed

string

A description of the private link service connection.

describe

string

A description of the private link service connection.

status

string

Connection status to the private link service.

ManagedInstanceProxyOverride

The type of connection used to connect to the instance.

Nametypdescribe
default

string

agent

string

redirect

string

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.

Nametypdescribe
default

string

point in time restoration

string

entity type

The main type for server administrators.

Nametypdescribe
app

string

Group

string

user

string

Resource ID

Azure Active Directory identity configuration for the resource.

Nametypdescribe
Entity ID

string

Azure Active Directory Subject ID.

tenant ID

string

Azure Active Directory tenant ID.

typ

identity type

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

user-assigned identity

User ID>

The resource ID of the user-assigned identity to use

the object of the service

Configuration of the service principal for the managed resource instance.

Nametypdescribe
Client number

string

Azure Active Directory application client ID.

Entity ID

string

The object ID of the Azure Active Directory application.

tenant ID

string

Azure Active Directory tenant ID.

typ

The main type of service

The main type of service.

The main type of service

The main type of service.

Nametypdescribe
no

string

system allocation

string

Sku

ARM resource SKUs.

Nametypdescribe
capacity

integer

The capacity of a specific SKU.

family

string

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

Name

string

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

size

string

Dimensions for specific SKUs

degree

string

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

User ID

Azure Active Directory identity configuration for the resource.

Nametypdescribe
Client number

string

Identyfikator klienta Azure Active Directory.

Entity ID

string

Azure Active Directory Subject ID.

Top Articles
Latest Posts
Article information

Author: Rev. Leonie Wyman

Last Updated: 06/06/2023

Views: 5263

Rating: 4.9 / 5 (59 voted)

Reviews: 82% of readers found this page helpful

Author information

Name: Rev. Leonie Wyman

Birthday: 1993-07-01

Address: Suite 763 6272 Lang Bypass, New Xochitlport, VT 72704-3308

Phone: +22014484519944

Job: Banking Officer

Hobby: Sailing, Gaming, Basketball, Calligraphy, Mycology, Astronomy, Juggling

Introduction: My name is Rev. Leonie Wyman, I am a colorful, tasty, splendid, fair, witty, gorgeous, splendid person who loves writing and wants to share my knowledge and understanding with you.