Azure Native

Pulumi Official
Package maintained by Pulumi
v1.68.2 published on Tuesday, Aug 16, 2022 by Pulumi

getWorkspace

Represents a Workspace definition. API Version: 2021-02-01-preview.

Using getWorkspace

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getWorkspace(args: GetWorkspaceArgs, opts?: InvokeOptions): Promise<GetWorkspaceResult>
function getWorkspaceOutput(args: GetWorkspaceOutputArgs, opts?: InvokeOptions): Output<GetWorkspaceResult>
def get_workspace(resource_group_name: Optional[str] = None,
                  workspace_name: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetWorkspaceResult
def get_workspace_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                  workspace_name: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetWorkspaceResult]
func LookupWorkspace(ctx *Context, args *LookupWorkspaceArgs, opts ...InvokeOption) (*LookupWorkspaceResult, error)
func LookupWorkspaceOutput(ctx *Context, args *LookupWorkspaceOutputArgs, opts ...InvokeOption) LookupWorkspaceResultOutput

> Note: This function is named LookupWorkspace in the Go SDK.

public static class GetWorkspace 
{
    public static Task<GetWorkspaceResult> InvokeAsync(GetWorkspaceArgs args, InvokeOptions? opts = null)
    public static Output<GetWorkspaceResult> Invoke(GetWorkspaceInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetWorkspaceResult> getWorkspace(GetWorkspaceArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: azure-native:desktopvirtualization:getWorkspace
  Arguments:
    # Arguments dictionary

The following arguments are supported:

ResourceGroupName string

The name of the resource group. The name is case insensitive.

WorkspaceName string

The name of the workspace

ResourceGroupName string

The name of the resource group. The name is case insensitive.

WorkspaceName string

The name of the workspace

resourceGroupName String

The name of the resource group. The name is case insensitive.

workspaceName String

The name of the workspace

resourceGroupName string

The name of the resource group. The name is case insensitive.

workspaceName string

The name of the workspace

resource_group_name str

The name of the resource group. The name is case insensitive.

workspace_name str

The name of the workspace

resourceGroupName String

The name of the resource group. The name is case insensitive.

workspaceName String

The name of the workspace

getWorkspace Result

The following output properties are available:

CloudPcResource bool

Is cloud pc resource.

Etag string

The etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.

Id string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

Name string

The name of the resource

ObjectId string

ObjectId of Workspace. (internal use)

Type string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

ApplicationGroupReferences List<string>

List of applicationGroup resource Ids.

Description string

Description of Workspace.

FriendlyName string

Friendly name of Workspace.

Identity Pulumi.AzureNative.DesktopVirtualization.Outputs.ResourceModelWithAllowedPropertySetResponseIdentity
Kind string

Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.

Location string

The geo-location where the resource lives

ManagedBy string

The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.

Plan Pulumi.AzureNative.DesktopVirtualization.Outputs.ResourceModelWithAllowedPropertySetResponsePlan
Sku Pulumi.AzureNative.DesktopVirtualization.Outputs.ResourceModelWithAllowedPropertySetResponseSku
Tags Dictionary<string, string>

Resource tags.

CloudPcResource bool

Is cloud pc resource.

Etag string

The etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.

Id string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

Name string

The name of the resource

ObjectId string

ObjectId of Workspace. (internal use)

Type string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

ApplicationGroupReferences []string

List of applicationGroup resource Ids.

Description string

Description of Workspace.

FriendlyName string

Friendly name of Workspace.

Identity ResourceModelWithAllowedPropertySetResponseIdentity
Kind string

Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.

Location string

The geo-location where the resource lives

ManagedBy string

The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.

Plan ResourceModelWithAllowedPropertySetResponsePlan
Sku ResourceModelWithAllowedPropertySetResponseSku
Tags map[string]string

Resource tags.

cloudPcResource Boolean

Is cloud pc resource.

etag String

The etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.

id String

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name String

The name of the resource

objectId String

ObjectId of Workspace. (internal use)

type String

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

applicationGroupReferences List<String>

List of applicationGroup resource Ids.

description String

Description of Workspace.

friendlyName String

Friendly name of Workspace.

identity ResourceModelWithAllowedPropertySetResponseIdentity
kind String

Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.

location String

The geo-location where the resource lives

managedBy String

The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.

plan ResourceModelWithAllowedPropertySetResponsePlan
sku ResourceModelWithAllowedPropertySetResponseSku
tags Map<String,String>

Resource tags.

cloudPcResource boolean

Is cloud pc resource.

etag string

The etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.

id string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name string

The name of the resource

objectId string

ObjectId of Workspace. (internal use)

type string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

applicationGroupReferences string[]

List of applicationGroup resource Ids.

description string

Description of Workspace.

friendlyName string

Friendly name of Workspace.

identity ResourceModelWithAllowedPropertySetResponseIdentity
kind string

Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.

location string

The geo-location where the resource lives

managedBy string

The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.

plan ResourceModelWithAllowedPropertySetResponsePlan
sku ResourceModelWithAllowedPropertySetResponseSku
tags {[key: string]: string}

Resource tags.

cloud_pc_resource bool

Is cloud pc resource.

etag str

The etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.

id str

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name str

The name of the resource

object_id str

ObjectId of Workspace. (internal use)

type str

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

application_group_references Sequence[str]

List of applicationGroup resource Ids.

description str

Description of Workspace.

friendly_name str

Friendly name of Workspace.

identity ResourceModelWithAllowedPropertySetResponseIdentity
kind str

Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.

location str

The geo-location where the resource lives

managed_by str

The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.

plan ResourceModelWithAllowedPropertySetResponsePlan
sku ResourceModelWithAllowedPropertySetResponseSku
tags Mapping[str, str]

Resource tags.

cloudPcResource Boolean

Is cloud pc resource.

etag String

The etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.

id String

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name String

The name of the resource

objectId String

ObjectId of Workspace. (internal use)

type String

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

applicationGroupReferences List<String>

List of applicationGroup resource Ids.

description String

Description of Workspace.

friendlyName String

Friendly name of Workspace.

identity Property Map
kind String

Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.

location String

The geo-location where the resource lives

managedBy String

The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.

plan Property Map
sku Property Map
tags Map<String>

Resource tags.

Supporting Types

ResourceModelWithAllowedPropertySetResponseIdentity

PrincipalId string

The principal ID of resource identity.

TenantId string

The tenant ID of resource.

Type string

The identity type.

PrincipalId string

The principal ID of resource identity.

TenantId string

The tenant ID of resource.

Type string

The identity type.

principalId String

The principal ID of resource identity.

tenantId String

The tenant ID of resource.

type String

The identity type.

principalId string

The principal ID of resource identity.

tenantId string

The tenant ID of resource.

type string

The identity type.

principal_id str

The principal ID of resource identity.

tenant_id str

The tenant ID of resource.

type str

The identity type.

principalId String

The principal ID of resource identity.

tenantId String

The tenant ID of resource.

type String

The identity type.

ResourceModelWithAllowedPropertySetResponsePlan

Name string

A user defined name of the 3rd Party Artifact that is being procured.

Product string

The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding.

Publisher string

The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic

PromotionCode string

A publisher provided promotion code as provisioned in Data Market for the said product/artifact.

Version string

The version of the desired product/artifact.

Name string

A user defined name of the 3rd Party Artifact that is being procured.

Product string

The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding.

Publisher string

The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic

PromotionCode string

A publisher provided promotion code as provisioned in Data Market for the said product/artifact.

Version string

The version of the desired product/artifact.

name String

A user defined name of the 3rd Party Artifact that is being procured.

product String

The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding.

publisher String

The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic

promotionCode String

A publisher provided promotion code as provisioned in Data Market for the said product/artifact.

version String

The version of the desired product/artifact.

name string

A user defined name of the 3rd Party Artifact that is being procured.

product string

The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding.

publisher string

The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic

promotionCode string

A publisher provided promotion code as provisioned in Data Market for the said product/artifact.

version string

The version of the desired product/artifact.

name str

A user defined name of the 3rd Party Artifact that is being procured.

product str

The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding.

publisher str

The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic

promotion_code str

A publisher provided promotion code as provisioned in Data Market for the said product/artifact.

version str

The version of the desired product/artifact.

name String

A user defined name of the 3rd Party Artifact that is being procured.

product String

The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding.

publisher String

The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic

promotionCode String

A publisher provided promotion code as provisioned in Data Market for the said product/artifact.

version String

The version of the desired product/artifact.

ResourceModelWithAllowedPropertySetResponseSku

Name string

The name of the SKU. Ex - P3. It is typically a letter+number code

Capacity int

If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.

Family string

If the service has different generations of hardware, for the same SKU, then that can be captured here.

Size string

The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.

Tier string

This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.

Name string

The name of the SKU. Ex - P3. It is typically a letter+number code

Capacity int

If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.

Family string

If the service has different generations of hardware, for the same SKU, then that can be captured here.

Size string

The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.

Tier string

This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.

name String

The name of the SKU. Ex - P3. It is typically a letter+number code

capacity Integer

If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.

family String

If the service has different generations of hardware, for the same SKU, then that can be captured here.

size String

The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.

tier String

This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.

name string

The name of the SKU. Ex - P3. It is typically a letter+number code

capacity number

If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.

family string

If the service has different generations of hardware, for the same SKU, then that can be captured here.

size string

The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.

tier string

This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.

name str

The name of the SKU. Ex - P3. It is typically a letter+number code

capacity int

If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.

family str

If the service has different generations of hardware, for the same SKU, then that can be captured here.

size str

The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.

tier str

This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.

name String

The name of the SKU. Ex - P3. It is typically a letter+number code

capacity Number

If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.

family String

If the service has different generations of hardware, for the same SKU, then that can be captured here.

size String

The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.

tier String

This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.

Package Details

Repository
https://github.com/pulumi/pulumi-azure-native
License
Apache-2.0