@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 5.59 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Gets an elastic pool.
*
* Uses Azure REST API version 2023-08-01.
*
* Other available API versions: 2014-04-01, 2017-10-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, 2024-11-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](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getElasticPool(args: GetElasticPoolArgs, opts?: pulumi.InvokeOptions): Promise<GetElasticPoolResult>;
export interface GetElasticPoolArgs {
/**
* The name of the elastic pool.
*/
elasticPoolName: 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.
*/
resourceGroupName: string;
/**
* The name of the server.
*/
serverName: string;
}
/**
* An elastic pool.
*/
export interface GetElasticPoolResult {
/**
* Time in minutes after which elastic pool is automatically paused. A value of -1 means that automatic pause is disabled
*/
readonly autoPauseDelay?: number;
/**
* Specifies the availability zone the pool's primary replica is pinned to.
*/
readonly availabilityZone?: string;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: string;
/**
* The creation date of the elastic pool (ISO8601 format).
*/
readonly creationDate: string;
/**
* The number of secondary replicas associated with the Business Critical, Premium, or Hyperscale edition elastic pool that are used to provide high availability. Applicable only to Hyperscale elastic pools.
*/
readonly highAvailabilityReplicaCount?: number;
/**
* Resource ID.
*/
readonly id: string;
/**
* Kind of elastic pool. This is metadata used for the Azure portal experience.
*/
readonly kind: string;
/**
* The license type to apply for this elastic pool.
*/
readonly licenseType?: string;
/**
* Resource location.
*/
readonly location: string;
/**
* Maintenance configuration id assigned to the elastic pool. This configuration defines the period when the maintenance updates will will occur.
*/
readonly maintenanceConfigurationId?: string;
/**
* The storage limit for the database elastic pool in bytes.
*/
readonly maxSizeBytes?: number;
/**
* Minimal capacity that serverless pool will not shrink below, if not paused
*/
readonly minCapacity?: number;
/**
* Resource name.
*/
readonly name: string;
/**
* The per database settings for the elastic pool.
*/
readonly perDatabaseSettings?: outputs.sql.ElasticPoolPerDatabaseSettingsResponse;
/**
* Type of enclave requested on the elastic pool.
*/
readonly preferredEnclaveType?: string;
/**
* The elastic pool SKU.
*
* The list of SKUs may vary by region and support offer. To determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure region, use the `Capabilities_ListByLocation` REST API or the following command:
*
* ```azurecli
* az sql elastic-pool list-editions -l <location> -o table
* ````
*/
readonly sku?: outputs.sql.SkuResponse;
/**
* The state of the elastic pool.
*/
readonly state: string;
/**
* Resource tags.
*/
readonly tags?: {
[key: string]: string;
};
/**
* Resource type.
*/
readonly type: string;
/**
* Whether or not this elastic pool is zone redundant, which means the replicas of this elastic pool will be spread across multiple availability zones.
*/
readonly zoneRedundant?: boolean;
}
/**
* Gets an elastic pool.
*
* Uses Azure REST API version 2023-08-01.
*
* Other available API versions: 2014-04-01, 2017-10-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, 2024-11-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](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getElasticPoolOutput(args: GetElasticPoolOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetElasticPoolResult>;
export interface GetElasticPoolOutputArgs {
/**
* The name of the elastic pool.
*/
elasticPoolName: pulumi.Input<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.
*/
resourceGroupName: pulumi.Input<string>;
/**
* The name of the server.
*/
serverName: pulumi.Input<string>;
}