1. Packages
  2. Azure Native v2
  3. API Docs
  4. operationalinsights
  5. getMachineGroup
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

azure-native-v2.operationalinsights.getMachineGroup

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

Returns the specified machine group as it existed during the specified time interval. Azure REST API version: 2015-11-01-preview.

Using getMachineGroup

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 getMachineGroup(args: GetMachineGroupArgs, opts?: InvokeOptions): Promise<GetMachineGroupResult>
function getMachineGroupOutput(args: GetMachineGroupOutputArgs, opts?: InvokeOptions): Output<GetMachineGroupResult>
Copy
def get_machine_group(end_time: Optional[str] = None,
                      machine_group_name: Optional[str] = None,
                      resource_group_name: Optional[str] = None,
                      start_time: Optional[str] = None,
                      workspace_name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetMachineGroupResult
def get_machine_group_output(end_time: Optional[pulumi.Input[str]] = None,
                      machine_group_name: Optional[pulumi.Input[str]] = None,
                      resource_group_name: Optional[pulumi.Input[str]] = None,
                      start_time: Optional[pulumi.Input[str]] = None,
                      workspace_name: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetMachineGroupResult]
Copy
func LookupMachineGroup(ctx *Context, args *LookupMachineGroupArgs, opts ...InvokeOption) (*LookupMachineGroupResult, error)
func LookupMachineGroupOutput(ctx *Context, args *LookupMachineGroupOutputArgs, opts ...InvokeOption) LookupMachineGroupResultOutput
Copy

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

public static class GetMachineGroup 
{
    public static Task<GetMachineGroupResult> InvokeAsync(GetMachineGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetMachineGroupResult> Invoke(GetMachineGroupInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetMachineGroupResult> getMachineGroup(GetMachineGroupArgs args, InvokeOptions options)
public static Output<GetMachineGroupResult> getMachineGroup(GetMachineGroupArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:operationalinsights:getMachineGroup
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

MachineGroupName
This property is required.
Changes to this property will trigger replacement.
string
Machine Group resource name.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Resource group name within the specified subscriptionId.
WorkspaceName
This property is required.
Changes to this property will trigger replacement.
string
OMS workspace containing the resources of interest.
EndTime string
UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow
StartTime string
UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m
MachineGroupName
This property is required.
Changes to this property will trigger replacement.
string
Machine Group resource name.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Resource group name within the specified subscriptionId.
WorkspaceName
This property is required.
Changes to this property will trigger replacement.
string
OMS workspace containing the resources of interest.
EndTime string
UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow
StartTime string
UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m
machineGroupName
This property is required.
Changes to this property will trigger replacement.
String
Machine Group resource name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Resource group name within the specified subscriptionId.
workspaceName
This property is required.
Changes to this property will trigger replacement.
String
OMS workspace containing the resources of interest.
endTime String
UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow
startTime String
UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m
machineGroupName
This property is required.
Changes to this property will trigger replacement.
string
Machine Group resource name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Resource group name within the specified subscriptionId.
workspaceName
This property is required.
Changes to this property will trigger replacement.
string
OMS workspace containing the resources of interest.
endTime string
UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow
startTime string
UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m
machine_group_name
This property is required.
Changes to this property will trigger replacement.
str
Machine Group resource name.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
Resource group name within the specified subscriptionId.
workspace_name
This property is required.
Changes to this property will trigger replacement.
str
OMS workspace containing the resources of interest.
end_time str
UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow
start_time str
UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m
machineGroupName
This property is required.
Changes to this property will trigger replacement.
String
Machine Group resource name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Resource group name within the specified subscriptionId.
workspaceName
This property is required.
Changes to this property will trigger replacement.
String
OMS workspace containing the resources of interest.
endTime String
UTC date and time specifying the end time of an interval. When not specified the service uses DateTime.UtcNow
startTime String
UTC date and time specifying the start time of an interval. When not specified the service uses DateTime.UtcNow - 10m

getMachineGroup Result

The following output properties are available:

DisplayName string
User defined name for the group
Id string
Resource identifier.
Name string
Resource name.
Type string
Resource type.
Count int
Count of machines in this group. The value of count may be bigger than the number of machines in case of the group has been truncated due to exceeding the max number of machines a group can handle.
Etag string
Resource ETAG.
GroupType string
Type of the machine group
Machines List<Pulumi.AzureNative.OperationalInsights.Outputs.MachineReferenceWithHintsResponse>
References of the machines in this group. The hints within each reference do not represent the current value of the corresponding fields. They are a snapshot created during the last time the machine group was updated.
DisplayName string
User defined name for the group
Id string
Resource identifier.
Name string
Resource name.
Type string
Resource type.
Count int
Count of machines in this group. The value of count may be bigger than the number of machines in case of the group has been truncated due to exceeding the max number of machines a group can handle.
Etag string
Resource ETAG.
GroupType string
Type of the machine group
Machines []MachineReferenceWithHintsResponse
References of the machines in this group. The hints within each reference do not represent the current value of the corresponding fields. They are a snapshot created during the last time the machine group was updated.
displayName String
User defined name for the group
id String
Resource identifier.
name String
Resource name.
type String
Resource type.
count Integer
Count of machines in this group. The value of count may be bigger than the number of machines in case of the group has been truncated due to exceeding the max number of machines a group can handle.
etag String
Resource ETAG.
groupType String
Type of the machine group
machines List<MachineReferenceWithHintsResponse>
References of the machines in this group. The hints within each reference do not represent the current value of the corresponding fields. They are a snapshot created during the last time the machine group was updated.
displayName string
User defined name for the group
id string
Resource identifier.
name string
Resource name.
type string
Resource type.
count number
Count of machines in this group. The value of count may be bigger than the number of machines in case of the group has been truncated due to exceeding the max number of machines a group can handle.
etag string
Resource ETAG.
groupType string
Type of the machine group
machines MachineReferenceWithHintsResponse[]
References of the machines in this group. The hints within each reference do not represent the current value of the corresponding fields. They are a snapshot created during the last time the machine group was updated.
display_name str
User defined name for the group
id str
Resource identifier.
name str
Resource name.
type str
Resource type.
count int
Count of machines in this group. The value of count may be bigger than the number of machines in case of the group has been truncated due to exceeding the max number of machines a group can handle.
etag str
Resource ETAG.
group_type str
Type of the machine group
machines Sequence[MachineReferenceWithHintsResponse]
References of the machines in this group. The hints within each reference do not represent the current value of the corresponding fields. They are a snapshot created during the last time the machine group was updated.
displayName String
User defined name for the group
id String
Resource identifier.
name String
Resource name.
type String
Resource type.
count Number
Count of machines in this group. The value of count may be bigger than the number of machines in case of the group has been truncated due to exceeding the max number of machines a group can handle.
etag String
Resource ETAG.
groupType String
Type of the machine group
machines List<Property Map>
References of the machines in this group. The hints within each reference do not represent the current value of the corresponding fields. They are a snapshot created during the last time the machine group was updated.

Supporting Types

MachineReferenceWithHintsResponse

DisplayNameHint This property is required. string
Last known display name.
Id This property is required. string
Resource URI.
Name This property is required. string
Resource name.
OsFamilyHint This property is required. string
Last known operating system family.
Type This property is required. string
Resource type qualifier.
DisplayNameHint This property is required. string
Last known display name.
Id This property is required. string
Resource URI.
Name This property is required. string
Resource name.
OsFamilyHint This property is required. string
Last known operating system family.
Type This property is required. string
Resource type qualifier.
displayNameHint This property is required. String
Last known display name.
id This property is required. String
Resource URI.
name This property is required. String
Resource name.
osFamilyHint This property is required. String
Last known operating system family.
type This property is required. String
Resource type qualifier.
displayNameHint This property is required. string
Last known display name.
id This property is required. string
Resource URI.
name This property is required. string
Resource name.
osFamilyHint This property is required. string
Last known operating system family.
type This property is required. string
Resource type qualifier.
display_name_hint This property is required. str
Last known display name.
id This property is required. str
Resource URI.
name This property is required. str
Resource name.
os_family_hint This property is required. str
Last known operating system family.
type This property is required. str
Resource type qualifier.
displayNameHint This property is required. String
Last known display name.
id This property is required. String
Resource URI.
name This property is required. String
Resource name.
osFamilyHint This property is required. String
Last known operating system family.
type This property is required. String
Resource type qualifier.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi