import * as pulumi from "@pulumi/pulumi"; /** * Manages an API Management Workspace. * * > **Note:** This resource is currently available only when using the Classic Premium SKU of `azure.apimanagement.Service`. For more details, refer to [Federated API Management with Workspaces](https://learn.microsoft.com/en-us/azure/api-management/workspaces-overview). * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as azure from "@pulumi/azure"; * * const example = new azure.core.ResourceGroup("example", { * name: "example-resources", * location: "West Europe", * }); * const exampleService = new azure.apimanagement.Service("example", { * name: "example-apimanagement", * location: example.location, * resourceGroupName: example.name, * publisherName: "pub1", * publisherEmail: "pub1@email.com", * skuName: "Premium_1", * }); * const exampleWorkspace = new azure.apimanagement.Workspace("example", { * name: "example-workspace", * apiManagementId: exampleService.id, * displayName: "my workspace", * }); * ``` * * ## API Providers * * * This resource uses the following Azure API Providers: * * * `Microsoft.ApiManagement` - 2024-05-01 * * ## Import * * API Management Workspace can be imported using the `resource id`, e.g. * * ```sh * $ pulumi import azure:apimanagement/workspace:Workspace example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.ApiManagement/service/service1/workspaces/workspace1 * ``` */ export declare class Workspace extends pulumi.CustomResource { /** * Get an existing Workspace 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 state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: WorkspaceState, opts?: pulumi.CustomResourceOptions): Workspace; /** * Returns true if the given object is an instance of Workspace. 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 Workspace; /** * Specifies the ID of the API Management Service in which the API Management Workspace should be created. Changing this forces a new resource to be created. */ readonly apiManagementId: pulumi.Output; /** * The description of the API Management Workspace. */ readonly description: pulumi.Output; /** * The display name of the API Management Workspace. */ readonly displayName: pulumi.Output; /** * Specifies the name which should be used for this API Management Workspace. Changing this forces a new resource to be created. */ readonly name: pulumi.Output; /** * Create a Workspace 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: WorkspaceArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Workspace resources. */ export interface WorkspaceState { /** * Specifies the ID of the API Management Service in which the API Management Workspace should be created. Changing this forces a new resource to be created. */ apiManagementId?: pulumi.Input; /** * The description of the API Management Workspace. */ description?: pulumi.Input; /** * The display name of the API Management Workspace. */ displayName?: pulumi.Input; /** * Specifies the name which should be used for this API Management Workspace. Changing this forces a new resource to be created. */ name?: pulumi.Input; } /** * The set of arguments for constructing a Workspace resource. */ export interface WorkspaceArgs { /** * Specifies the ID of the API Management Service in which the API Management Workspace should be created. Changing this forces a new resource to be created. */ apiManagementId: pulumi.Input; /** * The description of the API Management Workspace. */ description?: pulumi.Input; /** * The display name of the API Management Workspace. */ displayName: pulumi.Input; /** * Specifies the name which should be used for this API Management Workspace. Changing this forces a new resource to be created. */ name?: pulumi.Input; }