ACMESharp.POSH.xml
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 |
<?xml version="1.0"?>
<doc> <assembly> <name>ACMESharp.POSH</name> </assembly> <members> <member name="T:ACMESharp.POSH.GetCertificate"> <summary> <para type="synopsis"> Gets the status and details of a Certificate stored in the Vault. </para> <para type="description"> This cmdlet retrieves the details of a Certificate defined in the Vault. It is also used to export various artificates associated with the Certificate to various formats. </para> <para type="link">New-Certificate</para> <para type="link">Submit-Certificate</para> <para type="link">Update-Certificate</para> </summary> </member> <member name="P:ACMESharp.POSH.GetCertificate.CertificateRef"> <summary> <para type="description"> A reference (ID or alias) to a previously defined Certificate request. </para> </summary> </member> <member name="P:ACMESharp.POSH.GetCertificate.ExportKeyPEM"> <summary> <para type="description"> Optionally, specifies a file path where the private key associated with the referenced Certificate will be saved in PEM format. </para> </summary> </member> <member name="P:ACMESharp.POSH.GetCertificate.ExportCsrPEM"> <summary> <para type="description"> Optionally, specifies a file path where the CSR associated with the referenced Certificate will be saved in PEM format. </para> </summary> </member> <member name="P:ACMESharp.POSH.GetCertificate.ExportCertificatePEM"> <summary> <para type="description"> Optionally, specifies a file path where the referenced Certificate will be saved in PEM format. </para> </summary> </member> <member name="P:ACMESharp.POSH.GetCertificate.ExportCertificateDER"> <summary> <para type="description"> Optionally, specifies a file path where the referenced Certificate will be saved in DER format. </para> </summary> </member> <member name="P:ACMESharp.POSH.GetCertificate.ExportIssuerPEM"> <summary> <para type="description"> Optionally, specifies a file path where the referenced Issuer Certificate will be saved in PEM format. </para> </summary> </member> <member name="P:ACMESharp.POSH.GetCertificate.ExportIssuerDER"> <summary> <para type="description"> Optionally, specifies a file path where the referenced Issuer Certificate will be saved in DER format. </para> </summary> </member> <member name="P:ACMESharp.POSH.GetCertificate.ExportPkcs12"> <summary> <para type="description"> Optionally, specifies a file path where the referenced Certificate and related artifacts will be saved into a PKCS#12 archive format. </para> </summary> </member> <member name="P:ACMESharp.POSH.GetCertificate.CertificatePassword"> <summary> <para type="description"> Optionally, specifies a password to use to secure an exported PKCS#12 archive file. </para> </summary> </member> <member name="P:ACMESharp.POSH.GetCertificate.Overwrite"> <summary> <para type="description"> This flag indicates that any existing files matching any of the requested export parameter paths will be overwritten. If not specified, existing files will cause this cmdlet to error. </para> </summary> </member> <member name="P:ACMESharp.POSH.GetCertificate.VaultProfile"> <summary> <para type="description"> Specifies a Vault profile name that will resolve to the Vault instance to be used for all related operations and storage/retrieval of all related assets. </para> </summary> </member> <member name="T:ACMESharp.POSH.GetIdentifier"> <summary> <para type="synopsis">Lists all, or retrieves details for, Identifiers submitted for verification.</para> <para type="description"> Use this cmdlet to list all of the Identifier that have been previously defined and submitted to the ACME CA Server of the current Vault. You also use this cmdlet to specify specific Identifier references (ID or alias) to retrieve more specific details as they are captured in the Vault. </para> <para type="link">New-Identifier</para> <para type="link">Update-Identifier</para> </summary> </member> <member name="P:ACMESharp.POSH.GetIdentifier.IdentifierRef"> <summary> <para type="description"> A reference (ID or alias) to a previously defined Identifier submitted to the ACME CA Server for verification. </para> </summary> </member> <member name="P:ACMESharp.POSH.GetIdentifier.VaultProfile"> <summary> <para type="description"> Specifies a Vault profile name that will resolve to the Vault instance to be used for all related operations and storage/retrieval of all related assets. </para> </summary> </member> <member name="T:ACMESharp.POSH.CompleteChallenge"> <summary> <para type="synopsis">Completes a Challenge using a prescribed Handler.</para> <para type="description"> Use this cmdlet to complete a Challenge associated with an Identifier defined in an ACMESharp Vault that has been submitted for verification to an ACME CA Server. </para> <para type="link">Get-ChallengeHandlerProfile</para> <para type="link">Set-ChallengeHandlerProfile</para> </summary> </member> <member name="P:ACMESharp.POSH.CompleteChallenge.IdentifierRef"> <summary> <para type="description"> A reference (ID or alias) to a previously defined Identifier submitted to the ACME CA Server for verification. </para> </summary> </member> <member name="P:ACMESharp.POSH.CompleteChallenge.HandlerProfileRef"> <summary> <para type="description"> Specifies a reference (ID or alias) to a previously defined Challenge Handler profile in the associated Vault that defines the Handler provider and associated instance parameters that should be used to resolve the Challenge. </para> </summary> </member> <member name="P:ACMESharp.POSH.CompleteChallenge.ChallengeType"> <summary> <para type="description"> Specifies the ACME Challenge type that should be handled. This type is expected to be found in the list of Challenges returned by the ACME CA Server for the associated Identifier. </para> </summary> </member> <member name="P:ACMESharp.POSH.CompleteChallenge.Handler"> <summary> <para type="description"> Specifies the Challenge Handler instance provider that will be used to handle the associated Challenge. </para> </summary> </member> <member name="P:ACMESharp.POSH.CompleteChallenge.HandlerParameters"> <summary> <para type="description"> Specifies the parameters that will be passed to the Challenge Handler instance that will be used to handle the associated Challenge. </para> <para type="description"> If this cmdlet is invoked *in-line*, then these are the only parameters that will be passed to the handler. If this cmdlet is invoked with a handler profile reference, then these parameters are merged with, and override, whatever parameters are already defined within the profile. </para> </summary> </member> <member name="P:ACMESharp.POSH.CompleteChallenge.CleanUp"> <summary> <para type="description"> When specified, executes the <i>clean up</i> operation associated with the resolved Challenge Handler. This is typcially invoked after the challenge has been previously successfully completed and submitted to the ACME server, and is used to remove any residual resources or traces of the steps that were needed during the challenge-handling process. </para> </summary> </member> <member name="P:ACMESharp.POSH.CompleteChallenge.Regenerate"> <summary> <para type="description"> When specified, will force the decoding and regeneration of any ACME-defined heuristics and parameters for the given Challenge type. </para> </summary> </member> <member name="P:ACMESharp.POSH.CompleteChallenge.Repeat"> <summary> <para type="description"> When specified, forces the resolved Handler to repeat the process of handling the given Challenge, even if the process has already been completed previously. </para> </summary> </member> <member name="P:ACMESharp.POSH.CompleteChallenge.UseBaseUri"> <summary> <para type="description"> Overrides the base URI associated with the target Registration and used for subsequent communication with the associated ACME CA Server. </para> </summary> </member> <member name="P:ACMESharp.POSH.CompleteChallenge.VaultProfile"> <summary> <para type="description"> Specifies a Vault profile name that will resolve to the Vault instance to be used for all related operations and storage/retrieval of all related assets. </para> </summary> </member> <!-- Badly formed XML comment ignored for member "T:ACMESharp.POSH.NewCertificate" --> <member name="P:ACMESharp.POSH.NewCertificate.IdentifierRef"> <summary> <para type="description"> A reference (ID or alias) to a previously defined and authorized Identifier verified by the ACME CA Server. </para> </summary> </member> <member name="P:ACMESharp.POSH.NewCertificate.KeyPemFile"> <summary> <para type="description"> Specifies an existing private key in PEM file format that should be used to generate the Certificate Request. </para> </summary> </member> <member name="P:ACMESharp.POSH.NewCertificate.CsrPemFile"> <summary> <para type="description"> Specifies an existing CSR in PEM file format containing all the details of the Certificate that should be used to generate the Certificate Request. </para> </summary> </member> <member name="P:ACMESharp.POSH.NewCertificate.Generate"> <summary> <para type="description"> Indicates that new Certificate Request parameters and artificats should be generated. </para> </summary> </member> <member name="P:ACMESharp.POSH.NewCertificate.CsrDetails"> <summary> <para type="description"> An optional set of certificate details to be included in the generated CSR. </para> <para type="description"> The common name will be set based on the DNS name of the associated Identifier, however all other details will be specified as set in this parameter. The following elements are defined, however not all of these may be supported or honored by the target ACME CA Server: * Country; // C; * StateOrProvince; // ST; * Locality; // L; * Organization; // O; * OrganizationUnit; // OU; * Description; // D; * Surname; // S; * GivenName; // G; * Initials; // I; * Title; // T; * SerialNumber; // SN; * UniqueIdentifier; // UID; * AlternativeNames; // X509 SAN Extension (manually overridden) </para> <para type="description"> For any elements that except multiple values (such as SAN), specify a string of values separated by space, comma or semicolon </para> </summary> </member> <member name="P:ACMESharp.POSH.NewCertificate.AlternativeIdentifierRefs"> <summary> <para type="description"> A collection of one or more references (ID or alias) to previously defined and authorized Identifiers verified by the ACME CA Server which will be included in the X509 extension for the list of Subject Alternative Names (SAN). </para> <para type="description"> There is no need to repeat the reference to the primary common name Identifier as it will be automatically included at the start of this list. </para> </summary> </member> <member name="P:ACMESharp.POSH.NewCertificate.Alias"> <summary> <para type="description"> An optional, unique alias to assign to the Certificate for future reference. </para> </summary> </member> <member name="P:ACMESharp.POSH.NewCertificate.Label"> <summary> <para type="description"> An optional, human-friendly label to assign to the Certificate for easy recognition. </para> </summary> </member> <member name="P:ACMESharp.POSH.NewCertificate.Memo"> <summary> <para type="description"> An optional, arbitrary text field to capture any notes or details associated with the Certificate. </para> </summary> </member> <member name="P:ACMESharp.POSH.NewCertificate.VaultProfile"> <summary> <para type="description"> Specifies a Vault profile name that will resolve to the Vault instance to be used for all related operations and storage/retrieval of all related assets. </para> </summary> </member> <member name="T:ACMESharp.POSH.NewIdentifier"> <summary> <para type="synopsis"> Creates and submits a new Identifier to be verified to the ACME CA Server. </para> <para type="description"> Currently, the only Identifier type supported is the DNS type. </para> <para type="link">Get-Identifier</para> <para type="link">Update-Identifier</para> <para type="link">Complete-Challenge</para> <para type="link">Submit-Challenge</para> </summary> </member> <member name="P:ACMESharp.POSH.NewIdentifier.Dns"> <summary> <para type="description"> Specifies the DNS name to be submitted for verification. </para> </summary> </member> <member name="P:ACMESharp.POSH.NewIdentifier.Alias"> <summary> <para type="description"> An optional, unique alias to assign to the Identifier for future reference. </para> </summary> </member> <member name="P:ACMESharp.POSH.NewIdentifier.Label"> <summary> <para type="description"> An optional, human-friendly label to assign to the Identifier for easy recognition. </para> </summary> </member> <member name="P:ACMESharp.POSH.NewIdentifier.Memo"> <summary> <para type="description"> An optional, arbitrary text field to capture any notes or details associated with the Identifier. </para> </summary> </member> <member name="P:ACMESharp.POSH.NewIdentifier.VaultProfile"> <summary> <para type="description"> Specifies a Vault profile name that will resolve to the Vault instance to be used for all related operations and storage/retrieval of all related assets. </para> </summary> </member> <member name="P:ACMESharp.POSH.SubmitCertificate.CertificateRef"> <summary> <para type="description"> A reference (ID or alias) to a previously defined Certificate request. </para> </summary> </member> <member name="P:ACMESharp.POSH.SubmitCertificate.VaultProfile"> <summary> <para type="description"> Specifies a Vault profile name that will resolve to the Vault instance to be used for all related operations and storage/retrieval of all related assets. </para> </summary> </member> <!-- Badly formed XML comment ignored for member "T:ACMESharp.POSH.SubmitChallenge" --> <member name="P:ACMESharp.POSH.SubmitChallenge.IdentifierRef"> <summary> <para type="description"> A reference (ID or alias) to a previously defined Identifier submitted to the ACME CA Server for verification. </para> </summary> </member> <member name="P:ACMESharp.POSH.SubmitChallenge.ChallengeType"> <summary> <para type="description"> Specifies the ACME Challenge type that should be submitted. This type is expected to be found in the list of Challenges returned by the ACME CA Server for the associated Identifier and it should already have been handled previously, either externally to the ACMESharp operations or via the Handler mechanisms within. </para> </summary> </member> <member name="P:ACMESharp.POSH.SubmitChallenge.UseBaseUri"> <summary> <para type="description"> Overrides the base URI associated with the target Registration and used for subsequent communication with the associated ACME CA Server. </para> </summary> </member> <member name="P:ACMESharp.POSH.SubmitChallenge.VaultProfile"> <summary> <para type="description"> Specifies a Vault profile name that will resolve to the Vault instance to be used for all related operations and storage/retrieval of all related assets. </para> </summary> </member> <member name="T:ACMESharp.POSH.UpdateCertificate"> <summary> <para type="synopsis"> Updates the status and details of a Certificate stored in the Vault. </para> <para type="description"> Use this cmdlet to update characteristics of an Identifier that are defined locally, such as the Alias or Label. </para> <para type="description"> Also use this cmdlet to refresh the state and status of a Certificate including retrieving the certificate and intermediate signing certificate from the associated ACME CA Server. </para> <para type="link">New-Certificate</para> <para type="link">Get-Certificate</para> <para type="link">Submit-Certificate</para> </summary> </member> <member name="P:ACMESharp.POSH.UpdateCertificate.CertificateRef"> <summary> <para type="description"> A reference (ID or alias) to a previously defined Certificate request. </para> </summary> </member> <member name="P:ACMESharp.POSH.UpdateCertificate.UseBaseUri"> <summary> <para type="description"> Overrides the base URI associated with the target Registration and used for subsequent communication with the associated ACME CA Server. </para> </summary> </member> <member name="P:ACMESharp.POSH.UpdateCertificate.Repeat"> <summary> <para type="description"> When specified, this flag instructs the cmdlet to repeat the retrieval of the issued certificate and related artifacts (e.g. intermediate signing cert). </para> </summary> </member> <member name="P:ACMESharp.POSH.UpdateCertificate.LocalOnly"> <summary> <para type="description"> Indicates that updates should be performed locally only, and no attempt should be made to retrieve the current status from the ACME CA Server. </para> </summary> </member> <member name="P:ACMESharp.POSH.UpdateCertificate.Alias"> <summary> <para type="description"> Optionaly, set or update the unique alias assigned to the Certificate for future reference. </para> </summary> </member> <member name="P:ACMESharp.POSH.UpdateCertificate.Label"> <summary> <para type="description"> Optionally, set or update the human-friendly label to assigned to the Certificate for easy recognition. </para> </summary> </member> <member name="P:ACMESharp.POSH.UpdateCertificate.Memo"> <summary> <para type="description"> Optionall, set or update the arbitrary text field used to capture any notes or details associated with the Certificate. </para> </summary> </member> <member name="P:ACMESharp.POSH.UpdateCertificate.VaultProfile"> <summary> <para type="description"> Specifies a Vault profile name that will resolve to the Vault instance to be used for all related operations and storage/retrieval of all related assets. </para> </summary> </member> <member name="T:ACMESharp.POSH.UpdateIdentifier"> <summary> <para type="synopsis"> Updates the status and details of an Identifier stored in the Vault. </para> <para type="description"> Use this cmdlet to update characteristics of an Identifier that are defined locally, such as the Alias or Label. </para> <para type="description"> Also use this cmdlet to refresh the state and status of an Identifier by probing the associated ACME CA Server for Identifier details. </para> <para type="link">New-Identifier</para> <para type="link">Get-Identifier</para> <para type="link">Complete-Challenge</para> <para type="link">Submit-Challenge</para> </summary> </member> <member name="P:ACMESharp.POSH.UpdateIdentifier.IdentifierRef"> <summary> <para type="description"> A reference (ID or alias) to a previously defined Identifier submitted to the ACME CA Server for verification. </para> </summary> </member> <member name="P:ACMESharp.POSH.UpdateIdentifier.ChallengeType"> <summary> <para type="description"> Specifies the ACME Challenge type that should be updated. </para> </summary> </member> <member name="P:ACMESharp.POSH.UpdateIdentifier.UseBaseUri"> <summary> <para type="description"> Overrides the base URI associated with the target Registration and used for subsequent communication with the associated ACME CA Server. </para> </summary> </member> <member name="P:ACMESharp.POSH.UpdateIdentifier.LocalOnly"> <summary> <para type="description"> Indicates that updates should be performed locally only, and no attempt should be made to retrieve the current status from the ACME CA Server. </para> </summary> </member> <member name="P:ACMESharp.POSH.UpdateIdentifier.Alias"> <summary> <para type="description"> Optionaly, set or update the unique alias assigned to the Identifier for future reference. </para> </summary> </member> <member name="P:ACMESharp.POSH.UpdateIdentifier.Label"> <summary> <para type="description"> Optionally, set or update the human-friendly label to assigned to the Identifier for easy recognition. </para> </summary> </member> <member name="P:ACMESharp.POSH.UpdateIdentifier.Memo"> <summary> <para type="description"> Optionall, set or update the arbitrary text field used to capture any notes or details associated with the Identifier. </para> </summary> </member> <member name="P:ACMESharp.POSH.UpdateIdentifier.VaultProfile"> <summary> <para type="description"> Specifies a Vault profile name that will resolve to the Vault instance to be used for all related operations and storage/retrieval of all related assets. </para> </summary> </member> <member name="M:ACMESharp.POSH.Util.PoshHelper.BeforeExtAccess"> <summary> This routine must be invoked from any CMDLET that relies on the Ext mechanism when running under POSH, but does not make use of Vault. </summary> </member> <member name="F:ACMESharp.POSH.Util.PoshHelper.PROBLEM_DETAIL_TYPE_URN"> <summary> Defines the well-defined ACME problem detail type URN prefix. </summary> </member> <member name="F:ACMESharp.POSH.Util.PoshHelper.PROBLEM_DETAIL_TYPE_TO_ERROR_CATEGORY"> <summary> Defines a mapping from well-defined ACME problem detail type URNs to POSH <see cref="T:System.Management.Automation.ErrorCategory">error categories</see>. </summary> <remarks> This list was compiled from: https://ietf-wg-acme.github.io/acme/#rfc.section.5.4 </remarks> </member> <member name="M:ACMESharp.POSH.Util.PoshHelper.CreateErrorRecord(ACMESharp.AcmeClient.AcmeWebException,System.Object)"> <summary> Constructs an <see cref="T:System.Management.Automation.ErrorRecord"/> from an <see cref="T:ACMESharp.AcmeClient.AcmeWebException"/>, populating as much detail as can be derived. </summary> <param name="ex"></param> <param name="targetObject"></param> <returns></returns> </member> </members> </doc> |