com.pulumi.azurenative.apicenter.Environment 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.apicenter;
import com.pulumi.azurenative.Utilities;
import com.pulumi.azurenative.apicenter.EnvironmentArgs;
import com.pulumi.azurenative.apicenter.outputs.EnvironmentServerResponse;
import com.pulumi.azurenative.apicenter.outputs.OnboardingResponse;
import com.pulumi.azurenative.apicenter.outputs.SystemDataResponse;
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.Object;
import java.lang.String;
import java.util.List;
import java.util.Optional;
import javax.annotation.Nullable;
/**
* Environment entity.
* Azure REST API version: 2024-03-01.
*
* Other available API versions: 2024-03-15-preview.
*
* ## Example Usage
* ### Environments_CreateOrUpdate
*
*
* {@code
* package generated_program;
*
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.azurenative.apicenter.Environment;
* import com.pulumi.azurenative.apicenter.EnvironmentArgs;
* import com.pulumi.azurenative.apicenter.inputs.OnboardingArgs;
* import com.pulumi.azurenative.apicenter.inputs.EnvironmentServerArgs;
* 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 environment = new Environment("environment", EnvironmentArgs.builder()
* .description("The primary Azure API Management service for the European division of Contoso.")
* .environmentName("public")
* .kind("production")
* .onboarding(OnboardingArgs.builder()
* .developerPortalUri("https://developer.contoso.com")
* .instructions("Sign in or sign up in the specified developer portal to request API access. You must complete the internal privacy training for your account to be approved.")
* .build())
* .resourceGroupName("contoso-resources")
* .server(EnvironmentServerArgs.builder()
* .managementPortalUri("https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiManagement/service/contoso")
* .type("Azure API Management")
* .build())
* .serviceName("contoso")
* .title("Contoso Europe Azure API Management")
* .workspaceName("default")
* .build());
*
* }
* }
*
* }
*
*
* ## Import
*
* An existing resource can be imported using its type token, name, and identifier, e.g.
*
* ```sh
* $ pulumi import azure-native:apicenter:Environment public /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/environments/{environmentName}
* ```
*
*/
@ResourceType(type="azure-native:apicenter:Environment")
public class Environment extends com.pulumi.resources.CustomResource {
/**
* The custom metadata defined for API catalog entities.
*
*/
@Export(name="customProperties", refs={Object.class}, tree="[0]")
private Output customProperties;
/**
* @return The custom metadata defined for API catalog entities.
*
*/
public Output> customProperties() {
return Codegen.optional(this.customProperties);
}
/**
* The environment description.
*
*/
@Export(name="description", refs={String.class}, tree="[0]")
private Output description;
/**
* @return The environment description.
*
*/
public Output> description() {
return Codegen.optional(this.description);
}
/**
* Environment kind.
*
*/
@Export(name="kind", refs={String.class}, tree="[0]")
private Output kind;
/**
* @return Environment kind.
*
*/
public Output kind() {
return this.kind;
}
/**
* 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;
}
/**
* Environment onboarding information
*
*/
@Export(name="onboarding", refs={OnboardingResponse.class}, tree="[0]")
private Output onboarding;
/**
* @return Environment onboarding information
*
*/
public Output> onboarding() {
return Codegen.optional(this.onboarding);
}
/**
* Server information of the environment.
*
*/
@Export(name="server", refs={EnvironmentServerResponse.class}, tree="[0]")
private Output server;
/**
* @return Server information of the environment.
*
*/
public Output> server() {
return Codegen.optional(this.server);
}
/**
* Azure Resource Manager metadata containing createdBy and modifiedBy information.
*
*/
@Export(name="systemData", refs={SystemDataResponse.class}, tree="[0]")
private Output systemData;
/**
* @return Azure Resource Manager metadata containing createdBy and modifiedBy information.
*
*/
public Output systemData() {
return this.systemData;
}
/**
* Environment title.
*
*/
@Export(name="title", refs={String.class}, tree="[0]")
private Output title;
/**
* @return Environment title.
*
*/
public Output title() {
return this.title;
}
/**
* 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 Environment(java.lang.String name) {
this(name, EnvironmentArgs.Empty);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
*/
public Environment(java.lang.String name, EnvironmentArgs 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 Environment(java.lang.String name, EnvironmentArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("azure-native:apicenter:Environment", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false);
}
private Environment(java.lang.String name, Output id, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("azure-native:apicenter:Environment", name, null, makeResourceOptions(options, id), false);
}
private static EnvironmentArgs makeArgs(EnvironmentArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
if (options != null && options.getUrn().isPresent()) {
return null;
}
return args == null ? EnvironmentArgs.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:apicenter/v20240301:Environment").build()),
Output.of(Alias.builder().type("azure-native:apicenter/v20240315preview:Environment").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 Environment get(java.lang.String name, Output id, @Nullable com.pulumi.resources.CustomResourceOptions options) {
return new Environment(name, id, options);
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy