MetadataSchemaArgs

data class MetadataSchemaArgs(val assignedTo: Output<List<MetadataAssignmentArgs>>? = null, val metadataSchemaName: Output<String>? = null, val resourceGroupName: Output<String>? = null, val schema: Output<String>? = null, val serviceName: Output<String>? = null) : ConvertibleToJava<MetadataSchemaArgs>

Metadata schema entity. Used to define metadata for the entities in API catalog. Uses Azure REST API version 2024-03-15-preview. In version 2.x of the Azure Native provider, it used API version 2024-03-01. Other available API versions: 2024-03-01, 2024-06-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native apicenter [ApiVersion]. See the ../../../version-guide/#accessing-any-api-version-via-local-packages for details.

Example Usage

MetadataSchemas_CreateOrUpdate

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var metadataSchema = new AzureNative.ApiCenter.MetadataSchema("metadataSchema", new()
{
AssignedTo = new[]
{
new AzureNative.ApiCenter.Inputs.MetadataAssignmentArgs
{
Deprecated = true,
Entity = AzureNative.ApiCenter.MetadataAssignmentEntity.Api,
},
},
MetadataSchemaName = "author",
ResourceGroupName = "contoso-resources",
Schema = "{\"type\":\"string\", \"title\":\"Author\", pattern: \"^[a-zA-Z]+$\"}",
ServiceName = "contoso",
});
});
package main
import (
apicenter "github.com/pulumi/pulumi-azure-native-sdk/apicenter/v2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := apicenter.NewMetadataSchema(ctx, "metadataSchema", &apicenter.MetadataSchemaArgs{
AssignedTo: apicenter.MetadataAssignmentArray{
&apicenter.MetadataAssignmentArgs{
Deprecated: pulumi.Bool(true),
Entity: pulumi.String(apicenter.MetadataAssignmentEntityApi),
},
},
MetadataSchemaName: pulumi.String("author"),
ResourceGroupName: pulumi.String("contoso-resources"),
Schema: pulumi.String("{\"type\":\"string\", \"title\":\"Author\", pattern: \"^[a-zA-Z]+$\"}"),
ServiceName: pulumi.String("contoso"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.apicenter.MetadataSchema;
import com.pulumi.azurenative.apicenter.MetadataSchemaArgs;
import com.pulumi.azurenative.apicenter.inputs.MetadataAssignmentArgs;
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 metadataSchema = new MetadataSchema("metadataSchema", MetadataSchemaArgs.builder()
.assignedTo(MetadataAssignmentArgs.builder()
.deprecated(true)
.entity("api")
.build())
.metadataSchemaName("author")
.resourceGroupName("contoso-resources")
.schema("{\"type\":\"string\", \"title\":\"Author\", pattern: \"^[a-zA-Z]+$\"}")
.serviceName("contoso")
.build());
}
}

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:apicenter:MetadataSchema author /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/metadataSchemas/{metadataSchemaName}

Constructors

Link copied to clipboard
constructor(assignedTo: Output<List<MetadataAssignmentArgs>>? = null, metadataSchemaName: Output<String>? = null, resourceGroupName: Output<String>? = null, schema: Output<String>? = null, serviceName: Output<String>? = null)

Properties

Link copied to clipboard
val assignedTo: Output<List<MetadataAssignmentArgs>>? = null

The assignees

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

The name of the metadata schema.

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

The name of the resource group. The name is case insensitive.

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

The schema defining the type.

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

The name of Azure API Center service.

Functions

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