1. Packages
  2. Azure Native v2
  3. API Docs
  4. apimanagement
  5. getWorkspaceGroup
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

azure-native-v2.apimanagement.getWorkspaceGroup

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

Gets the details of the group specified by its identifier. Azure REST API version: 2022-09-01-preview.

Other available API versions: 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-01, 2024-06-01-preview.

Using getWorkspaceGroup

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 getWorkspaceGroup(args: GetWorkspaceGroupArgs, opts?: InvokeOptions): Promise<GetWorkspaceGroupResult>
function getWorkspaceGroupOutput(args: GetWorkspaceGroupOutputArgs, opts?: InvokeOptions): Output<GetWorkspaceGroupResult>
Copy
def get_workspace_group(group_id: Optional[str] = None,
                        resource_group_name: Optional[str] = None,
                        service_name: Optional[str] = None,
                        workspace_id: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetWorkspaceGroupResult
def get_workspace_group_output(group_id: Optional[pulumi.Input[str]] = None,
                        resource_group_name: Optional[pulumi.Input[str]] = None,
                        service_name: Optional[pulumi.Input[str]] = None,
                        workspace_id: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetWorkspaceGroupResult]
Copy
func LookupWorkspaceGroup(ctx *Context, args *LookupWorkspaceGroupArgs, opts ...InvokeOption) (*LookupWorkspaceGroupResult, error)
func LookupWorkspaceGroupOutput(ctx *Context, args *LookupWorkspaceGroupOutputArgs, opts ...InvokeOption) LookupWorkspaceGroupResultOutput
Copy

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

public static class GetWorkspaceGroup 
{
    public static Task<GetWorkspaceGroupResult> InvokeAsync(GetWorkspaceGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetWorkspaceGroupResult> Invoke(GetWorkspaceGroupInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetWorkspaceGroupResult> getWorkspaceGroup(GetWorkspaceGroupArgs args, InvokeOptions options)
public static Output<GetWorkspaceGroupResult> getWorkspaceGroup(GetWorkspaceGroupArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:apimanagement:getWorkspaceGroup
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

GroupId
This property is required.
Changes to this property will trigger replacement.
string
Group identifier. Must be unique in the current API Management service instance.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
WorkspaceId
This property is required.
Changes to this property will trigger replacement.
string
Workspace identifier. Must be unique in the current API Management service instance.
GroupId
This property is required.
Changes to this property will trigger replacement.
string
Group identifier. Must be unique in the current API Management service instance.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
WorkspaceId
This property is required.
Changes to this property will trigger replacement.
string
Workspace identifier. Must be unique in the current API Management service instance.
groupId
This property is required.
Changes to this property will trigger replacement.
String
Group identifier. Must be unique in the current API Management service instance.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the API Management service.
workspaceId
This property is required.
Changes to this property will trigger replacement.
String
Workspace identifier. Must be unique in the current API Management service instance.
groupId
This property is required.
Changes to this property will trigger replacement.
string
Group identifier. Must be unique in the current API Management service instance.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
workspaceId
This property is required.
Changes to this property will trigger replacement.
string
Workspace identifier. Must be unique in the current API Management service instance.
group_id
This property is required.
Changes to this property will trigger replacement.
str
Group identifier. Must be unique in the current API Management service instance.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
service_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the API Management service.
workspace_id
This property is required.
Changes to this property will trigger replacement.
str
Workspace identifier. Must be unique in the current API Management service instance.
groupId
This property is required.
Changes to this property will trigger replacement.
String
Group identifier. Must be unique in the current API Management service instance.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the API Management service.
workspaceId
This property is required.
Changes to this property will trigger replacement.
String
Workspace identifier. Must be unique in the current API Management service instance.

getWorkspaceGroup 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
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string
The name of the resource
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string
The name of the resource
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String
The name of the resource
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name string
The name of the resource
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name str
The name of the resource
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String
The name of the resource
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi