Docs Packages
  1. Packages
  2. Azure Native v1
  3. API Docs
  4. synapse
  5. getSqlPool
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

azure-native.synapse.getSqlPool

Explore with Pulumi AI

azure-native-v1 logo
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

    Get SQL pool properties API Version: 2021-03-01.

    Using getSqlPool

    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.

    function getSqlPool(args: GetSqlPoolArgs, opts?: InvokeOptions): Promise<GetSqlPoolResult>
function getSqlPoolOutput(args: GetSqlPoolOutputArgs, opts?: InvokeOptions): Output<GetSqlPoolResult>
    def get_sql_pool(resource_group_name: Optional[str] = None,
                 sql_pool_name: Optional[str] = None,
                 workspace_name: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetSqlPoolResult
def get_sql_pool_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                 sql_pool_name: Optional[pulumi.Input[str]] = None,
                 workspace_name: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetSqlPoolResult]
    func LookupSqlPool(ctx *Context, args *LookupSqlPoolArgs, opts ...InvokeOption) (*LookupSqlPoolResult, error)
func LookupSqlPoolOutput(ctx *Context, args *LookupSqlPoolOutputArgs, opts ...InvokeOption) LookupSqlPoolResultOutput

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

    public static class GetSqlPool 
{
    public static Task<GetSqlPoolResult> InvokeAsync(GetSqlPoolArgs args, InvokeOptions? opts = null)
    public static Output<GetSqlPoolResult> Invoke(GetSqlPoolInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetSqlPoolResult> getSqlPool(GetSqlPoolArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: azure-native:synapse:getSqlPool
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    SqlPoolName string
    SQL pool name
    WorkspaceName string
    The name of the workspace
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    SqlPoolName string
    SQL pool name
    WorkspaceName string
    The name of the workspace
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    sqlPoolName String
    SQL pool name
    workspaceName String
    The name of the workspace
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    sqlPoolName string
    SQL pool name
    workspaceName string
    The name of the workspace
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    sql_pool_name str
    SQL pool name
    workspace_name str
    The name of the workspace
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    sqlPoolName String
    SQL pool name
    workspaceName String
    The name of the workspace

    getSqlPool Result

    The following output properties are available:

    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Collation string
    Collation mode
    CreateMode string

    Specifies the mode of sql pool creation.

    Default: regular sql pool creation.

    PointInTimeRestore: Creates a sql pool by restoring a point in time backup of an existing sql pool. sourceDatabaseId must be specified as the resource ID of the existing sql pool, and restorePointInTime must be specified.

    Recovery: Creates a sql pool by a geo-replicated backup. sourceDatabaseId must be specified as the recoverableDatabaseId to restore.

    Restore: Creates a sql pool by restoring a backup of a deleted sql pool. SourceDatabaseId should be the sql pool's original resource ID. SourceDatabaseId and sourceDatabaseDeletionDate must be specified.

    CreationDate string
    Date the SQL pool was created
    MaxSizeBytes double
    Maximum size in bytes
    ProvisioningState string
    Resource state
    RecoverableDatabaseId string
    Backup database to restore from
    RestorePointInTime string
    Snapshot time to restore
    Sku Pulumi.AzureNative.Synapse.Outputs.SkuResponse
    SQL pool SKU
    SourceDatabaseId string
    Source database to create from
    Status string
    Resource status
    StorageAccountType string
    The storage account type used to store backups for this sql pool.
    Tags Dictionary<string, string>
    Resource tags.
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Collation string
    Collation mode
    CreateMode string

    Specifies the mode of sql pool creation.

    Default: regular sql pool creation.

    PointInTimeRestore: Creates a sql pool by restoring a point in time backup of an existing sql pool. sourceDatabaseId must be specified as the resource ID of the existing sql pool, and restorePointInTime must be specified.

    Recovery: Creates a sql pool by a geo-replicated backup. sourceDatabaseId must be specified as the recoverableDatabaseId to restore.

    Restore: Creates a sql pool by restoring a backup of a deleted sql pool. SourceDatabaseId should be the sql pool's original resource ID. SourceDatabaseId and sourceDatabaseDeletionDate must be specified.

    CreationDate string
    Date the SQL pool was created
    MaxSizeBytes float64
    Maximum size in bytes
    ProvisioningState string
    Resource state
    RecoverableDatabaseId string
    Backup database to restore from
    RestorePointInTime string
    Snapshot time to restore
    Sku SkuResponse
    SQL pool SKU
    SourceDatabaseId string
    Source database to create from
    Status string
    Resource status
    StorageAccountType string
    The storage account type used to store backups for this sql pool.
    Tags map[string]string
    Resource tags.
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    collation String
    Collation mode
    createMode String

    Specifies the mode of sql pool creation.

    Default: regular sql pool creation.

    PointInTimeRestore: Creates a sql pool by restoring a point in time backup of an existing sql pool. sourceDatabaseId must be specified as the resource ID of the existing sql pool, and restorePointInTime must be specified.

    Recovery: Creates a sql pool by a geo-replicated backup. sourceDatabaseId must be specified as the recoverableDatabaseId to restore.

    Restore: Creates a sql pool by restoring a backup of a deleted sql pool. SourceDatabaseId should be the sql pool's original resource ID. SourceDatabaseId and sourceDatabaseDeletionDate must be specified.

    creationDate String
    Date the SQL pool was created
    maxSizeBytes Double
    Maximum size in bytes
    provisioningState String
    Resource state
    recoverableDatabaseId String
    Backup database to restore from
    restorePointInTime String
    Snapshot time to restore
    sku SkuResponse
    SQL pool SKU
    sourceDatabaseId String
    Source database to create from
    status String
    Resource status
    storageAccountType String
    The storage account type used to store backups for this sql pool.
    tags Map<String,String>
    Resource tags.
    id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    location string
    The geo-location where the resource lives
    name string
    The name of the resource
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    collation string
    Collation mode
    createMode string

    Specifies the mode of sql pool creation.

    Default: regular sql pool creation.

    PointInTimeRestore: Creates a sql pool by restoring a point in time backup of an existing sql pool. sourceDatabaseId must be specified as the resource ID of the existing sql pool, and restorePointInTime must be specified.

    Recovery: Creates a sql pool by a geo-replicated backup. sourceDatabaseId must be specified as the recoverableDatabaseId to restore.

    Restore: Creates a sql pool by restoring a backup of a deleted sql pool. SourceDatabaseId should be the sql pool's original resource ID. SourceDatabaseId and sourceDatabaseDeletionDate must be specified.

    creationDate string
    Date the SQL pool was created
    maxSizeBytes number
    Maximum size in bytes
    provisioningState string
    Resource state
    recoverableDatabaseId string
    Backup database to restore from
    restorePointInTime string
    Snapshot time to restore
    sku SkuResponse
    SQL pool SKU
    sourceDatabaseId string
    Source database to create from
    status string
    Resource status
    storageAccountType string
    The storage account type used to store backups for this sql pool.
    tags {[key: string]: string}
    Resource tags.
    id str
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    location str
    The geo-location where the resource lives
    name str
    The name of the resource
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    collation str
    Collation mode
    create_mode str

    Specifies the mode of sql pool creation.

    Default: regular sql pool creation.

    PointInTimeRestore: Creates a sql pool by restoring a point in time backup of an existing sql pool. sourceDatabaseId must be specified as the resource ID of the existing sql pool, and restorePointInTime must be specified.

    Recovery: Creates a sql pool by a geo-replicated backup. sourceDatabaseId must be specified as the recoverableDatabaseId to restore.

    Restore: Creates a sql pool by restoring a backup of a deleted sql pool. SourceDatabaseId should be the sql pool's original resource ID. SourceDatabaseId and sourceDatabaseDeletionDate must be specified.

    creation_date str
    Date the SQL pool was created
    max_size_bytes float
    Maximum size in bytes
    provisioning_state str
    Resource state
    recoverable_database_id str
    Backup database to restore from
    restore_point_in_time str
    Snapshot time to restore
    sku SkuResponse
    SQL pool SKU
    source_database_id str
    Source database to create from
    status str
    Resource status
    storage_account_type str
    The storage account type used to store backups for this sql pool.
    tags Mapping[str, str]
    Resource tags.
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    collation String
    Collation mode
    createMode String

    Specifies the mode of sql pool creation.

    Default: regular sql pool creation.

    PointInTimeRestore: Creates a sql pool by restoring a point in time backup of an existing sql pool. sourceDatabaseId must be specified as the resource ID of the existing sql pool, and restorePointInTime must be specified.

    Recovery: Creates a sql pool by a geo-replicated backup. sourceDatabaseId must be specified as the recoverableDatabaseId to restore.

    Restore: Creates a sql pool by restoring a backup of a deleted sql pool. SourceDatabaseId should be the sql pool's original resource ID. SourceDatabaseId and sourceDatabaseDeletionDate must be specified.

    creationDate String
    Date the SQL pool was created
    maxSizeBytes Number
    Maximum size in bytes
    provisioningState String
    Resource state
    recoverableDatabaseId String
    Backup database to restore from
    restorePointInTime String
    Snapshot time to restore
    sku Property Map
    SQL pool SKU
    sourceDatabaseId String
    Source database to create from
    status String
    Resource status
    storageAccountType String
    The storage account type used to store backups for this sql pool.
    tags Map<String>
    Resource tags.

    Supporting Types

    SkuResponse

    Capacity int
    If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
    Name string
    The SKU name
    Tier string
    The service tier
    Capacity int
    If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
    Name string
    The SKU name
    Tier string
    The service tier
    capacity Integer
    If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
    name String
    The SKU name
    tier String
    The service tier
    capacity number
    If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
    name string
    The SKU name
    tier string
    The service tier
    capacity int
    If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
    name str
    The SKU name
    tier str
    The service tier
    capacity Number
    If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
    name String
    The SKU name
    tier String
    The service tier

    Package Details

    Repository
    azure-native-v1 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native-v1 logo
    These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
    Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
    pulumi/pulumi-azure-native