com.pulumi.azure.apimanagement.kotlin.GroupArgs.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-azure-kotlin Show documentation
Show all versions of pulumi-azure-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.azure.apimanagement.kotlin
import com.pulumi.azure.apimanagement.GroupArgs.builder
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import kotlin.String
import kotlin.Suppress
import kotlin.jvm.JvmName
/**
* Manages an API Management Group.
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as azure from "@pulumi/azure";
* const example = new azure.core.ResourceGroup("example", {
* name: "example-resources",
* location: "West Europe",
* });
* const exampleService = new azure.apimanagement.Service("example", {
* name: "example-apim",
* location: example.location,
* resourceGroupName: example.name,
* publisherName: "pub1",
* publisherEmail: "[email protected]",
* skuName: "Developer_1",
* });
* const exampleGroup = new azure.apimanagement.Group("example", {
* name: "example-apimg",
* resourceGroupName: example.name,
* apiManagementName: exampleService.name,
* displayName: "Example Group",
* description: "This is an example API management group.",
* });
* ```
* ```python
* import pulumi
* import pulumi_azure as azure
* example = azure.core.ResourceGroup("example",
* name="example-resources",
* location="West Europe")
* example_service = azure.apimanagement.Service("example",
* name="example-apim",
* location=example.location,
* resource_group_name=example.name,
* publisher_name="pub1",
* publisher_email="[email protected]",
* sku_name="Developer_1")
* example_group = azure.apimanagement.Group("example",
* name="example-apimg",
* resource_group_name=example.name,
* api_management_name=example_service.name,
* display_name="Example Group",
* description="This is an example API management group.")
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Azure = Pulumi.Azure;
* return await Deployment.RunAsync(() =>
* {
* var example = new Azure.Core.ResourceGroup("example", new()
* {
* Name = "example-resources",
* Location = "West Europe",
* });
* var exampleService = new Azure.ApiManagement.Service("example", new()
* {
* Name = "example-apim",
* Location = example.Location,
* ResourceGroupName = example.Name,
* PublisherName = "pub1",
* PublisherEmail = "[email protected]",
* SkuName = "Developer_1",
* });
* var exampleGroup = new Azure.ApiManagement.Group("example", new()
* {
* Name = "example-apimg",
* ResourceGroupName = example.Name,
* ApiManagementName = exampleService.Name,
* DisplayName = "Example Group",
* Description = "This is an example API management group.",
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-azure/sdk/v5/go/azure/apimanagement"
* "github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
* Name: pulumi.String("example-resources"),
* Location: pulumi.String("West Europe"),
* })
* if err != nil {
* return err
* }
* exampleService, err := apimanagement.NewService(ctx, "example", &apimanagement.ServiceArgs{
* Name: pulumi.String("example-apim"),
* Location: example.Location,
* ResourceGroupName: example.Name,
* PublisherName: pulumi.String("pub1"),
* PublisherEmail: pulumi.String("[email protected]"),
* SkuName: pulumi.String("Developer_1"),
* })
* if err != nil {
* return err
* }
* _, err = apimanagement.NewGroup(ctx, "example", &apimanagement.GroupArgs{
* Name: pulumi.String("example-apimg"),
* ResourceGroupName: example.Name,
* ApiManagementName: exampleService.Name,
* DisplayName: pulumi.String("Example Group"),
* Description: pulumi.String("This is an example API management group."),
* })
* 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.core.ResourceGroup;
* import com.pulumi.azure.core.ResourceGroupArgs;
* import com.pulumi.azure.apimanagement.Service;
* import com.pulumi.azure.apimanagement.ServiceArgs;
* import com.pulumi.azure.apimanagement.Group;
* import com.pulumi.azure.apimanagement.GroupArgs;
* 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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
* .name("example-resources")
* .location("West Europe")
* .build());
* var exampleService = new Service("exampleService", ServiceArgs.builder()
* .name("example-apim")
* .location(example.location())
* .resourceGroupName(example.name())
* .publisherName("pub1")
* .publisherEmail("[email protected]")
* .skuName("Developer_1")
* .build());
* var exampleGroup = new Group("exampleGroup", GroupArgs.builder()
* .name("example-apimg")
* .resourceGroupName(example.name())
* .apiManagementName(exampleService.name())
* .displayName("Example Group")
* .description("This is an example API management group.")
* .build());
* }
* }
* ```
* ```yaml
* resources:
* example:
* type: azure:core:ResourceGroup
* properties:
* name: example-resources
* location: West Europe
* exampleService:
* type: azure:apimanagement:Service
* name: example
* properties:
* name: example-apim
* location: ${example.location}
* resourceGroupName: ${example.name}
* publisherName: pub1
* publisherEmail: [email protected]
* skuName: Developer_1
* exampleGroup:
* type: azure:apimanagement:Group
* name: example
* properties:
* name: example-apimg
* resourceGroupName: ${example.name}
* apiManagementName: ${exampleService.name}
* displayName: Example Group
* description: This is an example API management group.
* ```
*
* ## Import
* API Management Groups can be imported using the `resource id`, e.g.
* ```sh
* $ pulumi import azure:apimanagement/group:Group example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example-resources/providers/Microsoft.ApiManagement/service/example-apim/groups/example-apimg
* ```
* @property apiManagementName The name of the API Management Service in which the API Management Group should exist. Changing this forces a new resource to be created.
* @property description The description of this API Management Group.
* @property displayName The display name of this API Management Group.
* @property externalId The identifier of the external Group. For example, an Azure Active Directory group `aad:///groups/`. Changing this forces a new resource to be created.
* @property name The name of the API Management Group. Changing this forces a new resource to be created.
* @property resourceGroupName The name of the Resource Group in which the API Management Group should exist. Changing this forces a new resource to be created.
* @property type The type of this API Management Group. Possible values are `custom`, `external` and `system`. Default is `custom`. Changing this forces a new resource to be created.
*/
public data class GroupArgs(
public val apiManagementName: Output? = null,
public val description: Output? = null,
public val displayName: Output? = null,
public val externalId: Output? = null,
public val name: Output? = null,
public val resourceGroupName: Output? = null,
public val type: Output? = null,
) : ConvertibleToJava {
override fun toJava(): com.pulumi.azure.apimanagement.GroupArgs =
com.pulumi.azure.apimanagement.GroupArgs.builder()
.apiManagementName(apiManagementName?.applyValue({ args0 -> args0 }))
.description(description?.applyValue({ args0 -> args0 }))
.displayName(displayName?.applyValue({ args0 -> args0 }))
.externalId(externalId?.applyValue({ args0 -> args0 }))
.name(name?.applyValue({ args0 -> args0 }))
.resourceGroupName(resourceGroupName?.applyValue({ args0 -> args0 }))
.type(type?.applyValue({ args0 -> args0 })).build()
}
/**
* Builder for [GroupArgs].
*/
@PulumiTagMarker
public class GroupArgsBuilder internal constructor() {
private var apiManagementName: Output? = null
private var description: Output? = null
private var displayName: Output? = null
private var externalId: Output? = null
private var name: Output? = null
private var resourceGroupName: Output? = null
private var type: Output? = null
/**
* @param value The name of the API Management Service in which the API Management Group should exist. Changing this forces a new resource to be created.
*/
@JvmName("bufjilmykxsartdw")
public suspend fun apiManagementName(`value`: Output) {
this.apiManagementName = value
}
/**
* @param value The description of this API Management Group.
*/
@JvmName("mvfqtbeqgbqfuhxd")
public suspend fun description(`value`: Output) {
this.description = value
}
/**
* @param value The display name of this API Management Group.
*/
@JvmName("ujifeqnjeuhdwkwv")
public suspend fun displayName(`value`: Output) {
this.displayName = value
}
/**
* @param value The identifier of the external Group. For example, an Azure Active Directory group `aad:///groups/`. Changing this forces a new resource to be created.
*/
@JvmName("expntsnsnpuqvljy")
public suspend fun externalId(`value`: Output) {
this.externalId = value
}
/**
* @param value The name of the API Management Group. Changing this forces a new resource to be created.
*/
@JvmName("eqhfbjtgoipygjge")
public suspend fun name(`value`: Output) {
this.name = value
}
/**
* @param value The name of the Resource Group in which the API Management Group should exist. Changing this forces a new resource to be created.
*/
@JvmName("vpwyyriywxuqlusl")
public suspend fun resourceGroupName(`value`: Output) {
this.resourceGroupName = value
}
/**
* @param value The type of this API Management Group. Possible values are `custom`, `external` and `system`. Default is `custom`. Changing this forces a new resource to be created.
*/
@JvmName("ahattkaxwddvxjtt")
public suspend fun type(`value`: Output) {
this.type = value
}
/**
* @param value The name of the API Management Service in which the API Management Group should exist. Changing this forces a new resource to be created.
*/
@JvmName("alsttcfenimsywrb")
public suspend fun apiManagementName(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.apiManagementName = mapped
}
/**
* @param value The description of this API Management Group.
*/
@JvmName("qvphecqvfrkpfmka")
public suspend fun description(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.description = mapped
}
/**
* @param value The display name of this API Management Group.
*/
@JvmName("tnlarnkbcfurmywt")
public suspend fun displayName(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.displayName = mapped
}
/**
* @param value The identifier of the external Group. For example, an Azure Active Directory group `aad:///groups/`. Changing this forces a new resource to be created.
*/
@JvmName("txrebodwbppqdasa")
public suspend fun externalId(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.externalId = mapped
}
/**
* @param value The name of the API Management Group. Changing this forces a new resource to be created.
*/
@JvmName("dxspacjyxgqyqorh")
public suspend fun name(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.name = mapped
}
/**
* @param value The name of the Resource Group in which the API Management Group should exist. Changing this forces a new resource to be created.
*/
@JvmName("xsrswunbybxhsknd")
public suspend fun resourceGroupName(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.resourceGroupName = mapped
}
/**
* @param value The type of this API Management Group. Possible values are `custom`, `external` and `system`. Default is `custom`. Changing this forces a new resource to be created.
*/
@JvmName("fjflgtpptyvohjif")
public suspend fun type(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.type = mapped
}
internal fun build(): GroupArgs = GroupArgs(
apiManagementName = apiManagementName,
description = description,
displayName = displayName,
externalId = externalId,
name = name,
resourceGroupName = resourceGroupName,
type = type,
)
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy