1. Packages
  2. Azure Native
  3. API Docs
  4. synapse
  5. getSqlPool
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.33.0 published on Friday, Mar 22, 2024 by Pulumi

azure-native.synapse.getSqlPool

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.33.0 published on Friday, Mar 22, 2024 by Pulumi

    Get SQL pool properties Azure REST API version: 2021-06-01.

    Other available API versions: 2021-05-01, 2021-06-01-preview.

    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:

    CreationDate string
    Date the SQL pool was created
    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
    Status string
    Resource status
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Collation string
    Collation mode
    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
    SourceDatabaseDeletionDate string
    Specifies the time that the sql pool was deleted
    StorageAccountType string
    The storage account type used to store backups for this sql pool.
    Tags Dictionary<string, string>
    Resource tags.
    CreationDate string
    Date the SQL pool was created
    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
    Status string
    Resource status
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Collation string
    Collation mode
    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
    SourceDatabaseDeletionDate string
    Specifies the time that the sql pool was deleted
    StorageAccountType string
    The storage account type used to store backups for this sql pool.
    Tags map[string]string
    Resource tags.
    creationDate String
    Date the SQL pool was created
    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
    status String
    Resource status
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    collation String
    Collation mode
    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
    sourceDatabaseDeletionDate String
    Specifies the time that the sql pool was deleted
    storageAccountType String
    The storage account type used to store backups for this sql pool.
    tags Map<String,String>
    Resource tags.
    creationDate string
    Date the SQL pool was created
    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
    status string
    Resource status
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    collation string
    Collation mode
    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
    sourceDatabaseDeletionDate string
    Specifies the time that the sql pool was deleted
    storageAccountType string
    The storage account type used to store backups for this sql pool.
    tags {[key: string]: string}
    Resource tags.
    creation_date str
    Date the SQL pool was created
    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
    status str
    Resource status
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    collation str
    Collation mode
    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_deletion_date str
    Specifies the time that the sql pool was deleted
    storage_account_type str
    The storage account type used to store backups for this sql pool.
    tags Mapping[str, str]
    Resource tags.
    creationDate String
    Date the SQL pool was created
    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
    status String
    Resource status
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    collation String
    Collation mode
    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
    sourceDatabaseDeletionDate String
    Specifies the time that the sql pool was deleted
    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 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.33.0 published on Friday, Mar 22, 2024 by Pulumi