en-US/SecretBackup-Help.xml
|
<?xml version="1.0" encoding="utf-8"?> <helpItems xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" schema="maml" xmlns="http://msh"> <command:command> <command:details> <command:name>Export-Secret</command:name> <maml:description> <maml:para>Exports secrets from a specified vault to a JSON file.</maml:para> </maml:description> <command:verb>Export</command:verb> <command:noun>Secret</command:noun> </command:details> <maml:description> <maml:para>This function exports secrets from a specified vault to a JSON file. It retrieves secret information from the vault and converts it to a JSON format for export.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Export-Secret</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="none"> <maml:name>OutPath</maml:name> <maml:description> <maml:para>Specifies the output path where the JSON file will be saved. If not provided, the current location will be used as the default output path.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>VaultName</maml:name> <maml:description> <maml:para>Specifies the name of the vault from which to export secrets. This parameter is mandatory.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="none"> <maml:name>OutPath</maml:name> <maml:description> <maml:para>Specifies the output path where the JSON file will be saved. If not provided, the current location will be used as the default output path.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>VaultName</maml:name> <maml:description> <maml:para>Specifies the name of the vault from which to export secrets. This parameter is mandatory.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Exports secretes in plain text. Make sure you protect the exported data.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1: Exports secrets from the 'MyVault' vault and saves the JSON file to the 'C:\Backups' directory. ---------</maml:title> <maml:introduction> <maml:para>Export-Secret -VaultName 'MyVault' -OutPath 'C:\Backups'</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- EXAMPLE 2: Exports secrets from the 'MyVault' vault and saves the JSON file to the current location. ---------</maml:title> <maml:introduction> <maml:para>Export-Secret -VaultName 'MyVault'</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <command:uri /> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Import-Secret</command:name> <maml:description> <maml:para>Imports secrets from a backup file into a specified vault.</maml:para> </maml:description> <command:verb>Import</command:verb> <command:noun>Secret</command:noun> </command:details> <maml:description> <maml:para>This function imports secrets from a backup file (generated by same module) into a specified vault. It checks if the secret already exists in the vault and either adds it or updates it based on the OverWrite switch parameter.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Import-Secret</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="none"> <maml:name>BackupFile</maml:name> <maml:description> <maml:para>The path to the backup file containing the secrets to be imported.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>OverWrite</maml:name> <maml:description> <maml:para>A switch parameter that specifies whether existing secrets in the vault should be overwritten if they already exist.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.Management.Automation.SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>VaultName</maml:name> <maml:description> <maml:para>The name of the vault where the secrets will be imported.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="none"> <maml:name>BackupFile</maml:name> <maml:description> <maml:para>The path to the backup file containing the secrets to be imported.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>OverWrite</maml:name> <maml:description> <maml:para>A switch parameter that specifies whether existing secrets in the vault should be overwritten if they already exist.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.Management.Automation.SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>VaultName</maml:name> <maml:description> <maml:para>The name of the vault where the secrets will be imported.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- EXAMPLE 1: Imports secrets from the specified backup file into the "MyVault" vault, overwriting existing secrets if they already exist ---------</maml:title> <maml:introduction> <maml:para>Import-Secret -VaultName "MyVault" -BackupFile "C:\Path\to\backup.json" -OverWrite</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <command:uri /> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |