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

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 getInferenceGroupStatus

    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 getInferenceGroupStatus(args: GetInferenceGroupStatusArgs, opts?: InvokeOptions): Promise<GetInferenceGroupStatusResult>
    function getInferenceGroupStatusOutput(args: GetInferenceGroupStatusOutputArgs, opts?: InvokeOptions): Output<GetInferenceGroupStatusResult>
    def get_inference_group_status(group_name: Optional[str] = None,
                                   pool_name: Optional[str] = None,
                                   resource_group_name: Optional[str] = None,
                                   workspace_name: Optional[str] = None,
                                   opts: Optional[InvokeOptions] = None) -> GetInferenceGroupStatusResult
    def get_inference_group_status_output(group_name: Optional[pulumi.Input[str]] = None,
                                   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[GetInferenceGroupStatusResult]
    func GetInferenceGroupStatus(ctx *Context, args *GetInferenceGroupStatusArgs, opts ...InvokeOption) (*GetInferenceGroupStatusResult, error)
    func GetInferenceGroupStatusOutput(ctx *Context, args *GetInferenceGroupStatusOutputArgs, opts ...InvokeOption) GetInferenceGroupStatusResultOutput

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

    public static class GetInferenceGroupStatus 
    {
        public static Task<GetInferenceGroupStatusResult> InvokeAsync(GetInferenceGroupStatusArgs args, InvokeOptions? opts = null)
        public static Output<GetInferenceGroupStatusResult> Invoke(GetInferenceGroupStatusInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetInferenceGroupStatusResult> getInferenceGroupStatus(GetInferenceGroupStatusArgs args, InvokeOptions options)
    public static Output<GetInferenceGroupStatusResult> getInferenceGroupStatus(GetInferenceGroupStatusArgs args, InvokeOptions options)
    
    fn::invoke:
      function: azure-native:machinelearningservices:getInferenceGroupStatus
      arguments:
        # arguments dictionary

    The following arguments are supported:

    GroupName string
    InferenceGroup name.
    PoolName string
    InferencePool name.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    WorkspaceName string
    Name of Azure Machine Learning workspace.
    GroupName string
    InferenceGroup name.
    PoolName string
    InferencePool name.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    WorkspaceName string
    Name of Azure Machine Learning workspace.
    groupName String
    InferenceGroup name.
    poolName String
    InferencePool name.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    workspaceName String
    Name of Azure Machine Learning workspace.
    groupName string
    InferenceGroup name.
    poolName string
    InferencePool name.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    workspaceName string
    Name of Azure Machine Learning workspace.
    group_name str
    InferenceGroup name.
    pool_name str
    InferencePool name.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    workspace_name str
    Name of Azure Machine Learning workspace.
    groupName String
    InferenceGroup name.
    poolName String
    InferencePool name.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    workspaceName String
    Name of Azure Machine Learning workspace.

    getInferenceGroupStatus Result

    The following output properties are available:

    ActualCapacityInfo Pulumi.AzureNative.MachineLearningServices.Outputs.ActualCapacityInfoResponse
    Gets or sets the actual capacity info for the group.
    EndpointCount int
    Gets or sets the actual number of endpoints in the group.
    RequestedCapacity int
    Gets or sets the request number of instances for the group.
    ActualCapacityInfo ActualCapacityInfoResponse
    Gets or sets the actual capacity info for the group.
    EndpointCount int
    Gets or sets the actual number of endpoints in the group.
    RequestedCapacity int
    Gets or sets the request number of instances for the group.
    actualCapacityInfo ActualCapacityInfoResponse
    Gets or sets the actual capacity info for the group.
    endpointCount Integer
    Gets or sets the actual number of endpoints in the group.
    requestedCapacity Integer
    Gets or sets the request number of instances for the group.
    actualCapacityInfo ActualCapacityInfoResponse
    Gets or sets the actual capacity info for the group.
    endpointCount number
    Gets or sets the actual number of endpoints in the group.
    requestedCapacity number
    Gets or sets the request number of instances for the group.
    actual_capacity_info ActualCapacityInfoResponse
    Gets or sets the actual capacity info for the group.
    endpoint_count int
    Gets or sets the actual number of endpoints in the group.
    requested_capacity int
    Gets or sets the request number of instances for the group.
    actualCapacityInfo Property Map
    Gets or sets the actual capacity info for the group.
    endpointCount Number
    Gets or sets the actual number of endpoints in the group.
    requestedCapacity Number
    Gets or sets the request number of instances for the group.

    Supporting Types

    ActualCapacityInfoResponse

    Failed int
    Gets or sets the number of instances (scale units) which have Failed provisioning state and have target group payload.
    OutdatedFailed int
    Gets or sets the number of instances (scale units) which have Failed provisioning state but do not have target group payload.
    OutdatedSucceeded int
    Gets or sets the number of instances (scale units) which have Succeeded provisioning state but do not have target group payload.
    Succeeded int
    Gets or sets the number of instances (scale units) which have Succeeded provisioning state and target group payload.
    Total int
    Gets or sets the total number of instances (scale units) regardless of provisioning state or whether current group payload version matches the target group payload.
    Failed int
    Gets or sets the number of instances (scale units) which have Failed provisioning state and have target group payload.
    OutdatedFailed int
    Gets or sets the number of instances (scale units) which have Failed provisioning state but do not have target group payload.
    OutdatedSucceeded int
    Gets or sets the number of instances (scale units) which have Succeeded provisioning state but do not have target group payload.
    Succeeded int
    Gets or sets the number of instances (scale units) which have Succeeded provisioning state and target group payload.
    Total int
    Gets or sets the total number of instances (scale units) regardless of provisioning state or whether current group payload version matches the target group payload.
    failed Integer
    Gets or sets the number of instances (scale units) which have Failed provisioning state and have target group payload.
    outdatedFailed Integer
    Gets or sets the number of instances (scale units) which have Failed provisioning state but do not have target group payload.
    outdatedSucceeded Integer
    Gets or sets the number of instances (scale units) which have Succeeded provisioning state but do not have target group payload.
    succeeded Integer
    Gets or sets the number of instances (scale units) which have Succeeded provisioning state and target group payload.
    total Integer
    Gets or sets the total number of instances (scale units) regardless of provisioning state or whether current group payload version matches the target group payload.
    failed number
    Gets or sets the number of instances (scale units) which have Failed provisioning state and have target group payload.
    outdatedFailed number
    Gets or sets the number of instances (scale units) which have Failed provisioning state but do not have target group payload.
    outdatedSucceeded number
    Gets or sets the number of instances (scale units) which have Succeeded provisioning state but do not have target group payload.
    succeeded number
    Gets or sets the number of instances (scale units) which have Succeeded provisioning state and target group payload.
    total number
    Gets or sets the total number of instances (scale units) regardless of provisioning state or whether current group payload version matches the target group payload.
    failed int
    Gets or sets the number of instances (scale units) which have Failed provisioning state and have target group payload.
    outdated_failed int
    Gets or sets the number of instances (scale units) which have Failed provisioning state but do not have target group payload.
    outdated_succeeded int
    Gets or sets the number of instances (scale units) which have Succeeded provisioning state but do not have target group payload.
    succeeded int
    Gets or sets the number of instances (scale units) which have Succeeded provisioning state and target group payload.
    total int
    Gets or sets the total number of instances (scale units) regardless of provisioning state or whether current group payload version matches the target group payload.
    failed Number
    Gets or sets the number of instances (scale units) which have Failed provisioning state and have target group payload.
    outdatedFailed Number
    Gets or sets the number of instances (scale units) which have Failed provisioning state but do not have target group payload.
    outdatedSucceeded Number
    Gets or sets the number of instances (scale units) which have Succeeded provisioning state but do not have target group payload.
    succeeded Number
    Gets or sets the number of instances (scale units) which have Succeeded provisioning state and target group payload.
    total Number
    Gets or sets the total number of instances (scale units) regardless of provisioning state or whether current group payload version matches the target group payload.

    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