Azure Native v1.98.0, Mar 23 23

azure-native.desktopvirtualization.getApplicationGroup

Get an application group. API Version: 2021-02-01-preview.

Using getApplicationGroup

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 getApplicationGroup(args: GetApplicationGroupArgs, opts?: InvokeOptions): Promise<GetApplicationGroupResult>
function getApplicationGroupOutput(args: GetApplicationGroupOutputArgs, opts?: InvokeOptions): Output<GetApplicationGroupResult>

def get_application_group(application_group_name: Optional[str] = None,
                          resource_group_name: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetApplicationGroupResult
def get_application_group_output(application_group_name: Optional[pulumi.Input[str]] = None,
                          resource_group_name: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetApplicationGroupResult]

func LookupApplicationGroup(ctx *Context, args *LookupApplicationGroupArgs, opts ...InvokeOption) (*LookupApplicationGroupResult, error)
func LookupApplicationGroupOutput(ctx *Context, args *LookupApplicationGroupOutputArgs, opts ...InvokeOption) LookupApplicationGroupResultOutput

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

public static class GetApplicationGroup 
{
    public static Task<GetApplicationGroupResult> InvokeAsync(GetApplicationGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetApplicationGroupResult> Invoke(GetApplicationGroupInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetApplicationGroupResult> getApplicationGroup(GetApplicationGroupArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: azure-native:desktopvirtualization:getApplicationGroup
  arguments:
    # arguments dictionary

The following arguments are supported:

ApplicationGroupName string: The name of the application group
ResourceGroupName string: The name of the resource group. The name is case insensitive.

ApplicationGroupName string: The name of the application group
ResourceGroupName string: The name of the resource group. The name is case insensitive.

applicationGroupName String: The name of the application group
resourceGroupName String: The name of the resource group. The name is case insensitive.

applicationGroupName string: The name of the application group
resourceGroupName string: The name of the resource group. The name is case insensitive.

application_group_name str: The name of the application group
resource_group_name str: The name of the resource group. The name is case insensitive.

applicationGroupName String: The name of the application group
resourceGroupName String: The name of the resource group. The name is case insensitive.

getApplicationGroup Result

The following output properties are available:

ApplicationGroupType string: Resource Type of ApplicationGroup.
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.
HostPoolArmPath string: HostPool arm path of ApplicationGroup.
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 ApplicationGroup. (internal use)
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
WorkspaceArmPath string: Workspace arm path of ApplicationGroup.
Description string: Description of ApplicationGroup.
FriendlyName string: Friendly name of ApplicationGroup.
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.
MigrationRequest Pulumi.AzureNative.DesktopVirtualization.Outputs.MigrationRequestPropertiesResponse: The registration info of HostPool.
Plan Pulumi.AzureNative.DesktopVirtualization.Outputs.ResourceModelWithAllowedPropertySetResponsePlan
Sku Pulumi.AzureNative.DesktopVirtualization.Outputs.ResourceModelWithAllowedPropertySetResponseSku
Tags Dictionary<string, string>: Resource tags.

ApplicationGroupType string: Resource Type of ApplicationGroup.
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.
HostPoolArmPath string: HostPool arm path of ApplicationGroup.
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 ApplicationGroup. (internal use)
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
WorkspaceArmPath string: Workspace arm path of ApplicationGroup.
Description string: Description of ApplicationGroup.
FriendlyName string: Friendly name of ApplicationGroup.
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.
MigrationRequest MigrationRequestPropertiesResponse: The registration info of HostPool.
Plan ResourceModelWithAllowedPropertySetResponsePlan
Sku ResourceModelWithAllowedPropertySetResponseSku
Tags map[string]string: Resource tags.

applicationGroupType String: Resource Type of ApplicationGroup.
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.
hostPoolArmPath String: HostPool arm path of ApplicationGroup.
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 ApplicationGroup. (internal use)
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
workspaceArmPath String: Workspace arm path of ApplicationGroup.
description String: Description of ApplicationGroup.
friendlyName String: Friendly name of ApplicationGroup.
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.
migrationRequest MigrationRequestPropertiesResponse: The registration info of HostPool.
plan ResourceModelWithAllowedPropertySetResponsePlan
sku ResourceModelWithAllowedPropertySetResponseSku
tags Map<String,String>: Resource tags.

applicationGroupType string: Resource Type of ApplicationGroup.
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.
hostPoolArmPath string: HostPool arm path of ApplicationGroup.
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 ApplicationGroup. (internal use)
type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
workspaceArmPath string: Workspace arm path of ApplicationGroup.
description string: Description of ApplicationGroup.
friendlyName string: Friendly name of ApplicationGroup.
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.
migrationRequest MigrationRequestPropertiesResponse: The registration info of HostPool.
plan ResourceModelWithAllowedPropertySetResponsePlan
sku ResourceModelWithAllowedPropertySetResponseSku
tags {[key: string]: string}: Resource tags.

application_group_type str: Resource Type of ApplicationGroup.
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.
host_pool_arm_path str: HostPool arm path of ApplicationGroup.
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 ApplicationGroup. (internal use)
type str: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
workspace_arm_path str: Workspace arm path of ApplicationGroup.
description str: Description of ApplicationGroup.
friendly_name str: Friendly name of ApplicationGroup.
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.
migration_request MigrationRequestPropertiesResponse: The registration info of HostPool.
plan ResourceModelWithAllowedPropertySetResponsePlan
sku ResourceModelWithAllowedPropertySetResponseSku
tags Mapping[str, str]: Resource tags.

applicationGroupType String: Resource Type of ApplicationGroup.
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.
hostPoolArmPath String: HostPool arm path of ApplicationGroup.
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 ApplicationGroup. (internal use)
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
workspaceArmPath String: Workspace arm path of ApplicationGroup.
description String: Description of ApplicationGroup.
friendlyName String: Friendly name of ApplicationGroup.
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.
migrationRequest Property Map: The registration info of HostPool.
plan Property Map
sku Property Map
tags Map<String>: Resource tags.

Supporting Types

MigrationRequestPropertiesResponse

MigrationPath string: The path to the legacy object to migrate.
Operation string: The type of operation for migration.

MigrationPath string: The path to the legacy object to migrate.
Operation string: The type of operation for migration.

migrationPath String: The path to the legacy object to migrate.
operation String: The type of operation for migration.

migrationPath string: The path to the legacy object to migrate.
operation string: The type of operation for migration.

migration_path str: The path to the legacy object to migrate.
operation str: The type of operation for migration.

migrationPath String: The path to the legacy object to migrate.
operation String: The type of operation for migration.

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: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0