ManagedInstanceResource Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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 GetManagedInstanceResource method. Otherwise you can get one from its parent resource ResourceGroupResource using the GetManagedInstance method.
public class ManagedInstanceResource : Azure.ResourceManager.ArmResourcepublic 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 ArmResourcetype ManagedInstanceResource = class
inherit ArmResource
interface IJsonModel<ManagedInstanceData>
interface IPersistableModel<ManagedInstanceData>Public Class ManagedInstanceResource
Inherits ArmResourcePublic Class ManagedInstanceResource
Inherits ArmResource
Implements IJsonModel(Of ManagedInstanceData), IPersistableModel(Of ManagedInstanceData)- Inheritance
- Implements
Constructors
| ManagedInstanceResource() |
Initializes a new instance of the ManagedInstanceResource class for mocking. |
Fields
| ResourceType |
Gets the resource type for the operations. |
Properties
| 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
| 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.
|
| CreateManagedInstanceTdeCertificateAsync(WaitUntil, TdeCertificate, CancellationToken) |
Creates a TDE certificate for a given server.
|
| CreateResourceIdentifier(String, String, String) |
Generate the resource identifier of a ManagedInstanceResource instance. |
| Delete(WaitUntil, CancellationToken) |
Deletes a managed instance.
|
| DeleteAsync(WaitUntil, CancellationToken) |
Deletes a managed instance.
|
| Failover(WaitUntil, Nullable<ReplicaType>, CancellationToken) |
Failovers a managed instance.
|
| FailoverAsync(WaitUntil, Nullable<ReplicaType>, CancellationToken) |
Failovers a managed instance.
|
| Get(String, CancellationToken) |
Gets a managed instance.
|
| GetAsync(String, CancellationToken) |
Gets a managed instance.
|
| GetAvailableLocations(CancellationToken) |
Lists all available geo-locations. (Inherited from ArmResource) |
| GetAvailableLocationsAsync(CancellationToken) |
Lists all available geo-locations. (Inherited from ArmResource) |
| GetDistributedAvailabilityGroup(String, CancellationToken) |
Gets a distributed availability group info.
|
| GetDistributedAvailabilityGroupAsync(String, CancellationToken) |
Gets a distributed availability group info.
|
| GetDistributedAvailabilityGroups() |
Gets a collection of DistributedAvailabilityGroupResources in the ManagedInstance. |
| 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 EndpointCertificateResources in the ManagedInstance. |
| GetInaccessibleManagedDatabases(CancellationToken) |
Gets a list of inaccessible managed databases in a managed instance
|
| GetInaccessibleManagedDatabasesAsync(CancellationToken) |
Gets a list of inaccessible managed databases in a managed instance
|
| GetManagedDatabase(String, CancellationToken) |
Gets a managed database.
|
| GetManagedDatabaseAsync(String, CancellationToken) |
Gets a managed database.
|
| GetManagedDatabases() |
Gets a collection of ManagedDatabaseResources in the ManagedInstance. |
| GetManagedInstanceAdministrator(SqlAdministratorName, CancellationToken) |
Gets a managed instance administrator.
|
| GetManagedInstanceAdministratorAsync(SqlAdministratorName, CancellationToken) |
Gets a managed instance administrator.
|
| GetManagedInstanceAdministrators() |
Gets a collection of ManagedInstanceAdministratorResources in the ManagedInstance. |
| 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 ManagedInstanceAdvancedThreatProtectionResources in the ManagedInstance. |
| 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 ManagedInstanceAzureADOnlyAuthenticationResources in the ManagedInstance. |
| GetManagedInstanceDtc(DtcName, CancellationToken) |
Gets managed instance DTC settings.
|
| GetManagedInstanceDtcAsync(DtcName, CancellationToken) |
Gets managed instance DTC settings.
|
| GetManagedInstanceDtcs() |
Gets a collection of ManagedInstanceDtcResources in the ManagedInstance. |
| GetManagedInstanceEncryptionProtector(EncryptionProtectorName, CancellationToken) |
Gets a managed instance encryption protector.
|
| GetManagedInstanceEncryptionProtectorAsync(EncryptionProtectorName, CancellationToken) |
Gets a managed instance encryption protector.
|
| GetManagedInstanceEncryptionProtectors() |
Gets a collection of ManagedInstanceEncryptionProtectorResources in the ManagedInstance. |
| GetManagedInstanceKey(String, CancellationToken) |
Gets a managed instance key.
|
| GetManagedInstanceKeyAsync(String, CancellationToken) |
Gets a managed instance key.
|
| GetManagedInstanceKeys() |
Gets a collection of ManagedInstanceKeyResources in the ManagedInstance. |
| 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 ManagedInstanceOperationResources in the ManagedInstance. |
| GetManagedInstancePrivateEndpointConnection(String, CancellationToken) |
Gets a private endpoint connection.
|
| GetManagedInstancePrivateEndpointConnectionAsync(String, CancellationToken) |
Gets a private endpoint connection.
|
| GetManagedInstancePrivateEndpointConnections() |
Gets a collection of ManagedInstancePrivateEndpointConnectionResources in the ManagedInstance. |
| 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 ManagedInstancePrivateLinkResources in the ManagedInstance. |
| GetManagedInstanceServerConfigurationOption(ManagedInstanceServerConfigurationOptionName, CancellationToken) |
Gets managed instance server configuration option.
|
| GetManagedInstanceServerConfigurationOptionAsync(ManagedInstanceServerConfigurationOptionName, CancellationToken) |
Gets managed instance server configuration option.
|
| GetManagedInstanceServerConfigurationOptions() |
Gets a collection of ManagedInstanceServerConfigurationOptionResources in the ManagedInstance. |
| GetManagedInstanceServerTrustCertificate(String, CancellationToken) |
Gets a server trust certificate that was uploaded from box to Sql Managed Instance.
|
| GetManagedInstanceServerTrustCertificateAsync(String, CancellationToken) |
Gets a server trust certificate that was uploaded from box to Sql Managed Instance.
|
| GetManagedInstanceServerTrustCertificates() |
Gets a collection of ManagedInstanceServerTrustCertificateResources in the ManagedInstance. |
| 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 ManagedInstanceStartStopScheduleResources in the ManagedInstance. |
| 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 ManagedInstanceVulnerabilityAssessmentResources in the ManagedInstance. |
| GetManagedServerDnsAlias(String, CancellationToken) |
Gets a server DNS alias.
|
| GetManagedServerDnsAliasAsync(String, CancellationToken) |
Gets a server DNS alias.
|
| GetManagedServerDnsAliases() |
Gets a collection of ManagedServerDnsAliasResources in the ManagedInstance. |
| GetManagedServerSecurityAlertPolicies() |
Gets a collection of ManagedServerSecurityAlertPolicyResources in the ManagedInstance. |
| 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.
|
| GetManagementLockAsync(String, CancellationToken) |
Get a management lock by scope.
|
| 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.
|
| GetOutboundNetworkDependenciesAsync(CancellationToken) |
Gets the collection of outbound network dependencies for the given managed instance.
|
| GetPolicyAssignment(String, CancellationToken) |
This operation retrieves a single policy assignment, given its name and the scope it was created at.
|
| GetPolicyAssignmentAsync(String, CancellationToken) |
This operation retrieves a single policy assignment, given its name and the scope it was created at.
|
| 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 RecoverableManagedDatabaseResources in the ManagedInstance. |
| GetRestorableDroppedManagedDatabase(String, CancellationToken) |
Gets a restorable dropped managed database.
|
| GetRestorableDroppedManagedDatabaseAsync(String, CancellationToken) |
Gets a restorable dropped managed database.
|
| GetRestorableDroppedManagedDatabases() |
Gets a collection of RestorableDroppedManagedDatabaseResources in the ManagedInstance. |
| GetSqlAgentConfiguration() |
Gets an object representing a SqlAgentConfigurationResource along with the instance operations that can be performed on it in the ManagedInstance. |
| GetSqlServerTrustGroups(CancellationToken) |
Gets a server trust groups by instance name.
|
| GetSqlServerTrustGroupsAsync(CancellationToken) |
Gets a server trust groups by instance name.
|
| 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(ManagedInstanceResourceGetTopQueriesOptions, CancellationToken) |
Get top resource consuming queries of a managed instance.
|
| GetTopQueries(Nullable<Int32>, String, String, String, Nullable<QueryTimeGrainType>, Nullable<AggregationFunctionType>, Nullable<SqlMetricType>, CancellationToken) |
Get top resource consuming queries of a managed instance.
|
| GetTopQueriesAsync(ManagedInstanceResourceGetTopQueriesOptions, CancellationToken) |
Get top resource consuming queries of a managed instance.
|
| GetTopQueriesAsync(Nullable<Int32>, String, String, String, Nullable<QueryTimeGrainType>, Nullable<AggregationFunctionType>, Nullable<SqlMetricType>, CancellationToken) |
Get top resource consuming queries of a managed instance.
|
| 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.
|
| StartAsync(WaitUntil, CancellationToken) |
Starts the managed instance.
|
| Stop(WaitUntil, CancellationToken) |
Stops the managed instance.
|
| StopAsync(WaitUntil, CancellationToken) |
Stops the managed instance.
|
| 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.
|
| UpdateAsync(WaitUntil, ManagedInstancePatch, CancellationToken) |
Updates a managed instance.
|
Explicit Interface Implementations
| 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
| GetAuthorizationRoleDefinition(ArmResource, ResourceIdentifier, CancellationToken) |
Get role definition by name (GUID).
|
| GetAuthorizationRoleDefinitionAsync(ArmResource, ResourceIdentifier, CancellationToken) |
Get role definition by name (GUID).
|
| GetAuthorizationRoleDefinitions(ArmResource) |
Gets a collection of AuthorizationRoleDefinitionResources in the ArmResource. MockingTo mock this method, please mock GetAuthorizationRoleDefinitions() instead. |
| GetDenyAssignment(ArmResource, String, CancellationToken) |
Get the specified deny assignment.
|
| GetDenyAssignmentAsync(ArmResource, String, CancellationToken) |
Get the specified deny assignment.
|
| GetDenyAssignments(ArmResource) |
Gets a collection of DenyAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetDenyAssignments() instead. |
| 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 RoleAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignments() instead. |
| 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 RoleAssignmentScheduleInstanceResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentScheduleInstances() instead. |
| 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 RoleAssignmentScheduleRequestResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentScheduleRequests() instead. |
| GetRoleAssignmentSchedules(ArmResource) |
Gets a collection of RoleAssignmentScheduleResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentSchedules() instead. |
| 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 RoleEligibilityScheduleInstanceResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilityScheduleInstances() instead. |
| 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 RoleEligibilityScheduleRequestResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilityScheduleRequests() instead. |
| GetRoleEligibilitySchedules(ArmResource) |
Gets a collection of RoleEligibilityScheduleResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilitySchedules() instead. |
| GetRoleManagementPolicies(ArmResource) |
Gets a collection of RoleManagementPolicyResources in the ArmResource. MockingTo mock this method, please mock GetRoleManagementPolicies() instead. |
| 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 RoleManagementPolicyAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetRoleManagementPolicyAssignments() instead. |
| 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. MockingTo mock this method, please mock GetSystemAssignedIdentity() instead. |
| GetLinkerResource(ArmResource, String, CancellationToken) |
Returns Linker resource for a given name.
|
| GetLinkerResourceAsync(ArmResource, String, CancellationToken) |
Returns Linker resource for a given name.
|
| GetLinkerResources(ArmResource) |
Gets a collection of LinkerResources in the ArmResource. MockingTo mock this method, please mock GetLinkerResources() instead. |
Applies to
Azure SDK for .NET
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for