SecretDependencies - class conversion

thycotic-ps · Jul 26, 2021 · 33f8300 · 33f8300
1 parent 1036884
commit 33f8300
Show file tree

Hide file tree

Showing 56 changed files with 314 additions and 352 deletions.
diff --git a/...dependencies/about_tsssecretdependency.md → ..._topics/secret-dependencies/Dependency.md b/...dependencies/about_tsssecretdependency.md → ..._topics/secret-dependencies/Dependency.md
@@ -1,18 +1,18 @@
 ---
-title: "TssSecretDependency"
+title: "Dependency"
 ---
 
 # TOPIC
-    This help topic describes the TssSecretDependency class in the Thycotic.SecretServer module
+    This help topic describes the Thycotic.PowerShell.SecretDependencies.Dependency class in the Thycotic.SecretServer module
 
 # CLASS
-    TssSecretDependency
+    Thycotic.PowerShell.SecretDependencies.Dependency
 
 # INHERITANCE
     None
 
 # DESCRIPTION
-    The TssSecretDependency class represents the SecretDependencyModel object returned by Secret Server endpoint GET /secret-dependencies/{id}
+    The Thycotic.PowerShell.SecretDependencies.Dependency class represents the SecretDependencyModel object returned by Secret Server endpoint GET /secret-dependencies/{id}
 
 # CONSTRUCTORS
     new()
@@ -30,7 +30,7 @@ title: "TssSecretDependency"
     ConditionMode: string
         Condition Mode governs if this dependency's run relies on the result of other dependencies above it. The Default is ALWAYSRUN. Other values maybe 'All Pass', 'Any Fail', 'DEPENDENCYPASS', 'DEPENDENCYFAIL'.
 
-    DependencyTemplate: SecretDependencyTemplate
+    DependencyTemplate: DependencyTemplate
         The DependencyTemplate properties that are populated if the Dependency is based on a Dependency template.
 
     Description: string
@@ -61,7 +61,7 @@ title: "TssSecretDependency"
         The Name of the Secret that the Secret Dependency is assigned to.
 
     Settings: object[]
-        The Settings used by the Secret Dependency. (Ex: WaitBeforeSeconds, Database, Port, SSHKeyDigest). If a setting exists with the same name (or intent in the case of Port and SqlPort) as a field on the Dependency template's DependencyScanItemFields collection, the value assigned to the setting takes precidence and will overwrite the corresponding DependencyScanItemField.
+        The Settings used by the Secret Dependency. (Ex: WaitBeforeSeconds, Database, Port, SSHKeyDigest). If a setting exists with the same name (or intent in the case of Port and SqlPort) as a field on the Dependency template's DependencyScanItemFields collection, the value assigned to the setting takes precedence and will overwrite the corresponding DependencyScanItemField.
 
     SortOrder: integer (int32)
         The sort order of the Secret Dependency in the group. Determines the order of execution of the dependencies within a group.

diff --git a/...cies/about_tsssecretdependencytemplate.md → ...secret-dependencies/DependencyTemplate.md b/...cies/about_tsssecretdependencytemplate.md → ...secret-dependencies/DependencyTemplate.md
@@ -1,18 +1,18 @@
 ---
-title: "TssSecretDependencyTemplate"
+title: "DependencyTemplate"
 ---
 
 # TOPIC
-    This help topic describes the TssSecretDependencyTemplate class in the Thycotic.SecretServer module
+    This help topic describes the Thycotic.PowerShell.SecretDependencies.DependencyTemplate class in the Thycotic.SecretServer module
 
 # CLASS
-    TssSecretDependencyTemplate
+    Thycotic.PowerShell.SecretDependencies.DependencyTemplate
 
 # INHERITANCE
     None
 
 # DESCRIPTION
-    The TssSecretDependencyTemplate class represents the SecretDependencyTemplate object returned by Secret Server endpoint GET /secret-dependencies/stub
+    The Thycotic.PowerShell.SecretDependencies.DependencyTemplate class represents the SecretDependencyTemplate object returned by Secret Server endpoint GET /secret-dependencies/stub
 
 # CONSTRUCTORS
     new()
@@ -21,7 +21,7 @@ title: "TssSecretDependencyTemplate"
     ChangerScriptId: integer (int32)
         The id of the script (if any) used by the Dependency Template
 
-    DependencyScanItemFields: TssSecretDependencyScanItemFields[]
+    DependencyScanItemFields: ScanItemFields[]
         The Scan Item Fields used by the Dependency Template
 
     ScriptName: string
@@ -36,5 +36,4 @@ title: "TssSecretDependencyTemplate"
 # METHODS
 
 # RELATED LINKS:
-    TssSecretDependency
     Get-TssSecretDependencyStub
diff --git a/...dencies/about_tsssecretdependencygroup.md → ...about_topics/secret-dependencies/Group.md b/...dencies/about_tsssecretdependencygroup.md → ...about_topics/secret-dependencies/Group.md
@@ -1,18 +1,18 @@
 ---
-title: "TssSecretDependencyGroup"
+title: "Group"
 ---
 
 # TOPIC
-    This help topic describes the TssSecretDependencyGroup class in the Thycotic.SecretServer module
+    This help topic describes the Thycotic.PowerShell.SecretDependencies.Group class in the Thycotic.SecretServer module
 
 # CLASS
-    TssSecretDependencyGroup
+    Thycotic.PowerShell.SecretDependencies.Group
 
 # INHERITANCE
     None
 
 # DESCRIPTION
-    The TssSecretDependencyGroup class represents the SecretDependencyGroup object returned by Secret Server endpoint POST /secret-dependencies/groups/{secretId}
+    The Thycotic.PowerShell.SecretDependencies.Group class represents the SecretDependencyGroup object returned by Secret Server endpoint POST /secret-dependencies/groups/{secretId}
 
 # CONSTRUCTORS
     new()

diff --git a/...ies/about_tsssecretdependencyrunscript.md → ...t_topics/secret-dependencies/RunScript.md b/...ies/about_tsssecretdependencyrunscript.md → ...t_topics/secret-dependencies/RunScript.md
@@ -1,18 +1,18 @@
 ---
-title: "TssSecretDependencyRunScript"
+title: "RunScript"
 ---
 
 # TOPIC
-    This help topic describes the TssSecretDependencyRunScript class in the Thycotic.SecretServer module
+    This help topic describes the Thycotic.PowerShell.SecretDependencies.RunScript class in the Thycotic.SecretServer module
 
 # CLASS
-    TssSecretDependencyRunScript
+    Thycotic.PowerShell.SecretDependencies.RunScript
 
 # INHERITANCE
     None
 
 # DESCRIPTION
-    The TssSecretDependencyRunScript class represents the SecretDependencyRunScript object returned by Secret Server endpoint GET /secret-dependencies/stub
+    The Thycotic.PowerShell.SecretDependencies.RunScript class represents the SecretDependencyRunScript object returned by Secret Server endpoint GET /secret-dependencies/stub
 
 # CONSTRUCTORS
     new()
@@ -39,5 +39,4 @@ title: "TssSecretDependencyRunScript"
 # METHODS
 
 # RELATED LINKS:
-    TssSecretDependency
     Get-TssSecretDependencyRunScriptStub
diff --git a/docs/about_topics/secret-dependencies/ScanItemFields.md b/docs/about_topics/secret-dependencies/ScanItemFields.md
@@ -0,0 +1,36 @@
+---
+title: "ScanItemFields"
+---
+
+# TOPIC
+    This help topic describes the Thycotic.PowerShell.SecretDependencies.ScanItemFields class in the Thycotic.SecretServer module
+
+# CLASS
+    Thycotic.PowerShell.SecretDependencies.ScanItemFields
+
+# INHERITANCE
+    None
+
+# DESCRIPTION
+    The Thycotic.PowerShell.SecretDependencies.ScanItemFields class represents the SecretDependencyScanItemField object returned by Secret Server endpoint GET /secret-dependencies/stub
+
+# CONSTRUCTORS
+    new()
+
+# PROPERTIES
+    Id: integer (int32)
+        Id of the ScanItemField
+
+    Name: string
+        Name of the ScanItemField
+
+    ParentName: string
+        ScanItemField Parent name. Will Match Name if no parent is inherited.
+
+    Value: string
+        Value of the ScanItemField
+
+# METHODS
+
+# RELATED LINKS:
+    Get-TssSecretDependencyStub
diff --git a/...ncies/about_tsssecretdependencysummary.md → ...out_topics/secret-dependencies/Summary.md b/...ncies/about_tsssecretdependencysummary.md → ...out_topics/secret-dependencies/Summary.md
@@ -1,18 +1,18 @@
 ---
-title: "TssSecretDependencyGroup"
+title: "Summary"
 ---
 
 # TOPIC
-    This help topic describes the TssSecretDependencySummary class in the Thycotic.SecretServer module
+    This help topic describes the Thycotic.PowerShell.SecretDependencies.Summary class in the Thycotic.SecretServer module
 
 # CLASS
-    TssSecretDependencySummary
+    Thycotic.PowerShell.SecretDependencies.Summary
 
 # INHERITANCE
     None
 
 # DESCRIPTION
-    The TssSecretDependencySummary class represents the SecretDependencySummary object returned by Secret Server endpoint GET /secret-dependencies
+    The Thycotic.PowerShell.SecretDependencies.Summary class represents the SecretDependencySummary object returned by Secret Server endpoint GET /secret-dependencies
 
 # CONSTRUCTORS
     new()

diff --git a/docs/about_topics/secret-dependencies/TaskError.md b/docs/about_topics/secret-dependencies/TaskError.md
@@ -0,0 +1,30 @@
+---
+title: "TaskError"
+---
+
+# TOPIC
+    This help topic describes the Thycotic.PowerShell.SecretDependencies.TaskError class in the Thycotic.SecretServer module
+
+# CLASS
+    Thycotic.PowerShell.SecretDependencies.TaskError
+
+# INHERITANCE
+    None
+
+# DESCRIPTION
+    The Thycotic.PowerShell.SecretDependencies.TaskError class represents the TaskError object returned by Secret Server endpoint GET /secret-dependencies/run/{identifier}
+
+# CONSTRUCTORS
+    new()
+
+# PROPERTIES
+    ErrorMessage: string
+        The error message
+
+    ItemName: string
+        The name of the item that had the error
+
+# METHODS
+
+# RELATED LINKS:
+    Get-TssSecretDependencyRunStatus
diff --git a/.../about_tsssecretdependencytaskprogress.md → ...opics/secret-dependencies/TaskProgress.md b/.../about_tsssecretdependencytaskprogress.md → ...opics/secret-dependencies/TaskProgress.md
@@ -1,24 +1,24 @@
 ---
