Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

Get-AzSqlServerConfigurationOption

Module:
Az.Sql Module

Returns information about server configuration options for Azure SQL Managed Instance.

Syntax

GetByNameParameterSet (Default) 

Get-AzSqlServerConfigurationOption
 [-ResourceGroupName] <String>
 [-InstanceName] <String>
 [[-Name] <String>]
 [-DefaultProfile <IAzureContextContainer>]
 [<CommonParameters>]

GetByParentObjectParameterSet 

Get-AzSqlServerConfigurationOption
 [[-Name] <String>]
 [-InstanceObject] <AzureSqlManagedInstanceModel>
 [-DefaultProfile <IAzureContextContainer>]
 [<CommonParameters>]

GetByInstanceResourceIdParameterSet 

Get-AzSqlServerConfigurationOption
 [[-Name] <String>]
 [-InstanceResourceId] <String>
 [-DefaultProfile <IAzureContextContainer>]
 [<CommonParameters>]

GetByResourceIdParameterSet 

Get-AzSqlServerConfigurationOption
 [-ResourceId] <String>
 [-DefaultProfile <IAzureContextContainer>]
 [<CommonParameters>]

Description

The Get-AzSqlServerConfigurationOption cmdlet returns information about one or more server configuration option on Azure SQL Managed Instance. Specify the name of a server configuration option to see information for that option only.

Examples

Example 1

Get-AzSqlServerConfigurationOption -ResourceGroupName "ResourceGroup01" -InstanceName "ManagedInstance01" -Name "allowPolybaseExport"

ResourceGroupName : ResourceGroup01
InstanceName : ManagedInstance01
Type : Microsoft.Sql/managedInstances/serverConfigurationOptions
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ResourceGroup01/providers/Microsoft.Sql/managedInstances/ManagedInstance01/serverConfigurationOptions/allowPolybaseExport
Name : allowPolybaseExport
Value : 0

This command gets information about the server configuration option named "allowPolybaseExport" on instance "Instance01" and resource group "ResourceGroup01".

Parameters

-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

-InstanceName

Name of Azure SQL Managed Instance.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-InstanceObject

Instance input object.

Parameter properties

Type:AzureSqlManagedInstanceModel
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-InstanceResourceId

Managed instance resource ID.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-Name

Name of the server configuration option.

Parameter properties

Type:String
Default value:None
Accepted values:allowPolybaseExport
Supports wildcards:False
DontShow:False
Aliases:ConfigOptionName

Parameter sets

-ResourceGroupName

Name of the resource group.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-ResourceId

Server configuration option resource ID.

Parameter properties

Type:String
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

ServerConfigurationOptionsModel

Related Links

Feedback

Was this page helpful?