1. Packages
  2. Azure Native
  3. API Docs
  4. migrate
  5. getGroup
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.30.0 published on Friday, Feb 23, 2024 by Pulumi

azure-native.migrate.getGroup

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.30.0 published on Friday, Feb 23, 2024 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. Azure REST API version: 2019-10-01.

    Other available API versions: 2018-02-02.

    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>
    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]
    func LookupGroup(ctx *Context, args *LookupGroupArgs, opts ...InvokeOption) (*LookupGroupResult, error)
    func LookupGroupOutput(ctx *Context, args *LookupGroupOutputArgs, opts ...InvokeOption) LookupGroupResultOutput

    > 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)
    }
    public static CompletableFuture<GetGroupResult> getGroup(GetGroupArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:migrate:getGroup
      arguments:
        # arguments dictionary

    The following arguments are supported:

    GroupName string
    Unique name of a group within a project.
    ProjectName string
    Name of the Azure Migrate project.
    ResourceGroupName string
    Name of the Azure Resource Group that project is part of.
    GroupName string
    Unique name of a group within a project.
    ProjectName string
    Name of the Azure Migrate project.
    ResourceGroupName string
    Name of the Azure Resource Group that project is part of.
    groupName String
    Unique name of a group within a project.
    projectName String
    Name of the Azure Migrate project.
    resourceGroupName String
    Name of the Azure Resource Group that project is part of.
    groupName string
    Unique name of a group within a project.
    projectName string
    Name of the Azure Migrate project.
    resourceGroupName string
    Name of the Azure Resource Group that project is part of.
    group_name str
    Unique name of a group within a project.
    project_name str
    Name of the Azure Migrate project.
    resource_group_name str
    Name of the Azure Resource Group that project is part of.
    groupName String
    Unique name of a group within a project.
    projectName String
    Name of the Azure Migrate project.
    resourceGroupName String
    Name of the Azure Resource Group that project is part of.

    getGroup Result

    The following output properties are available:

    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.
    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.
    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.
    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.
    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.
    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 bool
    If the assessments are in running state.
    Assessments List<string>
    List of References to Assessments created on this group.
    CreatedTimestamp string
    Time when this group was created. Date-Time represented in ISO-8601 format.
    GroupStatus string
    Whether the group has been created and is valid.
    MachineCount int
    Number of machines part of this group.
    UpdatedTimestamp string
    Time when this group was last updated. Date-Time represented in ISO-8601 format.
    GroupType string
    The type of group.
    AreAssessmentsRunning bool
    If the assessments are in running state.
    Assessments []string
    List of References to Assessments created on this group.
    CreatedTimestamp string
    Time when this group was created. Date-Time represented in ISO-8601 format.
    GroupStatus string
    Whether the group has been created and is valid.
    MachineCount int
    Number of machines part of this group.
    UpdatedTimestamp string
    Time when this group was last updated. Date-Time represented in ISO-8601 format.
    GroupType string
    The type of group.
    areAssessmentsRunning Boolean
    If the assessments are in running state.
    assessments List<String>
    List of References to Assessments created on this group.
    createdTimestamp String
    Time when this group was created. Date-Time represented in ISO-8601 format.
    groupStatus String
    Whether the group has been created and is valid.
    machineCount Integer
    Number of machines part of this group.
    updatedTimestamp String
    Time when this group was last updated. Date-Time represented in ISO-8601 format.
    groupType String
    The type of group.
    areAssessmentsRunning boolean
    If the assessments are in running state.
    assessments string[]
    List of References to Assessments created on this group.
    createdTimestamp string
    Time when this group was created. Date-Time represented in ISO-8601 format.
    groupStatus string
    Whether the group has been created and is valid.
    machineCount number
    Number of machines part of this group.
    updatedTimestamp string
    Time when this group was last updated. Date-Time represented in ISO-8601 format.
    groupType string
    The type of group.
    are_assessments_running bool
    If the assessments are in running state.
    assessments Sequence[str]
    List of References to Assessments created on this group.
    created_timestamp str
    Time when this group was created. Date-Time represented in ISO-8601 format.
    group_status str
    Whether the group has been created and is valid.
    machine_count int
    Number of machines part of this group.
    updated_timestamp str
    Time when this group was last updated. Date-Time represented in ISO-8601 format.
    group_type str
    The type of group.
    areAssessmentsRunning Boolean
    If the assessments are in running state.
    assessments List<String>
    List of References to Assessments created on this group.
    createdTimestamp String
    Time when this group was created. Date-Time represented in ISO-8601 format.
    groupStatus String
    Whether the group has been created and is valid.
    machineCount Number
    Number of machines part of this group.
    updatedTimestamp 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
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.30.0 published on Friday, Feb 23, 2024 by Pulumi