All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.pulumi.azure.apimanagement.kotlin.GroupUser.kt Maven / Gradle / Ivy

@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.azure.apimanagement.kotlin

import com.pulumi.core.Output
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.String
import kotlin.Suppress
import kotlin.Unit

/**
 * Builder for [GroupUser].
 */
@PulumiTagMarker
public class GroupUserResourceBuilder internal constructor() {
    public var name: String? = null

    public var args: GroupUserArgs = GroupUserArgs()

    public var opts: CustomResourceOptions = CustomResourceOptions()

    /**
     * @param name The _unique_ name of the resulting resource.
     */
    public fun name(`value`: String) {
        this.name = value
    }

    /**
     * @param block The arguments to use to populate this resource's properties.
     */
    public suspend fun args(block: suspend GroupUserArgsBuilder.() -> Unit) {
        val builder = GroupUserArgsBuilder()
        block(builder)
        this.args = builder.build()
    }

    /**
     * @param block A bag of options that control this resource's behavior.
     */
    public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
        this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
    }

    internal fun build(): GroupUser {
        val builtJavaResource = com.pulumi.azure.apimanagement.GroupUser(
            this.name,
            this.args.toJava(),
            this.opts.toJava(),
        )
        return GroupUser(builtJavaResource)
    }
}

/**
 * Manages an API Management User Assignment to a Group.
 * ## Example Usage
 * 
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as azure from "@pulumi/azure";
 * const example = azure.apimanagement.getUser({
 *     userId: "my-user",
 *     apiManagementName: "example-apim",
 *     resourceGroupName: "search-service",
 * });
 * const exampleGroupUser = new azure.apimanagement.GroupUser("example", {
 *     userId: example.then(example => example.id),
 *     groupName: "example-group",
 *     resourceGroupName: example.then(example => example.resourceGroupName),
 *     apiManagementName: example.then(example => example.apiManagementName),
 * });
 * ```
 * ```python
 * import pulumi
 * import pulumi_azure as azure
 * example = azure.apimanagement.get_user(user_id="my-user",
 *     api_management_name="example-apim",
 *     resource_group_name="search-service")
 * example_group_user = azure.apimanagement.GroupUser("example",
 *     user_id=example.id,
 *     group_name="example-group",
 *     resource_group_name=example.resource_group_name,
 *     api_management_name=example.api_management_name)
 * ```
 * ```csharp
 * using System.Collections.Generic;
 * using System.Linq;
 * using Pulumi;
 * using Azure = Pulumi.Azure;
 * return await Deployment.RunAsync(() =>
 * {
 *     var example = Azure.ApiManagement.GetUser.Invoke(new()
 *     {
 *         UserId = "my-user",
 *         ApiManagementName = "example-apim",
 *         ResourceGroupName = "search-service",
 *     });
 *     var exampleGroupUser = new Azure.ApiManagement.GroupUser("example", new()
 *     {
 *         UserId = example.Apply(getUserResult => getUserResult.Id),
 *         GroupName = "example-group",
 *         ResourceGroupName = example.Apply(getUserResult => getUserResult.ResourceGroupName),
 *         ApiManagementName = example.Apply(getUserResult => getUserResult.ApiManagementName),
 *     });
 * });
 * ```
 * ```go
 * package main
 * import (
 * 	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/apimanagement"
 * 	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
 * )
 * func main() {
 * 	pulumi.Run(func(ctx *pulumi.Context) error {
 * 		example, err := apimanagement.LookupUser(ctx, &apimanagement.LookupUserArgs{
 * 			UserId:            "my-user",
 * 			ApiManagementName: "example-apim",
 * 			ResourceGroupName: "search-service",
 * 		}, nil)
 * 		if err != nil {
 * 			return err
 * 		}
 * 		_, err = apimanagement.NewGroupUser(ctx, "example", &apimanagement.GroupUserArgs{
 * 			UserId:            pulumi.String(example.Id),
 * 			GroupName:         pulumi.String("example-group"),
 * 			ResourceGroupName: pulumi.String(example.ResourceGroupName),
 * 			ApiManagementName: pulumi.String(example.ApiManagementName),
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		return nil
 * 	})
 * }
 * ```
 * ```java
 * package generated_program;
 * import com.pulumi.Context;
 * import com.pulumi.Pulumi;
 * import com.pulumi.core.Output;
 * import com.pulumi.azure.apimanagement.ApimanagementFunctions;
 * import com.pulumi.azure.apimanagement.inputs.GetUserArgs;
 * import com.pulumi.azure.apimanagement.GroupUser;
 * import com.pulumi.azure.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) {
 *         final var example = ApimanagementFunctions.getUser(GetUserArgs.builder()
 *             .userId("my-user")
 *             .apiManagementName("example-apim")
 *             .resourceGroupName("search-service")
 *             .build());
 *         var exampleGroupUser = new GroupUser("exampleGroupUser", GroupUserArgs.builder()
 *             .userId(example.applyValue(getUserResult -> getUserResult.id()))
 *             .groupName("example-group")
 *             .resourceGroupName(example.applyValue(getUserResult -> getUserResult.resourceGroupName()))
 *             .apiManagementName(example.applyValue(getUserResult -> getUserResult.apiManagementName()))
 *             .build());
 *     }
 * }
 * ```
 * ```yaml
 * resources:
 *   exampleGroupUser:
 *     type: azure:apimanagement:GroupUser
 *     name: example
 *     properties:
 *       userId: ${example.id}
 *       groupName: example-group
 *       resourceGroupName: ${example.resourceGroupName}
 *       apiManagementName: ${example.apiManagementName}
 * variables:
 *   example:
 *     fn::invoke:
 *       Function: azure:apimanagement:getUser
 *       Arguments:
 *         userId: my-user
 *         apiManagementName: example-apim
 *         resourceGroupName: search-service
 * ```
 * 
 * ## Import
 * API Management Group Users can be imported using the `resource id`, e.g.
 * ```sh
 * $ pulumi import azure:apimanagement/groupUser:GroupUser example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.ApiManagement/service/service1/groups/groupId/users/user123
 * ```
 */
