azure-native.operationalinsights.MachineGroup
Explore with Pulumi AI
A user-defined logical grouping of machines.
Uses Azure REST API version 2015-11-01-preview. In version 2.x of the Azure Native provider, it used API version 2015-11-01-preview.
Create MachineGroup Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new MachineGroup(name: string, args: MachineGroupArgs, opts?: CustomResourceOptions);
@overload
def MachineGroup(resource_name: str,
args: MachineGroupArgs,
opts: Optional[ResourceOptions] = None)
@overload
def MachineGroup(resource_name: str,
opts: Optional[ResourceOptions] = None,
display_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
workspace_name: Optional[str] = None,
count: Optional[int] = None,
group_type: Optional[Union[str, MachineGroupType]] = None,
machine_group_name: Optional[str] = None,
machines: Optional[Sequence[MachineReferenceWithHintsArgs]] = None)
func NewMachineGroup(ctx *Context, name string, args MachineGroupArgs, opts ...ResourceOption) (*MachineGroup, error)
public MachineGroup(string name, MachineGroupArgs args, CustomResourceOptions? opts = null)
public MachineGroup(String name, MachineGroupArgs args)
public MachineGroup(String name, MachineGroupArgs args, CustomResourceOptions options)
type: azure-native:operationalinsights:MachineGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name
This property is required. string - The unique name of the resource.
- args
This property is required. MachineGroupArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
This property is required. str - The unique name of the resource.
- args
This property is required. MachineGroupArgs - The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. MachineGroupArgs - The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. MachineGroupArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name
This property is required. String - The unique name of the resource.
- args
This property is required. MachineGroupArgs - The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var machineGroupResource = new AzureNative.OperationalInsights.MachineGroup("machineGroupResource", new()
{
DisplayName = "string",
Kind = "string",
ResourceGroupName = "string",
WorkspaceName = "string",
Count = 0,
GroupType = "string",
MachineGroupName = "string",
Machines = new[]
{
new AzureNative.OperationalInsights.Inputs.MachineReferenceWithHintsArgs
{
Id = "string",
Kind = "ref:machinewithhints",
},
},
});
example, err := operationalinsights.NewMachineGroup(ctx, "machineGroupResource", &operationalinsights.MachineGroupArgs{
DisplayName: pulumi.String("string"),
Kind: pulumi.String("string"),
ResourceGroupName: pulumi.String("string"),
WorkspaceName: pulumi.String("string"),
Count: pulumi.Int(0),
GroupType: pulumi.String("string"),
MachineGroupName: pulumi.String("string"),
Machines: operationalinsights.MachineReferenceWithHintsArray{
&operationalinsights.MachineReferenceWithHintsArgs{
Id: pulumi.String("string"),
Kind: pulumi.String("ref:machinewithhints"),
},
},
})
var machineGroupResource = new MachineGroup("machineGroupResource", MachineGroupArgs.builder()
.displayName("string")
.kind("string")
.resourceGroupName("string")
.workspaceName("string")
.count(0)
.groupType("string")
.machineGroupName("string")
.machines(MachineReferenceWithHintsArgs.builder()
.id("string")
.kind("ref:machinewithhints")
.build())
.build());
machine_group_resource = azure_native.operationalinsights.MachineGroup("machineGroupResource",
display_name="string",
kind="string",
resource_group_name="string",
workspace_name="string",
count=0,
group_type="string",
machine_group_name="string",
machines=[{
"id": "string",
"kind": "ref:machinewithhints",
}])
const machineGroupResource = new azure_native.operationalinsights.MachineGroup("machineGroupResource", {
displayName: "string",
kind: "string",
resourceGroupName: "string",
workspaceName: "string",
count: 0,
groupType: "string",
machineGroupName: "string",
machines: [{
id: "string",
kind: "ref:machinewithhints",
}],
});
type: azure-native:operationalinsights:MachineGroup
properties:
count: 0
displayName: string
groupType: string
kind: string
machineGroupName: string
machines:
- id: string
kind: ref:machinewithhints
resourceGroupName: string
workspaceName: string
MachineGroup Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The MachineGroup resource accepts the following input properties:
- Display
Name This property is required. string - User defined name for the group
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- Resource group name within the specified subscriptionId.
- Workspace
Name This property is required. Changes to this property will trigger replacement.
- OMS workspace containing the resources of interest.
- 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.
- Group
Type string | Pulumi.Azure Native. Operational Insights. Machine Group Type - Type of the machine group
- Machine
Group Name Changes to this property will trigger replacement.
- Machine Group resource name.
- Machines
List<Pulumi.
Azure Native. Operational Insights. Inputs. Machine Reference With Hints> - 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 This property is required. string - User defined name for the group
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- Resource group name within the specified subscriptionId.
- Workspace
Name This property is required. Changes to this property will trigger replacement.
- OMS workspace containing the resources of interest.
- 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.
- Group
Type string | MachineGroup Type - Type of the machine group
- Machine
Group Name Changes to this property will trigger replacement.
- Machine Group resource name.
- Machines
[]Machine
Reference With Hints Args - 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 This property is required. String - User defined name for the group
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- Resource group name within the specified subscriptionId.
- workspace
Name This property is required. Changes to this property will trigger replacement.
- OMS workspace containing the resources of interest.
- 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.
- group
Type String | MachineGroup Type - Type of the machine group
- machine
Group Name Changes to this property will trigger replacement.
- Machine Group resource name.
- machines
List<Machine
Reference With Hints> - 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 This property is required. string - User defined name for the group
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- Resource group name within the specified subscriptionId.
- workspace
Name This property is required. Changes to this property will trigger replacement.
- OMS workspace containing the resources of interest.
- 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.
- group
Type string | MachineGroup Type - Type of the machine group
- machine
Group Name Changes to this property will trigger replacement.
- Machine Group resource name.
- machines
Machine
Reference With Hints[] - 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 This property is required. str - User defined name for the group
- resource_
group_ name This property is required. Changes to this property will trigger replacement.
- Resource group name within the specified subscriptionId.
- workspace_
name This property is required. Changes to this property will trigger replacement.
- OMS workspace containing the resources of interest.
- 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.
- group_
type str | MachineGroup Type - Type of the machine group
- machine_
group_ name Changes to this property will trigger replacement.
- Machine Group resource name.
- machines
Sequence[Machine
Reference With Hints Args] - 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 This property is required. String - User defined name for the group
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- Resource group name within the specified subscriptionId.
- workspace
Name This property is required. Changes to this property will trigger replacement.
- OMS workspace containing the resources of interest.
- 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.
- group
Type String | "unknown" | "azure-cs" | "azure-sf" | "azure-vmss" | "user-static" - Type of the machine group
- machine
Group Name Changes to this property will trigger replacement.
- Machine Group resource name.
- 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.
Outputs
All input properties are implicitly available as output properties. Additionally, the MachineGroup resource produces the following output properties:
- Azure
Api stringVersion - The Azure API version of the resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- Resource name.
- Type string
- Resource type.
- Etag string
- Resource ETAG.
- Azure
Api stringVersion - The Azure API version of the resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- Resource name.
- Type string
- Resource type.
- Etag string
- Resource ETAG.
- azure
Api StringVersion - The Azure API version of the resource.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- Resource name.
- type String
- Resource type.
- etag String
- Resource ETAG.
- azure
Api stringVersion - The Azure API version of the resource.
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- Resource name.
- type string
- Resource type.
- etag string
- Resource ETAG.
- azure_
api_ strversion - The Azure API version of the resource.
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- Resource name.
- type str
- Resource type.
- etag str
- Resource ETAG.
- azure
Api StringVersion - The Azure API version of the resource.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- Resource name.
- type String
- Resource type.
- etag String
- Resource ETAG.
Supporting Types
MachineGroupType, MachineGroupTypeArgs
- Unknown
- unknown
- Azure_
cs - azure-cs
- Azure_
sf - azure-sf
- Azure_
vmss - azure-vmss
- User_
static - user-static
- Machine
Group Type Unknown - unknown
- Machine
Group Type_Azure_Cs - azure-cs
- Machine
Group Type_Azure_Sf - azure-sf
- Machine
Group Type_Azure_Vmss - azure-vmss
- Machine
Group Type_User_Static - user-static
- Unknown
- unknown
- Azurecs
- azure-cs
- Azuresf
- azure-sf
- Azurevmss
- azure-vmss
- Userstatic
- user-static
- Unknown
- unknown
- Azure_
cs - azure-cs
- Azure_
sf - azure-sf
- Azure_
vmss - azure-vmss
- User_
static - user-static
- UNKNOWN
- unknown
- AZURE_CS
- azure-cs
- AZURE_SF
- azure-sf
- AZURE_VMSS
- azure-vmss
- USER_STATIC
- user-static
- "unknown"
- unknown
- "azure-cs"
- azure-cs
- "azure-sf"
- azure-sf
- "azure-vmss"
- azure-vmss
- "user-static"
- user-static
MachineReferenceWithHints, MachineReferenceWithHintsArgs
- Id
This property is required. string - Resource URI.
- Id
This property is required. string - Resource URI.
- id
This property is required. String - Resource URI.
- id
This property is required. string - Resource URI.
- id
This property is required. str - Resource URI.
- id
This property is required. String - Resource URI.
MachineReferenceWithHintsResponse, MachineReferenceWithHintsResponseArgs
- Display
Name Hint 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.
- Os
Family Hint 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. string - Last known display name.
- Id
This property is required. string - Resource URI.
- Name
This property is required. string - Resource name.
- Os
Family Hint 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. String - Last known display name.
- id
This property is required. String - Resource URI.
- name
This property is required. String - Resource name.
- os
Family Hint 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. string - Last known display name.
- id
This property is required. string - Resource URI.
- name
This property is required. string - Resource name.
- os
Family Hint 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.
- display
Name Hint 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.
- os
Family Hint This property is required. String - Last known operating system family.
- type
This property is required. String - Resource type qualifier.
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:operationalinsights:MachineGroup ccfbf4bf-dc08-4371-9e9b-00a8d875d45a /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/machineGroups/{machineGroupName}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0