@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [![Python version](https://badge.fury.io/py/pu
125 lines • 14.9 kB
JavaScript
;
// *** WARNING: this file was generated by pulumi-language-nodejs. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.Api = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* API 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.
*/
class Api extends pulumi.CustomResource {
/**
* Get an existing Api 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, id, opts) {
return new Api(name, undefined, { ...opts, id: id });
}
/**
* Returns true if the given object is an instance of Api. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj) {
if (obj === undefined || obj === null) {
return false;
}
return obj['__pulumiType'] === Api.__pulumiType;
}
/**
* Create a Api 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, args, opts) {
let resourceInputs = {};
opts = opts || {};
if (!opts.id) {
if (args?.path === undefined && !opts.urn) {
throw new Error("Missing required property 'path'");
}
if (args?.resourceGroupName === undefined && !opts.urn) {
throw new Error("Missing required property 'resourceGroupName'");
}
if (args?.serviceName === undefined && !opts.urn) {
throw new Error("Missing required property 'serviceName'");
}
resourceInputs["apiId"] = args?.apiId;
resourceInputs["apiRevision"] = args?.apiRevision;
resourceInputs["apiRevisionDescription"] = args?.apiRevisionDescription;
resourceInputs["apiType"] = args?.apiType;
resourceInputs["apiVersion"] = args?.apiVersion;
resourceInputs["apiVersionDescription"] = args?.apiVersionDescription;
resourceInputs["apiVersionSet"] = args?.apiVersionSet;
resourceInputs["apiVersionSetId"] = args?.apiVersionSetId;
resourceInputs["authenticationSettings"] = args?.authenticationSettings;
resourceInputs["contact"] = args?.contact;
resourceInputs["description"] = args?.description;
resourceInputs["displayName"] = args?.displayName;
resourceInputs["format"] = args?.format;
resourceInputs["isCurrent"] = args?.isCurrent;
resourceInputs["license"] = args?.license;
resourceInputs["path"] = args?.path;
resourceInputs["protocols"] = args?.protocols;
resourceInputs["resourceGroupName"] = args?.resourceGroupName;
resourceInputs["serviceName"] = args?.serviceName;
resourceInputs["serviceUrl"] = args?.serviceUrl;
resourceInputs["soapApiType"] = args?.soapApiType;
resourceInputs["sourceApiId"] = args?.sourceApiId;
resourceInputs["subscriptionKeyParameterNames"] = args?.subscriptionKeyParameterNames;
resourceInputs["subscriptionRequired"] = args?.subscriptionRequired;
resourceInputs["termsOfServiceUrl"] = args?.termsOfServiceUrl;
resourceInputs["translateRequiredQueryParametersConduct"] = args?.translateRequiredQueryParametersConduct;
resourceInputs["value"] = args?.value;
resourceInputs["wsdlSelector"] = args?.wsdlSelector;
resourceInputs["azureApiVersion"] = undefined /*out*/;
resourceInputs["isOnline"] = undefined /*out*/;
resourceInputs["name"] = undefined /*out*/;
resourceInputs["type"] = undefined /*out*/;
}
else {
resourceInputs["apiRevision"] = undefined /*out*/;
resourceInputs["apiRevisionDescription"] = undefined /*out*/;
resourceInputs["apiType"] = undefined /*out*/;
resourceInputs["apiVersion"] = undefined /*out*/;
resourceInputs["apiVersionDescription"] = undefined /*out*/;
resourceInputs["apiVersionSet"] = undefined /*out*/;
resourceInputs["apiVersionSetId"] = undefined /*out*/;
resourceInputs["authenticationSettings"] = undefined /*out*/;
resourceInputs["azureApiVersion"] = undefined /*out*/;
resourceInputs["contact"] = undefined /*out*/;
resourceInputs["description"] = undefined /*out*/;
resourceInputs["displayName"] = undefined /*out*/;
resourceInputs["isCurrent"] = undefined /*out*/;
resourceInputs["isOnline"] = undefined /*out*/;
resourceInputs["license"] = undefined /*out*/;
resourceInputs["name"] = undefined /*out*/;
resourceInputs["path"] = undefined /*out*/;
resourceInputs["protocols"] = undefined /*out*/;
resourceInputs["serviceUrl"] = undefined /*out*/;
resourceInputs["sourceApiId"] = undefined /*out*/;
resourceInputs["subscriptionKeyParameterNames"] = undefined /*out*/;
resourceInputs["subscriptionRequired"] = undefined /*out*/;
resourceInputs["termsOfServiceUrl"] = undefined /*out*/;
resourceInputs["type"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
const aliasOpts = { aliases: [{ type: "azure-native:apimanagement/v20160707:Api" }, { type: "azure-native:apimanagement/v20161010:Api" }, { type: "azure-native:apimanagement/v20170301:Api" }, { type: "azure-native:apimanagement/v20180101:Api" }, { type: "azure-native:apimanagement/v20180601preview:Api" }, { type: "azure-native:apimanagement/v20190101:Api" }, { type: "azure-native:apimanagement/v20191201:Api" }, { type: "azure-native:apimanagement/v20191201preview:Api" }, { type: "azure-native:apimanagement/v20200601preview:Api" }, { type: "azure-native:apimanagement/v20201201:Api" }, { type: "azure-native:apimanagement/v20210101preview:Api" }, { type: "azure-native:apimanagement/v20210401preview:Api" }, { type: "azure-native:apimanagement/v20210801:Api" }, { type: "azure-native:apimanagement/v20211201preview:Api" }, { type: "azure-native:apimanagement/v20220401preview:Api" }, { type: "azure-native:apimanagement/v20220801:Api" }, { type: "azure-native:apimanagement/v20220901preview:Api" }, { type: "azure-native:apimanagement/v20230301preview:Api" }, { type: "azure-native:apimanagement/v20230501preview:Api" }, { type: "azure-native:apimanagement/v20230901preview:Api" }, { type: "azure-native:apimanagement/v20240501:Api" }, { type: "azure-native:apimanagement/v20240601preview:Api" }, { type: "azure-native:apimanagement/v20241001preview:Api" }] };
opts = pulumi.mergeOptions(opts, aliasOpts);
super(Api.__pulumiType, name, resourceInputs, opts);
}
}
exports.Api = Api;
/** @internal */
Api.__pulumiType = 'azure-native:apimanagement:Api';
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXBpLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vYXBpbWFuYWdlbWVudC9hcGkudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLHNFQUFzRTtBQUN0RSxpRkFBaUY7OztBQUVqRix5Q0FBeUM7QUFJekMsMENBQTBDO0FBRTFDOzs7Ozs7R0FNRztBQUNILE1BQWEsR0FBSSxTQUFRLE1BQU0sQ0FBQyxjQUFjO0lBQzFDOzs7Ozs7O09BT0c7SUFDSSxNQUFNLENBQUMsR0FBRyxDQUFDLElBQVksRUFBRSxFQUEyQixFQUFFLElBQW1DO1FBQzVGLE9BQU8sSUFBSSxHQUFHLENBQUMsSUFBSSxFQUFFLFNBQWdCLEVBQUUsRUFBRSxHQUFHLElBQUksRUFBRSxFQUFFLEVBQUUsRUFBRSxFQUFFLENBQUMsQ0FBQztJQUNoRSxDQUFDO0lBS0Q7OztPQUdHO0lBQ0ksTUFBTSxDQUFDLFVBQVUsQ0FBQyxHQUFRO1FBQzdCLElBQUksR0FBRyxLQUFLLFNBQVMsSUFBSSxHQUFHLEtBQUssSUFBSSxFQUFFO1lBQ25DLE9BQU8sS0FBSyxDQUFDO1NBQ2hCO1FBQ0QsT0FBTyxHQUFHLENBQUMsY0FBYyxDQUFDLEtBQUssR0FBRyxDQUFDLFlBQVksQ0FBQztJQUNwRCxDQUFDO0lBbUdEOzs7Ozs7T0FNRztJQUNILFlBQVksSUFBWSxFQUFFLElBQWEsRUFBRSxJQUFtQztRQUN4RSxJQUFJLGNBQWMsR0FBa0IsRUFBRSxDQUFDO1FBQ3ZDLElBQUksR0FBRyxJQUFJLElBQUksRUFBRSxDQUFDO1FBQ2xCLElBQUksQ0FBQyxJQUFJLENBQUMsRUFBRSxFQUFFO1lBQ1YsSUFBSSxJQUFJLEVBQUUsSUFBSSxLQUFLLFNBQVMsSUFBSSxDQUFDLElBQUksQ0FBQyxHQUFHLEVBQUU7Z0JBQ3ZDLE1BQU0sSUFBSSxLQUFLLENBQUMsa0NBQWtDLENBQUMsQ0FBQzthQUN2RDtZQUNELElBQUksSUFBSSxFQUFFLGlCQUFpQixLQUFLLFNBQVMsSUFBSSxDQUFDLElBQUksQ0FBQyxHQUFHLEVBQUU7Z0JBQ3BELE1BQU0sSUFBSSxLQUFLLENBQUMsK0NBQStDLENBQUMsQ0FBQzthQUNwRTtZQUNELElBQUksSUFBSSxFQUFFLFdBQVcsS0FBSyxTQUFTLElBQUksQ0FBQyxJQUFJLENBQUMsR0FBRyxFQUFFO2dCQUM5QyxNQUFNLElBQUksS0FBSyxDQUFDLHlDQUF5QyxDQUFDLENBQUM7YUFDOUQ7WUFDRCxjQUFjLENBQUMsT0FBTyxDQUFDLEdBQUcsSUFBSSxFQUFFLEtBQUssQ0FBQztZQUN0QyxjQUFjLENBQUMsYUFBYSxDQUFDLEdBQUcsSUFBSSxFQUFFLFdBQVcsQ0FBQztZQUNsRCxjQUFjLENBQUMsd0JBQXdCLENBQUMsR0FBRyxJQUFJLEVBQUUsc0JBQXNCLENBQUM7WUFDeEUsY0FBYyxDQUFDLFNBQVMsQ0FBQyxHQUFHLElBQUksRUFBRSxPQUFPLENBQUM7WUFDMUMsY0FBYyxDQUFDLFlBQVksQ0FBQyxHQUFHLElBQUksRUFBRSxVQUFVLENBQUM7WUFDaEQsY0FBYyxDQUFDLHVCQUF1QixDQUFDLEdBQUcsSUFBSSxFQUFFLHFCQUFxQixDQUFDO1lBQ3RFLGNBQWMsQ0FBQyxlQUFlLENBQUMsR0FBRyxJQUFJLEVBQUUsYUFBYSxDQUFDO1lBQ3RELGNBQWMsQ0FBQyxpQkFBaUIsQ0FBQyxHQUFHLElBQUksRUFBRSxlQUFlLENBQUM7WUFDMUQsY0FBYyxDQUFDLHdCQUF3QixDQUFDLEdBQUcsSUFBSSxFQUFFLHNCQUFzQixDQUFDO1lBQ3hFLGNBQWMsQ0FBQyxTQUFTLENBQUMsR0FBRyxJQUFJLEVBQUUsT0FBTyxDQUFDO1lBQzFDLGNBQWMsQ0FBQyxhQUFhLENBQUMsR0FBRyxJQUFJLEVBQUUsV0FBVyxDQUFDO1lBQ2xELGNBQWMsQ0FBQyxhQUFhLENBQUMsR0FBRyxJQUFJLEVBQUUsV0FBVyxDQUFDO1lBQ2xELGNBQWMsQ0FBQyxRQUFRLENBQUMsR0FBRyxJQUFJLEVBQUUsTUFBTSxDQUFDO1lBQ3hDLGNBQWMsQ0FBQyxXQUFXLENBQUMsR0FBRyxJQUFJLEVBQUUsU0FBUyxDQUFDO1lBQzlDLGNBQWMsQ0FBQyxTQUFTLENBQUMsR0FBRyxJQUFJLEVBQUUsT0FBTyxDQUFDO1lBQzFDLGNBQWMsQ0FBQyxNQUFNLENBQUMsR0FBRyxJQUFJLEVBQUUsSUFBSSxDQUFDO1lBQ3BDLGNBQWMsQ0FBQyxXQUFXLENBQUMsR0FBRyxJQUFJLEVBQUUsU0FBUyxDQUFDO1lBQzlDLGNBQWMsQ0FBQyxtQkFBbUIsQ0FBQyxHQUFHLElBQUksRUFBRSxpQkFBaUIsQ0FBQztZQUM5RCxjQUFjLENBQUMsYUFBYSxDQUFDLEdBQUcsSUFBSSxFQUFFLFdBQVcsQ0FBQztZQUNsRCxjQUFjLENBQUMsWUFBWSxDQUFDLEdBQUcsSUFBSSxFQUFFLFVBQVUsQ0FBQztZQUNoRCxjQUFjLENBQUMsYUFBYSxDQUFDLEdBQUcsSUFBSSxFQUFFLFdBQVcsQ0FBQztZQUNsRCxjQUFjLENBQUMsYUFBYSxDQUFDLEdBQUcsSUFBSSxFQUFFLFdBQVcsQ0FBQztZQUNsRCxjQUFjLENBQUMsK0JBQStCLENBQUMsR0FBRyxJQUFJLEVBQUUsNkJBQTZCLENBQUM7WUFDdEYsY0FBYyxDQUFDLHNCQUFzQixDQUFDLEdBQUcsSUFBSSxFQUFFLG9CQUFvQixDQUFDO1lBQ3BFLGNBQWMsQ0FBQyxtQkFBbUIsQ0FBQyxHQUFHLElBQUksRUFBRSxpQkFBaUIsQ0FBQztZQUM5RCxjQUFjLENBQUMseUNBQXlDLENBQUMsR0FBRyxJQUFJLEVBQUUsdUNBQXVDLENBQUM7WUFDMUcsY0FBYyxDQUFDLE9BQU8sQ0FBQyxHQUFHLElBQUksRUFBRSxLQUFLLENBQUM7WUFDdEMsY0FBYyxDQUFDLGNBQWMsQ0FBQyxHQUFHLElBQUksRUFBRSxZQUFZLENBQUM7WUFDcEQsY0FBYyxDQUFDLGlCQUFpQixDQUFDLEdBQUcsU0FBUyxDQUFDLE9BQU8sQ0FBQztZQUN0RCxjQUFjLENBQUMsVUFBVSxDQUFDLEdBQUcsU0FBUyxDQUFDLE9BQU8sQ0FBQztZQUMvQyxjQUFjLENBQUMsTUFBTSxDQUFDLEdBQUcsU0FBUyxDQUFDLE9BQU8sQ0FBQztZQUMzQyxjQUFjLENBQUMsTUFBTSxDQUFDLEdBQUcsU0FBUyxDQUFDLE9BQU8sQ0FBQztTQUM5QzthQUFNO1lBQ0gsY0FBYyxDQUFDLGFBQWEsQ0FBQyxHQUFHLFNBQVMsQ0FBQyxPQUFPLENBQUM7WUFDbEQsY0FBYyxDQUFDLHdCQUF3QixDQUFDLEdBQUcsU0FBUyxDQUFDLE9BQU8sQ0FBQztZQUM3RCxjQUFjLENBQUMsU0FBUyxDQUFDLEdBQUcsU0FBUyxDQUFDLE9BQU8sQ0FBQztZQUM5QyxjQUFjLENBQUMsWUFBWSxDQUFDLEdBQUcsU0FBUyxDQUFDLE9BQU8sQ0FBQztZQUNqRCxjQUFjLENBQUMsdUJBQXVCLENBQUMsR0FBRyxTQUFTLENBQUMsT0FBTyxDQUFDO1lBQzVELGNBQWMsQ0FBQyxlQUFlLENBQUMsR0FBRyxTQUFTLENBQUMsT0FBTyxDQUFDO1lBQ3BELGNBQWMsQ0FBQyxpQkFBaUIsQ0FBQyxHQUFHLFNBQVMsQ0FBQyxPQUFPLENBQUM7WUFDdEQsY0FBYyxDQUFDLHdCQUF3QixDQUFDLEdBQUcsU0FBUyxDQUFDLE9BQU8sQ0FBQztZQUM3RCxjQUFjLENBQUMsaUJBQWlCLENBQUMsR0FBRyxTQUFTLENBQUMsT0FBTyxDQUFDO1lBQ3RELGNBQWMsQ0FBQyxTQUFTLENBQUMsR0FBRyxTQUFTLENBQUMsT0FBTyxDQUFDO1lBQzlDLGNBQWMsQ0FBQyxhQUFhLENBQUMsR0FBRyxTQUFTLENBQUMsT0FBTyxDQUFDO1lBQ2xELGNBQWMsQ0FBQyxhQUFhLENBQUMsR0FBRyxTQUFTLENBQUMsT0FBTyxDQUFDO1lBQ2xELGNBQWMsQ0FBQyxXQUFXLENBQUMsR0FBRyxTQUFTLENBQUMsT0FBTyxDQUFDO1lBQ2hELGNBQWMsQ0FBQyxVQUFVLENBQUMsR0FBRyxTQUFTLENBQUMsT0FBTyxDQUFDO1lBQy9DLGNBQWMsQ0FBQyxTQUFTLENBQUMsR0FBRyxTQUFTLENBQUMsT0FBTyxDQUFDO1lBQzlDLGNBQWMsQ0FBQyxNQUFNLENBQUMsR0FBRyxTQUFTLENBQUMsT0FBTyxDQUFDO1lBQzNDLGNBQWMsQ0FBQyxNQUFNLENBQUMsR0FBRyxTQUFTLENBQUMsT0FBTyxDQUFDO1lBQzNDLGNBQWMsQ0FBQyxXQUFXLENBQUMsR0FBRyxTQUFTLENBQUMsT0FBTyxDQUFDO1lBQ2hELGNBQWMsQ0FBQyxZQUFZLENBQUMsR0FBRyxTQUFTLENBQUMsT0FBTyxDQUFDO1lBQ2pELGNBQWMsQ0FBQyxhQUFhLENBQUMsR0FBRyxTQUFTLENBQUMsT0FBTyxDQUFDO1lBQ2xELGNBQWMsQ0FBQywrQkFBK0IsQ0FBQyxHQUFHLFNBQVMsQ0FBQyxPQUFPLENBQUM7WUFDcEUsY0FBYyxDQUFDLHNCQUFzQixDQUFDLEdBQUcsU0FBUyxDQUFDLE9BQU8sQ0FBQztZQUMzRCxjQUFjLENBQUMsbUJBQW1CLENBQUMsR0FBRyxTQUFTLENBQUMsT0FBTyxDQUFDO1lBQ3hELGNBQWMsQ0FBQyxNQUFNLENBQUMsR0FBRyxTQUFTLENBQUMsT0FBTyxDQUFDO1NBQzlDO1FBQ0QsSUFBSSxHQUFHLE1BQU0sQ0FBQyxZQUFZLENBQUMsU0FBUyxDQUFDLG9CQUFvQixFQUFFLEVBQUUsSUFBSSxDQUFDLENBQUM7UUFDbkUsTUFBTSxTQUFTLEdBQUcsRUFBRSxPQUFPLEVBQUUsQ0FBQyxFQUFFLElBQUksRUFBRSwwQ0FBMEMsRUFBRSxFQUFFLEVBQUUsSUFBSSxFQUFFLDBDQUEwQyxFQUFFLEVBQUUsRUFBRSxJQUFJLEVBQUUsMENBQTBDLEVBQUUsRUFBRSxFQUFFLElBQUksRUFBRSwwQ0FBMEMsRUFBRSxFQUFFLEVBQUUsSUFBSSxFQUFFLGlEQUFpRCxFQUFFLEVBQUUsRUFBRSxJQUFJLEVBQUUsMENBQTBDLEVBQUUsRUFBRSxFQUFFLElBQUksRUFBRSwwQ0FBMEMsRUFBRSxFQUFFLEVBQUUsSUFBSSxFQUFFLGlEQUFpRCxFQUFFLEVBQUUsRUFBRSxJQUFJLEVBQUUsaURBQWlELEVBQUUsRUFBRSxFQUFFLElBQUksRUFBRSwwQ0FBMEMsRUFBRSxFQUFFLEVBQUUsSUFBSSxFQUFFLGlEQUFpRCxFQUFFLEVBQUUsRUFBRSxJQUFJLEVBQUUsaURBQWlELEVBQUUsRUFBRSxFQUFFLElBQUksRUFBRSwwQ0FBMEMsRUFBRSxFQUFFLEVBQUUsSUFBSSxFQUFFLGlEQUFpRCxFQUFFLEVBQUUsRUFBRSxJQUFJLEVBQUUsaURBQWlELEVBQUUsRUFBRSxFQUFFLElBQUksRUFBRSwwQ0FBMEMsRUFBRSxFQUFFLEVBQUUsSUFBSSxFQUFFLGlEQUFpRCxFQUFFLEVBQUUsRUFBRSxJQUFJLEVBQUUsaURBQWlELEVBQUUsRUFBRSxFQUFFLElBQUksRUFBRSxpREFBaUQsRUFBRSxFQUFFLEVBQUUsSUFBSSxFQUFFLGlEQUFpRCxFQUFFLEVBQUUsRUFBRSxJQUFJLEVBQUUsMENBQTBDLEVBQUUsRUFBRSxFQUFFLElBQUksRUFBRSxpREFBaUQsRUFBRSxFQUFFLEVBQUUsSUFBSSxFQUFFLGlEQUFpRCxFQUFFLENBQUMsRUFBRSxDQUFDO1FBQ3IxQyxJQUFJLEdBQUcsTUFBTSxDQUFDLFlBQVksQ0FBQyxJQUFJLEVBQUUsU0FBUyxDQUFDLENBQUM7UUFDNUMsS0FBSyxDQUFDLEdBQUcsQ0FBQyxZQUFZLEVBQUUsSUFBSSxFQUFFLGNBQWMsRUFBRSxJQUFJLENBQUMsQ0FBQztJQUN4RCxDQUFDOztBQTlNTCxrQkErTUM7QUFsTUcsZ0JBQWdCO0FBQ08sZ0JBQVksR0FBRyxnQ0FBZ0MsQ0FBQyJ9