Citrix Daas SDK

Get-ProvRecommendation

November 26, 2024

Contributed by:

Gets details of a recommendation using Machine Creation Services.

Syntax

Get-ProvRecommendation
   [-ReturnTotalRecordCount]
   [-MaxRecordCount <Int32>]
   [-Skip <Int32>]
   [-SortBy <String>]
   [-Filter <String>]
   [-FilterScope <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Provides the ability to view recommendations using Citrix Machine Creation Services.

Examples

EXAMPLE 1

Gets all the recommendations

Get-ProvRecommendation

          CreatedDateTimeInUTC      : 6/25/2024 2:36:42 PM
          Reason                    :
          RecommendationDescription : We recommend editing the catalog catalog-name to instead use Azure Ephemeral OS Disk as
          the storage type. By doing so, you can save costs without sacrificing performance. Please
          refer to blog-link for more information on the recommended feature.
          RecommendationId          : 643d6db8-1a52-4f19-9719-165a989c7130
          RecommendationMetadata    : {"catalog-name":"","blog-link":""}
          RecommendationSource      : AzureRmPlugin
          RecommendationState       : Dismiss
          RecommendationType        : EnableEphemeralOsDisk
          RemindInDateTimeInUTC     :
          TargetName                : apCT102
          TargetType                : ProvisioningScheme
          TargetUid                 : f888b899-7a21-41e8-917c-5459005cd5f6
          UpdatedDateTimeInUTC      :

          CreatedDateTimeInUTC      : 6/25/2024 5:47:50 PM
          Reason                    :
          RecommendationDescription : We recommend editing the catalog catalog-name to instead use Azure Ephemeral OS Disk as
          the storage type. By doing so, you can save costs without sacrificing performance. Please
          refer to blog-link for more information on the recommended feature.
          RecommendationId          : 8140909c-b041-4547-b31d-4f2ee83ebfe5
          RecommendationMetadata    : {"catalog-name":"","blog-link":""}
          RecommendationSource      : AzureRmPlugin
          RecommendationState       : Accept
          RecommendationType        : EnableEphemeralOsDisk
          RemindInDateTimeInUTC     :
          TargetName                : apCT103
          TargetType                : ProvisioningScheme
          TargetUid                 : adf53193-c47e-476e-8daa-8ad12ff2bc2b
          UpdatedDateTimeInUTC      :
<!--NeedCopy-->

Parameters

-ReturnTotalRecordCount

When specified, the cmdlet outputs an error record containing the number of records available. This error record is additional information and does not affect the objects written to the output pipeline. See about_Prov_Filtering for details.

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-MaxRecordCount

Specifies the maximum number of records to return.

Type:	Int32
Position:	Named
Default value:	250
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Skip

Skips the specified number of records before returning results. Also reduces the count returned by -ReturnTotalRecordCount.

Type:	Int32
Position:	Named
Default value:	0
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SortBy

Sorts the results by the specified list of properties. The list is a set of property names separated by commas, semi-colons, or spaces. Optionally, prefix each name with a + or - to indicate ascending or descending order. Ascending order is assumed if no prefix is present.

Type:	String
Position:	Named
Default value:	The default sort order is by name or unique identifier.
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Filter

Gets records that match a PowerShell-style filter expression. See about_Prov_Filtering for details.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-FilterScope

Gets only results allowed by the specified scope id.

Type:	Guid
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

CitrixCommonParameters

This cmdlet supports the common Citrix parameters: -AdminAddress, -AdminClientIP, -BearerToken, -TraceParent, -TraceState and -VirtualSiteId. For more information, see about_CitrixCommonParameters.

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

You can’t pipe objects to this cmdlet.

Outputs

Citrix.MachineCreation.Sdk.Recommendation

The object has the following properties:

RecommendationId <string>

The unique identifier of this recommendation.

RecommendationType <string>

The type or category of this recommendation.

RecommendationDescription <int>

The full description of this recommendation.

RecommendationMetadata <int>

The metadata associated with this recommendation.

RecommendationState <bool>

The state of this recommendation.

RecommendationSource <string>

The source of this recommendation.

TargetType <string>

The type of target associated with this recommendation. E.g. Provisioning Scheme.

TargetName <bool>

The name of the target associated with this recommendation. E.g. Provisioning Scheme Name.

Reason <datetime>

The reason why this recommendation was dismissed or rejected by the user.

CreatedDateTimeInUTC <bool>

The datetime at which this recommendation was generated by the system.

UpdatedDateTimeInUTC <int> The datetime at which this recommendation was updated.

RemindInDateTimeInUTC <int> The datetime at which this recommendation needs to be reminded.

Notes

In the case of failure, the following errors can result.

Error Codes

PartialData Only a subset of the available data was returned.

CouldNotQueryDatabase The query required to get the database was not defined.

PermissionDenied The user does not have administrative rights to perform this operation.

ConfigurationLoggingError The operation could not be performed because of a configuration logging error

CommunicationError An error occurred while communicating with the service.

DatabaseNotConfigured The operation could not be completed because the database for the service is not configured.

InvalidFilter A filtering expression was supplied that could not be interpreted for this cmdlet. ExceptionThrown An unexpected error occurred. For more details, see the Windows event logs on the controller being used or Citrix Virtual Apps and Desktops logs.

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Get-ProvRecommendation

November 26, 2024

Contributed by:

November 26, 2024

Contributed by:

Get-ProvRecommendation

Syntax

Description

Examples

EXAMPLE 1

Parameters

-ReturnTotalRecordCount

-MaxRecordCount

-Skip

-SortBy

-Filter

-FilterScope

CitrixCommonParameters

CommonParameters

Inputs

None

Outputs

Citrix.MachineCreation.Sdk.Recommendation

Notes

Related Links

In this article