Partager via


Managed Instances - Get

Obtient une instance managée.

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

Paramètres URI

Nom Dans Obligatoire Type Description
managedInstanceName
path True

string

Nom de l'instance managée.

resourceGroupName
path True

string

Nom du groupe de ressources qui contient la ressource. Vous pouvez obtenir cette valeur à partir de l’API Azure Resource Manager ou du portail.

subscriptionId
path True

string

L’ID d’abonnement d’un abonnement Azure.

api-version
query True

string

Version de l’API à utiliser pour la requête.

$expand
query

string

Ressources enfants à inclure dans la réponse.

Réponses

Nom Type Description
200 OK

ManagedInstance

Récupération réussie de l’instance managée spécifiée.

Other Status Codes

Réponses d’erreur : ***

  • 400 MiGeoRestoreWithWrongBackupStorageRedundancy : Geo-Restore n’est pas autorisé pour les instances managées avec redondance du stockage de sauvegarde LRS/ZRS.

  • 400 UpdatingInstanceAndBackupRedundancy - La redondance de zone d’instance et la redondance du stockage de sauvegarde ne peuvent pas être mises à jour dans la même requête.

  • 400 ProvisioningDisabled : affiche le message d’erreur de l’autorisation d’opération des ressources en l’état, sans modification

  • 400 AadOnlyAuthenticationIsEnabled : l’authentification Azure Active Directory uniquement est activée. Contactez votre administrateur système.

  • 400 ManagementServiceFeatureDisabled : l’utilisateur a tenté d’utiliser une fonctionnalité désactivée.

  • 404 SubscriptionNotFound : l’abonnement demandé est introuvable.

  • 404 ServerNotInSubscription : le serveur spécifié n’existe pas sur l’abonnement spécifié.

  • 404 ManagedInstanceNotInSubscriptionResourceGroup : le instance managé spécifié n’existe pas dans le groupe de ressources et l’abonnement spécifiés.

  • 404 SubscriptionNotFound : l’abonnement demandé est introuvable.

  • 404 ResourceNotFound : la ressource demandée est introuvable.

  • 409 ConflictingManagedInstanceOperation : une opération est actuellement en cours pour le instance managé.

  • 409 BackupRedundancyUpdateAndInstanceRedundancyConflict : le instance est multi-az, mais le stockage de sauvegarde est mis à jour de redondant interzone à non redondant interzone.

  • 409 InstanceRedundancyUpdateWhileBackupRedundancyUpdateInProgress : impossible de mettre à jour instance redondance, car la mise à jour de la redondance du stockage de sauvegarde est en cours.

  • 409 InstanceRedundancyUpdateAndBackupRedundancyConflict : le stockage de sauvegarde n’est pas redondant interzone, mais instance redondance est mise à jour vers une redondance interzone.

  • 409 BackupRedundancyUpdateConflict : impossible de mettre à jour la redondance du stockage de sauvegarde, car une mise à jour de la redondance du stockage de sauvegarde est déjà en cours.

  • 409 MiDropFailedOnAuthLocks : l’utilisateur a essayé de supprimer la dernière Managed Instance dans le sous-réseau auquel le verrou a été appliqué sur la ou les ressources.

  • 409 MiCreateFailedNonDelegatedSubnet : l’utilisateur a essayé de déployer Managed Instance ou Managed Instance pool dans un sous-réseau qui n’est pas délégué à Microsoft.Sql/managedInstances.

  • 412 InstanceNotReadyForBackupRedundancyUpdate : impossible de mettre à jour la redondance du stockage de sauvegarde, car le instance n’est pas prêt.

  • 429 SubscriptionTooManyCreateUpdateRequests : demandes au-delà du nombre maximal de requêtes pouvant être traitées par les ressources disponibles.

  • 429 SubscriptionTooManyRequests : demandes au-delà du nombre maximal de requêtes pouvant être traitées par les ressources disponibles.

  • 429 SubscriptionTooManyCreateUpdateRequests : demandes au-delà du nombre maximal de requêtes pouvant être traitées par les ressources disponibles.

  • 429 SubscriptionTooManyRequests : demandes au-delà du nombre maximal de requêtes pouvant être traitées par les ressources disponibles.

  • 429 ConflictingSubscriptionOperation : une opération est actuellement en cours pour l’abonnement.

  • 503 TooManyRequests : demandes au-delà du nombre maximal de demandes pouvant être traitées par les ressources disponibles.

  • 503 TooManyRequests : demandes au-delà du nombre maximal de demandes pouvant être traitées par les ressources disponibles.

  • 504 RequestTimeout - La demande de service a dépassé le délai d’expiration autorisé.

  • 504 RequestTimeout - La demande de service a dépassé le délai d’expiration autorisé.

Exemples

Get managed instance
Get managed instance with $expand=administrators/activedirectory

Get managed instance

Exemple de requête

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

Exemple de réponse

{
  "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",
    "currentBackupStorageRedundancy": "Geo",
    "requestedBackupStorageRedundancy": "Geo",
    "servicePrincipal": {
      "principalId": "00000011-1111-2222-2222-123456789111",
      "clientId": "00000011-1111-2222-2222-123456789111",
      "tenantId": "00000011-1111-2222-2222-123456789111",
      "type": "SystemAssigned"
    }
  },
  "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/activedirectory

Exemple de requête

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

Exemple de réponse

{
  "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",
    "currentBackupStorageRedundancy": "Geo",
    "requestedBackupStorageRedundancy": "Geo",
    "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"
}

Définitions

Nom Description
AdministratorType

Type de l’administrateur de serveur.

BackupStorageRedundancy

Type de compte de stockage utilisé pour stocker les sauvegardes pour cette instance. Les options sont Local (LocalRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) et GeoZone(GeoZoneRedundantStorage).

IdentityType

Type d’identité. Définissez cette valeur sur « SystemAssigned » afin de créer et d’affecter automatiquement un principal Azure Active Directory pour la ressource.

ManagedInstance

Une instance managée Azure SQL.

ManagedInstanceExternalAdministrator

Propriétés d’un administrateur Active Directory.

ManagedInstanceLicenseType

Type de licence. Les valeurs possibles sont « LicenseIncluded » (prix normal incluant une nouvelle licence SQL) et « BasePrice » (prix AHB réduit pour apporter vos propres licences SQL).

ManagedInstancePecProperty

Une connexion de point de terminaison privé sous un instance managé

ManagedInstancePrivateEndpointConnectionProperties

Propriétés d’une connexion de point de terminaison privé.

ManagedInstancePrivateEndpointProperty
ManagedInstancePrivateLinkServiceConnectionStateProperty
ManagedInstanceProxyOverride

Type de connexion utilisé pour la connexion au instance.

ManagedServerCreateMode

Spécifie le mode de création de la base de données.

Valeur par défaut : création de instance standard.

Restauration : crée un instance en restaurant un ensemble de sauvegardes à un point spécifique dans le temps. RestorePointInTime et SourceManagedInstanceId doivent être spécifiés.

PrincipalType

Type principal de l’administrateur de serveur.

ResourceIdentity

Configuration d’identité Azure Active Directory pour une ressource.

ServicePrincipal

Configuration du principal de service du instance managé pour une ressource.

ServicePrincipalType

Type de principal de service.

Sku

Référence SKU de ressource ARM.

UserIdentity

Configuration d’identité Azure Active Directory pour une ressource.

AdministratorType

Type de l’administrateur de serveur.

Nom Type Description
ActiveDirectory

string

BackupStorageRedundancy

Type de compte de stockage utilisé pour stocker les sauvegardes pour cette instance. Les options sont Local (LocalRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) et GeoZone(GeoZoneRedundantStorage).

Nom Type Description
Geo

string

GeoZone

string

Local

string

Zone

string

IdentityType

Type d’identité. Définissez cette valeur sur « SystemAssigned » afin de créer et d’affecter automatiquement un principal Azure Active Directory pour la ressource.

Nom Type Description
None

string

SystemAssigned

string

SystemAssigned,UserAssigned

string

UserAssigned

string

ManagedInstance

Une instance managée Azure SQL.

Nom Type Description
id

string

ID de la ressource

identity

ResourceIdentity

Identité Azure Active Directory du instance managé.

location

string

Emplacement de la ressource.

name

string

Nom de la ressource.

properties.administratorLogin

string

Nom d’utilisateur administrateur pour le instance managé. Ne peut être spécifié que lorsque le instance managé est en cours de création (et est requis pour la création).

properties.administratorLoginPassword

string

Mot de passe de connexion administrateur (requis pour la création de instance managés).

properties.administrators

ManagedInstanceExternalAdministrator

Administrateur Azure Active Directory du serveur.

properties.collation

string

Classement des instance managés.

properties.currentBackupStorageRedundancy

BackupStorageRedundancy

Type de compte de stockage utilisé pour stocker les sauvegardes pour cette instance. Les options sont Local (LocalRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) et GeoZone(GeoZoneRedundantStorage).

properties.dnsZone

string

Zone DNS dans laquelle se trouve le instance managé.

properties.dnsZonePartner

string

ID de ressource d’un autre instance managé dont la zone DNS que cette instance managée partagera après sa création.

properties.fullyQualifiedDomainName

string

Nom de domaine complet du instance managé.

properties.instancePoolId

string

ID du pool de instance auquel appartient ce serveur managé.

properties.keyId

string

URI CMK de la clé à utiliser pour le chiffrement.

properties.licenseType

ManagedInstanceLicenseType

Type de licence. Les valeurs possibles sont « LicenseIncluded » (prix normal incluant une nouvelle licence SQL) et « BasePrice » (prix AHB réduit pour apporter vos propres licences SQL).

properties.maintenanceConfigurationId

string

Spécifie l’ID de configuration de maintenance à appliquer à cette instance managée.

properties.managedInstanceCreateMode

ManagedServerCreateMode

Spécifie le mode de création de la base de données.

Valeur par défaut : création de instance standard.

Restauration : crée un instance en restaurant un ensemble de sauvegardes à un point spécifique dans le temps. RestorePointInTime et SourceManagedInstanceId doivent être spécifiés.

properties.minimalTlsVersion

string

Version TLS minimale. Valeurs autorisées : « None », « 1.0 », « 1.1 », « 1.2 »

properties.primaryUserAssignedIdentityId

string

ID de ressource d’une identité affectée par l’utilisateur à utiliser par défaut.

properties.privateEndpointConnections

ManagedInstancePecProperty[]

Liste des connexions de point de terminaison privé sur un instance managé.

properties.provisioningState enum:
  • Accepted
  • Canceled
  • Created
  • Creating
  • Deleted
  • Deleting
  • Failed
  • NotSpecified
  • Registering
  • Running
  • Succeeded
  • TimedOut
  • Unknown
  • Unrecognized
  • Updating
properties.proxyOverride

ManagedInstanceProxyOverride

Type de connexion utilisé pour la connexion au instance.

properties.publicDataEndpointEnabled

boolean

Indique si le point de terminaison de données public est activé ou non.

properties.requestedBackupStorageRedundancy

BackupStorageRedundancy

Type de compte de stockage à utiliser pour stocker les sauvegardes pour cette instance. Les options sont Local (LocalRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) et GeoZone(GeoZoneRedundantStorage).

properties.restorePointInTime

string

Spécifie le point dans le temps (format ISO8601) de la base de données source qui sera restaurée pour créer la nouvelle base de données.

properties.servicePrincipal

ServicePrincipal

Principal de service du instance managé.

properties.sourceManagedInstanceId

string

Identificateur de ressource de l’instance managée source associée à l’opération de création de ce instance.

properties.state

string

État du instance managé.

properties.storageSizeInGB

integer

Taille de stockage en Go. Valeur minimale : 32. Valeur maximale : 16384. Incréments de 32 Go autorisés uniquement. La valeur maximale dépend de la famille de matériel sélectionnée et du nombre de vCores.

properties.subnetId

string

ID de ressource de sous-réseau pour le instance managé.

properties.timezoneId

string

ID du fuseau horaire. Les valeurs autorisées sont des fuseaux horaires pris en charge par Windows. Windows conserve les détails des fuseaux horaires pris en charge, y compris l’ID, dans le Registre sous KEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Fuseaux horaires. Vous pouvez obtenir ces valeurs de Registre via SQL Server en interrogeant select name as timezone_id FROM sys.time_zone_info. La liste des ID peut également être obtenue en exécutant [System.TimeZoneInfo] ::GetSystemTimeZones() dans PowerShell. Un exemple d’ID de fuseau horaire valide est « Heure standard du Pacifique » ou « W. Heure standard de l’Europe ».

properties.vCores

integer

Nombre de vCores. Valeurs autorisées : 8, 16, 24, 32, 40, 64, 80.

properties.zoneRedundant

boolean

Indique si le multi-az est activé ou non.

sku

Sku

Référence SKU instance managée. Valeurs autorisées pour sku.name : GP_Gen5, GP_G8IM, GP_G8IH, BC_Gen5, BC_G8IM, BC_G8IH

tags

object

Balises de ressource.

type

string

Type de ressource.

ManagedInstanceExternalAdministrator

Propriétés d’un administrateur Active Directory.

Nom Type Description
administratorType

AdministratorType

Type de l’administrateur de serveur.

azureADOnlyAuthentication

boolean

Authentification Azure Active Directory uniquement activée.

login

string

Nom de connexion de l’administrateur du serveur.

principalType

PrincipalType

Type de principal de l’administrateur de serveur.

sid

string

SID (ID d’objet) de l’administrateur du serveur.

tenantId

string

ID de locataire de l’administrateur.

ManagedInstanceLicenseType

Type de licence. Les valeurs possibles sont « LicenseIncluded » (prix normal incluant une nouvelle licence SQL) et « BasePrice » (prix AHB réduit pour apporter vos propres licences SQL).

Nom Type Description
BasePrice

string

LicenseIncluded

string

ManagedInstancePecProperty

Une connexion de point de terminaison privé sous un instance managé

Nom Type Description
id

string

ID de la ressource

properties

ManagedInstancePrivateEndpointConnectionProperties

Propriétés de connexion de point de terminaison privé

ManagedInstancePrivateEndpointConnectionProperties

Propriétés d’une connexion de point de terminaison privé.

Nom Type Description
privateEndpoint

ManagedInstancePrivateEndpointProperty

Point de terminaison privé auquel appartient la connexion.

privateLinkServiceConnectionState

ManagedInstancePrivateLinkServiceConnectionStateProperty

État de la connexion de la connexion de point de terminaison privé.

provisioningState

string

État de la connexion de point de terminaison privé.

ManagedInstancePrivateEndpointProperty

Nom Type Description
id

string

ID de ressource du point de terminaison privé.

ManagedInstancePrivateLinkServiceConnectionStateProperty

Nom Type Description
actionsRequired

string

Description de la connexion au service de liaison privée.

description

string

Description de la connexion au service de liaison privée.

status

string

La connexion au service de liaison privée status.

ManagedInstanceProxyOverride

Type de connexion utilisé pour la connexion au instance.

Nom Type Description
Default

string

Proxy

string

Redirect

string

ManagedServerCreateMode

Spécifie le mode de création de la base de données.

Valeur par défaut : création de instance standard.

Restauration : crée un instance en restaurant un ensemble de sauvegardes à un point spécifique dans le temps. RestorePointInTime et SourceManagedInstanceId doivent être spécifiés.

Nom Type Description
Default

string

PointInTimeRestore

string

PrincipalType

Type principal de l’administrateur de serveur.

Nom Type Description
Application

string

Group

string

User

string

ResourceIdentity

Configuration d’identité Azure Active Directory pour une ressource.

Nom Type Description
principalId

string

ID du principal Azure Active Directory.

tenantId

string

ID de locataire Azure Active Directory.

type

IdentityType

Type d’identité. Définissez cette valeur sur « SystemAssigned » afin de créer et d’affecter automatiquement un principal Azure Active Directory pour la ressource.

userAssignedIdentities

<string,  UserIdentity>

ID de ressource des identités affectées par l’utilisateur à utiliser

ServicePrincipal

Configuration du principal de service du instance managé pour une ressource.

Nom Type Description
clientId

string

ID client de l’application Azure Active Directory.

principalId

string

ID d’objet de l’application Azure Active Directory.

tenantId

string

ID de locataire Azure Active Directory.

type

ServicePrincipalType

Type de principal de service.

ServicePrincipalType

Type de principal de service.

Nom Type Description
None

string

SystemAssigned

string

Sku

Référence SKU de ressource ARM.

Nom Type Description
capacity

integer

Capacité de la référence SKU particulière.

family

string

Si le service a différentes générations de matériel, pour la même référence SKU, cela peut être capturé ici.

name

string

Nom de la référence SKU, généralement une lettre + un code numérique, par exemple P3.

size

string

Taille de la référence SKU particulière

tier

string

Niveau ou édition de la référence SKU particulière, par exemple De base, Premium.

UserIdentity

Configuration d’identité Azure Active Directory pour une ressource.

Nom Type Description
clientId

string

ID client Azure Active Directory.

principalId

string

ID du principal Azure Active Directory.