public class GroupUser internal constructor(
    override val javaResource: com.pulumi.azure.apimanagement.GroupUser,
) : KotlinCustomResource(javaResource, GroupUserMapper) {
    /**
     * The name of the API Management Service. Changing this forces a new resource to be created.
     */
    public val apiManagementName: Output
        get() = javaResource.apiManagementName().applyValue({ args0 -> args0 })

    /**
     * The Name of the API Management Group within the API Management Service. Changing this forces a new resource to be created.
     */
    public val groupName: Output
        get() = javaResource.groupName().applyValue({ args0 -> args0 })

    /**
     * The name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
     */
    public val resourceGroupName: Output
        get() = javaResource.resourceGroupName().applyValue({ args0 -> args0 })

    /**
     * The ID of the API Management User which should be assigned to this API Management Group. Changing this forces a new resource to be created.
     */
    public val userId: Output
        get() = javaResource.userId().applyValue({ args0 -> args0 })
}

public object GroupUserMapper : ResourceMapper {
    override fun supportsMappingOfType(javaResource: Resource): Boolean =
        com.pulumi.azure.apimanagement.GroupUser::class == javaResource::class

    override fun map(javaResource: Resource): GroupUser = GroupUser(
        javaResource as
            com.pulumi.azure.apimanagement.GroupUser,
    )
}

/**
 * @see [GroupUser].
 * @param name The _unique_ name of the resulting resource.
 * @param block Builder for [GroupUser].
 */
public suspend fun groupUser(name: String, block: suspend GroupUserResourceBuilder.() -> Unit): GroupUser {
    val builder = GroupUserResourceBuilder()
    builder.name(name)
    block(builder)
    return builder.build()
}

/**
 * @see [GroupUser].
 * @param name The _unique_ name of the resulting resource.
 */
public fun groupUser(name: String): GroupUser {
    val builder = GroupUserResourceBuilder()
    builder.name(name)
    return builder.build()
}




© 2015 - 2025 Weber Informatics LLC | Privacy Policy