import * as pulumi from "@pulumi/pulumi"; /** * Manages an API Version Set within an API Management Workspace. * * ## 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-apim", * location: example.location, * resourceGroupName: example.name, * publisherName: "Example Publisher", * publisherEmail: "publisher@example.com", * skuName: "Premium_1", * }); * const exampleWorkspace = new azure.apimanagement.Workspace("example", { * name: "example-workspace", * apiManagementId: exampleService.id, * displayName: "Example Workspace", * description: "Example workspace for development", * }); * const exampleWorkspaceApiVersionSet = new azure.apimanagement.WorkspaceApiVersionSet("example", { * name: "example-version-set", * apiManagementWorkspaceId: exampleWorkspace.id, * displayName: "Example API Version Set", * versioningScheme: "Segment", * }); * ``` * * ## API Providers * * * This resource uses the following Azure API Providers: * * * `Microsoft.ApiManagement` - 2024-05-01 * * ## Import * * API Management Workspace API Version Sets can be imported using the `resource id`, e.g. * * ```sh * $ pulumi import azure:apimanagement/workspaceApiVersionSet:WorkspaceApiVersionSet example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.ApiManagement/service/service1/workspaces/workspace1/apiVersionSets/set1 * ``` */ export declare class WorkspaceApiVersionSet extends pulumi.CustomResource { /** * Get an existing WorkspaceApiVersionSet 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?: WorkspaceApiVersionSetState, opts?: pulumi.CustomResourceOptions): WorkspaceApiVersionSet; /** * Returns true if the given object is an instance of WorkspaceApiVersionSet. 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 WorkspaceApiVersionSet; /** * Specifies the ID of the API Management Workspace. Changing this forces a new resource to be created. */ readonly apiManagementWorkspaceId: pulumi.Output; /** * Specifies the description of the API Management Workspace API Version Set. */ readonly description: pulumi.Output; /** * Specifies the display name of the API Management Workspace API Version Set. */ readonly displayName: pulumi.Output; /** * Specifies the name of the API Management Workspace API Version Set. Changing this forces a new resource to be created. */ readonly name: pulumi.Output; /** * Specifies the name of the header to read from inbound requests to determine the API version. */ readonly versionHeaderName: pulumi.Output; /** * Specifies the name of the query string parameter to read from inbound requests to determine the API version. */ readonly versionQueryName: pulumi.Output; /** * Specifies where in a request that the API Version should be read from. Possible values are `Header`, `Query` and `Segment`. */ readonly versioningScheme: pulumi.Output; /** * Create a WorkspaceApiVersionSet 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: WorkspaceApiVersionSetArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering WorkspaceApiVersionSet resources. */ export interface WorkspaceApiVersionSetState { /** * Specifies the ID of the API Management Workspace. Changing this forces a new resource to be created. */ apiManagementWorkspaceId?: pulumi.Input; /** * Specifies the description of the API Management Workspace API Version Set. */ description?: pulumi.Input; /** * Specifies the display name of the API Management Workspace API Version Set. */ displayName?: pulumi.Input; /** * Specifies the name of the API Management Workspace API Version Set. Changing this forces a new resource to be created. */ name?: pulumi.Input; /** * Specifies the name of the header to read from inbound requests to determine the API version. */ versionHeaderName?: pulumi.Input; /** * Specifies the name of the query string parameter to read from inbound requests to determine the API version. */ versionQueryName?: pulumi.Input; /** * Specifies where in a request that the API Version should be read from. Possible values are `Header`, `Query` and `Segment`. */ versioningScheme?: pulumi.Input; } /** * The set of arguments for constructing a WorkspaceApiVersionSet resource. */ export interface WorkspaceApiVersionSetArgs { /** * Specifies the ID of the API Management Workspace. Changing this forces a new resource to be created. */ apiManagementWorkspaceId: pulumi.Input; /** * Specifies the description of the API Management Workspace API Version Set. */ description?: pulumi.Input; /** * Specifies the display name of the API Management Workspace API Version Set. */ displayName: pulumi.Input; /** * Specifies the name of the API Management Workspace API Version Set. Changing this forces a new resource to be created. */ name?: pulumi.Input; /** * Specifies the name of the header to read from inbound requests to determine the API version. */ versionHeaderName?: pulumi.Input; /** * Specifies the name of the query string parameter to read from inbound requests to determine the API version. */ versionQueryName?: pulumi.Input; /** * Specifies where in a request that the API Version should be read from. Possible values are `Header`, `Query` and `Segment`. */ versioningScheme: pulumi.Input; }