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 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
- 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.
|
| CreateManagedInstanceTdeCertificateAsync(WaitUntil, TdeCertificate, CancellationToken) |
Creates a TDE certificate for a given server.
|
| CreateResourceIdentifier(String, String, String) |
Generate the resource identifier for this resource. |
| 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) |
| 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
|
| 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 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.
|
| 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 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.
|
| 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(Nullable<Int32>, String, String, String, Nullable<QueryTimeGrainType>, Nullable<AggregationFunctionType>, Nullable<SqlMetricType>, 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.
|
| ReevaluateInaccessibleDatabaseState(WaitUntil, CancellationToken) |
Reevaluates the inaccessibility state of all managed databases.
|
| ReevaluateInaccessibleDatabaseStateAsync(WaitUntil, CancellationToken) |
Reevaluates the inaccessibility state of all managed databases.
|
| RefreshStatus(WaitUntil, CancellationToken) |
Refresh external governance enablement status.
|
| RefreshStatusAsync(WaitUntil, CancellationToken) |
Refresh external governance enablement status.
|
| 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.
|
| ValidateAzureKeyVaultEncryptionKey(WaitUntil, ManagedInstanceValidateAzureKeyVaultEncryptionKeyContent, CancellationToken) |
Validates customer managed key.
|
| ValidateAzureKeyVaultEncryptionKeyAsync(WaitUntil, ManagedInstanceValidateAzureKeyVaultEncryptionKeyContent, CancellationToken) |
Validates customer managed key.
|
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. |