Azure Native

v1.80.0 published on Tuesday, Oct 4, 2022 by Pulumi

getGroup

Contract details. API Version: 2020-12-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>
def get_group(group_id: Optional[str] = None,
              resource_group_name: Optional[str] = None,
              service_name: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetGroupResult
def get_group_output(group_id: Optional[pulumi.Input[str]] = None,
              resource_group_name: Optional[pulumi.Input[str]] = None,
              service_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:apimanagement:getGroup
  Arguments:
    # Arguments dictionary

The following arguments are supported:

GroupId string

Group identifier. Must be unique in the current API Management service instance.

ResourceGroupName string

The name of the resource group.

ServiceName string

The name of the API Management service.

GroupId string

Group identifier. Must be unique in the current API Management service instance.

ResourceGroupName string

The name of the resource group.

ServiceName string

The name of the API Management service.

groupId String

Group identifier. Must be unique in the current API Management service instance.

resourceGroupName String

The name of the resource group.

serviceName String

The name of the API Management service.

groupId string

Group identifier. Must be unique in the current API Management service instance.

resourceGroupName string

The name of the resource group.

serviceName string

The name of the API Management service.

group_id str

Group identifier. Must be unique in the current API Management service instance.

resource_group_name str

The name of the resource group.

service_name str

The name of the API Management service.

groupId String

Group identifier. Must be unique in the current API Management service instance.

resourceGroupName String

The name of the resource group.

serviceName String

The name of the API Management service.

getGroup Result

The following output properties are available:

BuiltIn bool

true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false.

DisplayName string

Group name.

Id string

Resource ID.

Name string

Resource name.

Type string

Resource type for API Management resource.

Description string

Group description. Can contain HTML formatting tags.

ExternalId string

For external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; otherwise the value is null.

BuiltIn bool

true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false.

DisplayName string

Group name.

Id string

Resource ID.

Name string

Resource name.

Type string

Resource type for API Management resource.

Description string

Group description. Can contain HTML formatting tags.

ExternalId string

For external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; otherwise the value is null.

builtIn Boolean

true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false.

displayName String

Group name.

id String

Resource ID.

name String

Resource name.

type String

Resource type for API Management resource.

description String

Group description. Can contain HTML formatting tags.

externalId String

For external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; otherwise the value is null.

builtIn boolean

true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false.

displayName string

Group name.

id string

Resource ID.

name string

Resource name.

type string

Resource type for API Management resource.

description string

Group description. Can contain HTML formatting tags.

externalId string

For external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; otherwise the value is null.

built_in bool

true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false.

display_name str

Group name.

id str

Resource ID.

name str

Resource name.

type str

Resource type for API Management resource.

description str

Group description. Can contain HTML formatting tags.

external_id str

For external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; otherwise the value is null.

builtIn Boolean

true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false.

displayName String

Group name.

id String

Resource ID.

name String

Resource name.

type String

Resource type for API Management resource.

description String

Group description. Can contain HTML formatting tags.

externalId String

For external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; otherwise the value is null.

Package Details

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