@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 3.21 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Gets the details of the Schema specified by its identifier.
*
* Uses Azure REST API version 2022-09-01-preview.
*
* Other available API versions: 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 function getGlobalSchema(args: GetGlobalSchemaArgs, opts?: pulumi.InvokeOptions): Promise<GetGlobalSchemaResult>;
export interface GetGlobalSchemaArgs {
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: string;
/**
* Schema id identifier. Must be unique in the current API Management service instance.
*/
schemaId: string;
/**
* The name of the API Management service.
*/
serviceName: string;
}
/**
* Global Schema Contract details.
*/
export interface GetGlobalSchemaResult {
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: string;
/**
* Free-form schema entity description.
*/
readonly description?: string;
/**
* Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
*/
readonly id: string;
/**
* The name of the resource
*/
readonly name: string;
/**
* Schema Type. Immutable.
*/
readonly schemaType: string;
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
readonly type: string;
/**
* Json-encoded string for non json-based schema.
*/
readonly value?: any;
}
/**
* Gets the details of the Schema specified by its identifier.
*
* Uses Azure REST API version 2022-09-01-preview.
*
* Other available API versions: 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 function getGlobalSchemaOutput(args: GetGlobalSchemaOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetGlobalSchemaResult>;
export interface GetGlobalSchemaOutputArgs {
/**
* 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>;
}