azure-native.apimanagement.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:
- Group
Id string Group identifier. Must be unique in the current API Management service instance.
- Resource
Group stringName The name of the resource group.
- Service
Name string The name of the API Management service.
- Group
Id string Group identifier. Must be unique in the current API Management service instance.
- Resource
Group stringName The name of the resource group.
- Service
Name string The name of the API Management service.
- group
Id String Group identifier. Must be unique in the current API Management service instance.
- resource
Group StringName The name of the resource group.
- service
Name String The name of the API Management service.
- group
Id string Group identifier. Must be unique in the current API Management service instance.
- resource
Group stringName The name of the resource group.
- service
Name 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_ strname The name of the resource group.
- service_
name str The name of the API Management service.
- group
Id String Group identifier. Must be unique in the current API Management service instance.
- resource
Group StringName The name of the resource group.
- service
Name String The name of the API Management service.
getGroup Result
The following output properties are available:
- Built
In bool true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false.
- Display
Name 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.
- External
Id 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 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.
- External
Id 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 Boolean true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false.
- display
Name 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.
- external
Id 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 boolean true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false.
- display
Name 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.
- external
Id 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.
- built
In Boolean true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false.
- display
Name 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.
- external
Id 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
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0