1. Packages
  2. Azure Native
  3. API Docs
  4. machinelearningservices
  5. getInferencePool
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

azure-native.machinelearningservices.getInferencePool

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

    Uses Azure REST API version 2025-01-01-preview.

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

    Using getInferencePool

    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 getInferencePool(args: GetInferencePoolArgs, opts?: InvokeOptions): Promise<GetInferencePoolResult>
    function getInferencePoolOutput(args: GetInferencePoolOutputArgs, opts?: InvokeOptions): Output<GetInferencePoolResult>
    def get_inference_pool(inference_pool_name: Optional[str] = None,
                           resource_group_name: Optional[str] = None,
                           workspace_name: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetInferencePoolResult
    def get_inference_pool_output(inference_pool_name: Optional[pulumi.Input[str]] = None,
                           resource_group_name: Optional[pulumi.Input[str]] = None,
                           workspace_name: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetInferencePoolResult]
    func LookupInferencePool(ctx *Context, args *LookupInferencePoolArgs, opts ...InvokeOption) (*LookupInferencePoolResult, error)
    func LookupInferencePoolOutput(ctx *Context, args *LookupInferencePoolOutputArgs, opts ...InvokeOption) LookupInferencePoolResultOutput

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

    public static class GetInferencePool 
    {
        public static Task<GetInferencePoolResult> InvokeAsync(GetInferencePoolArgs args, InvokeOptions? opts = null)
        public static Output<GetInferencePoolResult> Invoke(GetInferencePoolInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetInferencePoolResult> getInferencePool(GetInferencePoolArgs args, InvokeOptions options)
    public static Output<GetInferencePoolResult> getInferencePool(GetInferencePoolArgs args, InvokeOptions options)
    
    fn::invoke:
      function: azure-native:machinelearningservices:getInferencePool
      arguments:
        # arguments dictionary

    The following arguments are supported:

    InferencePoolName string
    Name of InferencePool
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    WorkspaceName string
    Name of Azure Machine Learning workspace.
    InferencePoolName string
    Name of InferencePool
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    WorkspaceName string
    Name of Azure Machine Learning workspace.
    inferencePoolName String
    Name of InferencePool
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    workspaceName String
    Name of Azure Machine Learning workspace.
    inferencePoolName string
    Name of InferencePool
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    workspaceName string
    Name of Azure Machine Learning workspace.
    inference_pool_name str
    Name of InferencePool
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    workspace_name str
    Name of Azure Machine Learning workspace.
    inferencePoolName String
    Name of InferencePool
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    workspaceName String
    Name of Azure Machine Learning workspace.

    getInferencePool Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    InferencePoolProperties Pulumi.AzureNative.MachineLearningServices.Outputs.InferencePoolResponse
    [Required] Additional attributes of the entity.
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    SystemData Pulumi.AzureNative.MachineLearningServices.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"
    Identity Pulumi.AzureNative.MachineLearningServices.Outputs.ManagedServiceIdentityResponse
    Managed service identity (system assigned and/or user assigned identities)
    Kind string
    Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.
    Sku Pulumi.AzureNative.MachineLearningServices.Outputs.SkuResponse
    Sku details required for ARM contract for Autoscaling.
    Tags Dictionary<string, string>
    Resource tags.
    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    InferencePoolProperties InferencePoolResponse
    [Required] Additional attributes of the entity.
    Location string
    The geo-location where the resource lives
    Name string
    The name 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"
    Identity ManagedServiceIdentityResponse
    Managed service identity (system assigned and/or user assigned identities)
    Kind string
    Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.
    Sku SkuResponse
    Sku details required for ARM contract for Autoscaling.
    Tags map[string]string
    Resource tags.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    inferencePoolProperties InferencePoolResponse
    [Required] Additional attributes of the entity.
    location String
    The geo-location where the resource lives
    name String
    The name 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"
    identity ManagedServiceIdentityResponse
    Managed service identity (system assigned and/or user assigned identities)
    kind String
    Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.
    sku SkuResponse
    Sku details required for ARM contract for Autoscaling.
    tags Map<String,String>
    Resource tags.
    azureApiVersion string
    The Azure API version of the resource.
    id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    inferencePoolProperties InferencePoolResponse
    [Required] Additional attributes of the entity.
    location string
    The geo-location where the resource lives
    name string
    The name 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"
    identity ManagedServiceIdentityResponse
    Managed service identity (system assigned and/or user assigned identities)
    kind string
    Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.
    sku SkuResponse
    Sku details required for ARM contract for Autoscaling.
    tags {[key: string]: string}
    Resource tags.
    azure_api_version str
    The Azure API version of the resource.
    id str
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    inference_pool_properties InferencePoolResponse
    [Required] Additional attributes of the entity.
    location str
    The geo-location where the resource lives
    name str
    The name 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"
    identity ManagedServiceIdentityResponse
    Managed service identity (system assigned and/or user assigned identities)
    kind str
    Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.
    sku SkuResponse
    Sku details required for ARM contract for Autoscaling.
    tags Mapping[str, str]
    Resource tags.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    inferencePoolProperties Property Map
    [Required] Additional attributes of the entity.
    location String
    The geo-location where the resource lives
    name String
    The name 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"
    identity Property Map
    Managed service identity (system assigned and/or user assigned identities)
    kind String
    Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.
    sku Property Map
    Sku details required for ARM contract for Autoscaling.
    tags Map<String>
    Resource tags.

    Supporting Types

    InferencePoolResponse

    ProvisioningState string
    Provisioning state for the pool.
    Description string
    Description of the resource.
    Properties List<Pulumi.AzureNative.MachineLearningServices.Inputs.StringStringKeyValuePairResponse>
    Property dictionary. Properties can be added, but not removed or altered.
    ScaleUnitConfiguration Pulumi.AzureNative.MachineLearningServices.Inputs.ScaleUnitConfigurationResponse
    Gets or sets ScaleUnitConfiguration for the inference pool. Used if PoolType=ScaleUnit.
    ProvisioningState string
    Provisioning state for the pool.
    Description string
    Description of the resource.
    Properties []StringStringKeyValuePairResponse
    Property dictionary. Properties can be added, but not removed or altered.
    ScaleUnitConfiguration ScaleUnitConfigurationResponse
    Gets or sets ScaleUnitConfiguration for the inference pool. Used if PoolType=ScaleUnit.
    provisioningState String
    Provisioning state for the pool.
    description String
    Description of the resource.
    properties List<StringStringKeyValuePairResponse>
    Property dictionary. Properties can be added, but not removed or altered.
    scaleUnitConfiguration ScaleUnitConfigurationResponse
    Gets or sets ScaleUnitConfiguration for the inference pool. Used if PoolType=ScaleUnit.
    provisioningState string
    Provisioning state for the pool.
    description string
    Description of the resource.
    properties StringStringKeyValuePairResponse[]
    Property dictionary. Properties can be added, but not removed or altered.
    scaleUnitConfiguration ScaleUnitConfigurationResponse
    Gets or sets ScaleUnitConfiguration for the inference pool. Used if PoolType=ScaleUnit.
    provisioning_state str
    Provisioning state for the pool.
    description str
    Description of the resource.
    properties Sequence[StringStringKeyValuePairResponse]
    Property dictionary. Properties can be added, but not removed or altered.
    scale_unit_configuration ScaleUnitConfigurationResponse
    Gets or sets ScaleUnitConfiguration for the inference pool. Used if PoolType=ScaleUnit.
    provisioningState String
    Provisioning state for the pool.
    description String
    Description of the resource.
    properties List<Property Map>
    Property dictionary. Properties can be added, but not removed or altered.
    scaleUnitConfiguration Property Map
    Gets or sets ScaleUnitConfiguration for the inference pool. Used if PoolType=ScaleUnit.

    ManagedServiceIdentityResponse

    PrincipalId string
    The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
    TenantId string
    The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
    Type string
    Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
    UserAssignedIdentities Dictionary<string, Pulumi.AzureNative.MachineLearningServices.Inputs.UserAssignedIdentityResponse>
    The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
    PrincipalId string
    The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
    TenantId string
    The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
    Type string
    Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
    UserAssignedIdentities map[string]UserAssignedIdentityResponse
    The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
    principalId String
    The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
    tenantId String
    The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
    type String
    Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
    userAssignedIdentities Map<String,UserAssignedIdentityResponse>
    The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
    principalId string
    The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
    tenantId string
    The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
    type string
    Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
    userAssignedIdentities {[key: string]: UserAssignedIdentityResponse}
    The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
    principal_id str
    The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
    tenant_id str
    The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
    type str
    Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
    user_assigned_identities Mapping[str, UserAssignedIdentityResponse]
    The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
    principalId String
    The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
    tenantId String
    The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
    type String
    Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
    userAssignedIdentities Map<Property Map>
    The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

    ScaleUnitConfigurationResponse

    DisablePublicEgress bool
    Gets or sets a value indicating whether PublicEgress is disabled.
    Registries List<string>
    Gets or sets a list of Registry sources that will be used to confirm identity, storage, ACR.
    DisablePublicEgress bool
    Gets or sets a value indicating whether PublicEgress is disabled.
    Registries []string
    Gets or sets a list of Registry sources that will be used to confirm identity, storage, ACR.
    disablePublicEgress Boolean
    Gets or sets a value indicating whether PublicEgress is disabled.
    registries List<String>
    Gets or sets a list of Registry sources that will be used to confirm identity, storage, ACR.
    disablePublicEgress boolean
    Gets or sets a value indicating whether PublicEgress is disabled.
    registries string[]
    Gets or sets a list of Registry sources that will be used to confirm identity, storage, ACR.
    disable_public_egress bool
    Gets or sets a value indicating whether PublicEgress is disabled.
    registries Sequence[str]
    Gets or sets a list of Registry sources that will be used to confirm identity, storage, ACR.
    disablePublicEgress Boolean
    Gets or sets a value indicating whether PublicEgress is disabled.
    registries List<String>
    Gets or sets a list of Registry sources that will be used to confirm identity, storage, ACR.

    SkuResponse

    Name string
    The name of the SKU. Ex - P3. It is typically a letter+number code
    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.
    Family string
    If the service has different generations of hardware, for the same SKU, then that can be captured here.
    Size string
    The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
    Tier string
    This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.
    Name string
    The name of the SKU. Ex - P3. It is typically a letter+number code
    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.
    Family string
    If the service has different generations of hardware, for the same SKU, then that can be captured here.
    Size string
    The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
    Tier string
    This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.
    name String
    The name of the SKU. Ex - P3. It is typically a letter+number code
    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.
    family String
    If the service has different generations of hardware, for the same SKU, then that can be captured here.
    size String
    The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
    tier String
    This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.
    name string
    The name of the SKU. Ex - P3. It is typically a letter+number code
    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.
    family string
    If the service has different generations of hardware, for the same SKU, then that can be captured here.
    size string
    The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
    tier string
    This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.
    name str
    The name of the SKU. Ex - P3. It is typically a letter+number code
    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.
    family str
    If the service has different generations of hardware, for the same SKU, then that can be captured here.
    size str
    The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
    tier str
    This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.
    name String
    The name of the SKU. Ex - P3. It is typically a letter+number code
    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.
    family String
    If the service has different generations of hardware, for the same SKU, then that can be captured here.
    size String
    The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
    tier String
    This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.

    StringStringKeyValuePairResponse

    Key string
    Value string
    Key string
    Value string
    key String
    value String
    key string
    value string
    key str
    value str
    key String
    value String

    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.

    UserAssignedIdentityResponse

    ClientId string
    The client ID of the assigned identity.
    PrincipalId string
    The principal ID of the assigned identity.
    TenantId string
    The tenant ID of the user assigned identity.
    ClientId string
    The client ID of the assigned identity.
    PrincipalId string
    The principal ID of the assigned identity.
    TenantId string
    The tenant ID of the user assigned identity.
    clientId String
    The client ID of the assigned identity.
    principalId String
    The principal ID of the assigned identity.
    tenantId String
    The tenant ID of the user assigned identity.
    clientId string
    The client ID of the assigned identity.
    principalId string
    The principal ID of the assigned identity.
    tenantId string
    The tenant ID of the user assigned identity.
    client_id str
    The client ID of the assigned identity.
    principal_id str
    The principal ID of the assigned identity.
    tenant_id str
    The tenant ID of the user assigned identity.
    clientId String
    The client ID of the assigned identity.
    principalId String
    The principal ID of the assigned identity.
    tenantId String
    The tenant ID of the user assigned identity.

    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