com.pulumi.azurenative.apicenter.Api 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.ApiArgs;
import com.pulumi.azurenative.apicenter.outputs.ContactResponse;
import com.pulumi.azurenative.apicenter.outputs.ExternalDocumentationResponse;
import com.pulumi.azurenative.apicenter.outputs.LicenseResponse;
import com.pulumi.azurenative.apicenter.outputs.SystemDataResponse;
import com.pulumi.azurenative.apicenter.outputs.TermsOfServiceResponse;
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;
/**
* API entity.
* Azure REST API version: 2024-03-01.
*
* Other available API versions: 2024-03-15-preview.
*
* ## Example Usage
* ### Apis_CreateOrUpdate
*
*
* {@code
* package generated_program;
*
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.azurenative.apicenter.Api;
* import com.pulumi.azurenative.apicenter.ApiArgs;
* import com.pulumi.azurenative.apicenter.inputs.ExternalDocumentationArgs;
* import com.pulumi.azurenative.apicenter.inputs.LicenseArgs;
* import com.pulumi.azurenative.apicenter.inputs.TermsOfServiceArgs;
* 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 api = new Api("api", ApiArgs.builder()
* .apiName("echo-api")
* .customProperties(Map.of("author", "John Doe"))
* .description("A simple HTTP request/response service.")
* .externalDocumentation(ExternalDocumentationArgs.builder()
* .title("Onboarding docs")
* .url("https://docs.contoso.com")
* .build())
* .kind("rest")
* .license(LicenseArgs.builder()
* .url("https://contoso.com/license")
* .build())
* .resourceGroupName("contoso-resources")
* .serviceName("contoso")
* .termsOfService(TermsOfServiceArgs.builder()
* .url("https://contoso.com/terms-of-service")
* .build())
* .title("Echo API")
* .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:Api echo-api /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/apis/{apiName}
* ```
*
*/
@ResourceType(type="azure-native:apicenter:Api")
public class Api extends com.pulumi.resources.CustomResource {
/**
* The set of contacts
*
*/
@Export(name="contacts", refs={List.class,ContactResponse.class}, tree="[0,1]")
private Output> contacts;
/**
* @return The set of contacts
*
*/
public Output>> contacts() {
return Codegen.optional(this.contacts);
}
/**
* 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);
}
/**
* Description of the API.
*
*/
@Export(name="description", refs={String.class}, tree="[0]")
private Output description;
/**
* @return Description of the API.
*
*/
public Output> description() {
return Codegen.optional(this.description);
}
/**
* The set of external documentation
*
*/
@Export(name="externalDocumentation", refs={List.class,ExternalDocumentationResponse.class}, tree="[0,1]")
private Output> externalDocumentation;
/**
* @return The set of external documentation
*
*/
public Output>> externalDocumentation() {
return Codegen.optional(this.externalDocumentation);
}
/**
* Kind of API. For example, REST or GraphQL.
*
*/
@Export(name="kind", refs={String.class}, tree="[0]")
private Output kind;
/**
* @return Kind of API. For example, REST or GraphQL.
*
*/
public Output kind() {
return this.kind;
}
/**
* The license information for the API.
*
*/
@Export(name="license", refs={LicenseResponse.class}, tree="[0]")
private Output license;
/**
* @return The license information for the API.
*
*/
public Output> license() {
return Codegen.optional(this.license);
}
/**
* Current lifecycle stage of the API.
*
*/
@Export(name="lifecycleStage", refs={String.class}, tree="[0]")
private Output lifecycleStage;
/**
* @return Current lifecycle stage of the API.
*
*/
public Output lifecycleStage() {
return this.lifecycleStage;
}
/**
* 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;
}
/**
* Short description of the API.
*
*/
@Export(name="summary", refs={String.class}, tree="[0]")
private Output summary;
/**
* @return Short description of the API.
*
*/
public Output> summary() {
return Codegen.optional(this.summary);
}
/**
* 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;
}
/**
* Terms of service for the API.
*
*/
@Export(name="termsOfService", refs={TermsOfServiceResponse.class}, tree="[0]")
private Output termsOfService;
/**
* @return Terms of service for the API.
*
*/
public Output> termsOfService() {
return Codegen.optional(this.termsOfService);
}
/**
* API title.
*
*/
@Export(name="title", refs={String.class}, tree="[0]")
private Output title;
/**
* @return API 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 Api(java.lang.String name) {
this(name, ApiArgs.Empty);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
*/
public Api(java.lang.String name, ApiArgs 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 Api(java.lang.String name, ApiArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("azure-native:apicenter:Api", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false);
}
private Api(java.lang.String name, Output id, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("azure-native:apicenter:Api", name, null, makeResourceOptions(options, id), false);
}
private static ApiArgs makeArgs(ApiArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
if (options != null && options.getUrn().isPresent()) {
return null;
}
return args == null ? ApiArgs.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:Api").build()),
Output.of(Alias.builder().type("azure-native:apicenter/v20240315preview:Api").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 Api get(java.lang.String name, Output id, @Nullable com.pulumi.resources.CustomResourceOptions options) {
return new Api(name, id, options);
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy