Custom Api Args
data class CustomApiArgs(val apiName: Output<String>? = null, val location: Output<String>? = null, val properties: Output<CustomApiPropertiesDefinitionArgs>? = null, val resourceGroupName: Output<String>? = null, val subscriptionId: Output<String>? = null, val tags: Output<Map<String, String>>? = null) : ConvertibleToJava<CustomApiArgs>
A custom API Uses Azure REST API version 2016-06-01. In version 2.x of the Azure Native provider, it used API version 2016-06-01.
Example Usage
Replace a custom API
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var customApi = new AzureNative.Web.CustomApi("customApi", new()
{
ApiName = "testCustomApi",
Properties = new AzureNative.Web.Inputs.CustomApiPropertiesDefinitionArgs
{
ApiDefinitions = new AzureNative.Web.Inputs.ApiResourceDefinitionsArgs
{
OriginalSwaggerUrl = "https://tempuri.org/swagger.json",
},
ApiType = AzureNative.Web.ApiType.Rest,
Capabilities = new() { },
Description = "",
DisplayName = "testCustomApi",
IconUri = "/testIcon.svg",
},
ResourceGroupName = "testResourceGroup",
});
});
Content copied to clipboard
package main
import (
web "github.com/pulumi/pulumi-azure-native-sdk/web/v3"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := web.NewCustomApi(ctx, "customApi", &web.CustomApiArgs{
ApiName: pulumi.String("testCustomApi"),
Properties: &web.CustomApiPropertiesDefinitionArgs{
ApiDefinitions: &web.ApiResourceDefinitionsArgs{
OriginalSwaggerUrl: pulumi.String("https://tempuri.org/swagger.json"),
},
ApiType: pulumi.String(web.ApiTypeRest),
Capabilities: pulumi.StringArray{},
Description: pulumi.String(""),
DisplayName: pulumi.String("testCustomApi"),
IconUri: pulumi.String("/testIcon.svg"),
},
ResourceGroupName: pulumi.String("testResourceGroup"),
})
if err != nil {
return err
}
return nil
})
}
Content copied to clipboard
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());
}
}
Content copied to clipboard
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:web:CustomApi testCustomApi /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/customApis/{apiName}
Content copied to clipboard