Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. devcenter
  5. getPool
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.devcenter.getPool

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-azure-native

    Gets a machine pool

    Uses Azure REST API version 2024-02-01.

    Other available API versions: 2023-04-01, 2023-08-01-preview, 2023-10-01-preview, 2024-05-01-preview, 2024-06-01-preview, 2024-07-01-preview, 2024-08-01-preview, 2024-10-01-preview, 2025-02-01, 2025-04-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native devcenter [ApiVersion]. See the version guide for details.

    Using getPool

    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 getPool(args: GetPoolArgs, opts?: InvokeOptions): Promise<GetPoolResult>
function getPoolOutput(args: GetPoolOutputArgs, opts?: InvokeOptions): Output<GetPoolResult>
    def get_pool(pool_name: Optional[str] = None,
             project_name: Optional[str] = None,
             resource_group_name: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetPoolResult
def get_pool_output(pool_name: Optional[pulumi.Input[str]] = None,
             project_name: Optional[pulumi.Input[str]] = None,
             resource_group_name: Optional[pulumi.Input[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetPoolResult]
    func LookupPool(ctx *Context, args *LookupPoolArgs, opts ...InvokeOption) (*LookupPoolResult, error)
func LookupPoolOutput(ctx *Context, args *LookupPoolOutputArgs, opts ...InvokeOption) LookupPoolResultOutput

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

    public static class GetPool 
{
    public static Task<GetPoolResult> InvokeAsync(GetPoolArgs args, InvokeOptions? opts = null)
    public static Output<GetPoolResult> Invoke(GetPoolInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPoolResult> getPool(GetPoolArgs args, InvokeOptions options)
public static Output<GetPoolResult> getPool(GetPoolArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:devcenter:getPool
  arguments:
    # arguments dictionary

    The following arguments are supported:

    PoolName string
    Name of the pool.
    ProjectName string
    The name of the project.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    PoolName string
    Name of the pool.
    ProjectName string
    The name of the project.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    poolName String
    Name of the pool.
    projectName String
    The name of the project.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    poolName string
    Name of the pool.
    projectName string
    The name of the project.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    pool_name str
    Name of the pool.
    project_name str
    The name of the project.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    poolName String
    Name of the pool.
    projectName String
    The name of the project.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getPool Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    DevBoxCount int
    Indicates the number of provisioned Dev Boxes in this pool.
    DevBoxDefinitionName string
    Name of a Dev Box definition in parent Project of this Pool
    HealthStatus string
    Overall health status of the Pool. Indicates whether or not the Pool is available to create Dev Boxes.
    HealthStatusDetails List<Pulumi.AzureNative.DevCenter.Outputs.HealthStatusDetailResponse>
    Details on the Pool health status to help diagnose issues. This is only populated when the pool status indicates the pool is in a non-healthy state
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    LicenseType string
    Specifies the license type indicating the caller has already acquired licenses for the Dev Boxes that will be created.
    LocalAdministrator string
    Indicates whether owners of Dev Boxes in this pool are added as local administrators on the Dev Box.
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    NetworkConnectionName string
    Name of a Network Connection in parent Project of this Pool
    ProvisioningState string
    The provisioning state of the resource.
    SystemData Pulumi.AzureNative.DevCenter.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    DisplayName string
    The display name of the pool.
    ManagedVirtualNetworkRegions List<string>
    The regions of the managed virtual network (required when managedNetworkType is Managed).
    SingleSignOnStatus string
    Indicates whether Dev Boxes in this pool are created with single sign on enabled. The also requires that single sign on be enabled on the tenant.
    StopOnDisconnect Pulumi.AzureNative.DevCenter.Outputs.StopOnDisconnectConfigurationResponse
    Stop on disconnect configuration settings for Dev Boxes created in this pool.
    Tags Dictionary<string, string>
    Resource tags.
    VirtualNetworkType string
    Indicates whether the pool uses a Virtual Network managed by Microsoft or a customer provided network.
    AzureApiVersion string
    The Azure API version of the resource.
    DevBoxCount int
    Indicates the number of provisioned Dev Boxes in this pool.
    DevBoxDefinitionName string
    Name of a Dev Box definition in parent Project of this Pool
    HealthStatus string
    Overall health status of the Pool. Indicates whether or not the Pool is available to create Dev Boxes.
    HealthStatusDetails []HealthStatusDetailResponse
    Details on the Pool health status to help diagnose issues. This is only populated when the pool status indicates the pool is in a non-healthy state
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    LicenseType string
    Specifies the license type indicating the caller has already acquired licenses for the Dev Boxes that will be created.
    LocalAdministrator string
    Indicates whether owners of Dev Boxes in this pool are added as local administrators on the Dev Box.
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    NetworkConnectionName string
    Name of a Network Connection in parent Project of this Pool
    ProvisioningState string
    The provisioning state of the resource.
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    DisplayName string
    The display name of the pool.
    ManagedVirtualNetworkRegions []string
    The regions of the managed virtual network (required when managedNetworkType is Managed).
    SingleSignOnStatus string
    Indicates whether Dev Boxes in this pool are created with single sign on enabled. The also requires that single sign on be enabled on the tenant.
    StopOnDisconnect StopOnDisconnectConfigurationResponse
    Stop on disconnect configuration settings for Dev Boxes created in this pool.
    Tags map[string]string
    Resource tags.
    VirtualNetworkType string
    Indicates whether the pool uses a Virtual Network managed by Microsoft or a customer provided network.
    azureApiVersion String
    The Azure API version of the resource.
    devBoxCount Integer
    Indicates the number of provisioned Dev Boxes in this pool.
    devBoxDefinitionName String
    Name of a Dev Box definition in parent Project of this Pool
    healthStatus String
    Overall health status of the Pool. Indicates whether or not the Pool is available to create Dev Boxes.
    healthStatusDetails List<HealthStatusDetailResponse>
    Details on the Pool health status to help diagnose issues. This is only populated when the pool status indicates the pool is in a non-healthy state
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    licenseType String
    Specifies the license type indicating the caller has already acquired licenses for the Dev Boxes that will be created.
    localAdministrator String
    Indicates whether owners of Dev Boxes in this pool are added as local administrators on the Dev Box.
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    networkConnectionName String
    Name of a Network Connection in parent Project of this Pool
    provisioningState String
    The provisioning state of the resource.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    displayName String
    The display name of the pool.
    managedVirtualNetworkRegions List<String>
    The regions of the managed virtual network (required when managedNetworkType is Managed).
    singleSignOnStatus String
    Indicates whether Dev Boxes in this pool are created with single sign on enabled. The also requires that single sign on be enabled on the tenant.
    stopOnDisconnect StopOnDisconnectConfigurationResponse
    Stop on disconnect configuration settings for Dev Boxes created in this pool.
    tags Map<String,String>
    Resource tags.
    virtualNetworkType String
    Indicates whether the pool uses a Virtual Network managed by Microsoft or a customer provided network.
    azureApiVersion string
    The Azure API version of the resource.
    devBoxCount number
    Indicates the number of provisioned Dev Boxes in this pool.
    devBoxDefinitionName string
    Name of a Dev Box definition in parent Project of this Pool
    healthStatus string
    Overall health status of the Pool. Indicates whether or not the Pool is available to create Dev Boxes.
    healthStatusDetails HealthStatusDetailResponse[]
    Details on the Pool health status to help diagnose issues. This is only populated when the pool status indicates the pool is in a non-healthy state
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    licenseType string
    Specifies the license type indicating the caller has already acquired licenses for the Dev Boxes that will be created.
    localAdministrator string
    Indicates whether owners of Dev Boxes in this pool are added as local administrators on the Dev Box.
    location string
    The geo-location where the resource lives
    name string
    The name of the resource
    networkConnectionName string
    Name of a Network Connection in parent Project of this Pool
    provisioningState string
    The provisioning state of the resource.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    displayName string
    The display name of the pool.
    managedVirtualNetworkRegions string[]
    The regions of the managed virtual network (required when managedNetworkType is Managed).
    singleSignOnStatus string
    Indicates whether Dev Boxes in this pool are created with single sign on enabled. The also requires that single sign on be enabled on the tenant.
    stopOnDisconnect StopOnDisconnectConfigurationResponse
    Stop on disconnect configuration settings for Dev Boxes created in this pool.
    tags {[key: string]: string}
    Resource tags.
    virtualNetworkType string
    Indicates whether the pool uses a Virtual Network managed by Microsoft or a customer provided network.
    azure_api_version str
    The Azure API version of the resource.
    dev_box_count int
    Indicates the number of provisioned Dev Boxes in this pool.
    dev_box_definition_name str
    Name of a Dev Box definition in parent Project of this Pool
    health_status str
    Overall health status of the Pool. Indicates whether or not the Pool is available to create Dev Boxes.
    health_status_details Sequence[HealthStatusDetailResponse]
    Details on the Pool health status to help diagnose issues. This is only populated when the pool status indicates the pool is in a non-healthy state
    id str
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    license_type str
    Specifies the license type indicating the caller has already acquired licenses for the Dev Boxes that will be created.
    local_administrator str
    Indicates whether owners of Dev Boxes in this pool are added as local administrators on the Dev Box.
    location str
    The geo-location where the resource lives
    name str
    The name of the resource
    network_connection_name str
    Name of a Network Connection in parent Project of this Pool
    provisioning_state str
    The provisioning state of the resource.
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    display_name str
    The display name of the pool.
    managed_virtual_network_regions Sequence[str]
    The regions of the managed virtual network (required when managedNetworkType is Managed).
    single_sign_on_status str
    Indicates whether Dev Boxes in this pool are created with single sign on enabled. The also requires that single sign on be enabled on the tenant.
    stop_on_disconnect StopOnDisconnectConfigurationResponse
    Stop on disconnect configuration settings for Dev Boxes created in this pool.
    tags Mapping[str, str]
    Resource tags.
    virtual_network_type str
    Indicates whether the pool uses a Virtual Network managed by Microsoft or a customer provided network.
    azureApiVersion String
    The Azure API version of the resource.
    devBoxCount Number
    Indicates the number of provisioned Dev Boxes in this pool.
    devBoxDefinitionName String
    Name of a Dev Box definition in parent Project of this Pool
    healthStatus String
    Overall health status of the Pool. Indicates whether or not the Pool is available to create Dev Boxes.
    healthStatusDetails List<Property Map>
    Details on the Pool health status to help diagnose issues. This is only populated when the pool status indicates the pool is in a non-healthy state
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    licenseType String
    Specifies the license type indicating the caller has already acquired licenses for the Dev Boxes that will be created.
    localAdministrator String
    Indicates whether owners of Dev Boxes in this pool are added as local administrators on the Dev Box.
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    networkConnectionName String
    Name of a Network Connection in parent Project of this Pool
    provisioningState String
    The provisioning state of the resource.
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    displayName String
    The display name of the pool.
    managedVirtualNetworkRegions List<String>
    The regions of the managed virtual network (required when managedNetworkType is Managed).
    singleSignOnStatus String
    Indicates whether Dev Boxes in this pool are created with single sign on enabled. The also requires that single sign on be enabled on the tenant.
    stopOnDisconnect Property Map
    Stop on disconnect configuration settings for Dev Boxes created in this pool.
    tags Map<String>
    Resource tags.
    virtualNetworkType String
    Indicates whether the pool uses a Virtual Network managed by Microsoft or a customer provided network.

    Supporting Types

    HealthStatusDetailResponse

    Code string
    An identifier for the issue.
    Message string
    A message describing the issue, intended to be suitable for display in a user interface
    Code string
    An identifier for the issue.
    Message string
    A message describing the issue, intended to be suitable for display in a user interface
    code String
    An identifier for the issue.
    message String
    A message describing the issue, intended to be suitable for display in a user interface
    code string
    An identifier for the issue.
    message string
    A message describing the issue, intended to be suitable for display in a user interface
    code str
    An identifier for the issue.
    message str
    A message describing the issue, intended to be suitable for display in a user interface
    code String
    An identifier for the issue.
    message String
    A message describing the issue, intended to be suitable for display in a user interface

    StopOnDisconnectConfigurationResponse

    GracePeriodMinutes int
    The specified time in minutes to wait before stopping a Dev Box once disconnect is detected.
    Status string
    Whether the feature to stop the Dev Box on disconnect once the grace period has lapsed is enabled.
    GracePeriodMinutes int
    The specified time in minutes to wait before stopping a Dev Box once disconnect is detected.
    Status string
    Whether the feature to stop the Dev Box on disconnect once the grace period has lapsed is enabled.
    gracePeriodMinutes Integer
    The specified time in minutes to wait before stopping a Dev Box once disconnect is detected.
    status String
    Whether the feature to stop the Dev Box on disconnect once the grace period has lapsed is enabled.
    gracePeriodMinutes number
    The specified time in minutes to wait before stopping a Dev Box once disconnect is detected.
    status string
    Whether the feature to stop the Dev Box on disconnect once the grace period has lapsed is enabled.
    grace_period_minutes int
    The specified time in minutes to wait before stopping a Dev Box once disconnect is detected.
    status str
    Whether the feature to stop the Dev Box on disconnect once the grace period has lapsed is enabled.
    gracePeriodMinutes Number
    The specified time in minutes to wait before stopping a Dev Box once disconnect is detected.
    status String
    Whether the feature to stop the Dev Box on disconnect once the grace period has lapsed is enabled.

    SystemDataResponse

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    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 v2 docs if using the v2 version of this package.
    Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi
    pulumi/pulumi-azure-native