-title: "TssSecretDependencyTaskProgress"
+title: "TaskProgress"
 ---
 
 # TOPIC
-    This help topic describes the TssSecretDependencyTaskProgress class in the Thycotic.SecretServer module
+    This help topic describes the Thycotic.PowerShell.SecretDependencies.TaskProgress class in the Thycotic.SecretServer module
 
 # CLASS
-    TssSecretDependencyTaskProgress
+    Thycotic.PowerShell.SecretDependencies.TaskProgress
 
 # INHERITANCE
     None
 
 # DESCRIPTION
-    The TssSecretDependencyTaskProgress class represents the TaskProgress object returned by Secret Server endpoint GET /secret-dependencies/run
+    The Thycotic.PowerShell.SecretDependencies.TaskProgress class represents the TaskProgress object returned by Secret Server endpoint GET /secret-dependencies/run
 
 # CONSTRUCTORS
     new()
 
 # PROPERTIES
-    Errors: TssSecretDependencyTaskError[]
+    Errors: TaskError[]
         A list of errors for the task
 
     IsComplete: boolean

diff --git a/...pendencies/about_tssdependencytemplate.md → ...ut_topics/secret-dependencies/Template.md b/...pendencies/about_tssdependencytemplate.md → ...ut_topics/secret-dependencies/Template.md
@@ -1,18 +1,18 @@
 ---
-Title: "TssDependencyTemplate"
+Title: "Template"
 ---
 
 # TOPIC
-    This help topic describes the TssDependencyTemplate class in the Thycotic.SecretServer module
+    This help topic describes the Thycotic.PowerShell.SecretDependencies.Template class in the Thycotic.SecretServer module
 
 # CLASS
-    TssDependencyTemplate
+    Thycotic.PowerShell.SecretDependencies.Template
 
 # INHERITANCE
     None
 
 # DESCRIPTION
-    The TssDependencyTemplate class represents the DependencyTemplate object returned by Secret Server endpoint GET /secret-dependencies/templates
+    The Thycotic.PowerShell.SecretDependencies.Template class represents the DependencyTemplate object returned by Secret Server endpoint GET /secret-dependencies/templates
 
 # CONSTRUCTORS
     new()

diff --git a/docs/about_topics/secret-dependencies/about_tsssecretdependencyscanitemfields.md b/docs/about_topics/secret-dependencies/about_tsssecretdependencyscanitemfields.md
diff --git a/docs/about_topics/secret-dependencies/about_tsssecretdependencytaskerror.md b/docs/about_topics/secret-dependencies/about_tsssecretdependencytaskerror.md
diff --git a/docs/about_topics/secret-dependencies/readme.md b/docs/about_topics/secret-dependencies/readme.md
@@ -1,3 +1,3 @@
-# Secret Dependencies
+# Thycotic.PowerShell.SecretDependencies
 
 {% include list.liquid all=true %}
diff --git a/docs/commands/secret-dependencies/Get-TssSecretDependency.md b/docs/commands/secret-dependencies/Get-TssSecretDependency.md
@@ -61,7 +61,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 
 ## OUTPUTS
 
-### TssSecretDependency
+### Thycotic.PowerShell.SecretDependencies.Dependency
 ## NOTES
 Requires TssSession object returned by New-TssSession
 

diff --git a/docs/commands/secret-dependencies/Get-TssSecretDependencyGroup.md b/docs/commands/secret-dependencies/Get-TssSecretDependencyGroup.md
@@ -61,7 +61,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 
 ## OUTPUTS
 
-### TssSecretDependencyGroup
+### Thycotic.PowerShell.SecretDependencies.Group
 ## NOTES
 Requires TssSession object returned by New-TssSession
 

diff --git a/docs/commands/secret-dependencies/Get-TssSecretDependencyRunStatus.md b/docs/commands/secret-dependencies/Get-TssSecretDependencyRunStatus.md
@@ -62,7 +62,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 
 ## OUTPUTS
 
-### TssSecretDependencyTaskProgress
+### Thycotic.PowerShell.SecretDependencies.TaskProgress
 ## NOTES
 Requires TssSession object returned by New-TssSession
 

diff --git a/docs/commands/secret-dependencies/Get-TssSecretDependencyStub.md b/docs/commands/secret-dependencies/Get-TssSecretDependencyStub.md
@@ -115,7 +115,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 
 ## OUTPUTS
 
-### TssSecretDependencyStub
+### Thycotic.PowerShell.SecretDependencies.Dependency
 ## NOTES
 Requires TssSession object returned by New-TssSession