1. Packages
  2. Azure Native
  3. API Docs
  4. apimanagement
  5. Workspace
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.37.0 published on Monday, Apr 15, 2024 by Pulumi

azure-native.apimanagement.Workspace

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.37.0 published on Monday, Apr 15, 2024 by Pulumi

    Workspace details. Azure REST API version: 2022-09-01-preview.

    Other available API versions: 2023-03-01-preview, 2023-05-01-preview.

    Example Usage

    ApiManagementCreateWorkspace

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var workspace = new AzureNative.ApiManagement.Workspace("workspace", new()
        {
            Description = "workspace 1",
            DisplayName = "my workspace",
            ResourceGroupName = "rg1",
            ServiceName = "apimService1",
            WorkspaceId = "wks1",
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure-native-sdk/apimanagement/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := apimanagement.NewWorkspace(ctx, "workspace", &apimanagement.WorkspaceArgs{
    			Description:       pulumi.String("workspace 1"),
    			DisplayName:       pulumi.String("my workspace"),
    			ResourceGroupName: pulumi.String("rg1"),
    			ServiceName:       pulumi.String("apimService1"),
    			WorkspaceId:       pulumi.String("wks1"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azurenative.apimanagement.Workspace;
    import com.pulumi.azurenative.apimanagement.WorkspaceArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var workspace = new Workspace("workspace", WorkspaceArgs.builder()        
                .description("workspace 1")
                .displayName("my workspace")
                .resourceGroupName("rg1")
                .serviceName("apimService1")
                .workspaceId("wks1")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    workspace = azure_native.apimanagement.Workspace("workspace",
        description="workspace 1",
        display_name="my workspace",
        resource_group_name="rg1",
        service_name="apimService1",
        workspace_id="wks1")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const workspace = new azure_native.apimanagement.Workspace("workspace", {
        description: "workspace 1",
        displayName: "my workspace",
        resourceGroupName: "rg1",
        serviceName: "apimService1",
        workspaceId: "wks1",
    });
    
    resources:
      workspace:
        type: azure-native:apimanagement:Workspace
        properties:
          description: workspace 1
          displayName: my workspace
          resourceGroupName: rg1
          serviceName: apimService1
          workspaceId: wks1
    

    Create Workspace Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Workspace(name: string, args: WorkspaceArgs, opts?: CustomResourceOptions);
    @overload
    def Workspace(resource_name: str,
                  args: WorkspaceArgs,
                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def Workspace(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  display_name: Optional[str] = None,
                  resource_group_name: Optional[str] = None,
                  service_name: Optional[str] = None,
                  description: Optional[str] = None,
                  workspace_id: Optional[str] = None)
    func NewWorkspace(ctx *Context, name string, args WorkspaceArgs, opts ...ResourceOption) (*Workspace, error)
    public Workspace(string name, WorkspaceArgs args, CustomResourceOptions? opts = null)
    public Workspace(String name, WorkspaceArgs args)
    public Workspace(String name, WorkspaceArgs args, CustomResourceOptions options)
    
    type: azure-native:apimanagement:Workspace
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args WorkspaceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args WorkspaceArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args WorkspaceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkspaceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WorkspaceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var azure_nativeWorkspaceResource = new AzureNative.ApiManagement.Workspace("azure-nativeWorkspaceResource", new()
    {
        DisplayName = "string",
        ResourceGroupName = "string",
        ServiceName = "string",
        Description = "string",
        WorkspaceId = "string",
    });
    
    example, err := apimanagement.NewWorkspace(ctx, "azure-nativeWorkspaceResource", &apimanagement.WorkspaceArgs{
    DisplayName: pulumi.String("string"),
    ResourceGroupName: pulumi.String("string"),
    ServiceName: pulumi.String("string"),
    Description: pulumi.String("string"),
    WorkspaceId: pulumi.String("string"),
    })
    
    var azure_nativeWorkspaceResource = new Workspace("azure-nativeWorkspaceResource", WorkspaceArgs.builder()        
        .displayName("string")
        .resourceGroupName("string")
        .serviceName("string")
        .description("string")
        .workspaceId("string")
        .build());
    
    azure_native_workspace_resource = azure_native.apimanagement.Workspace("azure-nativeWorkspaceResource",
        display_name="string",
        resource_group_name="string",
        service_name="string",
        description="string",
        workspace_id="string")
    
    const azure_nativeWorkspaceResource = new azure_native.apimanagement.Workspace("azure-nativeWorkspaceResource", {
        displayName: "string",
        resourceGroupName: "string",
        serviceName: "string",
        description: "string",
        workspaceId: "string",
    });
    
    type: azure-native:apimanagement:Workspace
    properties:
        description: string
        displayName: string
        resourceGroupName: string
        serviceName: string
        workspaceId: string
    

    Workspace Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Workspace resource accepts the following input properties:

    DisplayName string
    Name of the workspace.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ServiceName string
    The name of the API Management service.
    Description string
    Description of the workspace.
    WorkspaceId string
    Workspace identifier. Must be unique in the current API Management service instance.
    DisplayName string
    Name of the workspace.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ServiceName string
    The name of the API Management service.
    Description string
    Description of the workspace.
    WorkspaceId string
    Workspace identifier. Must be unique in the current API Management service instance.
    displayName String
    Name of the workspace.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    serviceName String
    The name of the API Management service.
    description String
    Description of the workspace.
    workspaceId String
    Workspace identifier. Must be unique in the current API Management service instance.
    displayName string
    Name of the workspace.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    serviceName string
    The name of the API Management service.
    description string
    Description of the workspace.
    workspaceId string
    Workspace identifier. Must be unique in the current API Management service instance.
    display_name str
    Name of the workspace.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    service_name str
    The name of the API Management service.
    description str
    Description of the workspace.
    workspace_id str
    Workspace identifier. Must be unique in the current API Management service instance.
    displayName String
    Name of the workspace.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    serviceName String
    The name of the API Management service.
    description String
    Description of the workspace.
    workspaceId String
    Workspace identifier. Must be unique in the current API Management service instance.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Workspace resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the resource
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The name of the resource
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:apimanagement:Workspace wks1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId} 
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.37.0 published on Monday, Apr 15, 2024 by Pulumi