ManagedInstanceData Class

Definition

A class representing the ManagedInstance data model. An Azure SQL managed instance.

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

Constructors

ManagedInstanceData(AzureLocation)

Initializes a new instance of ManagedInstanceData.

Properties

AdministratorLogin

Administrator username for the managed instance. Can only be specified when the managed instance is being created (and is required for creation).

AdministratorLoginPassword

The administrator login password (required for managed instance creation).

Administrators

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.

Collation

Collation of the managed instance.

CurrentBackupStorageRedundancy

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

DnsZone

The Dns Zone that the managed instance is in.

FullyQualifiedDomainName

The fully qualified domain name of the managed instance.

Id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

(Inherited from ResourceData)
Identity

The Azure Active Directory identity of the managed instance.

InstancePoolId

The Id of the instance pool this managed server belongs to.

IsPublicDataEndpointEnabled

Whether or not the public data endpoint is enabled.

IsZoneRedundant

Whether or not the multi-az is enabled.

KeyId

A CMK URI of the key to use for encryption.

LicenseType

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

Location

The geo-location where the resource lives.

(Inherited from TrackedResourceData)
MaintenanceConfigurationId

Specifies maintenance configuration id to apply to this managed instance.

ManagedDnsZonePartner

The resource id of another managed instance whose DNS zone this managed instance will share after creation.

ManagedInstanceCreateMode

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.

MinimalTlsVersion

Minimal TLS version. Allowed values: 'None', '1.0', '1.1', '1.2'.

Name

The name of the resource.

(Inherited from ResourceData)
PrimaryUserAssignedIdentityId

The resource id of a user assigned identity to be used by default.

PrivateEndpointConnections

List of private endpoint connections on a managed instance.

ProvisioningState

Gets the provisioning state.

ProxyOverride

Connection type used for connecting to the instance.

RequestedBackupStorageRedundancy

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

ResourceType

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

(Inherited from ResourceData)
RestorePointInTime

Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database.

ServicePrincipal

The managed instance's service principal.

Sku

Managed instance SKU. Allowed values for sku.name: GP_Gen5, GP_G8IM, GP_G8IH, BC_Gen5, BC_G8IM, BC_G8IH.

SourceManagedInstanceId

The resource identifier of the source managed instance associated with create operation of this instance.

State

The state of the managed instance.

StorageSizeInGB

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.

SubnetId

Subnet resource ID for the managed instance.

SystemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

(Inherited from ResourceData)
Tags

Resource tags.

(Inherited from TrackedResourceData)
TimezoneId

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

VCores

The number of vCores. Allowed values: 8, 16, 24, 32, 40, 64, 80.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from TrackedResourceData)

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.

Applies to