Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
Set-AzSqlInstance
- Module:
- Az.Sql Module
Sets properties for an Azure SQL Managed Instance.
Syntax
SetInstanceFromInputParameters (Default)
Set-AzSqlInstance
[-Name] <String>
[-ResourceGroupName] <String>
[-AdministratorPassword <SecureString>]
[-Edition <String>]
[-IsGeneralPurposeV2 <Boolean>]
[-SubnetId <String>]
[-LicenseType <String>]
[-StorageSizeInGB <Int32>]
[-StorageIOps <Int32>]
[-VCore <Int32>]
[-MemorySizeInGB <Int32>]
[-PublicDataEndpointEnabled <Boolean>]
[-ProxyOverride <String>]
[-Tag <Hashtable>]
[-AssignIdentity]
[-InstancePoolName <String>]
[-MinimalTlsVersion <String>]
[-PrimaryUserAssignedIdentityId <String>]
[-KeyId <String>]
[-Force]
[-ComputeGeneration <String>]
[-MaintenanceConfigurationId <String>]
[-UserAssignedIdentityId <System.Collections.Generic.List`1[System.String]>]
[-IdentityType <String>]
[-BackupStorageRedundancy <String>]
[-AsJob]
[-ZoneRedundant]
[-ServicePrincipalType <String>]
[-DatabaseFormat <String>]
[-PricingModel <String>]
[-AuthenticationMetadata <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
SetInstanceFromAzureSqlManagedInstanceModelInstanceDefinition
Set-AzSqlInstance
[-InputObject] <AzureSqlManagedInstanceModel>
[-AdministratorPassword <SecureString>]
[-Edition <String>]
[-IsGeneralPurposeV2 <Boolean>]
[-SubnetId <String>]
[-LicenseType <String>]
[-StorageSizeInGB <Int32>]
[-StorageIOps <Int32>]
[-VCore <Int32>]
[-MemorySizeInGB <Int32>]
[-PublicDataEndpointEnabled <Boolean>]
[-ProxyOverride <String>]
[-Tag <Hashtable>]
[-AssignIdentity]
[-InstancePoolName <String>]
[-MinimalTlsVersion <String>]
[-PrimaryUserAssignedIdentityId <String>]
[-KeyId <String>]
[-Force]
[-ComputeGeneration <String>]
[-MaintenanceConfigurationId <String>]
[-UserAssignedIdentityId <System.Collections.Generic.List`1[System.String]>]
[-IdentityType <String>]
[-BackupStorageRedundancy <String>]
[-AsJob]
[-ZoneRedundant]
[-ServicePrincipalType <String>]
[-DatabaseFormat <String>]
[-PricingModel <String>]
[-AuthenticationMetadata <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
SetInstanceFromAzureResourceId
Set-AzSqlInstance
[-ResourceId] <String>
[-AdministratorPassword <SecureString>]
[-Edition <String>]
[-IsGeneralPurposeV2 <Boolean>]
[-SubnetId <String>]
[-LicenseType <String>]
[-StorageSizeInGB <Int32>]
[-StorageIOps <Int32>]
[-VCore <Int32>]
[-MemorySizeInGB <Int32>]
[-PublicDataEndpointEnabled <Boolean>]
[-ProxyOverride <String>]
[-Tag <Hashtable>]
[-AssignIdentity]
[-InstancePoolName <String>]
[-MinimalTlsVersion <String>]
[-PrimaryUserAssignedIdentityId <String>]
[-KeyId <String>]
[-Force]
[-ComputeGeneration <String>]
[-MaintenanceConfigurationId <String>]
[-UserAssignedIdentityId <System.Collections.Generic.List`1[System.String]>]
[-IdentityType <String>]
[-BackupStorageRedundancy <String>]
[-AsJob]
[-ZoneRedundant]
[-ServicePrincipalType <String>]
[-DatabaseFormat <String>]
[-PricingModel <String>]
[-AuthenticationMetadata <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Set-AzSqlInstance cmdlet modifies properties of an Azure SQL Managed instance.
Examples
Example 1: Set existing instance using new values for -AdministratorPassword, -LicenseType, -StorageSizeInGB, -VCore and -Edition
$SecureString = ConvertTo-SecureString -String "****" -AsPlainText -Force
Set-AzSqlInstance -Name "managedinstance1" -ResourceGroupName "ResourceGroup01" -AdministratorPassword $SecureString -LicenseType LicenseIncluded -StorageSizeInGB 1024 -VCore 16 -Edition BusinessCritical
Location : westcentralus
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance1
ResourceGroupName : resourcegroup01
ManagedInstanceName : managedInstance1
Tags :
Identity : Microsoft.Azure.Management.Sql.Models.ResourceIdentity
Sku : Microsoft.Azure.Management.Internal.Resources.Models.Sku
IsGeneralPurposeV2 :
FullyQualifiedDomainName : managedInstance1.wcusxxxxxxxxxxxxx.database.windows.net
AdministratorLogin : adminLogin1
AdministratorPassword :
SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name
LicenseType : LicenseIncluded
VCores : 16
MemorySizeInGB :
StorageSizeInGB : 1024
StorageIOps :
InstancePoolName :
Example 2: Change existing instance hardware generation using new value for -ComputeGeneration
Set-AzSqlInstance -Name "managedinstance1" -ResourceGroupName "ResourceGroup01" -ComputeGeneration Gen5
Location : westcentralus
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance1
ResourceGroupName : resourcegroup01
ManagedInstanceName : managedInstance1
Tags :
Identity : Microsoft.Azure.Management.Sql.Models.ResourceIdentity
Sku : Microsoft.Azure.Management.Internal.Resources.Models.Sku
IsGeneralPurposeV2 :
FullyQualifiedDomainName : managedInstance1.wcusxxxxxxxxxxxxx.database.windows.net
AdministratorLogin : adminLogin1
AdministratorPassword :
SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name
LicenseType : LicenseIncluded
VCores : 16
MemorySizeInGB :
StorageSizeInGB : 1024
StorageIOps :
InstancePoolName :
This command sets existing instance using new values for -AdministratorPassword, -LicenseType, -StorageSizeInGB and -VCore
Example 3: Change existing instance to GPv2 by setting new values for -Edition, -ComputeGeneration, -IsGeneralPurposeV2. Also set new values for -VCore, StorageSizeInGB, StorageIOps
Set-AzSqlInstance -Name "managedinstance1" -ResourceGroupName "ResourceGroup01" -Edition "GeneralPurpose" -ComputeGeneration "Gen5" -IsGeneralPurposeV2 $true -VCore 8 -StorageSizeInGB 1024 -StorageIOps 4000
Location : westcentralus
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance1
ResourceGroupName : resourcegroup01
ManagedInstanceName : managedInstance1
Tags :
Identity : Microsoft.Azure.Management.Sql.Models.ResourceIdentity
Sku : Microsoft.Azure.Management.Internal.Resources.Models.Sku
IsGeneralPurposeV2 : true
FullyQualifiedDomainName : managedInstance1.wcusxxxxxxxxxxxxx.database.windows.net
AdministratorLogin : adminLogin1
AdministratorPassword :
SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name
LicenseType : LicenseIncluded
VCores : 8
MemorySizeInGB :
StorageSizeInGB : 1024
StorageIOps : 4000
InstancePoolName :
This command changes existing instance to GPv2 by setting new values for -Edition, -ComputeGeneration, -IsGeneralPurposeV2. Also sets new values for -VCore, StorageSizeInGB, StorageIOps
Example 4: Set existing instance using new values for -AdministratorPassword, -LicenseType, -StorageSizeInGB and -VCore for an instance within an instance pool
$SecureString = ConvertTo-SecureString -String "****" -AsPlainText -Force
Set-AzSqlInstance -Name "managedinstance1" -ResourceGroupName "ResourceGroup01" -AdministratorPassword $SecureString -LicenseType LicenseIncluded -StorageSizeInGB 1024 -VCore 2 -InstancePoolName instancePool0
Location : westcentralus
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance1
ResourceGroupName : resourcegroup01
ManagedInstanceName : managedInstance1
Tags :
Identity : Microsoft.Azure.Management.Sql.Models.ResourceIdentity
Sku : Microsoft.Azure.Management.Internal.Resources.Models.Sku
FullyQualifiedDomainName : managedInstance1.wcusxxxxxxxxxxxxx.database.windows.net
AdministratorLogin : adminLogin1
AdministratorPassword :
SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name
LicenseType : LicenseIncluded
VCores : 2
StorageSizeInGB : 1024
InstancePoolName : instancePool0
This command sets existing instance using new values for -AdministratorPassword, -LicenseType, -StorageSizeInGB and -VCore for an instance within an instance pool
Example 5: Update maintenance configuration for existing instance
Set-AzSqlInstance -Name "managedInstance1" -ResourceGroupName "resourcegroup01" -MaintenanceConfigurationId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_WestUS_MI_2"
Location : westus
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance1
ResourceGroupName : resourcegroup01
ManagedInstanceName : managedInstance1
Tags :
Identity :
Sku : Microsoft.Azure.Management.Internal.Resources.Models.Sku
IsGeneralPurposeV2 :
FullyQualifiedDomainName : managedInstance1.wusxxxxxxxxxxxxx.database.windows.net
AdministratorLogin : adminLogin1
AdministratorPassword :
SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name
LicenseType : LicenseIncluded
VCores : 8
MemorySizeInGB :
StorageSizeInGB : 256
StorageIOps :
Collation : SQL_Latin1_General_CP1_CI_AS
PublicDataEndpointEnabled : False
ProxyOverride :
TimezoneId : UTC
DnsZonePartner :
DnsZone : ad35cna0mw
InstancePoolName :
MinimalTlsVersion :
BackupStorageRedundancy : Geo
CurrentBackupStorageRedundancy : Geo
MaintenanceConfigurationId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_WestUS_MI_2
This command updates existing instance with maintenance configuration MI_2
Example 6: Remove maintenance configuration from existing instance
Set-AzSqlInstance -Name "managediInstance1" -ResourceGroupName "Resourcegroup01" -MaintenanceConfigurationId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_Default"
Location : westus
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance1
ResourceGroupName : resourcegroup01
ManagedInstanceName : managedInstance1
Tags :
Identity :
Sku : Microsoft.Azure.Management.Internal.Resources.Models.Sku
IsGeneralPurposeV2 :
FullyQualifiedDomainName : managedInstance1.wusxxxxxxxxxxxxx.database.windows.net
AdministratorLogin : adminLogin1
AdministratorPassword :
SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name
LicenseType : LicenseIncluded
VCores : 8
MemorySizeInGB :
StorageSizeInGB : 256
StorageIOps :
Collation : SQL_Latin1_General_CP1_CI_AS
PublicDataEndpointEnabled : False
ProxyOverride :
TimezoneId : UTC
DnsZonePartner :
DnsZone : ad35cna0mw
InstancePoolName :
MinimalTlsVersion :
BackupStorageRedundancy : Geo
CurrentBackupStorageRedundancy : Geo
MaintenanceConfigurationId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_Default
This command resets maintenance configuration to default for existing instance
Example 7: Move managed instance to another subnet
Set-AzSqlInstance -Name "managediInstance1" -ResourceGroupName "Resourcegroup01" -SubnetId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/target_subnet_name"
Location : westus
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance1
ResourceGroupName : resourcegroup01
ManagedInstanceName : managedInstance1
Tags :
Identity :
Sku : Microsoft.Azure.Management.Internal.Resources.Models.Sku
IsGeneralPurposeV2 :
FullyQualifiedDomainName : managedInstance1.wusxxxxxxxxxxxxx.database.windows.net
AdministratorLogin : adminLogin1
AdministratorPassword :
SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/target_subnet_name
LicenseType : LicenseIncluded
VCores : 8
MemorySizeInGB :
StorageSizeInGB : 256
StorageIOps :
Collation : SQL_Latin1_General_CP1_CI_AS
PublicDataEndpointEnabled : False
ProxyOverride :
TimezoneId : UTC
DnsZonePartner :
DnsZone : ad35cna0mw
InstancePoolName :
MinimalTlsVersion :
BackupStorageRedundancy : Geo
CurrentBackupStorageRedundancy : Geo
MaintenanceConfigurationId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_Default
This command moves managed instance to another subnet
Example 8: Update an existing instance to be zone - redundant
Set-AzSqlInstance -Name "managediInstance1" -ResourceGroupName "Resourcegroup01" -ZoneRedundant
Location : westus
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance1
ResourceGroupName : resourcegroup01
ManagedInstanceName : managedInstance1
Tags :
Identity :
Sku : Microsoft.Azure.Management.Internal.Resources.Models.Sku
IsGeneralPurposeV2 :
FullyQualifiedDomainName : managedInstance1.wusxxxxxxxxxxxxx.database.windows.net
AdministratorLogin : adminLogin1
AdministratorPassword :
SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/target_subnet_name
LicenseType : LicenseIncluded
VCores : 8
MemorySizeInGB :
StorageSizeInGB : 256
StorageIOps :
Collation : SQL_Latin1_General_CP1_CI_AS
PublicDataEndpointEnabled : False
ProxyOverride :
TimezoneId : UTC
DnsZonePartner :
DnsZone : ad35cna0mw
InstancePoolName :
MinimalTlsVersion :
BackupStorageRedundancy : Geo
CurrentBackupStorageRedundancy : Geo
MaintenanceConfigurationId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_Default
ZoneRedundant : true
This command updates an existing instance to be zone - redundant.
Example 9: Update backup storage redundancy on existing instance
Set-AzSqlInstance -Name "managediInstance1" -ResourceGroupName "Resourcegroup01" -BackupStorageRedundancy Local -Force
Location : westus
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance1
ResourceGroupName : resourcegroup01
ManagedInstanceName : managedInstance1
Tags :
Identity :
Sku : Microsoft.Azure.Management.Internal.Resources.Models.Sku
IsGeneralPurposeV2 :
FullyQualifiedDomainName : managedInstance1.wusxxxxxxxxxxxxx.database.windows.net
AdministratorLogin : adminLogin1
AdministratorPassword :
SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/target_subnet_name
LicenseType : LicenseIncluded
VCores : 8
MemorySizeInGB :
StorageSizeInGB : 256
StorageIOps :
Collation : SQL_Latin1_General_CP1_CI_AS
PublicDataEndpointEnabled : False
ProxyOverride :
TimezoneId : UTC
DnsZonePartner :
DnsZone : ad35cna0mw
InstancePoolName :
MinimalTlsVersion :
BackupStorageRedundancy : Geo
CurrentBackupStorageRedundancy : Geo
RequestedBackupStorageRedundancy : Local
MaintenanceConfigurationId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_Default
ZoneRedundant : False
This command changes backups storage redundancy type for managed instance
Example 10: Update an existing instance with database format and pricing model
Set-AzSqlInstance -Name "managediInstance1" -ResourceGroupName "Resourcegroup01" -DatabaseFormat AlwaysUpToDate -PricingModel Regular
Location : westus
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance1
ResourceGroupName : resourcegroup01
ManagedInstanceName : managedInstance1
Tags :
Identity :
Sku : Microsoft.Azure.Management.Internal.Resources.Models.Sku
IsGeneralPurposeV2 :
FullyQualifiedDomainName : managedInstance1.wusxxxxxxxxxxxxx.database.windows.net
AdministratorLogin : adminLogin1
AdministratorPassword :
SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/target_subnet_name
LicenseType : LicenseIncluded
VCores : 8
MemorySizeInGB :
StorageSizeInGB : 256
StorageIOps :
Collation : SQL_Latin1_General_CP1_CI_AS
PublicDataEndpointEnabled : False
ProxyOverride :
TimezoneId : UTC
DnsZonePartner :
DnsZone : ad35cna0mw
InstancePoolName :
MinimalTlsVersion :
BackupStorageRedundancy : Geo
CurrentBackupStorageRedundancy : Geo
MaintenanceConfigurationId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_Default
ZoneRedundant : true
DatabaseFormat : AlwaysUpToDate
PricingModel : Regular
This command updates managed instance with given with database format and pricing model specified.
Example 11: Update an existing managed instance to use Windows authentication metadata mode
Set-AzSqlInstance -Name managedInstance1 -ResourceGroupName ResourceGroup01 -AuthenticationMetadata Windows
Location : westcentralus
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance1
ResourceGroupName : resourcegroup01
ManagedInstanceName : managedInstance1
Tags :
Identity :
Sku : Microsoft.Azure.Management.Internal.Resources.Models.Sku
FullyQualifiedDomainName : managedInstance1.xxxxxxxxxxxx.database.windows.net
AdministratorLogin : adminLogin1
AdministratorPassword :
SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name
LicenseType : LicenseIncluded
VCores : 8
MemorySizeInGB :
StorageSizeInGB : 256
Collation : SQL_Latin1_General_CP1_CI_AS
PublicDataEndpointEnabled : False
ProxyOverride : Proxy
TimezoneId : UTC
DnsZonePartner :
DnsZone : ad35cna0mw
InstancePoolName :
MinimalTlsVersion :
BackupStorageRedundancy : Geo
RequestedBackupStorageRedundancy : Geo
CurrentBackupStorageRedundancy : Geo
MaintenanceConfigurationId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_Default
Administrators :
PrimaryUserAssignedIdentityId :
KeyId :
ZoneRedundant : False
ServicePrincipal :
DatabaseFormat : SQLServer2022
PricingModel : Regular
ExternalGovernanceStatus : Disabled
AuthenticationMetadata : Windows
This command updates an existing managed instance to use Windows metadata for authentication of synced users.
Example 12: Change existing instance by setting new value to MemorySizeInGB and keeping current or setting new value for VCores and keeping NextGen GP edition (v2)
Set-AzSqlInstance -Name "managedinstance1" -ResourceGroupName "ResourceGroup01" -MemorySizeInGB 64 -VCore 8 -IsGeneralPurposeV2 $true
Location : westcentralus
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Sql/managedInstances/managedInstance1
ResourceGroupName : resourcegroup01
ManagedInstanceName : managedInstance1
Tags :
Identity : Microsoft.Azure.Management.Sql.Models.ResourceIdentity
Sku : Microsoft.Azure.Management.Internal.Resources.Models.Sku
IsGeneralPurposeV2 : true
FullyQualifiedDomainName : managedInstance1.wcusxxxxxxxxxxxxx.database.windows.net
AdministratorLogin : adminLogin1
AdministratorPassword :
SubnetId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourcegroup01/providers/Microsoft.Network/virtualNetworks/vnet_name/subnets/subnet_name
LicenseType : LicenseIncluded
VCores : 8
MemorySizeInGB : 64
StorageSizeInGB : 1024
StorageIOps : 4000
InstancePoolName :
Parameters
-AdministratorPassword
The new SQL administrator password for the instance.
Parameter properties
| Type: | SecureString |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-AsJob
Run cmdlet in the background
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-AssignIdentity
Generate and assign a Microsoft Entra identity for this instance for use with key management services like Azure KeyVault.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-AuthenticationMetadata
Preferred metadata to use for authentication of synced on-prem users. Default is AzureAD.
Parameter properties
| Type: | String |
| Default value: | None |
| Accepted values: | AzureAD, Paired, Windows |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-BackupStorageRedundancy
The Backup storage redundancy used to store backups for the Sql Azure Managed Instance. Options are: Local, Zone and Geo
Parameter properties
| Type: | String |
| Default value: | None |
| Accepted values: | Local, Zone, Geo, GeoZone |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ComputeGeneration
The compute generation for the instance.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
-DatabaseFormat
The database format for the instance. Possible values are:
- AlwaysUpToDate - The instance gets access to all new SQL engine features as soon as they are released in Azure. Database format keeps evolving to accommodate new features.
- SQLServer2022 - The instance keeps getting SQL engine bug fixes, security patches and small functional improvements via Cumulative Updates for SQL Server 2022 during its mainstream support period. Database format remains compatible with SQL Server 2022 during that time.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Parameter properties
| Type: | IAzureContextContainer |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
Parameter sets
-Edition
The edition to assign to the instance.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Force
Skip confirmation message for performing the action
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-IdentityType
Type of identity to be assigned to the server. Possible values are SystemAssigned, UserAssigned, 'SystemAssigned,UserAssigned' and None.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-InputObject
The AzureSqlManagedInstanceModel object to remove
Parameter properties
| Type: | AzureSqlManagedInstanceModel |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | SqlInstance |
Parameter sets
-InstancePoolName
The instance pool name.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-IsGeneralPurposeV2
Whether or not this is a GPv2 variant of General Purpose edition.
Parameter properties
| Type: | |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-KeyId
The Azure Key Vault URI that is used for encryption.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-LicenseType
Determines which License Type to use. Possible values are:
- BasePrice - Azure Hybrid Benefit (AHB) discounted pricing for existing SQL Server license owners is applied. Managed Instance service price will be discounted for existing SQL Server license owners.
- LicenseIncluded - Azure Hybrid Benefit (AHB) discount pricing for existing SQL Server license owners is not applied. Managed Instance service price will include a new SQL Server license costs.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-MaintenanceConfigurationId
The Maintenance configuration id for the Sql Azure Managed Instance.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-MemorySizeInGB
Determines how much memory in GB to associate with instance
Parameter properties
| Type: | |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-MinimalTlsVersion
The minimal TLS version to enforce for Managed instance
Parameter properties
| Type: | String |
| Default value: | None |
| Accepted values: | None, 1.0, 1.1, 1.2 |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Name
Instance name.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | InstanceName |
Parameter sets
-PricingModel
The pricing model for the instance.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-PrimaryUserAssignedIdentityId
The primary User Managed Identity(UMI) id.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ProxyOverride
The connection type used for connecting to the instance.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-PublicDataEndpointEnabled
Whether or not the public data endpoint is enabled for the instance.
Parameter properties
| Type: | |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ResourceGroupName
The name of the resource group.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ResourceId
The resource id of instance to remove
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ServicePrincipalType
Type of Service Principal to be used. Possible values are SystemAssigned and None.
Parameter properties
| Type: | String |
| Default value: | None |
| Accepted values: | None, SystemAssigned |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-StorageIOps
Determines how much Storage IOps to associate with instance
Parameter properties
| Type: | |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-StorageSizeInGB
Determines how much Storage size to associate with instance
Parameter properties
| Type: | |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-SubnetId
The Subnet Id to use for instance update.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Tag
The tags to associate with the instance.
Parameter properties
| Type: | Hashtable |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Tags |
Parameter sets
-UserAssignedIdentityId
The list of user assigned identities.
Parameter properties
| Type: | |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-VCore
Determines how much VCore to associate with instance
Parameter properties
| Type: | |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
-ZoneRedundant
Use zone redundant storage
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
AzureSqlManagedInstanceModel
String
Outputs
AzureSqlManagedInstanceModel
Collaborate with us on GitHub
The source for this content can be found on GitHub, where you can also create and review issues and pull requests. For more information, see our contributor guide.
Azure PowerShell
Feedback
Was this page helpful?