Azure Native v3.2.0, Apr 14 25

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.

Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

azure-native.sql.getManagedInstance

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.

Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

Other available API versions: 2015-05-01-preview, 2018-06-01-preview, 2020-02-02-preview, 2020-08-01-preview, 2020-11-01-preview, 2021-02-01-preview, 2021-05-01-preview, 2021-08-01-preview, 2021-11-01, 2021-11-01-preview, 2022-02-01-preview, 2022-05-01-preview, 2022-08-01-preview, 2022-11-01-preview, 2023-02-01-preview, 2023-05-01-preview, 2023-08-01-preview, 2024-05-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native sql [ApiVersion]. See the version guide for details.

Using getManagedInstance

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

TypeScript
Python
Go
C#
Java
YAML

function getManagedInstance(args: GetManagedInstanceArgs, opts?: InvokeOptions): Promise<GetManagedInstanceResult>
function getManagedInstanceOutput(args: GetManagedInstanceOutputArgs, opts?: InvokeOptions): Output<GetManagedInstanceResult>

def get_managed_instance(expand: Optional[str] = None,
                         managed_instance_name: Optional[str] = None,
                         resource_group_name: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetManagedInstanceResult
def get_managed_instance_output(expand: Optional[pulumi.Input[str]] = None,
                         managed_instance_name: Optional[pulumi.Input[str]] = None,
                         resource_group_name: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetManagedInstanceResult]

func LookupManagedInstance(ctx *Context, args *LookupManagedInstanceArgs, opts ...InvokeOption) (*LookupManagedInstanceResult, error)
func LookupManagedInstanceOutput(ctx *Context, args *LookupManagedInstanceOutputArgs, opts ...InvokeOption) LookupManagedInstanceResultOutput

> Note: This function is named LookupManagedInstance in the Go SDK.

public static class GetManagedInstance 
{
    public static Task<GetManagedInstanceResult> InvokeAsync(GetManagedInstanceArgs args, InvokeOptions? opts = null)
    public static Output<GetManagedInstanceResult> Invoke(GetManagedInstanceInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetManagedInstanceResult> getManagedInstance(GetManagedInstanceArgs args, InvokeOptions options)
public static Output<GetManagedInstanceResult> getManagedInstance(GetManagedInstanceArgs args, InvokeOptions options)

fn::invoke:
  function: azure-native:sql:getManagedInstance
  arguments:
    # arguments dictionary

The following arguments are supported:

ManagedInstanceName string: The name of the managed instance.
ResourceGroupName 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.
Expand string: The child resources to include in the response.

ManagedInstanceName string: The name of the managed instance.
ResourceGroupName 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.
Expand string: The child resources to include in the response.

managedInstanceName String: The name of the managed instance.
resourceGroupName 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.
expand String: The child resources to include in the response.

managedInstanceName string: The name of the managed instance.
resourceGroupName 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.
expand string: The child resources to include in the response.

managed_instance_name str: The name of the managed instance.
resource_group_name str: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
expand str: The child resources to include in the response.

managedInstanceName String: The name of the managed instance.
resourceGroupName 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.
expand String: The child resources to include in the response.

getManagedInstance Result

The following output properties are available:

AzureApiVersion string: The Azure API version of the resource.
CreateTime string: Specifies the point in time (ISO8601 format) of the Managed Instance creation.
CurrentBackupStorageRedundancy string: The storage account type used to store backups for this instance. The options are Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) and GeoZone(GeoZoneRedundantStorage)
DnsZone string: The Dns Zone that the managed instance is in.
ExternalGovernanceStatus string: Status of external governance.
FullyQualifiedDomainName string: The fully qualified domain name of the managed instance.
HybridSecondaryUsageDetected string: Hybrid secondary usage detected. Possible values are 'Active' (customer does not meet the requirements to use the secondary as Passive DR) and 'Passive' (customer meets the requirements to use the secondary as Passive DR).
Id string: Resource ID.
Location string: Resource location.
Name string: Resource name.
PrivateEndpointConnections List<Pulumi.AzureNative.Sql.Outputs.ManagedInstancePecPropertyResponse>: List of private endpoint connections on a managed instance.
ProvisioningState string: Provisioning state of managed instance.
State string: The state of the managed instance.
Type string: Resource type.
VirtualClusterId string: Virtual cluster resource id for the Managed Instance.
AdministratorLogin string: Administrator username for the managed instance. Can only be specified when the managed instance is being created (and is required for creation).
Administrators Pulumi.AzureNative.Sql.Outputs.ManagedInstanceExternalAdministratorResponse: 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.
AuthenticationMetadata string: The managed instance's authentication metadata lookup mode.
Collation string: Collation of the managed instance.
DatabaseFormat string: Specifies the internal format of instance databases specific to the SQL engine version.
HybridSecondaryUsage string: Hybrid secondary usage. Possible values are 'Active' (default value) and 'Passive' (customer uses the secondary as Passive DR).
Identity Pulumi.AzureNative.Sql.Outputs.ResourceIdentityResponse: The Azure Active Directory identity of the managed instance.
InstancePoolId string: The Id of the instance pool this managed server belongs to.
IsGeneralPurposeV2 bool: Whether or not this is a GPv2 variant of General Purpose edition.
KeyId string: A CMK URI of the key to use for encryption.
LicenseType string: 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).
MaintenanceConfigurationId string: Specifies maintenance configuration id to apply to this managed instance.
MinimalTlsVersion string: Minimal TLS version. Allowed values: 'None', '1.0', '1.1', '1.2'
PricingModel string: Pricing model of Managed Instance.
PrimaryUserAssignedIdentityId string: The resource id of a user assigned identity to be used by default.
ProxyOverride string: Connection type used for connecting to the instance.
PublicDataEndpointEnabled bool: Whether or not the public data endpoint is enabled.
RequestedBackupStorageRedundancy string: 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)
ServicePrincipal Pulumi.AzureNative.Sql.Outputs.ServicePrincipalResponse: The managed instance's service principal.
Sku Pulumi.AzureNative.Sql.Outputs.SkuResponse: Managed instance SKU. Allowed values for sku.name: GP_Gen5, GP_G8IM, GP_G8IH, BC_Gen5, BC_G8IM, BC_G8IH
StorageIOps int: Storage IOps. Minimum value: 300. Maximum value: 80000. Increments of 1 IOps allowed only. Maximum value depends on the selected hardware family and number of vCores.
StorageSizeInGB int: 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.
StorageThroughputMBps int: Storage throughput MBps parameter is not supported in the instance create/update operation.
SubnetId string: Subnet resource ID for the managed instance.
Tags Dictionary<string, string>: Resource tags.
TimezoneId string: 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 int: The number of vCores. Allowed values: 8, 16, 24, 32, 40, 64, 80.
ZoneRedundant bool: Whether or not the multi-az is enabled.

AzureApiVersion string: The Azure API version of the resource.
CreateTime string: Specifies the point in time (ISO8601 format) of the Managed Instance creation.
CurrentBackupStorageRedundancy string: The storage account type used to store backups for this instance. The options are Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) and GeoZone(GeoZoneRedundantStorage)
DnsZone string: The Dns Zone that the managed instance is in.
ExternalGovernanceStatus string: Status of external governance.
FullyQualifiedDomainName string: The fully qualified domain name of the managed instance.
HybridSecondaryUsageDetected string: Hybrid secondary usage detected. Possible values are 'Active' (customer does not meet the requirements to use the secondary as Passive DR) and 'Passive' (customer meets the requirements to use the secondary as Passive DR).
Id string: Resource ID.
Location string: Resource location.
Name string: Resource name.
PrivateEndpointConnections []ManagedInstancePecPropertyResponse: List of private endpoint connections on a managed instance.
ProvisioningState string: Provisioning state of managed instance.
State string: The state of the managed instance.
Type string: Resource type.
VirtualClusterId string: Virtual cluster resource id for the Managed Instance.
AdministratorLogin string: Administrator username for the managed instance. Can only be specified when the managed instance is being created (and is required for creation).
Administrators ManagedInstanceExternalAdministratorResponse: 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.
AuthenticationMetadata string: The managed instance's authentication metadata lookup mode.
Collation string: Collation of the managed instance.
DatabaseFormat string: Specifies the internal format of instance databases specific to the SQL engine version.
HybridSecondaryUsage string: Hybrid secondary usage. Possible values are 'Active' (default value) and 'Passive' (customer uses the secondary as Passive DR).
Identity ResourceIdentityResponse: The Azure Active Directory identity of the managed instance.
InstancePoolId string: The Id of the instance pool this managed server belongs to.
IsGeneralPurposeV2 bool: Whether or not this is a GPv2 variant of General Purpose edition.
KeyId string: A CMK URI of the key to use for encryption.
LicenseType string: 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).
MaintenanceConfigurationId string: Specifies maintenance configuration id to apply to this managed instance.
MinimalTlsVersion string: Minimal TLS version. Allowed values: 'None', '1.0', '1.1', '1.2'
PricingModel string: Pricing model of Managed Instance.
PrimaryUserAssignedIdentityId string: The resource id of a user assigned identity to be used by default.
ProxyOverride string: Connection type used for connecting to the instance.
PublicDataEndpointEnabled bool: Whether or not the public data endpoint is enabled.
RequestedBackupStorageRedundancy string: 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)
ServicePrincipal ServicePrincipalResponse: The managed instance's service principal.
Sku SkuResponse: Managed instance SKU. Allowed values for sku.name: GP_Gen5, GP_G8IM, GP_G8IH, BC_Gen5, BC_G8IM, BC_G8IH
StorageIOps int: Storage IOps. Minimum value: 300. Maximum value: 80000. Increments of 1 IOps allowed only. Maximum value depends on the selected hardware family and number of vCores.
StorageSizeInGB int: 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.
StorageThroughputMBps int: Storage throughput MBps parameter is not supported in the instance create/update operation.
SubnetId string: Subnet resource ID for the managed instance.
Tags map[string]string: Resource tags.
TimezoneId string: 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 int: The number of vCores. Allowed values: 8, 16, 24, 32, 40, 64, 80.
ZoneRedundant bool: Whether or not the multi-az is enabled.

azureApiVersion String: The Azure API version of the resource.
createTime String: Specifies the point in time (ISO8601 format) of the Managed Instance creation.
currentBackupStorageRedundancy String: The storage account type used to store backups for this instance. The options are Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) and GeoZone(GeoZoneRedundantStorage)
dnsZone String: The Dns Zone that the managed instance is in.
externalGovernanceStatus String: Status of external governance.
fullyQualifiedDomainName String: The fully qualified domain name of the managed instance.
hybridSecondaryUsageDetected String: Hybrid secondary usage detected. Possible values are 'Active' (customer does not meet the requirements to use the secondary as Passive DR) and 'Passive' (customer meets the requirements to use the secondary as Passive DR).
id String: Resource ID.
location String: Resource location.
name String: Resource name.
privateEndpointConnections List<ManagedInstancePecPropertyResponse>: List of private endpoint connections on a managed instance.
provisioningState String: Provisioning state of managed instance.
state String: The state of the managed instance.
type String: Resource type.
virtualClusterId String: Virtual cluster resource id for the Managed Instance.
administratorLogin String: Administrator username for the managed instance. Can only be specified when the managed instance is being created (and is required for creation).
administrators ManagedInstanceExternalAdministratorResponse: 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.
authenticationMetadata String: The managed instance's authentication metadata lookup mode.
collation String: Collation of the managed instance.
databaseFormat String: Specifies the internal format of instance databases specific to the SQL engine version.
hybridSecondaryUsage String: Hybrid secondary usage. Possible values are 'Active' (default value) and 'Passive' (customer uses the secondary as Passive DR).
identity ResourceIdentityResponse: The Azure Active Directory identity of the managed instance.
instancePoolId String: The Id of the instance pool this managed server belongs to.
isGeneralPurposeV2 Boolean: Whether or not this is a GPv2 variant of General Purpose edition.
keyId String: A CMK URI of the key to use for encryption.
licenseType String: 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).
maintenanceConfigurationId String: Specifies maintenance configuration id to apply to this managed instance.
minimalTlsVersion String: Minimal TLS version. Allowed values: 'None', '1.0', '1.1', '1.2'
pricingModel String: Pricing model of Managed Instance.
primaryUserAssignedIdentityId String: The resource id of a user assigned identity to be used by default.
proxyOverride String: Connection type used for connecting to the instance.
publicDataEndpointEnabled Boolean: Whether or not the public data endpoint is enabled.
requestedBackupStorageRedundancy String: 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)
servicePrincipal ServicePrincipalResponse: The managed instance's service principal.
sku SkuResponse: Managed instance SKU. Allowed values for sku.name: GP_Gen5, GP_G8IM, GP_G8IH, BC_Gen5, BC_G8IM, BC_G8IH
storageIOps Integer: Storage IOps. Minimum value: 300. Maximum value: 80000. Increments of 1 IOps allowed only. Maximum value depends on the selected hardware family and number of vCores.
storageSizeInGB Integer: 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.
storageThroughputMBps Integer: Storage throughput MBps parameter is not supported in the instance create/update operation.
subnetId String: Subnet resource ID for the managed instance.
tags Map<String,String>: Resource tags.
timezoneId String: 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 Integer: The number of vCores. Allowed values: 8, 16, 24, 32, 40, 64, 80.
zoneRedundant Boolean: Whether or not the multi-az is enabled.

