com.pulumi.azurenative.apimanagement.Group Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure-native Show documentation
Show all versions of azure-native Show documentation
A native Pulumi package for creating and managing Azure resources.
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.azurenative.apimanagement;
import com.pulumi.azurenative.Utilities;
import com.pulumi.azurenative.apimanagement.GroupArgs;
import com.pulumi.core.Alias;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Export;
import com.pulumi.core.annotations.ResourceType;
import com.pulumi.core.internal.Codegen;
import java.lang.Boolean;
import java.lang.String;
import java.util.List;
import java.util.Optional;
import javax.annotation.Nullable;
/**
* Contract details.
* Azure REST API version: 2022-08-01. Prior API version in Azure Native 1.x: 2020-12-01.
*
* Other available API versions: 2016-07-07, 2016-10-10, 2022-09-01-preview, 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-01.
*
* ## Example Usage
* ### ApiManagementCreateGroup
*
*
* {@code
* package generated_program;
*
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.azurenative.apimanagement.Group;
* import com.pulumi.azurenative.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 group = new Group("group", GroupArgs.builder()
* .displayName("temp group")
* .groupId("tempgroup")
* .resourceGroupName("rg1")
* .serviceName("apimService1")
* .build());
*
* }
* }
*
* }
*
* ### ApiManagementCreateGroupExternal
*
*
* {@code
* package generated_program;
*
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.azurenative.apimanagement.Group;
* import com.pulumi.azurenative.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 group = new Group("group", GroupArgs.builder()
* .description("new group to test")
* .displayName("NewGroup (samiraad.onmicrosoft.com)")
* .externalId("aad://samiraad.onmicrosoft.com/groups/83cf2753-5831-4675-bc0e-2f8dc067c58d")
* .groupId("aadGroup")
* .resourceGroupName("rg1")
* .serviceName("apimService1")
* .type("external")
* .build());
*
* }
* }
*
* }
*
*
* ## Import
*
* An existing resource can be imported using its type token, name, and identifier, e.g.
*
* ```sh
* $ pulumi import azure-native:apimanagement:Group aadGroup /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}
* ```
*
*/
@ResourceType(type="azure-native:apimanagement:Group")
public class Group extends com.pulumi.resources.CustomResource {
/**
* true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false.
*
*/
@Export(name="builtIn", refs={Boolean.class}, tree="[0]")
private Output builtIn;
/**
* @return true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false.
*
*/
public Output builtIn() {
return this.builtIn;
}
/**
* Group description. Can contain HTML formatting tags.
*
*/
@Export(name="description", refs={String.class}, tree="[0]")
private Output description;
/**
* @return Group description. Can contain HTML formatting tags.
*
*/
public Output> description() {
return Codegen.optional(this.description);
}
/**
* Group name.
*
*/
@Export(name="displayName", refs={String.class}, tree="[0]")
private Output displayName;
/**
* @return Group name.
*
*/
public Output displayName() {
return this.displayName;
}
/**
* 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.
*
*/
@Export(name="externalId", refs={String.class}, tree="[0]")
private Output externalId;
/**
* @return 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.
*
*/
public Output> externalId() {
return Codegen.optional(this.externalId);
}
/**
* The name of the resource
*
*/
@Export(name="name", refs={String.class}, tree="[0]")
private Output name;
/**
* @return The name of the resource
*
*/
public Output name() {
return this.name;
}
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*
*/
@Export(name="type", refs={String.class}, tree="[0]")
private Output type;
/**
* @return The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*
*/
public Output type() {
return this.type;
}
/**
*
* @param name The _unique_ name of the resulting resource.
*/
public Group(java.lang.String name) {
this(name, GroupArgs.Empty);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
*/
public Group(java.lang.String name, GroupArgs args) {
this(name, args, null);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
* @param options A bag of options that control this resource's behavior.
*/
public Group(java.lang.String name, GroupArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("azure-native:apimanagement:Group", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false);
}
private Group(java.lang.String name, Output id, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("azure-native:apimanagement:Group", name, null, makeResourceOptions(options, id), false);
}
private static GroupArgs makeArgs(GroupArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
if (options != null && options.getUrn().isPresent()) {
return null;
}
return args == null ? GroupArgs.Empty : args;
}
private static com.pulumi.resources.CustomResourceOptions makeResourceOptions(@Nullable com.pulumi.resources.CustomResourceOptions options, @Nullable Output id) {
var defaultOptions = com.pulumi.resources.CustomResourceOptions.builder()
.version(Utilities.getVersion())
.aliases(List.of(
Output.of(Alias.builder().type("azure-native:apimanagement/v20160707:Group").build()),
Output.of(Alias.builder().type("azure-native:apimanagement/v20161010:Group").build()),
Output.of(Alias.builder().type("azure-native:apimanagement/v20170301:Group").build()),
Output.of(Alias.builder().type("azure-native:apimanagement/v20180101:Group").build()),
Output.of(Alias.builder().type("azure-native:apimanagement/v20180601preview:Group").build()),
Output.of(Alias.builder().type("azure-native:apimanagement/v20190101:Group").build()),
Output.of(Alias.builder().type("azure-native:apimanagement/v20191201:Group").build()),
Output.of(Alias.builder().type("azure-native:apimanagement/v20191201preview:Group").build()),
Output.of(Alias.builder().type("azure-native:apimanagement/v20200601preview:Group").build()),
Output.of(Alias.builder().type("azure-native:apimanagement/v20201201:Group").build()),
Output.of(Alias.builder().type("azure-native:apimanagement/v20210101preview:Group").build()),
Output.of(Alias.builder().type("azure-native:apimanagement/v20210401preview:Group").build()),
Output.of(Alias.builder().type("azure-native:apimanagement/v20210801:Group").build()),
Output.of(Alias.builder().type("azure-native:apimanagement/v20211201preview:Group").build()),
Output.of(Alias.builder().type("azure-native:apimanagement/v20220401preview:Group").build()),
Output.of(Alias.builder().type("azure-native:apimanagement/v20220801:Group").build()),
Output.of(Alias.builder().type("azure-native:apimanagement/v20220901preview:Group").build()),
Output.of(Alias.builder().type("azure-native:apimanagement/v20230301preview:Group").build()),
Output.of(Alias.builder().type("azure-native:apimanagement/v20230501preview:Group").build()),
Output.of(Alias.builder().type("azure-native:apimanagement/v20230901preview:Group").build()),
Output.of(Alias.builder().type("azure-native:apimanagement/v20240501:Group").build())
))
.build();
return com.pulumi.resources.CustomResourceOptions.merge(defaultOptions, options, id);
}
/**
* Get an existing Host resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param options Optional settings to control the behavior of the CustomResource.
*/
public static Group get(java.lang.String name, Output id, @Nullable com.pulumi.resources.CustomResourceOptions options) {
return new Group(name, id, options);
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy