Google Native

v0.27.0 published on Friday, Oct 21, 2022 by Pulumi

getGroup

Gets a single group.

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_id: Optional[str] = None,
              project: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetGroupResult
def get_group_output(group_id: Optional[pulumi.Input[str]] = None,
              project: 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: google-native:monitoring/v3:getGroup
  arguments:
    # arguments dictionary

The following arguments are supported:

GroupId string
Project string
GroupId string
Project string
groupId String
project String
groupId string
project string
groupId String
project String

getGroup Result

The following output properties are available:

DisplayName string

A user-assigned name for this group, used only for display purposes.

Filter string

The filter used to determine which monitored resources belong to this group.

IsCluster bool

If true, the members of this group are considered to be a cluster. The system can perform additional analysis on groups that are clusters.

Name string

The name of this group. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] When creating a group, this field is ignored and a new name is created consisting of the project specified in the call to CreateGroup and a unique [GROUP_ID] that is generated automatically.

ParentName string

The name of the group's parent, if it has one. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] For groups with no parent, parent_name is the empty string, "".

DisplayName string

A user-assigned name for this group, used only for display purposes.

Filter string

The filter used to determine which monitored resources belong to this group.

IsCluster bool

If true, the members of this group are considered to be a cluster. The system can perform additional analysis on groups that are clusters.

Name string

The name of this group. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] When creating a group, this field is ignored and a new name is created consisting of the project specified in the call to CreateGroup and a unique [GROUP_ID] that is generated automatically.

ParentName string

The name of the group's parent, if it has one. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] For groups with no parent, parent_name is the empty string, "".

displayName String

A user-assigned name for this group, used only for display purposes.

filter String

The filter used to determine which monitored resources belong to this group.

isCluster Boolean

If true, the members of this group are considered to be a cluster. The system can perform additional analysis on groups that are clusters.

name String

The name of this group. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] When creating a group, this field is ignored and a new name is created consisting of the project specified in the call to CreateGroup and a unique [GROUP_ID] that is generated automatically.

parentName String

The name of the group's parent, if it has one. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] For groups with no parent, parent_name is the empty string, "".

displayName string

A user-assigned name for this group, used only for display purposes.

filter string

The filter used to determine which monitored resources belong to this group.

isCluster boolean

If true, the members of this group are considered to be a cluster. The system can perform additional analysis on groups that are clusters.

name string

The name of this group. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] When creating a group, this field is ignored and a new name is created consisting of the project specified in the call to CreateGroup and a unique [GROUP_ID] that is generated automatically.

parentName string

The name of the group's parent, if it has one. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] For groups with no parent, parent_name is the empty string, "".

display_name str

A user-assigned name for this group, used only for display purposes.

filter str

The filter used to determine which monitored resources belong to this group.

is_cluster bool

If true, the members of this group are considered to be a cluster. The system can perform additional analysis on groups that are clusters.

name str

The name of this group. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] When creating a group, this field is ignored and a new name is created consisting of the project specified in the call to CreateGroup and a unique [GROUP_ID] that is generated automatically.

parent_name str

The name of the group's parent, if it has one. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] For groups with no parent, parent_name is the empty string, "".

displayName String

A user-assigned name for this group, used only for display purposes.

filter String

The filter used to determine which monitored resources belong to this group.

isCluster Boolean

If true, the members of this group are considered to be a cluster. The system can perform additional analysis on groups that are clusters.

name String

The name of this group. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] When creating a group, this field is ignored and a new name is created consisting of the project specified in the call to CreateGroup and a unique [GROUP_ID] that is generated automatically.

parentName String

The name of the group's parent, if it has one. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] For groups with no parent, parent_name is the empty string, "".

Package Details

Repository
https://github.com/pulumi/pulumi-google-native
License
Apache-2.0