@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 3.36 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* 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](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare class MetadataSchema extends pulumi.CustomResource {
/**
* Get an existing MetadataSchema 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 opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): MetadataSchema;
/**
* Returns true if the given object is an instance of MetadataSchema. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is MetadataSchema;
/**
* The assignees
*/
readonly assignedTo: pulumi.Output<outputs.apicenter.MetadataAssignmentResponse[] | undefined>;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* The name of the resource
*/
readonly name: pulumi.Output<string>;
/**
* The schema defining the type.
*/
readonly schema: pulumi.Output<string>;
/**
* Azure Resource Manager metadata containing createdBy and modifiedBy information.
*/
readonly systemData: pulumi.Output<outputs.apicenter.SystemDataResponse>;
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
readonly type: pulumi.Output<string>;
/**
* Create a MetadataSchema resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: MetadataSchemaArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a MetadataSchema resource.
*/
export interface MetadataSchemaArgs {
/**
* The assignees
*/
assignedTo?: pulumi.Input<pulumi.Input<inputs.apicenter.MetadataAssignmentArgs>[]>;
/**
* The name of the metadata schema.
*/
metadataSchemaName?: pulumi.Input<string>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
/**
* The schema defining the type.
*/
schema: pulumi.Input<string>;
/**
* The name of Azure API Center service.
*/
serviceName: pulumi.Input<string>;
}