azure-native.apimanagement.GroupUser
Explore with Pulumi AI
User details. Azure REST API version: 2022-08-01. Prior API version in Azure Native 1.x: 2020-12-01.
Other available API versions: 2017-03-01, 2018-01-01, 2022-09-01-preview, 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-01, 2024-06-01-preview.
Example Usage
ApiManagementCreateGroupUser
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var groupUser = new AzureNative.ApiManagement.GroupUser("groupUser", new()
{
GroupId = "tempgroup",
ResourceGroupName = "rg1",
ServiceName = "apimService1",
UserId = "59307d350af58404d8a26300",
});
});
package main
import (
apimanagement "github.com/pulumi/pulumi-azure-native-sdk/apimanagement/v2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := apimanagement.NewGroupUser(ctx, "groupUser", &apimanagement.GroupUserArgs{
GroupId: pulumi.String("tempgroup"),
ResourceGroupName: pulumi.String("rg1"),
ServiceName: pulumi.String("apimService1"),
UserId: pulumi.String("59307d350af58404d8a26300"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.apimanagement.GroupUser;
import com.pulumi.azurenative.apimanagement.GroupUserArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var groupUser = new GroupUser("groupUser", GroupUserArgs.builder()
.groupId("tempgroup")
.resourceGroupName("rg1")
.serviceName("apimService1")
.userId("59307d350af58404d8a26300")
.build());
}
}
import pulumi
import pulumi_azure_native as azure_native
group_user = azure_native.apimanagement.GroupUser("groupUser",
group_id="tempgroup",
resource_group_name="rg1",
service_name="apimService1",
user_id="59307d350af58404d8a26300")
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const groupUser = new azure_native.apimanagement.GroupUser("groupUser", {
groupId: "tempgroup",
resourceGroupName: "rg1",
serviceName: "apimService1",
userId: "59307d350af58404d8a26300",
});
resources:
groupUser:
type: azure-native:apimanagement:GroupUser
properties:
groupId: tempgroup
resourceGroupName: rg1
serviceName: apimService1
userId: 59307d350af58404d8a26300
Create GroupUser Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new GroupUser(name: string, args: GroupUserArgs, opts?: CustomResourceOptions);
@overload
def GroupUser(resource_name: str,
args: GroupUserArgs,
opts: Optional[ResourceOptions] = None)
@overload
def GroupUser(resource_name: str,
opts: Optional[ResourceOptions] = None,
group_id: Optional[str] = None,
resource_group_name: Optional[str] = None,
service_name: Optional[str] = None,
user_id: Optional[str] = None)
func NewGroupUser(ctx *Context, name string, args GroupUserArgs, opts ...ResourceOption) (*GroupUser, error)
public GroupUser(string name, GroupUserArgs args, CustomResourceOptions? opts = null)
public GroupUser(String name, GroupUserArgs args)
public GroupUser(String name, GroupUserArgs args, CustomResourceOptions options)
type: azure-native:apimanagement:GroupUser
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args GroupUserArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args GroupUserArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args GroupUserArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args GroupUserArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args GroupUserArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var groupUserResource = new AzureNative.ApiManagement.GroupUser("groupUserResource", new()
{
GroupId = "string",
ResourceGroupName = "string",
ServiceName = "string",
UserId = "string",
});
example, err := apimanagement.NewGroupUser(ctx, "groupUserResource", &apimanagement.GroupUserArgs{
GroupId: pulumi.String("string"),
ResourceGroupName: pulumi.String("string"),
ServiceName: pulumi.String("string"),
UserId: pulumi.String("string"),
})
var groupUserResource = new GroupUser("groupUserResource", GroupUserArgs.builder()
.groupId("string")
.resourceGroupName("string")
.serviceName("string")
.userId("string")
.build());
group_user_resource = azure_native.apimanagement.GroupUser("groupUserResource",
group_id="string",
resource_group_name="string",
service_name="string",
user_id="string")
const groupUserResource = new azure_native.apimanagement.GroupUser("groupUserResource", {
groupId: "string",
resourceGroupName: "string",
serviceName: "string",
userId: "string",
});
type: azure-native:apimanagement:GroupUser
properties:
groupId: string
resourceGroupName: string
serviceName: string
userId: string
GroupUser Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The GroupUser resource accepts the following input properties:
- Group
Id string - Group identifier. Must be unique in the current API Management service instance.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Service
Name string - The name of the API Management service.
- User
Id string - User identifier. Must be unique in the current API Management service instance.
- Group
Id string - Group identifier. Must be unique in the current API Management service instance.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Service
Name string - The name of the API Management service.
- User
Id string - User identifier. Must be unique in the current API Management service instance.
- group
Id String - Group identifier. Must be unique in the current API Management service instance.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- service
Name String - The name of the API Management service.
- user
Id String - User identifier. Must be unique in the current API Management service instance.
- group
Id string - Group identifier. Must be unique in the current API Management service instance.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- service
Name string - The name of the API Management service.
- user
Id string - User identifier. Must be unique in the current API Management service instance.
- group_
id str - Group identifier. Must be unique in the current API Management service instance.
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- service_
name str - The name of the API Management service.
- user_
id str - User identifier. Must be unique in the current API Management service instance.
- group
Id String - Group identifier. Must be unique in the current API Management service instance.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- service
Name String - The name of the API Management service.
- user
Id String - User identifier. Must be unique in the current API Management service instance.
Outputs
All input properties are implicitly available as output properties. Additionally, the GroupUser resource produces the following output properties:
- Groups
List<Pulumi.
Azure Native. Api Management. Outputs. Group Contract Properties Response> - Collection of groups user is part of.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the resource
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Email string
- Email address.
- First
Name string - First name.
- Identities
List<Pulumi.
Azure Native. Api Management. Outputs. User Identity Contract Response> - Collection of user identities.
- Last
Name string - Last name.
- Note string
- Optional note about a user set by the administrator.
- Registration
Date string - Date of user registration. The date conforms to the following format:
yyyy-MM-ddTHH:mm:ssZ
as specified by the ISO 8601 standard. - State string
- Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active.
- Groups
[]Group
Contract Properties Response - Collection of groups user is part of.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the resource
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Email string
- Email address.
- First
Name string - First name.
- Identities
[]User
Identity Contract Response - Collection of user identities.
- Last
Name string - Last name.
- Note string
- Optional note about a user set by the administrator.
- Registration
Date string - Date of user registration. The date conforms to the following format:
yyyy-MM-ddTHH:mm:ssZ
as specified by the ISO 8601 standard. - State string
- Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active.
- groups
List<Group
Contract Properties Response> - Collection of groups user is part of.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- email String
- Email address.
- first
Name String - First name.
- identities
List<User
Identity Contract Response> - Collection of user identities.
- last
Name String - Last name.
- note String
- Optional note about a user set by the administrator.
- registration
Date String - Date of user registration. The date conforms to the following format:
yyyy-MM-ddTHH:mm:ssZ
as specified by the ISO 8601 standard. - state String
- Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active.
- groups
Group
Contract Properties Response[] - Collection of groups user is part of.
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- The name of the resource
- type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- email string
- Email address.
- first
Name string - First name.
- identities
User
Identity Contract Response[] - Collection of user identities.
- last
Name string - Last name.
- note string
- Optional note about a user set by the administrator.
- registration
Date string - Date of user registration. The date conforms to the following format:
yyyy-MM-ddTHH:mm:ssZ
as specified by the ISO 8601 standard. - state string
- Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active.
- groups
Sequence[Group
Contract Properties Response] - Collection of groups user is part of.
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- The name of the resource
- type str
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- email str
- Email address.
- first_
name str - First name.
- identities
Sequence[User
Identity Contract Response] - Collection of user identities.
- last_
name str - Last name.
- note str
- Optional note about a user set by the administrator.
- registration_
date str - Date of user registration. The date conforms to the following format:
yyyy-MM-ddTHH:mm:ssZ
as specified by the ISO 8601 standard. - state str
- Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active.
- groups List<Property Map>
- Collection of groups user is part of.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- email String
- Email address.
- first
Name String - First name.
- identities List<Property Map>
- Collection of user identities.
- last
Name String - Last name.
- note String
- Optional note about a user set by the administrator.
- registration
Date String - Date of user registration. The date conforms to the following format:
yyyy-MM-ddTHH:mm:ssZ
as specified by the ISO 8601 standard. - state String
- Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active.
Supporting Types
GroupContractPropertiesResponse, GroupContractPropertiesResponseArgs
- 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.
- 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. - Type string
- Group type.
- 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.
- 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. - Type string
- Group type.
- 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.
- 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. - type String
- Group type.
- 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.
- 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. - type string
- Group type.
- 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.
- 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. - type str
- Group type.
- 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.
- 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. - type String
- Group type.
UserIdentityContractResponse, UserIdentityContractResponseArgs
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:apimanagement:GroupUser 59307d350af58404d8a26300 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}/users/{userId}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0