com.pulumi.azurenative.apicenter.ApiDefinition 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.ApiDefinitionArgs;
import com.pulumi.azurenative.apicenter.outputs.ApiDefinitionPropertiesSpecificationResponse;
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.String;
import java.util.List;
import java.util.Optional;
import javax.annotation.Nullable;
/**
* API definition entity.
* Azure REST API version: 2024-03-01.
*
* Other available API versions: 2024-03-15-preview.
*
* ## Example Usage
* ### ApiDefinitions_CreateOrUpdate
*
*
* {@code
* package generated_program;
*
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.azurenative.apicenter.ApiDefinition;
* import com.pulumi.azurenative.apicenter.ApiDefinitionArgs;
* 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 apiDefinition = new ApiDefinition("apiDefinition", ApiDefinitionArgs.builder()
* .apiName("openapi")
* .definitionName("openapi")
* .description("Default spec")
* .resourceGroupName("contoso-resources")
* .serviceName("contoso")
* .title("OpenAPI")
* .versionName("2023-01-01")
* .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:ApiDefinition openapi /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/apis/{apiName}/versions/{versionName}/definitions/{definitionName}
* ```
*
*/
@ResourceType(type="azure-native:apicenter:ApiDefinition")
public class ApiDefinition extends com.pulumi.resources.CustomResource {
/**
* API definition description.
*
*/
@Export(name="description", refs={String.class}, tree="[0]")
private Output description;
/**
* @return API definition description.
*
*/
public Output> description() {
return Codegen.optional(this.description);
}
/**
* 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;
}
/**
* API specification details.
*
*/
@Export(name="specification", refs={ApiDefinitionPropertiesSpecificationResponse.class}, tree="[0]")
private Output specification;
/**
* @return API specification details.
*
*/
public Output specification() {
return this.specification;
}
/**
* 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;
}
/**
* API definition title.
*
*/
@Export(name="title", refs={String.class}, tree="[0]")
private Output title;
/**
* @return API definition 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 ApiDefinition(java.lang.String name) {
this(name, ApiDefinitionArgs.Empty);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
*/
public ApiDefinition(java.lang.String name, ApiDefinitionArgs 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 ApiDefinition(java.lang.String name, ApiDefinitionArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("azure-native:apicenter:ApiDefinition", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false);
}
private ApiDefinition(java.lang.String name, Output id, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("azure-native:apicenter:ApiDefinition", name, null, makeResourceOptions(options, id), false);
}
private static ApiDefinitionArgs makeArgs(ApiDefinitionArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
if (options != null && options.getUrn().isPresent()) {
return null;
}
return args == null ? ApiDefinitionArgs.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:ApiDefinition").build()),
Output.of(Alias.builder().type("azure-native:apicenter/v20240315preview:ApiDefinition").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 ApiDefinition get(java.lang.String name, Output id, @Nullable com.pulumi.resources.CustomResourceOptions options) {
return new ApiDefinition(name, id, options);
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy