Managed Instances - Stop

Service:

SQL Database

API Version:

2024-05-01-preview

Stops the managed instance.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/stop?api-version=2024-05-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.

Responses

Name	Type	Description
200 OK	ManagedInstance	Successfully stopped the managed instance.
202 Accepted		Stopping the managed instance is in progress.
Other Status Codes	ErrorResponse	*** Error Responses: *** 400 ManagementServiceStopManagedInstanceZoneRedundant - Stop executed on instance with zone redundancy enabled. 400 ManagementServiceStopManagedInstancePartOfFailoverGroup - Stop executed on the instance that is part of failover group. 400 NameAlreadyExists - The provided name already exists. 400 ManagementServiceStartStopManagedInstanceSubscriptionNotEnabledForFeature - User attempted to use Start/Stop feature without having the subscription allowlisted for the appropriate subscription feature. 400 ManagementServiceStopManagedInstanceNotSupportedOnSKU - Stop operation is not supported on the given SKU. 400 InvalidServerName - Invalid server name specified. 400 StartStopOfManagedInstanceIsDisabled - Start and stop operation on managed instance is not enabled. 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character. 400 ManagementServiceStopManagedInstanceUsingMILink - Stop executed on the instance that has Managed Instance link configured. 400 ManagementServiceStopManagedInstanceFeatureDisabled - User attempted to use the Stop Azure SQL Managed Instance feature, which is disabled. 400 ManagementServiceStopManagedInstanceHostedOnRdfePlatform - Stop executed on the instance that is not running with Feature Wave November 2022 400 InvalidServerName - Invalid server name specified. 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character. 400 TokenTooLong - The provided token is too long. 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription. 404 SubscriptionDoesNotHaveServer - The requested server was not found 404 OperationIdNotFound - The operation with Id does not exist. 404 ResourceNotFound - The requested resource was not found. 404 OperationIdNotFound - The operation with Id does not exist. 409 ManagementServiceStopManagedInstanceAlreadyInProgress - Stop operation submitted for operation that is in stopping/stopped state. 409 ManagementServiceStopManagedInstanceConflictingOperation - Stop Azure SQL Managed Instance conflicting operation message. 409 ManagementServiceStopManagedInstanceDroppedDuringStop - Stop executed on instance that is in deleting state or removed in the meantime. 409 SubscriptionDisabled - Subscription is disabled. 409 ManagementServiceStopManagedInstanceConflictingOperationOnInstancePool - Stop Azure SQL Managed Instance conflicting on instance pool operation message. 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled. 409 OperationCancelled - The operation has been cancelled by user. 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource. 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. 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation. 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.

Examples

Stops the managed instance.

Sample request

HTTP

POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/stoprg/providers/Microsoft.Sql/managedInstances/mitostop/stop?api-version=2024-05-01-preview

Sample response

Status code:

200

{
  "sku": {
    "name": "GP_Gen5",
    "tier": "GeneralPurpose",
    "capacity": 8,
    "family": "Gen5"
  },
  "properties": {
    "fullyQualifiedDomainName": "mitostop.1234567891234.database.windows.net",
    "administratorLogin": "dummylogin",
    "subnetId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/stoprg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1",
    "state": "Stopped",
    "provisioningState": "Succeeded",
    "vCores": 8,
    "storageSizeInGB": 1024,
    "licenseType": "LicenseIncluded",
    "collation": "SQL_Latin1_General_CP1_CI_AS",
    "publicDataEndpointEnabled": false,
    "proxyOverride": "Default",
    "minimalTlsVersion": "1.2",
    "dnsZone": "1234567891234",
    "instancePoolId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/stoprg/providers/Microsoft.Sql/instancePools/instancePool1",
    "maintenanceConfigurationId": "/subscriptions/00000000-1111-2222-3333-444444444444/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"
    },
    "externalGovernanceStatus": "Enabled",
    "hybridSecondaryUsage": "Passive",
    "authenticationMetadata": "Windows",
    "databaseFormat": "SQLServer2022"
  },
  "location": "japaneast",
  "tags": {
    "key": "value"
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/stoprg/providers/Microsoft.Sql/managedInstances/mitostop",
  "name": "mitostop",
  "type": "Microsoft.Sql/managedInstances"
}

Status code:

202

Location: /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/stoprg/providers/Microsoft.Sql/locations/westeurope/stopManagedInstanceOperationResults/11111111-1111-1111-1111-111111111111
Azure-AsyncOperation: /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/stoprg/providers/Microsoft.Sql/locations/westeurope/stopManagedInstanceAzureAsyncOperation/11111111-1111-1111-1111-111111111111

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

Type of the sever administrator.

Name	Type	Description
ActiveDirectory	string

AuthMetadataLookupModes

The managed instance's authentication metadata lookup mode.

Name	Type	Description
AzureAD	string
Paired	string
Windows	string

BackupStorageRedundancy

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

Name	Type	Description
Geo	string
GeoZone	string
Local	string
Zone	string

ErrorAdditionalInfo

The resource management error additional info.

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

ErrorDetail

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

Error response

Name	Type	Description
error	ErrorDetail	The error object.

ExternalGovernanceStatus

Status of external governance.

Name	Type	Description
Disabled	string
Enabled	string

HybridSecondaryUsage

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

Name	Type	Description
Active	string
Passive	string

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

Name	Type	Description
Active	string
Passive	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
SystemAssigned,UserAssigned	string
UserAssigned	string

ManagedInstance

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	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	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	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	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	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	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	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	Storage throughput MBps parameter is not supported in the instance create/update operation.
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.totalMemoryMB	integer	Total memory in MB. Minimum value: 7168. Maximum value: 891328. Increments of 1 MB allowed only. Maximum value depends on the selected hardware family and number of vCores.
properties.vCores	integer	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

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

Name	Type	Description
AlwaysUpToDate	string
SQLServer2022	string

ManagedInstanceExternalAdministrator

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	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	ManagedInstancePrivateEndpointConnectionProperties	Private endpoint connection properties

ManagedInstancePrivateEndpointConnectionProperties

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

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

PricingModel

Pricing model of Managed Instance.

Name	Type	Description
Freemium	string
Regular	string

PrincipalType

Principal Type of the sever administrator.

Name	Type	Description
Application	string
Group	string
User	string

ProvisioningState

Provisioning state of managed instance.

Name	Type	Description
Canceled	string
Created	string
Failed	string
InProgress	string
Succeeded	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	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

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

Service principal type.

Name	Type	Description
None	string
SystemAssigned	string

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.

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.