Set-VltPolicy

Set-VltPolicy

Create or update a policy with the given rules.

Comparable to the vault CLI 'policy-write' command.

Set-Policy [-Name] <string> [-Rules] <string> [-VaultAddress <string>] [-VaultProfile <string>] [-VaultSession <object>] [-VaultToken <string>] [<CommonParameters>]

If updating an existing policy, the entire contents of the existing policy rules definitions will be replaced.

-Name <string>
The name of the policy to create or update.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       true (ByPropertyName)

        Accept wildcard characters?  false

-Rules <string>
The rules content to write to the policy definition.

        Required?                    true

        Position?                    1

        Default value                

        Accept pipeline input?       true (ByPropertyName)

        Accept wildcard characters?  false

-VaultSession <object>
Specifies a Vault Session object that represents a connected-state container to a Vault server.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-vs <object>
Specifies a Vault Session object that represents a connected-state container to a Vault server.

This is an alias of the VaultSession parameter.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-VaultProfile <string>
Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.

Other connection parameters on this command may override whatever attributes are defined in the profile.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-vp <string>
Specifies the name of a persisted Vault connection profile whose attributes define default parameters for connecting to a Vault server endpoint.

Other connection parameters on this command may override whatever attributes are defined in the profile.

This is an alias of the VaultProfile parameter.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-VaultAddress <string>
Specifies the Vault server connection endpoint URL.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-va <string>
Specifies the Vault server connection endpoint URL.

This is an alias of the VaultAddress parameter.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-VaultToken <string>
Specifies the Vault server connection authentication token to identify the caller to the server.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-vt <string>
Specifies the Vault server connection authentication token to identify the caller to the server.

This is an alias of the VaultToken parameter.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

<CommonParameters>

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

        OutBuffer, PipelineVariable, and OutVariable. For more information, see 

        about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). 

System.String

        The name of the policy to create or update.

System.String

        The rules content to write to the policy definition.

VaultSharp.Backends.System.Models.Secret`1[[System.Collections.Generic.Dictionary`2[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089],[System.Object, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]], mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]