RTDP.CLI.PartnerCmdlets.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>RTDP.CLI.PartnerCmdlets</name> </assembly> <members> <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.DatasetId"> <summary> The ID of the partner dataset to delete. </summary> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.DeletePartnerDataset.DatastoreURI"> <summary> The datastore URI where the dataset is contained. </summary> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.DeletePartnerDataset.AccessToken"> <summary> The partner Access Token to use for the request. </summary> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.DeletePartnerDataset.Force"> <summary> The `-Force` parameter is used to skip user validation. </summary> </member> <member name="M:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.DeletePartnerDataset.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.DatasetManager.DeletePartnerDataset.ProcessRecord"> <summary> 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.DatasetManager.DeletePartnerDataset.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.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.DatastoreURI"> <summary> The datastore URI to be used for querying the available datasets. </summary> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.GetAvailableDatasets.AccessToken"> <summary> The partner Access Token to use for the request. </summary> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.GetAvailableDatasets.Force"> <summary> The `-Force` parameter is used to skip user validation. </summary> </member> <member name="M:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.GetAvailableDatasets.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.DatasetManager.GetAvailableDatasets.ProcessRecord"> <summary> 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.DatasetManager.GetAvailableDatasets.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.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.DatasetId"> <summary> The ID of the partner dataset to retrieve column information. </summary> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.GetDatasetColumns.DatastoreURI"> <summary> The datastore URI where the dataset is contained. </summary> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.GetDatasetColumns.AccessToken"> <summary> The partner Access Token to use for the request. </summary> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.GetDatasetColumns.Force"> <summary> The `-Force` parameter is used to skip user validation. </summary> </member> <member name="M:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.GetDatasetColumns.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.DatasetManager.GetDatasetColumns.ProcessRecord"> <summary> 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.DatasetManager.GetDatasetColumns.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.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.DatasetId"> <summary> The ID of the partner dataset to retrieve environments for. </summary> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.GetDatasetEnvironments.DatastoreURI"> <summary> The Datastore URI where the dataset is contained. </summary> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.GetDatasetEnvironments.AccessToken"> <summary> The partner Access Token to use for the request. </summary> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.GetDatasetEnvironments.Force"> <summary> The `-Force` parameter is used to skip user validation. </summary> </member> <member name="M:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.GetDatasetEnvironments.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.DatasetManager.GetDatasetEnvironments.ProcessRecord"> <summary> 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.DatasetManager.GetDatasetEnvironments.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.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.DatasetId"> <summary> The ID of the partner dataset to retrieve information for. </summary> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.GetDatasetInformation.DatastoreURI"> <summary> The Datastore URI where the dataset is contained. </summary> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.GetDatasetInformation.AccessToken"> <summary> The partner Access Token to use for the request. </summary> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.GetDatasetInformation.Force"> <summary> The `-Force` parameter is used to skip user validation. </summary> </member> <member name="M:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.GetDatasetInformation.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.DatasetManager.GetDatasetInformation.ProcessRecord"> <summary> 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.DatasetManager.GetDatasetInformation.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.PartnerCmdlets.Cmdlets.DatasetManager.PromotePartnerDataset"> <summary> The Promote-PartnerDataset cmdlet is used to promote a partner dataset to another environment. Parameters: <list type="number"> <item>Access Token: The Access Token received from the ExecutePartnerAuth flow being ran.</item> <item>Environments URI: the URI where the other environments are located.</item> <item>Dataset ID: The ID of the dataset that will be promoted onto the environments endpoint.</item> <item>SessionEnvironment: an environment where the dataset should be promoted onto.</item> </list> <c>There is also a -Force parameter to skip interactive validation (for automation purposes)</c> </summary> </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="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.PromotePartnerDataset.EnvironmentsURI"> <summary> Parameter 3: The environments URI where the dataset will be promoted to. </summary> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.PromotePartnerDataset.AccessToken"> <summary> Parameter 4: The Access Token that will be used in order to promote the partner dataset. </summary> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.PromotePartnerDataset.Force"> <summary> Parameter 5: This parameter is optional and skips the confirmation prompt. </summary> </member> <member name="M:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.PromotePartnerDataset.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.DatasetManager.PromotePartnerDataset.ProcessRecord"> <summary> 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.DatasetManager.PromotePartnerDataset.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.PartnerCmdlets.Cmdlets.DatasetManager.RegisterPartnerDataset"> <summary> The Register-PartnerDataset cmdlet is used to register a dataset to the datastores location. Parameters: <list type="number"> <item>Access Token: The Access Token received from the ExecutePartnerAuth flow being ran.</item> <item>Datastores URI: the URI where the dataset should be registered onto.</item> <item>Dataset name: The name of the dataset that will be registered.</item> <item>Dataset expression: The expression that will be ran in order to register the dataset.</item> <item>Internal resource ID: The internal ID of the datastore that will be used for registering the dataset.</item> <item>Dataset description: A short description about the dataset's offerings.</item> <item>Dataset Environments: A list of enviornments where the dataset will be registered onto.</item> <item>Is Writeable?: A true/false flag to register the dataset as read-only or not, in the datastore.</item> </list> <c>There is also a -Force parameter to skip interactive validation (for automation purposes)</c> </summary> </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.DatasetURI"> <summary> Parameter 6: The Dataset URI where the dataset will be registered to. </summary> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.RegisterPartnerDataset.IsWriteable"> <summary> Parameter 7: Is the dataset writeable or read-only? </summary> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.RegisterPartnerDataset.IsCommon"> <summary> Parameter 8: Is the dataset visible to all partners? (Common) </summary> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.RegisterPartnerDataset.AccessToken"> <summary> Parameter 9: The Access Token that will be used to register the dataset. </summary> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.RegisterPartnerDataset.Force"> <summary> Parameter 9: This parameter is optional and skips the confirmation prompt. </summary> </member> <member name="M:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.RegisterPartnerDataset.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.DatasetManager.RegisterPartnerDataset.ProcessRecord"> <summary> 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.DatasetManager.RegisterPartnerDataset.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.PartnerCmdlets.Cmdlets.DatasetManager.RevokeDatasetPromotion"> <summary> The Revoke-DatasetPromotion cmdlet is used to revoke the promotion of a dataset. Parameters: <list type="number"> <item>Access Token: The Access Token received from the ExecutePartnerAuth flow being ran.</item> <item>Dataset ID: The ID of the dataset that will be revoked-promoted.</item> <item>Environments URI: the URI where the dataset was previously promoted on.</item> </list> <c>There is also a -Force parameter to skip interactive validation (for automation purposes)</c> </summary> </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="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.RevokeDatasetPromotion.EnvironmentsURI"> <summary> Parameter 3: The URI for the environment where the dataset will be demoted the previous promotion(s). </summary> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.RevokeDatasetPromotion.AccessToken"> <summary> Parameter 4: The Access Token that will be used to revoke the promotion of the dataset. </summary> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.RevokeDatasetPromotion.Force"> <summary> Parameter 5: This parameter is optional and skips the confirmation prompt. </summary> </member> <member name="M:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.RevokeDatasetPromotion.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.DatasetManager.RevokeDatasetPromotion.ProcessRecord"> <summary> 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.DatasetManager.RevokeDatasetPromotion.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.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.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="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.UpdateDatasetInformation.DatastoreURI"> <summary> The datastore URI where the dataset is contained. </summary> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.UpdateDatasetInformation.AccessToken"> <summary> The Access Token to use for authentication. </summary> </member> <member name="P:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.UpdateDatasetInformation.Force"> <summary> The `-Force` parameter is used to skip user validation. </summary> </member> <member name="M:RTDP.CLI.PartnerCmdlets.Cmdlets.DatasetManager.UpdateDatasetInformation.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.DatasetManager.UpdateDatasetInformation.ProcessRecord"> <summary> 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.DatasetManager.UpdateDatasetInformation.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.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.GetAvailableDatastores"> <summary> The `Get-AvailableDatastores` cmdlet is used to list the datastores that are currently available in the Data Platform. Parameters: <list type="number"> <item>Datastores URI: the URI where available datastores reside in.</item> <item>Access Token: The Access Token received from the MSAL auth flow being ran.</item> </list> <c>There is also a -Force parameter to skip interactive validation (for automation purposes)</c> </summary> </member> <member name="P:RTDP.CLI.Common.Cmdlets.AppResourcesAPI.GetAvailableDatastores.ResourceURI"> <summary> The URI for the datastores location. </summary> </member> <member name="P:RTDP.CLI.Common.Cmdlets.AppResourcesAPI.GetAvailableDatastores.AccessToken"> <summary> The Access Token to query the available data stores. </summary> </member> <member name="P:RTDP.CLI.Common.Cmdlets.AppResourcesAPI.GetAvailableDatastores.Force"> <summary> The Force parameter. This parameter is optional and skips the confirmation prompt. </summary> </member> <member name="M:RTDP.CLI.Common.Cmdlets.AppResourcesAPI.GetAvailableDatastores.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.Common.Cmdlets.AppResourcesAPI.GetAvailableDatastores.ProcessRecord"> <summary> 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.Common.Cmdlets.AppResourcesAPI.GetAvailableDatastores.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.Cmdlets.AppResourcesAPI.GetDatastoreTables"> <summary> The Get-DatastoreTables cmdlet is used to list all the available tables in a datastore. Parameters: <list type="number"> <item>Internal Resource ID: The specified datastore internal resource ID that will be queried.</item> <item>Datastores URI: the URI where the dataset is located.</item> <item>Access Token: The Access Token received from an MSAL auth flow being ran.</item> </list> <c>There is also a -Force parameter to skip interactive validation (for automation purposes)</c> </summary> </member> <member name="P:RTDP.CLI.Common.Cmdlets.AppResourcesAPI.GetDatastoreTables.InternalResourceID"> <summary> The specified datastore internal resource ID. </summary> </member> <member name="P:RTDP.CLI.Common.Cmdlets.AppResourcesAPI.GetDatastoreTables.ResourceURI"> <summary> The URI for the datastores location. </summary> </member> <member name="P:RTDP.CLI.Common.Cmdlets.AppResourcesAPI.GetDatastoreTables.AccessToken"> <summary> The Access Token to query the dataset tables. </summary> </member> <member name="P:RTDP.CLI.Common.Cmdlets.AppResourcesAPI.GetDatastoreTables.Force"> <summary> The -Force flag used to skip user validation. This parameter is optional and skips the confirmation prompt. </summary> </member> <member name="M:RTDP.CLI.Common.Cmdlets.AppResourcesAPI.GetDatastoreTables.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.Common.Cmdlets.AppResourcesAPI.GetDatastoreTables.ProcessRecord"> <summary> 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.Common.Cmdlets.AppResourcesAPI.GetDatastoreTables.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.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.DatasetId"> <summary> The ID of the dataset to add a record to. </summary> </member> <member name="P:RTDP.CLI.Common.Cmdlets.DataServer.AddDatasetRecord.DatastoreURI"> <summary> The Datastore URI to perform the POST to. </summary> </member> <member name="P:RTDP.CLI.Common.Cmdlets.DataServer.AddDatasetRecord.AccessToken"> <summary> The Access Token to authenticate the request. </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="P:RTDP.CLI.Common.Cmdlets.DataServer.AddDatasetRecord.Force"> <summary> The `-Force` parameter is used to skip user validation. </summary> </member> <member name="M:RTDP.CLI.Common.Cmdlets.DataServer.AddDatasetRecord.BeginProcessing"> <summary> The method `Begin Processing` is called before any input is processed. </summary> </member> <member name="M:RTDP.CLI.Common.Cmdlets.DataServer.AddDatasetRecord.ProcessRecord"> <summary> The method `Process Record` is called for each input object. </summary> </member> <member name="M:RTDP.CLI.Common.Cmdlets.DataServer.AddDatasetRecord.EndProcessing"> <summary> The method `End Processing` is called after all input has been processed. </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.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.DatastoreURI"> <summary> The Datastore URI where the dataset is contained. </summary> </member> <member name="P:RTDP.CLI.Common.Cmdlets.DataServer.GetDatasetContent.AccessToken"> <summary> The partner Access Token to use for the request. </summary> </member> <member name="P:RTDP.CLI.Common.Cmdlets.DataServer.GetDatasetContent.Force"> <summary> The `-Force` parameter is used to skip user validation. </summary> </member> <member name="M:RTDP.CLI.Common.Cmdlets.DataServer.GetDatasetContent.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.Common.Cmdlets.DataServer.GetDatasetContent.ProcessRecord"> <summary> 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.Common.Cmdlets.DataServer.GetDatasetContent.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.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.DatasetId"> <summary> The ID of the dataset to retrieve the schema for. </summary> </member> <member name="P:RTDP.CLI.Common.Cmdlets.DataServer.GetDatasetSchema.DatastoreURI"> <summary> The Datastore URI where the dataset is contained. </summary> </member> <member name="P:RTDP.CLI.Common.Cmdlets.DataServer.GetDatasetSchema.AccessToken"> <summary> The partner Access Token to use for the request. </summary> </member> <member name="P:RTDP.CLI.Common.Cmdlets.DataServer.GetDatasetSchema.Force"> <summary> The `-Force` parameter is used to skip user validation. </summary> </member> <member name="M:RTDP.CLI.Common.Cmdlets.DataServer.GetDatasetSchema.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.Common.Cmdlets.DataServer.GetDatasetSchema.ProcessRecord"> <summary> 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.Common.Cmdlets.DataServer.GetDatasetSchema.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.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.GetDatasetManagerEndpoint(RTDP.CLI.Common.EndpointEnvironment)"> <summary> Gets the endpoint for the Dataset Manager service. </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.GetAppResourcesEndpoint(RTDP.CLI.Common.EndpointEnvironment)"> <summary> Gets the endpoint for the Data Server service. </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.GetDataServerEndpoint(RTDP.CLI.Common.EndpointEnvironment)"> <summary> Gets the endpoint for the Data Server service. </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.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.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.PSCmdletExtensions"> <summary> Extension methods for PowerShell Cmdlets </summary> </member> <member name="M:RTDP.CLI.Common.PSCmdletExtensions.WriteResponse(System.Management.Automation.PSCmdlet,System.Net.Http.HttpResponseMessage)"> <summary> Writes the HTTP Response Message to the host PowerShell console. </summary> <param name="cmdlet"></param> <param name="response"></param> </member> <member name="M:RTDP.CLI.Common.PSCmdletExtensions.CalculateAccessToken(System.Management.Automation.PSCmdlet,System.String)"> <summary> Validates that the Access Token parameter is filled. </summary> <param name="cmdlet"></param> <param name="accessToken"></param> </member> <member name="M:RTDP.CLI.Common.PSCmdletExtensions.EndProcessingExtension(System.Management.Automation.PSCmdlet)"> <summary> End Processing Extension Method that contains additional information about the ran command. </summary> <param name="cmdlet"></param> </member> <member name="M:RTDP.CLI.Common.PSCmdletExtensions.BuildClientAndReturnResponse(System.Management.Automation.PSCmdlet,System.Uri,System.String,System.Net.Http.HttpMethod,System.String)"> <summary> Build a Http Client and send a request. </summary> <param name="cmdlet"></param> <param name="endpoint"></param> <param name="accessToken"></param> <param name="method"></param> <param name="payload"></param> <returns>Returns a Http Response message object.</returns> </member> <member name="M:RTDP.CLI.Common.PSCmdletExtensions.BuildInteractiveTextPrompt(System.Management.Automation.PSCmdlet)"> <summary> Build the interactive text prompt for user validation, based on the cmdlet public parameters values, using C# Attribute Reflection. </summary> <param name="cmdlet"></param> <returns>A string that contains the parameter name and paramter value, for each parameters found, excl. Access Token and Force parameters.</returns> </member> </members> </doc> |