Language

ManagedInstanceResource Class

Definition

A class representing a ManagedInstance along with the instance operations that can be performed on it. If you have a ResourceIdentifier you can construct a ManagedInstanceResource from an instance of ArmClient using the GetResource method. Otherwise you can get one from its parent resource ResourceGroupResource using the GetManagedInstances method.

public class ManagedInstanceResource : Azure.ResourceManager.ArmResource, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.Sql.ManagedInstanceData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.Sql.ManagedInstanceData>
type ManagedInstanceResource = class
    inherit ArmResource
    interface IJsonModel<ManagedInstanceData>
    interface IPersistableModel<ManagedInstanceData>
Public Class ManagedInstanceResource
Inherits ArmResource
Implements IJsonModel(Of ManagedInstanceData), IPersistableModel(Of ManagedInstanceData)
Inheritance
ManagedInstanceResource
Implements

Constructors

Name Description
ManagedInstanceResource()

Initializes a new instance of ManagedInstanceResource for mocking.

Fields

Name Description
ResourceType

Gets the resource type for the operations.

Properties

Name Description
Client

Gets the ArmClient this resource client was created from.

(Inherited from ArmResource)
Data

Gets the data representing this Feature.

Diagnostics

Gets the diagnostic options for this resource client.

(Inherited from ArmResource)
Endpoint

Gets the base uri for this resource client.

(Inherited from ArmResource)
HasData

Gets whether or not the current instance has data.

Id

Gets the resource identifier.

(Inherited from ArmResource)
Pipeline

Gets the pipeline for this resource client.

(Inherited from ArmResource)

Methods

Name Description
AddTag(String, String, CancellationToken)

Add a tag to the current resource.

AddTagAsync(String, String, CancellationToken)

Add a tag to the current resource.

CanUseTagResource(CancellationToken)

Checks to see if the TagResource API is deployed in the current environment.

(Inherited from ArmResource)
CanUseTagResourceAsync(CancellationToken)

Checks to see if the TagResource API is deployed in the current environment.

(Inherited from ArmResource)
CreateManagedInstanceTdeCertificate(WaitUntil, TdeCertificate, CancellationToken)

Creates a TDE certificate for a given server.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/tdeCertificates.
  • Operation Id. : ManagedInstances_Create.
  • Default Api Version. : 2025-08-01-preview.
  • Resource. : ManagedInstanceResource.
CreateManagedInstanceTdeCertificateAsync(WaitUntil, TdeCertificate, CancellationToken)

Creates a TDE certificate for a given server.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/tdeCertificates.
  • Operation Id. : ManagedInstances_Create.
  • Default Api Version. : 2025-08-01-preview.
  • Resource. : ManagedInstanceResource.
CreateResourceIdentifier(String, String, String)

Generate the resource identifier for this resource.

Delete(WaitUntil, CancellationToken)

Deletes a managed instance.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}.
  • Operation Id. : ManagedInstances_Delete.
  • Default Api Version. : 2025-08-01-preview.
  • Resource. : ManagedInstanceResource.
DeleteAsync(WaitUntil, CancellationToken)

Deletes a managed instance.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}.
  • Operation Id. : ManagedInstances_Delete.
  • Default Api Version. : 2025-08-01-preview.
  • Resource. : ManagedInstanceResource.
Failover(WaitUntil, Nullable<ReplicaType>, CancellationToken)

Failovers a managed instance.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/failover.
  • Operation Id. : ManagedInstances_Failover.
  • Default Api Version. : 2025-08-01-preview.
  • Resource. : ManagedInstanceResource.
FailoverAsync(WaitUntil, Nullable<ReplicaType>, CancellationToken)

Failovers a managed instance.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/failover.
  • Operation Id. : ManagedInstances_Failover.
  • Default Api Version. : 2025-08-01-preview.
  • Resource. : ManagedInstanceResource.
Get(String, CancellationToken)

Gets a managed instance.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}.
  • Operation Id. : ManagedInstances_Get.
  • Default Api Version. : 2025-08-01-preview.
  • Resource. : ManagedInstanceResource.
GetAsync(String, CancellationToken)

Gets a managed instance.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}.
  • Operation Id. : ManagedInstances_Get.
  • Default Api Version. : 2025-08-01-preview.
  • Resource. : ManagedInstanceResource.
GetAvailableLocations(CancellationToken)

Lists all available geo-locations.

(Inherited from ArmResource)
GetAvailableLocationsAsync(CancellationToken)

Lists all available geo-locations.

(Inherited from ArmResource)
GetEndpointCertificate(String, CancellationToken)

Gets a certificate used on the endpoint with the given id.

GetEndpointCertificateAsync(String, CancellationToken)

Gets a certificate used on the endpoint with the given id.

GetEndpointCertificates()

Gets a collection of EndpointCertificates in the ManagedInstanceResource.

GetInaccessibleManagedDatabases(CancellationToken)

Gets a list of inaccessible managed databases in a managed instance

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/inaccessibleManagedDatabases.
  • Operation Id. : ManagedInstances_ListInaccessibleByInstance.
  • Default Api Version. : 2025-08-01-preview.
  • Resource. : ManagedInstanceResource.
GetInaccessibleManagedDatabasesAsync(CancellationToken)

Gets a list of inaccessible managed databases in a managed instance

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/inaccessibleManagedDatabases.
  • Operation Id. : ManagedInstances_ListInaccessibleByInstance.
  • Default Api Version. : 2025-08-01-preview.
  • Resource. : ManagedInstanceResource.
GetManagedDatabase(String, CancellationToken)

Gets a managed database.

GetManagedDatabaseAsync(String, CancellationToken)

Gets a managed database.

GetManagedDatabases()

Gets a collection of ManagedDatabases in the ManagedInstanceResource.

GetManagedInstanceAdministrator(SqlAdministratorName, CancellationToken)

Gets a managed instance administrator.

GetManagedInstanceAdministratorAsync(SqlAdministratorName, CancellationToken)

Gets a managed instance administrator.

GetManagedInstanceAdministrators()

Gets a collection of ManagedInstanceAdministrators in the ManagedInstanceResource.

GetManagedInstanceAdvancedThreatProtection(AdvancedThreatProtectionName, CancellationToken)

Get a managed instance's Advanced Threat Protection state.

GetManagedInstanceAdvancedThreatProtectionAsync(AdvancedThreatProtectionName, CancellationToken)

Get a managed instance's Advanced Threat Protection state.

GetManagedInstanceAdvancedThreatProtections()

Gets a collection of ManagedInstanceAdvancedThreatProtections in the ManagedInstanceResource.

GetManagedInstanceAzureADOnlyAuthentication(AuthenticationName, CancellationToken)

Gets a specific Azure Active Directory only authentication property.

GetManagedInstanceAzureADOnlyAuthenticationAsync(AuthenticationName, CancellationToken)

Gets a specific Azure Active Directory only authentication property.

GetManagedInstanceAzureADOnlyAuthentications()

Gets a collection of ManagedInstanceAzureADOnlyAuthentications in the ManagedInstanceResource.

GetManagedInstanceDtc(DtcName, CancellationToken)

Gets managed instance DTC settings.

GetManagedInstanceDtcAsync(DtcName, CancellationToken)

Gets managed instance DTC settings.

GetManagedInstanceDtcs()

Gets a collection of ManagedInstanceDtcs in the ManagedInstanceResource.

GetManagedInstanceEncryptionProtector(EncryptionProtectorName, CancellationToken)

Gets a managed instance encryption protector.

GetManagedInstanceEncryptionProtectorAsync(EncryptionProtectorName, CancellationToken)

Gets a managed instance encryption protector.

GetManagedInstanceEncryptionProtectors()

Gets a collection of ManagedInstanceEncryptionProtectors in the ManagedInstanceResource.

GetManagedInstanceKey(String, CancellationToken)

Gets a managed instance key.

GetManagedInstanceKeyAsync(String, CancellationToken)

Gets a managed instance key.

GetManagedInstanceKeys()

Gets a collection of ManagedInstanceKeys in the ManagedInstanceResource.

GetManagedInstanceOperation(Guid, CancellationToken)

Gets a management operation on a managed instance.

GetManagedInstanceOperationAsync(Guid, CancellationToken)

Gets a management operation on a managed instance.

GetManagedInstanceOperations()

Gets a collection of ManagedInstanceOperations in the ManagedInstanceResource.

GetManagedInstancePrivateEndpointConnection(String, CancellationToken)

Gets a private endpoint connection.

GetManagedInstancePrivateEndpointConnectionAsync(String, CancellationToken)

Gets a private endpoint connection.

GetManagedInstancePrivateEndpointConnections()

Gets a collection of ManagedInstancePrivateEndpointConnections in the ManagedInstanceResource.

GetManagedInstancePrivateLink(String, CancellationToken)

Gets a private link resource for SQL server.

GetManagedInstancePrivateLinkAsync(String, CancellationToken)

Gets a private link resource for SQL server.

GetManagedInstancePrivateLinks()

Gets a collection of ManagedInstancePrivateLinks in the ManagedInstanceResource.

GetManagedInstanceServerConfigurationOption(ManagedInstanceServerConfigurationOptionName, CancellationToken)

Gets managed instance server configuration option.

GetManagedInstanceServerConfigurationOptionAsync(ManagedInstanceServerConfigurationOptionName, CancellationToken)

Gets managed instance server configuration option.

GetManagedInstanceServerConfigurationOptions()

Gets a collection of ManagedInstanceServerConfigurationOptions in the ManagedInstanceResource.

GetManagedInstanceServerTrustCertificate(String, CancellationToken)

Gets a server trust certificate that was uploaded from SQL Server to SQL Managed Instance.

GetManagedInstanceServerTrustCertificateAsync(String, CancellationToken)

Gets a server trust certificate that was uploaded from SQL Server to SQL Managed Instance.

GetManagedInstanceServerTrustCertificates()

Gets a collection of ManagedInstanceServerTrustCertificates in the ManagedInstanceResource.

GetManagedInstanceStartStopSchedule(ManagedInstanceStartStopScheduleName, CancellationToken)

Gets the managed instance's Start/Stop schedule.

GetManagedInstanceStartStopScheduleAsync(ManagedInstanceStartStopScheduleName, CancellationToken)

Gets the managed instance's Start/Stop schedule.

GetManagedInstanceStartStopSchedules()

Gets a collection of ManagedInstanceStartStopSchedules in the ManagedInstanceResource.

GetManagedInstanceVulnerabilityAssessment(VulnerabilityAssessmentName, CancellationToken)

Gets the managed instance's vulnerability assessment.

GetManagedInstanceVulnerabilityAssessmentAsync(VulnerabilityAssessmentName, CancellationToken)

Gets the managed instance's vulnerability assessment.

GetManagedInstanceVulnerabilityAssessments()

Gets a collection of ManagedInstanceVulnerabilityAssessments in the ManagedInstanceResource.

GetManagedServerDnsAlias(String, CancellationToken)

Gets a server DNS alias.

GetManagedServerDnsAliasAsync(String, CancellationToken)

Gets a server DNS alias.

GetManagedServerDnsAliases()

Gets a collection of ManagedServerDnsAliases in the ManagedInstanceResource.

GetManagedServerSecurityAlertPolicies()

Gets a collection of ManagedServerSecurityAlertPolicies in the ManagedInstanceResource.

GetManagedServerSecurityAlertPolicy(SqlSecurityAlertPolicyName, CancellationToken)

Get a managed server's threat detection policy.

GetManagedServerSecurityAlertPolicyAsync(SqlSecurityAlertPolicyName, CancellationToken)

Get a managed server's threat detection policy.

GetManagementLock(String, CancellationToken)

Get a management lock by scope.

  • Request Path: /{scope}/providers/Microsoft.Authorization/locks/{lockName}
  • Operation Id: ManagementLocks_GetByScope
  • Default Api Version: 2020-05-01
  • Resource: ManagementLockResource
(Inherited from ArmResource)
GetManagementLockAsync(String, CancellationToken)

Get a management lock by scope.

  • Request Path: /{scope}/providers/Microsoft.Authorization/locks/{lockName}
  • Operation Id: ManagementLocks_GetByScope
  • Default Api Version: 2020-05-01
  • Resource: ManagementLockResource
(Inherited from ArmResource)
GetManagementLocks()

Gets a collection of ManagementLockResources in the ArmResource.

(Inherited from ArmResource)
GetOutboundNetworkDependencies(CancellationToken)

Gets the collection of outbound network dependencies for the given managed instance.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/outboundNetworkDependenciesEndpoints.
  • Operation Id. : ManagedInstances_ListOutboundNetworkDependenciesByManagedInstance.
  • Default Api Version. : 2025-08-01-preview.
  • Resource. : ManagedInstanceResource.
GetOutboundNetworkDependenciesAsync(CancellationToken)

Gets the collection of outbound network dependencies for the given managed instance.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/outboundNetworkDependenciesEndpoints.
  • Operation Id. : ManagedInstances_ListOutboundNetworkDependenciesByManagedInstance.
  • Default Api Version. : 2025-08-01-preview.
  • Resource. : ManagedInstanceResource.
GetPolicyAssignment(String, CancellationToken)

This operation retrieves a single policy assignment, given its name and the scope it was created at.

  • Request Path: /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}
  • Operation Id: PolicyAssignments_Get
  • Default Api Version: 2022-06-01
  • Resource: PolicyAssignmentResource
(Inherited from ArmResource)
GetPolicyAssignmentAsync(String, CancellationToken)

This operation retrieves a single policy assignment, given its name and the scope it was created at.

  • Request Path: /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}
  • Operation Id: PolicyAssignments_Get
  • Default Api Version: 2022-06-01
  • Resource: PolicyAssignmentResource
(Inherited from ArmResource)
GetPolicyAssignments()

Gets a collection of PolicyAssignmentResources in the ArmResource.

(Inherited from ArmResource)
GetRecoverableManagedDatabase(String, CancellationToken)

Gets a recoverable managed database.

GetRecoverableManagedDatabaseAsync(String, CancellationToken)

Gets a recoverable managed database.

GetRecoverableManagedDatabases()

Gets a collection of RecoverableManagedDatabases in the ManagedInstanceResource.

GetRestorableDroppedManagedDatabase(String, CancellationToken)

Gets a restorable dropped managed database.

GetRestorableDroppedManagedDatabaseAsync(String, CancellationToken)

Gets a restorable dropped managed database.

GetRestorableDroppedManagedDatabases()

Gets a collection of RestorableDroppedManagedDatabases in the ManagedInstanceResource.

GetSqlAgentConfiguration()

Gets an object representing a SqlAgentConfigurationResource along with the instance operations that can be performed on it in the ManagedInstanceResource.

GetSqlDistributedAvailabilityGroup(String, CancellationToken)

Gets a distributed availability group info.

GetSqlDistributedAvailabilityGroupAsync(String, CancellationToken)

Gets a distributed availability group info.

GetSqlDistributedAvailabilityGroups()

Gets a collection of SqlDistributedAvailabilityGroups in the ManagedInstanceResource.

GetSqlServerTrustGroups(CancellationToken)

Gets a server trust groups by instance name.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/serverTrustGroups.
  • Operation Id. : ManagedInstances_ListByInstance.
  • Default Api Version. : 2025-08-01-preview.
  • Resource. : ManagedInstanceResource.
GetSqlServerTrustGroupsAsync(CancellationToken)

Gets a server trust groups by instance name.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/serverTrustGroups.
  • Operation Id. : ManagedInstances_ListByInstance.
  • Default Api Version. : 2025-08-01-preview.
  • Resource. : ManagedInstanceResource.
GetTagResource()

Gets an object representing a TagResource along with the instance operations that can be performed on it in the ArmResource.

(Inherited from ArmResource)
GetTopQueries(Nullable<Int32>, String, String, String, Nullable<QueryTimeGrainType>, Nullable<AggregationFunctionType>, Nullable<SqlMetricType>, CancellationToken)

Get top resource consuming queries of a managed instance.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/topqueries.
  • Operation Id. : ManagedInstances_ListByManagedInstance.
  • Default Api Version. : 2025-08-01-preview.
  • Resource. : ManagedInstanceResource.
GetTopQueriesAsync(Nullable<Int32>, String, String, String, Nullable<QueryTimeGrainType>, Nullable<AggregationFunctionType>, Nullable<SqlMetricType>, CancellationToken)

Get top resource consuming queries of a managed instance.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/topqueries.
  • Operation Id. : ManagedInstances_ListByManagedInstance.
  • Default Api Version. : 2025-08-01-preview.
  • Resource. : ManagedInstanceResource.
ReevaluateInaccessibleDatabaseState(WaitUntil, CancellationToken)

Reevaluates the inaccessibility state of all managed databases.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/reevaluateInaccessibleDatabaseState.
  • Operation Id. : ManagedInstances_ReevaluateInaccessibleDatabaseState.
  • Default Api Version. : 2025-08-01-preview.
  • Resource. : ManagedInstanceResource.
ReevaluateInaccessibleDatabaseStateAsync(WaitUntil, CancellationToken)

Reevaluates the inaccessibility state of all managed databases.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/reevaluateInaccessibleDatabaseState.
  • Operation Id. : ManagedInstances_ReevaluateInaccessibleDatabaseState.
  • Default Api Version. : 2025-08-01-preview.
  • Resource. : ManagedInstanceResource.
RefreshStatus(WaitUntil, CancellationToken)

Refresh external governance enablement status.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/refreshExternalGovernanceStatus.
  • Operation Id. : ManagedInstances_RefreshStatus.
  • Default Api Version. : 2025-08-01-preview.
  • Resource. : ManagedInstanceResource.
RefreshStatusAsync(WaitUntil, CancellationToken)

Refresh external governance enablement status.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/refreshExternalGovernanceStatus.
  • Operation Id. : ManagedInstances_RefreshStatus.
  • Default Api Version. : 2025-08-01-preview.
  • Resource. : ManagedInstanceResource.
RemoveTag(String, CancellationToken)

Removes a tag by key from the resource.

RemoveTagAsync(String, CancellationToken)

Removes a tag by key from the resource.

SetTags(IDictionary<String,String>, CancellationToken)

Replace the tags on the resource with the given set.

SetTagsAsync(IDictionary<String,String>, CancellationToken)

Replace the tags on the resource with the given set.

Start(WaitUntil, CancellationToken)

Starts the managed instance.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/start.
  • Operation Id. : ManagedInstances_Start.
  • Default Api Version. : 2025-08-01-preview.
  • Resource. : ManagedInstanceResource.
StartAsync(WaitUntil, CancellationToken)

Starts the managed instance.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/start.
  • Operation Id. : ManagedInstances_Start.
  • Default Api Version. : 2025-08-01-preview.
  • Resource. : ManagedInstanceResource.
Stop(WaitUntil, CancellationToken)

Stops the managed instance.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/stop.
  • Operation Id. : ManagedInstances_Stop.
  • Default Api Version. : 2025-08-01-preview.
  • Resource. : ManagedInstanceResource.
StopAsync(WaitUntil, CancellationToken)

Stops the managed instance.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/stop.
  • Operation Id. : ManagedInstances_Stop.
  • Default Api Version. : 2025-08-01-preview.
  • Resource. : ManagedInstanceResource.
TryGetApiVersion(ResourceType, String)

Gets the api version override if it has been set for the current client options.

(Inherited from ArmResource)
Update(WaitUntil, ManagedInstancePatch, CancellationToken)

Updates a managed instance.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}.
  • Operation Id. : ManagedInstances_Update.
  • Default Api Version. : 2025-08-01-preview.
  • Resource. : ManagedInstanceResource.
UpdateAsync(WaitUntil, ManagedInstancePatch, CancellationToken)

Updates a managed instance.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}.
  • Operation Id. : ManagedInstances_Update.
  • Default Api Version. : 2025-08-01-preview.
  • Resource. : ManagedInstanceResource.
ValidateAzureKeyVaultEncryptionKey(WaitUntil, ManagedInstanceValidateAzureKeyVaultEncryptionKeyContent, CancellationToken)

Validates customer managed key.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/validateAzureKeyVaultEncryptionKey.
  • Operation Id. : ManagedInstances_ValidateAzureKeyVaultEncryptionKey.
  • Default Api Version. : 2025-08-01-preview.
  • Resource. : ManagedInstanceResource.
ValidateAzureKeyVaultEncryptionKeyAsync(WaitUntil, ManagedInstanceValidateAzureKeyVaultEncryptionKeyContent, CancellationToken)

Validates customer managed key.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/validateAzureKeyVaultEncryptionKey.
  • Operation Id. : ManagedInstances_ValidateAzureKeyVaultEncryptionKey.
  • Default Api Version. : 2025-08-01-preview.
  • Resource. : ManagedInstanceResource.

Explicit Interface Implementations

Name Description
IJsonModel<ManagedInstanceData>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<ManagedInstanceData>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<ManagedInstanceData>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<ManagedInstanceData>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<ManagedInstanceData>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Extension Methods

Name Description
GetAuthorizationRoleDefinition(ArmResource, ResourceIdentifier, CancellationToken)

Gets the role definition identified by roleDefinitionId at this resource scope.

GetAuthorizationRoleDefinitionAsync(ArmResource, ResourceIdentifier, CancellationToken)

Gets the role definition identified by roleDefinitionId at this resource scope.

GetAuthorizationRoleDefinitions(ArmResource)

Gets a collection of AuthorizationRoleDefinitionCollection objects within the specified scope.

GetDenyAssignment(ArmResource, String, CancellationToken)

Get the specified deny assignment.

GetDenyAssignmentAsync(ArmResource, String, CancellationToken)

Get the specified deny assignment.

GetDenyAssignments(ArmResource)

Gets a collection of DenyAssignmentCollection objects within the specified scope.

GetLinkerResource(ArmResource, String, CancellationToken)

Returns Linker resource for a given name.

  • Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}
  • Operation Id: Linker_Get
  • Default Api Version: 2022-05-01
  • Resource: LinkerResource
<item>MockingTo mock this method, please mock GetLinkerResource(String, CancellationToken) instead.</item>
GetLinkerResourceAsync(ArmResource, String, CancellationToken)

Returns Linker resource for a given name.

  • Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}
  • Operation Id: Linker_Get
  • Default Api Version: 2022-05-01
  • Resource: LinkerResource
<item>MockingTo mock this method, please mock GetLinkerResourceAsync(String, CancellationToken) instead.</item>
GetLinkerResources(ArmResource)

Gets a collection of LinkerResources in the ArmResource. <item>MockingTo mock this method, please mock GetLinkerResources() instead.</item>

GetRoleAssignment(ArmResource, String, String, CancellationToken)

Get a role assignment by scope and name.

GetRoleAssignmentAsync(ArmResource, String, String, CancellationToken)

Get a role assignment by scope and name.

GetRoleAssignments(ArmResource)

Gets a collection of RoleAssignmentCollection objects within the specified scope.

GetRoleAssignmentSchedule(ArmResource, String, CancellationToken)

Get the specified role assignment schedule for a resource scope.

GetRoleAssignmentScheduleAsync(ArmResource, String, CancellationToken)

Get the specified role assignment schedule for a resource scope.

GetRoleAssignmentScheduleInstance(ArmResource, String, CancellationToken)

Gets the specified role assignment schedule instance.

GetRoleAssignmentScheduleInstanceAsync(ArmResource, String, CancellationToken)

Gets the specified role assignment schedule instance.

GetRoleAssignmentScheduleInstances(ArmResource)

Gets a collection of RoleAssignmentScheduleInstanceCollection objects within the specified scope.

GetRoleAssignmentScheduleRequest(ArmResource, String, CancellationToken)

Get the specified role assignment schedule request.

GetRoleAssignmentScheduleRequestAsync(ArmResource, String, CancellationToken)

Get the specified role assignment schedule request.

GetRoleAssignmentScheduleRequests(ArmResource)

Gets a collection of RoleAssignmentScheduleRequestCollection objects within the specified scope.

GetRoleAssignmentSchedules(ArmResource)

Gets a collection of RoleAssignmentScheduleCollection objects within the specified scope.

GetRoleEligibilitySchedule(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule for a resource scope.

GetRoleEligibilityScheduleAsync(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule for a resource scope.

GetRoleEligibilityScheduleInstance(ArmResource, String, CancellationToken)

Gets the specified role eligibility schedule instance.

GetRoleEligibilityScheduleInstanceAsync(ArmResource, String, CancellationToken)

Gets the specified role eligibility schedule instance.

GetRoleEligibilityScheduleInstances(ArmResource)

Gets a collection of RoleEligibilityScheduleInstanceCollection objects within the specified scope.

GetRoleEligibilityScheduleRequest(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule request.

GetRoleEligibilityScheduleRequestAsync(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule request.

GetRoleEligibilityScheduleRequests(ArmResource)

Gets a collection of RoleEligibilityScheduleRequestCollection objects within the specified scope.

GetRoleEligibilitySchedules(ArmResource)

Gets a collection of RoleEligibilityScheduleCollection objects within the specified scope.

GetRoleManagementPolicies(ArmResource)

Gets a collection of RoleManagementPolicyCollection objects within the specified scope.

GetRoleManagementPolicy(ArmResource, String, CancellationToken)

Get the specified role management policy for a resource scope.

GetRoleManagementPolicyAssignment(ArmResource, String, CancellationToken)

Get the specified role management policy assignment for a resource scope.

GetRoleManagementPolicyAssignmentAsync(ArmResource, String, CancellationToken)

Get the specified role management policy assignment for a resource scope.

GetRoleManagementPolicyAssignments(ArmResource)

Gets a collection of RoleManagementPolicyAssignmentCollection objects within the specified scope.

GetRoleManagementPolicyAsync(ArmResource, String, CancellationToken)

Get the specified role management policy for a resource scope.

GetSystemAssignedIdentity(ArmResource)

Gets an object representing a SystemAssignedIdentityResource along with the instance operations that can be performed on it in the ArmResource scope.

Applies to