azure-native.desktopvirtualization.getWorkspace
Explore with Pulumi AI
Get a workspace. Azure REST API version: 2022-09-09.
Other available API versions: 2020-11-10-preview, 2022-10-14-preview, 2023-07-07-preview, 2023-09-05, 2023-10-04-preview, 2023-11-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:
- Resource
Group stringName The name of the resource group. The name is case insensitive.
- Workspace
Name string The name of the workspace
- Resource
Group stringName The name of the resource group. The name is case insensitive.
- Workspace
Name string The name of the workspace
- resource
Group StringName The name of the resource group. The name is case insensitive.
- workspace
Name String The name of the workspace
- resource
Group stringName The name of the resource group. The name is case insensitive.
- workspace
Name string The name of the workspace
- resource_
group_ strname The name of the resource group. The name is case insensitive.
- workspace_
name str The name of the workspace
- resource
Group StringName The name of the resource group. The name is case insensitive.
- workspace
Name String The name of the workspace
getWorkspace Result
The following output properties are available:
- Cloud
Pc boolResource 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
- Object
Id string ObjectId of Workspace. (internal use)
- System
Data Pulumi.Azure Native. Desktop Virtualization. Outputs. System Data Response Metadata pertaining to creation and last modification of the resource.
- Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Application
Group List<string>References List of applicationGroup resource Ids.
- Description string
Description of Workspace.
- Friendly
Name string Friendly name of Workspace.
- Identity
Pulumi.
Azure Native. Desktop Virtualization. Outputs. Resource Model With Allowed Property Set Response Identity - 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
- Managed
By 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.
Azure Native. Desktop Virtualization. Outputs. Resource Model With Allowed Property Set Response Plan - Sku
Pulumi.
Azure Native. Desktop Virtualization. Outputs. Resource Model With Allowed Property Set Response Sku - Dictionary<string, string>
Resource tags.
- Cloud
Pc boolResource 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
- Object
Id string ObjectId of Workspace. (internal use)
- System
Data SystemData Response Metadata pertaining to creation and last modification of the resource.
- Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Application
Group []stringReferences List of applicationGroup resource Ids.
- Description string
Description of Workspace.
- Friendly
Name string Friendly name of Workspace.
- Identity
Resource
Model With Allowed Property Set Response Identity - 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
- Managed
By 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
Resource
Model With Allowed Property Set Response Plan - Sku
Resource
Model With Allowed Property Set Response Sku - map[string]string
Resource tags.
- cloud
Pc BooleanResource 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
- object
Id String ObjectId of Workspace. (internal use)
- system
Data SystemData Response Metadata pertaining to creation and last modification of the resource.
- type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- application
Group List<String>References List of applicationGroup resource Ids.
- description String
Description of Workspace.
- friendly
Name String Friendly name of Workspace.
- identity
Resource
Model With Allowed Property Set Response Identity - 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
- managed
By 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
Resource
Model With Allowed Property Set Response Plan - sku
Resource
Model With Allowed Property Set Response Sku - Map<String,String>
Resource tags.
- cloud
Pc booleanResource 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
- object
Id string ObjectId of Workspace. (internal use)
- system
Data SystemData Response Metadata pertaining to creation and last modification of the resource.
- type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- application
Group string[]References List of applicationGroup resource Ids.
- description string
Description of Workspace.
- friendly
Name string Friendly name of Workspace.
- identity
Resource
Model With Allowed Property Set Response Identity - 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
- managed
By 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
Resource
Model With Allowed Property Set Response Plan - sku
Resource
Model With Allowed Property Set Response Sku - {[key: string]: string}
Resource tags.
- cloud_
pc_ boolresource 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)
- system_
data SystemData Response Metadata pertaining to creation and last modification of the resource.
- type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- application_
group_ Sequence[str]references List of applicationGroup resource Ids.
- description str
Description of Workspace.
- friendly_
name str Friendly name of Workspace.
- identity
Resource
Model With Allowed Property Set Response Identity - 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
Resource
Model With Allowed Property Set Response Plan - sku
Resource
Model With Allowed Property Set Response Sku - Mapping[str, str]
Resource tags.
- cloud
Pc BooleanResource 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
- object
Id String ObjectId of Workspace. (internal use)
- system
Data Property Map Metadata pertaining to creation and last modification of the resource.
- type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- application
Group List<String>References List of applicationGroup resource Ids.
- description String
Description of Workspace.
- friendly
Name 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
- managed
By 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
- Map<String>
Resource tags.
Supporting Types
ResourceModelWithAllowedPropertySetResponseIdentity
- Principal
Id string The principal ID of resource identity.
- Tenant
Id string The tenant ID of resource.
- Type string
The identity type.
- Principal
Id string The principal ID of resource identity.
- Tenant
Id string The tenant ID of resource.
- Type string
The identity type.
- principal
Id String The principal ID of resource identity.
- tenant
Id String The tenant ID of resource.
- type String
The identity type.
- principal
Id string The principal ID of resource identity.
- tenant
Id 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.
- principal
Id String The principal ID of resource identity.
- tenant
Id 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
- Promotion
Code 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
- Promotion
Code 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
- promotion
Code 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
- promotion
Code 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
- promotion
Code 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.
SystemDataResponse
- Created
At string The timestamp of resource creation (UTC).
- Created
By string The identity that created the resource.
- Created
By stringType The type of identity that created the resource.
- Last
Modified stringAt The timestamp of resource last modification (UTC)
- Last
Modified stringBy The identity that last modified the resource.
- Last
Modified stringBy Type The type of identity that last modified the resource.
- Created
At string The timestamp of resource creation (UTC).
- Created
By string The identity that created the resource.
- Created
By stringType The type of identity that created the resource.
- Last
Modified stringAt The timestamp of resource last modification (UTC)
- Last
Modified stringBy The identity that last modified the resource.
- Last
Modified stringBy Type The type of identity that last modified the resource.
- created
At String The timestamp of resource creation (UTC).
- created
By String The identity that created the resource.
- created
By StringType The type of identity that created the resource.
- last
Modified StringAt The timestamp of resource last modification (UTC)
- last
Modified StringBy The identity that last modified the resource.
- last
Modified StringBy Type The type of identity that last modified the resource.
- created
At string The timestamp of resource creation (UTC).
- created
By string The identity that created the resource.
- created
By stringType The type of identity that created the resource.
- last
Modified stringAt The timestamp of resource last modification (UTC)
- last
Modified stringBy The identity that last modified the resource.
- last
Modified stringBy Type The type of identity that last modified the resource.
- created_
at str The timestamp of resource creation (UTC).
- created_
by str The identity that created the resource.
- created_
by_ strtype The type of identity that created the resource.
- last_
modified_ strat The timestamp of resource last modification (UTC)
- last_
modified_ strby The identity that last modified the resource.
- last_
modified_ strby_ type The type of identity that last modified the resource.
- created
At String The timestamp of resource creation (UTC).
- created
By String The identity that created the resource.
- created
By StringType The type of identity that created the resource.
- last
Modified StringAt The timestamp of resource last modification (UTC)
- last
Modified StringBy The identity that last modified the resource.
- last
Modified StringBy Type The type of identity that last modified the resource.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0