Security Parameters
The following table lists the recommended names and functionality for parameters used to provide security information for an operation, such as parameters that specify certificate key and privilege information.
| Parameter | Functionality |
|---|---|
| ACL Data type: String |
Implement this parameter to specify the access control level of protection for a catalog or for a Uniform Resource Identifier (URI). |
| CertFile Data type: String |
Implement this parameter so that the user can specify the name of a file that contains one of the following: - A Base64 or Distinguished Encoding Rules (DER) encoded x.509 certificate - A Public Key Cryptography Standards (PKCS) #12 file that contains at least one certificate and key |
| CertIssuerName Data type: String |
Implement this parameter so that the user can specify the name of the issuer of a certificate or so that the user can specify a substring. |
| CertRequestFile Data type: String |
Implement this parameter to specify the name of a file that contains a Base64 or DER-encoded PKCS #10 certificate request. |
| CertSerialNumber Data type: String |
Implement this parameter to specify the serial number that was issued by the certification authority. |
| CertStoreLocation Data type: String |
Implement this parameter so that the user can specify the location of the certificate store. The location is typically a file path. |
| CertSubjectName Data type: String |
Implement this parameter so that the user can specify the issuer of a certificate or so that the user can specify a substring. |
| CertUsage Data type: String |
Implement this parameter to specify the key usage or the enhanced key usage. The key can be represented as a bit mask, a bit, an object identifier (OID), or a string. |
| Credential Data type: System.Management.Automation.PSCredential |
Implement this parameter so that the cmdlet will automatically prompt the user for a user name or password. A prompt for both is displayed if a full credential is not supplied directly. |
| CSPName Data type: String |
Implement this parameter so that the user can specify the name of the certificate service provider (CSP). |
| CSPType Data type: Integer |
Implement this parameter so that the user can specify the type of CSP. |
| Group Data type: String |
Implement this parameter so that the user can specify a collection of principals for access. For more information, see the description of the Principal parameter. |
| KeyAlgorithm Data type: String |
Implement this parameter so that the user can specify the key generation algorithm to use for security. |
| KeyContainerName Data type: String |
Implement this parameter so that the user can specify the name of the key container. |
| KeyLength Data type: Integer |
Implement this parameter so that the user can specify the length of the key in bits. |
| Operation Data type: String |
Implement this parameter so that the user can specify an action that can be performed on a protected object. |
| Principal Data type: String |
Implement this parameter so that the user can specify a unique identifiable entity for access. |
| Privilege Data type: String, String[] |
Implement this parameter so that the user can specify the rights a cmdlet needs to perform an operation for a particular entity. |
| Role Data type: String |
Implement this parameter so that the user can specify a set of operations that can be performed by an entity. |
| SaveCred Data type: SwitchParameter |
Implement this parameter so that credentials that were previously saved by the user will be used when the parameter is specified. |
| Scope Data type: String |
Implement this parameter so that the user can specify the group of protected objects for the cmdlet. |
| SID Data type: String |
Implement this parameter so that the user can specify a unique identifier that represents a principal. |
| Trusted Data type: SwitchParameter |
Implement this parameter so that trust levels are supported when the parameter is specified. |
| TrustLevel Data type: Keyword |
Implement this parameter so that the user can specify the trust level that is supported. For example, possible values include internet, intranet, and fulltrust. |
See Also
Collaborate with us on GitHub
The source for this content can be found on GitHub, where you can also create and review issues and pull requests. For more information, see our contributor guide.
