import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * Manages an API Management Workspace Named Value. * * ## 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: "My Company", * publisherEmail: "company@terraform.io", * skuName: "Premium_1", * }); * const exampleWorkspace = new azure.apimanagement.Workspace("example", { * name: "example-workspace", * apiManagementId: exampleService.id, * displayName: "ExampleWorkspace", * }); * const exampleWorkspaceNamedValue = new azure.apimanagement.WorkspaceNamedValue("example", { * name: "example-named-value", * apiManagementWorkspaceId: exampleWorkspace.id, * displayName: "ExampleProperty", * value: "Example Value", * tags: [ * "tag1", * "tag2", * "tag3", * ], * }); * ``` * * ## API Providers * * * This resource uses the following Azure API Providers: * * * `Microsoft.ApiManagement` - 2024-05-01 * * ## Import * * API Management Workspace Named Values can be imported using the `resource id`, e.g. * * ```sh * $ pulumi import azure:apimanagement/workspaceNamedValue:WorkspaceNamedValue example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.ApiManagement/service/service1/workspaces/workspace1/namedValues/namedValue1 * ``` */ export declare class WorkspaceNamedValue extends pulumi.CustomResource { /** * Get an existing WorkspaceNamedValue 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?: WorkspaceNamedValueState, opts?: pulumi.CustomResourceOptions): WorkspaceNamedValue; /** * Returns true if the given object is an instance of WorkspaceNamedValue. 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 WorkspaceNamedValue; /** * The ID of the API Management Workspace. Changing this forces a new resource to be created. */ readonly apiManagementWorkspaceId: pulumi.Output; /** * The display name of this API Management Workspace Named Value. */ readonly displayName: pulumi.Output; /** * The name of the API Management Workspace Named Value. Changing this forces a new resource to be created. */ readonly name: pulumi.Output; /** * Specifies whether the API Management Workspace Named Value is secret. Defaults to `false`. * * > **Note:** Setting the field `secret` to `true` does not make this field sensitive in Terraform, instead it marks the value as secret and encrypts the value in Azure. */ readonly secret: pulumi.Output; /** * A list of tags to be applied to the API Management Workspace Named Value. */ readonly tags: pulumi.Output; /** * The value of this API Management Workspace Named Value. * * > **Note:** Exactly one of `value` or `valueFromKeyVault` must be specified. */ readonly value: pulumi.Output; /** * A `valueFromKeyVault` block as defined below. * * > **Note:** Exactly one of `value` or `valueFromKeyVault` must be specified. If `valueFromKeyVault` is specified, `secret` must also be set to `true`. */ readonly valueFromKeyVault: pulumi.Output; /** * Create a WorkspaceNamedValue 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: WorkspaceNamedValueArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering WorkspaceNamedValue resources. */ export interface WorkspaceNamedValueState { /** * The ID of the API Management Workspace. Changing this forces a new resource to be created. */ apiManagementWorkspaceId?: pulumi.Input; /** * The display name of this API Management Workspace Named Value. */ displayName?: pulumi.Input; /** * The name of the API Management Workspace Named Value. Changing this forces a new resource to be created. */ name?: pulumi.Input; /** * Specifies whether the API Management Workspace Named Value is secret. Defaults to `false`. * * > **Note:** Setting the field `secret` to `true` does not make this field sensitive in Terraform, instead it marks the value as secret and encrypts the value in Azure. */ secret?: pulumi.Input; /** * A list of tags to be applied to the API Management Workspace Named Value. */ tags?: pulumi.Input[]>; /** * The value of this API Management Workspace Named Value. * * > **Note:** Exactly one of `value` or `valueFromKeyVault` must be specified. */ value?: pulumi.Input; /** * A `valueFromKeyVault` block as defined below. * * > **Note:** Exactly one of `value` or `valueFromKeyVault` must be specified. If `valueFromKeyVault` is specified, `secret` must also be set to `true`. */ valueFromKeyVault?: pulumi.Input; } /** * The set of arguments for constructing a WorkspaceNamedValue resource. */ export interface WorkspaceNamedValueArgs { /** * The ID of the API Management Workspace. Changing this forces a new resource to be created. */ apiManagementWorkspaceId: pulumi.Input; /** * The display name of this API Management Workspace Named Value. */ displayName: pulumi.Input; /** * The name of the API Management Workspace Named Value. Changing this forces a new resource to be created. */ name?: pulumi.Input; /** * Specifies whether the API Management Workspace Named Value is secret. Defaults to `false`. * * > **Note:** Setting the field `secret` to `true` does not make this field sensitive in Terraform, instead it marks the value as secret and encrypts the value in Azure. */ secret?: pulumi.Input; /** * A list of tags to be applied to the API Management Workspace Named Value. */ tags?: pulumi.Input[]>; /** * The value of this API Management Workspace Named Value. * * > **Note:** Exactly one of `value` or `valueFromKeyVault` must be specified. */ value?: pulumi.Input; /** * A `valueFromKeyVault` block as defined below. * * > **Note:** Exactly one of `value` or `valueFromKeyVault` must be specified. If `valueFromKeyVault` is specified, `secret` must also be set to `true`. */ valueFromKeyVault?: pulumi.Input; }