RTDP.CLI.PartnerCmdlets.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>RTDP.CLI.PartnerCmdlets</name> </assembly> <members> <member name="T:RTDP.CLI.PartnerCmdlets.Cmdlets.DataPipelineFactoryAPI.CreatePartnerKustoConnectorPipeline"> <summary> Create partner ADF kusto connector pipeline given the data source and the destination. All the files will automatically commit to the branch </summary> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DataPipelineFactoryAPI.CreatePartnerKustoConnectorPipeline.CmdletName"> <inheritdoc/> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DataPipelineFactoryAPI.CreatePartnerKustoConnectorPipeline.EndpointSuffix"> <inheritdoc/> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DataPipelineFactoryAPI.CreatePartnerKustoConnectorPipeline.Component"> <inheritdoc/> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DataPipelineFactoryAPI.CreatePartnerKustoConnectorPipeline.DatasetId"> <summary> The Dataset Id that will represent the destination endpoint </summary> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DataPipelineFactoryAPI.CreatePartnerKustoConnectorPipeline.SourceConnectionString"> <summary> Source Connection String endpoint </summary> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DataPipelineFactoryAPI.CreatePartnerKustoConnectorPipeline.DestinationConnectionString"> <summary> Destination Connection String endpoint </summary> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DataPipelineFactoryAPI.CreatePartnerKustoConnectorPipeline.QueryText"> <summary> Query Text - valid kusto query </summary> </member> <member name="M:RTDP.CLI.PartnerCmdlets.Cmdlets.DataPipelineFactoryAPI.CreatePartnerKustoConnectorPipeline.ProcessRecordExtension"> <inheritdoc/> </member> <member name="T:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.CreatePartnerDataset"> <summary> The Create-Partner cmdlet is used to create a Kusto Table with a given schema and register it as a dataset. </summary> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.CreatePartnerDataset.CmdletName"> <inheritdoc/> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.CreatePartnerDataset.EndpointSuffix"> <inheritdoc/> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.CreatePartnerDataset.Component"> <inheritdoc/> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.CreatePartnerDataset.DatasetName"> <summary> Parameter 1: The name of the dataset to be registered. </summary> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.CreatePartnerDataset.InternalResourceID"> <summary> Parameter 2: The internal datastore resource ID. </summary> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.CreatePartnerDataset.DatasetDescription"> <summary> Parameter 3: The dataset description. </summary> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.CreatePartnerDataset.IsWriteable"> <summary> Parameter 4: Is the dataset writeable or read-only? </summary> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.CreatePartnerDataset.IsCommon"> <summary> Parameter 5: Is the dataset visible to all partners? (Common) </summary> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.CreatePartnerDataset.DatasetEnvironment"> <summary> Parameter 6: A comma separated list that contains the environments where the dataset will be registered on. </summary> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.CreatePartnerDataset.DatasetColumnsSerialized"> <summary> Parameter 7: Dataset Columns </summary> </member> <member name="M:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.CreatePartnerDataset.ProcessRecordExtension"> <inheritdoc/> </member> <member name="T:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.DeletePartnerDataset"> <summary> The `Delete-PartnerDataset` cmdlet deletes a partner dataset by the specified ID from the Data Platform. </summary> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.DeletePartnerDataset.CmdletName"> <inheritdoc/> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.DeletePartnerDataset.EndpointSuffix"> <inheritdoc/> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.DeletePartnerDataset.Component"> <inheritdoc/> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.DeletePartnerDataset.DatasetId"> <summary> The ID of the partner dataset to delete. </summary> </member> <member name="M:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.DeletePartnerDataset.ProcessRecordExtension"> <inheritdoc/> </member> <member name="T:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.GetAvailableDatasets"> <summary> The `Get-AvailableDatasets` cmdlet will return all Common and partner-created datasets that are available to the partner. </summary> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.GetAvailableDatasets.CmdletName"> <inheritdoc/> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.GetAvailableDatasets.EndpointSuffix"> <inheritdoc/> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.GetAvailableDatasets.Component"> <inheritdoc/> </member> <member name="T:RTDP.CLI.PartnerCmdlets.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.PartnerCmdlets.Cmdlets.DatasetManager.GetDatasetColumns.CmdletName"> <inheritdoc/> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.GetDatasetColumns.EndpointSuffix"> <inheritdoc/> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.GetDatasetColumns.Component"> <inheritdoc/> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.GetDatasetColumns.DatasetId"> <summary> The ID of the partner dataset to retrieve column information. </summary> </member> <member name="T:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.GetDatasetEnvironments"> <summary> The `Get-DatasetEnvironment` cmdlet will return the environments where the partner dataset has been published onto. </summary> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.GetDatasetEnvironments.CmdletName"> <inheritdoc/> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.GetDatasetEnvironments.EndpointSuffix"> <inheritdoc/> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.GetDatasetEnvironments.Component"> <inheritdoc/> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.GetDatasetEnvironments.DatasetId"> <summary> The ID of the partner dataset to retrieve environments for. </summary> </member> <member name="T:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.GetDatasetInformation"> <summary> The `Get-DatasetInformation` cmdlet will return the information about a specific dataset. </summary> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.GetDatasetInformation.CmdletName"> <inheritdoc/> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.GetDatasetInformation.EndpointSuffix"> <inheritdoc/> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.GetDatasetInformation.Component"> <inheritdoc/> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.GetDatasetInformation.DatasetId"> <summary> The ID of the partner dataset to retrieve information for. </summary> </member> <member name="T:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.PromotePartnerDataset"> <summary> The Promote-PartnerDataset cmdlet is used to promote a partner dataset to another environment. </summary> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.PromotePartnerDataset.CmdletName"> <inheritdoc/> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.PromotePartnerDataset.EndpointSuffix"> <inheritdoc/> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.PromotePartnerDataset.Component"> <inheritdoc/> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.PromotePartnerDataset.DatasetId"> <summary> Parameter 1: The ID of the dataset that will be promoted. </summary> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.PromotePartnerDataset.TargetEnvironment"> <summary> Parameter 2: An environment that the dataset should be promoted onto. </summary> </member> <member name="M:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.PromotePartnerDataset.ProcessRecordExtension"> <inheritdoc/> </member> <member name="T:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.RegisterPartnerDataset"> <summary> The Register-PartnerDataset cmdlet is used to register a dataset to the datastores location. </summary> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.RegisterPartnerDataset.CmdletName"> <inheritdoc/> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.RegisterPartnerDataset.EndpointSuffix"> <inheritdoc/> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.RegisterPartnerDataset.Component"> <inheritdoc/> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.RegisterPartnerDataset.DatasetName"> <summary> Parameter 1: The name of the dataset to be registered. </summary> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.RegisterPartnerDataset.DatasetExpression"> <summary> Parameter 2: The expression that will be used to generate the dataset. </summary> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.RegisterPartnerDataset.InternalResourceID"> <summary> Parameter 3: The internal datastore resource ID. </summary> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.RegisterPartnerDataset.DatasetDescription"> <summary> Parameter 4: The dataset description. </summary> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.RegisterPartnerDataset.DatasetEnvironment"> <summary> Parameter 5: A comma separated list that contains the environments where the dataset will be registered on. </summary> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.RegisterPartnerDataset.IsWriteable"> <summary> Parameter 6: Is the dataset writeable or read-only? </summary> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.RegisterPartnerDataset.IsCommon"> <summary> Parameter 7: Is the dataset visible to all partners? (Common) </summary> </member> <member name="M:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.RegisterPartnerDataset.ProcessRecordExtension"> <inheritdoc/> </member> <member name="T:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.RevokeDatasetPromotion"> <summary> The Revoke-DatasetPromotion cmdlet is used to revoke the promotion of a dataset. </summary> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.RevokeDatasetPromotion.CmdletName"> <inheritdoc/> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.RevokeDatasetPromotion.EndpointSuffix"> <inheritdoc/> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.RevokeDatasetPromotion.Component"> <inheritdoc/> </member> <member name="P:RTDP.CLI.PartnerCmdlets.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.PartnerCmdlets.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.PartnerCmdlets.Cmdlets.DatasetManager.RevokeDatasetPromotion.ProcessRecordExtension"> <inheritdoc/> </member> <member name="T:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.UpdateDatasetInformation"> <summary> The `Update-DatasetInformation` cmdlet will update the information about a specific dataset. </summary> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.UpdateDatasetInformation.CmdletName"> <inheritdoc/> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.UpdateDatasetInformation.EndpointSuffix"> <inheritdoc/> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.UpdateDatasetInformation.Component"> <inheritdoc/> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.UpdateDatasetInformation.DatasetId"> <summary> The ID of the partner dataset to update information for. </summary> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.UpdateDatasetInformation.DatasetExpression"> <summary> The dataset expression updated value. </summary> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.UpdateDatasetInformation.DatasetDescription"> <summary> The dataset description updated value. </summary> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.UpdateDatasetInformation.IsWritable"> <summary> The dataset `IsWritable` flag / access modifier </summary> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.UpdateDatasetInformation.IsVisibleToAllPartners"> <summary> The dataset `IsVisibleToAllPartners` flag / access modifier </summary> </member> <member name="M:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.UpdateDatasetInformation.BeginProcessingExtension"> <inheritdoc/> </member> <member name="M:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.UpdateDatasetInformation.ProcessRecordExtension"> <inheritdoc/> </member> <member name="T:RTDP.CLI.PartnerCmdlets.Cmdlets.InitializePartnerSession"> <summary> The "Initialize-PartnerSession" PwSh cmdlet returns an Access Token to be used by other Partner-related PwSh cmdlets. Parameters: <list type="number"> <item>Tenant ID: the Tenant ID where the Partner Enterprise Application is hosted.</item> <item>Client ID: the ID of the Enterprise Application that will execute the auth flow.</item> <item>Redirect URI: the URI that will be used by the MSAL client to listen for the Access Token received from the auth flow.</item> <item>Scope(s): the scopes that will be used on for the auth flow.</item> </list> <c>There is also a -Force parameter to skip interactive validation (for automation purposes)</c> This PwSh Cmdlet initializes the auth flow for the partner. The Access Token returned by the Cmdlet should be saved to a temporary variable, like this: <example> <code>$token = Initialize-PartnerSession</code> This will capture the Access Token (which is basically a JWT) in the $token variable, for later usage. </example> </summary> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.InitializePartnerSession.TargetEnvironment"> <summary> Parameter 1: Target Environment The target environment to perform the partner authentication against. </summary> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.InitializePartnerSession.TenantID"> <summary> Parameter 2: Tenant ID The tenant ID for the registered partner enterprise application. </summary> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.InitializePartnerSession.ClientID"> <summary> Parameter 3: Client ID The client ID for the registered partner enterprise application. </summary> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.InitializePartnerSession.RedirectURI"> <summary> Parameter 4: Redirect URI This parameter is optional and is received from the user. It represents the Redirect URI used by the MSAL client to listen for the access token received from the auth. </summary> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.InitializePartnerSession.Scopes"> <summary> Parameter 5: Scopes This parameter is mandatory and is received from the user. The scopes should most of the time end with the route ".default" <example> <code>Scopes[0] = "https://www.microsoft.com/api/.default"</code> <code>Scopes[1] = "https://www.contoso.com/api/.default"</code> </example> </summary> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.InitializePartnerSession.Force"> <summary> Parameter: Force This parameter is optional and skips the user confirmation prompt. (Useful for automation) </summary> </member> <member name="M:RTDP.CLI.PartnerCmdlets.Cmdlets.InitializePartnerSession.BeginProcessing"> <summary> This method gets called once for each cmdlet in the pipeline when the pipeline starts executing </summary> </member> <member name="M:RTDP.CLI.PartnerCmdlets.Cmdlets.InitializePartnerSession.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="M:RTDP.CLI.PartnerCmdlets.Cmdlets.InitializePartnerSession.EndProcessing"> <summary> This method will be called once at the end of pipeline execution; 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.Cmdlets.DataServer.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.Common.Cmdlets.DataServer.GetQueuedIngestionsByDatasetId.CmdletName"> <inheritdoc/> </member> <member name="P:RTDP.CLI.Common.Cmdlets.DataServer.GetQueuedIngestionsByDatasetId.EndpointSuffix"> <inheritdoc/> </member> <member name="P:RTDP.CLI.Common.Cmdlets.DataServer.GetQueuedIngestionsByDatasetId.Component"> <inheritdoc/> </member> <member name="P:RTDP.CLI.Common.Cmdlets.DataServer.GetQueuedIngestionsByDatasetId.DatasetId"> <summary> The ID of the dataset to retrieve the queued ingestions list </summary> </member> <member name="T:RTDP.CLI.Common.Cmdlets.DataServer.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.Common.Cmdlets.DataServer.GetQueuedIngestionsByDatasetIdAndSourceId.CmdletName"> <inheritdoc/> </member> <member name="P:RTDP.CLI.Common.Cmdlets.DataServer.GetQueuedIngestionsByDatasetIdAndSourceId.EndpointSuffix"> <inheritdoc/> </member> <member name="P:RTDP.CLI.Common.Cmdlets.DataServer.GetQueuedIngestionsByDatasetIdAndSourceId.Component"> <inheritdoc/> </member> <member name="P:RTDP.CLI.Common.Cmdlets.DataServer.GetQueuedIngestionsByDatasetIdAndSourceId.DatasetId"> <summary> The ID of the dataset to retrieve details of </summary> </member> <member name="P:RTDP.CLI.Common.Cmdlets.DataServer.GetQueuedIngestionsByDatasetIdAndSourceId.QueuedIngestionId"> <summary> The ID of the source queued ingestion to retrieve details of </summary> </member> <member name="T:RTDP.CLI.Common.Cmdlets.DataServer.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.Common.Cmdlets.DataServer.GetRequesterQueuedIngestions.CmdletName"> <inheritdoc/> </member> <member name="P:RTDP.CLI.Common.Cmdlets.DataServer.GetRequesterQueuedIngestions.EndpointSuffix"> <inheritdoc/> </member> <member name="P:RTDP.CLI.Common.Cmdlets.DataServer.GetRequesterQueuedIngestions.Component"> <inheritdoc/> </member> <member name="T:RTDP.CLI.Common.Cmdlets.DataServer.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.Common.Cmdlets.DataServer.RegisterQueuedIngestion.CmdletName"> <inheritdoc/> </member> <member name="P:RTDP.CLI.Common.Cmdlets.DataServer.RegisterQueuedIngestion.EndpointSuffix"> <inheritdoc/> </member> <member name="P:RTDP.CLI.Common.Cmdlets.DataServer.RegisterQueuedIngestion.Component"> <inheritdoc/> </member> <member name="P:RTDP.CLI.Common.Cmdlets.DataServer.RegisterQueuedIngestion.DatasetId"> <summary> The ID of the dataset to make the ingestion </summary> </member> <member name="P:RTDP.CLI.Common.Cmdlets.DataServer.RegisterQueuedIngestion.PayloadIngestion"> <summary> The payload object for the ingestion </summary> </member> <member name="M:RTDP.CLI.Common.Cmdlets.DataServer.RegisterQueuedIngestion.ProcessRecordExtension"> <inheritdoc/> </member> <member name="T:RTDP.CLI.Common.Cmdlets.Entities.Edges.AddEntityEdge"> <summary> The `Add-EntityEdge` cmdlet will add an edge to the Data Platform. </summary> </member> <member name="P:RTDP.CLI.Common.Cmdlets.Entities.Edges.AddEntityEdge.CmdletName"> <inheritdoc/> </member> <member name="P:RTDP.CLI.Common.Cmdlets.Entities.Edges.AddEntityEdge.EndpointSuffix"> <inheritdoc/> </member> <member name="P:RTDP.CLI.Common.Cmdlets.Entities.Edges.AddEntityEdge.Component"> <inheritdoc/> </member> <member name="P:RTDP.CLI.Common.Cmdlets.Entities.Edges.AddEntityEdge.Name"> <summary> The name of the edge (link). </summary> </member> <member name="P:RTDP.CLI.Common.Cmdlets.Entities.Edges.AddEntityEdge.Description"> <summary> The description of the edge (link). </summary> </member> <member name="P:RTDP.CLI.Common.Cmdlets.Entities.Edges.AddEntityEdge.LeftVertexId"> <summary> The left vertex ID. </summary> </member> <member name="P:RTDP.CLI.Common.Cmdlets.Entities.Edges.AddEntityEdge.RightVertexId"> <summary> The right vertex ID. </summary> </member> <member name="P:RTDP.CLI.Common.Cmdlets.Entities.Edges.AddEntityEdge.LeftVertexKey"> <summary> The left vertex key. </summary> </member> <member name="P:RTDP.CLI.Common.Cmdlets.Entities.Edges.AddEntityEdge.RightVertexKey"> <summary> The right vertex key. </summary> </member> <member name="M:RTDP.CLI.Common.Cmdlets.Entities.Edges.AddEntityEdge.ProcessRecordExtension"> <inheritdoc/> </member> <member name="T:RTDP.CLI.Common.Cmdlets.Entities.Edges.RemoveEntityEdge"> <summary> The `Delete-EntityEdge` cmdlet will delete an edge from the Data Platform. </summary> </member> <member name="P:RTDP.CLI.Common.Cmdlets.Entities.Edges.RemoveEntityEdge.CmdletName"> <inheritdoc/> </member> <member name="P:RTDP.CLI.Common.Cmdlets.Entities.Edges.RemoveEntityEdge.EndpointSuffix"> <inheritdoc/> </member> <member name="P:RTDP.CLI.Common.Cmdlets.Entities.Edges.RemoveEntityEdge.Component"> <inheritdoc/> </member> <member name="P:RTDP.CLI.Common.Cmdlets.Entities.Edges.RemoveEntityEdge.Name"> <summary> The name of the edge (link). </summary> </member> <member name="P:RTDP.CLI.Common.Cmdlets.Entities.Edges.RemoveEntityEdge.Description"> <summary> The description of the edge (link). </summary> </member> <member name="P:RTDP.CLI.Common.Cmdlets.Entities.Edges.RemoveEntityEdge.LeftVertexId"> <summary> The left vertex ID. </summary> </member> <member name="P:RTDP.CLI.Common.Cmdlets.Entities.Edges.RemoveEntityEdge.RightVertexId"> <summary> The right vertex ID. </summary> </member> <member name="P:RTDP.CLI.Common.Cmdlets.Entities.Edges.RemoveEntityEdge.LeftVertexKey"> <summary> The left vertex key. </summary> </member> <member name="P:RTDP.CLI.Common.Cmdlets.Entities.Edges.RemoveEntityEdge.RightVertexKey"> <summary> The right vertex key. </summary> </member> <member name="M:RTDP.CLI.Common.Cmdlets.Entities.Edges.RemoveEntityEdge.ProcessRecordExtension"> <inheritdoc/> </member> <member name="T:RTDP.CLI.Common.Cmdlets.Entities.Edges.GetEntityEdges"> <summary> The `Get-EntityEdges` cmdlet will return the edges present in the Data Platform. </summary> </member> <member name="P:RTDP.CLI.Common.Cmdlets.Entities.Edges.GetEntityEdges.CmdletName"> <inheritdoc/> </member> <member name="P:RTDP.CLI.Common.Cmdlets.Entities.Edges.GetEntityEdges.EndpointSuffix"> <inheritdoc/> </member> <member name="P:RTDP.CLI.Common.Cmdlets.Entities.Edges.GetEntityEdges.Component"> <inheritdoc/> </member> <member name="T:RTDP.CLI.Common.Cmdlets.Entities.Graph.FindPossibleEntities"> <summary> The `Find-PossibleEntities` cmdlet will return the entities that have a similarity with the provided search text. </summary> </member> <member name="P:RTDP.CLI.Common.Cmdlets.Entities.Graph.FindPossibleEntities.CmdletName"> <inheritdoc/> </member> <member name="P:RTDP.CLI.Common.Cmdlets.Entities.Graph.FindPossibleEntities.EndpointSuffix"> <inheritdoc/> </member> <member name="P:RTDP.CLI.Common.Cmdlets.Entities.Graph.FindPossibleEntities.Component"> <inheritdoc/> </member> <member name="P:RTDP.CLI.Common.Cmdlets.Entities.Graph.FindPossibleEntities.SearchText"> <summary> The search text. </summary> </member> <member name="M:RTDP.CLI.Common.Cmdlets.Entities.Graph.FindPossibleEntities.ProcessRecordExtension"> <inheritdoc/> </member> <member name="T:RTDP.CLI.Common.Cmdlets.Entities.Graph.GetEntityEdgesConnectedToVertex"> <summary> The `Get-EntityEdgesConnectedToVertex` cmdlet will return the edges connected to a vertex. </summary> </member> <member name="P:RTDP.CLI.Common.Cmdlets.Entities.Graph.GetEntityEdgesConnectedToVertex.CmdletName"> <inheritdoc/> </member> <member name="P:RTDP.CLI.Common.Cmdlets.Entities.Graph.GetEntityEdgesConnectedToVertex.EndpointSuffix"> <inheritdoc/> </member> <member name="P:RTDP.CLI.Common.Cmdlets.Entities.Graph.GetEntityEdgesConnectedToVertex.Component"> <inheritdoc/> </member> <member name="P:RTDP.CLI.Common.Cmdlets.Entities.Graph.GetEntityEdgesConnectedToVertex.VertexIdentifier"> <summary> The vertex identifier. </summary> </member> <member name="T:RTDP.CLI.Common.Cmdlets.Entities.Graph.GetEntitySubgraph"> <summary> The `Get-EntitySubgraph` cmdlet will return the subgraph that contains a list of entity vertices. </summary> </member> <member name="P:RTDP.CLI.Common.Cmdlets.Entities.Graph.GetEntitySubgraph.CmdletName"> <inheritdoc/> </member> <member name="P:RTDP.CLI.Common.Cmdlets.Entities.Graph.GetEntitySubgraph.EndpointSuffix"> <inheritdoc/> </member> <member name="P:RTDP.CLI.Common.Cmdlets.Entities.Graph.GetEntitySubgraph.Component"> <inheritdoc/> </member> <member name="P:RTDP.CLI.Common.Cmdlets.Entities.Graph.GetEntitySubgraph.EntityIdentifiers"> <summary> The list of entity identifiers. </summary> </member> <member name="M:RTDP.CLI.Common.Cmdlets.Entities.Graph.GetEntitySubgraph.ProcessRecordExtension"> <inheritdoc/> </member> <member name="T:RTDP.CLI.Common.Cmdlets.Entities.Graph.GetShortestPathFromVertexToVertex"> <summary> The `Get-ShortestPathFromVertexToVertex` cmdlet will return the shortest path between two vertices. </summary> </member> <member name="P:RTDP.CLI.Common.Cmdlets.Entities.Graph.GetShortestPathFromVertexToVertex.CmdletName"> <inheritdoc/> </member> <member name="P:RTDP.CLI.Common.Cmdlets.Entities.Graph.GetShortestPathFromVertexToVertex.EndpointSuffix"> <inheritdoc/> </member> <member name="P:RTDP.CLI.Common.Cmdlets.Entities.Graph.GetShortestPathFromVertexToVertex.Component"> <inheritdoc/> </member> <member name="P:RTDP.CLI.Common.Cmdlets.Entities.Graph.GetShortestPathFromVertexToVertex.SourceId"> <summary> The source vertex identifier. </summary> </member> <member name="P:RTDP.CLI.Common.Cmdlets.Entities.Graph.GetShortestPathFromVertexToVertex.TargetId"> <summary> The target vertex identifier. </summary> </member> <member name="T:RTDP.CLI.Common.Cmdlets.Entities.Vertices.AddEntityVertex"> <summary> The `Add-EntityVertex` cmdlet will add a vertex to the Data Platform. </summary> </member> <member name="P:RTDP.CLI.Common.Cmdlets.Entities.Vertices.AddEntityVertex.CmdletName"> <inheritdoc/> </member> <member name="P:RTDP.CLI.Common.Cmdlets.Entities.Vertices.AddEntityVertex.EndpointSuffix"> <inheritdoc/> </member> <member name="P:RTDP.CLI.Common.Cmdlets.Entities.Vertices.AddEntityVertex.Component"> <inheritdoc/> </member> <member name="P:RTDP.CLI.Common.Cmdlets.Entities.Vertices.AddEntityVertex.Name"> <summary> The name of the vertex. </summary> </member> <member name="P:RTDP.CLI.Common.Cmdlets.Entities.Vertices.AddEntityVertex.Description"> <summary> The description of the vertex. </summary> </member> <member name="P:RTDP.CLI.Common.Cmdlets.Entities.Vertices.AddEntityVertex.DomainDatasetId"> <summary> The support dataset (domain dataset) ID. </summary> </member> <member name="P:RTDP.CLI.Common.Cmdlets.Entities.Vertices.AddEntityVertex.DomainExposedSchema"> <summary> The domain exposed schema. </summary> </member> <member name="M:RTDP.CLI.Common.Cmdlets.Entities.Vertices.AddEntityVertex.ProcessRecordExtension"> <inheritdoc/> </member> <member name="T:RTDP.CLI.Common.Cmdlets.Entities.Vertices.RemoveEntityVertex"> <summary> The `Remove-EntityVertex` cmdlet will delete a vertex from the Data Platform. </summary> </member> <member name="P:RTDP.CLI.Common.Cmdlets.Entities.Vertices.RemoveEntityVertex.CmdletName"> <inheritdoc/> </member> <member name="P:RTDP.CLI.Common.Cmdlets.Entities.Vertices.RemoveEntityVertex.EndpointSuffix"> <inheritdoc/> </member> <member name="P:RTDP.CLI.Common.Cmdlets.Entities.Vertices.RemoveEntityVertex.Component"> <inheritdoc/> </member> <member name="P:RTDP.CLI.Common.Cmdlets.Entities.Vertices.RemoveEntityVertex.VertexId"> <summary> The vertex ID. </summary> </member> <member name="M:RTDP.CLI.Common.Cmdlets.Entities.Vertices.RemoveEntityVertex.ProcessRecordExtension"> <inheritdoc/> </member> <member name="T:RTDP.CLI.Common.Cmdlets.Entities.Vertices.GetEntityVertexById"> <summary> The `Get-EntityVertices` cmdlet will return the vertices stored in the Data Platform. </summary> </member> <member name="P:RTDP.CLI.Common.Cmdlets.Entities.Vertices.GetEntityVertexById.CmdletName"> <inheritdoc/> </member> <member name="P:RTDP.CLI.Common.Cmdlets.Entities.Vertices.GetEntityVertexById.EndpointSuffix"> <inheritdoc/> </member> <member name="P:RTDP.CLI.Common.Cmdlets.Entities.Vertices.GetEntityVertexById.Component"> <inheritdoc/> </member> <member name="P:RTDP.CLI.Common.Cmdlets.Entities.Vertices.GetEntityVertexById.VertexId"> <summary> The vertex ID. </summary> </member> <member name="T:RTDP.CLI.Common.Cmdlets.Entities.Vertices.GetEntityVertices"> <summary> The `Get-EntityVertices` cmdlet will return the vertices stored in the Data Platform. </summary> </member> <member name="P:RTDP.CLI.Common.Cmdlets.Entities.Vertices.GetEntityVertices.CmdletName"> <inheritdoc/> </member> <member name="P:RTDP.CLI.Common.Cmdlets.Entities.Vertices.GetEntityVertices.EndpointSuffix"> <inheritdoc/> </member> <member name="P:RTDP.CLI.Common.Cmdlets.Entities.Vertices.GetEntityVertices.Component"> <inheritdoc/> </member> <member name="T:RTDP.CLI.Common.Cmdlets.Entities.Vertices.UpdateEntityVertex"> <summary> The `Update-EntityVertex` cmdlet will update a vertex in the Data Platform. </summary> </member> <member name="P:RTDP.CLI.Common.Cmdlets.Entities.Vertices.UpdateEntityVertex.CmdletName"> <inheritdoc/> </member> <member name="P:RTDP.CLI.Common.Cmdlets.Entities.Vertices.UpdateEntityVertex.EndpointSuffix"> <inheritdoc/> </member> <member name="P:RTDP.CLI.Common.Cmdlets.Entities.Vertices.UpdateEntityVertex.Component"> <inheritdoc/> </member> <member name="P:RTDP.CLI.Common.Cmdlets.Entities.Vertices.UpdateEntityVertex.VertexId"> <summary> The ID of the vertex. </summary> </member> <member name="P:RTDP.CLI.Common.Cmdlets.Entities.Vertices.UpdateEntityVertex.Name"> <summary> The name of the vertex. </summary> </member> <member name="P:RTDP.CLI.Common.Cmdlets.Entities.Vertices.UpdateEntityVertex.Description"> <summary> The description of the vertex. </summary> </member> <member name="P:RTDP.CLI.Common.Cmdlets.Entities.Vertices.UpdateEntityVertex.DomainDatasetId"> <summary> The support dataset (domain dataset) ID. </summary> </member> <member name="P:RTDP.CLI.Common.Cmdlets.Entities.Vertices.UpdateEntityVertex.DomainExposedSchema"> <summary> The domain exposed schema. </summary> </member> <member name="M:RTDP.CLI.Common.Cmdlets.Entities.Vertices.UpdateEntityVertex.ProcessRecordExtension"> <inheritdoc/> </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.DEVT"> <summary> DEV: rtdp-cluster-sf-devt.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.PPE"> <summary> PPE: rtdp-cluster-sf-ppe.eastus.cloudapp.azure.com </summary> </member> <member name="F:RTDP.CLI.Common.EndpointEnvironment.PRODUCTION"> <summary> PROD: rtdp-cluster-sf-prd.westus2.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="F:RTDP.CLI.Common.EndpointComponent.DATA_PIPELINE_FACTORY_API"> <summary> The Data Pipeline Factory 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> |