pulumi-azure-kotlin/com.pulumi.azure.apimanagement.kotlin/GlobalSchemaArgs

GlobalSchemaArgs

data class GlobalSchemaArgs(val apiManagementName: Output<String>? = null, val description: Output<String>? = null, val resourceGroupName: Output<String>? = null, val schemaId: Output<String>? = null, val type: Output<String>? = null, val value: Output<String>? = null) : ConvertibleToJava<GlobalSchemaArgs>

Manages a Global Schema within an API Management Service.

Example Usage

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.apimanagement.Service;
import com.pulumi.azure.apimanagement.ServiceArgs;
import com.pulumi.azure.apimanagement.GlobalSchema;
import com.pulumi.azure.apimanagement.GlobalSchemaArgs;
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 exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()
            .location("West Europe")
            .build());
        var exampleService = new Service("exampleService", ServiceArgs.builder()
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .publisherName("pub1")
            .publisherEmail("pub1@email.com")
            .skuName("Consumption_0")
            .build());
        var exampleGlobalSchema = new GlobalSchema("exampleGlobalSchema", GlobalSchemaArgs.builder()
            .schemaId("example-schema1")
            .apiManagementName(exampleService.name())
            .resourceGroupName(exampleResourceGroup.name())
            .type("xml")
            .value(Files.readString(Paths.get("api_management_api_schema.xml")))
            .build());
    }
}
Content copied to clipboard

Import

API Management API Schema's can be imported using the resource id, e.g.

$ pulumi import azure:apimanagement/globalSchema:GlobalSchema example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.ApiManagement/service/instance1/schemas/schema1
Content copied to clipboard

Constructors

Link copied to clipboard
fun GlobalSchemaArgs(apiManagementName: Output<String>? = null, description: Output<String>? = null, resourceGroupName: Output<String>? = null, schemaId: Output<String>? = null, type: Output<String>? = null, value: Output<String>? = null)

Functions

Link copied to clipboard
open override fun toJava(): GlobalSchemaArgs

Properties

Link copied to clipboard
val apiManagementName: Output<String>? = null

The Name of the API Management Service where the API exists. Changing this forces a new resource to be created.

Link copied to clipboard
val description: Output<String>? = null

The description of the schema.

Link copied to clipboard
val resourceGroupName: Output<String>? = null

The Name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.

Link copied to clipboard
val schemaId: Output<String>? = null

A unique identifier for this Schema. Changing this forces a new resource to be created.

Link copied to clipboard
val type: Output<String>? = null

The content type of the Schema. Possible values are xml and json.

Link copied to clipboard
val value: Output<String>? = null

The string defining the document representing the Schema.