1. Packages
  2. Azure Native
  3. API Docs
  4. migrate
  5. getGroup
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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

azure-native.migrate.getGroup

Explore with Pulumi AI

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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

Get information related to a specific group in the project. Returns a json object of type ‘group’ as specified in the models section.

Uses Azure REST API version 2019-10-01.

Using getGroup

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 getGroup(args: GetGroupArgs, opts?: InvokeOptions): Promise<GetGroupResult>
function getGroupOutput(args: GetGroupOutputArgs, opts?: InvokeOptions): Output<GetGroupResult>
Copy
def get_group(group_name: Optional[str] = None,
              project_name: Optional[str] = None,
              resource_group_name: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetGroupResult
def get_group_output(group_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[GetGroupResult]
Copy
func LookupGroup(ctx *Context, args *LookupGroupArgs, opts ...InvokeOption) (*LookupGroupResult, error)
func LookupGroupOutput(ctx *Context, args *LookupGroupOutputArgs, opts ...InvokeOption) LookupGroupResultOutput
Copy

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

public static class GetGroup 
{
    public static Task<GetGroupResult> InvokeAsync(GetGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetGroupResult> Invoke(GetGroupInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetGroupResult> getGroup(GetGroupArgs args, InvokeOptions options)
public static Output<GetGroupResult> getGroup(GetGroupArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:migrate:getGroup
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

GroupName
This property is required.
Changes to this property will trigger replacement.
string
Unique name of a group within a project.
ProjectName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Azure Migrate project.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Azure Resource Group that project is part of.
GroupName
This property is required.
Changes to this property will trigger replacement.
string
Unique name of a group within a project.
ProjectName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Azure Migrate project.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Azure Resource Group that project is part of.
groupName
This property is required.
Changes to this property will trigger replacement.
String
Unique name of a group within a project.
projectName
This property is required.
Changes to this property will trigger replacement.
String
Name of the Azure Migrate project.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the Azure Resource Group that project is part of.
groupName
This property is required.
Changes to this property will trigger replacement.
string
Unique name of a group within a project.
projectName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Azure Migrate project.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Azure Resource Group that project is part of.
group_name
This property is required.
Changes to this property will trigger replacement.
str
Unique name of a group within a project.
project_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the Azure Migrate project.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the Azure Resource Group that project is part of.
groupName
This property is required.
Changes to this property will trigger replacement.
String
Unique name of a group within a project.
projectName
This property is required.
Changes to this property will trigger replacement.
String
Name of the Azure Migrate project.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the Azure Resource Group that project is part of.

getGroup Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Id string
Path reference to this group. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}
Name string
Name of the group.
Properties Pulumi.AzureNative.Migrate.Outputs.GroupPropertiesResponse
Properties of the group.
Type string
Type of the object = [Microsoft.Migrate/assessmentProjects/groups].
ETag string
For optimistic concurrency control.
AzureApiVersion string
The Azure API version of the resource.
Id string
Path reference to this group. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}
Name string
Name of the group.
Properties GroupPropertiesResponse
Properties of the group.
Type string
Type of the object = [Microsoft.Migrate/assessmentProjects/groups].
ETag string
For optimistic concurrency control.
azureApiVersion String
The Azure API version of the resource.
id String
Path reference to this group. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}
name String
Name of the group.
properties GroupPropertiesResponse
Properties of the group.
type String
Type of the object = [Microsoft.Migrate/assessmentProjects/groups].
eTag String
For optimistic concurrency control.
azureApiVersion string
The Azure API version of the resource.
id string
Path reference to this group. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}
name string
Name of the group.
properties GroupPropertiesResponse
Properties of the group.
type string
Type of the object = [Microsoft.Migrate/assessmentProjects/groups].
eTag string
For optimistic concurrency control.
azure_api_version str
The Azure API version of the resource.
id str
Path reference to this group. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}
name str
Name of the group.
properties GroupPropertiesResponse
Properties of the group.
type str
Type of the object = [Microsoft.Migrate/assessmentProjects/groups].
e_tag str
For optimistic concurrency control.
azureApiVersion String
The Azure API version of the resource.
id String
Path reference to this group. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}
name String
Name of the group.
properties Property Map
Properties of the group.
type String
Type of the object = [Microsoft.Migrate/assessmentProjects/groups].
eTag String
For optimistic concurrency control.

Supporting Types

GroupPropertiesResponse

AreAssessmentsRunning This property is required. bool
If the assessments are in running state.
Assessments This property is required. List<string>
List of References to Assessments created on this group.
CreatedTimestamp This property is required. string
Time when this group was created. Date-Time represented in ISO-8601 format.
GroupStatus This property is required. string
Whether the group has been created and is valid.
MachineCount This property is required. int
Number of machines part of this group.
UpdatedTimestamp This property is required. string
Time when this group was last updated. Date-Time represented in ISO-8601 format.
GroupType string
The type of group.
AreAssessmentsRunning This property is required. bool
If the assessments are in running state.
Assessments This property is required. []string
List of References to Assessments created on this group.
CreatedTimestamp This property is required. string
Time when this group was created. Date-Time represented in ISO-8601 format.
GroupStatus This property is required. string
Whether the group has been created and is valid.
MachineCount This property is required. int
Number of machines part of this group.
UpdatedTimestamp This property is required. string
Time when this group was last updated. Date-Time represented in ISO-8601 format.
GroupType string
The type of group.
areAssessmentsRunning This property is required. Boolean
If the assessments are in running state.
assessments This property is required. List<String>
List of References to Assessments created on this group.
createdTimestamp This property is required. String
Time when this group was created. Date-Time represented in ISO-8601 format.
groupStatus This property is required. String
Whether the group has been created and is valid.
machineCount This property is required. Integer
Number of machines part of this group.
updatedTimestamp This property is required. String
Time when this group was last updated. Date-Time represented in ISO-8601 format.
groupType String
The type of group.
areAssessmentsRunning This property is required. boolean
If the assessments are in running state.
assessments This property is required. string[]
List of References to Assessments created on this group.
createdTimestamp This property is required. string
Time when this group was created. Date-Time represented in ISO-8601 format.
groupStatus This property is required. string
Whether the group has been created and is valid.
machineCount This property is required. number
Number of machines part of this group.
updatedTimestamp This property is required. string
Time when this group was last updated. Date-Time represented in ISO-8601 format.
groupType string
The type of group.
are_assessments_running This property is required. bool
If the assessments are in running state.
assessments This property is required. Sequence[str]
List of References to Assessments created on this group.
created_timestamp This property is required. str
Time when this group was created. Date-Time represented in ISO-8601 format.
group_status This property is required. str
Whether the group has been created and is valid.
machine_count This property is required. int
Number of machines part of this group.
updated_timestamp This property is required. str
Time when this group was last updated. Date-Time represented in ISO-8601 format.
group_type str
The type of group.
areAssessmentsRunning This property is required. Boolean
If the assessments are in running state.
assessments This property is required. List<String>
List of References to Assessments created on this group.
createdTimestamp This property is required. String
Time when this group was created. Date-Time represented in ISO-8601 format.
groupStatus This property is required. String
Whether the group has been created and is valid.
machineCount This property is required. Number
Number of machines part of this group.
updatedTimestamp This property is required. String
Time when this group was last updated. Date-Time represented in ISO-8601 format.
groupType String
The type of group.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi