Managed Instances - Refresh Status

Service:: SQL Database

API Version:: 2023-08-01

Refresh external governance enablement status.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/refreshExternalGovernanceStatus?api-version=2023-08-01

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	RefreshExternalGovernanceStatusOperationResultMI	Successfully refreshed external governance enablement status.
202 Accepted		Refreshing external governance enablement status. Headers Location: string
Other Status Codes	ErrorResponse	* Error Responses: * 400 SubnetMissingRequiredDelegation - Selected subnet is not delegated for SQL Managed Instance. 404 ManagedInstanceNotInSubscriptionResourceGroup - Specified managed instance does not exist in the specified resource group and subscription. 404 SubscriptionNotFound - The requested subscription was not found. 404 ServerNotInSubscription - Specified server does not exist on the specified subscription. 404 OperationIdNotFound - The operation with Id does not exist. 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. 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. 503 TooManyRequests - Requests beyond max requests that can be processed by available resources. 504 RequestTimeout - Service request exceeded the allowed timeout.

Name

Type

Description

200 OK

RefreshExternalGovernanceStatusOperationResultMI

Successfully refreshed external governance enablement status.

202 Accepted

Refreshing external governance enablement status.

Headers

Location: string

Other Status Codes

ErrorResponse

*** Error Responses: ***

400 SubnetMissingRequiredDelegation - Selected subnet is not delegated for SQL Managed Instance.
404 ManagedInstanceNotInSubscriptionResourceGroup - Specified managed instance does not exist in the specified resource group and subscription.
404 SubscriptionNotFound - The requested subscription was not found.
404 ServerNotInSubscription - Specified server does not exist on the specified subscription.
404 OperationIdNotFound - The operation with Id does not exist.
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.
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.
503 TooManyRequests - Requests beyond max requests that can be processed by available resources.
504 RequestTimeout - Service request exceeded the allowed timeout.

Examples

Refresh external governance enablement status.

POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/sqlcrudtest-4645/refreshExternalGovernanceStatus?api-version=2023-08-01

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/ManagedInstanceRefreshExternalGovernanceStatus.json
// this example is just showing the usage of "ManagedInstances_RefreshStatus" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ManagedInstanceResource created on azure
// for more information of creating ManagedInstanceResource, please refer to the document of ManagedInstanceResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "sqlcrudtest-7398";
string managedInstanceName = "sqlcrudtest-4645";
ResourceIdentifier managedInstanceResourceId = ManagedInstanceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, managedInstanceName);
ManagedInstanceResource managedInstance = client.GetManagedInstanceResource(managedInstanceResourceId);

// invoke the operation
ArmOperation<SqlManagedInstanceRefreshExternalGovernanceStatusOperationResult> lro = await managedInstance.RefreshStatusAsync(WaitUntil.Completed);
SqlManagedInstanceRefreshExternalGovernanceStatusOperationResult result = lro.Value;

Console.WriteLine($"Succeeded: {result}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 200

{
  "properties": {
    "requestId": "00000000-0000-0000-0000-000000000000",
    "requestType": "UpdatePurviewMetadata",
    "queuedTime": "2/12/2022 8:33:27 PM",
    "managedInstanceName": "testsvr.database.windows.net",
    "status": "Completed"
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.Sql/locations/japaneast/refreshExternalGovernanceStatusMIOperationResults/9d9a794a-5cec-4f23-af70-d29511b522a4",
  "name": "9d9a794a-5cec-4f23-af70-d29511b522a4",
  "type": "Microsoft.Sql/locations/refreshExternalGovernanceStatusMIOperationResults"
}

Status code:: 202

Location: https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.Sql/locations/japaneast/refreshExternalGovernanceStatusMIOperationResults/00000000-0000-0000-0000-000000000000?api-version=2023-02-01-preview

Definitions

Name	Description
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
RefreshExternalGovernanceStatusOperationResultMI	An RefreshExternalGovernanceStatus operation result resource.

ErrorAdditionalInfo

Object

The resource management error additional info.

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

ErrorDetail

Object

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

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

RefreshExternalGovernanceStatusOperationResultMI

Object

An RefreshExternalGovernanceStatus operation result resource.

Name	Type	Description
id	string	Resource ID.
name	string	Resource name.
properties.errorMessage	string	Error message.
properties.managedInstanceName	string	Managed instance name.
properties.queuedTime	string	Queued time.
properties.requestId	string (uuid)	Request Id.
properties.requestType	string	Request type.
properties.status	string	Operation status.
type	string	Resource type.

Share via

Managed Instances - Refresh Status

URI Parameters

Responses

Examples

Refresh external governance enablement status.

Sample request

Sample response

Definitions

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

RefreshExternalGovernanceStatusOperationResultMI