azureApiVersion string: The Azure API version of the resource.
createTime string: Specifies the point in time (ISO8601 format) of the Managed Instance creation.
currentBackupStorageRedundancy string: The storage account type used to store backups for this instance. The options are Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) and GeoZone(GeoZoneRedundantStorage)
dnsZone string: The Dns Zone that the managed instance is in.
externalGovernanceStatus string: Status of external governance.
fullyQualifiedDomainName string: The fully qualified domain name of the managed instance.
hybridSecondaryUsageDetected string: Hybrid secondary usage detected. Possible values are 'Active' (customer does not meet the requirements to use the secondary as Passive DR) and 'Passive' (customer meets the requirements to use the secondary as Passive DR).
id string: Resource ID.
location string: Resource location.
name string: Resource name.
privateEndpointConnections ManagedInstancePecPropertyResponse[]: List of private endpoint connections on a managed instance.
provisioningState string: Provisioning state of managed instance.
state string: The state of the managed instance.
type string: Resource type.
virtualClusterId string: Virtual cluster resource id for the Managed Instance.
administratorLogin string: Administrator username for the managed instance. Can only be specified when the managed instance is being created (and is required for creation).
administrators ManagedInstanceExternalAdministratorResponse: 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.
authenticationMetadata string: The managed instance's authentication metadata lookup mode.
collation string: Collation of the managed instance.
databaseFormat string: Specifies the internal format of instance databases specific to the SQL engine version.
hybridSecondaryUsage string: Hybrid secondary usage. Possible values are 'Active' (default value) and 'Passive' (customer uses the secondary as Passive DR).
identity ResourceIdentityResponse: The Azure Active Directory identity of the managed instance.
instancePoolId string: The Id of the instance pool this managed server belongs to.
isGeneralPurposeV2 boolean: Whether or not this is a GPv2 variant of General Purpose edition.
keyId string: A CMK URI of the key to use for encryption.
licenseType string: 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).
maintenanceConfigurationId string: Specifies maintenance configuration id to apply to this managed instance.
minimalTlsVersion string: Minimal TLS version. Allowed values: 'None', '1.0', '1.1', '1.2'
pricingModel string: Pricing model of Managed Instance.
primaryUserAssignedIdentityId string: The resource id of a user assigned identity to be used by default.
proxyOverride string: Connection type used for connecting to the instance.
publicDataEndpointEnabled boolean: Whether or not the public data endpoint is enabled.
requestedBackupStorageRedundancy string: 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)
servicePrincipal ServicePrincipalResponse: The managed instance's service principal.
sku SkuResponse: Managed instance SKU. Allowed values for sku.name: GP_Gen5, GP_G8IM, GP_G8IH, BC_Gen5, BC_G8IM, BC_G8IH
storageIOps number: Storage IOps. Minimum value: 300. Maximum value: 80000. Increments of 1 IOps allowed only. Maximum value depends on the selected hardware family and number of vCores.
storageSizeInGB number: 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.
storageThroughputMBps number: Storage throughput MBps parameter is not supported in the instance create/update operation.
subnetId string: Subnet resource ID for the managed instance.
tags {[key: string]: string}: Resource tags.
timezoneId string: 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 number: The number of vCores. Allowed values: 8, 16, 24, 32, 40, 64, 80.
zoneRedundant boolean: Whether or not the multi-az is enabled.

azure_api_version str: The Azure API version of the resource.
create_time str: Specifies the point in time (ISO8601 format) of the Managed Instance creation.
current_backup_storage_redundancy str: The storage account type used to store backups for this instance. The options are Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) and GeoZone(GeoZoneRedundantStorage)
dns_zone str: The Dns Zone that the managed instance is in.
external_governance_status str: Status of external governance.
fully_qualified_domain_name str: The fully qualified domain name of the managed instance.
hybrid_secondary_usage_detected str: Hybrid secondary usage detected. Possible values are 'Active' (customer does not meet the requirements to use the secondary as Passive DR) and 'Passive' (customer meets the requirements to use the secondary as Passive DR).
id str: Resource ID.
location str: Resource location.
name str: Resource name.
private_endpoint_connections Sequence[ManagedInstancePecPropertyResponse]: List of private endpoint connections on a managed instance.
provisioning_state str: Provisioning state of managed instance.
state str: The state of the managed instance.
type str: Resource type.
virtual_cluster_id str: Virtual cluster resource id for the Managed Instance.
administrator_login str: Administrator username for the managed instance. Can only be specified when the managed instance is being created (and is required for creation).
administrators ManagedInstanceExternalAdministratorResponse: 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.
authentication_metadata str: The managed instance's authentication metadata lookup mode.
collation str: Collation of the managed instance.
database_format str: Specifies the internal format of instance databases specific to the SQL engine version.
hybrid_secondary_usage str: Hybrid secondary usage. Possible values are 'Active' (default value) and 'Passive' (customer uses the secondary as Passive DR).
identity ResourceIdentityResponse: The Azure Active Directory identity of the managed instance.
instance_pool_id str: The Id of the instance pool this managed server belongs to.
is_general_purpose_v2 bool: Whether or not this is a GPv2 variant of General Purpose edition.
key_id str: A CMK URI of the key to use for encryption.
license_type str: 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).
maintenance_configuration_id str: Specifies maintenance configuration id to apply to this managed instance.
minimal_tls_version str: Minimal TLS version. Allowed values: 'None', '1.0', '1.1', '1.2'
pricing_model str: Pricing model of Managed Instance.
primary_user_assigned_identity_id str: The resource id of a user assigned identity to be used by default.
proxy_override str: Connection type used for connecting to the instance.
public_data_endpoint_enabled bool: Whether or not the public data endpoint is enabled.
requested_backup_storage_redundancy str: 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)
service_principal ServicePrincipalResponse: The managed instance's service principal.
sku SkuResponse: Managed instance SKU. Allowed values for sku.name: GP_Gen5, GP_G8IM, GP_G8IH, BC_Gen5, BC_G8IM, BC_G8IH
storage_i_ops int: Storage IOps. Minimum value: 300. Maximum value: 80000. Increments of 1 IOps allowed only. Maximum value depends on the selected hardware family and number of vCores.
storage_size_in_gb int: 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.
storage_throughput_m_bps int: Storage throughput MBps parameter is not supported in the instance create/update operation.
subnet_id str: Subnet resource ID for the managed instance.
tags Mapping[str, str]: Resource tags.
timezone_id str: 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".
v_cores int: The number of vCores. Allowed values: 8, 16, 24, 32, 40, 64, 80.
zone_redundant bool: Whether or not the multi-az is enabled.

azureApiVersion String: The Azure API version of the resource.
createTime String: Specifies the point in time (ISO8601 format) of the Managed Instance creation.
currentBackupStorageRedundancy String: The storage account type used to store backups for this instance. The options are Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) and GeoZone(GeoZoneRedundantStorage)
dnsZone String: The Dns Zone that the managed instance is in.
externalGovernanceStatus String: Status of external governance.
fullyQualifiedDomainName String: The fully qualified domain name of the managed instance.
hybridSecondaryUsageDetected String: Hybrid secondary usage detected. Possible values are 'Active' (customer does not meet the requirements to use the secondary as Passive DR) and 'Passive' (customer meets the requirements to use the secondary as Passive DR).
id String: Resource ID.
location String: Resource location.
name String: Resource name.
privateEndpointConnections List<Property Map>: List of private endpoint connections on a managed instance.
provisioningState String: Provisioning state of managed instance.
state String: The state of the managed instance.
type String: Resource type.
virtualClusterId String: Virtual cluster resource id for the Managed Instance.
administratorLogin String: Administrator username for the managed instance. Can only be specified when the managed instance is being created (and is required for creation).
administrators Property Map: 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.
authenticationMetadata String: The managed instance's authentication metadata lookup mode.
collation String: Collation of the managed instance.
databaseFormat String: Specifies the internal format of instance databases specific to the SQL engine version.
hybridSecondaryUsage String: Hybrid secondary usage. Possible values are 'Active' (default value) and 'Passive' (customer uses the secondary as Passive DR).
identity Property Map: The Azure Active Directory identity of the managed instance.
instancePoolId String: The Id of the instance pool this managed server belongs to.
isGeneralPurposeV2 Boolean: Whether or not this is a GPv2 variant of General Purpose edition.
keyId String: A CMK URI of the key to use for encryption.
licenseType String: 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).
maintenanceConfigurationId String: Specifies maintenance configuration id to apply to this managed instance.
minimalTlsVersion String: Minimal TLS version. Allowed values: 'None', '1.0', '1.1', '1.2'
pricingModel String: Pricing model of Managed Instance.
primaryUserAssignedIdentityId String: The resource id of a user assigned identity to be used by default.
proxyOverride String: Connection type used for connecting to the instance.
publicDataEndpointEnabled Boolean: Whether or not the public data endpoint is enabled.
requestedBackupStorageRedundancy String: 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)
servicePrincipal Property Map: The managed instance's service principal.
sku Property Map: Managed instance SKU. Allowed values for sku.name: GP_Gen5, GP_G8IM, GP_G8IH, BC_Gen5, BC_G8IM, BC_G8IH
storageIOps Number: Storage IOps. Minimum value: 300. Maximum value: 80000. Increments of 1 IOps allowed only. Maximum value depends on the selected hardware family and number of vCores.
storageSizeInGB Number: 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.
storageThroughputMBps Number: Storage throughput MBps parameter is not supported in the instance create/update operation.
subnetId String: Subnet resource ID for the managed instance.
tags Map<String>: Resource tags.
timezoneId String: 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 Number: The number of vCores. Allowed values: 8, 16, 24, 32, 40, 64, 80.
zoneRedundant Boolean: Whether or not the multi-az is enabled.

Supporting Types

ManagedInstanceExternalAdministratorResponse

AdministratorType string: Type of the sever administrator.
AzureADOnlyAuthentication bool: Azure Active Directory only Authentication enabled.
Login string: Login name of the server administrator.
PrincipalType string: Principal Type of the sever administrator.
Sid string: SID (object ID) of the server administrator.
TenantId string: Tenant ID of the administrator.

AdministratorType string: Type of the sever administrator.
AzureADOnlyAuthentication bool: Azure Active Directory only Authentication enabled.
Login string: Login name of the server administrator.
PrincipalType string: Principal Type of the sever administrator.
Sid string: SID (object ID) of the server administrator.
TenantId string: Tenant ID of the administrator.

administratorType String: Type of the sever administrator.
azureADOnlyAuthentication Boolean: Azure Active Directory only Authentication enabled.
login String: Login name of the server administrator.
principalType String: Principal Type of the sever administrator.
sid String: SID (object ID) of the server administrator.
tenantId String: Tenant ID of the administrator.

administratorType string: Type of the sever administrator.
azureADOnlyAuthentication boolean: Azure Active Directory only Authentication enabled.
login string: Login name of the server administrator.
principalType string: Principal Type of the sever administrator.
sid string: SID (object ID) of the server administrator.
tenantId string: Tenant ID of the administrator.

administrator_type str: Type of the sever administrator.
azure_ad_only_authentication bool: Azure Active Directory only Authentication enabled.
login str: Login name of the server administrator.
principal_type str: Principal Type of the sever administrator.
sid str: SID (object ID) of the server administrator.
tenant_id str: Tenant ID of the administrator.

administratorType String: Type of the sever administrator.
azureADOnlyAuthentication Boolean: Azure Active Directory only Authentication enabled.
login String: Login name of the server administrator.
principalType String: Principal Type of the sever administrator.
sid String: SID (object ID) of the server administrator.
tenantId String: Tenant ID of the administrator.

ManagedInstancePecPropertyResponse

Id string: Resource ID.
Properties Pulumi.AzureNative.Sql.Inputs.ManagedInstancePrivateEndpointConnectionPropertiesResponse: Private endpoint connection properties

Id string: Resource ID.
Properties ManagedInstancePrivateEndpointConnectionPropertiesResponse: Private endpoint connection properties

id String: Resource ID.
properties ManagedInstancePrivateEndpointConnectionPropertiesResponse: Private endpoint connection properties

id string: Resource ID.
properties ManagedInstancePrivateEndpointConnectionPropertiesResponse: Private endpoint connection properties

id str: Resource ID.
properties ManagedInstancePrivateEndpointConnectionPropertiesResponse: Private endpoint connection properties

id String: Resource ID.
properties Property Map: Private endpoint connection properties

ManagedInstancePrivateEndpointConnectionPropertiesResponse

ProvisioningState string: State of the Private Endpoint Connection.
PrivateEndpoint Pulumi.AzureNative.Sql.Inputs.ManagedInstancePrivateEndpointPropertyResponse: Private endpoint which the connection belongs to.
PrivateLinkServiceConnectionState Pulumi.AzureNative.Sql.Inputs.ManagedInstancePrivateLinkServiceConnectionStatePropertyResponse: Connection State of the Private Endpoint Connection.

ProvisioningState string: State of the Private Endpoint Connection.
PrivateEndpoint ManagedInstancePrivateEndpointPropertyResponse: Private endpoint which the connection belongs to.
PrivateLinkServiceConnectionState ManagedInstancePrivateLinkServiceConnectionStatePropertyResponse: Connection State of the Private Endpoint Connection.

provisioningState String: State of the Private Endpoint Connection.
privateEndpoint ManagedInstancePrivateEndpointPropertyResponse: Private endpoint which the connection belongs to.
privateLinkServiceConnectionState ManagedInstancePrivateLinkServiceConnectionStatePropertyResponse: Connection State of the Private Endpoint Connection.

provisioningState string: State of the Private Endpoint Connection.
privateEndpoint ManagedInstancePrivateEndpointPropertyResponse: Private endpoint which the connection belongs to.
privateLinkServiceConnectionState ManagedInstancePrivateLinkServiceConnectionStatePropertyResponse: Connection State of the Private Endpoint Connection.

provisioning_state str: State of the Private Endpoint Connection.
private_endpoint ManagedInstancePrivateEndpointPropertyResponse: Private endpoint which the connection belongs to.
private_link_service_connection_state ManagedInstancePrivateLinkServiceConnectionStatePropertyResponse: Connection State of the Private Endpoint Connection.

provisioningState String: State of the Private Endpoint Connection.
privateEndpoint Property Map: Private endpoint which the connection belongs to.
privateLinkServiceConnectionState Property Map: Connection State of the Private Endpoint Connection.

ManagedInstancePrivateEndpointPropertyResponse

Id string: Resource id of the private endpoint.

Id string: Resource id of the private endpoint.

id String: Resource id of the private endpoint.

id string: Resource id of the private endpoint.

id str: Resource id of the private endpoint.

id String: Resource id of the private endpoint.

ManagedInstancePrivateLinkServiceConnectionStatePropertyResponse

ActionsRequired string: The private link service connection description.
Description string: The private link service connection description.
Status string: The private link service connection status.

ActionsRequired string: The private link service connection description.
Description string: The private link service connection description.
Status string: The private link service connection status.

actionsRequired String: The private link service connection description.
description String: The private link service connection description.
status String: The private link service connection status.

actionsRequired string: The private link service connection description.
description string: The private link service connection description.
status string: The private link service connection status.

actions_required str: The private link service connection description.
description str: The private link service connection description.
status str: The private link service connection status.

actionsRequired String: The private link service connection description.
description String: The private link service connection description.
status String: The private link service connection status.

ResourceIdentityResponse

PrincipalId string: The Azure Active Directory principal id.
TenantId string: The Azure Active Directory tenant id.
Type string: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource.
UserAssignedIdentities Dictionary<string, Pulumi.AzureNative.Sql.Inputs.UserIdentityResponse>: The resource ids of the user assigned identities to use

PrincipalId string: The Azure Active Directory principal id.
TenantId string: The Azure Active Directory tenant id.
Type string: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource.
UserAssignedIdentities map[string]UserIdentityResponse: The resource ids of the user assigned identities to use

principalId String: The Azure Active Directory principal id.
tenantId String: The Azure Active Directory tenant id.
type String: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource.
userAssignedIdentities Map<String,UserIdentityResponse>: The resource ids of the user assigned identities to use

principalId string: The Azure Active Directory principal id.
tenantId string: The Azure Active Directory tenant id.
type string: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource.
userAssignedIdentities {[key: string]: UserIdentityResponse}: The resource ids of the user assigned identities to use

principal_id str: The Azure Active Directory principal id.
tenant_id str: The Azure Active Directory tenant id.
type str: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource.
user_assigned_identities Mapping[str, UserIdentityResponse]: The resource ids of the user assigned identities to use

principalId String: The Azure Active Directory principal id.
tenantId String: The Azure Active Directory tenant id.
type String: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource.
userAssignedIdentities Map<Property Map>: The resource ids of the user assigned identities to use

ServicePrincipalResponse

ClientId string: The Azure Active Directory application client id.
PrincipalId string: The Azure Active Directory application object id.
TenantId string: The Azure Active Directory tenant id.
Type string: Service principal type.

ClientId string: The Azure Active Directory application client id.
PrincipalId string: The Azure Active Directory application object id.
TenantId string: The Azure Active Directory tenant id.
Type string: Service principal type.

clientId String: The Azure Active Directory application client id.
principalId String: The Azure Active Directory application object id.
tenantId String: The Azure Active Directory tenant id.
type String: Service principal type.

clientId string: The Azure Active Directory application client id.
principalId string: The Azure Active Directory application object id.
tenantId string: The Azure Active Directory tenant id.
type string: Service principal type.

client_id str: The Azure Active Directory application client id.
principal_id str: The Azure Active Directory application object id.
tenant_id str: The Azure Active Directory tenant id.
type str: Service principal type.

clientId String: The Azure Active Directory application client id.
principalId String: The Azure Active Directory application object id.
tenantId String: The Azure Active Directory tenant id.
type String: Service principal type.

SkuResponse

Name string: The name of the SKU, typically, a letter + Number code, e.g. P3.
Capacity int: Capacity of the particular SKU.
Family string: If the service has different generations of hardware, for the same SKU, then that can be captured here.
Size string: Size of the particular SKU
Tier string: The tier or edition of the particular SKU, e.g. Basic, Premium.

Name string: The name of the SKU, typically, a letter + Number code, e.g. P3.
Capacity int: Capacity of the particular SKU.
Family string: If the service has different generations of hardware, for the same SKU, then that can be captured here.
Size string: Size of the particular SKU
Tier string: The tier or edition of the particular SKU, e.g. Basic, Premium.

name String: The name of the SKU, typically, a letter + Number code, e.g. P3.
capacity Integer: Capacity of the particular SKU.
family String: If the service has different generations of hardware, for the same SKU, then that can be captured here.
size String: Size of the particular SKU
tier String: The tier or edition of the particular SKU, e.g. Basic, Premium.

name string: The name of the SKU, typically, a letter + Number code, e.g. P3.
capacity number: Capacity of the particular SKU.
family string: If the service has different generations of hardware, for the same SKU, then that can be captured here.
size string: Size of the particular SKU
tier string: The tier or edition of the particular SKU, e.g. Basic, Premium.

name str: The name of the SKU, typically, a letter + Number code, e.g. P3.
capacity int: Capacity of the particular SKU.
family str: If the service has different generations of hardware, for the same SKU, then that can be captured here.
size str: Size of the particular SKU
tier str: The tier or edition of the particular SKU, e.g. Basic, Premium.

name String: The name of the SKU, typically, a letter + Number code, e.g. P3.
capacity Number: Capacity of the particular SKU.
family String: If the service has different generations of hardware, for the same SKU, then that can be captured here.
size String: Size of the particular SKU
tier String: The tier or edition of the particular SKU, e.g. Basic, Premium.

UserIdentityResponse

ClientId string: The Azure Active Directory client id.
PrincipalId string: The Azure Active Directory principal id.

ClientId string: The Azure Active Directory client id.
PrincipalId string: The Azure Active Directory principal id.

clientId String: The Azure Active Directory client id.
principalId String: The Azure Active Directory principal id.

clientId string: The Azure Active Directory client id.
principalId string: The Azure Active Directory principal id.

client_id str: The Azure Active Directory client id.
principal_id str: The Azure Active Directory principal id.

clientId String: The Azure Active Directory client id.
principalId String: The Azure Active Directory principal id.

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.

Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

pulumi/pulumi-azure-native

azure-native.sql.getManagedInstance

On this page

On this page

Using getManagedInstance

getManagedInstance Result

Supporting Types

ManagedInstanceExternalAdministratorResponse

ManagedInstancePecPropertyResponse

ManagedInstancePrivateEndpointConnectionPropertiesResponse

ManagedInstancePrivateEndpointPropertyResponse

ManagedInstancePrivateLinkServiceConnectionStatePropertyResponse

ResourceIdentityResponse

ServicePrincipalResponse

SkuResponse

UserIdentityResponse

Package Details

On this page

On this page