diff --git a/README.md b/README.md index 76cfc2d..0a12121 100644 --- a/README.md +++ b/README.md @@ -18,11 +18,13 @@ https://www.powershellgallery.com/packages/Microsoft.Xrm.DevOps.Data.PowerShell/ $anotherPackage = Get-CrmDataPackage -Conn $Conn -Fetches @(""); Get-CrmDataPackage -Conn $Conn -Fetches ` @("", "") ` - | Add-CrmDataPackage -Conn $Conn -Fetches @("") ` + | Add-FetchesToCrmDataPackage -Conn $Conn -Fetches @("") ` | Merge-CrmDataPackage -AdditionalPackage $anotherPackage ` + | Remove-CrmDataPackage -RemovePackage $anotherPackage ` | Export-CrmDataPackage -ZipPath $env:USERPROFILE\Downloads\testrun.zip Get-CrmDataPackage -Conn $Conn -Fetches @("") -Identifiers @{ "contact" = @("firstname", "lastname", "birthdate") } -DisablePluginsGlobally $true | Export-CrmDataPackage -ZipPath "$env:USERPROFILE\Desktop\contacts.zip"; + ## Commands ### Get-CrmDataPackage Returns object CrmDataPackage used by this module @@ -37,9 +39,9 @@ https://www.powershellgallery.com/packages/Microsoft.Xrm.DevOps.Data.PowerShell/ -DisablePluginsGlobally Boolean e.g. $false; -### Add-CrmDataPackage +### Add-FetchesCrmDataPackage Returns object CrmDataPackage - Same as Get-CrmDataPackage except it can take a CrmDataPackage via pipe, or input Package + Takes a CrmDataPackage input from pipeline or variable as well as the inputs Get-CrmDataPackage takes. ### Merge-CrmDataPackage Returns object CrmDataPackage @@ -48,7 +50,16 @@ https://www.powershellgallery.com/packages/Microsoft.Xrm.DevOps.Data.PowerShell/ ### Export-CrmDataPackage Returns nothing. -Package takes a CrmDataPackage - -ZipPath takes a "$env:USERPROFILE\Downloads\thedata.zip" + -ZipPath takes a path to the zip file where data will be saved. + +### Import-CrmDataPackage + Returns object CrmDataPackage + -ZipPath takes a path to the zip file that will be imported. + +### Remove-CrmDataPackage + Returns object CrmDataPackage + -SourcePackage is the package data will be removed from. + -RemovePackage is the package that will be removed. Identical attributes are first removed, and if an entity is empty it will then also be removed. ### CrmDataPackage Contains three XmlDocuments representing the three XML files that go in a Configuration Migration Data Package.