@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [;
exports.WorkspaceApi = 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-09-01-preview.
*
* Other available API versions: 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 WorkspaceApi extends pulumi.CustomResource {
/**
* Get an existing WorkspaceApi 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 WorkspaceApi(name, undefined, { ...opts, id: id });
}
/**
* Returns true if the given object is an instance of WorkspaceApi. 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'] === WorkspaceApi.__pulumiType;
}
/**
* Create a WorkspaceApi 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'");
}
if (args?.workspaceId === undefined && !opts.urn) {
throw new Error("Missing required property 'workspaceId'");
}
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["workspaceId"] = args?.workspaceId;
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/v20220901preview:WorkspaceApi" }, { type: "azure-native:apimanagement/v20230301preview:WorkspaceApi" }, { type: "azure-native:apimanagement/v20230501preview:WorkspaceApi" }, { type: "azure-native:apimanagement/v20230901preview:WorkspaceApi" }, { type: "azure-native:apimanagement/v20240501:WorkspaceApi" }, { type: "azure-native:apimanagement/v20240601preview:WorkspaceApi" }, { type: "azure-native:apimanagement/v20241001preview:WorkspaceApi" }] };
opts = pulumi.mergeOptions(opts, aliasOpts);
super(WorkspaceApi.__pulumiType, name, resourceInputs, opts);
}
}
exports.WorkspaceApi = WorkspaceApi;
/** @internal */
WorkspaceApi.__pulumiType = 'azure-native:apimanagement:WorkspaceApi';
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoid29ya3NwYWNlQXBpLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vYXBpbWFuYWdlbWVudC93b3Jrc3BhY2VBcGkudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLHNFQUFzRTtBQUN0RSxpRkFBaUY7OztBQUVqRix5Q0FBeUM7QUFJekMsMENBQTBDO0FBRTFDOzs7Ozs7R0FNRztBQUNILE1BQWEsWUFBYSxTQUFRLE1BQU0sQ0FBQyxjQUFjO0lBQ25EOzs7Ozs7O09BT0c7SUFDSSxNQUFNLENBQUMsR0FBRyxDQUFDLElBQVksRUFBRSxFQUEyQixFQUFFLElBQW1DO1FBQzVGLE9BQU8sSUFBSSxZQUFZLENBQUMsSUFBSSxFQUFFLFNBQWdCLEVBQUUsRUFBRSxHQUFHLElBQUksRUFBRSxFQUFFLEVBQUUsRUFBRSxFQUFFLENBQUMsQ0FBQztJQUN6RSxDQUFDO0lBS0Q7OztPQUdHO0lBQ0ksTUFBTSxDQUFDLFVBQVUsQ0FBQyxHQUFRO1FBQzdCLElBQUksR0FBRyxLQUFLLFNBQVMsSUFBSSxHQUFHLEtBQUssSUFBSSxFQUFFO1lBQ25DLE9BQU8sS0FBSyxDQUFDO1NBQ2hCO1FBQ0QsT0FBTyxHQUFHLENBQUMsY0FBYyxDQUFDLEtBQUssWUFBWSxDQUFDLFlBQVksQ0FBQztJQUM3RCxDQUFDO0lBbUdEOzs7Ozs7T0FNRztJQUNILFlBQVksSUFBWSxFQUFFLElBQXNCLEVBQUUsSUFBbUM7UUFDakYsSUFBSSxjQUFjLEdBQWtCLEVBQUUsQ0FBQztRQUN2QyxJQUFJLEdBQUcsSUFBSSxJQUFJLEVBQUUsQ0FBQztRQUNsQixJQUFJLENBQUMsSUFBSSxDQUFDLEVBQUUsRUFBRTtZQUNWLElBQUksSUFBSSxFQUFFLElBQUksS0FBSyxTQUFTLElBQUksQ0FBQyxJQUFJLENBQUMsR0FBRyxFQUFFO2dCQUN2QyxNQUFNLElBQUksS0FBSyxDQUFDLGtDQUFrQyxDQUFDLENBQUM7YUFDdkQ7WUFDRCxJQUFJLElBQUksRUFBRSxpQkFBaUIsS0FBSyxTQUFTLElBQUksQ0FBQyxJQUFJLENBQUMsR0FBRyxFQUFFO2dCQUNwRCxNQUFNLElBQUksS0FBSyxDQUFDLCtDQUErQyxDQUFDLENBQUM7YUFDcEU7WUFDRCxJQUFJLElBQUksRUFBRSxXQUFXLEtBQUssU0FBUyxJQUFJLENBQUMsSUFBSSxDQUFDLEdBQUcsRUFBRTtnQkFDOUMsTUFBTSxJQUFJLEtBQUssQ0FBQyx5Q0FBeUMsQ0FBQyxDQUFDO2FBQzlEO1lBQ0QsSUFBSSxJQUFJLEVBQUUsV0FBVyxLQUFLLFNBQVMsSUFBSSxDQUFDLElBQUksQ0FBQyxHQUFHLEVBQUU7Z0JBQzlDLE1BQU0sSUFBSSxLQUFLLENBQUMseUNBQXlDLENBQUMsQ0FBQzthQUM5RDtZQUNELGNBQWMsQ0FBQyxPQUFPLENBQUMsR0FBRyxJQUFJLEVBQUUsS0FBSyxDQUFDO1lBQ3RDLGNBQWMsQ0FBQyxhQUFhLENBQUMsR0FBRyxJQUFJLEVBQUUsV0FBVyxDQUFDO1lBQ2xELGNBQWMsQ0FBQyx3QkFBd0IsQ0FBQyxHQUFHLElBQUksRUFBRSxzQkFBc0IsQ0FBQztZQUN4RSxjQUFjLENBQUMsU0FBUyxDQUFDLEdBQUcsSUFBSSxFQUFFLE9BQU8sQ0FBQztZQUMxQyxjQUFjLENBQUMsWUFBWSxDQUFDLEdBQUcsSUFBSSxFQUFFLFVBQVUsQ0FBQztZQUNoRCxjQUFjLENBQUMsdUJBQXVCLENBQUMsR0FBRyxJQUFJLEVBQUUscUJBQXFCLENBQUM7WUFDdEUsY0FBYyxDQUFDLGVBQWUsQ0FBQyxHQUFHLElBQUksRUFBRSxhQUFhLENBQUM7WUFDdEQsY0FBYyxDQUFDLGlCQUFpQixDQUFDLEdBQUcsSUFBSSxFQUFFLGVBQWUsQ0FBQztZQUMxRCxjQUFjLENBQUMsd0JBQXdCLENBQUMsR0FBRyxJQUFJLEVBQUUsc0JBQXNCLENBQUM7WUFDeEUsY0FBYyxDQUFDLFNBQVMsQ0FBQyxHQUFHLElBQUksRUFBRSxPQUFPLENBQUM7WUFDMUMsY0FBYyxDQUFDLGFBQWEsQ0FBQyxHQUFHLElBQUksRUFBRSxXQUFXLENBQUM7WUFDbEQsY0FBYyxDQUFDLGFBQWEsQ0FBQyxHQUFHLElBQUksRUFBRSxXQUFXLENBQUM7WUFDbEQsY0FBYyxDQUFDLFFBQVEsQ0FBQyxHQUFHLElBQUksRUFBRSxNQUFNLENBQUM7WUFDeEMsY0FBYyxDQUFDLFdBQVcsQ0FBQyxHQUFHLElBQUksRUFBRSxTQUFTLENBQUM7WUFDOUMsY0FBYyxDQUFDLFNBQVMsQ0FBQyxHQUFHLElBQUksRUFBRSxPQUFPLENBQUM7WUFDMUMsY0FBYyxDQUFDLE1BQU0sQ0FBQyxHQUFHLElBQUksRUFBRSxJQUFJLENBQUM7WUFDcEMsY0FBYyxDQUFDLFdBQVcsQ0FBQyxHQUFHLElBQUksRUFBRSxTQUFTLENBQUM7WUFDOUMsY0FBYyxDQUFDLG1CQUFtQixDQUFDLEdBQUcsSUFBSSxFQUFFLGlCQUFpQixDQUFDO1lBQzlELGNBQWMsQ0FBQyxhQUFhLENBQUMsR0FBRyxJQUFJLEVBQUUsV0FBVyxDQUFDO1lBQ2xELGNBQWMsQ0FBQyxZQUFZLENBQUMsR0FBRyxJQUFJLEVBQUUsVUFBVSxDQUFDO1lBQ2hELGNBQWMsQ0FBQyxhQUFhLENBQUMsR0FBRyxJQUFJLEVBQUUsV0FBVyxDQUFDO1lBQ2xELGNBQWMsQ0FBQyxhQUFhLENBQUMsR0FBRyxJQUFJLEVBQUUsV0FBVyxDQUFDO1lBQ2xELGNBQWMsQ0FBQywrQkFBK0IsQ0FBQyxHQUFHLElBQUksRUFBRSw2QkFBNkIsQ0FBQztZQUN0RixjQUFjLENBQUMsc0JBQXNCLENBQUMsR0FBRyxJQUFJLEVBQUUsb0JBQW9CLENBQUM7WUFDcEUsY0FBYyxDQUFDLG1CQUFtQixDQUFDLEdBQUcsSUFBSSxFQUFFLGlCQUFpQixDQUFDO1lBQzlELGNBQWMsQ0FBQyx5Q0FBeUMsQ0FBQyxHQUFHLElBQUksRUFBRSx1Q0FBdUMsQ0FBQztZQUMxRyxjQUFjLENBQUMsT0FBTyxDQUFDLEdBQUcsSUFBSSxFQUFFLEtBQUssQ0FBQztZQUN0QyxjQUFjLENBQUMsYUFBYSxDQUFDLEdBQUcsSUFBSSxFQUFFLFdBQVcsQ0FBQztZQUNsRCxjQUFjLENBQUMsY0FBYyxDQUFDLEdBQUcsSUFBSSxFQUFFLFlBQVksQ0FBQztZQUNwRCxjQUFjLENBQUMsaUJBQWlCLENBQUMsR0FBRyxTQUFTLENBQUMsT0FBTyxDQUFDO1lBQ3RELGNBQWMsQ0FBQyxVQUFVLENBQUMsR0FBRyxTQUFTLENBQUMsT0FBTyxDQUFDO1lBQy9DLGNBQWMsQ0FBQyxNQUFNLENBQUMsR0FBRyxTQUFTLENBQUMsT0FBTyxDQUFDO1lBQzNDLGNBQWMsQ0FBQyxNQUFNLENBQUMsR0FBRyxTQUFTLENBQUMsT0FBTyxDQUFDO1NBQzlDO2FBQU07WUFDSCxjQUFjLENBQUMsYUFBYSxDQUFDLEdBQUcsU0FBUyxDQUFDLE9BQU8sQ0FBQztZQUNsRCxjQUFjLENBQUMsd0JBQXdCLENBQUMsR0FBRyxTQUFTLENBQUMsT0FBTyxDQUFDO1lBQzdELGNBQWMsQ0FBQyxTQUFTLENBQUMsR0FBRyxTQUFTLENBQUMsT0FBTyxDQUFDO1lBQzlDLGNBQWMsQ0FBQyxZQUFZLENBQUMsR0FBRyxTQUFTLENBQUMsT0FBTyxDQUFDO1lBQ2pELGNBQWMsQ0FBQyx1QkFBdUIsQ0FBQyxHQUFHLFNBQVMsQ0FBQyxPQUFPLENBQUM7WUFDNUQsY0FBYyxDQUFDLGVBQWUsQ0FBQyxHQUFHLFNBQVMsQ0FBQyxPQUFPLENBQUM7WUFDcEQsY0FBYyxDQUFDLGlCQUFpQixDQUFDLEdBQUcsU0FBUyxDQUFDLE9BQU8sQ0FBQztZQUN0RCxjQUFjLENBQUMsd0JBQXdCLENBQUMsR0FBRyxTQUFTLENBQUMsT0FBTyxDQUFDO1lBQzdELGNBQWMsQ0FBQyxpQkFBaUIsQ0FBQyxHQUFHLFNBQVMsQ0FBQyxPQUFPLENBQUM7WUFDdEQsY0FBYyxDQUFDLFNBQVMsQ0FBQyxHQUFHLFNBQVMsQ0FBQyxPQUFPLENBQUM7WUFDOUMsY0FBYyxDQUFDLGFBQWEsQ0FBQyxHQUFHLFNBQVMsQ0FBQyxPQUFPLENBQUM7WUFDbEQsY0FBYyxDQUFDLGFBQWEsQ0FBQyxHQUFHLFNBQVMsQ0FBQyxPQUFPLENBQUM7WUFDbEQsY0FBYyxDQUFDLFdBQVcsQ0FBQyxHQUFHLFNBQVMsQ0FBQyxPQUFPLENBQUM7WUFDaEQsY0FBYyxDQUFDLFVBQVUsQ0FBQyxHQUFHLFNBQVMsQ0FBQyxPQUFPLENBQUM7WUFDL0MsY0FBYyxDQUFDLFNBQVMsQ0FBQyxHQUFHLFNBQVMsQ0FBQyxPQUFPLENBQUM7WUFDOUMsY0FBYyxDQUFDLE1BQU0sQ0FBQyxHQUFHLFNBQVMsQ0FBQyxPQUFPLENBQUM7WUFDM0MsY0FBYyxDQUFDLE1BQU0sQ0FBQyxHQUFHLFNBQVMsQ0FBQyxPQUFPLENBQUM7WUFDM0MsY0FBYyxDQUFDLFdBQVcsQ0FBQyxHQUFHLFNBQVMsQ0FBQyxPQUFPLENBQUM7WUFDaEQsY0FBYyxDQUFDLFlBQVksQ0FBQyxHQUFHLFNBQVMsQ0FBQyxPQUFPLENBQUM7WUFDakQsY0FBYyxDQUFDLGFBQWEsQ0FBQyxHQUFHLFNBQVMsQ0FBQyxPQUFPLENBQUM7WUFDbEQsY0FBYyxDQUFDLCtCQUErQixDQUFDLEdBQUcsU0FBUyxDQUFDLE9BQU8sQ0FBQztZQUNwRSxjQUFjLENBQUMsc0JBQXNCLENBQUMsR0FBRyxTQUFTLENBQUMsT0FBTyxDQUFDO1lBQzNELGNBQWMsQ0FBQyxtQkFBbUIsQ0FBQyxHQUFHLFNBQVMsQ0FBQyxPQUFPLENBQUM7WUFDeEQsY0FBYyxDQUFDLE1BQU0sQ0FBQyxHQUFHLFNBQVMsQ0FBQyxPQUFPLENBQUM7U0FDOUM7UUFDRCxJQUFJLEdBQUcsTUFBTSxDQUFDLFlBQVksQ0FBQyxTQUFTLENBQUMsb0JBQW9CLEVBQUUsRUFBRSxJQUFJLENBQUMsQ0FBQztRQUNuRSxNQUFNLFNBQVMsR0FBRyxFQUFFLE9BQU8sRUFBRSxDQUFDLEVBQUUsSUFBSSxFQUFFLDBEQUEwRCxFQUFFLEVBQUUsRUFBRSxJQUFJLEVBQUUsMERBQTBELEVBQUUsRUFBRSxFQUFFLElBQUksRUFBRSwwREFBMEQsRUFBRSxFQUFFLEVBQUUsSUFBSSxFQUFFLDBEQUEwRCxFQUFFLEVBQUUsRUFBRSxJQUFJLEVBQUUsbURBQW1ELEVBQUUsRUFBRSxFQUFFLElBQUksRUFBRSwwREFBMEQsRUFBRSxFQUFFLEVBQUUsSUFBSSxFQUFFLDBEQUEwRCxFQUFFLENBQUMsRUFBRSxDQUFDO1FBQ25nQixJQUFJLEdBQUcsTUFBTSxDQUFDLFlBQVksQ0FBQyxJQUFJLEVBQUUsU0FBUyxDQUFDLENBQUM7UUFDNUMsS0FBSyxDQUFDLFlBQVksQ0FBQyxZQUFZLEVBQUUsSUFBSSxFQUFFLGNBQWMsRUFBRSxJQUFJLENBQUMsQ0FBQztJQUNqRSxDQUFDOztBQWxOTCxvQ0FtTkM7QUF0TUcsZ0JBQWdCO0FBQ08seUJBQVksR0FBRyx5Q0FBeUMsQ0FBQyJ9