RTDP.CLI.AdminCmdlets.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>RTDP.CLI.AdminCmdlets</name> </assembly> <members> <member name="T:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerApp.GetPartnerApps"> <summary> The `Get-PartnerApps` cmdlet will retrieve the partner enterprise applications mapped to a datastore ID. </summary> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerApp.GetPartnerApps.CmdletName"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerApp.GetPartnerApps.EndpointSuffix"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerApp.GetPartnerApps.Component"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerApp.GetPartnerApps.DatastoreID"> <summary> The Datastore ID that will be used to query the available partner resources. </summary> </member> <member name="T:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerApp.RegisterPartnerApp"> <summary> The `Register-PartnerApp` cmdlet will register a partner enterprise application to the Data Platform. </summary> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerApp.RegisterPartnerApp.CmdletName"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerApp.RegisterPartnerApp.EndpointSuffix"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerApp.RegisterPartnerApp.Component"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerApp.RegisterPartnerApp.ApplicationName"> <summary> The partner enterprise application given name </summary> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerApp.RegisterPartnerApp.ApplicationIcmTeam"> <summary> The ICM team responsible for this enterprise application </summary> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerApp.RegisterPartnerApp.ApplicationTeamEmail"> <summary> The team email / distribution list for this application </summary> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerApp.RegisterPartnerApp.ApplicationInformation"> <summary> Information about the enterprise application. </summary> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerApp.RegisterPartnerApp.ApplicationEligibility"> <summary> The application eligibility. </summary> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerApp.RegisterPartnerApp.ApplicationEnvironmentBindings"> <summary> Application environment-specific bindings (such as Aad App Id). </summary> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerApp.RegisterPartnerApp.Payload"> <summary> The payload object contains values for the other parameters. You can either use this parameter, or the others. </summary> </member> <member name="M:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerApp.RegisterPartnerApp.BeginProcessingExtension"> <inheritdoc/> </member> <member name="M:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerApp.RegisterPartnerApp.ProcessRecordExtension"> <inheritdoc/> </member> <member name="T:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerApp.RemovePartnerApp"> <summary> The `Remove-PartnerApplication` cmdlet will remove the partner application bindings with mapped datastores. </summary> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerApp.RemovePartnerApp.CmdletName"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerApp.RemovePartnerApp.EndpointSuffix"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerApp.RemovePartnerApp.Component"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerApp.RemovePartnerApp.PartnerApplicationID"> <summary> The partner enterprise application ID. </summary> </member> <member name="M:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerApp.RemovePartnerApp.ProcessRecordExtension"> <inheritdoc/> </member> <member name="T:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerApp.UpdatePartnerApp"> <summary> The `Update-PartnerApplication` cmdlet will update the enterprise partner application information. </summary> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerApp.UpdatePartnerApp.CmdletName"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerApp.UpdatePartnerApp.EndpointSuffix"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerApp.UpdatePartnerApp.Component"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerApp.UpdatePartnerApp.PartnerApplicationID"> <summary> The Partner Application ID. </summary> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerApp.UpdatePartnerApp.PartnerApplicationName"> <summary> The modified partner application name. </summary> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerApp.UpdatePartnerApp.PartnerApplicationIcMTeam"> <summary> The modified IcM team for this application. </summary> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerApp.UpdatePartnerApp.PartnerApplicationTeamEmail"> <summary> The modified team email / distribution list for this application. </summary> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerApp.UpdatePartnerApp.PartnerApplicationInformation"> <summary> The modified /updated application information field. </summary> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerApp.UpdatePartnerApp.PartnerApplicactionElbigibility"> <summary> The modified / updated application eligibilities field. </summary> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerApp.UpdatePartnerApp.PartnerApplicationEnvironmentBindings"> <summary> The modified / updated application environment bindings. </summary> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerApp.UpdatePartnerApp.Payload"> <summary> The payload object contains values for the other parameters. You can either use this parameter, or the others. </summary> </member> <member name="M:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerApp.UpdatePartnerApp.BeginProcessingExtension"> <inheritdoc/> </member> <member name="M:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerApp.UpdatePartnerApp.ProcessRecordExtension"> <inheritdoc/> </member> <member name="T:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerResource.DeleteDatastore"> <summary> The `Delete-Datastore` cmdlet will perform a soft-delete for a given datastore id. </summary> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerResource.DeleteDatastore.CmdletName"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerResource.DeleteDatastore.EndpointSuffix"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerResource.DeleteDatastore.Component"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerResource.DeleteDatastore.DatastoreID"> <summary> The Datastore ID that will be used for the soft-delete action. </summary> </member> <member name="M:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerResource.DeleteDatastore.ProcessRecordExtension"> <inheritdoc/> </member> <member name="T:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerResource.GetDatastoreConnectionString"> <summary> The `Get-DatastoreConnectionString` cmdlet will return the connection string information for a specifid datastore. </summary> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerResource.GetDatastoreConnectionString.CmdletName"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerResource.GetDatastoreConnectionString.EndpointSuffix"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerResource.GetDatastoreConnectionString.Component"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerResource.GetDatastoreConnectionString.DatastoreID"> <summary> The Datastore ID that will be used to retrieve the mapped datastore connection string </summary> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerResource.GetDatastoreConnectionString.PartnerAppID"> <summary> The Partner Enterprise Application ID, to retrieve the connection string information for </summary> </member> <member name="T:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerResource.GetDatastoreEndpoints"> <summary> The `Get-DatastoreEndpoints` cmdlet will retrieve the endpoints for a given datastore ID. </summary> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerResource.GetDatastoreEndpoints.CmdletName"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerResource.GetDatastoreEndpoints.EndpointSuffix"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerResource.GetDatastoreEndpoints.Component"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerResource.GetDatastoreEndpoints.DatastoreID"> <summary> The Datastore ID that will be used to retrieve datastore endpoints. </summary> </member> <member name="T:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerResource.RegisterDatastore"> <summary> The `Register-Datastore` cmdlet is used to register a new datastore inside of Data Platform. </summary> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerResource.RegisterDatastore.CmdletName"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerResource.RegisterDatastore.EndpointSuffix"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerResource.RegisterDatastore.Component"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerResource.RegisterDatastore.ResourceName"> <summary> The datastore resource name. </summary> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerResource.RegisterDatastore.ResourceType"> <summary> The datastore resource type. </summary> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerResource.RegisterDatastore.InternalApplicationId"> <summary> The mapped 'internal' application ID. </summary> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerResource.RegisterDatastore.ResourceInformation"> <summary> The datastore resource information. </summary> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerResource.RegisterDatastore.ResourceEnvironments"> <summary> The JSON array representation for the datastore resource environments. </summary> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerResource.RegisterDatastore.Payload"> <summary> The payload object contains values for the other parameters. You can either use this parameter, or the others. </summary> </member> <member name="M:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerResource.RegisterDatastore.BeginProcessingExtension"> <inheritdoc/> </member> <member name="M:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerResource.RegisterDatastore.ProcessRecordExtension"> <inheritdoc/> </member> <member name="T:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerResource.UpdateDatastore"> <summary> The `Update-Datastore` cmdlet will update a datastore based on the given datastore ID </summary> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerResource.UpdateDatastore.CmdletName"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerResource.UpdateDatastore.EndpointSuffix"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerResource.UpdateDatastore.Component"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerResource.UpdateDatastore.DatastoreID"> <summary> The datastore ID that will be used for the PUT request. </summary> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerResource.UpdateDatastore.ResourceName"> <summary> The datastore new resource name. </summary> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerResource.UpdateDatastore.ResourceType"> <summary> The datastore new resource type. </summary> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerResource.UpdateDatastore.InternalApplicationID"> <summary> The datastore new internal app ID. </summary> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerResource.UpdateDatastore.ResourceInformation"> <summary> The datastore new resource information. </summary> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerResource.UpdateDatastore.ResourceEnvironments"> <summary> The new datastore resource environments information. </summary> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerResource.UpdateDatastore.Payload"> <summary> The payload object contains values for the other parameters. You can either use this parameter, or the others. </summary> </member> <member name="M:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerResource.UpdateDatastore.BeginProcessingExtension"> <inheritdoc/> </member> <member name="M:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerResource.UpdateDatastore.ProcessRecordExtension"> <inheritdoc/> </member> <member name="T:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerResource.UpdateDatastoreVersion"> <summary> The `Update-DatastoreVersion` cmdlet allows the admin to update the datastore versioning. </summary> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerResource.UpdateDatastoreVersion.CmdletName"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerResource.UpdateDatastoreVersion.EndpointSuffix"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerResource.UpdateDatastoreVersion.Component"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerResource.UpdateDatastoreVersion.ResourceName"> <summary> The resource name that will be used for the PUT request. </summary> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerResource.UpdateDatastoreVersion.Environment"> <summary> The datastore environment that will be patched. </summary> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerResource.UpdateDatastoreVersion.Version"> <summary> The patched version number. </summary> </member> <member name="M:RTDP.CLI.AdminCmdlets.Cmdlets.AppResourcesAPI.PartnerResource.UpdateDatastoreVersion.ProcessRecordExtension"> <inheritdoc/> </member> <member name="T:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.DeleteDataset"> <summary> The `Delete-Dataset` cmdlet deletes a dataset by the specified ID from the Data Platform. </summary> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.DeleteDataset.CmdletName"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.DeleteDataset.EndpointSuffix"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.DeleteDataset.Component"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.DeleteDataset.DatasetId"> <summary> The ID of the dataset to delete. </summary> </member> <member name="M:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.DeleteDataset.ProcessRecordExtension"> <inheritdoc/> </member> <member name="T:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.GetAvailableDatasets"> <summary> The `Get-AvailableDatasets` cmdlet will return all Common and partner-created datasets that are available to the admin. </summary> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.GetAvailableDatasets.CmdletName"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.GetAvailableDatasets.EndpointSuffix"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.GetAvailableDatasets.Component"> <inheritdoc/> </member> <member name="T:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.GetDatasetColumns"> <summary> The `Get-DatasetColumns` PowerShell cmdlet will return the columns of a table / dataset in the Data Platform. </summary> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.GetDatasetColumns.CmdletName"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.GetDatasetColumns.EndpointSuffix"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.GetDatasetColumns.Component"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.GetDatasetColumns.DatasetId"> <summary> The ID of the dataset to retrieve column information. </summary> </member> <member name="T:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.GetDatasetConnectionDetails"> <summary> The `Get-DatasetConnectionDetails` cmdlet will return the connection details for a given dataset based on the id. </summary> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.GetDatasetConnectionDetails.CmdletName"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.GetDatasetConnectionDetails.EndpointSuffix"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.GetDatasetConnectionDetails.Component"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.GetDatasetConnectionDetails.DatasetID"> <summary> The Dataset ID that will be used to retrieve the Connection Details. </summary> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.GetDatasetConnectionDetails.AadApplicationID"> <summary> The partner AAD Registered Application ID that will be used for retrieving the dataset connection details. </summary> </member> <member name="T:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.GetDatasetEnvironments"> <summary> The `Get-DatasetEnvironment` cmdlet will return the environments where the dataset has been published onto. </summary> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.GetDatasetEnvironments.CmdletName"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.GetDatasetEnvironments.EndpointSuffix"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.GetDatasetEnvironments.Component"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.GetDatasetEnvironments.DatasetId"> <summary> The ID of the dataset to retrieve environments for. </summary> </member> <member name="T:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.GetDatasetInformation"> <summary> The `Get-DatasetInformation` cmdlet will return the information about a specific dataset. </summary> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.GetDatasetInformation.CmdletName"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.GetDatasetInformation.EndpointSuffix"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.GetDatasetInformation.Component"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.GetDatasetInformation.DatasetId"> <summary> The ID of the dataset to retrieve information for. </summary> </member> <member name="T:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.GetQueuedIngestionsByDatasetId"> <summary> The `Get-QueuedIngestionsByDatasetId` cmdlet will return the list of queued ingestions specific of a dataset id. </summary> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.GetQueuedIngestionsByDatasetId.CmdletName"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.GetQueuedIngestionsByDatasetId.EndpointSuffix"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.GetQueuedIngestionsByDatasetId.Component"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.GetQueuedIngestionsByDatasetId.DatasetId"> <summary> The ID of the dataset to retrieve the queued ingestions list </summary> </member> <member name="T:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.GetQueuedIngestionsByDatasetIdAndSourceId"> <summary> The `Get-QueuedIngestionsByDatasetIdAndSourceId` cmdlet will return details of a queued ingestion specific of a dataset id and source id. </summary> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.GetQueuedIngestionsByDatasetIdAndSourceId.CmdletName"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.GetQueuedIngestionsByDatasetIdAndSourceId.EndpointSuffix"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.GetQueuedIngestionsByDatasetIdAndSourceId.Component"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.GetQueuedIngestionsByDatasetIdAndSourceId.DatasetId"> <summary> The ID of the dataset to retrieve details of </summary> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.GetQueuedIngestionsByDatasetIdAndSourceId.QueuedIngestionId"> <summary> The ID of the source queued ingestion to retrieve details of </summary> </member> <member name="T:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.GetRequesterQueuedIngestions"> <summary> The `Get-RequesterQueuedIngestions` cmdlet will return all records of queued ingestions made by the caller AAD App Id that are available to the admin. </summary> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.GetRequesterQueuedIngestions.CmdletName"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.GetRequesterQueuedIngestions.EndpointSuffix"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.GetRequesterQueuedIngestions.Component"> <inheritdoc/> </member> <member name="T:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.PromoteDataset"> <summary> The Promote-Dataset cmdlet is used to promote a dataset to another environment. </summary> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.PromoteDataset.CmdletName"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.PromoteDataset.EndpointSuffix"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.PromoteDataset.Component"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.PromoteDataset.DatasetId"> <summary> Parameter 1: The ID of the dataset that will be promoted. </summary> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.PromoteDataset.TargetEnvironment"> <summary> Parameter 2: An environment that the dataset should be promoted onto. </summary> </member> <member name="M:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.PromoteDataset.ProcessRecordExtension"> <inheritdoc/> </member> <member name="T:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.RegisterDataset"> <summary> The Register-Dataset cmdlet is used to register a dataset to the datastores location. </summary> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.RegisterDataset.CmdletName"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.RegisterDataset.EndpointSuffix"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.RegisterDataset.Component"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.RegisterDataset.DatasetName"> <summary> The name of the dataset to be registered. </summary> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.RegisterDataset.DatasetType"> <summary> The dataset type: KQLM, SQL, etc. </summary> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.RegisterDataset.DatasetProperties"> <summary> The additional properties of this dataset (JSON format) </summary> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.RegisterDataset.DatasetCategory"> <summary> The dataset category: common or private </summary> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.RegisterDataset.InternalResourceID"> <summary> The internal datastore resource ID. </summary> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.RegisterDataset.DatasetExpression"> <summary> The expression that will be used to generate the dataset. </summary> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.RegisterDataset.DatasetOwnerEmail"> <summary> The dataset owner e-mail address. </summary> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.RegisterDataset.IsWriteable"> <summary> Is the dataset writeable or read-only? </summary> </member> <member name="M:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.RegisterDataset.ProcessRecordExtension"> <inheritdoc/> </member> <member name="T:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.RegisterQueuedIngestion"> <summary> The Register-QueuedIngestion cmdlet is used to register a queued ingestion to the datastores location and create the request for the ingestion </summary> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.RegisterQueuedIngestion.CmdletName"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.RegisterQueuedIngestion.EndpointSuffix"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.RegisterQueuedIngestion.Component"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.RegisterQueuedIngestion.DatasetId"> <summary> The ID of the dataset to make the ingestion </summary> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.RegisterQueuedIngestion.PayloadIngestion"> <summary> The payload object for the ingestion </summary> </member> <member name="M:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.RegisterQueuedIngestion.ProcessRecordExtension"> <inheritdoc/> </member> <member name="T:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.RevokeDatasetPromotion"> <summary> The Revoke-DatasetPromotion cmdlet is used to revoke the promotion of a dataset. </summary> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.RevokeDatasetPromotion.CmdletName"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.RevokeDatasetPromotion.EndpointSuffix"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.RevokeDatasetPromotion.Component"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.RevokeDatasetPromotion.DatasetID"> <summary> Parameter 1: The ID of the dataset that will be revoked from promotion. </summary> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.RevokeDatasetPromotion.TargetEnvironment"> <summary> Parameter 2: The target environment that will be used to revoke the dataset promotion. </summary> </member> <member name="M:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.RevokeDatasetPromotion.ProcessRecordExtension"> <inheritdoc/> </member> <member name="T:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.UpdateDatasetInformation"> <summary> The `Update-DatasetInformation` cmdlet will update the information about a specific dataset. </summary> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.UpdateDatasetInformation.CmdletName"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.UpdateDatasetInformation.EndpointSuffix"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.UpdateDatasetInformation.Component"> <inheritdoc/> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.UpdateDatasetInformation.DatasetId"> <summary> The ID of the partner dataset to update information for. </summary> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.UpdateDatasetInformation.DatasetExpression"> <summary> The dataset expression updated value. </summary> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.UpdateDatasetInformation.DatasetDescription"> <summary> The dataset description updated value. </summary> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.UpdateDatasetInformation.IsWritable"> <summary> The dataset `IsWritable` flag / access modifier </summary> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.UpdateDatasetInformation.IsVisibleToAllPartners"> <summary> The dataset `IsVisibleToAllPartners` flag / access modifier </summary> </member> <member name="M:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.UpdateDatasetInformation.BeginProcessingExtension"> <inheritdoc/> </member> <member name="M:RTDP.CLI.AdminCmdlets.Cmdlets.DatasetManager.UpdateDatasetInformation.ProcessRecordExtension"> <inheritdoc/> </member> <member name="T:RTDP.CLI.AdminCmdlets.Cmdlets.InitializeAdminSession"> <summary> The `Initialize-AdminSession` cmdlet will set up the process environment variable (INT, DEV, PROD). </summary> </member> <member name="P:RTDP.CLI.AdminCmdlets.Cmdlets.InitializeAdminSession.TargetEnvironment"> <summary> Parameter: Target Environment The target environment to perform the admin authentication against. </summary> </member> <member name="M:RTDP.CLI.AdminCmdlets.Cmdlets.InitializeAdminSession.ProcessRecord"> <summary> ProcessRecord method. This method will be called for each input received from the pipeline to this cmdlet; if no input is received, this method is not called </summary> </member> <member name="T:RTDP.CLI.Common.AuthEngine"> <summary> This class represents the Auth flows for Partners and Admins. It will be mostly used by partners and admins when they want to use the Data Platform PowerShell Cmdlets. </summary> </member> <member name="M:RTDP.CLI.Common.AuthEngine.ExecutePartnerAuth(System.String,System.String,System.String,System.String[])"> <summary> The ExecutePartnerAuth method will use the Microsoft.Identity.Client package and return the AuthenticationResult (that contains the Access Token) object. Instruction set: <list type="number"> <item> Create the Public Client Application builder object, passing the Client ID of the enterprise application. </item> <item> Prepare and build the Public Client Application that will trigger auth flow. </item> <item> Call the AcquireTokenInteractive() method for the Public Client Application, and retrieve the AuthenticationResult object. </item> </list> </summary> <param name="clientID">The client ID for the registered enterprise application.</param> <param name="tenantID">The tenant ID where the registered enterprise application is hosted.</param> <param name="redirectURI">The redirect URI that will be used by the MSAL client to listen for the access token received from the auth.</param> <param name="scopes">The scopes for the authentication and authorization flow.</param> <returns> The AuthenticationResult object after trying to authorize the partner.</returns> </member> <member name="T:RTDP.CLI.Common.Cmdlets.AppResourcesAPI.PromoteResourceStorage"> <summary> The `Promote-Resource-Storage` cmdlet is used to create (add) a new storage promotion. </summary> </member> <member name="P:RTDP.CLI.Common.Cmdlets.AppResourcesAPI.PromoteResourceStorage.CmdletName"> <inheritdoc/> </member> <member name="P:RTDP.CLI.Common.Cmdlets.AppResourcesAPI.PromoteResourceStorage.EndpointSuffix"> <inheritdoc/> </member> <member name="P:RTDP.CLI.Common.Cmdlets.AppResourcesAPI.PromoteResourceStorage.Component"> <inheritdoc/> </member> <member name="P:RTDP.CLI.Common.Cmdlets.AppResourcesAPI.PromoteResourceStorage.ResourceId"> <summary> The internal resource ID of the resource for the storage promotion. </summary> </member> <member name="M:RTDP.CLI.Common.Cmdlets.AppResourcesAPI.PromoteResourceStorage.ProcessRecordExtension"> <inheritdoc/> </member> <member name="T:RTDP.CLI.Common.Cmdlets.AppResourcesAPI.GetAvailableDatastores"> <summary> The `Get-AvailableDatastores` cmdlet is used to list the datastores that are currently available in the Data Platform. </summary> </member> <member name="P:RTDP.CLI.Common.Cmdlets.AppResourcesAPI.GetAvailableDatastores.CmdletName"> <inheritdoc/> </member> <member name="P:RTDP.CLI.Common.Cmdlets.AppResourcesAPI.GetAvailableDatastores.EndpointSuffix"> <inheritdoc/> </member> <member name="P:RTDP.CLI.Common.Cmdlets.AppResourcesAPI.GetAvailableDatastores.Component"> <inheritdoc/> </member> <member name="T:RTDP.CLI.Common.Cmdlets.AppResourcesAPI.GetDatastoreInformation"> <summary> The `Get-DatastoreInformation` cmdlet is used to list a specific datastore information. </summary> </member> <member name="P:RTDP.CLI.Common.Cmdlets.AppResourcesAPI.GetDatastoreInformation.CmdletName"> <inheritdoc/> </member> <member name="P:RTDP.CLI.Common.Cmdlets.AppResourcesAPI.GetDatastoreInformation.EndpointSuffix"> <inheritdoc/> </member> <member name="P:RTDP.CLI.Common.Cmdlets.AppResourcesAPI.GetDatastoreInformation.Component"> <inheritdoc/> </member> <member name="P:RTDP.CLI.Common.Cmdlets.AppResourcesAPI.GetDatastoreInformation.DatastoreID"> <summary> The DatastoreID parameter represents the Guid of the datastore that will be interrogated. </summary> </member> <member name="T:RTDP.CLI.Common.Cmdlets.AppResourcesAPI.GetDatastoreTables"> <summary> The Get-DatastoreTables cmdlet is used to list all the available tables in a datastore. </summary> </member> <member name="P:RTDP.CLI.Common.Cmdlets.AppResourcesAPI.GetDatastoreTables.CmdletName"> <inheritdoc/> </member> <member name="P:RTDP.CLI.Common.Cmdlets.AppResourcesAPI.GetDatastoreTables.EndpointSuffix"> <inheritdoc/> </member> <member name="P:RTDP.CLI.Common.Cmdlets.AppResourcesAPI.GetDatastoreTables.Component"> <inheritdoc/> </member> <member name="P:RTDP.CLI.Common.Cmdlets.AppResourcesAPI.GetDatastoreTables.DatastoreID"> <summary> The specified datastore internal resource ID. </summary> </member> <member name="T:RTDP.CLI.Common.Cmdlets.DataServer.AddDatasetRecord"> <summary> The `Add-DatasetRecord` cmdlet will create a new entry into a given dataset. </summary> </member> <member name="P:RTDP.CLI.Common.Cmdlets.DataServer.AddDatasetRecord.CmdletName"> <inheritdoc/> </member> <member name="P:RTDP.CLI.Common.Cmdlets.DataServer.AddDatasetRecord.EndpointSuffix"> <inheritdoc/> </member> <member name="P:RTDP.CLI.Common.Cmdlets.DataServer.AddDatasetRecord.Component"> <inheritdoc/> </member> <member name="P:RTDP.CLI.Common.Cmdlets.DataServer.AddDatasetRecord.DatasetId"> <summary> The ID of the dataset to add a record to. </summary> </member> <member name="P:RTDP.CLI.Common.Cmdlets.DataServer.AddDatasetRecord.Record"> <summary> The JSON payload representation of a record to add to the dataset. </summary> </member> <member name="M:RTDP.CLI.Common.Cmdlets.DataServer.AddDatasetRecord.ProcessRecordExtension"> <summary> The method `Process Record` is called for each input object. </summary> </member> <member name="T:RTDP.CLI.Common.Cmdlets.DataServer.GetDatasetContent"> <summary> The `Get-DatasetContent` cmdlet will return the content of a specific dataset. </summary> </member> <member name="P:RTDP.CLI.Common.Cmdlets.DataServer.GetDatasetContent.CmdletName"> <inheritdoc/> </member> <member name="P:RTDP.CLI.Common.Cmdlets.DataServer.GetDatasetContent.EndpointSuffix"> <inheritdoc/> </member> <member name="P:RTDP.CLI.Common.Cmdlets.DataServer.GetDatasetContent.Component"> <inheritdoc/> </member> <member name="P:RTDP.CLI.Common.Cmdlets.DataServer.GetDatasetContent.DatasetId"> <summary> The ID of the dataset to retrieve the environments for. </summary> </member> <member name="P:RTDP.CLI.Common.Cmdlets.DataServer.GetDatasetContent.AdditionalParameters"> <summary> Additional parameters for function / view support (passed as a JSON object). </summary> </member> <member name="P:RTDP.CLI.Common.Cmdlets.DataServer.GetDatasetContent.Count"> <summary> The odata $count token </summary> </member> <member name="P:RTDP.CLI.Common.Cmdlets.DataServer.GetDatasetContent.Top"> <summary> The odata $top token </summary> </member> <member name="P:RTDP.CLI.Common.Cmdlets.DataServer.GetDatasetContent.Skip"> <summary> The odata $skip token </summary> </member> <member name="P:RTDP.CLI.Common.Cmdlets.DataServer.GetDatasetContent.Filter"> <summary> The odata $filter token </summary> </member> <member name="P:RTDP.CLI.Common.Cmdlets.DataServer.GetDatasetContent.Select"> <summary> The odata $select token </summary> </member> <member name="M:RTDP.CLI.Common.Cmdlets.DataServer.GetDatasetContent.BeginProcessingExtension"> <inheritdoc/> </member> <member name="T:RTDP.CLI.Common.Cmdlets.DataServer.GetDatasetSchema"> <summary> The `Get-DatasetSchema` cmdlet will return the schema of a specific dataset. </summary> </member> <member name="P:RTDP.CLI.Common.Cmdlets.DataServer.GetDatasetSchema.CmdletName"> <inheritdoc/> </member> <member name="P:RTDP.CLI.Common.Cmdlets.DataServer.GetDatasetSchema.EndpointSuffix"> <inheritdoc/> </member> <member name="P:RTDP.CLI.Common.Cmdlets.DataServer.GetDatasetSchema.Component"> <inheritdoc/> </member> <member name="P:RTDP.CLI.Common.Cmdlets.DataServer.GetDatasetSchema.DatasetId"> <summary> The ID of the dataset to retrieve the schema for. </summary> </member> <member name="T:RTDP.CLI.Common.ConfigMapper"> <summary> The `EndpointsMapper` static class contains methods for mapping the endpoints used by the CLI. </summary> </member> <member name="M:RTDP.CLI.Common.ConfigMapper.GetEndpointFor(RTDP.CLI.Common.EndpointComponent,RTDP.CLI.Common.EndpointEnvironment)"> <summary> Get the Endpoint for a specific core microservice and environment. </summary> <param name="component"></param> <param name="environment"></param> <returns>The URI formatted as a string (PowerShell cannot validate URIs).</returns> </member> <member name="M:RTDP.CLI.Common.ConfigMapper.GetClientID(RTDP.CLI.Common.EndpointEnvironment)"> <summary> Get the Client ID based on the given environment. </summary> <param name="environment"></param> <returns></returns> <exception cref="T:System.ArgumentException">If the specified ENV does not exist -> return Argument Exception</exception> </member> <member name="M:RTDP.CLI.Common.ConfigMapper.GetTenantID(RTDP.CLI.Common.EndpointEnvironment)"> <summary> Get the Tenant ID based on the given environment. </summary> <param name="environment"></param> <returns></returns> <exception cref="T:System.ArgumentException">If the specified ENV does not exist -> return Argument Exception</exception> </member> <member name="M:RTDP.CLI.Common.ConfigMapper.GetScopes(RTDP.CLI.Common.EndpointEnvironment)"> <summary> Get the Scopes based on the given environment. </summary> <param name="environment"></param> <returns></returns> <exception cref="T:System.ArgumentException">If the specified ENV does not exist -> return Argument Exception</exception> </member> <member name="T:RTDP.CLI.Common.EndpointEnvironment"> <summary> The Endpoints Enum contains the names of the endpoints used by the CLI. </summary> </member> <member name="F:RTDP.CLI.Common.EndpointEnvironment.DEVELOPMENT"> <summary> DEV: rtdp-cluster-sf-dev.eastus.cloudapp.azure.com </summary> </member> <member name="F:RTDP.CLI.Common.EndpointEnvironment.INTEGRATION"> <summary> INT: rtdp-cluster-sf-int.eastus.cloudapp.azure.com </summary> </member> <member name="F:RTDP.CLI.Common.EndpointEnvironment.PRODUCTION"> <summary> PROD: rtdp-cluster-sf-prod.eastus.cloudapp.azure.com </summary> </member> <member name="T:RTDP.CLI.Common.EndpointComponent"> <summary> The Endpoint Component enum contains the 4 core microservices developed by RT Data Platform. </summary> </member> <member name="F:RTDP.CLI.Common.EndpointComponent.DATASET_MANAGER"> <summary> The Dataset Manager microservice. </summary> </member> <member name="F:RTDP.CLI.Common.EndpointComponent.DATA_SERVER"> <summary> The Data Server microservice. </summary> </member> <member name="F:RTDP.CLI.Common.EndpointComponent.APP_RESOURCES_API"> <summary> The App Resources API microservice. </summary> </member> <member name="T:RTDP.CLI.Common.HttpClientFacade"> <summary> Builds HTTP clients for the specified environment. </summary> </member> <member name="M:RTDP.CLI.Common.HttpClientFacade.BuildClient(System.Uri,System.String)"> <summary> Builds an HTTP client for the specified environment. </summary> <param name="endpoint"></param> <param name="accessToken"></param> <returns></returns> </member> <member name="M:RTDP.CLI.Common.HttpClientFacade.SendRequest(System.Net.Http.HttpClient,System.Net.Http.HttpMethod,System.String)"> <summary> Sends a request to the specified endpoint. </summary> <param name="client"></param> <param name="method"></param> <param name="payload"></param> <returns></returns> </member> <member name="T:RTDP.CLI.Common.Abstractions.RiseCmdlet"> <summary> The Rise Cmdlet class is the base class for all of the cmdlets developed by the RISE Data Platform team. This abstract base class provides the following characteristics: <list type="number"> <item>Default implementation for the PSCmdlet virtual methods.</item> <item>Possibility to add additional business logic for the PSCmdlet virtual methods.</item> <item>Specific parameters that are always required for RT Data Platform cmdlets (reduce DRY).</item> <item>Specific methods that are always required for RT Data Platform cmdlets (reduce DRY).</item> </list> See also <seealso cref="T:System.Management.Automation.PSCmdlet"/> for the former, original PS Cmdlet implementation. </summary> </member> <member name="M:RTDP.CLI.Common.Abstractions.RiseCmdlet.BeginProcessingExtension"> <summary> The method `BeginProcessingExtension` offers the possibility to perform custom logic that should be in the `Begin Processing` method. Override example: when you need to validate additional parameters before executing the cmdlet. </summary> </member> <member name="M:RTDP.CLI.Common.Abstractions.RiseCmdlet.ProcessRecordExtension"> <summary> The method `ProcessRecordExtension` offers the possibility to perform custom logic that should be in the `Process Record` method. This custom logic is wrapped on a if (Force || ShouldContinue()) block, thus guaranteeing that the custom logic will fire after validation. This method already offers an implementation of performing a GET request on the formatted endpoint parameter value and writing the response. Override example: when you want to perform a different HTTP method - PUT, DELETE, PATCH; or when you want to add more logic to the GET request. </summary> </member> <member name="M:RTDP.CLI.Common.Abstractions.RiseCmdlet.EndProcessingExtension"> <summary> The method `EndProcessingExtension` offers the possibility to perform custom logic that should be in the `End Processing` method. Override example: when you want to execute specific cleanup code. </summary> </member> <member name="P:RTDP.CLI.Common.Abstractions.RiseCmdlet.CmdletName"> <summary> The property `CmdletName` holds the cmdlet name. </summary> </member> <member name="P:RTDP.CLI.Common.Abstractions.RiseCmdlet.EndpointSuffix"> <summary> The property `EndpointSuffix` holds the endpoint suffix. This property is lazily loaded, to allow for dynamic suffixes. </summary> </member> <member name="P:RTDP.CLI.Common.Abstractions.RiseCmdlet.Component"> <summary> The property `Component` represents the targeted core microservice. E.g.: DATA_SERVER, DATASET_MANAGER, APP_RESOURCES_API. </summary> </member> <member name="M:RTDP.CLI.Common.Abstractions.RiseCmdlet.BuildInteractiveTextPrompt"> <summary> Build the interactive text prompt for user validation, based on the cmdlet public parameters values This method is built using reflection; this method will skip the `AccessToken` and `Force` parameters. </summary> <returns>A string that contains the parameter name and paramter value, for each parameters found, excl. Access Token and Force parameters.</returns> </member> <member name="M:RTDP.CLI.Common.Abstractions.RiseCmdlet.BuildClientAndReturnResponse(System.Net.Http.HttpMethod,System.String)"> <summary> Build a Http Client and send a HTTP request. </summary> <param name="method"></param> <param name="payload"></param> <returns>Returns a Http Response message object.</returns> </member> <member name="M:RTDP.CLI.Common.Abstractions.RiseCmdlet.WriteResponse(System.Net.Http.HttpResponseMessage)"> <summary> Writes the HTTP Response Message to the host PowerShell console. </summary> <param name="response"></param> </member> <member name="P:RTDP.CLI.Common.Abstractions.RiseCmdlet.EndpointURI"> <summary> The parameter `EndpointURI` represents the URI that will receive a HTTP request from the cmdlet. This parameter is of type `string`, since PowerShell is not able to validate custom types - such as URI. Later, this parameter will be automatically converted to URI type, when the HTTP client is built. </summary> </member> <member name="P:RTDP.CLI.Common.Abstractions.RiseCmdlet.AccessToken"> <summary> The parameter `AccessToken` represents the access token that will be attached to the HTTP request. This token will be verified by RT Data Platform's back-end and, if valid, allow the HTTP request. </summary> </member> <member name="P:RTDP.CLI.Common.Abstractions.RiseCmdlet.Force"> <summary> The `Force` parameter is used to skip the 2nd layer of validation (user/machine). This parameter is optional and is *recommended* when you wish to build an automated scenario. </summary> </member> <member name="M:RTDP.CLI.Common.Abstractions.RiseCmdlet.BeginProcessing"> <summary> The `BeginProcessing` method will be called at the beginning of each cmdlet's execution. This method will, by default, perform Access Token and Endpoint URI validation. You can override the `BeginProcessingExtension` method to add business logic. </summary> </member> <member name="M:RTDP.CLI.Common.Abstractions.RiseCmdlet.ProcessRecord"> <summary> The `ProcessRecord` method will be called after the `BeginProcessing` method exits execution scope. This means that, by default, we know that we have a valid Access Token and Endpoint URI. This method just prepares the execution grounds, and calls the `ProcessRecordExtension` method. Be sure to override the `ProcessRecordExtension` method whenever you want to add business logic. </summary> </member> <member name="M:RTDP.CLI.Common.Abstractions.RiseCmdlet.EndProcessing"> <summary> The `EndProcessing` method will be executed whenever the cmdlet finishes it's execution phase, the `ProcessRecord` method. By default, the implementation offers debugging (Verbose) information for the ran cmdlet. The implementation also allows for custom logic to be added. Override the `EndProcessingExtension` method if required. </summary> </member> </members> </doc> |