com.pulumi.azurenative.web.CustomApi 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
A native Pulumi package for creating and managing Azure resources.
There is a newer version: 2.78.0
// *** 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.web;

import com.pulumi.azurenative.Utilities;
import com.pulumi.azurenative.web.CustomApiArgs;
import com.pulumi.azurenative.web.outputs.CustomApiPropertiesDefinitionResponse;
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.Map;
import java.util.Optional;
import javax.annotation.Nullable;

/**
 * A custom API
 * Azure REST API version: 2016-06-01. Prior API version in Azure Native 1.x: 2016-06-01.
 * 
 * ## Example Usage
 * ### Replace a custom API
 * 
 *  * {@code
 * package generated_program;
 * 
 * import com.pulumi.Context;
 * import com.pulumi.Pulumi;
 * import com.pulumi.core.Output;
 * import com.pulumi.azurenative.web.CustomApi;
 * import com.pulumi.azurenative.web.CustomApiArgs;
 * import com.pulumi.azurenative.web.inputs.CustomApiPropertiesDefinitionArgs;
 * import com.pulumi.azurenative.web.inputs.ApiResourceDefinitionsArgs;
 * 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 customApi = new CustomApi("customApi", CustomApiArgs.builder()
 *             .apiName("testCustomApi")
 *             .properties(CustomApiPropertiesDefinitionArgs.builder()
 *                 .apiDefinitions(ApiResourceDefinitionsArgs.builder()
 *                     .originalSwaggerUrl("https://tempuri.org/swagger.json")
 *                     .build())
 *                 .apiType("Rest")
 *                 .capabilities()
 *                 .description("")
 *                 .displayName("testCustomApi")
 *                 .iconUri("/testIcon.svg")
 *                 .build())
 *             .resourceGroupName("testResourceGroup")
 *             .build());
 * 
 *     }
 * }
 * 
 * }
 * 
 * 
 * ## Import
 * 
 * An existing resource can be imported using its type token, name, and identifier, e.g.
 * 
 * ```sh
 * $ pulumi import azure-native:web:CustomApi testCustomApi /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/customApis/{apiName} 
 * ```
 * 
 */
@ResourceType(type="azure-native:web:CustomApi")
public class CustomApi extends com.pulumi.resources.CustomResource {
    /**
     * Resource ETag
     * 
     */
    @Export(name="etag", refs={String.class}, tree="[0]")
    private Output etag;

    /**
     * @return Resource ETag
     * 
     */
    public Output> etag() {
        return Codegen.optional(this.etag);
    }
    /**
     * Resource location
     * 
     */
    @Export(name="location", refs={String.class}, tree="[0]")
    private Output location;

    /**
     * @return Resource location
     * 
     */
    public Output> location() {
        return Codegen.optional(this.location);
    }
    /**
     * Resource name
     * 
     */
    @Export(name="name", refs={String.class}, tree="[0]")
    private Output name;

    /**
     * @return Resource name
     * 
     */
    public Output name() {
        return this.name;
    }
    /**
     * Custom API properties
     * 
     */
    @Export(name="properties", refs={CustomApiPropertiesDefinitionResponse.class}, tree="[0]")
    private Output properties;

    /**
     * @return Custom API properties
     * 
     */
    public Output properties() {
        return this.properties;
    }
    /**
     * Resource tags
     * 
     */
    @Export(name="tags", refs={Map.class,String.class}, tree="[0,1,1]")
    private Output> tags;

    /**
     * @return Resource tags
     * 
     */
    public Output>> tags() {
        return Codegen.optional(this.tags);
    }
    /**
     * Resource type
     * 
     */
    @Export(name="type", refs={String.class}, tree="[0]")
    private Output type;

    /**
     * @return Resource type
     * 
     */
    public Output type() {
        return this.type;
    }

    /**
     *
     * @param name The _unique_ name of the resulting resource.
     */
    public CustomApi(java.lang.String name) {
        this(name, CustomApiArgs.Empty);
    }
    /**
     *
     * @param name The _unique_ name of the resulting resource.
     * @param args The arguments to use to populate this resource's properties.
     */
    public CustomApi(java.lang.String name, CustomApiArgs 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 CustomApi(java.lang.String name, CustomApiArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
        super("azure-native:web:CustomApi", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false);
    }

    private CustomApi(java.lang.String name, Output id, @Nullable com.pulumi.resources.CustomResourceOptions options) {
        super("azure-native:web:CustomApi", name, null, makeResourceOptions(options, id), false);
    }

    private static CustomApiArgs makeArgs(CustomApiArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
        if (options != null && options.getUrn().isPresent()) {
            return null;
        }
        return args == null ? CustomApiArgs.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:web/v20160601:CustomApi").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 CustomApi get(java.lang.String name, Output id, @Nullable com.pulumi.resources.CustomResourceOptions options) {
        return new CustomApi(name, id, options);
    }
}