@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 4.98 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* API Schema Contract details.
*
* Uses Azure REST API version 2022-09-01-preview. In version 2.x of the Azure Native provider, it used API version 2022-08-01.
*
* Other available API versions: 2021-04-01-preview, 2021-08-01, 2021-12-01-preview, 2022-04-01-preview, 2022-08-01, 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-01, 2024-06-01-preview, 2024-10-01-preview. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native apimanagement [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare class ApiSchema extends pulumi.CustomResource {
/**
* Get an existing ApiSchema 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): ApiSchema;
/**
* Returns true if the given object is an instance of ApiSchema. 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 ApiSchema;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* Types definitions. Used for Swagger/OpenAPI v2/v3 schemas only, null otherwise.
*/
readonly components: pulumi.Output<any | undefined>;
/**
* Must be a valid a media type used in a Content-Type header as defined in the RFC 2616. Media type of the schema document (e.g. application/json, application/xml). </br> - `Swagger` Schema use `application/vnd.ms-azure-apim.swagger.definitions+json` </br> - `WSDL` Schema use `application/vnd.ms-azure-apim.xsd+xml` </br> - `OpenApi` Schema use `application/vnd.oai.openapi.components+json` </br> - `WADL Schema` use `application/vnd.ms-azure-apim.wadl.grammars+xml`.
*/
readonly contentType: pulumi.Output<string>;
/**
* Types definitions. Used for Swagger/OpenAPI v1 schemas only, null otherwise.
*/
readonly definitions: pulumi.Output<any | undefined>;
/**
* The name of the resource
*/
readonly name: pulumi.Output<string>;
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
readonly type: pulumi.Output<string>;
/**
* Json escaped string defining the document representing the Schema. Used for schemas other than Swagger/OpenAPI.
*/
readonly value: pulumi.Output<string | undefined>;
/**
* Create a ApiSchema 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: ApiSchemaArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a ApiSchema resource.
*/
export interface ApiSchemaArgs {
/**
* API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
*/
apiId: pulumi.Input<string>;
/**
* Types definitions. Used for Swagger/OpenAPI v2/v3 schemas only, null otherwise.
*/
components?: any;
/**
* Must be a valid a media type used in a Content-Type header as defined in the RFC 2616. Media type of the schema document (e.g. application/json, application/xml). </br> - `Swagger` Schema use `application/vnd.ms-azure-apim.swagger.definitions+json` </br> - `WSDL` Schema use `application/vnd.ms-azure-apim.xsd+xml` </br> - `OpenApi` Schema use `application/vnd.oai.openapi.components+json` </br> - `WADL Schema` use `application/vnd.ms-azure-apim.wadl.grammars+xml`.
*/
contentType: pulumi.Input<string>;
/**
* Types definitions. Used for Swagger/OpenAPI v1 schemas only, null otherwise.
*/
definitions?: any;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
/**
* Schema id identifier. Must be unique in the current API Management service instance.
*/
schemaId?: pulumi.Input<string>;
/**
* The name of the API Management service.
*/
serviceName: pulumi.Input<string>;
/**
* Json escaped string defining the document representing the Schema. Used for schemas other than Swagger/OpenAPI.
*/
value?: pulumi.Input<string>;
}