full_path
stringlengths 31
232
| filename
stringlengths 4
167
| content
stringlengths 0
48.3M
|
|---|---|---|
PowerShellCorpus/PowerShellGallery/biz.dfch.PS.Appclusive.Client/5.2.1.20161201/Remove-Node.ps1
|
Remove-Node.ps1
|
function Remove-Node {
<#
.SYNOPSIS
Removes a Node entry from the inventory.
.DESCRIPTION
Removes a Node entry from the inventory.
The Cmdlet lets you remove an existing Node entry from the Node inventory.
.INPUTS
The Cmdlet can either remove entities by id, by name or by object reference.
.OUTPUTS
default | json | json-pretty | xml | xml-pretty
.EXAMPLE
PS > Remove-Node $node
Removes the Node '$node' from the inventory.
.EXAMPLE
PS > Remove-Node -Id 42
Removes the Node with Id 42 from the inventory.
.EXAMPLE
PS > Remove-Node -Name 'ArbitraryName'
Removes the Node with Name 'ArbitraryName' from the inventory.
.LINK
Online Version: http://dfch.biz/biz/dfch/PS/Appclusive/Client/Remove-Node/
.NOTES
See module manifest for required software versions and dependencies.
#>
[CmdletBinding(
SupportsShouldProcess = $true
,
ConfirmImpact = 'High'
,
HelpURI = 'http://dfch.biz/biz/dfch/PS/Appclusive/Client/Remove-Node/'
,
DefaultParameterSetName = 'o'
)]
Param
(
# The id of the Node to remove
[Parameter(Mandatory = $true, Position = 0, ParameterSetName = 'id')]
[int] $Id
,
# The name of the Node to remove
[Parameter(Mandatory = $true, Position = 0, ParameterSetName = 'name')]
[string] $Name
,
# Specifies the Node to remove
[Parameter(Mandatory = $true, ValueFromPipeline = $true, Position = 0, ParameterSetName = 'o')]
[Alias("Entity")]
$InputObject
,
# Service reference to Appclusive
[Parameter(Mandatory = $false, Position = 1)]
[Alias('Services')]
[hashtable] $svc = (Get-Variable -Name $MyInvocation.MyCommand.Module.PrivateData.MODULEVAR -ValueOnly).Services
,
# Specifies the return format of the Cnmdlet
[ValidateSet('default', 'json', 'json-pretty', 'xml', 'xml-pretty')]
[Parameter(Mandatory = $false, Position = 2)]
[alias('ReturnFormat')]
[string] $As = 'default'
)
Begin
{
trap { Log-Exception $_; break; }
$datBegin = [datetime]::Now;
[string] $fn = $MyInvocation.MyCommand.Name;
Log-Debug -fn $fn -msg ("CALL. svc '{0}'. Name '{1}'." -f ($svc -is [Object]), $Name) -fac 1;
# Parameter validation
Contract-Requires ($svc.Core -is [biz.dfch.CS.Appclusive.Api.Core.Core]) "Connect to the server before using the Cmdlet"
}
# Begin
Process
{
trap { Log-Exception $_; break; }
# Default test variable for checking function response codes.
[Boolean] $fReturn = $false;
# Return values are always and only returned via OutputParameter.
$OutputParameter = $null;
if($PSCmdlet.ParameterSetName -eq 'id')
{
$InputObject = Get-Node -Id $Id -svc $svc;
}
if($PSCmdlet.ParameterSetName -eq 'name')
{
$InputObject = Get-Node -Name $Name -svc $svc;
}
$r = @();
$objectFoundToBeRemoved = $false;
foreach($item in $InputObject)
{
$bShouldProcess = $false;
# Node entity
$objectFoundToBeRemoved = $true;
$itemString = '{0}' -f $item.Name;
$bShouldProcess = $PSCmdlet.ShouldProcess($itemString);
if(!$bShouldProcess) { break; };
# ChildNodes
$childNodes = Get-Node -ParentId $item.Id -svc $svc;
foreach($childNode in $childNodes)
{
$itemString = "Referenced ChildNode '{0}'" -f $childNode.Name;
$bShouldProcess = $PSCmdlet.ShouldProcess($itemString);
if(!$bShouldProcess) { break; };
$r += Remove-Node -Id $childNode.Id -svc $svc;
}
if(!$bShouldProcess) { break; };
# ExternalNode entity
$externalNodes = Get-Node -Id $item.Id -svc $svc -ExpandExternalNodes;
foreach($externalNode in $externalNodes)
{
$itemString = "Referenced ExternalNode '{0}' of Type '{1}'" -f $externalNode.Name, $externalNode.ExternalType;
$bShouldProcess = $PSCmdlet.ShouldProcess($itemString);
if(!$bShouldProcess) { break; };
# ExternalNodeAttributes
$externalNodeAttributes = Get-ExternalNode -Id $externalNode.Id -svc $svc -ExpandAttributes;
foreach($externalNodeAttribute in $externalNodeAttributes)
{
$itemString = "Referenced ExternalNodeAttribute '{0}', '{1}'" -f $externalNodeAttribute.Name, $externalNodeAttribute.Description;
$bShouldProcess = $PSCmdlet.ShouldProcess($itemString);
if(!$bShouldProcess) { break; };
$r += ($externalNodeAttribute | Select -Property @{ Name="Name"; Expression={'{0} (ExternalNodeAttribute)' -f $item.Name}}, Id);
Log-Notice $fn ("Removing ref ExternalNodeAttribute '{0}' ..." -f $externalNodeAttribute.Id);
$svc.Core.DeleteObject($externalNodeAttribute);
$null = $svc.Core.SaveChanges();
}
if(!$bShouldProcess) { break; };
$r += ($externalNode | Select -Property @{ Name="Name"; Expression={'{0} (ExternalNode)' -f $item.Name}}, Id);
Log-Notice $fn ("Removing ref ExternalNode '{0}' ..." -f $externalNode.Id);
$svc.Core.DeleteObject($externalNode);
$null = $svc.Core.SaveChanges();
}
if(!$bShouldProcess) { break; };
# Job entity
# $jobentity = Get-Node -Id $item.Id -svc $svc -ExpandJob;
# Workaroud because singele action status does not work properly
$jobentity = $svc.Core.Jobs.AddQueryOption('$filter',("RefId eq '{0}'" -f $item.Id)) | Select;
if ($jobentity)
{
$itemString = "Referenced Job '{0}' in Status '{1}'" -f $jobentity.Id, $jobentity.Status;
$bShouldProcess = $PSCmdlet.ShouldProcess($itemString);
if(!$bShouldProcess) { break; };
# ChildJobs
$jobChilds = Get-Job -ParentId $jobentity.Id -svc $svc;
foreach($jobChild in $jobChilds)
{
$itemString = "Referenced ChildJob '{0}' in Status '{1}'" -f $jobChild.Id, $jobChild.Status;
$bShouldProcess = $PSCmdlet.ShouldProcess($itemString);
if(!$bShouldProcess) { break; };
$r += ($jobChild | Select -Property @{ Name="Name"; Expression={'{0} (ChildJob)' -f $item.Name}}, Id);
Log-Notice $fn ("Removing ref ChildJob '{0}' ..." -f $jobChild.Id);
$svc.Core.DeleteObject($jobChild);
$null = $svc.Core.SaveChanges();
}
if(!$bShouldProcess) { break; };
$r += ($jobentity | Select -Property @{ Name="Name"; Expression={'{0} (Job)' -f $item.Name}}, Id);
Log-Notice $fn ("Removing ref Job '{0}' ..." -f $jobentity.Id);
$svc.Core.DeleteObject($jobentity);
$null = $svc.Core.SaveChanges();
}
if(!$bShouldProcess) { break; };
# Node entity
$r += ($item | Select -Property Name, Id);
Log-Notice $fn ("Removing '{0}' ..." -f $itemString);
$svc.Core.DeleteObject($item);
$null = $svc.Core.SaveChanges();
}
Contract-Assert ($objectFoundToBeRemoved)
$OutputParameter = Format-ResultAs $r $As;
$fReturn = $true;
}
# Process
End
{
$datEnd = [datetime]::Now;
Log-Debug -fn $fn -msg ("RET. fReturn: [{0}]. Execution time: [{1}]ms. Started: [{2}]." -f $fReturn, ($datEnd - $datBegin).TotalMilliseconds, $datBegin.ToString('yyyy-MM-dd HH:mm:ss.fffzzz')) -fac 2;
# Return values are always and only returned via OutputParameter.
return $OutputParameter;
}
# End
}
if($MyInvocation.ScriptName) { Export-ModuleMember -Function Remove-Node; }
#
# Copyright 2014-2015 d-fens GmbH
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SIG # Begin signature block
# MIIXDwYJKoZIhvcNAQcCoIIXADCCFvwCAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB
# gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR
# AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQUxUjfEvzYYEVI+IwrTgkSaNeN
# d9ugghHCMIIEFDCCAvygAwIBAgILBAAAAAABL07hUtcwDQYJKoZIhvcNAQEFBQAw
# VzELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNV
# BAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkdsb2JhbFNpZ24gUm9vdCBDQTAeFw0xMTA0
# MTMxMDAwMDBaFw0yODAxMjgxMjAwMDBaMFIxCzAJBgNVBAYTAkJFMRkwFwYDVQQK
# ExBHbG9iYWxTaWduIG52LXNhMSgwJgYDVQQDEx9HbG9iYWxTaWduIFRpbWVzdGFt
# cGluZyBDQSAtIEcyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAlO9l
# +LVXn6BTDTQG6wkft0cYasvwW+T/J6U00feJGr+esc0SQW5m1IGghYtkWkYvmaCN
# d7HivFzdItdqZ9C76Mp03otPDbBS5ZBb60cO8eefnAuQZT4XljBFcm05oRc2yrmg
# jBtPCBn2gTGtYRakYua0QJ7D/PuV9vu1LpWBmODvxevYAll4d/eq41JrUJEpxfz3
# zZNl0mBhIvIG+zLdFlH6Dv2KMPAXCae78wSuq5DnbN96qfTvxGInX2+ZbTh0qhGL
# 2t/HFEzphbLswn1KJo/nVrqm4M+SU4B09APsaLJgvIQgAIMboe60dAXBKY5i0Eex
# +vBTzBj5Ljv5cH60JQIDAQABo4HlMIHiMA4GA1UdDwEB/wQEAwIBBjASBgNVHRMB
# Af8ECDAGAQH/AgEAMB0GA1UdDgQWBBRG2D7/3OO+/4Pm9IWbsN1q1hSpwTBHBgNV
# HSAEQDA+MDwGBFUdIAAwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93d3cuZ2xvYmFs
# c2lnbi5jb20vcmVwb3NpdG9yeS8wMwYDVR0fBCwwKjAooCagJIYiaHR0cDovL2Ny
# bC5nbG9iYWxzaWduLm5ldC9yb290LmNybDAfBgNVHSMEGDAWgBRge2YaRQ2XyolQ
# L30EzTSo//z9SzANBgkqhkiG9w0BAQUFAAOCAQEATl5WkB5GtNlJMfO7FzkoG8IW
# 3f1B3AkFBJtvsqKa1pkuQJkAVbXqP6UgdtOGNNQXzFU6x4Lu76i6vNgGnxVQ380W
# e1I6AtcZGv2v8Hhc4EvFGN86JB7arLipWAQCBzDbsBJe/jG+8ARI9PBw+DpeVoPP
# PfsNvPTF7ZedudTbpSeE4zibi6c1hkQgpDttpGoLoYP9KOva7yj2zIhd+wo7AKvg
# IeviLzVsD440RZfroveZMzV+y5qKu0VN5z+fwtmK+mWybsd+Zf/okuEsMaL3sCc2
# SI8mbzvuTXYfecPlf5Y1vC0OzAGwjn//UYCAp5LUs0RGZIyHTxZjBzFLY7Df8zCC
# BCkwggMRoAMCAQICCwQAAAAAATGJxjfoMA0GCSqGSIb3DQEBCwUAMEwxIDAeBgNV
# BAsTF0dsb2JhbFNpZ24gUm9vdCBDQSAtIFIzMRMwEQYDVQQKEwpHbG9iYWxTaWdu
# MRMwEQYDVQQDEwpHbG9iYWxTaWduMB4XDTExMDgwMjEwMDAwMFoXDTE5MDgwMjEw
# MDAwMFowWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKPv0Z8p6djTgnY8YqDS
# SdYWHvHP8NC6SEMDLacd8gE0SaQQ6WIT9BP0FoO11VdCSIYrlViH6igEdMtyEQ9h
# JuH6HGEVxyibTQuCDyYrkDqW7aTQaymc9WGI5qRXb+70cNCNF97mZnZfdB5eDFM4
# XZD03zAtGxPReZhUGks4BPQHxCMD05LL94BdqpxWBkQtQUxItC3sNZKaxpXX9c6Q
# MeJ2s2G48XVXQqw7zivIkEnotybPuwyJy9DDo2qhydXjnFMrVyb+Vpp2/WFGomDs
# KUZH8s3ggmLGBFrn7U5AXEgGfZ1f53TJnoRlDVve3NMkHLQUEeurv8QfpLqZ0BdY
# Nc0CAwEAAaOB/TCB+jAOBgNVHQ8BAf8EBAMCAQYwEgYDVR0TAQH/BAgwBgEB/wIB
# ADAdBgNVHQ4EFgQUGUq4WuRNMaUU5V7sL6Mc+oCMMmswRwYDVR0gBEAwPjA8BgRV
# HSAAMDQwMgYIKwYBBQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3Jl
# cG9zaXRvcnkvMDYGA1UdHwQvMC0wK6ApoCeGJWh0dHA6Ly9jcmwuZ2xvYmFsc2ln
# bi5uZXQvcm9vdC1yMy5jcmwwEwYDVR0lBAwwCgYIKwYBBQUHAwMwHwYDVR0jBBgw
# FoAUj/BLf6guRSSuTVD6Y5qL3uLdG7wwDQYJKoZIhvcNAQELBQADggEBAHmwaTTi
# BYf2/tRgLC+GeTQD4LEHkwyEXPnk3GzPbrXsCly6C9BoMS4/ZL0Pgmtmd4F/ximl
# F9jwiU2DJBH2bv6d4UgKKKDieySApOzCmgDXsG1szYjVFXjPE/mIpXNNwTYr3MvO
# 23580ovvL72zT006rbtibiiTxAzL2ebK4BEClAOwvT+UKFaQHlPCJ9XJPM0aYx6C
# WRW2QMqngarDVa8z0bV16AnqRwhIIvtdG/Mseml+xddaXlYzPK1X6JMlQsPSXnE7
# ShxU7alVrCgFx8RsXdw8k/ZpPIJRzhoVPV4Bc/9Aouq0rtOO+u5dbEfHQfXUVlfy
# GDcy1tTMS/Zx4HYwggSfMIIDh6ADAgECAhIRIdaZp2SXPvH4Qn7pGcxTQRQwDQYJ
# KoZIhvcNAQEFBQAwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24g
# bnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzIw
# HhcNMTYwNTI0MDAwMDAwWhcNMjcwNjI0MDAwMDAwWjBgMQswCQYDVQQGEwJTRzEf
# MB0GA1UEChMWR01PIEdsb2JhbFNpZ24gUHRlIEx0ZDEwMC4GA1UEAxMnR2xvYmFs
# U2lnbiBUU0EgZm9yIE1TIEF1dGhlbnRpY29kZSAtIEcyMIIBIjANBgkqhkiG9w0B
# AQEFAAOCAQ8AMIIBCgKCAQEAsBeuotO2BDBWHlgPse1VpNZUy9j2czrsXV6rJf02
# pfqEw2FAxUa1WVI7QqIuXxNiEKlb5nPWkiWxfSPjBrOHOg5D8NcAiVOiETFSKG5d
# QHI88gl3p0mSl9RskKB2p/243LOd8gdgLE9YmABr0xVU4Prd/4AsXximmP/Uq+yh
# RVmyLm9iXeDZGayLV5yoJivZF6UQ0kcIGnAsM4t/aIAqtaFda92NAgIpA6p8N7u7
# KU49U5OzpvqP0liTFUy5LauAo6Ml+6/3CGSwekQPXBDXX2E3qk5r09JTJZ2Cc/os
# +XKwqRk5KlD6qdA8OsroW+/1X1H0+QrZlzXeaoXmIwRCrwIDAQABo4IBXzCCAVsw
# DgYDVR0PAQH/BAQDAgeAMEwGA1UdIARFMEMwQQYJKwYBBAGgMgEeMDQwMgYIKwYB
# BQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3JlcG9zaXRvcnkvMAkG
# A1UdEwQCMAAwFgYDVR0lAQH/BAwwCgYIKwYBBQUHAwgwQgYDVR0fBDswOTA3oDWg
# M4YxaHR0cDovL2NybC5nbG9iYWxzaWduLmNvbS9ncy9nc3RpbWVzdGFtcGluZ2cy
# LmNybDBUBggrBgEFBQcBAQRIMEYwRAYIKwYBBQUHMAKGOGh0dHA6Ly9zZWN1cmUu
# Z2xvYmFsc2lnbi5jb20vY2FjZXJ0L2dzdGltZXN0YW1waW5nZzIuY3J0MB0GA1Ud
# DgQWBBTUooRKOFoYf7pPMFC9ndV6h9YJ9zAfBgNVHSMEGDAWgBRG2D7/3OO+/4Pm
# 9IWbsN1q1hSpwTANBgkqhkiG9w0BAQUFAAOCAQEAj6kakW0EpjcgDoOW3iPTa24f
# bt1kPWghIrX4RzZpjuGlRcckoiK3KQnMVFquxrzNY46zPVBI5bTMrs2SjZ4oixNK
# Eaq9o+/Tsjb8tKFyv22XY3mMRLxwL37zvN2CU6sa9uv6HJe8tjecpBwwvKu8LUc2
# 35IgA+hxxlj2dQWaNPALWVqCRDSqgOQvhPZHXZbJtsrKnbemuuRQ09Q3uLogDtDT
# kipbxFm7oW3bPM5EncE4Kq3jjb3NCXcaEL5nCgI2ZIi5sxsm7ueeYMRGqLxhM2zP
# TrmcuWrwnzf+tT1PmtNN/94gjk6Xpv2fCbxNyhh2ybBNhVDygNIdBvVYBAexGDCC
# BNYwggO+oAMCAQICEhEhDRayW4wRltP+V8mGEea62TANBgkqhkiG9w0BAQsFADBa
# MQswCQYDVQQGEwJCRTEZMBcGA1UEChMQR2xvYmFsU2lnbiBudi1zYTEwMC4GA1UE
# AxMnR2xvYmFsU2lnbiBDb2RlU2lnbmluZyBDQSAtIFNIQTI1NiAtIEcyMB4XDTE1
# MDUwNDE2NDMyMVoXDTE4MDUwNDE2NDMyMVowVTELMAkGA1UEBhMCQ0gxDDAKBgNV
# BAgTA1p1ZzEMMAoGA1UEBxMDWnVnMRQwEgYDVQQKEwtkLWZlbnMgR21iSDEUMBIG
# A1UEAxMLZC1mZW5zIEdtYkgwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB
# AQDNPSzSNPylU9jFM78Q/GjzB7N+VNqikf/use7p8mpnBZ4cf5b4qV3rqQd62rJH
# RlAsxgouCSNQrl8xxfg6/t/I02kPvrzsR4xnDgMiVCqVRAeQsWebafWdTvWmONBS
# lxJejPP8TSgXMKFaDa+2HleTycTBYSoErAZSWpQ0NqF9zBadjsJRVatQuPkTDrwL
# eWibiyOipK9fcNoQpl5ll5H9EG668YJR3fqX9o0TQTkOmxXIL3IJ0UxdpyDpLEkt
# tBG6Y5wAdpF2dQX2phrfFNVY54JOGtuBkNGMSiLFzTkBA1fOlA6ICMYjB8xIFxVv
# rN1tYojCrqYkKMOjwWQz5X8zAgMBAAGjggGZMIIBlTAOBgNVHQ8BAf8EBAMCB4Aw
# TAYDVR0gBEUwQzBBBgkrBgEEAaAyATIwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93
# d3cuZ2xvYmFsc2lnbi5jb20vcmVwb3NpdG9yeS8wCQYDVR0TBAIwADATBgNVHSUE
# DDAKBggrBgEFBQcDAzBCBgNVHR8EOzA5MDegNaAzhjFodHRwOi8vY3JsLmdsb2Jh
# bHNpZ24uY29tL2dzL2dzY29kZXNpZ25zaGEyZzIuY3JsMIGQBggrBgEFBQcBAQSB
# gzCBgDBEBggrBgEFBQcwAoY4aHR0cDovL3NlY3VyZS5nbG9iYWxzaWduLmNvbS9j
# YWNlcnQvZ3Njb2Rlc2lnbnNoYTJnMi5jcnQwOAYIKwYBBQUHMAGGLGh0dHA6Ly9v
# Y3NwMi5nbG9iYWxzaWduLmNvbS9nc2NvZGVzaWduc2hhMmcyMB0GA1UdDgQWBBTN
# GDddiIYZy9p3Z84iSIMd27rtUDAfBgNVHSMEGDAWgBQZSrha5E0xpRTlXuwvoxz6
# gIwyazANBgkqhkiG9w0BAQsFAAOCAQEAAApsOzSX1alF00fTeijB/aIthO3UB0ks
# 1Gg3xoKQC1iEQmFG/qlFLiufs52kRPN7L0a7ClNH3iQpaH5IEaUENT9cNEXdKTBG
# 8OrJS8lrDJXImgNEgtSwz0B40h7bM2Z+0DvXDvpmfyM2NwHF/nNVj7NzmczrLRqN
# 9de3tV0pgRqnIYordVcmb24CZl3bzpwzbQQy14Iz+P5Z2cnw+QaYzAuweTZxEUcJ
# bFwpM49c1LMPFJTuOKkUgY90JJ3gVTpyQxfkc7DNBnx74PlRzjFmeGC/hxQt0hvo
# eaAiBdjo/1uuCTToigVnyRH+c0T2AezTeoFb7ne3I538hWeTdU5q9jGCBLcwggSz
# AgEBMHAwWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MgISESENFrJbjBGW0/5XyYYR5rrZMAkGBSsOAwIaBQCgeDAYBgorBgEEAYI3AgEM
# MQowCKACgAChAoAAMBkGCSqGSIb3DQEJAzEMBgorBgEEAYI3AgEEMBwGCisGAQQB
# gjcCAQsxDjAMBgorBgEEAYI3AgEVMCMGCSqGSIb3DQEJBDEWBBRJKrcu73p+jUGY
# UJKcD8QZljhYKTANBgkqhkiG9w0BAQEFAASCAQCCZBMcX78z8qVlGpX1SgiOpBGv
# s+m/j8HrIsLcSIHSTW/OPead+a1AvJMjaU1keHd0rc5ZztbT0A1momWZ7jCiGImo
# a2/TOUohH0QL1jPGDtNEgwgInYvcjvsh9Pk8oYxeTvv5ywRVYG8uwOfae4x+WmNn
# i/liUNQfWLO7tizJP2N7Aqb3RWEHclC6oL55LZO0c/Mg+EsUJDdnr5Uq2cy0XdnU
# ZZXlhqpHCqmFXk0RSw9cdo51EJBYNnTlTQet3cCFFA+4Ayz1vfBpzMkP/ikIyXjS
# 2aMBmDGycE9KPVtw8JrbhvhQzwLLU2L3JESTqgUD2fYcPWQ9/dS0zZ6v0kEloYIC
# ojCCAp4GCSqGSIb3DQEJBjGCAo8wggKLAgEBMGgwUjELMAkGA1UEBhMCQkUxGTAX
# BgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGlt
# ZXN0YW1waW5nIENBIC0gRzICEhEh1pmnZJc+8fhCfukZzFNBFDAJBgUrDgMCGgUA
# oIH9MBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTE2
# MDgzMTE5MTcwMVowIwYJKoZIhvcNAQkEMRYEFM7mgZjDYQxM94k0Rf5sT/hbNbGV
# MIGdBgsqhkiG9w0BCRACDDGBjTCBijCBhzCBhAQUY7gvq2H1g5CWlQULACScUCkz
# 7HkwbDBWpFQwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYt
# c2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzICEhEh
# 1pmnZJc+8fhCfukZzFNBFDANBgkqhkiG9w0BAQEFAASCAQCT9WzKHoJ3UwhuCDtV
# 38AbD2kS86Z8QLab/8UhdbSD4U0ET4ZyUEep4s++PhaGGyoUUO/U11IRm99IAEhk
# mXM6WKfgadHrANgUIpekjy8bGHSDMaYbznS/5eQQ9AQXrdmKQAef7uCBSc9qNeri
# L2F13OaIUmE334raeMJtWkpnc9pNZHVhCWfl+hj5+OnHIHkk/sM5mzxRzsEPoaiV
# Sxrup/gaBUnY141v93gseEkp4sE42LRfy28jICAEXXiEuw0cedGPeKRO81V1nNV+
# 09gz2I3jaOr06a3iMXirU6Yq6vVdEaREfHPta/RU5l+mtltuLQy9zHV2+8C2cSCE
# B1mK
# SIG # End signature block
|
PowerShellCorpus/PowerShellGallery/biz.dfch.PS.Appclusive.Client/5.2.1.20161201/Get-SessionTenant.ps1
|
Get-SessionTenant.ps1
|
function Get-SessionTenant {
<#
.SYNOPSIS
Gets the tenant id for the current session.
.DESCRIPTION
Gets the tenant id for the current session.
By default the tenant id is not set in the caller session, meaning that all operations are performed under the HOME_TENANT of the caller.
.INPUTS
See parameters.
.OUTPUTS
Retuns the tenant entity of current tenant id if specified.
default | json | json-pretty | xml | xml-pretty
.EXAMPLE
# In this example we query the current setting of the TenantID. TenantID has been set to 'cb62d4c5-a354-408f-8658-1eb944762dec' so the result is the tenant entity for this id.
PS > Get-SessionTenant
Id : cb62d4c5-a354-408f-8658-1eb944762dec
Name : Fantabulous
Description : A supercalifragilisticexpialidocius tenant, but shorter and easier to spell.
ExternalId : bd16aeab-f354-43b4-9da9-60a1d64a15d0
ExternalType : External
CreatedById : 1
ModifiedById : 1
Created : 3/7/2016 12:00:00 AM +01:00
Modified : 7/15/2016 4:33:24 PM +02:00
RowVersion : {0, 0, 0, 0...}
ParentId : 5d31dbbd-d09c-4881-83b3-412d82ba84e5
CustomerId :
Parent :
Customer :
Children : {}
.EXAMPLE
#In this example we query the current setting of the TenantID. As no id has been set, nothing is returned.
PS > Get-SessionTenant
.LINK
Online Version: http://dfch.biz/biz/dfch/PS/Appclusive/Client/Get-SessionTenant/
.NOTES
See module manifest for required software versions and dependencies.
#>
[CmdletBinding(
SupportsShouldProcess = $false
,
ConfirmImpact = 'Low'
,
HelpURI = 'http://dfch.biz/biz/dfch/PS/Appclusive/Client/Get-SessionTenant/'
)]
PARAM
(
# Service reference to Appclusive
[Parameter(Mandatory = $false)]
[Alias('Services')]
[hashtable] $svc = (Get-Variable -Name $MyInvocation.MyCommand.Module.PrivateData.MODULEVAR -ValueOnly).Services
,
# Specifies the return format of the Cmdlet
[ValidateSet('default', 'json', 'json-pretty', 'xml', 'xml-pretty')]
[Parameter(Mandatory = $false)]
[alias('ReturnFormat')]
[string] $As = 'default'
)
Begin
{
trap { Log-Exception $_; break; }
$datBegin = [datetime]::Now;
[string] $fn = $MyInvocation.MyCommand.Name;
$OutputParameter = $null;
Log-Debug -fn $fn -msg ("CALL. svc '{0}'. Name '{1}'." -f ($svc -is [Object]), $Name) -fac 1;
$isConnected = Test-ApcStatus -Authenticate;
Contract-Assert (!!$isConnected) "You must connect to the server before using this Cmdlet."
}
# Begin
Process
{
trap { Log-Exception $_; break; }
$tenantIds = @{};
foreach($key in $svc.Keys)
{
$endpoint = $svc.$key;
$propertyTenantID = ($endpoint | gm -Type Properties -Name TenantID);
if(!$propertyTenantID)
{
$message = ("Endpoint '{0}' does not contain 'TenantID' property." -f $key)
Write-Warning $message
Log-Error $fn $message;
continue;
}
$tenantId = $endpoint.TenantID;
if($tenantId)
{
$tenant = Get-ApcTenant -Id $tenantId;
Contract-Assert (!!$tenant) "Tenant not found $tenantId"
}
$tenantIds.$tenantId = $tenant;
}
if($tenantIds.Keys.Count -eq 0)
{
$OutputParameter = $null
}
elseif($tenantIds.Keys.Count -eq 1)
{
$OutputParameter = $tenantIds.($tenantIds.Keys | Select -first 1);
}
else
{
$OutputParameter = $tenantIds;
}
$OutputParameter = Format-ResultAs $OutputParameter $As
$fReturn = $true;
}
# Process
End
{
$datEnd = [datetime]::Now;
Log-Debug -fn $fn -msg ("RET. fReturn: [{0}]. Execution time: [{1}]ms. Started: [{2}]." -f $fReturn, ($datEnd - $datBegin).TotalMilliseconds, $datBegin.ToString('yyyy-MM-dd HH:mm:ss.fffzzz')) -fac 2;
# Return values are always and only returned via OutputParameter.
return $OutputParameter;
}
} # function
if($MyInvocation.ScriptName) { Export-ModuleMember -Function Get-SessionTenant; }
#
# Copyright 2014-2016 d-fens GmbH
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SIG # Begin signature block
# MIIXDwYJKoZIhvcNAQcCoIIXADCCFvwCAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB
# gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR
# AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQU7Uo3HE2a6offwa4Tzr1Vckd5
# 1segghHCMIIEFDCCAvygAwIBAgILBAAAAAABL07hUtcwDQYJKoZIhvcNAQEFBQAw
# VzELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNV
# BAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkdsb2JhbFNpZ24gUm9vdCBDQTAeFw0xMTA0
# MTMxMDAwMDBaFw0yODAxMjgxMjAwMDBaMFIxCzAJBgNVBAYTAkJFMRkwFwYDVQQK
# ExBHbG9iYWxTaWduIG52LXNhMSgwJgYDVQQDEx9HbG9iYWxTaWduIFRpbWVzdGFt
# cGluZyBDQSAtIEcyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAlO9l
# +LVXn6BTDTQG6wkft0cYasvwW+T/J6U00feJGr+esc0SQW5m1IGghYtkWkYvmaCN
# d7HivFzdItdqZ9C76Mp03otPDbBS5ZBb60cO8eefnAuQZT4XljBFcm05oRc2yrmg
# jBtPCBn2gTGtYRakYua0QJ7D/PuV9vu1LpWBmODvxevYAll4d/eq41JrUJEpxfz3
# zZNl0mBhIvIG+zLdFlH6Dv2KMPAXCae78wSuq5DnbN96qfTvxGInX2+ZbTh0qhGL
# 2t/HFEzphbLswn1KJo/nVrqm4M+SU4B09APsaLJgvIQgAIMboe60dAXBKY5i0Eex
# +vBTzBj5Ljv5cH60JQIDAQABo4HlMIHiMA4GA1UdDwEB/wQEAwIBBjASBgNVHRMB
# Af8ECDAGAQH/AgEAMB0GA1UdDgQWBBRG2D7/3OO+/4Pm9IWbsN1q1hSpwTBHBgNV
# HSAEQDA+MDwGBFUdIAAwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93d3cuZ2xvYmFs
# c2lnbi5jb20vcmVwb3NpdG9yeS8wMwYDVR0fBCwwKjAooCagJIYiaHR0cDovL2Ny
# bC5nbG9iYWxzaWduLm5ldC9yb290LmNybDAfBgNVHSMEGDAWgBRge2YaRQ2XyolQ
# L30EzTSo//z9SzANBgkqhkiG9w0BAQUFAAOCAQEATl5WkB5GtNlJMfO7FzkoG8IW
# 3f1B3AkFBJtvsqKa1pkuQJkAVbXqP6UgdtOGNNQXzFU6x4Lu76i6vNgGnxVQ380W
# e1I6AtcZGv2v8Hhc4EvFGN86JB7arLipWAQCBzDbsBJe/jG+8ARI9PBw+DpeVoPP
# PfsNvPTF7ZedudTbpSeE4zibi6c1hkQgpDttpGoLoYP9KOva7yj2zIhd+wo7AKvg
# IeviLzVsD440RZfroveZMzV+y5qKu0VN5z+fwtmK+mWybsd+Zf/okuEsMaL3sCc2
# SI8mbzvuTXYfecPlf5Y1vC0OzAGwjn//UYCAp5LUs0RGZIyHTxZjBzFLY7Df8zCC
# BCkwggMRoAMCAQICCwQAAAAAATGJxjfoMA0GCSqGSIb3DQEBCwUAMEwxIDAeBgNV
# BAsTF0dsb2JhbFNpZ24gUm9vdCBDQSAtIFIzMRMwEQYDVQQKEwpHbG9iYWxTaWdu
# MRMwEQYDVQQDEwpHbG9iYWxTaWduMB4XDTExMDgwMjEwMDAwMFoXDTE5MDgwMjEw
# MDAwMFowWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKPv0Z8p6djTgnY8YqDS
# SdYWHvHP8NC6SEMDLacd8gE0SaQQ6WIT9BP0FoO11VdCSIYrlViH6igEdMtyEQ9h
# JuH6HGEVxyibTQuCDyYrkDqW7aTQaymc9WGI5qRXb+70cNCNF97mZnZfdB5eDFM4
# XZD03zAtGxPReZhUGks4BPQHxCMD05LL94BdqpxWBkQtQUxItC3sNZKaxpXX9c6Q
# MeJ2s2G48XVXQqw7zivIkEnotybPuwyJy9DDo2qhydXjnFMrVyb+Vpp2/WFGomDs
# KUZH8s3ggmLGBFrn7U5AXEgGfZ1f53TJnoRlDVve3NMkHLQUEeurv8QfpLqZ0BdY
# Nc0CAwEAAaOB/TCB+jAOBgNVHQ8BAf8EBAMCAQYwEgYDVR0TAQH/BAgwBgEB/wIB
# ADAdBgNVHQ4EFgQUGUq4WuRNMaUU5V7sL6Mc+oCMMmswRwYDVR0gBEAwPjA8BgRV
# HSAAMDQwMgYIKwYBBQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3Jl
# cG9zaXRvcnkvMDYGA1UdHwQvMC0wK6ApoCeGJWh0dHA6Ly9jcmwuZ2xvYmFsc2ln
# bi5uZXQvcm9vdC1yMy5jcmwwEwYDVR0lBAwwCgYIKwYBBQUHAwMwHwYDVR0jBBgw
# FoAUj/BLf6guRSSuTVD6Y5qL3uLdG7wwDQYJKoZIhvcNAQELBQADggEBAHmwaTTi
# BYf2/tRgLC+GeTQD4LEHkwyEXPnk3GzPbrXsCly6C9BoMS4/ZL0Pgmtmd4F/ximl
# F9jwiU2DJBH2bv6d4UgKKKDieySApOzCmgDXsG1szYjVFXjPE/mIpXNNwTYr3MvO
# 23580ovvL72zT006rbtibiiTxAzL2ebK4BEClAOwvT+UKFaQHlPCJ9XJPM0aYx6C
# WRW2QMqngarDVa8z0bV16AnqRwhIIvtdG/Mseml+xddaXlYzPK1X6JMlQsPSXnE7
# ShxU7alVrCgFx8RsXdw8k/ZpPIJRzhoVPV4Bc/9Aouq0rtOO+u5dbEfHQfXUVlfy
# GDcy1tTMS/Zx4HYwggSfMIIDh6ADAgECAhIRIdaZp2SXPvH4Qn7pGcxTQRQwDQYJ
# KoZIhvcNAQEFBQAwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24g
# bnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzIw
# HhcNMTYwNTI0MDAwMDAwWhcNMjcwNjI0MDAwMDAwWjBgMQswCQYDVQQGEwJTRzEf
# MB0GA1UEChMWR01PIEdsb2JhbFNpZ24gUHRlIEx0ZDEwMC4GA1UEAxMnR2xvYmFs
# U2lnbiBUU0EgZm9yIE1TIEF1dGhlbnRpY29kZSAtIEcyMIIBIjANBgkqhkiG9w0B
# AQEFAAOCAQ8AMIIBCgKCAQEAsBeuotO2BDBWHlgPse1VpNZUy9j2czrsXV6rJf02
# pfqEw2FAxUa1WVI7QqIuXxNiEKlb5nPWkiWxfSPjBrOHOg5D8NcAiVOiETFSKG5d
# QHI88gl3p0mSl9RskKB2p/243LOd8gdgLE9YmABr0xVU4Prd/4AsXximmP/Uq+yh
# RVmyLm9iXeDZGayLV5yoJivZF6UQ0kcIGnAsM4t/aIAqtaFda92NAgIpA6p8N7u7
# KU49U5OzpvqP0liTFUy5LauAo6Ml+6/3CGSwekQPXBDXX2E3qk5r09JTJZ2Cc/os
# +XKwqRk5KlD6qdA8OsroW+/1X1H0+QrZlzXeaoXmIwRCrwIDAQABo4IBXzCCAVsw
# DgYDVR0PAQH/BAQDAgeAMEwGA1UdIARFMEMwQQYJKwYBBAGgMgEeMDQwMgYIKwYB
# BQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3JlcG9zaXRvcnkvMAkG
# A1UdEwQCMAAwFgYDVR0lAQH/BAwwCgYIKwYBBQUHAwgwQgYDVR0fBDswOTA3oDWg
# M4YxaHR0cDovL2NybC5nbG9iYWxzaWduLmNvbS9ncy9nc3RpbWVzdGFtcGluZ2cy
# LmNybDBUBggrBgEFBQcBAQRIMEYwRAYIKwYBBQUHMAKGOGh0dHA6Ly9zZWN1cmUu
# Z2xvYmFsc2lnbi5jb20vY2FjZXJ0L2dzdGltZXN0YW1waW5nZzIuY3J0MB0GA1Ud
# DgQWBBTUooRKOFoYf7pPMFC9ndV6h9YJ9zAfBgNVHSMEGDAWgBRG2D7/3OO+/4Pm
# 9IWbsN1q1hSpwTANBgkqhkiG9w0BAQUFAAOCAQEAj6kakW0EpjcgDoOW3iPTa24f
# bt1kPWghIrX4RzZpjuGlRcckoiK3KQnMVFquxrzNY46zPVBI5bTMrs2SjZ4oixNK
# Eaq9o+/Tsjb8tKFyv22XY3mMRLxwL37zvN2CU6sa9uv6HJe8tjecpBwwvKu8LUc2
# 35IgA+hxxlj2dQWaNPALWVqCRDSqgOQvhPZHXZbJtsrKnbemuuRQ09Q3uLogDtDT
# kipbxFm7oW3bPM5EncE4Kq3jjb3NCXcaEL5nCgI2ZIi5sxsm7ueeYMRGqLxhM2zP
# TrmcuWrwnzf+tT1PmtNN/94gjk6Xpv2fCbxNyhh2ybBNhVDygNIdBvVYBAexGDCC
# BNYwggO+oAMCAQICEhEhDRayW4wRltP+V8mGEea62TANBgkqhkiG9w0BAQsFADBa
# MQswCQYDVQQGEwJCRTEZMBcGA1UEChMQR2xvYmFsU2lnbiBudi1zYTEwMC4GA1UE
# AxMnR2xvYmFsU2lnbiBDb2RlU2lnbmluZyBDQSAtIFNIQTI1NiAtIEcyMB4XDTE1
# MDUwNDE2NDMyMVoXDTE4MDUwNDE2NDMyMVowVTELMAkGA1UEBhMCQ0gxDDAKBgNV
# BAgTA1p1ZzEMMAoGA1UEBxMDWnVnMRQwEgYDVQQKEwtkLWZlbnMgR21iSDEUMBIG
# A1UEAxMLZC1mZW5zIEdtYkgwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB
# AQDNPSzSNPylU9jFM78Q/GjzB7N+VNqikf/use7p8mpnBZ4cf5b4qV3rqQd62rJH
# RlAsxgouCSNQrl8xxfg6/t/I02kPvrzsR4xnDgMiVCqVRAeQsWebafWdTvWmONBS
# lxJejPP8TSgXMKFaDa+2HleTycTBYSoErAZSWpQ0NqF9zBadjsJRVatQuPkTDrwL
# eWibiyOipK9fcNoQpl5ll5H9EG668YJR3fqX9o0TQTkOmxXIL3IJ0UxdpyDpLEkt
# tBG6Y5wAdpF2dQX2phrfFNVY54JOGtuBkNGMSiLFzTkBA1fOlA6ICMYjB8xIFxVv
# rN1tYojCrqYkKMOjwWQz5X8zAgMBAAGjggGZMIIBlTAOBgNVHQ8BAf8EBAMCB4Aw
# TAYDVR0gBEUwQzBBBgkrBgEEAaAyATIwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93
# d3cuZ2xvYmFsc2lnbi5jb20vcmVwb3NpdG9yeS8wCQYDVR0TBAIwADATBgNVHSUE
# DDAKBggrBgEFBQcDAzBCBgNVHR8EOzA5MDegNaAzhjFodHRwOi8vY3JsLmdsb2Jh
# bHNpZ24uY29tL2dzL2dzY29kZXNpZ25zaGEyZzIuY3JsMIGQBggrBgEFBQcBAQSB
# gzCBgDBEBggrBgEFBQcwAoY4aHR0cDovL3NlY3VyZS5nbG9iYWxzaWduLmNvbS9j
# YWNlcnQvZ3Njb2Rlc2lnbnNoYTJnMi5jcnQwOAYIKwYBBQUHMAGGLGh0dHA6Ly9v
# Y3NwMi5nbG9iYWxzaWduLmNvbS9nc2NvZGVzaWduc2hhMmcyMB0GA1UdDgQWBBTN
# GDddiIYZy9p3Z84iSIMd27rtUDAfBgNVHSMEGDAWgBQZSrha5E0xpRTlXuwvoxz6
# gIwyazANBgkqhkiG9w0BAQsFAAOCAQEAAApsOzSX1alF00fTeijB/aIthO3UB0ks
# 1Gg3xoKQC1iEQmFG/qlFLiufs52kRPN7L0a7ClNH3iQpaH5IEaUENT9cNEXdKTBG
# 8OrJS8lrDJXImgNEgtSwz0B40h7bM2Z+0DvXDvpmfyM2NwHF/nNVj7NzmczrLRqN
# 9de3tV0pgRqnIYordVcmb24CZl3bzpwzbQQy14Iz+P5Z2cnw+QaYzAuweTZxEUcJ
# bFwpM49c1LMPFJTuOKkUgY90JJ3gVTpyQxfkc7DNBnx74PlRzjFmeGC/hxQt0hvo
# eaAiBdjo/1uuCTToigVnyRH+c0T2AezTeoFb7ne3I538hWeTdU5q9jGCBLcwggSz
# AgEBMHAwWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MgISESENFrJbjBGW0/5XyYYR5rrZMAkGBSsOAwIaBQCgeDAYBgorBgEEAYI3AgEM
# MQowCKACgAChAoAAMBkGCSqGSIb3DQEJAzEMBgorBgEEAYI3AgEEMBwGCisGAQQB
# gjcCAQsxDjAMBgorBgEEAYI3AgEVMCMGCSqGSIb3DQEJBDEWBBRT0sbmpD7RXmCK
# PWSqOQD3KmmbjDANBgkqhkiG9w0BAQEFAASCAQCV2yEX3FtCCBoOmG1nOrjbNw1Q
# K7Kt1OCA19pTOBubtJcPVkzcbNjPXsjNOSLCwghcF68ZA6shHkUl5z8Em5eFeaE6
# sWKbTJHq1mnIUX2ma+zgpJNwZCLUcWzwv1W4VPZ+5AQ9bn7ILi88o46dWeMAPN7y
# sScGqs8Ax+VTgkuLclTBYDZ1wmBVumG/XeW0F1W5bXFfKKl+JOfojQ2qPVQEjqUw
# 01/ndgNAbx7SVGVu1qgDjk3VTSMJZ0/uBRXhirfqzoOb4ysgJqhTWsU00021pL7F
# hd69hzs5DRVXXblA9rU/4AtLLXZQhryPT5itNK+y7DKRGV6Pf8OnZ7MTqGf1oYIC
# ojCCAp4GCSqGSIb3DQEJBjGCAo8wggKLAgEBMGgwUjELMAkGA1UEBhMCQkUxGTAX
# BgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGlt
# ZXN0YW1waW5nIENBIC0gRzICEhEh1pmnZJc+8fhCfukZzFNBFDAJBgUrDgMCGgUA
# oIH9MBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTE2
# MDgzMTE5MTY0NlowIwYJKoZIhvcNAQkEMRYEFE1uXGnRvjFAWwDfE0UXTOEeCTzQ
# MIGdBgsqhkiG9w0BCRACDDGBjTCBijCBhzCBhAQUY7gvq2H1g5CWlQULACScUCkz
# 7HkwbDBWpFQwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYt
# c2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzICEhEh
# 1pmnZJc+8fhCfukZzFNBFDANBgkqhkiG9w0BAQEFAASCAQAqCUuHDVMPkms/s4Ja
# +e6x7vbW1rVVA81e1d6x2kX74R9YIzyLbZ/cqPJsD//oS+J2vbKAXsK7m66ctQAs
# Yd836oVLE2DiN+C7RSlJVgzJb8V5NokSwNWNQz1Ngr6RJn6LqSMzfNGXBwfkweuC
# +phN4PoqHmCYIOMVtHRVYgK4y5J0lBJ/8vnrmdLKtLxdxrGUD2l5zm/fuy7XTEpP
# jwmVze6rsMS/FJEMiaGxqVsXavkB/XAKvmVmA3rd0nf+Btjxt96868yar3kXhiT/
# lTf9bh7MtbEcETMS9DxIzyC34shwhkGBkA1PU1KVu7kz2RavV6GQS3HKHrP8mR6c
# YPlC
# SIG # End signature block
|
PowerShellCorpus/PowerShellGallery/biz.dfch.PS.Appclusive.Client/5.2.1.20161201/Get-EntityKind.ps1
|
Get-EntityKind.ps1
|
function Get-EntityKind {
<#
.SYNOPSIS
Retrieves one or more entities from the EntityKind entity set.
.DESCRIPTION
Retrieves one or more entities from the EntityKind entity set.
You can retrieve one ore more entities from the entity set by specifying
Id, Name or other properties.
.INPUTS
The Cmdlet can either return all available entities or filter entities on
specified conditions.
See PARAMETERS section on possible inputs.
.OUTPUTS
default | json | json-pretty | xml | xml-pretty
In addition output can be filtered on specified properties.
.EXAMPLE
Get-EntityKind -ListAvailable -Select Name
Name
----
biz.dfch.CS.Appclusive.Core.com.swisscom.cms.Mos
biz.dfch.CS.Appclusive.Core.OdataServices.Core.Ace
biz.dfch.CS.Appclusive.Core.OdataServices.Core.Acl
biz.dfch.CS.Appclusive.Core.OdataServices.Core.Approval
biz.dfch.CS.Appclusive.Core.OdataServices.Core.Assoc
biz.dfch.CS.Appclusive.Core.OdataServices.Core.AuditTrail
biz.dfch.CS.Appclusive.Core.OdataServices.Core.Cart
biz.dfch.CS.Appclusive.Core.OdataServices.Core.CartItem
biz.dfch.CS.Appclusive.Core.OdataServices.Core.Catalogue
biz.dfch.CS.Appclusive.Core.OdataServices.Core.CatalogueItem
biz.dfch.CS.Appclusive.Core.OdataServices.Core.ContractMapping
biz.dfch.CS.Appclusive.Core.OdataServices.Core.CostCentre
biz.dfch.CS.Appclusive.Core.OdataServices.Core.Customer
biz.dfch.CS.Appclusive.Core.OdataServices.Core.EntityKind
biz.dfch.CS.Appclusive.Core.OdataServices.Core.Gate
biz.dfch.CS.Appclusive.Core.OdataServices.Core.Job
biz.dfch.CS.Appclusive.Core.OdataServices.Core.KeyNameValue
biz.dfch.CS.Appclusive.Core.OdataServices.Core.ManagementCredential
biz.dfch.CS.Appclusive.Core.OdataServices.Core.ManagementUri
biz.dfch.CS.Appclusive.Core.OdataServices.Core.Node
biz.dfch.CS.Appclusive.Core.OdataServices.Core.Order
biz.dfch.CS.Appclusive.Core.OdataServices.Core.OrderItem
biz.dfch.CS.Appclusive.Core.OdataServices.Core.Permission
biz.dfch.CS.Appclusive.Core.OdataServices.Core.Product
biz.dfch.CS.Appclusive.Core.OdataServices.Core.Role
biz.dfch.CS.Appclusive.Core.OdataServices.Core.Tenant
biz.dfch.CS.Appclusive.Core.OdataServices.Core.User
Retrieves the name of all EntityKinds.
.EXAMPLE
Get-EntityKind 27
Version : biz.dfch.CS.Appclusive.Core.com.swisscom.cms.Mos
Parameters : {"InitialState-Create":"Created","Created-Run":"Running","Created-Delete":"Deleted","Running-Stop":"Stop
ped","Stopped-Decommission":"Decomissioned"}
Id : 27
Tid : 11111111-1111-1111-1111-111111111111
Name : biz.dfch.CS.Appclusive.Core.com.swisscom.cms.Mos
Description : biz.dfch.CS.Appclusive.Core.com.swisscom.cms.Mos
CreatedById : 1
ModifiedById : 1
Created : 14.12.2015 00:00:00 +00:00
Modified : 14.12.2015 00:00:00 +00:00
RowVersion : {0, 0, 0, 0...}
Tenant :
CreatedBy : SYSTEM
ModifiedBy : SYSTEM
Retrieves the EntityKind object with Id 27 and returns all properties of it.
.EXAMPLE
Get-EntityKind biz.dfch.CS.Appclusive.Core.com.swisscom.cms.Mos -Select Parameters -ValueOnly -ConvertFromJson
InitialState-Create : Created
Created-Run : Running
Created-Delete : Deleted
Running-Stop : Stopped
Stopped-Decommission : Decomissioned
Retrieves the EntityKind 'ActivitiClientUri' and only returns the 'Description' property
of it. In addition the contents of the property will be converted from JSON.
.EXAMPLE
Get-EntityKind -ListAvailable -Select Name, Id -First 3
Name Id
---- --
biz.dfch.CS.Appclusive.Core.com.swisscom.cms.Mos 27
biz.dfch.CS.Appclusive.Core.OdataServices.Core.Ace 3
biz.dfch.CS.Appclusive.Core.OdataServices.Core.Acl 4
Retrieves the name and id of the first 3 EntityKinds.
.EXAMPLE
Get-EntityKind 27 -Select Name -ValueOnly
biz.dfch.CS.Appclusive.Core.com.swisscom.cms.Mos
Retrieves the name of the EntityKind with Id 27.
.EXAMPLE
Get-EntityKind -ModifiedBy SYSTEM -Select Id, Name
Id Name
-- ----
1 biz.dfch.CS.Appclusive.Core.OdataServices.Core.Node
2 biz.dfch.CS.Appclusive.Core.OdataServices.Core.Job
4 biz.dfch.CS.Appclusive.Core.OdataServices.Core.Acl
5 biz.dfch.CS.Appclusive.Core.OdataServices.Core.Approval
Retrieves id and name of all Users that have been modified by user
with name 'SYSTEM' (case insensitive substring match).
.EXAMPLE
Get-EntityKind -Version biz.dfch.CS.Appclusive.Core.OdataServices.Core.Node -Select Id, Name
Id Name
-- ----
1 biz.dfch.CS.Appclusive.Core.OdataServices.Core.Node
Retrieves id and name of EntityKind with version 'biz.dfch.CS.Appclusive.Core.OdataServices.Core.Node' (case insensitive substring match).
.EXAMPLE
Get-EntityKind biz.dfch.CS.Appclusive.Core.com.swisscom.cms.Msql -Select Parameters -ValueOnly -DefaultValue @{"InitialState-Create"="Created";"Created-Decommission"="Decomissioned"}
Name Value
---- -----
InitialState-Create Created
Created-Decommission Decomissioned
Retrieves the 'Parameters' property of a EntityKind with Name 'biz.dfch.CS.Appclusive.Core.com.swisscom.cms.Msql'
and @{"InitialState-Create"="Created";"Created-Decommission"="Decomissioned"} if the entity is not found.
.LINK
Online Version: http://dfch.biz/biz/dfch/PS/Appclusive/Client/Get-EntityKind/
.NOTES
See module manifest for required software versions and dependencies.
#>
[CmdletBinding(
SupportsShouldProcess = $true
,
ConfirmImpact = 'Low'
,
HelpURI = 'http://dfch.biz/biz/dfch/PS/Appclusive/Client/Get-EntityKind/'
,
DefaultParameterSetName = 'list'
)]
PARAM
(
# Specifies the id of the entity
[Parameter(Mandatory = $false, Position = 0, ParameterSetName = 'id')]
[long] $Id
,
# Specifies the name of the entity
[Parameter(Mandatory = $false, Position = 0, ParameterSetName = 'name')]
[Alias('n')]
[string] $Name
,
# Filter by version
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[string] $Version
,
# Filter by creator
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[string] $CreatedBy
,
# Filter by modifier
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[string] $ModifiedBy
,
# Specify the attributes of the entity to return
[Parameter(Mandatory = $false)]
[string[]] $Select = @()
,
# Specifies to return only values without header information.
# This parameter takes precendes over the 'Select' parameter.
[ValidateScript( { if(1 -ge $Select.Count -And $_) { $true; } else { throw("You must specify exactly one 'Select' property when using 'ValueOnly'."); } } )]
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[Parameter(Mandatory = $false, ParameterSetName = 'id')]
[Alias('HideTableHeaders')]
[switch] $ValueOnly
,
# This value is only returned if the regular search would have returned no results
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[Parameter(Mandatory = $false, ParameterSetName = 'id')]
[Alias('default')]
$DefaultValue
,
# Specifies to deserialize JSON payloads
[ValidateScript( { if($ValueOnly -And $_) { $true; } else { throw("You must set the 'ValueOnly' switch when using 'ConvertFromJson'."); } } )]
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[Parameter(Mandatory = $false, ParameterSetName = 'id')]
[Alias('Convert')]
[switch] $ConvertFromJson
,
# Limits the output to the specified number of entries
[Parameter(Mandatory = $false)]
[Alias('top')]
[int] $First
,
# Retrieves the EntityKindId for the specified EntityKindName
[Parameter(Mandatory = $false, ParameterSetName = 'resolveByName')]
[string] $ResolveByName
,
# Retrieves the EntityKindId for the specified EntityKindName
[Parameter(Mandatory = $false, ParameterSetName = 'resolveById')]
[long] $ResolveById
,
# Service reference to Appclusive
[Parameter(Mandatory = $false)]
[Alias('Services')]
[hashtable] $svc = (Get-Variable -Name $MyInvocation.MyCommand.Module.PrivateData.MODULEVAR -ValueOnly).Services
,
# Indicates to return all file information
[Parameter(Mandatory = $false, ParameterSetName = 'list')]
[switch] $ListAvailable = $false
,
# Returns all Connectors which provide this Interface
[Parameter(Mandatory = $false)]
[Alias('Providers')]
[switch] $ListProviders = $false
,
# Returns all Connectors which require this Interface
[Parameter(Mandatory = $false)]
[Alias('Consumers')]
[switch] $ListConsumers = $false
,
# Returns all Connectors which provide this Interface
[Parameter(Mandatory = $false, ParameterSetName = 'ProvideInterface')]
[Alias('Provide')]
[long] $ProvideInterface
,
# Returns all Connectors which require this Interface
[Parameter(Mandatory = $false, ParameterSetName = 'RequireInterface')]
[Alias('Require')]
[long] $RequireInterface
,
# Specifies the return format of the Cmdlet
[ValidateSet('default', 'json', 'json-pretty', 'xml', 'xml-pretty')]
[Parameter(Mandatory = $false)]
[alias('ReturnFormat')]
[string] $As = 'default'
)
Begin
{
trap { Log-Exception $_; break; }
$datBegin = [datetime]::Now;
[string] $fn = $MyInvocation.MyCommand.Name;
Log-Debug -fn $fn -msg ("CALL. svc '{0}'. Name '{1}'." -f ($svc -is [Object]), $Name) -fac 1;
$EntitySetName = 'EntityKinds';
# Parameter validation
Contract-Requires ($svc.Core -is [biz.dfch.CS.Appclusive.Api.Core.Core]) "Connect to the server before using the Cmdlet"
if($Select)
{
$Select = $Select | Select -Unique;
}
elseif ($ValueOnly)
{
$Select = 'Parameters';
}
}
# Begin
Process
{
trap { Log-Exception $_; break; }
# Default test variable for checking function response codes.
[Boolean] $fReturn = $false;
# Return values are always and only returned via OutputParameter.
$OutputParameter = $null;
Contract-Assert ($PSCmdlet.ShouldProcess(($PSBoundParameters | Out-String)))
if($PSCmdlet.ParameterSetName -eq 'list')
{
if($Select)
{
if($PSBoundParameters.ContainsKey('First'))
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$orderby','Name').AddQueryOption('$top', $First) | Select -Property $Select;
}
else
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$orderby','Name') | Select -Property $Select;
}
}
else
{
if($PSBoundParameters.ContainsKey('First'))
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$orderby','Name').AddQueryOption('$top', $First) | Select;
}
else
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$orderby','Name') | Select;
}
}
}
elseif($PSCmdlet.ParameterSetName -eq 'resolveByName')
{
$Response = @();
$names = [Enum]::GetNames([biz.dfch.CS.Appclusive.Public.Constants+EntityKindId]);
foreach($name in ($names -match $ResolveByName))
{
$Response += [Enum]::Parse([biz.dfch.CS.Appclusive.Public.Constants+EntityKindId], $name).value__;
}
}
elseif($PSCmdlet.ParameterSetName -eq 'resolveById')
{
$Response = @();
$values = [Enum]::GetValues([biz.dfch.CS.Appclusive.Public.Constants+EntityKindId]);
foreach($value in $values)
{
if($ResolveById -eq ($value -as [long]))
{
$Response = $value.ToString();
break;
}
}
}
elseif($PSCmdlet.ParameterSetName -eq 'RequireInterface')
{
$Response = $svc.Core.InvokeEntitySetActionWithListResult("EntityKinds", "RequireInterface", [biz.dfch.CS.Appclusive.Api.Core.EntityKind], @{"InterfaceId"=$RequireInterface});
}
elseif($PSCmdlet.ParameterSetName -eq 'ProvideInterface')
{
$Response = $svc.Core.InvokeEntitySetActionWithListResult("EntityKinds", "ProvideInterface", [biz.dfch.CS.Appclusive.Api.Core.EntityKind], @{"InterfaceId"=$ProvideInterface});
}
else
{
$Exp = @();
if($PSCmdlet.ParameterSetName -eq 'id')
{
$Exp += ("Id eq {0}" -f $Id);
}
if($Name)
{
$Exp += ("tolower(Name) eq '{0}'" -f [uri]::EscapeDataString($Name.ToLower()));
}
if($Version)
{
$Exp += ("tolower(Version) eq '{0}'" -f [uri]::EscapeDataString($Version.ToLower()));
}
if($CreatedBy)
{
$CreatedById = Get-User -svc $svc -Name $CreatedBy -Select Id -ValueOnly;
if ( !$CreatedById )
{
# User not found
return;
}
$Exp += ("(CreatedById eq {0})" -f $CreatedById);
}
if($ModifiedBy)
{
$ModifiedById = Get-User -svc $svc -Name $ModifiedBy -Select Id -ValueOnly;
if ( !$ModifiedById )
{
# User not found
return;
}
$Exp += ("(ModifiedById eq {0})" -f $ModifiedById);
}
$FilterExpression = [String]::Join(' and ', $Exp);
if($Select)
{
if($PSBoundParameters.ContainsKey('First'))
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$filter', $FilterExpression).AddQueryOption('$top', $First) | Select -Property $Select;
}
else
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$filter', $FilterExpression) | Select -Property $Select;
}
}
else
{
if($PSBoundParameters.ContainsKey('First'))
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$filter', $FilterExpression).AddQueryOption('$top', $First) | Select;
}
else
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$filter', $FilterExpression) | Select;
}
}
if(1 -eq $Select.Count -And $ValueOnly)
{
$Response = $Response.$Select;
}
if (!$Response)
{
if($PSBoundParameters.ContainsKey('DefaultValue'))
{
$Response = $DefaultValue;
}
}
else
{
if ($PSBoundParameters.ContainsKey('ListProviders'))
{
$Response = Get-Connector -svc $svc -EntityKindId $Response.Id -Provide;
}
elseif ($PSBoundParameters.ContainsKey('ListConsumers'))
{
$Response = Get-Connector -svc $svc -EntityKindId $Response.Id -Require;
}
}
if($ValueOnly -And $ConvertFromJson)
{
$ResponseTemp = New-Object System.Collections.ArrayList;
foreach($item in $Response)
{
try
{
$null = $ResponseTemp.Add((ConvertFrom-Json -InputObject $item));
}
catch
{
$null = $ResponseTemp.Add($item);
}
}
$Response = $ResponseTemp.ToArray();
}
}
$OutputParameter = Format-ResultAs $Response $As
$fReturn = $true;
}
# Process
End
{
$datEnd = [datetime]::Now;
Log-Debug -fn $fn -msg ("RET. fReturn: [{0}]. Execution time: [{1}]ms. Started: [{2}]." -f $fReturn, ($datEnd - $datBegin).TotalMilliseconds, $datBegin.ToString('yyyy-MM-dd HH:mm:ss.fffzzz')) -fac 2;
# Return values are always and only returned via OutputParameter.
return $OutputParameter;
}
# End
} # function
if($MyInvocation.ScriptName) { Export-ModuleMember -Function Get-EntityKind; }
#
# Copyright 2014-2015 d-fens GmbH
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SIG # Begin signature block
# MIIXDwYJKoZIhvcNAQcCoIIXADCCFvwCAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB
# gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR
# AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQUaY+TXG64uyxsJ/rS8EebVsdX
# ctegghHCMIIEFDCCAvygAwIBAgILBAAAAAABL07hUtcwDQYJKoZIhvcNAQEFBQAw
# VzELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNV
# BAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkdsb2JhbFNpZ24gUm9vdCBDQTAeFw0xMTA0
# MTMxMDAwMDBaFw0yODAxMjgxMjAwMDBaMFIxCzAJBgNVBAYTAkJFMRkwFwYDVQQK
# ExBHbG9iYWxTaWduIG52LXNhMSgwJgYDVQQDEx9HbG9iYWxTaWduIFRpbWVzdGFt
# cGluZyBDQSAtIEcyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAlO9l
# +LVXn6BTDTQG6wkft0cYasvwW+T/J6U00feJGr+esc0SQW5m1IGghYtkWkYvmaCN
# d7HivFzdItdqZ9C76Mp03otPDbBS5ZBb60cO8eefnAuQZT4XljBFcm05oRc2yrmg
# jBtPCBn2gTGtYRakYua0QJ7D/PuV9vu1LpWBmODvxevYAll4d/eq41JrUJEpxfz3
# zZNl0mBhIvIG+zLdFlH6Dv2KMPAXCae78wSuq5DnbN96qfTvxGInX2+ZbTh0qhGL
# 2t/HFEzphbLswn1KJo/nVrqm4M+SU4B09APsaLJgvIQgAIMboe60dAXBKY5i0Eex
# +vBTzBj5Ljv5cH60JQIDAQABo4HlMIHiMA4GA1UdDwEB/wQEAwIBBjASBgNVHRMB
# Af8ECDAGAQH/AgEAMB0GA1UdDgQWBBRG2D7/3OO+/4Pm9IWbsN1q1hSpwTBHBgNV
# HSAEQDA+MDwGBFUdIAAwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93d3cuZ2xvYmFs
# c2lnbi5jb20vcmVwb3NpdG9yeS8wMwYDVR0fBCwwKjAooCagJIYiaHR0cDovL2Ny
# bC5nbG9iYWxzaWduLm5ldC9yb290LmNybDAfBgNVHSMEGDAWgBRge2YaRQ2XyolQ
# L30EzTSo//z9SzANBgkqhkiG9w0BAQUFAAOCAQEATl5WkB5GtNlJMfO7FzkoG8IW
# 3f1B3AkFBJtvsqKa1pkuQJkAVbXqP6UgdtOGNNQXzFU6x4Lu76i6vNgGnxVQ380W
# e1I6AtcZGv2v8Hhc4EvFGN86JB7arLipWAQCBzDbsBJe/jG+8ARI9PBw+DpeVoPP
# PfsNvPTF7ZedudTbpSeE4zibi6c1hkQgpDttpGoLoYP9KOva7yj2zIhd+wo7AKvg
# IeviLzVsD440RZfroveZMzV+y5qKu0VN5z+fwtmK+mWybsd+Zf/okuEsMaL3sCc2
# SI8mbzvuTXYfecPlf5Y1vC0OzAGwjn//UYCAp5LUs0RGZIyHTxZjBzFLY7Df8zCC
# BCkwggMRoAMCAQICCwQAAAAAATGJxjfoMA0GCSqGSIb3DQEBCwUAMEwxIDAeBgNV
# BAsTF0dsb2JhbFNpZ24gUm9vdCBDQSAtIFIzMRMwEQYDVQQKEwpHbG9iYWxTaWdu
# MRMwEQYDVQQDEwpHbG9iYWxTaWduMB4XDTExMDgwMjEwMDAwMFoXDTE5MDgwMjEw
# MDAwMFowWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKPv0Z8p6djTgnY8YqDS
# SdYWHvHP8NC6SEMDLacd8gE0SaQQ6WIT9BP0FoO11VdCSIYrlViH6igEdMtyEQ9h
# JuH6HGEVxyibTQuCDyYrkDqW7aTQaymc9WGI5qRXb+70cNCNF97mZnZfdB5eDFM4
# XZD03zAtGxPReZhUGks4BPQHxCMD05LL94BdqpxWBkQtQUxItC3sNZKaxpXX9c6Q
# MeJ2s2G48XVXQqw7zivIkEnotybPuwyJy9DDo2qhydXjnFMrVyb+Vpp2/WFGomDs
# KUZH8s3ggmLGBFrn7U5AXEgGfZ1f53TJnoRlDVve3NMkHLQUEeurv8QfpLqZ0BdY
# Nc0CAwEAAaOB/TCB+jAOBgNVHQ8BAf8EBAMCAQYwEgYDVR0TAQH/BAgwBgEB/wIB
# ADAdBgNVHQ4EFgQUGUq4WuRNMaUU5V7sL6Mc+oCMMmswRwYDVR0gBEAwPjA8BgRV
# HSAAMDQwMgYIKwYBBQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3Jl
# cG9zaXRvcnkvMDYGA1UdHwQvMC0wK6ApoCeGJWh0dHA6Ly9jcmwuZ2xvYmFsc2ln
# bi5uZXQvcm9vdC1yMy5jcmwwEwYDVR0lBAwwCgYIKwYBBQUHAwMwHwYDVR0jBBgw
# FoAUj/BLf6guRSSuTVD6Y5qL3uLdG7wwDQYJKoZIhvcNAQELBQADggEBAHmwaTTi
# BYf2/tRgLC+GeTQD4LEHkwyEXPnk3GzPbrXsCly6C9BoMS4/ZL0Pgmtmd4F/ximl
# F9jwiU2DJBH2bv6d4UgKKKDieySApOzCmgDXsG1szYjVFXjPE/mIpXNNwTYr3MvO
# 23580ovvL72zT006rbtibiiTxAzL2ebK4BEClAOwvT+UKFaQHlPCJ9XJPM0aYx6C
# WRW2QMqngarDVa8z0bV16AnqRwhIIvtdG/Mseml+xddaXlYzPK1X6JMlQsPSXnE7
# ShxU7alVrCgFx8RsXdw8k/ZpPIJRzhoVPV4Bc/9Aouq0rtOO+u5dbEfHQfXUVlfy
# GDcy1tTMS/Zx4HYwggSfMIIDh6ADAgECAhIRIdaZp2SXPvH4Qn7pGcxTQRQwDQYJ
# KoZIhvcNAQEFBQAwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24g
# bnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzIw
# HhcNMTYwNTI0MDAwMDAwWhcNMjcwNjI0MDAwMDAwWjBgMQswCQYDVQQGEwJTRzEf
# MB0GA1UEChMWR01PIEdsb2JhbFNpZ24gUHRlIEx0ZDEwMC4GA1UEAxMnR2xvYmFs
# U2lnbiBUU0EgZm9yIE1TIEF1dGhlbnRpY29kZSAtIEcyMIIBIjANBgkqhkiG9w0B
# AQEFAAOCAQ8AMIIBCgKCAQEAsBeuotO2BDBWHlgPse1VpNZUy9j2czrsXV6rJf02
# pfqEw2FAxUa1WVI7QqIuXxNiEKlb5nPWkiWxfSPjBrOHOg5D8NcAiVOiETFSKG5d
# QHI88gl3p0mSl9RskKB2p/243LOd8gdgLE9YmABr0xVU4Prd/4AsXximmP/Uq+yh
# RVmyLm9iXeDZGayLV5yoJivZF6UQ0kcIGnAsM4t/aIAqtaFda92NAgIpA6p8N7u7
# KU49U5OzpvqP0liTFUy5LauAo6Ml+6/3CGSwekQPXBDXX2E3qk5r09JTJZ2Cc/os
# +XKwqRk5KlD6qdA8OsroW+/1X1H0+QrZlzXeaoXmIwRCrwIDAQABo4IBXzCCAVsw
# DgYDVR0PAQH/BAQDAgeAMEwGA1UdIARFMEMwQQYJKwYBBAGgMgEeMDQwMgYIKwYB
# BQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3JlcG9zaXRvcnkvMAkG
# A1UdEwQCMAAwFgYDVR0lAQH/BAwwCgYIKwYBBQUHAwgwQgYDVR0fBDswOTA3oDWg
# M4YxaHR0cDovL2NybC5nbG9iYWxzaWduLmNvbS9ncy9nc3RpbWVzdGFtcGluZ2cy
# LmNybDBUBggrBgEFBQcBAQRIMEYwRAYIKwYBBQUHMAKGOGh0dHA6Ly9zZWN1cmUu
# Z2xvYmFsc2lnbi5jb20vY2FjZXJ0L2dzdGltZXN0YW1waW5nZzIuY3J0MB0GA1Ud
# DgQWBBTUooRKOFoYf7pPMFC9ndV6h9YJ9zAfBgNVHSMEGDAWgBRG2D7/3OO+/4Pm
# 9IWbsN1q1hSpwTANBgkqhkiG9w0BAQUFAAOCAQEAj6kakW0EpjcgDoOW3iPTa24f
# bt1kPWghIrX4RzZpjuGlRcckoiK3KQnMVFquxrzNY46zPVBI5bTMrs2SjZ4oixNK
# Eaq9o+/Tsjb8tKFyv22XY3mMRLxwL37zvN2CU6sa9uv6HJe8tjecpBwwvKu8LUc2
# 35IgA+hxxlj2dQWaNPALWVqCRDSqgOQvhPZHXZbJtsrKnbemuuRQ09Q3uLogDtDT
# kipbxFm7oW3bPM5EncE4Kq3jjb3NCXcaEL5nCgI2ZIi5sxsm7ueeYMRGqLxhM2zP
# TrmcuWrwnzf+tT1PmtNN/94gjk6Xpv2fCbxNyhh2ybBNhVDygNIdBvVYBAexGDCC
# BNYwggO+oAMCAQICEhEhDRayW4wRltP+V8mGEea62TANBgkqhkiG9w0BAQsFADBa
# MQswCQYDVQQGEwJCRTEZMBcGA1UEChMQR2xvYmFsU2lnbiBudi1zYTEwMC4GA1UE
# AxMnR2xvYmFsU2lnbiBDb2RlU2lnbmluZyBDQSAtIFNIQTI1NiAtIEcyMB4XDTE1
# MDUwNDE2NDMyMVoXDTE4MDUwNDE2NDMyMVowVTELMAkGA1UEBhMCQ0gxDDAKBgNV
# BAgTA1p1ZzEMMAoGA1UEBxMDWnVnMRQwEgYDVQQKEwtkLWZlbnMgR21iSDEUMBIG
# A1UEAxMLZC1mZW5zIEdtYkgwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB
# AQDNPSzSNPylU9jFM78Q/GjzB7N+VNqikf/use7p8mpnBZ4cf5b4qV3rqQd62rJH
# RlAsxgouCSNQrl8xxfg6/t/I02kPvrzsR4xnDgMiVCqVRAeQsWebafWdTvWmONBS
# lxJejPP8TSgXMKFaDa+2HleTycTBYSoErAZSWpQ0NqF9zBadjsJRVatQuPkTDrwL
# eWibiyOipK9fcNoQpl5ll5H9EG668YJR3fqX9o0TQTkOmxXIL3IJ0UxdpyDpLEkt
# tBG6Y5wAdpF2dQX2phrfFNVY54JOGtuBkNGMSiLFzTkBA1fOlA6ICMYjB8xIFxVv
# rN1tYojCrqYkKMOjwWQz5X8zAgMBAAGjggGZMIIBlTAOBgNVHQ8BAf8EBAMCB4Aw
# TAYDVR0gBEUwQzBBBgkrBgEEAaAyATIwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93
# d3cuZ2xvYmFsc2lnbi5jb20vcmVwb3NpdG9yeS8wCQYDVR0TBAIwADATBgNVHSUE
# DDAKBggrBgEFBQcDAzBCBgNVHR8EOzA5MDegNaAzhjFodHRwOi8vY3JsLmdsb2Jh
# bHNpZ24uY29tL2dzL2dzY29kZXNpZ25zaGEyZzIuY3JsMIGQBggrBgEFBQcBAQSB
# gzCBgDBEBggrBgEFBQcwAoY4aHR0cDovL3NlY3VyZS5nbG9iYWxzaWduLmNvbS9j
# YWNlcnQvZ3Njb2Rlc2lnbnNoYTJnMi5jcnQwOAYIKwYBBQUHMAGGLGh0dHA6Ly9v
# Y3NwMi5nbG9iYWxzaWduLmNvbS9nc2NvZGVzaWduc2hhMmcyMB0GA1UdDgQWBBTN
# GDddiIYZy9p3Z84iSIMd27rtUDAfBgNVHSMEGDAWgBQZSrha5E0xpRTlXuwvoxz6
# gIwyazANBgkqhkiG9w0BAQsFAAOCAQEAAApsOzSX1alF00fTeijB/aIthO3UB0ks
# 1Gg3xoKQC1iEQmFG/qlFLiufs52kRPN7L0a7ClNH3iQpaH5IEaUENT9cNEXdKTBG
# 8OrJS8lrDJXImgNEgtSwz0B40h7bM2Z+0DvXDvpmfyM2NwHF/nNVj7NzmczrLRqN
# 9de3tV0pgRqnIYordVcmb24CZl3bzpwzbQQy14Iz+P5Z2cnw+QaYzAuweTZxEUcJ
# bFwpM49c1LMPFJTuOKkUgY90JJ3gVTpyQxfkc7DNBnx74PlRzjFmeGC/hxQt0hvo
# eaAiBdjo/1uuCTToigVnyRH+c0T2AezTeoFb7ne3I538hWeTdU5q9jGCBLcwggSz
# AgEBMHAwWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MgISESENFrJbjBGW0/5XyYYR5rrZMAkGBSsOAwIaBQCgeDAYBgorBgEEAYI3AgEM
# MQowCKACgAChAoAAMBkGCSqGSIb3DQEJAzEMBgorBgEEAYI3AgEEMBwGCisGAQQB
# gjcCAQsxDjAMBgorBgEEAYI3AgEVMCMGCSqGSIb3DQEJBDEWBBRa26RVZWeu5RlS
# RzauoQXlVtARqDANBgkqhkiG9w0BAQEFAASCAQBMnmi63duVBPNIiPKgYQbmR6dA
# wG9yM5UBb6hE7qXyqz3fZOqmTGC6kcWJq0uSkEPSH7/UeBd9vwScvuBRHJOyyjpM
# 5yVMUkU+Es835XSyNI5tccaX7lwJ8pgliQIrH4gRBRpp2Ya2rZJ3oR/ihMQFJY5x
# HmxXYK3LuqNPAfPV7xZooGnPPm9SyjSYxLBZnZ1/oSNDqdESQhPBjFrJT1nQ9MGt
# quCnQZv51YgWkCqDri52CfVLt+zDOGGtTVRvzRLQEe46+D+HWcXZUA3aKLeCQodT
# fnQNE8OrQldqEU5HFRkmaAxD+dBKtpz5C7sspDhbIN0Uql1/DsMbS+vqpih1oYIC
# ojCCAp4GCSqGSIb3DQEJBjGCAo8wggKLAgEBMGgwUjELMAkGA1UEBhMCQkUxGTAX
# BgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGlt
# ZXN0YW1waW5nIENBIC0gRzICEhEh1pmnZJc+8fhCfukZzFNBFDAJBgUrDgMCGgUA
# oIH9MBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTE2
# MDgzMTE5MTY0MFowIwYJKoZIhvcNAQkEMRYEFKi/3V9uqEMfQ/4vILtM6gPlmIub
# MIGdBgsqhkiG9w0BCRACDDGBjTCBijCBhzCBhAQUY7gvq2H1g5CWlQULACScUCkz
# 7HkwbDBWpFQwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYt
# c2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzICEhEh
# 1pmnZJc+8fhCfukZzFNBFDANBgkqhkiG9w0BAQEFAASCAQBDLtUdRV/9Z72V7QkB
# RA+TLB4obC4Y9OXAJNTBkLXuaPj14+rPQuNmk1T6xSZ+1E/yGbGS+Db+qjdpSpKG
# ioIpf1oaKFOBYDADQAo1NEEc7fXqpinmB66mNwBuTTQ48UALDoUcPGtBRx3lz6pR
# m3nehOubK3bkbM/zPljywyzJUe4Mq9jrAZfuRYS4FLjw8k6TPHPpkUX4bpIYJbR4
# fmV54kNnubTB1ItCkgLUb/Cbla+7waYsDOYSiaOHgPk1l7QWcsV0o2Naxdg6NJV2
# iOsKiTYdl9Q8WEWw1Awj6KaIZ2PuLyRguHXEOWqEdZxoDVUnEl2f1umoPYryltZz
# rJAT
# SIG # End signature block
|
PowerShellCorpus/PowerShellGallery/biz.dfch.PS.Appclusive.Client/5.2.1.20161201/Invoke-EntityAction.ps1
|
Invoke-EntityAction.ps1
|
function Invoke-EntityAction {
<#
.SYNOPSIS
Invokes a Entity action in Appclusive.
.DESCRIPTION
Invokes a Entity action in Appclusive.
You must specify the parameters 'EntityId', 'EntitySetName' (or pipe on an existing Entity) and the 'EntityActionName'.
.EXAMPLE
Invoke-EntityAction -EntityId 12 -EntitySetName Nodes -EntityActionName InvokeAction -InputName FullManaged -InputParameters @{'ComputerRole'='CAS'}
Name Id InputParameters
---- -- ---------------
Nodes 12 {Name, Parameters}
Updates a Node entry to Status 'FullManaged'.
.EXAMPLE
Get-Node 12 | Invoke-EntityAction -EntityActionName InvokeAction -InputName FullManaged -InputParameters @{'ComputerRole'='CAS'}
Name Id InputParameters
---- -- ---------------
Srv01 12 {Name, Parameters}
Similar to the previous example, but as pipe from Get-Node.
.EXAMPLE
Invoke-ApcEntityAction -EntityId 12 -EntitySetName Nodes -EntityActionName Status -ExpectedResult single
Status : FullManaged
RefId : 13
Token : optional
TenantId : 22222222-2222-2222-2222-222222222222
EntityKindId : 1
Parameters : optional
Condition :
ConditionParameters :
Error : optional
EndTime :
ParentId : 1
Id : 12
Tid : 22222222-2222-2222-2222-222222222222
Name : biz.dfch.CS.Appclusive.Core.OdataServices.Core.Node
Description : biz.dfch.CS.Appclusive.Core.OdataServices.Core.Node
CreatedById : 60
ModifiedById : 60
Created : 05.01.2016 20:04:54 +01:00
Modified : 06.01.2016 14:42:39 +01:00
RowVersion : {0, 0, 0, 0...}
EntityKind :
Parent :
Children : {}
Tenant :
CreatedBy :
ModifiedBy :
Returns the corresponding Job entry from the Node with Id 12.
.EXAMPLE
Invoke-ApcEntityAction -EntityId 12 -EntitySetName Nodes -EntityActionName AvailableActions -ExpectedResult list
BA01ReturnToUnmanaged
BD01EnableFullCustomerMaintenance
BF01ReturnToLimitedManaged
Returns the available actions from the Node with Id 12.
.EXAMPLE
Invoke-ApcEntityAction -EntityId 13 -EntitySetName Jobs -EntityActionName JobResult -InputParameters @{Message='Job action successfully',Succeeded=$true}
Name Id InputParameters
---- -- ---------------
Job action successfully 13 {JobResult}
Returns confirmation.
.EXAMPLE
Get-ApcJob -Id 13 | Invoke-ApcEntityAction -EntityActionName JobResult -InputParameters @{Message='Job action successfully',Succeeded=$true}
Name Id InputParameters
---- -- ---------------
Job action successfully 13 {JobResult}
Similar to the previous example, but as pipe from Get-Job.
.EXAMPLE
Get-ApcNode -Id 12 -ExpandJob | Invoke-ApcEntityAction -EntityActionName JobResult -InputParameters @{Message='Job action successfully',Succeeded=$true}
Name Id InputParameters
---- -- ---------------
Job action successfully 13 {JobResult}
Similar to the previous example, but as pipe from Get-Node.
.LINK
Online Version: http://dfch.biz/biz/dfch/PS/Appclusive/Client/Invoke-EntityAction/
.NOTES
See module manifest for dependencies and further requirements.
#>
[CmdletBinding(
SupportsShouldProcess = $true
,
ConfirmImpact = 'Low'
,
HelpURI = 'http://dfch.biz/biz/dfch/PS/Appclusive/Client/Invoke-EntityAction/'
)]
PARAM
(
# Specifies an reference object of the entity
[Parameter(Mandatory = $false, ValueFromPipeline = $true, Position = 0, ParameterSetName = 'pipe')]
$InputObject
,
# Specifies the id of the entity
[Parameter(Mandatory = $false, Position = 0, ParameterSetName = 'id')]
[long] $EntityId
,
# Specifies the entitiyset name of the entity
[Parameter(Mandatory = $true, Position = 1, ParameterSetName = 'id')]
$EntitySetName
,
# Specifies the invoke action name
[Parameter(Mandatory = $true, Position = 2)]
[string] $EntityActionName
,
# Specifies the invoke entity action
[Parameter(Mandatory = $false, Position = 3)]
[string] $InputName
,
# Specifies the parameters of the entity action
[Parameter(Mandatory = $false, Position = 4)]
$InputParameters
,
[Parameter(Mandatory = $false, Position = 5)]
[ValidateSet('void', 'single', 'list')]
[string] $ExpectedResult = 'void'
,
# Service reference to Appclusive
[Parameter(Mandatory = $false, Position = 6)]
[Alias('Services')]
[hashtable] $svc = (Get-Variable -Name $MyInvocation.MyCommand.Module.PrivateData.MODULEVAR -ValueOnly).Services
,
# Specifies the return format of the Cnmdlet
[ValidateSet('default', 'json', 'json-pretty', 'xml', 'xml-pretty')]
[Parameter(Mandatory = $false, Position = 7)]
[alias('ReturnFormat')]
[string] $As = 'default'
)
Begin
{
trap { Log-Exception $_; break; }
$datBegin = [datetime]::Now;
[string] $fn = $MyInvocation.MyCommand.Name;
Log-Debug -fn $fn -msg ("CALL. svc '{0}'. Name '{1}'." -f ($svc -is [Object]), $Name) -fac 1;
# Parameter validation
Contract-Requires ($svc.Core -is [biz.dfch.CS.Appclusive.Api.Core.Core]) "Connect to the server before using the Cmdlet"
}
# Begin
Process
{
trap { Log-Exception $_; break; }
# Default test variable for checking function response codes.
[Boolean] $fReturn = $false;
# Return values are always and only returned via OutputParameter.
$OutputParameter = $null;
# Parameter validation
Contract-Assert ($PSCmdlet.ShouldProcess(($PSBoundParameters | Out-String)))
$InvokeActionMethodName = 'InvokeEntityActionWith{0}Result' -f $ExpectedResult;
switch($ExpectedResult)
{
'void' { $ResultType = $null; }
'single'{ $ResultType = [System.Object]; }
'list' { $ResultType = [string]; }
Default { $ResultType = $null; }
}
switch($EntityActionName)
{
'JobResult' { $EntityActionInputParameters = @{$EntityActionName = ($InputParameters | ConvertTo-Json -Compress).ToString()}; }
Default { $EntityActionInputParameters = $InputParameters; }
}
if($PSBoundParameters.ContainsKey('InputName'))
{
if($InputParameters -is [hashtable])
{
$EntityActionInputParameters = ($InputParameters | ConvertTo-Json -Compress).ToString();
}
$EntityActionInputParameters = @{'Name' = $InputName; 'Parameters' = $EntityActionInputParameters };
}
$r = @();
if($PSCmdlet.ParameterSetName -eq 'pipe')
{
# Get ValueFromPipeline
foreach($Object in $InputObject)
{
if($PSCmdlet.ShouldProcess($Object))
{
if ( !$ResultType )
{
$r += ($Object | Select -Property Name, Id, @{Name="InputParameters"; Expression={$EntityActionInputParameters}});
$svc.Core.$InvokeActionMethodName($Object, $EntityActionName, $EntityActionInputParameters);
}
else
{
$r += $svc.Core.$InvokeActionMethodName($Object, $EntityActionName, $ResultType, $EntityActionInputParameters);
}
}
}
}
else
{
if ( !$ResultType )
{
$r += ($EntityId | Select -Property @{Name="Name"; Expression={$EntitySetName}}, @{Name="Id"; Expression={$_}}, @{Name="InputParameters"; Expression={$EntityActionInputParameters}});
$svc.Core.$InvokeActionMethodName($EntitySetName, [long]$EntityId, $EntityActionName, $EntityActionInputParameters);
}
else
{
$r += $svc.Core.$InvokeActionMethodName($EntitySetName, [long]$EntityId, $EntityActionName, $ResultType, $EntityActionInputParameters);
}
}
$OutputParameter = Format-ResultAs $r $As;
$fReturn = $true;
}
# Process
End
{
$datEnd = [datetime]::Now;
Log-Debug -fn $fn -msg ("RET. fReturn: [{0}]. Execution time: [{1}]ms. Started: [{2}]." -f $fReturn, ($datEnd - $datBegin).TotalMilliseconds, $datBegin.ToString('yyyy-MM-dd HH:mm:ss.fffzzz')) -fac 2;
# Return values are always and only returned via OutputParameter.
return $OutputParameter;
}
# End
} # function
if($MyInvocation.ScriptName) { Export-ModuleMember -Function Invoke-EntityAction; }
#
# Copyright 2014-2015 d-fens GmbH
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SIG # Begin signature block
# MIIXDwYJKoZIhvcNAQcCoIIXADCCFvwCAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB
# gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR
# AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQUZ+PYVVw6pUW4rR6i5m78zwJU
# sgqgghHCMIIEFDCCAvygAwIBAgILBAAAAAABL07hUtcwDQYJKoZIhvcNAQEFBQAw
# VzELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNV
# BAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkdsb2JhbFNpZ24gUm9vdCBDQTAeFw0xMTA0
# MTMxMDAwMDBaFw0yODAxMjgxMjAwMDBaMFIxCzAJBgNVBAYTAkJFMRkwFwYDVQQK
# ExBHbG9iYWxTaWduIG52LXNhMSgwJgYDVQQDEx9HbG9iYWxTaWduIFRpbWVzdGFt
# cGluZyBDQSAtIEcyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAlO9l
# +LVXn6BTDTQG6wkft0cYasvwW+T/J6U00feJGr+esc0SQW5m1IGghYtkWkYvmaCN
# d7HivFzdItdqZ9C76Mp03otPDbBS5ZBb60cO8eefnAuQZT4XljBFcm05oRc2yrmg
# jBtPCBn2gTGtYRakYua0QJ7D/PuV9vu1LpWBmODvxevYAll4d/eq41JrUJEpxfz3
# zZNl0mBhIvIG+zLdFlH6Dv2KMPAXCae78wSuq5DnbN96qfTvxGInX2+ZbTh0qhGL
# 2t/HFEzphbLswn1KJo/nVrqm4M+SU4B09APsaLJgvIQgAIMboe60dAXBKY5i0Eex
# +vBTzBj5Ljv5cH60JQIDAQABo4HlMIHiMA4GA1UdDwEB/wQEAwIBBjASBgNVHRMB
# Af8ECDAGAQH/AgEAMB0GA1UdDgQWBBRG2D7/3OO+/4Pm9IWbsN1q1hSpwTBHBgNV
# HSAEQDA+MDwGBFUdIAAwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93d3cuZ2xvYmFs
# c2lnbi5jb20vcmVwb3NpdG9yeS8wMwYDVR0fBCwwKjAooCagJIYiaHR0cDovL2Ny
# bC5nbG9iYWxzaWduLm5ldC9yb290LmNybDAfBgNVHSMEGDAWgBRge2YaRQ2XyolQ
# L30EzTSo//z9SzANBgkqhkiG9w0BAQUFAAOCAQEATl5WkB5GtNlJMfO7FzkoG8IW
# 3f1B3AkFBJtvsqKa1pkuQJkAVbXqP6UgdtOGNNQXzFU6x4Lu76i6vNgGnxVQ380W
# e1I6AtcZGv2v8Hhc4EvFGN86JB7arLipWAQCBzDbsBJe/jG+8ARI9PBw+DpeVoPP
# PfsNvPTF7ZedudTbpSeE4zibi6c1hkQgpDttpGoLoYP9KOva7yj2zIhd+wo7AKvg
# IeviLzVsD440RZfroveZMzV+y5qKu0VN5z+fwtmK+mWybsd+Zf/okuEsMaL3sCc2
# SI8mbzvuTXYfecPlf5Y1vC0OzAGwjn//UYCAp5LUs0RGZIyHTxZjBzFLY7Df8zCC
# BCkwggMRoAMCAQICCwQAAAAAATGJxjfoMA0GCSqGSIb3DQEBCwUAMEwxIDAeBgNV
# BAsTF0dsb2JhbFNpZ24gUm9vdCBDQSAtIFIzMRMwEQYDVQQKEwpHbG9iYWxTaWdu
# MRMwEQYDVQQDEwpHbG9iYWxTaWduMB4XDTExMDgwMjEwMDAwMFoXDTE5MDgwMjEw
# MDAwMFowWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKPv0Z8p6djTgnY8YqDS
# SdYWHvHP8NC6SEMDLacd8gE0SaQQ6WIT9BP0FoO11VdCSIYrlViH6igEdMtyEQ9h
# JuH6HGEVxyibTQuCDyYrkDqW7aTQaymc9WGI5qRXb+70cNCNF97mZnZfdB5eDFM4
# XZD03zAtGxPReZhUGks4BPQHxCMD05LL94BdqpxWBkQtQUxItC3sNZKaxpXX9c6Q
# MeJ2s2G48XVXQqw7zivIkEnotybPuwyJy9DDo2qhydXjnFMrVyb+Vpp2/WFGomDs
# KUZH8s3ggmLGBFrn7U5AXEgGfZ1f53TJnoRlDVve3NMkHLQUEeurv8QfpLqZ0BdY
# Nc0CAwEAAaOB/TCB+jAOBgNVHQ8BAf8EBAMCAQYwEgYDVR0TAQH/BAgwBgEB/wIB
# ADAdBgNVHQ4EFgQUGUq4WuRNMaUU5V7sL6Mc+oCMMmswRwYDVR0gBEAwPjA8BgRV
# HSAAMDQwMgYIKwYBBQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3Jl
# cG9zaXRvcnkvMDYGA1UdHwQvMC0wK6ApoCeGJWh0dHA6Ly9jcmwuZ2xvYmFsc2ln
# bi5uZXQvcm9vdC1yMy5jcmwwEwYDVR0lBAwwCgYIKwYBBQUHAwMwHwYDVR0jBBgw
# FoAUj/BLf6guRSSuTVD6Y5qL3uLdG7wwDQYJKoZIhvcNAQELBQADggEBAHmwaTTi
# BYf2/tRgLC+GeTQD4LEHkwyEXPnk3GzPbrXsCly6C9BoMS4/ZL0Pgmtmd4F/ximl
# F9jwiU2DJBH2bv6d4UgKKKDieySApOzCmgDXsG1szYjVFXjPE/mIpXNNwTYr3MvO
# 23580ovvL72zT006rbtibiiTxAzL2ebK4BEClAOwvT+UKFaQHlPCJ9XJPM0aYx6C
# WRW2QMqngarDVa8z0bV16AnqRwhIIvtdG/Mseml+xddaXlYzPK1X6JMlQsPSXnE7
# ShxU7alVrCgFx8RsXdw8k/ZpPIJRzhoVPV4Bc/9Aouq0rtOO+u5dbEfHQfXUVlfy
# GDcy1tTMS/Zx4HYwggSfMIIDh6ADAgECAhIRIdaZp2SXPvH4Qn7pGcxTQRQwDQYJ
# KoZIhvcNAQEFBQAwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24g
# bnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzIw
# HhcNMTYwNTI0MDAwMDAwWhcNMjcwNjI0MDAwMDAwWjBgMQswCQYDVQQGEwJTRzEf
# MB0GA1UEChMWR01PIEdsb2JhbFNpZ24gUHRlIEx0ZDEwMC4GA1UEAxMnR2xvYmFs
# U2lnbiBUU0EgZm9yIE1TIEF1dGhlbnRpY29kZSAtIEcyMIIBIjANBgkqhkiG9w0B
# AQEFAAOCAQ8AMIIBCgKCAQEAsBeuotO2BDBWHlgPse1VpNZUy9j2czrsXV6rJf02
# pfqEw2FAxUa1WVI7QqIuXxNiEKlb5nPWkiWxfSPjBrOHOg5D8NcAiVOiETFSKG5d
# QHI88gl3p0mSl9RskKB2p/243LOd8gdgLE9YmABr0xVU4Prd/4AsXximmP/Uq+yh
# RVmyLm9iXeDZGayLV5yoJivZF6UQ0kcIGnAsM4t/aIAqtaFda92NAgIpA6p8N7u7
# KU49U5OzpvqP0liTFUy5LauAo6Ml+6/3CGSwekQPXBDXX2E3qk5r09JTJZ2Cc/os
# +XKwqRk5KlD6qdA8OsroW+/1X1H0+QrZlzXeaoXmIwRCrwIDAQABo4IBXzCCAVsw
# DgYDVR0PAQH/BAQDAgeAMEwGA1UdIARFMEMwQQYJKwYBBAGgMgEeMDQwMgYIKwYB
# BQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3JlcG9zaXRvcnkvMAkG
# A1UdEwQCMAAwFgYDVR0lAQH/BAwwCgYIKwYBBQUHAwgwQgYDVR0fBDswOTA3oDWg
# M4YxaHR0cDovL2NybC5nbG9iYWxzaWduLmNvbS9ncy9nc3RpbWVzdGFtcGluZ2cy
# LmNybDBUBggrBgEFBQcBAQRIMEYwRAYIKwYBBQUHMAKGOGh0dHA6Ly9zZWN1cmUu
# Z2xvYmFsc2lnbi5jb20vY2FjZXJ0L2dzdGltZXN0YW1waW5nZzIuY3J0MB0GA1Ud
# DgQWBBTUooRKOFoYf7pPMFC9ndV6h9YJ9zAfBgNVHSMEGDAWgBRG2D7/3OO+/4Pm
# 9IWbsN1q1hSpwTANBgkqhkiG9w0BAQUFAAOCAQEAj6kakW0EpjcgDoOW3iPTa24f
# bt1kPWghIrX4RzZpjuGlRcckoiK3KQnMVFquxrzNY46zPVBI5bTMrs2SjZ4oixNK
# Eaq9o+/Tsjb8tKFyv22XY3mMRLxwL37zvN2CU6sa9uv6HJe8tjecpBwwvKu8LUc2
# 35IgA+hxxlj2dQWaNPALWVqCRDSqgOQvhPZHXZbJtsrKnbemuuRQ09Q3uLogDtDT
# kipbxFm7oW3bPM5EncE4Kq3jjb3NCXcaEL5nCgI2ZIi5sxsm7ueeYMRGqLxhM2zP
# TrmcuWrwnzf+tT1PmtNN/94gjk6Xpv2fCbxNyhh2ybBNhVDygNIdBvVYBAexGDCC
# BNYwggO+oAMCAQICEhEhDRayW4wRltP+V8mGEea62TANBgkqhkiG9w0BAQsFADBa
# MQswCQYDVQQGEwJCRTEZMBcGA1UEChMQR2xvYmFsU2lnbiBudi1zYTEwMC4GA1UE
# AxMnR2xvYmFsU2lnbiBDb2RlU2lnbmluZyBDQSAtIFNIQTI1NiAtIEcyMB4XDTE1
# MDUwNDE2NDMyMVoXDTE4MDUwNDE2NDMyMVowVTELMAkGA1UEBhMCQ0gxDDAKBgNV
# BAgTA1p1ZzEMMAoGA1UEBxMDWnVnMRQwEgYDVQQKEwtkLWZlbnMgR21iSDEUMBIG
# A1UEAxMLZC1mZW5zIEdtYkgwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB
# AQDNPSzSNPylU9jFM78Q/GjzB7N+VNqikf/use7p8mpnBZ4cf5b4qV3rqQd62rJH
# RlAsxgouCSNQrl8xxfg6/t/I02kPvrzsR4xnDgMiVCqVRAeQsWebafWdTvWmONBS
# lxJejPP8TSgXMKFaDa+2HleTycTBYSoErAZSWpQ0NqF9zBadjsJRVatQuPkTDrwL
# eWibiyOipK9fcNoQpl5ll5H9EG668YJR3fqX9o0TQTkOmxXIL3IJ0UxdpyDpLEkt
# tBG6Y5wAdpF2dQX2phrfFNVY54JOGtuBkNGMSiLFzTkBA1fOlA6ICMYjB8xIFxVv
# rN1tYojCrqYkKMOjwWQz5X8zAgMBAAGjggGZMIIBlTAOBgNVHQ8BAf8EBAMCB4Aw
# TAYDVR0gBEUwQzBBBgkrBgEEAaAyATIwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93
# d3cuZ2xvYmFsc2lnbi5jb20vcmVwb3NpdG9yeS8wCQYDVR0TBAIwADATBgNVHSUE
# DDAKBggrBgEFBQcDAzBCBgNVHR8EOzA5MDegNaAzhjFodHRwOi8vY3JsLmdsb2Jh
# bHNpZ24uY29tL2dzL2dzY29kZXNpZ25zaGEyZzIuY3JsMIGQBggrBgEFBQcBAQSB
# gzCBgDBEBggrBgEFBQcwAoY4aHR0cDovL3NlY3VyZS5nbG9iYWxzaWduLmNvbS9j
# YWNlcnQvZ3Njb2Rlc2lnbnNoYTJnMi5jcnQwOAYIKwYBBQUHMAGGLGh0dHA6Ly9v
# Y3NwMi5nbG9iYWxzaWduLmNvbS9nc2NvZGVzaWduc2hhMmcyMB0GA1UdDgQWBBTN
# GDddiIYZy9p3Z84iSIMd27rtUDAfBgNVHSMEGDAWgBQZSrha5E0xpRTlXuwvoxz6
# gIwyazANBgkqhkiG9w0BAQsFAAOCAQEAAApsOzSX1alF00fTeijB/aIthO3UB0ks
# 1Gg3xoKQC1iEQmFG/qlFLiufs52kRPN7L0a7ClNH3iQpaH5IEaUENT9cNEXdKTBG
# 8OrJS8lrDJXImgNEgtSwz0B40h7bM2Z+0DvXDvpmfyM2NwHF/nNVj7NzmczrLRqN
# 9de3tV0pgRqnIYordVcmb24CZl3bzpwzbQQy14Iz+P5Z2cnw+QaYzAuweTZxEUcJ
# bFwpM49c1LMPFJTuOKkUgY90JJ3gVTpyQxfkc7DNBnx74PlRzjFmeGC/hxQt0hvo
# eaAiBdjo/1uuCTToigVnyRH+c0T2AezTeoFb7ne3I538hWeTdU5q9jGCBLcwggSz
# AgEBMHAwWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MgISESENFrJbjBGW0/5XyYYR5rrZMAkGBSsOAwIaBQCgeDAYBgorBgEEAYI3AgEM
# MQowCKACgAChAoAAMBkGCSqGSIb3DQEJAzEMBgorBgEEAYI3AgEEMBwGCisGAQQB
# gjcCAQsxDjAMBgorBgEEAYI3AgEVMCMGCSqGSIb3DQEJBDEWBBSyCYVA6AndCmau
# uijZu1B57bX5ZTANBgkqhkiG9w0BAQEFAASCAQCx3NJ2Pu2lfkyZtNTKJzcdK4RW
# 8OYpJq9u4qkxkb6XVphIdJlAbDk6Dz4maiOW/kHPwVKIY9Gg4CsZNv5YnBhHEcL7
# hezjPt71xz2fqYkYkTWmCj7gfOf4zWrUrXKKGjqiLmx/oR4Ra1bn47oucthjhvMu
# xKAtztDnLV0CnbVAnYKj8k8q6WvGhSd0wIg77kc0L4Sujf5tJr8+NRx+xNdU7CgU
# 22zt93mptY3HWHNeau9KptlksXcWiktxYDN96Yl9D1cN4HIiaU3no+EInsXi7e5O
# dZR2CeIy7ERLTqFyC/5Qz9scjr/0ty78ffYxgu2yxorrVUNjrS9OtG3ieFPsoYIC
# ojCCAp4GCSqGSIb3DQEJBjGCAo8wggKLAgEBMGgwUjELMAkGA1UEBhMCQkUxGTAX
# BgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGlt
# ZXN0YW1waW5nIENBIC0gRzICEhEh1pmnZJc+8fhCfukZzFNBFDAJBgUrDgMCGgUA
# oIH9MBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTE2
# MDgzMTE5MTY1MFowIwYJKoZIhvcNAQkEMRYEFCFTAX1ThgvwuENzrvH+pMaUN1c6
# MIGdBgsqhkiG9w0BCRACDDGBjTCBijCBhzCBhAQUY7gvq2H1g5CWlQULACScUCkz
# 7HkwbDBWpFQwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYt
# c2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzICEhEh
# 1pmnZJc+8fhCfukZzFNBFDANBgkqhkiG9w0BAQEFAASCAQAcAzFVU5ewwSdullai
# XJFVcAa4pMjlqUb9rOQZeM+d7cYmRONjm0RRvLunFNzkmW6neF5YB4COlY73W5VX
# 2G3mVx+NhovjtThF7KODZwpjsox3FAvV9EI3a261dHYEEHlMpa3isPBcxiuW9aYO
# jGBzA5pJ8IsDtbqcRE0wf1CwocayuH+JlpEzmZ5zo4GskcxAo2/zNCCDbCgkmwSI
# SIjqIGKckWM3vibh5YFnU9zUofkGMMXigpLSIym3XqQRGU+79UuRwqPEC21wXmZc
# OjXvCwpK6F1ZcixKbKMJYGoIOXNiYhgcVlI44qRi74enN1o1ZtZ/VWNaXUNKu+rc
# mosH
# SIG # End signature block
|
PowerShellCorpus/PowerShellGallery/biz.dfch.PS.Appclusive.Client/5.2.1.20161201/Format-ResultAs.ps1
|
Format-ResultAs.ps1
|
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseSingularNouns", "")]
PARAM()
function Format-ResultAs([object] $Result, [string] $As)
{
switch($As)
{
'xml' { $OutputParameter = (ConvertTo-Xml -InputObject $Result).OuterXml; }
'xml-pretty' { $OutputParameter = Format-Xml -String (ConvertTo-Xml -InputObject $Result).OuterXml; }
'json' { $OutputParameter = ConvertTo-Json -InputObject $Result -Compress; }
'json-pretty' { $OutputParameter = ConvertTo-Json -InputObject $Result; }
Default { $OutputParameter = $Result; }
}
return $OutputParameter;
}
#
# Copyright 2014-2015 d-fens GmbH
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SIG # Begin signature block
# MIIXDwYJKoZIhvcNAQcCoIIXADCCFvwCAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB
# gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR
# AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQUyhWMqSS3Z+FLGm94NxWZqqVs
# 8WigghHCMIIEFDCCAvygAwIBAgILBAAAAAABL07hUtcwDQYJKoZIhvcNAQEFBQAw
# VzELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNV
# BAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkdsb2JhbFNpZ24gUm9vdCBDQTAeFw0xMTA0
# MTMxMDAwMDBaFw0yODAxMjgxMjAwMDBaMFIxCzAJBgNVBAYTAkJFMRkwFwYDVQQK
# ExBHbG9iYWxTaWduIG52LXNhMSgwJgYDVQQDEx9HbG9iYWxTaWduIFRpbWVzdGFt
# cGluZyBDQSAtIEcyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAlO9l
# +LVXn6BTDTQG6wkft0cYasvwW+T/J6U00feJGr+esc0SQW5m1IGghYtkWkYvmaCN
# d7HivFzdItdqZ9C76Mp03otPDbBS5ZBb60cO8eefnAuQZT4XljBFcm05oRc2yrmg
# jBtPCBn2gTGtYRakYua0QJ7D/PuV9vu1LpWBmODvxevYAll4d/eq41JrUJEpxfz3
# zZNl0mBhIvIG+zLdFlH6Dv2KMPAXCae78wSuq5DnbN96qfTvxGInX2+ZbTh0qhGL
# 2t/HFEzphbLswn1KJo/nVrqm4M+SU4B09APsaLJgvIQgAIMboe60dAXBKY5i0Eex
# +vBTzBj5Ljv5cH60JQIDAQABo4HlMIHiMA4GA1UdDwEB/wQEAwIBBjASBgNVHRMB
# Af8ECDAGAQH/AgEAMB0GA1UdDgQWBBRG2D7/3OO+/4Pm9IWbsN1q1hSpwTBHBgNV
# HSAEQDA+MDwGBFUdIAAwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93d3cuZ2xvYmFs
# c2lnbi5jb20vcmVwb3NpdG9yeS8wMwYDVR0fBCwwKjAooCagJIYiaHR0cDovL2Ny
# bC5nbG9iYWxzaWduLm5ldC9yb290LmNybDAfBgNVHSMEGDAWgBRge2YaRQ2XyolQ
# L30EzTSo//z9SzANBgkqhkiG9w0BAQUFAAOCAQEATl5WkB5GtNlJMfO7FzkoG8IW
# 3f1B3AkFBJtvsqKa1pkuQJkAVbXqP6UgdtOGNNQXzFU6x4Lu76i6vNgGnxVQ380W
# e1I6AtcZGv2v8Hhc4EvFGN86JB7arLipWAQCBzDbsBJe/jG+8ARI9PBw+DpeVoPP
# PfsNvPTF7ZedudTbpSeE4zibi6c1hkQgpDttpGoLoYP9KOva7yj2zIhd+wo7AKvg
# IeviLzVsD440RZfroveZMzV+y5qKu0VN5z+fwtmK+mWybsd+Zf/okuEsMaL3sCc2
# SI8mbzvuTXYfecPlf5Y1vC0OzAGwjn//UYCAp5LUs0RGZIyHTxZjBzFLY7Df8zCC
# BCkwggMRoAMCAQICCwQAAAAAATGJxjfoMA0GCSqGSIb3DQEBCwUAMEwxIDAeBgNV
# BAsTF0dsb2JhbFNpZ24gUm9vdCBDQSAtIFIzMRMwEQYDVQQKEwpHbG9iYWxTaWdu
# MRMwEQYDVQQDEwpHbG9iYWxTaWduMB4XDTExMDgwMjEwMDAwMFoXDTE5MDgwMjEw
# MDAwMFowWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKPv0Z8p6djTgnY8YqDS
# SdYWHvHP8NC6SEMDLacd8gE0SaQQ6WIT9BP0FoO11VdCSIYrlViH6igEdMtyEQ9h
# JuH6HGEVxyibTQuCDyYrkDqW7aTQaymc9WGI5qRXb+70cNCNF97mZnZfdB5eDFM4
# XZD03zAtGxPReZhUGks4BPQHxCMD05LL94BdqpxWBkQtQUxItC3sNZKaxpXX9c6Q
# MeJ2s2G48XVXQqw7zivIkEnotybPuwyJy9DDo2qhydXjnFMrVyb+Vpp2/WFGomDs
# KUZH8s3ggmLGBFrn7U5AXEgGfZ1f53TJnoRlDVve3NMkHLQUEeurv8QfpLqZ0BdY
# Nc0CAwEAAaOB/TCB+jAOBgNVHQ8BAf8EBAMCAQYwEgYDVR0TAQH/BAgwBgEB/wIB
# ADAdBgNVHQ4EFgQUGUq4WuRNMaUU5V7sL6Mc+oCMMmswRwYDVR0gBEAwPjA8BgRV
# HSAAMDQwMgYIKwYBBQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3Jl
# cG9zaXRvcnkvMDYGA1UdHwQvMC0wK6ApoCeGJWh0dHA6Ly9jcmwuZ2xvYmFsc2ln
# bi5uZXQvcm9vdC1yMy5jcmwwEwYDVR0lBAwwCgYIKwYBBQUHAwMwHwYDVR0jBBgw
# FoAUj/BLf6guRSSuTVD6Y5qL3uLdG7wwDQYJKoZIhvcNAQELBQADggEBAHmwaTTi
# BYf2/tRgLC+GeTQD4LEHkwyEXPnk3GzPbrXsCly6C9BoMS4/ZL0Pgmtmd4F/ximl
# F9jwiU2DJBH2bv6d4UgKKKDieySApOzCmgDXsG1szYjVFXjPE/mIpXNNwTYr3MvO
# 23580ovvL72zT006rbtibiiTxAzL2ebK4BEClAOwvT+UKFaQHlPCJ9XJPM0aYx6C
# WRW2QMqngarDVa8z0bV16AnqRwhIIvtdG/Mseml+xddaXlYzPK1X6JMlQsPSXnE7
# ShxU7alVrCgFx8RsXdw8k/ZpPIJRzhoVPV4Bc/9Aouq0rtOO+u5dbEfHQfXUVlfy
# GDcy1tTMS/Zx4HYwggSfMIIDh6ADAgECAhIRIdaZp2SXPvH4Qn7pGcxTQRQwDQYJ
# KoZIhvcNAQEFBQAwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24g
# bnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzIw
# HhcNMTYwNTI0MDAwMDAwWhcNMjcwNjI0MDAwMDAwWjBgMQswCQYDVQQGEwJTRzEf
# MB0GA1UEChMWR01PIEdsb2JhbFNpZ24gUHRlIEx0ZDEwMC4GA1UEAxMnR2xvYmFs
# U2lnbiBUU0EgZm9yIE1TIEF1dGhlbnRpY29kZSAtIEcyMIIBIjANBgkqhkiG9w0B
# AQEFAAOCAQ8AMIIBCgKCAQEAsBeuotO2BDBWHlgPse1VpNZUy9j2czrsXV6rJf02
# pfqEw2FAxUa1WVI7QqIuXxNiEKlb5nPWkiWxfSPjBrOHOg5D8NcAiVOiETFSKG5d
# QHI88gl3p0mSl9RskKB2p/243LOd8gdgLE9YmABr0xVU4Prd/4AsXximmP/Uq+yh
# RVmyLm9iXeDZGayLV5yoJivZF6UQ0kcIGnAsM4t/aIAqtaFda92NAgIpA6p8N7u7
# KU49U5OzpvqP0liTFUy5LauAo6Ml+6/3CGSwekQPXBDXX2E3qk5r09JTJZ2Cc/os
# +XKwqRk5KlD6qdA8OsroW+/1X1H0+QrZlzXeaoXmIwRCrwIDAQABo4IBXzCCAVsw
# DgYDVR0PAQH/BAQDAgeAMEwGA1UdIARFMEMwQQYJKwYBBAGgMgEeMDQwMgYIKwYB
# BQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3JlcG9zaXRvcnkvMAkG
# A1UdEwQCMAAwFgYDVR0lAQH/BAwwCgYIKwYBBQUHAwgwQgYDVR0fBDswOTA3oDWg
# M4YxaHR0cDovL2NybC5nbG9iYWxzaWduLmNvbS9ncy9nc3RpbWVzdGFtcGluZ2cy
# LmNybDBUBggrBgEFBQcBAQRIMEYwRAYIKwYBBQUHMAKGOGh0dHA6Ly9zZWN1cmUu
# Z2xvYmFsc2lnbi5jb20vY2FjZXJ0L2dzdGltZXN0YW1waW5nZzIuY3J0MB0GA1Ud
# DgQWBBTUooRKOFoYf7pPMFC9ndV6h9YJ9zAfBgNVHSMEGDAWgBRG2D7/3OO+/4Pm
# 9IWbsN1q1hSpwTANBgkqhkiG9w0BAQUFAAOCAQEAj6kakW0EpjcgDoOW3iPTa24f
# bt1kPWghIrX4RzZpjuGlRcckoiK3KQnMVFquxrzNY46zPVBI5bTMrs2SjZ4oixNK
# Eaq9o+/Tsjb8tKFyv22XY3mMRLxwL37zvN2CU6sa9uv6HJe8tjecpBwwvKu8LUc2
# 35IgA+hxxlj2dQWaNPALWVqCRDSqgOQvhPZHXZbJtsrKnbemuuRQ09Q3uLogDtDT
# kipbxFm7oW3bPM5EncE4Kq3jjb3NCXcaEL5nCgI2ZIi5sxsm7ueeYMRGqLxhM2zP
# TrmcuWrwnzf+tT1PmtNN/94gjk6Xpv2fCbxNyhh2ybBNhVDygNIdBvVYBAexGDCC
# BNYwggO+oAMCAQICEhEhDRayW4wRltP+V8mGEea62TANBgkqhkiG9w0BAQsFADBa
# MQswCQYDVQQGEwJCRTEZMBcGA1UEChMQR2xvYmFsU2lnbiBudi1zYTEwMC4GA1UE
# AxMnR2xvYmFsU2lnbiBDb2RlU2lnbmluZyBDQSAtIFNIQTI1NiAtIEcyMB4XDTE1
# MDUwNDE2NDMyMVoXDTE4MDUwNDE2NDMyMVowVTELMAkGA1UEBhMCQ0gxDDAKBgNV
# BAgTA1p1ZzEMMAoGA1UEBxMDWnVnMRQwEgYDVQQKEwtkLWZlbnMgR21iSDEUMBIG
# A1UEAxMLZC1mZW5zIEdtYkgwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB
# AQDNPSzSNPylU9jFM78Q/GjzB7N+VNqikf/use7p8mpnBZ4cf5b4qV3rqQd62rJH
# RlAsxgouCSNQrl8xxfg6/t/I02kPvrzsR4xnDgMiVCqVRAeQsWebafWdTvWmONBS
# lxJejPP8TSgXMKFaDa+2HleTycTBYSoErAZSWpQ0NqF9zBadjsJRVatQuPkTDrwL
# eWibiyOipK9fcNoQpl5ll5H9EG668YJR3fqX9o0TQTkOmxXIL3IJ0UxdpyDpLEkt
# tBG6Y5wAdpF2dQX2phrfFNVY54JOGtuBkNGMSiLFzTkBA1fOlA6ICMYjB8xIFxVv
# rN1tYojCrqYkKMOjwWQz5X8zAgMBAAGjggGZMIIBlTAOBgNVHQ8BAf8EBAMCB4Aw
# TAYDVR0gBEUwQzBBBgkrBgEEAaAyATIwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93
# d3cuZ2xvYmFsc2lnbi5jb20vcmVwb3NpdG9yeS8wCQYDVR0TBAIwADATBgNVHSUE
# DDAKBggrBgEFBQcDAzBCBgNVHR8EOzA5MDegNaAzhjFodHRwOi8vY3JsLmdsb2Jh
# bHNpZ24uY29tL2dzL2dzY29kZXNpZ25zaGEyZzIuY3JsMIGQBggrBgEFBQcBAQSB
# gzCBgDBEBggrBgEFBQcwAoY4aHR0cDovL3NlY3VyZS5nbG9iYWxzaWduLmNvbS9j
# YWNlcnQvZ3Njb2Rlc2lnbnNoYTJnMi5jcnQwOAYIKwYBBQUHMAGGLGh0dHA6Ly9v
# Y3NwMi5nbG9iYWxzaWduLmNvbS9nc2NvZGVzaWduc2hhMmcyMB0GA1UdDgQWBBTN
# GDddiIYZy9p3Z84iSIMd27rtUDAfBgNVHSMEGDAWgBQZSrha5E0xpRTlXuwvoxz6
# gIwyazANBgkqhkiG9w0BAQsFAAOCAQEAAApsOzSX1alF00fTeijB/aIthO3UB0ks
# 1Gg3xoKQC1iEQmFG/qlFLiufs52kRPN7L0a7ClNH3iQpaH5IEaUENT9cNEXdKTBG
# 8OrJS8lrDJXImgNEgtSwz0B40h7bM2Z+0DvXDvpmfyM2NwHF/nNVj7NzmczrLRqN
# 9de3tV0pgRqnIYordVcmb24CZl3bzpwzbQQy14Iz+P5Z2cnw+QaYzAuweTZxEUcJ
# bFwpM49c1LMPFJTuOKkUgY90JJ3gVTpyQxfkc7DNBnx74PlRzjFmeGC/hxQt0hvo
# eaAiBdjo/1uuCTToigVnyRH+c0T2AezTeoFb7ne3I538hWeTdU5q9jGCBLcwggSz
# AgEBMHAwWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MgISESENFrJbjBGW0/5XyYYR5rrZMAkGBSsOAwIaBQCgeDAYBgorBgEEAYI3AgEM
# MQowCKACgAChAoAAMBkGCSqGSIb3DQEJAzEMBgorBgEEAYI3AgEEMBwGCisGAQQB
# gjcCAQsxDjAMBgorBgEEAYI3AgEVMCMGCSqGSIb3DQEJBDEWBBTic9IsjwjmuY2h
# iUHiP4xuVpfXyTANBgkqhkiG9w0BAQEFAASCAQAW6/feAoKndE49covv2tG79oQu
# /AYCtyCxZF9t4oItpaviJ62/E72eVJxHwnSbVyBw9nh/fDL/Zw3tRnULU65y4ZmO
# ray2bXnuNEa3v1Cr3q2eTz1Vf84DNWIEABYOXf4LB8LmZu6SvMzjXeMi1tqVVHWv
# rRWB73WLAxeY1prqhjQW8glaRJ3DRcZUNGxmE/AHojbnm1OhJfYOmE7/LOYKNWjj
# rb6zAy7pqQj6pJ+exU7WHYiJAVYst1bB1368auXIvClWtLyYmYoBM8hMInmBNx9D
# 8+eT/O6mKaAbFoRtwSPdZTJgx0vG25ySpnv6GSMS2COkJo24pcPO3TVsUvXRoYIC
# ojCCAp4GCSqGSIb3DQEJBjGCAo8wggKLAgEBMGgwUjELMAkGA1UEBhMCQkUxGTAX
# BgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGlt
# ZXN0YW1waW5nIENBIC0gRzICEhEh1pmnZJc+8fhCfukZzFNBFDAJBgUrDgMCGgUA
# oIH9MBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTE2
# MDgzMTE5MTYzOFowIwYJKoZIhvcNAQkEMRYEFLd5RX5/WNb0vzRRHrKt1tMpPNIY
# MIGdBgsqhkiG9w0BCRACDDGBjTCBijCBhzCBhAQUY7gvq2H1g5CWlQULACScUCkz
# 7HkwbDBWpFQwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYt
# c2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzICEhEh
# 1pmnZJc+8fhCfukZzFNBFDANBgkqhkiG9w0BAQEFAASCAQCflcbRLGdVw5iiK4et
# LIENF7gxP92nimop7NWivsGLam+wiNJkRafMQdTWgeY6x8hc30ndxXJx/gLiB7wC
# H6D8pZItJ+7Ppm3+0u5ac1Xp1WRdsW4x4QZ6rBnIq2FCX32mmwoy8CMx6OGI2qR+
# ec+NjJ+cgk+6oAnsJhNhwF/57Yw/9rhpfOi0Z9Uokanc+zImorITHSVGLHhW8KDM
# dEpTcoR2rfIZqEmIhbLbY+Ak21ti0wlkPIf4iMnDcNtkuysgYYp0FnSSZl27zF9f
# mnLqJirHrNCYlx0iPhVEq9yF8XKlJX93I5ge2f/AgGmCz6ESHjWnU25JVf6G1lqk
# bBfj
# SIG # End signature block
|
PowerShellCorpus/PowerShellGallery/biz.dfch.PS.Appclusive.Client/5.2.1.20161201/Get-CimiTarget.ps1
|
Get-CimiTarget.ps1
|
function Get-CimiTarget {
<#
.SYNOPSIS
Check if a machine exist in CIMI and if they is reachable from the orch
.DESCRIPTION
Check if a machine exist in CIMI and if they is reachable from the orch
You can check if a machine exist in CIMI. Therefor you can search by name oder cimi id.
.INPUTS
The Cmdlet can either return all available entities or filter entities on
specified conditions.
See PARAMETERS section on possible inputs.
.OUTPUTS
default | json | json-pretty | xml | xml-pretty
In addition output can be filtered on specified properties.
.EXAMPLE
Get-CimiTarget -ListAvailable
CimiID : https://cmabrmp-lab3ch-1.mgmt.sccloudpoc.net:9001/v1/cimi/2/machines/65c90f2b-12b1-4f45-b0db-f5de62478a4b
Name : rijutestrhel73
OrchTempID : 33
OrchTenantID : 9e210b40-3b9c-466a-bc4d-9f9243933350
Status : Impelented
CimiID : https://cmabrmp-lab3ch-1.mgmt.sccloudpoc.net:9001/v1/cimi/2/machines/99dd86e6-ed88-4ca8-9594-5ad1fd6aee66
Name : CMS-Test-Erich-W2012R2-Test-1
OrchTempID : 34
OrchTenantID : 9e210b40-3b9c-466a-bc4d-9f9243933350
Status : Impelented
CimiID : https://cmabrmp-lab3ch-1.mgmt.sccloudpoc.net:9001/v1/cimi/2/machines/f73bae78-248a-486c-ba5a-48cfce2ec4ad
Name : Template-Test-Erich-RHEL6
OrchTempID : 35
OrchTenantID : 9e210b40-3b9c-466a-bc4d-9f9243933350
Status : Impelented
CimiID : https://cmabrmp-lab3ch-1.mgmt.sccloudpoc.net:9001/v1/cimi/2/machines/548d1086-db9d-4d7b-b4a3-62382a8d581f
Name : CMS-Test-Erich-RHEL7-Test-3
OrchTempID : 36
OrchTenantID : 9e210b40-3b9c-466a-bc4d-9f9243933350
Status : Impelented
Return all machines with a bunch of information
.EXAMPLE
Get-CimiTarget -CimiId "06ffa86b-e5e7-49d3-9f6a-72d79416bce6"
CimiID : https://cmabrmp-lab3ch-1.mgmt.sccloudpoc.net:9001/v1/cimi/2/machines/06ffa86b-e5e7-49d3-9f6a-72d79416bce6
Name : TestProdukteJuergRHEL7
OrchTempID : 37
OrchTenantID : 9e210b40-3b9c-466a-bc4d-9f9243933350
Status : Impelented
Retrieves the cimi machine with ID 06ffa86b-e5e7-49d3-9f6a-72d79416bce6 and returns all properties of it.
.EXAMPLE
Get-CimiTarget -ServerName "hipatest19.6"
CimiID : https://cmabrmp-lab3ch-1.mgmt.sccloudpoc.net:9001/v1/cimi/2/machines/47019f6a-0038-4d40-a92a-56d8873fd405
Name : hipatest19.6
OrchTempID : 112
OrchTenantID : 9e210b40-3b9c-466a-bc4d-9f9243933350
Status : Impelented
Retrieves the cimi machine with the name -ServerName "hipatest19.6" and returns all properties of it.
.LINK
Online Version: http://dfch.biz/biz/dfch/PS/Appclusive/Client/Get-CimiTarget/
.NOTES
See module manifest for required software versions and dependencies.
#>
[CmdletBinding(
ConfirmImpact = 'Low'
,
HelpURI = 'http://dfch.biz/biz/dfch/PS/Appclusive/Client/Get-CimiTarget/'
,
DefaultParameterSetName = 'ListAvailable'
)]
PARAM
(
# Lists all available CIMI-Machines
[Parameter(Mandatory = $false, ParameterSetName = 'ListAvailable')]
[Switch] $ListAvailable
,
# CimiId or part of it to check if the machine is available
[Parameter(Mandatory = $true, Position = 0, ParameterSetName = 'CimiId')]
[ValidateNotNullOrEmpty()]
[string] $CimiId = $null
,
# Server name or part of it to check if the machine is available
[Parameter(Mandatory = $true, Position = 0, ParameterSetName = 'ServerName')]
[ValidateNotNullOrEmpty()]
[string] $Name = $null
,
# Service reference to Appclusive
[Parameter(Mandatory = $false)]
[Alias('Services')]
[hashtable] $svc = (Get-Variable -Name $MyInvocation.MyCommand.Module.PrivateData.MODULEVAR -ValueOnly).Services
,
# Specifies the return format of the Cmdlet
[ValidateSet('default', 'json', 'json-pretty', 'xml', 'xml-pretty')]
[Parameter(Mandatory = $false)]
[alias('ReturnFormat')]
[string] $As = 'default'
)
Begin
{
trap { Log-Exception $_; break; }
$datBegin = [datetime]::Now;
[string] $fn = $MyInvocation.MyCommand.Name;
Log-Debug -fn $fn -msg ("CALL. svc '{0}'. Name '{1}'." -f ($svc -is [Object]), $Name) -fac 1;
Contract-Requires ($svc.Cmp -is [biz.dfch.CS.Appclusive.Api.Cmp.Cmp]) "Connect to the server before using the Cmdlet"
$EntitySetName = 'CimiTargets';
}
# Begin
Process
{
trap { Log-Exception $_; break; }
# Default test variable for checking function response codes.
[Boolean] $fReturn = $false;
if($PSCmdlet.ParameterSetName -eq 'ListAvailable')
{
$Response = $svc.Cmp.$EntitySetName.AddQueryOption('$orderby','Name') | Select;
}
else
{
$Exp = @();
If ($PSCmdlet.ParameterSetName -eq 'CimiId')
{
$Exp += ("substringof('{0}', CimiId)" -f $CimiId);
}
If ($PSCmdlet.ParameterSetName -eq 'ServerName')
{
$Exp += ("substringof('{0}', tolower(Name))" -f $Name.ToLower());
}
$FilterExpression = [String]::Join(' and ', $Exp);
$Response = $svc.Cmp.$EntitySetName.AddQueryOption('$filter', $FilterExpression) | Select;
}
# $OutputParameter = $result
$OutputParameter = Format-ResultAs $Response $As
$fReturn = $true;
}
# Process
End
{
$datEnd = [datetime]::Now;
Log-Debug -fn $fn -msg ("RET. fReturn: [{0}]. Execution time: [{1}]ms. Started: [{2}]." -f $fReturn, ($datEnd - $datBegin).TotalMilliseconds, $datBegin.ToString('yyyy-MM-dd HH:mm:ss.fffzzz')) -fac 2;
# Return values are always and only returned via OutputParameter.
return $OutputParameter;
}
} # function
if($MyInvocation.ScriptName) { Export-ModuleMember -Function Get-CimiTarget; }
#
# Copyright 2016 d-fens GmbH
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SIG # Begin signature block
# MIIXDwYJKoZIhvcNAQcCoIIXADCCFvwCAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB
# gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR
# AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQUUdUoBNXXszBjDs/CC3R+rGQR
# sf+gghHCMIIEFDCCAvygAwIBAgILBAAAAAABL07hUtcwDQYJKoZIhvcNAQEFBQAw
# VzELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNV
# BAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkdsb2JhbFNpZ24gUm9vdCBDQTAeFw0xMTA0
# MTMxMDAwMDBaFw0yODAxMjgxMjAwMDBaMFIxCzAJBgNVBAYTAkJFMRkwFwYDVQQK
# ExBHbG9iYWxTaWduIG52LXNhMSgwJgYDVQQDEx9HbG9iYWxTaWduIFRpbWVzdGFt
# cGluZyBDQSAtIEcyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAlO9l
# +LVXn6BTDTQG6wkft0cYasvwW+T/J6U00feJGr+esc0SQW5m1IGghYtkWkYvmaCN
# d7HivFzdItdqZ9C76Mp03otPDbBS5ZBb60cO8eefnAuQZT4XljBFcm05oRc2yrmg
# jBtPCBn2gTGtYRakYua0QJ7D/PuV9vu1LpWBmODvxevYAll4d/eq41JrUJEpxfz3
# zZNl0mBhIvIG+zLdFlH6Dv2KMPAXCae78wSuq5DnbN96qfTvxGInX2+ZbTh0qhGL
# 2t/HFEzphbLswn1KJo/nVrqm4M+SU4B09APsaLJgvIQgAIMboe60dAXBKY5i0Eex
# +vBTzBj5Ljv5cH60JQIDAQABo4HlMIHiMA4GA1UdDwEB/wQEAwIBBjASBgNVHRMB
# Af8ECDAGAQH/AgEAMB0GA1UdDgQWBBRG2D7/3OO+/4Pm9IWbsN1q1hSpwTBHBgNV
# HSAEQDA+MDwGBFUdIAAwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93d3cuZ2xvYmFs
# c2lnbi5jb20vcmVwb3NpdG9yeS8wMwYDVR0fBCwwKjAooCagJIYiaHR0cDovL2Ny
# bC5nbG9iYWxzaWduLm5ldC9yb290LmNybDAfBgNVHSMEGDAWgBRge2YaRQ2XyolQ
# L30EzTSo//z9SzANBgkqhkiG9w0BAQUFAAOCAQEATl5WkB5GtNlJMfO7FzkoG8IW
# 3f1B3AkFBJtvsqKa1pkuQJkAVbXqP6UgdtOGNNQXzFU6x4Lu76i6vNgGnxVQ380W
# e1I6AtcZGv2v8Hhc4EvFGN86JB7arLipWAQCBzDbsBJe/jG+8ARI9PBw+DpeVoPP
# PfsNvPTF7ZedudTbpSeE4zibi6c1hkQgpDttpGoLoYP9KOva7yj2zIhd+wo7AKvg
# IeviLzVsD440RZfroveZMzV+y5qKu0VN5z+fwtmK+mWybsd+Zf/okuEsMaL3sCc2
# SI8mbzvuTXYfecPlf5Y1vC0OzAGwjn//UYCAp5LUs0RGZIyHTxZjBzFLY7Df8zCC
# BCkwggMRoAMCAQICCwQAAAAAATGJxjfoMA0GCSqGSIb3DQEBCwUAMEwxIDAeBgNV
# BAsTF0dsb2JhbFNpZ24gUm9vdCBDQSAtIFIzMRMwEQYDVQQKEwpHbG9iYWxTaWdu
# MRMwEQYDVQQDEwpHbG9iYWxTaWduMB4XDTExMDgwMjEwMDAwMFoXDTE5MDgwMjEw
# MDAwMFowWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKPv0Z8p6djTgnY8YqDS
# SdYWHvHP8NC6SEMDLacd8gE0SaQQ6WIT9BP0FoO11VdCSIYrlViH6igEdMtyEQ9h
# JuH6HGEVxyibTQuCDyYrkDqW7aTQaymc9WGI5qRXb+70cNCNF97mZnZfdB5eDFM4
# XZD03zAtGxPReZhUGks4BPQHxCMD05LL94BdqpxWBkQtQUxItC3sNZKaxpXX9c6Q
# MeJ2s2G48XVXQqw7zivIkEnotybPuwyJy9DDo2qhydXjnFMrVyb+Vpp2/WFGomDs
# KUZH8s3ggmLGBFrn7U5AXEgGfZ1f53TJnoRlDVve3NMkHLQUEeurv8QfpLqZ0BdY
# Nc0CAwEAAaOB/TCB+jAOBgNVHQ8BAf8EBAMCAQYwEgYDVR0TAQH/BAgwBgEB/wIB
# ADAdBgNVHQ4EFgQUGUq4WuRNMaUU5V7sL6Mc+oCMMmswRwYDVR0gBEAwPjA8BgRV
# HSAAMDQwMgYIKwYBBQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3Jl
# cG9zaXRvcnkvMDYGA1UdHwQvMC0wK6ApoCeGJWh0dHA6Ly9jcmwuZ2xvYmFsc2ln
# bi5uZXQvcm9vdC1yMy5jcmwwEwYDVR0lBAwwCgYIKwYBBQUHAwMwHwYDVR0jBBgw
# FoAUj/BLf6guRSSuTVD6Y5qL3uLdG7wwDQYJKoZIhvcNAQELBQADggEBAHmwaTTi
# BYf2/tRgLC+GeTQD4LEHkwyEXPnk3GzPbrXsCly6C9BoMS4/ZL0Pgmtmd4F/ximl
# F9jwiU2DJBH2bv6d4UgKKKDieySApOzCmgDXsG1szYjVFXjPE/mIpXNNwTYr3MvO
# 23580ovvL72zT006rbtibiiTxAzL2ebK4BEClAOwvT+UKFaQHlPCJ9XJPM0aYx6C
# WRW2QMqngarDVa8z0bV16AnqRwhIIvtdG/Mseml+xddaXlYzPK1X6JMlQsPSXnE7
# ShxU7alVrCgFx8RsXdw8k/ZpPIJRzhoVPV4Bc/9Aouq0rtOO+u5dbEfHQfXUVlfy
# GDcy1tTMS/Zx4HYwggSfMIIDh6ADAgECAhIRIdaZp2SXPvH4Qn7pGcxTQRQwDQYJ
# KoZIhvcNAQEFBQAwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24g
# bnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzIw
# HhcNMTYwNTI0MDAwMDAwWhcNMjcwNjI0MDAwMDAwWjBgMQswCQYDVQQGEwJTRzEf
# MB0GA1UEChMWR01PIEdsb2JhbFNpZ24gUHRlIEx0ZDEwMC4GA1UEAxMnR2xvYmFs
# U2lnbiBUU0EgZm9yIE1TIEF1dGhlbnRpY29kZSAtIEcyMIIBIjANBgkqhkiG9w0B
# AQEFAAOCAQ8AMIIBCgKCAQEAsBeuotO2BDBWHlgPse1VpNZUy9j2czrsXV6rJf02
# pfqEw2FAxUa1WVI7QqIuXxNiEKlb5nPWkiWxfSPjBrOHOg5D8NcAiVOiETFSKG5d
# QHI88gl3p0mSl9RskKB2p/243LOd8gdgLE9YmABr0xVU4Prd/4AsXximmP/Uq+yh
# RVmyLm9iXeDZGayLV5yoJivZF6UQ0kcIGnAsM4t/aIAqtaFda92NAgIpA6p8N7u7
# KU49U5OzpvqP0liTFUy5LauAo6Ml+6/3CGSwekQPXBDXX2E3qk5r09JTJZ2Cc/os
# +XKwqRk5KlD6qdA8OsroW+/1X1H0+QrZlzXeaoXmIwRCrwIDAQABo4IBXzCCAVsw
# DgYDVR0PAQH/BAQDAgeAMEwGA1UdIARFMEMwQQYJKwYBBAGgMgEeMDQwMgYIKwYB
# BQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3JlcG9zaXRvcnkvMAkG
# A1UdEwQCMAAwFgYDVR0lAQH/BAwwCgYIKwYBBQUHAwgwQgYDVR0fBDswOTA3oDWg
# M4YxaHR0cDovL2NybC5nbG9iYWxzaWduLmNvbS9ncy9nc3RpbWVzdGFtcGluZ2cy
# LmNybDBUBggrBgEFBQcBAQRIMEYwRAYIKwYBBQUHMAKGOGh0dHA6Ly9zZWN1cmUu
# Z2xvYmFsc2lnbi5jb20vY2FjZXJ0L2dzdGltZXN0YW1waW5nZzIuY3J0MB0GA1Ud
# DgQWBBTUooRKOFoYf7pPMFC9ndV6h9YJ9zAfBgNVHSMEGDAWgBRG2D7/3OO+/4Pm
# 9IWbsN1q1hSpwTANBgkqhkiG9w0BAQUFAAOCAQEAj6kakW0EpjcgDoOW3iPTa24f
# bt1kPWghIrX4RzZpjuGlRcckoiK3KQnMVFquxrzNY46zPVBI5bTMrs2SjZ4oixNK
# Eaq9o+/Tsjb8tKFyv22XY3mMRLxwL37zvN2CU6sa9uv6HJe8tjecpBwwvKu8LUc2
# 35IgA+hxxlj2dQWaNPALWVqCRDSqgOQvhPZHXZbJtsrKnbemuuRQ09Q3uLogDtDT
# kipbxFm7oW3bPM5EncE4Kq3jjb3NCXcaEL5nCgI2ZIi5sxsm7ueeYMRGqLxhM2zP
# TrmcuWrwnzf+tT1PmtNN/94gjk6Xpv2fCbxNyhh2ybBNhVDygNIdBvVYBAexGDCC
# BNYwggO+oAMCAQICEhEhDRayW4wRltP+V8mGEea62TANBgkqhkiG9w0BAQsFADBa
# MQswCQYDVQQGEwJCRTEZMBcGA1UEChMQR2xvYmFsU2lnbiBudi1zYTEwMC4GA1UE
# AxMnR2xvYmFsU2lnbiBDb2RlU2lnbmluZyBDQSAtIFNIQTI1NiAtIEcyMB4XDTE1
# MDUwNDE2NDMyMVoXDTE4MDUwNDE2NDMyMVowVTELMAkGA1UEBhMCQ0gxDDAKBgNV
# BAgTA1p1ZzEMMAoGA1UEBxMDWnVnMRQwEgYDVQQKEwtkLWZlbnMgR21iSDEUMBIG
# A1UEAxMLZC1mZW5zIEdtYkgwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB
# AQDNPSzSNPylU9jFM78Q/GjzB7N+VNqikf/use7p8mpnBZ4cf5b4qV3rqQd62rJH
# RlAsxgouCSNQrl8xxfg6/t/I02kPvrzsR4xnDgMiVCqVRAeQsWebafWdTvWmONBS
# lxJejPP8TSgXMKFaDa+2HleTycTBYSoErAZSWpQ0NqF9zBadjsJRVatQuPkTDrwL
# eWibiyOipK9fcNoQpl5ll5H9EG668YJR3fqX9o0TQTkOmxXIL3IJ0UxdpyDpLEkt
# tBG6Y5wAdpF2dQX2phrfFNVY54JOGtuBkNGMSiLFzTkBA1fOlA6ICMYjB8xIFxVv
# rN1tYojCrqYkKMOjwWQz5X8zAgMBAAGjggGZMIIBlTAOBgNVHQ8BAf8EBAMCB4Aw
# TAYDVR0gBEUwQzBBBgkrBgEEAaAyATIwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93
# d3cuZ2xvYmFsc2lnbi5jb20vcmVwb3NpdG9yeS8wCQYDVR0TBAIwADATBgNVHSUE
# DDAKBggrBgEFBQcDAzBCBgNVHR8EOzA5MDegNaAzhjFodHRwOi8vY3JsLmdsb2Jh
# bHNpZ24uY29tL2dzL2dzY29kZXNpZ25zaGEyZzIuY3JsMIGQBggrBgEFBQcBAQSB
# gzCBgDBEBggrBgEFBQcwAoY4aHR0cDovL3NlY3VyZS5nbG9iYWxzaWduLmNvbS9j
# YWNlcnQvZ3Njb2Rlc2lnbnNoYTJnMi5jcnQwOAYIKwYBBQUHMAGGLGh0dHA6Ly9v
# Y3NwMi5nbG9iYWxzaWduLmNvbS9nc2NvZGVzaWduc2hhMmcyMB0GA1UdDgQWBBTN
# GDddiIYZy9p3Z84iSIMd27rtUDAfBgNVHSMEGDAWgBQZSrha5E0xpRTlXuwvoxz6
# gIwyazANBgkqhkiG9w0BAQsFAAOCAQEAAApsOzSX1alF00fTeijB/aIthO3UB0ks
# 1Gg3xoKQC1iEQmFG/qlFLiufs52kRPN7L0a7ClNH3iQpaH5IEaUENT9cNEXdKTBG
# 8OrJS8lrDJXImgNEgtSwz0B40h7bM2Z+0DvXDvpmfyM2NwHF/nNVj7NzmczrLRqN
# 9de3tV0pgRqnIYordVcmb24CZl3bzpwzbQQy14Iz+P5Z2cnw+QaYzAuweTZxEUcJ
# bFwpM49c1LMPFJTuOKkUgY90JJ3gVTpyQxfkc7DNBnx74PlRzjFmeGC/hxQt0hvo
# eaAiBdjo/1uuCTToigVnyRH+c0T2AezTeoFb7ne3I538hWeTdU5q9jGCBLcwggSz
# AgEBMHAwWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MgISESENFrJbjBGW0/5XyYYR5rrZMAkGBSsOAwIaBQCgeDAYBgorBgEEAYI3AgEM
# MQowCKACgAChAoAAMBkGCSqGSIb3DQEJAzEMBgorBgEEAYI3AgEEMBwGCisGAQQB
# gjcCAQsxDjAMBgorBgEEAYI3AgEVMCMGCSqGSIb3DQEJBDEWBBQ+4ngwF6RrR9pz
# w7AcSvM+yeNQPzANBgkqhkiG9w0BAQEFAASCAQC6nn8dvhnQ34GqMPLAIcYulsey
# waXmS5LUCvBfT12td6QoK9jE54fXvEWVh+AHFvc/AGWKN+2WHJJr4a3LBluqEfhO
# tkc/RJ4ncnJelo0el8wB+T74oarr5Wfu4o10sB1GxqcjDqCIsDqg/TbcWOJNZI84
# JA+hPPjtxSAMF1AYG6QBcDY5C6A4I7XhqScSI0o35bvyvYDcgNUmuVzMgyOTHdEV
# 18hoAKN1I9tyyDdZf/5cn8K2QOoPe7v1aGCIDafWl8HI4K2T4E/V2DEb7SIcS+ga
# aTBm4zFC9I/PSO+SNC7KVYVrLR3R0ExpxomlDLKqx7uUAMJlYEX0tFjdxdqBoYIC
# ojCCAp4GCSqGSIb3DQEJBjGCAo8wggKLAgEBMGgwUjELMAkGA1UEBhMCQkUxGTAX
# BgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGlt
# ZXN0YW1waW5nIENBIC0gRzICEhEh1pmnZJc+8fhCfukZzFNBFDAJBgUrDgMCGgUA
# oIH9MBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTE2
# MDgzMTE5MTYzOVowIwYJKoZIhvcNAQkEMRYEFBQ4hiUCxx+hdEFFx+IaLXjEPxEJ
# MIGdBgsqhkiG9w0BCRACDDGBjTCBijCBhzCBhAQUY7gvq2H1g5CWlQULACScUCkz
# 7HkwbDBWpFQwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYt
# c2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzICEhEh
# 1pmnZJc+8fhCfukZzFNBFDANBgkqhkiG9w0BAQEFAASCAQCFGp1JrAsXPOGgVsCn
# Yr3exCX3JxK2/CMsR1u/7wVYRqX52vYu1p82vbQik4BbFNLSUugt9p53b4zOz/GU
# Svxr6dUiifFRdXwS77kyIflcho9lmF3qy6mfFCWYM0LeGrpPrOXQRk00BPLrB6Kg
# +cem/BUmRAhvKuBh9WnrUvlRQ9R8WljzJZJj+wZ8UhvlL+Zc+gAKyHRVy4SmKUfU
# sZz/a+wriDcE0A/mDh+ZJ+N1mRzdrSBIkkDioo4FBz6WzN16F2RkBqm5ValoKGSJ
# VuOL46k+mT8RLUDaE51EGJshv5GE4zP5T7qmcsmzMxRSixRZCH+gXSadx+VEQ5gr
# yNik
# SIG # End signature block
|
PowerShellCorpus/PowerShellGallery/biz.dfch.PS.Appclusive.Client/5.2.1.20161201/Set-KeyNameValue.ps1
|
Set-KeyNameValue.ps1
|
function Set-KeyNameValue {
<#
.SYNOPSIS
Sets or creates a K/N/V entry in Appclusive.
.DESCRIPTION
Sets or creates a K/N/V entry in Appclusive.
By updating a K/N/V entry you can specify if you want to update the Key, Name, Value or any combination thereof.
.OUTPUTS
default | json | json-pretty | xml | xml-pretty | PSCredential | Clear
.EXAMPLE
Set-KeyNameValue myKey myName myValue -CreateIfNotExist
Id : 3131
Key : myKey
Name : myName
Value : myValue
CreatedBy : SERVER1\Administrator
Created : 11/13/2014 11:08:46 PM +00:00
ModifiedBy : SERVER1\Administrator
Modified : 11/13/2014 11:08:46 PM +00:00
RowVersion : {0, 0, 0, 0...}
Create a new K/N/V entry if it does not exists.
.EXAMPLE
Set-KeyNameValue myKey -NewKey myNewKey myName myValue -NewValue myNewValue
Id : 3131
Key : myNewKey
Name : myName
Value : myNewValue
CreatedBy : SERVER1\Administrator
Created : 11/13/2014 11:08:46 PM +00:00
ModifiedBy : SERVER1\Administrator
Modified : 11/13/2014 11:08:46 PM +00:00
RowVersion : {0, 0, 0, 0...}
Update an existing K/N/V with new key and new value.
.EXAMPLE
Set-KeyNameValue myNewKey -NewKey myNewKey2 myName myNewValue -NewValue myNewValue2 -as json-pretty
{
"Id": 3131,
"Key": "myNewKey2",
"Name": "myName",
"Value": "myNewValue2",
"CreatedBy": "SERVER1\\Administrator",
"Created": "\/Date(1415920126010)\/",
"ModifiedBy": "SERVER1\\Administrator",
"Modified": "\/Date(1415920126010)\/",
"RowVersion": [
0,
0,
0,
0,
0,
2,
152,
17
]
}
Update an existing K/N/V with new key and new value. Return format is json with pretty-print.
.LINK
Online Version: http://dfch.biz/biz/dfch/PS/Appclusive/Client/Set-KeyNameValue/
.NOTES
See module manifest for dependencies and further requirements.
#>
[CmdletBinding(
SupportsShouldProcess = $false
,
ConfirmImpact = 'Low'
,
HelpURI = 'http://dfch.biz/biz/dfch/PS/Appclusive/Client/Set-KeyNameValue/'
)]
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseShouldProcessForStateChangingFunctions", "")]
Param
(
# Specifies the key to modify
[Parameter(Mandatory = $true, Position = 0)]
[Alias("k")]
[string] $Key
,
# Specifies the new key name
[Parameter(Mandatory = $false)]
[string] $NewKey
,
# Specifies the name to modify
[Parameter(Mandatory = $true, Position = 1)]
[Alias('n')]
[string] $Name
,
# Specifies the new name name
[Parameter(Mandatory = $false)]
[string] $NewName
,
# Specifies the value to modify
[Parameter(Mandatory = $true, Position = 2)]
[Alias("v")]
[string] $Value
,
# Specifies the new value name to modify
[Parameter(Mandatory = $false)]
[string] $NewValue
,
# Specifies the description
[Parameter(Mandatory = $false)]
[string] $Description
,
# Specifies to create a KNV if it does not exist
[Parameter(Mandatory = $false)]
[Alias("c")]
[switch] $CreateIfNotExist = $false
,
# Service reference to Appclusive
[Parameter(Mandatory = $false)]
[Alias('Services')]
[hashtable] $svc = (Get-Variable -Name $MyInvocation.MyCommand.Module.PrivateData.MODULEVAR -ValueOnly).Services
,
# Specifies the return format of the Cmdlet
[ValidateSet('default', 'json', 'json-pretty', 'xml', 'xml-pretty')]
[Parameter(Mandatory = $false)]
[alias('ReturnFormat')]
[string] $As = 'default'
)
Begin
{
trap { Log-Exception $_; break; }
$datBegin = [datetime]::Now;
[string] $fn = $MyInvocation.MyCommand.Name;
Log-Debug -fn $fn -msg ("CALL. svc '{0}'. Name '{1}'." -f ($svc -is [Object]), $Name) -fac 1;
$MaxPropertyLength = 475;
# Parameter validation
Contract-Requires ($svc.Core -is [biz.dfch.CS.Appclusive.Api.Core.Core]) "Connect to the server before using the Cmdlet"
}
# Begin
Process
{
# Default test variable for checking function response codes.
[Boolean] $fReturn = $false;
# Return values are always and only returned via OutputParameter.
$OutputParameter = $null;
$AddedEntity = $null;
try
{
$Exp = @();
$KeyNameValueContents = @();
if($Key.Length -lt $MaxPropertyLength)
{
$Exp += ("(tolower(Key) eq '{0}')" -f $Key.ToLower());
$KeyNameValueContents += $Key;
}
else
{
$shortenedKey = $Key.substring(0,$MaxPropertyLength);
$Exp += ("(startswith(tolower(Key), '{0}'))" -f $shortenedKey.ToLower());
$KeyNameValueContents += $Key;
}
if($Name.Length -lt $MaxPropertyLength)
{
$Exp += ("(tolower(Name) eq '{0}')" -f $Name.ToLower());
$KeyNameValueContents += $Name;
}
else
{
$shortenedName = $Name.substring(0,$MaxPropertyLength);
$Exp += ("(startswith(tolower(Name), '{0}'))" -f $shortenedName.ToLower());
$KeyNameValueContents += $Name;
}
if($Value.Length -lt $MaxPropertyLength)
{
$Exp += ("(tolower(Value) eq '{0}')" -f $Value.ToLower());
$KeyNameValueContents += $Value;
}
else
{
$shortenedValue = $Value.substring(0,$MaxPropertyLength);
$Exp += ("(startswith(tolower(Value), '{0}'))" -f $shortenedValue.ToLower());
$KeyNameValueContents += $Value;
}
$FilterExpression = [String]::Join(' and ', $Exp);
$KeyNameValueContentsString = [String]::Join(',', $KeyNameValueContents);
try
{
$knv = $svc.Core.KeyNameValues.AddQueryOption('$filter', $FilterExpression).AddQueryOption('$top',1) | Select;
}
catch
{
$exceptionMsg = $error[0].Exception.InnerException.InnerException.ToString();
if (!!$exceptionMsg -and $exceptionMsg -match "Http Error 404\.15 - Not Found")
{
$queryStringLength = $FilterExpression.Length + '$filter='.Length;
$msg = "Key/Name/Value: Filter expression to query for existing entity exceeds maxQueryString (Length: '{0}'). To avoid this exception increase the maximum URL length on the IIS server." -f $queryStringLength;
$e = New-CustomErrorRecord -m $msg -cat LimitsExceeded -o "maxQueryString";
throw($gotoError);
}
throw;
}
if(!$CreateIfNotExist -And !$knv)
{
$msg = "Key/Name/Value: Parameter validation FAILED. Entity does not exist. Use '-CreateIfNotExist' to create resource: '{0}'" -f $KeyNameValueContentsString;
$e = New-CustomErrorRecord -m $msg -cat ObjectNotFound -o $Name;
throw($gotoError);
}
if(!$knv)
{
$knv = New-Object biz.dfch.CS.Appclusive.Api.Core.KeyNameValue;
$knv.Key = $Key;
$knv.Name = $Name;
$knv.Value = $Value;
$svc.Core.AddToKeyNameValues($knv);
$AddedEntity = $knv;
$knv.Created = [System.DateTimeOffset]::Now;
$knv.Modified = $knv.Created;
$knv.CreatedById = 0;
$knv.ModifiedById = 0;
$knv.Tid = [guid]::Empty.ToString();
}
if($NewKey) { $knv.Key = $NewKey; }
if($NewName) { $knv.Name = $NewName; }
if($NewValue) { $knv.Value = $NewValue; }
if($PSBoundParameters.ContainsKey('Description'))
{
$knv.Description = $Description;
}
$svc.Core.UpdateObject($knv);
$r = $svc.Core.SaveChanges();
$r = $knv;
$OutputParameter = Format-ResultAs $r $As;
$fReturn = $true;
}
catch
{
if($gotoSuccess -eq $_.Exception.Message)
{
$fReturn = $true;
}
else
{
[string] $ErrorText = "catch [$($_.FullyQualifiedErrorId)]";
$ErrorText += (($_ | fl * -Force) | Out-String);
$ErrorText += (($_.Exception | fl * -Force) | Out-String);
$ErrorText += (Get-PSCallStack | Out-String);
if($_.Exception -is [System.Net.WebException])
{
Log-Critical $fn ("[WebException] Request FAILED with Status '{0}'. [{1}]." -f $_.Exception.Status, $_);
Log-Debug $fn $ErrorText -fac 3;
}
else
{
Log-Error $fn $ErrorText -fac 3;
if($gotoError -eq $_.Exception.Message)
{
Log-Error $fn $e.Exception.Message;
$PSCmdlet.ThrowTerminatingError($e);
}
elseif($gotoFailure -ne $_.Exception.Message)
{
Write-Verbose ("$fn`n$ErrorText");
}
else
{
# N/A
}
}
$fReturn = $false;
$OutputParameter = $null;
if($AddedEntity)
{
$svc.Core.DeleteObject($AddedEntity);
}
}
}
finally
{
# Clean up
# N/A
}
}
# Process
End
{
$datEnd = [datetime]::Now;
Log-Debug -fn $fn -msg ("RET. fReturn: [{0}]. Execution time: [{1}]ms. Started: [{2}]." -f $fReturn, ($datEnd - $datBegin).TotalMilliseconds, $datBegin.ToString('yyyy-MM-dd HH:mm:ss.fffzzz')) -fac 2;
# Return values are always and only returned via OutputParameter.
return $OutputParameter;
}
# End
}
if($MyInvocation.ScriptName) { Export-ModuleMember -Function Set-KeyNameValue; }
#
# Copyright 2014-2015 d-fens GmbH
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SIG # Begin signature block
# MIIXDwYJKoZIhvcNAQcCoIIXADCCFvwCAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB
# gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR
# AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQUyHKwACLh1wptrQrifNqcsn2Q
# CAegghHCMIIEFDCCAvygAwIBAgILBAAAAAABL07hUtcwDQYJKoZIhvcNAQEFBQAw
# VzELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNV
# BAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkdsb2JhbFNpZ24gUm9vdCBDQTAeFw0xMTA0
# MTMxMDAwMDBaFw0yODAxMjgxMjAwMDBaMFIxCzAJBgNVBAYTAkJFMRkwFwYDVQQK
# ExBHbG9iYWxTaWduIG52LXNhMSgwJgYDVQQDEx9HbG9iYWxTaWduIFRpbWVzdGFt
# cGluZyBDQSAtIEcyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAlO9l
# +LVXn6BTDTQG6wkft0cYasvwW+T/J6U00feJGr+esc0SQW5m1IGghYtkWkYvmaCN
# d7HivFzdItdqZ9C76Mp03otPDbBS5ZBb60cO8eefnAuQZT4XljBFcm05oRc2yrmg
# jBtPCBn2gTGtYRakYua0QJ7D/PuV9vu1LpWBmODvxevYAll4d/eq41JrUJEpxfz3
# zZNl0mBhIvIG+zLdFlH6Dv2KMPAXCae78wSuq5DnbN96qfTvxGInX2+ZbTh0qhGL
# 2t/HFEzphbLswn1KJo/nVrqm4M+SU4B09APsaLJgvIQgAIMboe60dAXBKY5i0Eex
# +vBTzBj5Ljv5cH60JQIDAQABo4HlMIHiMA4GA1UdDwEB/wQEAwIBBjASBgNVHRMB
# Af8ECDAGAQH/AgEAMB0GA1UdDgQWBBRG2D7/3OO+/4Pm9IWbsN1q1hSpwTBHBgNV
# HSAEQDA+MDwGBFUdIAAwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93d3cuZ2xvYmFs
# c2lnbi5jb20vcmVwb3NpdG9yeS8wMwYDVR0fBCwwKjAooCagJIYiaHR0cDovL2Ny
# bC5nbG9iYWxzaWduLm5ldC9yb290LmNybDAfBgNVHSMEGDAWgBRge2YaRQ2XyolQ
# L30EzTSo//z9SzANBgkqhkiG9w0BAQUFAAOCAQEATl5WkB5GtNlJMfO7FzkoG8IW
# 3f1B3AkFBJtvsqKa1pkuQJkAVbXqP6UgdtOGNNQXzFU6x4Lu76i6vNgGnxVQ380W
# e1I6AtcZGv2v8Hhc4EvFGN86JB7arLipWAQCBzDbsBJe/jG+8ARI9PBw+DpeVoPP
# PfsNvPTF7ZedudTbpSeE4zibi6c1hkQgpDttpGoLoYP9KOva7yj2zIhd+wo7AKvg
# IeviLzVsD440RZfroveZMzV+y5qKu0VN5z+fwtmK+mWybsd+Zf/okuEsMaL3sCc2
# SI8mbzvuTXYfecPlf5Y1vC0OzAGwjn//UYCAp5LUs0RGZIyHTxZjBzFLY7Df8zCC
# BCkwggMRoAMCAQICCwQAAAAAATGJxjfoMA0GCSqGSIb3DQEBCwUAMEwxIDAeBgNV
# BAsTF0dsb2JhbFNpZ24gUm9vdCBDQSAtIFIzMRMwEQYDVQQKEwpHbG9iYWxTaWdu
# MRMwEQYDVQQDEwpHbG9iYWxTaWduMB4XDTExMDgwMjEwMDAwMFoXDTE5MDgwMjEw
# MDAwMFowWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKPv0Z8p6djTgnY8YqDS
# SdYWHvHP8NC6SEMDLacd8gE0SaQQ6WIT9BP0FoO11VdCSIYrlViH6igEdMtyEQ9h
# JuH6HGEVxyibTQuCDyYrkDqW7aTQaymc9WGI5qRXb+70cNCNF97mZnZfdB5eDFM4
# XZD03zAtGxPReZhUGks4BPQHxCMD05LL94BdqpxWBkQtQUxItC3sNZKaxpXX9c6Q
# MeJ2s2G48XVXQqw7zivIkEnotybPuwyJy9DDo2qhydXjnFMrVyb+Vpp2/WFGomDs
# KUZH8s3ggmLGBFrn7U5AXEgGfZ1f53TJnoRlDVve3NMkHLQUEeurv8QfpLqZ0BdY
# Nc0CAwEAAaOB/TCB+jAOBgNVHQ8BAf8EBAMCAQYwEgYDVR0TAQH/BAgwBgEB/wIB
# ADAdBgNVHQ4EFgQUGUq4WuRNMaUU5V7sL6Mc+oCMMmswRwYDVR0gBEAwPjA8BgRV
# HSAAMDQwMgYIKwYBBQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3Jl
# cG9zaXRvcnkvMDYGA1UdHwQvMC0wK6ApoCeGJWh0dHA6Ly9jcmwuZ2xvYmFsc2ln
# bi5uZXQvcm9vdC1yMy5jcmwwEwYDVR0lBAwwCgYIKwYBBQUHAwMwHwYDVR0jBBgw
# FoAUj/BLf6guRSSuTVD6Y5qL3uLdG7wwDQYJKoZIhvcNAQELBQADggEBAHmwaTTi
# BYf2/tRgLC+GeTQD4LEHkwyEXPnk3GzPbrXsCly6C9BoMS4/ZL0Pgmtmd4F/ximl
# F9jwiU2DJBH2bv6d4UgKKKDieySApOzCmgDXsG1szYjVFXjPE/mIpXNNwTYr3MvO
# 23580ovvL72zT006rbtibiiTxAzL2ebK4BEClAOwvT+UKFaQHlPCJ9XJPM0aYx6C
# WRW2QMqngarDVa8z0bV16AnqRwhIIvtdG/Mseml+xddaXlYzPK1X6JMlQsPSXnE7
# ShxU7alVrCgFx8RsXdw8k/ZpPIJRzhoVPV4Bc/9Aouq0rtOO+u5dbEfHQfXUVlfy
# GDcy1tTMS/Zx4HYwggSfMIIDh6ADAgECAhIRIdaZp2SXPvH4Qn7pGcxTQRQwDQYJ
# KoZIhvcNAQEFBQAwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24g
# bnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzIw
# HhcNMTYwNTI0MDAwMDAwWhcNMjcwNjI0MDAwMDAwWjBgMQswCQYDVQQGEwJTRzEf
# MB0GA1UEChMWR01PIEdsb2JhbFNpZ24gUHRlIEx0ZDEwMC4GA1UEAxMnR2xvYmFs
# U2lnbiBUU0EgZm9yIE1TIEF1dGhlbnRpY29kZSAtIEcyMIIBIjANBgkqhkiG9w0B
# AQEFAAOCAQ8AMIIBCgKCAQEAsBeuotO2BDBWHlgPse1VpNZUy9j2czrsXV6rJf02
# pfqEw2FAxUa1WVI7QqIuXxNiEKlb5nPWkiWxfSPjBrOHOg5D8NcAiVOiETFSKG5d
# QHI88gl3p0mSl9RskKB2p/243LOd8gdgLE9YmABr0xVU4Prd/4AsXximmP/Uq+yh
# RVmyLm9iXeDZGayLV5yoJivZF6UQ0kcIGnAsM4t/aIAqtaFda92NAgIpA6p8N7u7
# KU49U5OzpvqP0liTFUy5LauAo6Ml+6/3CGSwekQPXBDXX2E3qk5r09JTJZ2Cc/os
# +XKwqRk5KlD6qdA8OsroW+/1X1H0+QrZlzXeaoXmIwRCrwIDAQABo4IBXzCCAVsw
# DgYDVR0PAQH/BAQDAgeAMEwGA1UdIARFMEMwQQYJKwYBBAGgMgEeMDQwMgYIKwYB
# BQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3JlcG9zaXRvcnkvMAkG
# A1UdEwQCMAAwFgYDVR0lAQH/BAwwCgYIKwYBBQUHAwgwQgYDVR0fBDswOTA3oDWg
# M4YxaHR0cDovL2NybC5nbG9iYWxzaWduLmNvbS9ncy9nc3RpbWVzdGFtcGluZ2cy
# LmNybDBUBggrBgEFBQcBAQRIMEYwRAYIKwYBBQUHMAKGOGh0dHA6Ly9zZWN1cmUu
# Z2xvYmFsc2lnbi5jb20vY2FjZXJ0L2dzdGltZXN0YW1waW5nZzIuY3J0MB0GA1Ud
# DgQWBBTUooRKOFoYf7pPMFC9ndV6h9YJ9zAfBgNVHSMEGDAWgBRG2D7/3OO+/4Pm
# 9IWbsN1q1hSpwTANBgkqhkiG9w0BAQUFAAOCAQEAj6kakW0EpjcgDoOW3iPTa24f
# bt1kPWghIrX4RzZpjuGlRcckoiK3KQnMVFquxrzNY46zPVBI5bTMrs2SjZ4oixNK
# Eaq9o+/Tsjb8tKFyv22XY3mMRLxwL37zvN2CU6sa9uv6HJe8tjecpBwwvKu8LUc2
# 35IgA+hxxlj2dQWaNPALWVqCRDSqgOQvhPZHXZbJtsrKnbemuuRQ09Q3uLogDtDT
# kipbxFm7oW3bPM5EncE4Kq3jjb3NCXcaEL5nCgI2ZIi5sxsm7ueeYMRGqLxhM2zP
# TrmcuWrwnzf+tT1PmtNN/94gjk6Xpv2fCbxNyhh2ybBNhVDygNIdBvVYBAexGDCC
# BNYwggO+oAMCAQICEhEhDRayW4wRltP+V8mGEea62TANBgkqhkiG9w0BAQsFADBa
# MQswCQYDVQQGEwJCRTEZMBcGA1UEChMQR2xvYmFsU2lnbiBudi1zYTEwMC4GA1UE
# AxMnR2xvYmFsU2lnbiBDb2RlU2lnbmluZyBDQSAtIFNIQTI1NiAtIEcyMB4XDTE1
# MDUwNDE2NDMyMVoXDTE4MDUwNDE2NDMyMVowVTELMAkGA1UEBhMCQ0gxDDAKBgNV
# BAgTA1p1ZzEMMAoGA1UEBxMDWnVnMRQwEgYDVQQKEwtkLWZlbnMgR21iSDEUMBIG
# A1UEAxMLZC1mZW5zIEdtYkgwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB
# AQDNPSzSNPylU9jFM78Q/GjzB7N+VNqikf/use7p8mpnBZ4cf5b4qV3rqQd62rJH
# RlAsxgouCSNQrl8xxfg6/t/I02kPvrzsR4xnDgMiVCqVRAeQsWebafWdTvWmONBS
# lxJejPP8TSgXMKFaDa+2HleTycTBYSoErAZSWpQ0NqF9zBadjsJRVatQuPkTDrwL
# eWibiyOipK9fcNoQpl5ll5H9EG668YJR3fqX9o0TQTkOmxXIL3IJ0UxdpyDpLEkt
# tBG6Y5wAdpF2dQX2phrfFNVY54JOGtuBkNGMSiLFzTkBA1fOlA6ICMYjB8xIFxVv
# rN1tYojCrqYkKMOjwWQz5X8zAgMBAAGjggGZMIIBlTAOBgNVHQ8BAf8EBAMCB4Aw
# TAYDVR0gBEUwQzBBBgkrBgEEAaAyATIwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93
# d3cuZ2xvYmFsc2lnbi5jb20vcmVwb3NpdG9yeS8wCQYDVR0TBAIwADATBgNVHSUE
# DDAKBggrBgEFBQcDAzBCBgNVHR8EOzA5MDegNaAzhjFodHRwOi8vY3JsLmdsb2Jh
# bHNpZ24uY29tL2dzL2dzY29kZXNpZ25zaGEyZzIuY3JsMIGQBggrBgEFBQcBAQSB
# gzCBgDBEBggrBgEFBQcwAoY4aHR0cDovL3NlY3VyZS5nbG9iYWxzaWduLmNvbS9j
# YWNlcnQvZ3Njb2Rlc2lnbnNoYTJnMi5jcnQwOAYIKwYBBQUHMAGGLGh0dHA6Ly9v
# Y3NwMi5nbG9iYWxzaWduLmNvbS9nc2NvZGVzaWduc2hhMmcyMB0GA1UdDgQWBBTN
# GDddiIYZy9p3Z84iSIMd27rtUDAfBgNVHSMEGDAWgBQZSrha5E0xpRTlXuwvoxz6
# gIwyazANBgkqhkiG9w0BAQsFAAOCAQEAAApsOzSX1alF00fTeijB/aIthO3UB0ks
# 1Gg3xoKQC1iEQmFG/qlFLiufs52kRPN7L0a7ClNH3iQpaH5IEaUENT9cNEXdKTBG
# 8OrJS8lrDJXImgNEgtSwz0B40h7bM2Z+0DvXDvpmfyM2NwHF/nNVj7NzmczrLRqN
# 9de3tV0pgRqnIYordVcmb24CZl3bzpwzbQQy14Iz+P5Z2cnw+QaYzAuweTZxEUcJ
# bFwpM49c1LMPFJTuOKkUgY90JJ3gVTpyQxfkc7DNBnx74PlRzjFmeGC/hxQt0hvo
# eaAiBdjo/1uuCTToigVnyRH+c0T2AezTeoFb7ne3I538hWeTdU5q9jGCBLcwggSz
# AgEBMHAwWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MgISESENFrJbjBGW0/5XyYYR5rrZMAkGBSsOAwIaBQCgeDAYBgorBgEEAYI3AgEM
# MQowCKACgAChAoAAMBkGCSqGSIb3DQEJAzEMBgorBgEEAYI3AgEEMBwGCisGAQQB
# gjcCAQsxDjAMBgorBgEEAYI3AgEVMCMGCSqGSIb3DQEJBDEWBBSvUp0C5elo01ix
# 56a9SuZIWPGaJzANBgkqhkiG9w0BAQEFAASCAQBqdnlOE96ymaW2iTYbTyu0dKWK
# zKDpEcU2or92GwSz3qGGUaq0kDVciV7Cb53ynaZ6N3cboSQGm92s8vufUX5vUXbo
# E/tXtEkKhNUCqqhoDMxtyojQSH20XiSHyZlNdlfqZJxz120uHyqX/Au3Xq+kRPk2
# A5zJ1rS4m2DisBTvMPIJh3XZn1+WonYWtOF5qSt/HeTd84zKeozYMx5QNBXBDpWk
# H5NdTJU2jPyKQIt4Beuktas2hndWxKHVOFTAfPb6/X7RbA4ux6cFqn3XNTbLpMMi
# v4ViQnOh02se9Ktmf2VmQw0PAn4smqnhTASsjPXI7/3mYFVwIftLLjWgmMtzoYIC
# ojCCAp4GCSqGSIb3DQEJBjGCAo8wggKLAgEBMGgwUjELMAkGA1UEBhMCQkUxGTAX
# BgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGlt
# ZXN0YW1waW5nIENBIC0gRzICEhEh1pmnZJc+8fhCfukZzFNBFDAJBgUrDgMCGgUA
# oIH9MBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTE2
# MDgzMTE5MTcwNVowIwYJKoZIhvcNAQkEMRYEFBkagLxArWwX7jG+uTx9iNi4QAw+
# MIGdBgsqhkiG9w0BCRACDDGBjTCBijCBhzCBhAQUY7gvq2H1g5CWlQULACScUCkz
# 7HkwbDBWpFQwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYt
# c2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzICEhEh
# 1pmnZJc+8fhCfukZzFNBFDANBgkqhkiG9w0BAQEFAASCAQBfTkiYRS/AfgrjwfuO
# 651Ts1c1QSODayABW61V8w3jjIUQjNwSG6G2AIWMPHsGggV4qRoA4k6MzyZpuJ88
# AzcDyAgYMvLwygBhdxYa2/aHvp7oamv3GnnKzcnKdUr0iLwIh3wA9J3hk82tFktf
# SGxQreSFesGiJhwUyXaPY9b5UMRULAkEynWQqPJzDyZ0hKQunxE2aYWf0K1lXF3Z
# ZUlTdeHIX8IfXBmUv9Gt60h2alfL+kTb9zvUKrRdEsNKNOUFR0B7v69Q5ekgcGJP
# vHuTj4nfDGqs55IOTQG/bnajmkceZ9GxIWI3YMSOVMWPC75S99+OZRueFo5lS/MA
# QMLr
# SIG # End signature block
|
PowerShellCorpus/PowerShellGallery/biz.dfch.PS.Appclusive.Client/5.2.1.20161201/Get-Node.ps1
|
Get-Node.ps1
|
function Get-Node {
<#
.SYNOPSIS
Retrieves one or more entities from the Node entity set.
.DESCRIPTION
Retrieves one or more entities from the Node entity set.
You can retrieve one ore more entities from the entity set by specifying
Id, Name or other properties.
.INPUTS
The Cmdlet can either return all available entities or filter entities on
specified conditions.
See PARAMETERS section on possible inputs.
.OUTPUTS
default | json | json-pretty | xml | xml-pretty
In addition output can be filtered on specified properties.
.EXAMPLE
Get-Node -ListAvailable -Select Id, Name
Id Name
-- ----
8 SomeArbitraryNode
15 SomeOtherNode
42 TheAnswerToEverythingNode
667 NeighbourNode
Retrieves the id and name of all Nodes.
.EXAMPLE
Get-Node 218
Parameters : {"Hostname":"Server01"}
EntityKindId : 27
ParentId : 1
Id : 218
Tid : 22222222-2222-2222-2222-222222222222
Name : abhenry
Description : abhenry is a whiles for timeous purposes
CreatedById : 1
ModifiedById : 1
Created : 15.12.2015 12:06:49 +01:00
Modified : 15.12.2015 12:06:49 +01:00
RowVersion : {0, 0, 0, 0...}
Parent :
EntityKind :
Children : {}
IncomingAssocs : {}
OutgoingAssocs : {}
Tenant :
CreatedBy :
ModifiedBy :
Retrieves the Node object with Id 218 and returns all properties of it.
.EXAMPLE
Get-Node 218 -Select Parameters -ValueOnly -ConvertFromJson
Hostname
---
Server01
Similar to the previous example, but only returns the 'Parameters' property
of it. In addition the contents of the property will be converted from JSON.
.EXAMPLE
Get-Node -ListAvailable -Select Id -First 3
Id
--
218
271
358
Retrieves the id of the first 3 Nodes.
.EXAMPLE
Get-Node 218 -Select Name -ValueOnly
abhenry
Retrieves the name of the Node with Id 218.
.EXAMPLE
Get-Node -ModifiedBy SYSTEM -Select Id, Name
Id Name
-- ----
1 Root Node
2 biz.dfch.CS.Appclusive.Core.OdataServices.Core.Node
3 biz.dfch.CS.Appclusive.Core.OdataServices.Core.Node
4 biz.dfch.CS.Appclusive.Core.OdataServices.Core.Node
5 biz.dfch.CS.Appclusive.Core.OdataServices.Core.Node
6 biz.dfch.CS.Appclusive.Core.OdataServices.Core.Node
7 biz.dfch.CS.Appclusive.Core.OdataServices.Core.Node
8 biz.dfch.CS.Appclusive.Core.OdataServices.Core.Node
9 biz.dfch.CS.Appclusive.Core.OdataServices.Core.Node
10 biz.dfch.CS.Appclusive.Core.OdataServices.Core.Node
11 biz.dfch.CS.Appclusive.Core.OdataServices.Core.Node
12 biz.dfch.CS.Appclusive.Core.OdataServices.Core.Node
13 biz.dfch.CS.Appclusive.Core.OdataServices.Core.Node
14 biz.dfch.CS.Appclusive.Core.OdataServices.Core.Node
15 biz.dfch.CS.Appclusive.Core.OdataServices.Core.Node
16 biz.dfch.CS.Appclusive.Core.OdataServices.Core.Node
17 biz.dfch.CS.Appclusive.Core.OdataServices.Core.Node
18 biz.dfch.CS.Appclusive.Core.OdataServices.Core.Node
19 biz.dfch.CS.Appclusive.Core.OdataServices.Core.Node
20 biz.dfch.CS.Appclusive.Core.OdataServices.Core.Node
Retrieves id and name of all Nodes that have been modified by user
with name 'SYSTEM' (case insensitive substring match).
.EXAMPLE
Get-Node AppclusiveScheduler -Select Name -ValueOnly -DefaultValue 'AppclusiveSchedulerNotAvailable'
AppclusiveSchedulerNotAvailable
Retrieves the 'Name' property of a Node with Name 'AppclusiveScheduler'
and AppclusiveSchedulerNotAvailable if the entity is not found.
.LINK
Online Version: http://dfch.biz/biz/dfch/PS/Appclusive/Client/Get-Node/
.NOTES
See module manifest for required software versions and dependencies.
#>
[CmdletBinding(
SupportsShouldProcess = $true
,
ConfirmImpact = 'Low'
,
HelpURI = 'http://dfch.biz/biz/dfch/PS/Appclusive/Client/Get-Node/'
,
DefaultParameterSetName = 'list'
)]
PARAM
(
# Specifies the id of the entity
[Parameter(Mandatory = $false, Position = 0, ParameterSetName = 'id')]
[long] $Id
,
# Specifies the name of the entity
[Parameter(Mandatory = $false, Position = 0, ParameterSetName = 'name')]
[Alias('n')]
[string] $Name
,
# Filter by creator
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[string] $CreatedBy
,
# Filter by modifier
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[string] $ModifiedBy
,
# Specifies the Parent id for this entity
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[long] $ParentId
,
# Specifies the EntityKind id for this entity
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[long] $EntityKindId
,
# Specifies the EntityKind name for this entity
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[string] $EntityKindName
,
# Specify the attributes of the entity to return
[Parameter(Mandatory = $false)]
[string[]] $Select = @()
,
# Specifies to return only values without header information.
# This parameter takes precendes over the 'Select' parameter.
[ValidateScript( { if(1 -eq $Select.Count -And $_) { $true; } else { throw("You must specify exactly one 'Select' property when using 'ValueOnly'."); } } )]
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[Parameter(Mandatory = $false, ParameterSetName = 'id')]
[Alias('HideTableHeaders')]
[switch] $ValueOnly
,
# This value is only returned if the regular search would have returned no results
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[Alias('default')]
$DefaultValue
,
# Specifies to deserialize JSON payloads
[ValidateScript( { if($ValueOnly -And $_) { $true; } else { throw("You must set the 'ValueOnly' switch when using 'ConvertFromJson'."); } } )]
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[Parameter(Mandatory = $false, ParameterSetName = 'id')]
[Alias('Convert')]
[switch] $ConvertFromJson
,
# Limits the output to the specified number of entries
[Parameter(Mandatory = $false)]
[Alias('top')]
[int] $First
,
# Service reference to Appclusive
[Parameter(Mandatory = $false)]
[Alias('Services')]
[hashtable] $svc = (Get-Variable -Name $MyInvocation.MyCommand.Module.PrivateData.MODULEVAR -ValueOnly).Services
,
# Indicates to return all file information
[Parameter(Mandatory = $false, ParameterSetName = 'list')]
[switch] $ListAvailable = $false
,
# Indicates to return child information
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[Parameter(Mandatory = $false, ParameterSetName = 'id')]
[Alias('ExpandChildNodes')]
[switch] $ExpandChildren = $false
,
# Indicates to return job information
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[Parameter(Mandatory = $false, ParameterSetName = 'id')]
[Alias('ExpandStatus')]
[switch] $ExpandJob = $false
,
# Indicates to return available actions information
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[Parameter(Mandatory = $false, ParameterSetName = 'id')]
[switch] $ExpandAvailableActions = $false
,
# Indicates to return externalnodes
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[Parameter(Mandatory = $false, ParameterSetName = 'id')]
[switch] $ExpandExternalNodes = $false
,
# Returns all Connectors which provide this Interface
[Parameter(Mandatory = $true, ParameterSetName = 'ProvideInterface')]
[Alias('Provide')]
[long] $ProvideInterface
,
# Returns all Connectors which require this Interface
[Parameter(Mandatory = $true, ParameterSetName = 'RequireInterface')]
[Alias('Require')]
[long] $RequireInterface
,
# Specifies the return format of the Cmdlet
[ValidateSet('default', 'json', 'json-pretty', 'xml', 'xml-pretty')]
[Parameter(Mandatory = $false)]
[alias('ReturnFormat')]
[string] $As = 'default'
)
Begin
{
trap { Log-Exception $_; break; }
$datBegin = [datetime]::Now;
[string] $fn = $MyInvocation.MyCommand.Name;
Log-Debug -fn $fn -msg ("CALL. svc '{0}'. Name '{1}'." -f ($svc -is [Object]), $Name) -fac 1;
$EntitySetName = 'Nodes';
# Parameter validation
Contract-Requires ($svc.Core -is [biz.dfch.CS.Appclusive.Api.Core.Core]) "Connect to the server before using the Cmdlet";
Contract-Requires (1 -ge ($PSBoundParameters.GetEnumerator() | Where { $_.Key -match 'Expand' -and $_.Value -eq $true}).Count) "You can specify only one 'Expand...' param.";
if($Select)
{
$Select = $Select | Select -Unique;
}
}
# Begin
Process
{
trap { Log-Exception $_; break; }
# Default test variable for checking function response codes.
[Boolean] $fReturn = $false;
# Return values are always and only returned via OutputParameter.
$OutputParameter = $null;
Contract-Assert ($PSCmdlet.ShouldProcess(($PSBoundParameters | Out-String)))
if($PSCmdlet.ParameterSetName -eq 'list')
{
if($PSBoundParameters.ContainsKey('First'))
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$orderby', 'Name').AddQueryOption('$top', $First) | Select;
}
else
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$orderby', 'Name') | Select;
}
if($Select)
{
$Response = $Response | Select -Property $Select;
}
}
elseif($PSCmdlet.ParameterSetName -eq 'RequireInterface')
{
$Response = $svc.Core.InvokeEntitySetActionWithListResult("Nodes", "RequireInterface", [biz.dfch.CS.Appclusive.Api.Core.Node], @{"InterfaceId"=$RequireInterface});
if($Select)
{
$Response = $Response | Select -Property $Select;
}
}
elseif($PSCmdlet.ParameterSetName -eq 'ProvideInterface')
{
$Response = $svc.Core.InvokeEntitySetActionWithListResult("Nodes", "ProvideInterface", [biz.dfch.CS.Appclusive.Api.Core.Node], @{"InterfaceId"=$ProvideInterface});
if($Select)
{
$Response = $Response | Select -Property $Select;
}
}
else
{
$Exp = @();
if($PSCmdlet.ParameterSetName -eq 'id')
{
$Exp += ("Id eq {0}L" -f $Id);
}
if($Name)
{
$Exp += ("tolower(Name) eq '{0}'" -f [uri]::EscapeDataString($Name.ToLower()));
}
if($ParentId)
{
$Exp += ("ParentId eq {0}L" -f $ParentId);
}
if($CreatedBy)
{
$CreatedById = Get-User -svc $svc $CreatedBy -Select Id -ValueOnly;
Contract-Assert ( !!$CreatedById ) 'User not found';
$Exp += ("(CreatedById eq {0}L)" -f $CreatedById);
}
if($ModifiedBy)
{
$ModifiedById = Get-User -svc $svc $ModifiedBy -Select Id -ValueOnly;
Contract-Assert ( !!$ModifiedById ) 'User not found';
$Exp += ("(ModifiedById eq {0}L)" -f $ModifiedById);
}
if($CreatedBy)
{
$CreatedById = Get-User -svc $svc $CreatedBy -Select Id -ValueOnly;
Contract-Assert ( !!$CreatedById ) 'User not found';
$Exp += ("(CreatedById eq {0})" -f $CreatedById);
}
if($EntityKindName)
{
$EntityKindId = Get-EntityKind -Name $EntityKindName -svc $svc -Select Id -ValueOnly;
Contract-Assert ( !!$EntityKindId ) 'EntityKind not found';
}
if($EntityKindId)
{
$Exp += ("(EntityKindId eq {0}L)" -f $EntityKindId);
}
$FilterExpression = [String]::Join(' and ', $Exp);
if($PSBoundParameters.ContainsKey('First'))
{
if(!$ExpandChildren)
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$filter', $FilterExpression).AddQueryOption('$top', $First) | Select;
}
else
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$filter', $FilterExpression).AddQueryOption('$expand', 'Children').AddQueryOption('$top', $First) | Select;
}
}
else
{
if(!$ExpandChildren)
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$filter', $FilterExpression) | Select;
}
else
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$filter', $FilterExpression).AddQueryOption('$expand', 'Children') | Select;
}
}
if($Select)
{
$Response = $Response | Select -Property $Select;
}
else
{
if ( $ExpandJob )
{
$ResponseTemp = New-Object System.Collections.ArrayList;
foreach ($item in $Response)
{
if ( $item )
{
$Response_ = $svc.Core.InvokeEntityActionWithSingleResult($item, 'Status', [System.Object], $null);
$null = $ResponseTemp.Add($Response_);
}
}
$Response = $ResponseTemp.ToArray();
}
if ( $ExpandAvailableActions )
{
$ResponseTemp = New-Object System.Collections.ArrayList;
foreach ($item in $Response)
{
if ( $item )
{
$Response_ = $svc.Core.InvokeEntityActionWithListResult($item, 'AvailableActions', [string], $null);
$null = $ResponseTemp.Add($Response_);
}
}
$Response = $ResponseTemp.ToArray();
}
if ( $ExpandExternalNodes )
{
$ResponseTemp = New-Object System.Collections.ArrayList;
foreach ($item in $Response)
{
if ( $item )
{
$Response_ = $svc.Core.ExternalNodes.AddQueryOption('$filter', 'NodeId eq {0}' -f $item.Id);
$null = $ResponseTemp.Add($Response_);
}
}
$Response = $ResponseTemp.ToArray();
}
}
if(1 -eq $Select.Count -And $ValueOnly)
{
$Response = $Response.$Select;
}
if($PSBoundParameters.ContainsKey('DefaultValue') -And !$Response)
{
$Response = $DefaultValue;
}
if($ValueOnly -And $ConvertFromJson)
{
$ResponseTemp = New-Object System.Collections.ArrayList;
foreach($item in $Response)
{
try
{
$null = $ResponseTemp.Add((ConvertFrom-Json -InputObject $item));
}
catch
{
$null = $ResponseTemp.Add($item);
}
}
$Response = $ResponseTemp.ToArray();
}
}
$OutputParameter = Format-ResultAs $Response $As
$fReturn = $true;
}
# Process
End
{
$datEnd = [datetime]::Now;
Log-Debug -fn $fn -msg ("RET. fReturn: [{0}]. Execution time: [{1}]ms. Started: [{2}]." -f $fReturn, ($datEnd - $datBegin).TotalMilliseconds, $datBegin.ToString('yyyy-MM-dd HH:mm:ss.fffzzz')) -fac 2;
# Return values are always and only returned via OutputParameter.
return $OutputParameter;
}
# End
} # function
if($MyInvocation.ScriptName) { Export-ModuleMember -Function Get-Node; }
#
# Copyright 2014-2015 d-fens GmbH
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SIG # Begin signature block
# MIIXDwYJKoZIhvcNAQcCoIIXADCCFvwCAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB
# gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR
# AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQUCUSmVW62YxBWMP9bVlob5RY/
# cnmgghHCMIIEFDCCAvygAwIBAgILBAAAAAABL07hUtcwDQYJKoZIhvcNAQEFBQAw
# VzELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNV
# BAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkdsb2JhbFNpZ24gUm9vdCBDQTAeFw0xMTA0
# MTMxMDAwMDBaFw0yODAxMjgxMjAwMDBaMFIxCzAJBgNVBAYTAkJFMRkwFwYDVQQK
# ExBHbG9iYWxTaWduIG52LXNhMSgwJgYDVQQDEx9HbG9iYWxTaWduIFRpbWVzdGFt
# cGluZyBDQSAtIEcyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAlO9l
# +LVXn6BTDTQG6wkft0cYasvwW+T/J6U00feJGr+esc0SQW5m1IGghYtkWkYvmaCN
# d7HivFzdItdqZ9C76Mp03otPDbBS5ZBb60cO8eefnAuQZT4XljBFcm05oRc2yrmg
# jBtPCBn2gTGtYRakYua0QJ7D/PuV9vu1LpWBmODvxevYAll4d/eq41JrUJEpxfz3
# zZNl0mBhIvIG+zLdFlH6Dv2KMPAXCae78wSuq5DnbN96qfTvxGInX2+ZbTh0qhGL
# 2t/HFEzphbLswn1KJo/nVrqm4M+SU4B09APsaLJgvIQgAIMboe60dAXBKY5i0Eex
# +vBTzBj5Ljv5cH60JQIDAQABo4HlMIHiMA4GA1UdDwEB/wQEAwIBBjASBgNVHRMB
# Af8ECDAGAQH/AgEAMB0GA1UdDgQWBBRG2D7/3OO+/4Pm9IWbsN1q1hSpwTBHBgNV
# HSAEQDA+MDwGBFUdIAAwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93d3cuZ2xvYmFs
# c2lnbi5jb20vcmVwb3NpdG9yeS8wMwYDVR0fBCwwKjAooCagJIYiaHR0cDovL2Ny
# bC5nbG9iYWxzaWduLm5ldC9yb290LmNybDAfBgNVHSMEGDAWgBRge2YaRQ2XyolQ
# L30EzTSo//z9SzANBgkqhkiG9w0BAQUFAAOCAQEATl5WkB5GtNlJMfO7FzkoG8IW
# 3f1B3AkFBJtvsqKa1pkuQJkAVbXqP6UgdtOGNNQXzFU6x4Lu76i6vNgGnxVQ380W
# e1I6AtcZGv2v8Hhc4EvFGN86JB7arLipWAQCBzDbsBJe/jG+8ARI9PBw+DpeVoPP
# PfsNvPTF7ZedudTbpSeE4zibi6c1hkQgpDttpGoLoYP9KOva7yj2zIhd+wo7AKvg
# IeviLzVsD440RZfroveZMzV+y5qKu0VN5z+fwtmK+mWybsd+Zf/okuEsMaL3sCc2
# SI8mbzvuTXYfecPlf5Y1vC0OzAGwjn//UYCAp5LUs0RGZIyHTxZjBzFLY7Df8zCC
# BCkwggMRoAMCAQICCwQAAAAAATGJxjfoMA0GCSqGSIb3DQEBCwUAMEwxIDAeBgNV
# BAsTF0dsb2JhbFNpZ24gUm9vdCBDQSAtIFIzMRMwEQYDVQQKEwpHbG9iYWxTaWdu
# MRMwEQYDVQQDEwpHbG9iYWxTaWduMB4XDTExMDgwMjEwMDAwMFoXDTE5MDgwMjEw
# MDAwMFowWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKPv0Z8p6djTgnY8YqDS
# SdYWHvHP8NC6SEMDLacd8gE0SaQQ6WIT9BP0FoO11VdCSIYrlViH6igEdMtyEQ9h
# JuH6HGEVxyibTQuCDyYrkDqW7aTQaymc9WGI5qRXb+70cNCNF97mZnZfdB5eDFM4
# XZD03zAtGxPReZhUGks4BPQHxCMD05LL94BdqpxWBkQtQUxItC3sNZKaxpXX9c6Q
# MeJ2s2G48XVXQqw7zivIkEnotybPuwyJy9DDo2qhydXjnFMrVyb+Vpp2/WFGomDs
# KUZH8s3ggmLGBFrn7U5AXEgGfZ1f53TJnoRlDVve3NMkHLQUEeurv8QfpLqZ0BdY
# Nc0CAwEAAaOB/TCB+jAOBgNVHQ8BAf8EBAMCAQYwEgYDVR0TAQH/BAgwBgEB/wIB
# ADAdBgNVHQ4EFgQUGUq4WuRNMaUU5V7sL6Mc+oCMMmswRwYDVR0gBEAwPjA8BgRV
# HSAAMDQwMgYIKwYBBQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3Jl
# cG9zaXRvcnkvMDYGA1UdHwQvMC0wK6ApoCeGJWh0dHA6Ly9jcmwuZ2xvYmFsc2ln
# bi5uZXQvcm9vdC1yMy5jcmwwEwYDVR0lBAwwCgYIKwYBBQUHAwMwHwYDVR0jBBgw
# FoAUj/BLf6guRSSuTVD6Y5qL3uLdG7wwDQYJKoZIhvcNAQELBQADggEBAHmwaTTi
# BYf2/tRgLC+GeTQD4LEHkwyEXPnk3GzPbrXsCly6C9BoMS4/ZL0Pgmtmd4F/ximl
# F9jwiU2DJBH2bv6d4UgKKKDieySApOzCmgDXsG1szYjVFXjPE/mIpXNNwTYr3MvO
# 23580ovvL72zT006rbtibiiTxAzL2ebK4BEClAOwvT+UKFaQHlPCJ9XJPM0aYx6C
# WRW2QMqngarDVa8z0bV16AnqRwhIIvtdG/Mseml+xddaXlYzPK1X6JMlQsPSXnE7
# ShxU7alVrCgFx8RsXdw8k/ZpPIJRzhoVPV4Bc/9Aouq0rtOO+u5dbEfHQfXUVlfy
# GDcy1tTMS/Zx4HYwggSfMIIDh6ADAgECAhIRIdaZp2SXPvH4Qn7pGcxTQRQwDQYJ
# KoZIhvcNAQEFBQAwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24g
# bnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzIw
# HhcNMTYwNTI0MDAwMDAwWhcNMjcwNjI0MDAwMDAwWjBgMQswCQYDVQQGEwJTRzEf
# MB0GA1UEChMWR01PIEdsb2JhbFNpZ24gUHRlIEx0ZDEwMC4GA1UEAxMnR2xvYmFs
# U2lnbiBUU0EgZm9yIE1TIEF1dGhlbnRpY29kZSAtIEcyMIIBIjANBgkqhkiG9w0B
# AQEFAAOCAQ8AMIIBCgKCAQEAsBeuotO2BDBWHlgPse1VpNZUy9j2czrsXV6rJf02
# pfqEw2FAxUa1WVI7QqIuXxNiEKlb5nPWkiWxfSPjBrOHOg5D8NcAiVOiETFSKG5d
# QHI88gl3p0mSl9RskKB2p/243LOd8gdgLE9YmABr0xVU4Prd/4AsXximmP/Uq+yh
# RVmyLm9iXeDZGayLV5yoJivZF6UQ0kcIGnAsM4t/aIAqtaFda92NAgIpA6p8N7u7
# KU49U5OzpvqP0liTFUy5LauAo6Ml+6/3CGSwekQPXBDXX2E3qk5r09JTJZ2Cc/os
# +XKwqRk5KlD6qdA8OsroW+/1X1H0+QrZlzXeaoXmIwRCrwIDAQABo4IBXzCCAVsw
# DgYDVR0PAQH/BAQDAgeAMEwGA1UdIARFMEMwQQYJKwYBBAGgMgEeMDQwMgYIKwYB
# BQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3JlcG9zaXRvcnkvMAkG
# A1UdEwQCMAAwFgYDVR0lAQH/BAwwCgYIKwYBBQUHAwgwQgYDVR0fBDswOTA3oDWg
# M4YxaHR0cDovL2NybC5nbG9iYWxzaWduLmNvbS9ncy9nc3RpbWVzdGFtcGluZ2cy
# LmNybDBUBggrBgEFBQcBAQRIMEYwRAYIKwYBBQUHMAKGOGh0dHA6Ly9zZWN1cmUu
# Z2xvYmFsc2lnbi5jb20vY2FjZXJ0L2dzdGltZXN0YW1waW5nZzIuY3J0MB0GA1Ud
# DgQWBBTUooRKOFoYf7pPMFC9ndV6h9YJ9zAfBgNVHSMEGDAWgBRG2D7/3OO+/4Pm
# 9IWbsN1q1hSpwTANBgkqhkiG9w0BAQUFAAOCAQEAj6kakW0EpjcgDoOW3iPTa24f
# bt1kPWghIrX4RzZpjuGlRcckoiK3KQnMVFquxrzNY46zPVBI5bTMrs2SjZ4oixNK
# Eaq9o+/Tsjb8tKFyv22XY3mMRLxwL37zvN2CU6sa9uv6HJe8tjecpBwwvKu8LUc2
# 35IgA+hxxlj2dQWaNPALWVqCRDSqgOQvhPZHXZbJtsrKnbemuuRQ09Q3uLogDtDT
# kipbxFm7oW3bPM5EncE4Kq3jjb3NCXcaEL5nCgI2ZIi5sxsm7ueeYMRGqLxhM2zP
# TrmcuWrwnzf+tT1PmtNN/94gjk6Xpv2fCbxNyhh2ybBNhVDygNIdBvVYBAexGDCC
# BNYwggO+oAMCAQICEhEhDRayW4wRltP+V8mGEea62TANBgkqhkiG9w0BAQsFADBa
# MQswCQYDVQQGEwJCRTEZMBcGA1UEChMQR2xvYmFsU2lnbiBudi1zYTEwMC4GA1UE
# AxMnR2xvYmFsU2lnbiBDb2RlU2lnbmluZyBDQSAtIFNIQTI1NiAtIEcyMB4XDTE1
# MDUwNDE2NDMyMVoXDTE4MDUwNDE2NDMyMVowVTELMAkGA1UEBhMCQ0gxDDAKBgNV
# BAgTA1p1ZzEMMAoGA1UEBxMDWnVnMRQwEgYDVQQKEwtkLWZlbnMgR21iSDEUMBIG
# A1UEAxMLZC1mZW5zIEdtYkgwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB
# AQDNPSzSNPylU9jFM78Q/GjzB7N+VNqikf/use7p8mpnBZ4cf5b4qV3rqQd62rJH
# RlAsxgouCSNQrl8xxfg6/t/I02kPvrzsR4xnDgMiVCqVRAeQsWebafWdTvWmONBS
# lxJejPP8TSgXMKFaDa+2HleTycTBYSoErAZSWpQ0NqF9zBadjsJRVatQuPkTDrwL
# eWibiyOipK9fcNoQpl5ll5H9EG668YJR3fqX9o0TQTkOmxXIL3IJ0UxdpyDpLEkt
# tBG6Y5wAdpF2dQX2phrfFNVY54JOGtuBkNGMSiLFzTkBA1fOlA6ICMYjB8xIFxVv
# rN1tYojCrqYkKMOjwWQz5X8zAgMBAAGjggGZMIIBlTAOBgNVHQ8BAf8EBAMCB4Aw
# TAYDVR0gBEUwQzBBBgkrBgEEAaAyATIwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93
# d3cuZ2xvYmFsc2lnbi5jb20vcmVwb3NpdG9yeS8wCQYDVR0TBAIwADATBgNVHSUE
# DDAKBggrBgEFBQcDAzBCBgNVHR8EOzA5MDegNaAzhjFodHRwOi8vY3JsLmdsb2Jh
# bHNpZ24uY29tL2dzL2dzY29kZXNpZ25zaGEyZzIuY3JsMIGQBggrBgEFBQcBAQSB
# gzCBgDBEBggrBgEFBQcwAoY4aHR0cDovL3NlY3VyZS5nbG9iYWxzaWduLmNvbS9j
# YWNlcnQvZ3Njb2Rlc2lnbnNoYTJnMi5jcnQwOAYIKwYBBQUHMAGGLGh0dHA6Ly9v
# Y3NwMi5nbG9iYWxzaWduLmNvbS9nc2NvZGVzaWduc2hhMmcyMB0GA1UdDgQWBBTN
# GDddiIYZy9p3Z84iSIMd27rtUDAfBgNVHSMEGDAWgBQZSrha5E0xpRTlXuwvoxz6
# gIwyazANBgkqhkiG9w0BAQsFAAOCAQEAAApsOzSX1alF00fTeijB/aIthO3UB0ks
# 1Gg3xoKQC1iEQmFG/qlFLiufs52kRPN7L0a7ClNH3iQpaH5IEaUENT9cNEXdKTBG
# 8OrJS8lrDJXImgNEgtSwz0B40h7bM2Z+0DvXDvpmfyM2NwHF/nNVj7NzmczrLRqN
# 9de3tV0pgRqnIYordVcmb24CZl3bzpwzbQQy14Iz+P5Z2cnw+QaYzAuweTZxEUcJ
# bFwpM49c1LMPFJTuOKkUgY90JJ3gVTpyQxfkc7DNBnx74PlRzjFmeGC/hxQt0hvo
# eaAiBdjo/1uuCTToigVnyRH+c0T2AezTeoFb7ne3I538hWeTdU5q9jGCBLcwggSz
# AgEBMHAwWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MgISESENFrJbjBGW0/5XyYYR5rrZMAkGBSsOAwIaBQCgeDAYBgorBgEEAYI3AgEM
# MQowCKACgAChAoAAMBkGCSqGSIb3DQEJAzEMBgorBgEEAYI3AgEEMBwGCisGAQQB
# gjcCAQsxDjAMBgorBgEEAYI3AgEVMCMGCSqGSIb3DQEJBDEWBBQsFaP2JQ8d0jwn
# 96g7q1OQJ5tDHzANBgkqhkiG9w0BAQEFAASCAQCFE2tcV6lvcL+NnQmov+Mf7nIb
# IXCWG+GXLI220rurdfgmhPwKnZZfCXrwNqAyNUqQ3WZFNaSp05wwC6aXouKH8p2j
# 6Z8+nv5Ki+aPkft2pFRsk/eZ8g3LuUbidiyNOFwrNbClSgbndYvVI554txlWwqZT
# v7WxjVjXIJqYS0dISwk5/qo+zaFCu+JeJAcvoQLJbTrVwTzYvoDA9VmUetc7u18U
# /c64EHIf2zU+5HtHp6Yb1XV5Vk7hre7qME5dFYOrBIXGPssiit9HI+fvkFwXBPsr
# xe6gwmB/7OLUxhi1gjfvvP2TYfoKU8jfM795gOzrwU4ljzfdy4gppWnpZZtaoYIC
# ojCCAp4GCSqGSIb3DQEJBjGCAo8wggKLAgEBMGgwUjELMAkGA1UEBhMCQkUxGTAX
# BgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGlt
# ZXN0YW1waW5nIENBIC0gRzICEhEh1pmnZJc+8fhCfukZzFNBFDAJBgUrDgMCGgUA
# oIH9MBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTE2
# MDgzMTE5MTY0NVowIwYJKoZIhvcNAQkEMRYEFEhKt8XshwyXAuzEe4bUwcNAffa5
# MIGdBgsqhkiG9w0BCRACDDGBjTCBijCBhzCBhAQUY7gvq2H1g5CWlQULACScUCkz
# 7HkwbDBWpFQwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYt
# c2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzICEhEh
# 1pmnZJc+8fhCfukZzFNBFDANBgkqhkiG9w0BAQEFAASCAQAyioTNEKyObYoAP3jH
# D8fV/bkkzOstuWMwJGQVNb99pDfV3FyxVGweVYGwbYKUBXPBelS3s60Uxilg10TV
# yeBofgYxwgUEJw89W30IuImDcDo+/IllRu9gyI8MdLMDBT5tAHazyTZl/45NeNbw
# l5mnNgmRq3E/Muught/IZ49Q39nn0X0WSBB9eDAIN18ITiLosydYio1yvmTodSe6
# OCKvC2kW2yP/g0MMbLU3zlasHtNTSsyMYPZRtlm6mX9/qnC4tryeljDL3SPRLqg+
# nGVC7kp3EAtlnZCwNOAAaquYO2CeysEdG+Hsai4ADb96QxxkxwsqTEUoWGI5nyRs
# NXBe
# SIG # End signature block
|
PowerShellCorpus/PowerShellGallery/biz.dfch.PS.Appclusive.Client/5.2.1.20161201/Set-ManagementCredential.ps1
|
Set-ManagementCredential.ps1
|
function Set-ManagementCredential {
<#
.SYNOPSIS
Sets or creates a ManagementCredential entry in Appclusive.
.DESCRIPTION
Sets or creates a ManagementCredential entry in Appclusive.
By updating a ManagementCredential entry you can specify if you want to update the Name, Username, Password or any combination thereof.
.OUTPUTS
default
.EXAMPLE
Set-ManagementCredential myName myUserName myPassword -CreateIfNotExist
Username : myUserName
EncryptedPassword : ***
Id : 4
Tid : 22222222-2222-2222-2222-222222222222
Name : myName
Description :
CreatedById : 1
ModifiedById : 1
Created : 01.12.2015 00:00:00 +01:00
Modified : 01.12.2015 00:00:00 +01:00
RowVersion : {0, 0, 0, 0...}
ManagementUris : {}
Tenant :
CreatedBy : SYSTEM
ModifiedBy : SYSTEM
Create a new ManagementCredential entry if it does not exists.
.EXAMPLE
Set-ManagementCredential -Name myName -NewName myNewName -Username myNewUserName -Password myNewPassword
Username : myNewUserName
EncryptedPassword : ***
Id : 4
Tid : 22222222-2222-2222-2222-222222222222
Name : myNewName
Description :
CreatedById : 1
ModifiedById : 1
Created : 01.12.2015 00:00:00 +01:00
Modified : 01.12.2015 00:00:00 +01:00
RowVersion : {0, 0, 0, 0...}
ManagementUris : {}
Tenant :
CreatedBy : SYSTEM
ModifiedBy : SYSTEM
Update an existing ManagementCredential with new name, username and password.
.LINK
Online Version: http://dfch.biz/biz/dfch/PS/Appclusive/Client/New-ManagementCredential/
Set-ManagementCredential: http://dfch.biz/biz/dfch/PS/Appclusive/Client/Set-ManagementCredential/
.NOTES
See module manifest for dependencies and further requirements.
#>
[CmdletBinding(
SupportsShouldProcess = $false
,
ConfirmImpact = 'Low'
,
HelpURI = 'http://dfch.biz/biz/dfch/PS/Appclusive/Client/Set-ManagementCredential/'
)]
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseShouldProcessForStateChangingFunctions", "")]
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidUsingUserNameAndPassWordParams", "")]
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidUsingPlainTextForPassword", "")]
Param
(
# Specifies the name to modify
[Parameter(Mandatory = $true, Position = 0)]
[Alias('n')]
[string] $Name
,
# Specifies the new name name
[Parameter(Mandatory = $false)]
[string] $NewName
,
# Specifies the description
[Parameter(Mandatory = $false)]
[Alias("d")]
[string] $Description
,
# Specifies the key to modify
[Parameter(Mandatory = $false, Position = 1)]
[string] $Username
,
# Specifies the new name name
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidUsingUserNameAndPassWordParams", "Password")]
[Parameter(Mandatory = $false, Position = 2)]
[string] $Password
,
# Specifies to create a entity if it does not exist
[Parameter(Mandatory = $false)]
[Alias("c")]
[switch] $CreateIfNotExist = $false
,
# Service reference to Appclusive
[Parameter(Mandatory = $false)]
[Alias('Services')]
[hashtable] $svc = (Get-Variable -Name $MyInvocation.MyCommand.Module.PrivateData.MODULEVAR -ValueOnly).Services
,
# Specifies the return format of the Cmdlet
[ValidateSet('default', 'json', 'json-pretty', 'xml', 'xml-pretty')]
[Parameter(Mandatory = $false)]
[alias('ReturnFormat')]
[string] $As = 'default'
)
Begin
{
trap { Log-Exception $_; break; }
$datBegin = [datetime]::Now;
[string] $fn = $MyInvocation.MyCommand.Name;
Log-Debug -fn $fn -msg ("CALL. svc '{0}'. Name '{1}'." -f ($svc -is [Object]), $Name) -fac 1;
# Parameter validation
Contract-Requires ($svc.Core -is [biz.dfch.CS.Appclusive.Api.Core.Core]) "Connect to the server before using the Cmdlet"
}
# Begin
Process
{
# Default test variable for checking function response codes.
[Boolean] $fReturn = $false;
# Return values are always and only returned via OutputParameter.
$OutputParameter = $null;
$AddedEntity = $null;
try
{
$FilterExpression = "(tolower(Name) eq '{0}')" -f $Name.toLower();
$entity = $svc.Core.ManagementCredentials.AddQueryOption('$filter', $FilterExpression).AddQueryOption('$top',1) | Select;
if(!$CreateIfNotExist -And !$entity)
{
$msg = "Name: Parameter validation FAILED. Entity does not exist. Use '-CreateIfNotExist' to create resource: '{0}'" -f $Name;
$e = New-CustomErrorRecord -m $msg -cat ObjectNotFound -o $Name;
throw($gotoError);
}
if(!$entity)
{
$entity = New-Object biz.dfch.CS.Appclusive.Api.Core.ManagementCredential;
$svc.Core.AddToManagementCredentials($entity);
$AddedEntity = $entity;
$entity.Name = $Name;
$entity.Created = [System.DateTimeOffset]::Now;
$entity.Modified = $entity.Created;
$entity.CreatedById = 0;
$entity.ModifiedById = 0;
$entity.Tid = [guid]::Empty.ToString();
$entity.EncryptedPassword = "crypttext";
}
if($PSBoundParameters.ContainsKey('Description'))
{
$entity.Description = $Description;
}
if($PSBoundParameters.ContainsKey('Username'))
{
$entity.Username = $Username;
}
if($PSBoundParameters.ContainsKey('Password'))
{
$entity.Password = $Password;
}
if($NewName) { $entity.Name = $NewName; }
$svc.Core.UpdateObject($entity);
$r = $svc.Core.SaveChanges();
$r = $entity;
$OutputParameter = Format-ResultAs $r $As;
$fReturn = $true;
}
catch
{
if($gotoSuccess -eq $_.Exception.Message)
{
$fReturn = $true;
}
else
{
[string] $ErrorText = "catch [$($_.FullyQualifiedErrorId)]";
$ErrorText += (($_ | fl * -Force) | Out-String);
$ErrorText += (($_.Exception | fl * -Force) | Out-String);
$ErrorText += (Get-PSCallStack | Out-String);
if($_.Exception -is [System.Net.WebException])
{
Log-Critical $fn ("[WebException] Request FAILED with Status '{0}'. [{1}]." -f $_.Exception.Status, $_);
Log-Debug $fn $ErrorText -fac 3;
}
else
{
Log-Error $fn $ErrorText -fac 3;
if($gotoError -eq $_.Exception.Message)
{
Log-Error $fn $e.Exception.Message;
$PSCmdlet.ThrowTerminatingError($e);
}
elseif($gotoFailure -ne $_.Exception.Message)
{
Write-Verbose ("$fn`n$ErrorText");
}
else
{
# N/A
}
}
$fReturn = $false;
$OutputParameter = $null;
if($AddedEntity)
{
$svc.Core.DeleteObject($AddedEntity);
}
}
}
finally
{
# Clean up
# N/A
}
}
# Process
End
{
$datEnd = [datetime]::Now;
Log-Debug -fn $fn -msg ("RET. fReturn: [{0}]. Execution time: [{1}]ms. Started: [{2}]." -f $fReturn, ($datEnd - $datBegin).TotalMilliseconds, $datBegin.ToString('yyyy-MM-dd HH:mm:ss.fffzzz')) -fac 2;
# Return values are always and only returned via OutputParameter.
return $OutputParameter;
}
# End
}
if($MyInvocation.ScriptName) { Export-ModuleMember -Function Set-ManagementCredential; }
#
# Copyright 2014-2015 d-fens GmbH
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SIG # Begin signature block
# MIIXDwYJKoZIhvcNAQcCoIIXADCCFvwCAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB
# gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR
# AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQUuokYQTeqXJnDkxPFkLalcY3k
# HWCgghHCMIIEFDCCAvygAwIBAgILBAAAAAABL07hUtcwDQYJKoZIhvcNAQEFBQAw
# VzELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNV
# BAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkdsb2JhbFNpZ24gUm9vdCBDQTAeFw0xMTA0
# MTMxMDAwMDBaFw0yODAxMjgxMjAwMDBaMFIxCzAJBgNVBAYTAkJFMRkwFwYDVQQK
# ExBHbG9iYWxTaWduIG52LXNhMSgwJgYDVQQDEx9HbG9iYWxTaWduIFRpbWVzdGFt
# cGluZyBDQSAtIEcyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAlO9l
# +LVXn6BTDTQG6wkft0cYasvwW+T/J6U00feJGr+esc0SQW5m1IGghYtkWkYvmaCN
# d7HivFzdItdqZ9C76Mp03otPDbBS5ZBb60cO8eefnAuQZT4XljBFcm05oRc2yrmg
# jBtPCBn2gTGtYRakYua0QJ7D/PuV9vu1LpWBmODvxevYAll4d/eq41JrUJEpxfz3
# zZNl0mBhIvIG+zLdFlH6Dv2KMPAXCae78wSuq5DnbN96qfTvxGInX2+ZbTh0qhGL
# 2t/HFEzphbLswn1KJo/nVrqm4M+SU4B09APsaLJgvIQgAIMboe60dAXBKY5i0Eex
# +vBTzBj5Ljv5cH60JQIDAQABo4HlMIHiMA4GA1UdDwEB/wQEAwIBBjASBgNVHRMB
# Af8ECDAGAQH/AgEAMB0GA1UdDgQWBBRG2D7/3OO+/4Pm9IWbsN1q1hSpwTBHBgNV
# HSAEQDA+MDwGBFUdIAAwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93d3cuZ2xvYmFs
# c2lnbi5jb20vcmVwb3NpdG9yeS8wMwYDVR0fBCwwKjAooCagJIYiaHR0cDovL2Ny
# bC5nbG9iYWxzaWduLm5ldC9yb290LmNybDAfBgNVHSMEGDAWgBRge2YaRQ2XyolQ
# L30EzTSo//z9SzANBgkqhkiG9w0BAQUFAAOCAQEATl5WkB5GtNlJMfO7FzkoG8IW
# 3f1B3AkFBJtvsqKa1pkuQJkAVbXqP6UgdtOGNNQXzFU6x4Lu76i6vNgGnxVQ380W
# e1I6AtcZGv2v8Hhc4EvFGN86JB7arLipWAQCBzDbsBJe/jG+8ARI9PBw+DpeVoPP
# PfsNvPTF7ZedudTbpSeE4zibi6c1hkQgpDttpGoLoYP9KOva7yj2zIhd+wo7AKvg
# IeviLzVsD440RZfroveZMzV+y5qKu0VN5z+fwtmK+mWybsd+Zf/okuEsMaL3sCc2
# SI8mbzvuTXYfecPlf5Y1vC0OzAGwjn//UYCAp5LUs0RGZIyHTxZjBzFLY7Df8zCC
# BCkwggMRoAMCAQICCwQAAAAAATGJxjfoMA0GCSqGSIb3DQEBCwUAMEwxIDAeBgNV
# BAsTF0dsb2JhbFNpZ24gUm9vdCBDQSAtIFIzMRMwEQYDVQQKEwpHbG9iYWxTaWdu
# MRMwEQYDVQQDEwpHbG9iYWxTaWduMB4XDTExMDgwMjEwMDAwMFoXDTE5MDgwMjEw
# MDAwMFowWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKPv0Z8p6djTgnY8YqDS
# SdYWHvHP8NC6SEMDLacd8gE0SaQQ6WIT9BP0FoO11VdCSIYrlViH6igEdMtyEQ9h
# JuH6HGEVxyibTQuCDyYrkDqW7aTQaymc9WGI5qRXb+70cNCNF97mZnZfdB5eDFM4
# XZD03zAtGxPReZhUGks4BPQHxCMD05LL94BdqpxWBkQtQUxItC3sNZKaxpXX9c6Q
# MeJ2s2G48XVXQqw7zivIkEnotybPuwyJy9DDo2qhydXjnFMrVyb+Vpp2/WFGomDs
# KUZH8s3ggmLGBFrn7U5AXEgGfZ1f53TJnoRlDVve3NMkHLQUEeurv8QfpLqZ0BdY
# Nc0CAwEAAaOB/TCB+jAOBgNVHQ8BAf8EBAMCAQYwEgYDVR0TAQH/BAgwBgEB/wIB
# ADAdBgNVHQ4EFgQUGUq4WuRNMaUU5V7sL6Mc+oCMMmswRwYDVR0gBEAwPjA8BgRV
# HSAAMDQwMgYIKwYBBQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3Jl
# cG9zaXRvcnkvMDYGA1UdHwQvMC0wK6ApoCeGJWh0dHA6Ly9jcmwuZ2xvYmFsc2ln
# bi5uZXQvcm9vdC1yMy5jcmwwEwYDVR0lBAwwCgYIKwYBBQUHAwMwHwYDVR0jBBgw
# FoAUj/BLf6guRSSuTVD6Y5qL3uLdG7wwDQYJKoZIhvcNAQELBQADggEBAHmwaTTi
# BYf2/tRgLC+GeTQD4LEHkwyEXPnk3GzPbrXsCly6C9BoMS4/ZL0Pgmtmd4F/ximl
# F9jwiU2DJBH2bv6d4UgKKKDieySApOzCmgDXsG1szYjVFXjPE/mIpXNNwTYr3MvO
# 23580ovvL72zT006rbtibiiTxAzL2ebK4BEClAOwvT+UKFaQHlPCJ9XJPM0aYx6C
# WRW2QMqngarDVa8z0bV16AnqRwhIIvtdG/Mseml+xddaXlYzPK1X6JMlQsPSXnE7
# ShxU7alVrCgFx8RsXdw8k/ZpPIJRzhoVPV4Bc/9Aouq0rtOO+u5dbEfHQfXUVlfy
# GDcy1tTMS/Zx4HYwggSfMIIDh6ADAgECAhIRIdaZp2SXPvH4Qn7pGcxTQRQwDQYJ
# KoZIhvcNAQEFBQAwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24g
# bnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzIw
# HhcNMTYwNTI0MDAwMDAwWhcNMjcwNjI0MDAwMDAwWjBgMQswCQYDVQQGEwJTRzEf
# MB0GA1UEChMWR01PIEdsb2JhbFNpZ24gUHRlIEx0ZDEwMC4GA1UEAxMnR2xvYmFs
# U2lnbiBUU0EgZm9yIE1TIEF1dGhlbnRpY29kZSAtIEcyMIIBIjANBgkqhkiG9w0B
# AQEFAAOCAQ8AMIIBCgKCAQEAsBeuotO2BDBWHlgPse1VpNZUy9j2czrsXV6rJf02
# pfqEw2FAxUa1WVI7QqIuXxNiEKlb5nPWkiWxfSPjBrOHOg5D8NcAiVOiETFSKG5d
# QHI88gl3p0mSl9RskKB2p/243LOd8gdgLE9YmABr0xVU4Prd/4AsXximmP/Uq+yh
# RVmyLm9iXeDZGayLV5yoJivZF6UQ0kcIGnAsM4t/aIAqtaFda92NAgIpA6p8N7u7
# KU49U5OzpvqP0liTFUy5LauAo6Ml+6/3CGSwekQPXBDXX2E3qk5r09JTJZ2Cc/os
# +XKwqRk5KlD6qdA8OsroW+/1X1H0+QrZlzXeaoXmIwRCrwIDAQABo4IBXzCCAVsw
# DgYDVR0PAQH/BAQDAgeAMEwGA1UdIARFMEMwQQYJKwYBBAGgMgEeMDQwMgYIKwYB
# BQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3JlcG9zaXRvcnkvMAkG
# A1UdEwQCMAAwFgYDVR0lAQH/BAwwCgYIKwYBBQUHAwgwQgYDVR0fBDswOTA3oDWg
# M4YxaHR0cDovL2NybC5nbG9iYWxzaWduLmNvbS9ncy9nc3RpbWVzdGFtcGluZ2cy
# LmNybDBUBggrBgEFBQcBAQRIMEYwRAYIKwYBBQUHMAKGOGh0dHA6Ly9zZWN1cmUu
# Z2xvYmFsc2lnbi5jb20vY2FjZXJ0L2dzdGltZXN0YW1waW5nZzIuY3J0MB0GA1Ud
# DgQWBBTUooRKOFoYf7pPMFC9ndV6h9YJ9zAfBgNVHSMEGDAWgBRG2D7/3OO+/4Pm
# 9IWbsN1q1hSpwTANBgkqhkiG9w0BAQUFAAOCAQEAj6kakW0EpjcgDoOW3iPTa24f
# bt1kPWghIrX4RzZpjuGlRcckoiK3KQnMVFquxrzNY46zPVBI5bTMrs2SjZ4oixNK
# Eaq9o+/Tsjb8tKFyv22XY3mMRLxwL37zvN2CU6sa9uv6HJe8tjecpBwwvKu8LUc2
# 35IgA+hxxlj2dQWaNPALWVqCRDSqgOQvhPZHXZbJtsrKnbemuuRQ09Q3uLogDtDT
# kipbxFm7oW3bPM5EncE4Kq3jjb3NCXcaEL5nCgI2ZIi5sxsm7ueeYMRGqLxhM2zP
# TrmcuWrwnzf+tT1PmtNN/94gjk6Xpv2fCbxNyhh2ybBNhVDygNIdBvVYBAexGDCC
# BNYwggO+oAMCAQICEhEhDRayW4wRltP+V8mGEea62TANBgkqhkiG9w0BAQsFADBa
# MQswCQYDVQQGEwJCRTEZMBcGA1UEChMQR2xvYmFsU2lnbiBudi1zYTEwMC4GA1UE
# AxMnR2xvYmFsU2lnbiBDb2RlU2lnbmluZyBDQSAtIFNIQTI1NiAtIEcyMB4XDTE1
# MDUwNDE2NDMyMVoXDTE4MDUwNDE2NDMyMVowVTELMAkGA1UEBhMCQ0gxDDAKBgNV
# BAgTA1p1ZzEMMAoGA1UEBxMDWnVnMRQwEgYDVQQKEwtkLWZlbnMgR21iSDEUMBIG
# A1UEAxMLZC1mZW5zIEdtYkgwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB
# AQDNPSzSNPylU9jFM78Q/GjzB7N+VNqikf/use7p8mpnBZ4cf5b4qV3rqQd62rJH
# RlAsxgouCSNQrl8xxfg6/t/I02kPvrzsR4xnDgMiVCqVRAeQsWebafWdTvWmONBS
# lxJejPP8TSgXMKFaDa+2HleTycTBYSoErAZSWpQ0NqF9zBadjsJRVatQuPkTDrwL
# eWibiyOipK9fcNoQpl5ll5H9EG668YJR3fqX9o0TQTkOmxXIL3IJ0UxdpyDpLEkt
# tBG6Y5wAdpF2dQX2phrfFNVY54JOGtuBkNGMSiLFzTkBA1fOlA6ICMYjB8xIFxVv
# rN1tYojCrqYkKMOjwWQz5X8zAgMBAAGjggGZMIIBlTAOBgNVHQ8BAf8EBAMCB4Aw
# TAYDVR0gBEUwQzBBBgkrBgEEAaAyATIwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93
# d3cuZ2xvYmFsc2lnbi5jb20vcmVwb3NpdG9yeS8wCQYDVR0TBAIwADATBgNVHSUE
# DDAKBggrBgEFBQcDAzBCBgNVHR8EOzA5MDegNaAzhjFodHRwOi8vY3JsLmdsb2Jh
# bHNpZ24uY29tL2dzL2dzY29kZXNpZ25zaGEyZzIuY3JsMIGQBggrBgEFBQcBAQSB
# gzCBgDBEBggrBgEFBQcwAoY4aHR0cDovL3NlY3VyZS5nbG9iYWxzaWduLmNvbS9j
# YWNlcnQvZ3Njb2Rlc2lnbnNoYTJnMi5jcnQwOAYIKwYBBQUHMAGGLGh0dHA6Ly9v
# Y3NwMi5nbG9iYWxzaWduLmNvbS9nc2NvZGVzaWduc2hhMmcyMB0GA1UdDgQWBBTN
# GDddiIYZy9p3Z84iSIMd27rtUDAfBgNVHSMEGDAWgBQZSrha5E0xpRTlXuwvoxz6
# gIwyazANBgkqhkiG9w0BAQsFAAOCAQEAAApsOzSX1alF00fTeijB/aIthO3UB0ks
# 1Gg3xoKQC1iEQmFG/qlFLiufs52kRPN7L0a7ClNH3iQpaH5IEaUENT9cNEXdKTBG
# 8OrJS8lrDJXImgNEgtSwz0B40h7bM2Z+0DvXDvpmfyM2NwHF/nNVj7NzmczrLRqN
# 9de3tV0pgRqnIYordVcmb24CZl3bzpwzbQQy14Iz+P5Z2cnw+QaYzAuweTZxEUcJ
# bFwpM49c1LMPFJTuOKkUgY90JJ3gVTpyQxfkc7DNBnx74PlRzjFmeGC/hxQt0hvo
# eaAiBdjo/1uuCTToigVnyRH+c0T2AezTeoFb7ne3I538hWeTdU5q9jGCBLcwggSz
# AgEBMHAwWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MgISESENFrJbjBGW0/5XyYYR5rrZMAkGBSsOAwIaBQCgeDAYBgorBgEEAYI3AgEM
# MQowCKACgAChAoAAMBkGCSqGSIb3DQEJAzEMBgorBgEEAYI3AgEEMBwGCisGAQQB
# gjcCAQsxDjAMBgorBgEEAYI3AgEVMCMGCSqGSIb3DQEJBDEWBBT8jd200PSShSVE
# nBIvW4FUYkRDtzANBgkqhkiG9w0BAQEFAASCAQCdvhIuiJiW8yvJ/fws1hH6RXSA
# OS6eofZ/vBETvSqJR8L+8zqgrwvMkXKvt4svRWHwjfigpUWWjhjTtOldOxobH53K
# NCQQpkF9SDZ6jlTT9nJSEb9roFsTPNuRf2HY2k97f3ntL1TJxff+dtccokxbN32C
# TWycktS3xlOxk3NGjH0HxeQnu+kEpBkBsoDueN4OTgL5fvfnqsNV1Mq2l7LDP3lW
# ukbFnk5n/sK1SXCQ99i9hyrqz/nGEYg9BHNYYy1mE1bXdjE255wGGvNWvj6QIM2A
# jb2xFx78z4+oJNt00+LPFYCebZEH33fyJsjxhFwNZrcjP90GjA2BuaaDDrSCoYIC
# ojCCAp4GCSqGSIb3DQEJBjGCAo8wggKLAgEBMGgwUjELMAkGA1UEBhMCQkUxGTAX
# BgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGlt
# ZXN0YW1waW5nIENBIC0gRzICEhEh1pmnZJc+8fhCfukZzFNBFDAJBgUrDgMCGgUA
# oIH9MBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTE2
# MDgzMTE5MTcwNlowIwYJKoZIhvcNAQkEMRYEFOQR7ZphLrTUDthAmcmGFL0XrNtn
# MIGdBgsqhkiG9w0BCRACDDGBjTCBijCBhzCBhAQUY7gvq2H1g5CWlQULACScUCkz
# 7HkwbDBWpFQwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYt
# c2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzICEhEh
# 1pmnZJc+8fhCfukZzFNBFDANBgkqhkiG9w0BAQEFAASCAQBbsHixHtXzGUHXfggl
# Y7pg1eOrQnyKzMcXZ7XMDBOLSk1seuJmPSpLGJ8e1k+on1v+I/NhulzN2/zVe/05
# k284LbVec6SvFngYdeUnlPuMzh5ClPOsC1tK0kZsMCQCrhjqMfiCRTSWTmUuHsK6
# n9INLQE4LZdtydfOY3mm7VBNlikeAw+0WIJiMmCfaaYa+8VIgD0MfQDA9nFHyo4E
# O4XvZXvlr+KgvoMGxO31hu32fNdVIb2o7zt10+S4Wt7fnvX1bmiea4iRKOrKAPgp
# 2oLMvEMCHvju3CJnmY9ATQtzHKpdMuIBGB5rmUwBdbtcxqPz0QL9TbB2e7Er8/Jx
# pAjV
# SIG # End signature block
|
PowerShellCorpus/PowerShellGallery/biz.dfch.PS.Appclusive.Client/5.2.1.20161201/New-Role.ps1
|
New-Role.ps1
|
function New-Role {
<#
.SYNOPSIS
Creates a Role entry in Appclusive.
.DESCRIPTION
Creates a Role entry in Appclusive.
You must specify the parameters Name, RoleType and Permissions. If the entry already exists no update of the existing entry is performed.
.OUTPUTS
default | json | json-pretty | xml | xml-pretty
.EXAMPLE
New-Role -Name ArbitraryRole -RoleType External
RoleType : External
MailAddress :
Id : 42
Tid : 11111111-1111-1111-1111-111111111111
Name : ArbitraryRole
Description :
CreatedById : 1
ModifiedById : 1
Created : 23.08.2016 11:08:14 +02:00
Modified : 23.08.2016 11:08:14 +02:00
RowVersion :
Permissions : {}
Users : {}
Tenant :
CreatedBy :
ModifiedBy :
Create a new Role entry if it not already exists.
.EXAMPLE
New-Role -Name ArbitraryRole -RoleType External -Description ArbitraryDescription -MailAddress arbitrary@example.com
RoleType : External
MailAddress : arbitrary@example.com
Id : 42
Tid : 11111111-1111-1111-1111-111111111111
Name : ArbitraryRole
Description : ArbitraryDescription
CreatedById : 1
ModifiedById : 1
Created : 23.08.2016 11:08:14 +02:00
Modified : 23.08.2016 11:08:14 +02:00
RowVersion :
Permissions : {}
Users : {}
Tenant :
CreatedBy :
ModifiedBy :
Create a new Role entry if it not already exists, with Description and MailAddress.
.EXAMPLE
New-Role -Name ArbitraryRole -RoleType External -PermissionsToAdd @("Apc:NodesCanRead","Apc:NodesCanCreate")
RoleType : External
MailAddress :
Id : 42
Tid : 11111111-1111-1111-1111-111111111111
Name : ArbitraryRole
Description :
CreatedById : 1
ModifiedById : 1
Created : 23.08.2016 11:08:14 +02:00
Modified : 23.08.2016 11:08:14 +02:00
RowVersion :
Permissions : {}
Users : {}
Tenant :
CreatedBy :
ModifiedBy :
Create a new Role entry with specified Permissions, if it not already exists.
.LINK
Online Version: http://dfch.biz/biz/dfch/PS/Appclusive/Client/New-Role/
Set-Role: http://dfch.biz/biz/dfch/PS/Appclusive/Client/Set-Role/
.NOTES
See module manifest for dependencies and further requirements.
#>
[CmdletBinding(
SupportsShouldProcess = $true
,
ConfirmImpact = 'Low'
,
HelpURI='http://dfch.biz/biz/dfch/PS/Appclusive/Client/Role/'
)]
Param
(
[Parameter(Mandatory = $true, Position = 0)]
[ValidateNotNullOrEmpty()]
[Alias('n')]
[string] $Name
,
[Parameter(Mandatory = $true, Position = 1)]
[ValidateSet('Default', 'Security', 'Distribution', 'BuiltIn', 'External')]
[string] $RoleType
,
# Specifies the name to modify
[Parameter(Mandatory = $false)]
[ValidateNotNullOrEmpty()]
[string] $MailAddress
,
# Specifies the description
[Parameter(Mandatory = $false)]
[ValidateNotNullOrEmpty()]
[string] $Description
,
# Specifies the permissions to be linked
[Parameter(Mandatory = $false)]
[string[]] $Permissions = @()
,
# Service reference to Appclusive
[Parameter(Mandatory = $false)]
[Alias('Services')]
[hashtable] $svc = (Get-Variable -Name $MyInvocation.MyCommand.Module.PrivateData.MODULEVAR -ValueOnly).Services
,
# Specifies the return format of the Cmdlet
[ValidateSet('default', 'json', 'json-pretty', 'xml', 'xml-pretty')]
[Parameter(Mandatory = $false)]
[alias('ReturnFormat')]
[string] $As = 'default'
)
Begin
{
trap { Log-Exception $_; break; }
$datBegin = [datetime]::Now;
[string] $fn = $MyInvocation.MyCommand.Name;
Log-Debug -fn $fn -msg ("CALL. svc '{0}'. Name '{1}'." -f ($svc -is [Object]), $Name) -fac 1;
# Parameter validation
Contract-Requires ($svc.Core -is [biz.dfch.CS.Appclusive.Api.Core.Core]) "Connect to the server before using the Cmdlet";
}
Process
{
trap { Log-Exception $_; break; }
# Default test variable for checking function response codes.
[Boolean] $fReturn = $false;
# Return values are always and only returned via OutputParameter.
$OutputParameter = $null;
$currentTenant = Get-Tenant -svc $svc -Current;
$exp = @();
$roleContents = @();
$exp += ("(tolower(Name) eq '{0}')" -f $Name.ToLower());
$exp += ("(RoleType eq '{0}')" -f $RoleType);
$exp += ("(Tid eq guid'{0}')" -f $currentTenant.Id);
$filterExpression = [String]::Join(' and ', $exp);
$roleContents += $Name;
$roleContents += $RoleType;
$roleContents += $currentTenant.Id;
$role = $svc.Core.Roles.AddQueryOption('$filter', $filterExpression).AddQueryOption('$top', 1) | Select;
Contract-Assert (!$role) 'Entity does already exist';
if($PSCmdlet.ShouldProcess($roleContents))
{
if ($PSBoundParameters.ContainsKey("Description") -And $PSBoundParameters.ContainsKey('MailAddress') -And $PSBoundParameters.ContainsKey("Permissions"))
{
$r = Set-Role -Name $Name -RoleType $RoleType -Description $Description -MailAddress $MailAddress -PermissionsToAdd $Permissions -svc $svc -CreateIfNotExist;
}
elseif ($PSBoundParameters.ContainsKey("Description") -And $PSBoundParameters.ContainsKey('MailAddress'))
{
$r = Set-Role -Name $Name -RoleType $RoleType -Description $Description -MailAddress $MailAddress -svc $svc -CreateIfNotExist;
}
elseif ($PSBoundParameters.ContainsKey("Description") -And $PSBoundParameters.ContainsKey("Permissions"))
{
$r = Set-Role -Name $Name -RoleType $RoleType -Description $Description -PermissionsToAdd $Permissions -svc $svc -CreateIfNotExist;
}
elseif ($PSBoundParameters.ContainsKey('MailAddress') -And $PSBoundParameters.ContainsKey("Permissions"))
{
$r = Set-Role -Name $Name -RoleType $RoleType -MailAddress $MailAddress -PermissionsToAdd $Permissions -svc $svc -CreateIfNotExist;
}
elseif($PSBoundParameters.ContainsKey("Description"))
{
$r = Set-Role -Name $Name -RoleType $RoleType -Description $Description -svc $svc -CreateIfNotExist;
}
elseif($PSBoundParameters.ContainsKey("MailAddress"))
{
$r = Set-Role -Name $Name -RoleType $RoleType -MailAddress $MailAddress -svc $svc -CreateIfNotExist;
}
elseif($PSBoundParameters.ContainsKey("Permissions"))
{
$r = Set-Role -Name $Name -RoleType $RoleType -PermissionsToAdd $Permissions -svc $svc -CreateIfNotExist;
}
else
{
$r = Set-Role -Name $Name -RoleType $RoleType -svc $svc -CreateIfNotExist;
}
$OutputParameter = $r;
}
$fReturn = $true;
}
End
{
$datEnd = [datetime]::Now;
Log-Debug -fn $fn -msg ("RET. fReturn: [{0}]. Execution time: [{1}]ms. Started: [{2}]." -f $fReturn, ($datEnd - $datBegin).TotalMilliseconds, $datBegin.ToString('yyyy-MM-dd HH:mm:ss.fffzzz')) -fac 2;
# Return values are always and only returned via OutputParameter.
return $OutputParameter;
}
}
if($MyInvocation.ScriptName) { Export-ModuleMember -Function New-Role; }
#
# Copyright 2016 d-fens GmbH
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
|
PowerShellCorpus/PowerShellGallery/biz.dfch.PS.Appclusive.Client/5.2.1.20161201/Import-Module.ps1
|
Import-Module.ps1
|
# Import-Module.ps1
#
# Place any pre-initialisation script here
# Note:
# * When executed the module is not yet loaded
# * Everything you define here (e.g. a variable) is defined OUTSIDE the module scope.
# If this script is loaded via "ScriptsToProcess" it will incorrectly
# show up as loaded module, see the bug on Microsoft Connect below:
# https://connect.microsoft.com/PowerShell/feedback/details/903654/scripts-loaded-via-a-scriptstoprocess-attribute-in-a-module-manifest-appear-as-if-they-are-loaded-modules
# we add EntityBagConverter as a type accelerator to facilitate its using and invocation
[PSObject].Assembly.GetType('System.Management.Automation.TypeAccelerators')::Add('EntityBagConverter', [biz.dfch.CS.Appclusive.Public.Converters.EntityBagConverter]);
#
# Copyright 2014-2015 d-fens GmbH
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SIG # Begin signature block
# MIIXDwYJKoZIhvcNAQcCoIIXADCCFvwCAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB
# gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR
# AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQUXexsDa7/kAO2s8APQ+E12nCj
# N8ygghHCMIIEFDCCAvygAwIBAgILBAAAAAABL07hUtcwDQYJKoZIhvcNAQEFBQAw
# VzELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNV
# BAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkdsb2JhbFNpZ24gUm9vdCBDQTAeFw0xMTA0
# MTMxMDAwMDBaFw0yODAxMjgxMjAwMDBaMFIxCzAJBgNVBAYTAkJFMRkwFwYDVQQK
# ExBHbG9iYWxTaWduIG52LXNhMSgwJgYDVQQDEx9HbG9iYWxTaWduIFRpbWVzdGFt
# cGluZyBDQSAtIEcyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAlO9l
# +LVXn6BTDTQG6wkft0cYasvwW+T/J6U00feJGr+esc0SQW5m1IGghYtkWkYvmaCN
# d7HivFzdItdqZ9C76Mp03otPDbBS5ZBb60cO8eefnAuQZT4XljBFcm05oRc2yrmg
# jBtPCBn2gTGtYRakYua0QJ7D/PuV9vu1LpWBmODvxevYAll4d/eq41JrUJEpxfz3
# zZNl0mBhIvIG+zLdFlH6Dv2KMPAXCae78wSuq5DnbN96qfTvxGInX2+ZbTh0qhGL
# 2t/HFEzphbLswn1KJo/nVrqm4M+SU4B09APsaLJgvIQgAIMboe60dAXBKY5i0Eex
# +vBTzBj5Ljv5cH60JQIDAQABo4HlMIHiMA4GA1UdDwEB/wQEAwIBBjASBgNVHRMB
# Af8ECDAGAQH/AgEAMB0GA1UdDgQWBBRG2D7/3OO+/4Pm9IWbsN1q1hSpwTBHBgNV
# HSAEQDA+MDwGBFUdIAAwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93d3cuZ2xvYmFs
# c2lnbi5jb20vcmVwb3NpdG9yeS8wMwYDVR0fBCwwKjAooCagJIYiaHR0cDovL2Ny
# bC5nbG9iYWxzaWduLm5ldC9yb290LmNybDAfBgNVHSMEGDAWgBRge2YaRQ2XyolQ
# L30EzTSo//z9SzANBgkqhkiG9w0BAQUFAAOCAQEATl5WkB5GtNlJMfO7FzkoG8IW
# 3f1B3AkFBJtvsqKa1pkuQJkAVbXqP6UgdtOGNNQXzFU6x4Lu76i6vNgGnxVQ380W
# e1I6AtcZGv2v8Hhc4EvFGN86JB7arLipWAQCBzDbsBJe/jG+8ARI9PBw+DpeVoPP
# PfsNvPTF7ZedudTbpSeE4zibi6c1hkQgpDttpGoLoYP9KOva7yj2zIhd+wo7AKvg
# IeviLzVsD440RZfroveZMzV+y5qKu0VN5z+fwtmK+mWybsd+Zf/okuEsMaL3sCc2
# SI8mbzvuTXYfecPlf5Y1vC0OzAGwjn//UYCAp5LUs0RGZIyHTxZjBzFLY7Df8zCC
# BCkwggMRoAMCAQICCwQAAAAAATGJxjfoMA0GCSqGSIb3DQEBCwUAMEwxIDAeBgNV
# BAsTF0dsb2JhbFNpZ24gUm9vdCBDQSAtIFIzMRMwEQYDVQQKEwpHbG9iYWxTaWdu
# MRMwEQYDVQQDEwpHbG9iYWxTaWduMB4XDTExMDgwMjEwMDAwMFoXDTE5MDgwMjEw
# MDAwMFowWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKPv0Z8p6djTgnY8YqDS
# SdYWHvHP8NC6SEMDLacd8gE0SaQQ6WIT9BP0FoO11VdCSIYrlViH6igEdMtyEQ9h
# JuH6HGEVxyibTQuCDyYrkDqW7aTQaymc9WGI5qRXb+70cNCNF97mZnZfdB5eDFM4
# XZD03zAtGxPReZhUGks4BPQHxCMD05LL94BdqpxWBkQtQUxItC3sNZKaxpXX9c6Q
# MeJ2s2G48XVXQqw7zivIkEnotybPuwyJy9DDo2qhydXjnFMrVyb+Vpp2/WFGomDs
# KUZH8s3ggmLGBFrn7U5AXEgGfZ1f53TJnoRlDVve3NMkHLQUEeurv8QfpLqZ0BdY
# Nc0CAwEAAaOB/TCB+jAOBgNVHQ8BAf8EBAMCAQYwEgYDVR0TAQH/BAgwBgEB/wIB
# ADAdBgNVHQ4EFgQUGUq4WuRNMaUU5V7sL6Mc+oCMMmswRwYDVR0gBEAwPjA8BgRV
# HSAAMDQwMgYIKwYBBQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3Jl
# cG9zaXRvcnkvMDYGA1UdHwQvMC0wK6ApoCeGJWh0dHA6Ly9jcmwuZ2xvYmFsc2ln
# bi5uZXQvcm9vdC1yMy5jcmwwEwYDVR0lBAwwCgYIKwYBBQUHAwMwHwYDVR0jBBgw
# FoAUj/BLf6guRSSuTVD6Y5qL3uLdG7wwDQYJKoZIhvcNAQELBQADggEBAHmwaTTi
# BYf2/tRgLC+GeTQD4LEHkwyEXPnk3GzPbrXsCly6C9BoMS4/ZL0Pgmtmd4F/ximl
# F9jwiU2DJBH2bv6d4UgKKKDieySApOzCmgDXsG1szYjVFXjPE/mIpXNNwTYr3MvO
# 23580ovvL72zT006rbtibiiTxAzL2ebK4BEClAOwvT+UKFaQHlPCJ9XJPM0aYx6C
# WRW2QMqngarDVa8z0bV16AnqRwhIIvtdG/Mseml+xddaXlYzPK1X6JMlQsPSXnE7
# ShxU7alVrCgFx8RsXdw8k/ZpPIJRzhoVPV4Bc/9Aouq0rtOO+u5dbEfHQfXUVlfy
# GDcy1tTMS/Zx4HYwggSfMIIDh6ADAgECAhIRIdaZp2SXPvH4Qn7pGcxTQRQwDQYJ
# KoZIhvcNAQEFBQAwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24g
# bnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzIw
# HhcNMTYwNTI0MDAwMDAwWhcNMjcwNjI0MDAwMDAwWjBgMQswCQYDVQQGEwJTRzEf
# MB0GA1UEChMWR01PIEdsb2JhbFNpZ24gUHRlIEx0ZDEwMC4GA1UEAxMnR2xvYmFs
# U2lnbiBUU0EgZm9yIE1TIEF1dGhlbnRpY29kZSAtIEcyMIIBIjANBgkqhkiG9w0B
# AQEFAAOCAQ8AMIIBCgKCAQEAsBeuotO2BDBWHlgPse1VpNZUy9j2czrsXV6rJf02
# pfqEw2FAxUa1WVI7QqIuXxNiEKlb5nPWkiWxfSPjBrOHOg5D8NcAiVOiETFSKG5d
# QHI88gl3p0mSl9RskKB2p/243LOd8gdgLE9YmABr0xVU4Prd/4AsXximmP/Uq+yh
# RVmyLm9iXeDZGayLV5yoJivZF6UQ0kcIGnAsM4t/aIAqtaFda92NAgIpA6p8N7u7
# KU49U5OzpvqP0liTFUy5LauAo6Ml+6/3CGSwekQPXBDXX2E3qk5r09JTJZ2Cc/os
# +XKwqRk5KlD6qdA8OsroW+/1X1H0+QrZlzXeaoXmIwRCrwIDAQABo4IBXzCCAVsw
# DgYDVR0PAQH/BAQDAgeAMEwGA1UdIARFMEMwQQYJKwYBBAGgMgEeMDQwMgYIKwYB
# BQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3JlcG9zaXRvcnkvMAkG
# A1UdEwQCMAAwFgYDVR0lAQH/BAwwCgYIKwYBBQUHAwgwQgYDVR0fBDswOTA3oDWg
# M4YxaHR0cDovL2NybC5nbG9iYWxzaWduLmNvbS9ncy9nc3RpbWVzdGFtcGluZ2cy
# LmNybDBUBggrBgEFBQcBAQRIMEYwRAYIKwYBBQUHMAKGOGh0dHA6Ly9zZWN1cmUu
# Z2xvYmFsc2lnbi5jb20vY2FjZXJ0L2dzdGltZXN0YW1waW5nZzIuY3J0MB0GA1Ud
# DgQWBBTUooRKOFoYf7pPMFC9ndV6h9YJ9zAfBgNVHSMEGDAWgBRG2D7/3OO+/4Pm
# 9IWbsN1q1hSpwTANBgkqhkiG9w0BAQUFAAOCAQEAj6kakW0EpjcgDoOW3iPTa24f
# bt1kPWghIrX4RzZpjuGlRcckoiK3KQnMVFquxrzNY46zPVBI5bTMrs2SjZ4oixNK
# Eaq9o+/Tsjb8tKFyv22XY3mMRLxwL37zvN2CU6sa9uv6HJe8tjecpBwwvKu8LUc2
# 35IgA+hxxlj2dQWaNPALWVqCRDSqgOQvhPZHXZbJtsrKnbemuuRQ09Q3uLogDtDT
# kipbxFm7oW3bPM5EncE4Kq3jjb3NCXcaEL5nCgI2ZIi5sxsm7ueeYMRGqLxhM2zP
# TrmcuWrwnzf+tT1PmtNN/94gjk6Xpv2fCbxNyhh2ybBNhVDygNIdBvVYBAexGDCC
# BNYwggO+oAMCAQICEhEhDRayW4wRltP+V8mGEea62TANBgkqhkiG9w0BAQsFADBa
# MQswCQYDVQQGEwJCRTEZMBcGA1UEChMQR2xvYmFsU2lnbiBudi1zYTEwMC4GA1UE
# AxMnR2xvYmFsU2lnbiBDb2RlU2lnbmluZyBDQSAtIFNIQTI1NiAtIEcyMB4XDTE1
# MDUwNDE2NDMyMVoXDTE4MDUwNDE2NDMyMVowVTELMAkGA1UEBhMCQ0gxDDAKBgNV
# BAgTA1p1ZzEMMAoGA1UEBxMDWnVnMRQwEgYDVQQKEwtkLWZlbnMgR21iSDEUMBIG
# A1UEAxMLZC1mZW5zIEdtYkgwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB
# AQDNPSzSNPylU9jFM78Q/GjzB7N+VNqikf/use7p8mpnBZ4cf5b4qV3rqQd62rJH
# RlAsxgouCSNQrl8xxfg6/t/I02kPvrzsR4xnDgMiVCqVRAeQsWebafWdTvWmONBS
# lxJejPP8TSgXMKFaDa+2HleTycTBYSoErAZSWpQ0NqF9zBadjsJRVatQuPkTDrwL
# eWibiyOipK9fcNoQpl5ll5H9EG668YJR3fqX9o0TQTkOmxXIL3IJ0UxdpyDpLEkt
# tBG6Y5wAdpF2dQX2phrfFNVY54JOGtuBkNGMSiLFzTkBA1fOlA6ICMYjB8xIFxVv
# rN1tYojCrqYkKMOjwWQz5X8zAgMBAAGjggGZMIIBlTAOBgNVHQ8BAf8EBAMCB4Aw
# TAYDVR0gBEUwQzBBBgkrBgEEAaAyATIwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93
# d3cuZ2xvYmFsc2lnbi5jb20vcmVwb3NpdG9yeS8wCQYDVR0TBAIwADATBgNVHSUE
# DDAKBggrBgEFBQcDAzBCBgNVHR8EOzA5MDegNaAzhjFodHRwOi8vY3JsLmdsb2Jh
# bHNpZ24uY29tL2dzL2dzY29kZXNpZ25zaGEyZzIuY3JsMIGQBggrBgEFBQcBAQSB
# gzCBgDBEBggrBgEFBQcwAoY4aHR0cDovL3NlY3VyZS5nbG9iYWxzaWduLmNvbS9j
# YWNlcnQvZ3Njb2Rlc2lnbnNoYTJnMi5jcnQwOAYIKwYBBQUHMAGGLGh0dHA6Ly9v
# Y3NwMi5nbG9iYWxzaWduLmNvbS9nc2NvZGVzaWduc2hhMmcyMB0GA1UdDgQWBBTN
# GDddiIYZy9p3Z84iSIMd27rtUDAfBgNVHSMEGDAWgBQZSrha5E0xpRTlXuwvoxz6
# gIwyazANBgkqhkiG9w0BAQsFAAOCAQEAAApsOzSX1alF00fTeijB/aIthO3UB0ks
# 1Gg3xoKQC1iEQmFG/qlFLiufs52kRPN7L0a7ClNH3iQpaH5IEaUENT9cNEXdKTBG
# 8OrJS8lrDJXImgNEgtSwz0B40h7bM2Z+0DvXDvpmfyM2NwHF/nNVj7NzmczrLRqN
# 9de3tV0pgRqnIYordVcmb24CZl3bzpwzbQQy14Iz+P5Z2cnw+QaYzAuweTZxEUcJ
# bFwpM49c1LMPFJTuOKkUgY90JJ3gVTpyQxfkc7DNBnx74PlRzjFmeGC/hxQt0hvo
# eaAiBdjo/1uuCTToigVnyRH+c0T2AezTeoFb7ne3I538hWeTdU5q9jGCBLcwggSz
# AgEBMHAwWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MgISESENFrJbjBGW0/5XyYYR5rrZMAkGBSsOAwIaBQCgeDAYBgorBgEEAYI3AgEM
# MQowCKACgAChAoAAMBkGCSqGSIb3DQEJAzEMBgorBgEEAYI3AgEEMBwGCisGAQQB
# gjcCAQsxDjAMBgorBgEEAYI3AgEVMCMGCSqGSIb3DQEJBDEWBBQKYhhvo61KQFxd
# PEbLCJCaU1zXGjANBgkqhkiG9w0BAQEFAASCAQAlJ4nH+J1j9dAGhNOiQc2gCNm3
# SKMJ2Bb+XUxkxbH0LLFZSFfNXPcltz6IGkJIIUu9MpGylu9KN2y61jDV+dIRsFat
# HPSCO4b6XE3A+mz7V/Vn1qzdrZ6zmt8aq2pXnzjVa+JSLy/GkndkwbMn/Y7RsMPD
# 8gt+62jhondKNFxwZ9qFRBFlmKTKhpPbDWwQ116GNu6s7S3MvY5LCWHLhKP2DrA1
# IGMj7t7mBodor/PnTgs5xxo2oNZAldtMejJg9CRAu/tRMknBsizQfrpql5Lcrnse
# WG6czz8XmKnaZuAhfStSV6MjEoO4GkkcDeDfsYRFld5JAORxHBBFDoPXSYM2oYIC
# ojCCAp4GCSqGSIb3DQEJBjGCAo8wggKLAgEBMGgwUjELMAkGA1UEBhMCQkUxGTAX
# BgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGlt
# ZXN0YW1waW5nIENBIC0gRzICEhEh1pmnZJc+8fhCfukZzFNBFDAJBgUrDgMCGgUA
# oIH9MBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTE2
# MTAzMTA0MzUyNVowIwYJKoZIhvcNAQkEMRYEFF60OUobm6ool8lVOVIt4HEghF+K
# MIGdBgsqhkiG9w0BCRACDDGBjTCBijCBhzCBhAQUY7gvq2H1g5CWlQULACScUCkz
# 7HkwbDBWpFQwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYt
# c2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzICEhEh
# 1pmnZJc+8fhCfukZzFNBFDANBgkqhkiG9w0BAQEFAASCAQCXn3oXcN2Icjqe3o78
# FXxh5UpzuL2+tKEl4Dw3gCUHm13XYE0klZYsAgK28JRdvBumwT8BUm0hqkpkvubo
# S9lPMubQoTV9DdSha215McrGKQSgYavjh/cZB7RuaGpYmUgDRPFgoiP7jK46j0tT
# yQfnwT4yiqMVMoeNHDkYZ6Hgo8ucKDMYZxp59ST5mSvobPiVs7fhvWqWJfqozQWk
# CQqVzRQzwhGFvyKY+NvH2RFvkoN2wkk/vIaakPqiHpRws/7e3yVLOzPQ60DK7IHV
# kNRJXhWCJo5KGLV6Kj59JrGUSS9sKBqAV0qNCHajzC8+ZF6WinqIUlIGJSUr16c1
# rSp/
# SIG # End signature block
|
PowerShellCorpus/PowerShellGallery/biz.dfch.PS.Appclusive.Client/5.2.1.20161201/Get-ExternalNode.ps1
|
Get-ExternalNode.ps1
|
function Get-ExternalNode {
<#
.SYNOPSIS
Retrieves one or more entities from the ExternalNode entity set.
.DESCRIPTION
Retrieves one or more entities from the ExternalNode entity set.
You can retrieve one ore more entities from the entity set by specifying
Id, Name or other properties.
.INPUTS
The Cmdlet can either return all available entities or filter entities on
specified conditions.
See PARAMETERS section on possible inputs.
.OUTPUTS
default | json | json-pretty | xml | xml-pretty
In addition output can be filtered on specified properties.
.EXAMPLE
Get-ExternalNode -ListAvailable -Select Id, Name
Id Name
-- ----
218 abhenry
271 abhenry
358 abhenry
572 abhenry
636 abhenry
666 abhenry
1017 abhenry
270 absence
406 absence
490 absence
568 absence
607 absence
613 absence
745 absence
875 absence
907 absence
967 absence
1024 absence
1081 absence
1179 absence
361 aggrade
373 aggrade
...
Retrieves the id and name of all ExternalNodes.
.EXAMPLE
Get-ExternalNode 218
Parameters : {"Hostname":"Server01"}
EntityKindId : 27
ParentId : 1
Id : 218
Tid : 22222222-2222-2222-2222-222222222222
Name : abhenry
Description : abhenry is a whiles for timeous purposes
CreatedById : 1
ModifiedById : 1
Created : 15.12.2015 12:06:49 +01:00
Modified : 15.12.2015 12:06:49 +01:00
RowVersion : {0, 0, 0, 0...}
Parent :
EntityKind :
Children : {}
IncomingAssocs : {}
OutgoingAssocs : {}
Tenant :
CreatedBy :
ModifiedBy :
Retrieves the ExternalNode object with Id 218 and returns all properties of it.
.EXAMPLE
Get-ExternalNode 218 -Select Parameters -ValueOnly -ConvertFromJson
Hostname
---
Server01
Similar to the previous example, but only returns the 'Parameters' property
of it. In addition the contents of the property will be converted from JSON.
.EXAMPLE
Get-ExternalNode 218 -Select Name -ValueOnly
abhenry
Retrieves the name of the ExternalNode with Id 218.
.EXAMPLE
Get-ExternalNode -ModifiedBy SYSTEM -Select Id, Name
Id Name
-- ----
1 Root ExternalNode
2 biz.dfch.CS.Appclusive.Core.OdataServices.Core.ExternalNode
3 biz.dfch.CS.Appclusive.Core.OdataServices.Core.ExternalNode
4 biz.dfch.CS.Appclusive.Core.OdataServices.Core.ExternalNode
5 biz.dfch.CS.Appclusive.Core.OdataServices.Core.ExternalNode
6 biz.dfch.CS.Appclusive.Core.OdataServices.Core.ExternalNode
7 biz.dfch.CS.Appclusive.Core.OdataServices.Core.ExternalNode
8 biz.dfch.CS.Appclusive.Core.OdataServices.Core.ExternalNode
9 biz.dfch.CS.Appclusive.Core.OdataServices.Core.ExternalNode
10 biz.dfch.CS.Appclusive.Core.OdataServices.Core.ExternalNode
11 biz.dfch.CS.Appclusive.Core.OdataServices.Core.ExternalNode
12 biz.dfch.CS.Appclusive.Core.OdataServices.Core.ExternalNode
13 biz.dfch.CS.Appclusive.Core.OdataServices.Core.ExternalNode
14 biz.dfch.CS.Appclusive.Core.OdataServices.Core.ExternalNode
15 biz.dfch.CS.Appclusive.Core.OdataServices.Core.ExternalNode
16 biz.dfch.CS.Appclusive.Core.OdataServices.Core.ExternalNode
17 biz.dfch.CS.Appclusive.Core.OdataServices.Core.ExternalNode
18 biz.dfch.CS.Appclusive.Core.OdataServices.Core.ExternalNode
19 biz.dfch.CS.Appclusive.Core.OdataServices.Core.ExternalNode
20 biz.dfch.CS.Appclusive.Core.OdataServices.Core.ExternalNode
Retrieves id and name of all ExternalNodes that have been modified by user
with name 'SYSTEM' (case insensitive substring match).
.EXAMPLE
Get-ExternalNode AppclusiveScheduler -Select Name -ValueOnly -DefaultValue 'AppclusiveSchedulerNotAvailable'
AppclusiveSchedulerNotAvailable
Retrieves the 'Name' property of a ExternalNode with Name 'AppclusiveScheduler'
and AppclusiveSchedulerNotAvailable if the entity is not found.
.LINK
Online Version: http://dfch.biz/biz/dfch/PS/Appclusive/Client/Get-ExternalNode/
.NOTES
See module manifest for required software versions and dependencies.
#>
[CmdletBinding(
SupportsShouldProcess = $true
,
ConfirmImpact = 'Low'
,
HelpURI = 'http://dfch.biz/biz/dfch/PS/Appclusive/Client/Get-ExternalNode/'
,
DefaultParameterSetName = 'list'
)]
PARAM
(
# Specifies the id of the entity
[Parameter(Mandatory = $false, Position = 0, ParameterSetName = 'id')]
[long] $Id
,
# Specifies the name of the entity
[Parameter(Mandatory = $false, Position = 0, ParameterSetName = 'name')]
[Alias('n')]
[string] $Name
,
# Filter by external id
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[string] $ExternalId
,
# Filter by external id
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[long] $NodeId
,
# Filter by type
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[Alias("Type")]
[string] $ExternalType
,
# Filter by creator
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[string] $CreatedBy
,
# Filter by modifier
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[string] $ModifiedBy
,
# Specify the attributes of the entity to return
[Parameter(Mandatory = $false)]
[string[]] $Select = @()
,
# Specifies to return only values without header information.
# This parameter takes precendes over the 'Select' parameter.
[ValidateScript( { if(1 -eq $Select.Count -And $_) { $true; } else { throw("You must specify exactly one 'Select' property when using 'ValueOnly'."); } } )]
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[Parameter(Mandatory = $false, ParameterSetName = 'id')]
[Alias('HideTableHeaders')]
[switch] $ValueOnly
,
# This value is only returned if the regular search would have returned no results
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[Alias('default')]
$DefaultValue
,
# Specifies to deserialize JSON payloads
[ValidateScript( { if($ValueOnly -And $_) { $true; } else { throw("You must set the 'ValueOnly' switch when using 'ConvertFromJson'."); } } )]
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[Parameter(Mandatory = $false, ParameterSetName = 'id')]
[Alias('Convert')]
[switch] $ConvertFromJson
,
# Service reference to Appclusive
[Parameter(Mandatory = $false)]
[Alias('Services')]
[hashtable] $svc = (Get-Variable -Name $MyInvocation.MyCommand.Module.PrivateData.MODULEVAR -ValueOnly).Services
,
# Indicates to return all file information
[Parameter(Mandatory = $false, ParameterSetName = 'list')]
[switch] $ListAvailable = $false
,
# Indicates to return node information
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[Parameter(Mandatory = $false, ParameterSetName = 'id')]
[switch] $ExpandNode = $false
,
# Indicates to return job information
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[Parameter(Mandatory = $false, ParameterSetName = 'id')]
[Alias('ExpandExternalNodeAttributes')]
[Alias('ExpandAttributes')]
[switch] $ExpandBags = $false
,
# Specifies the return format of the Cmdlet
[ValidateSet('default', 'json', 'json-pretty', 'xml', 'xml-pretty')]
[Parameter(Mandatory = $false)]
[alias('ReturnFormat')]
[string] $As = 'default'
)
Begin
{
trap { Log-Exception $_; break; }
$datBegin = [datetime]::Now;
[string] $fn = $MyInvocation.MyCommand.Name;
Log-Debug -fn $fn -msg ("CALL. svc '{0}'. Name '{1}'." -f ($svc -is [Object]), $Name) -fac 1;
$EntitySetName = 'ExternalNodes';
# Parameter validation
Contract-Requires ($svc.Core -is [biz.dfch.CS.Appclusive.Api.Core.Core]) "Connect to the server before using the Cmdlet"
Contract-Requires (1 -ge ($PSBoundParameters.GetEnumerator() | Where { $_.Key -match 'Expand' -and $_.Value -eq $true}).Count) "You can specify only one 'Expand...' param.";
if($Select)
{
$Select = $Select | Select -Unique;
}
}
# Begin
Process
{
trap { Log-Exception $_; break; }
# Default test variable for checking function response codes.
[Boolean] $fReturn = $false;
# Return values are always and only returned via OutputParameter.
$OutputParameter = $null;
Contract-Assert ($PSCmdlet.ShouldProcess(($PSBoundParameters | Out-String)))
if($PSCmdlet.ParameterSetName -eq 'list')
{
if($Select)
{
$Response = $svc.Core.$EntitySetName | Select -Property $Select;
}
else
{
$Response = $svc.Core.$EntitySetName | Select;
}
}
else
{
$Exp = @();
if($PSCmdlet.ParameterSetName -eq 'id')
{
$Exp += ("Id eq {0}L" -f $Id);
}
if($Name)
{
$Exp += ("tolower(Name) eq '{0}'" -f $Name.ToLower());
}
if($ExternalType)
{
$Exp += ("tolower(ExternalType) eq '{0}'" -f $ExternalType.ToLower());
}
if($ExternalId)
{
$Exp += ("tolower(ExternalId) eq '{0}'" -f $ExternalId.ToLower());
}
if($NodeId)
{
$Exp += ("NodeId eq {0}L" -f $NodeId);
}
if($CreatedBy)
{
$CreatedById = Get-User -svc $svc $CreatedBy -Select Id -ValueOnly;
if ( !$CreatedById )
{
# User not found
return;
}
$Exp += ("(CreatedById eq {0}L)" -f $CreatedById);
}
if($ModifiedBy)
{
$ModifiedById = Get-User -svc $svc $ModifiedBy -Select Id -ValueOnly;
if ( !$ModifiedById )
{
# User not found
return;
}
$Exp += ("(ModifiedById eq {0}L)" -f $ModifiedById);
}
$FilterExpression = [String]::Join(' and ', $Exp);
if($Select)
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$filter', $FilterExpression) | Select -Property $Select;
}
else
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$filter', $FilterExpression) | Select;
if ( $ExpandNode )
{
$ResponseTemp = New-Object System.Collections.ArrayList;
foreach ($item in $Response)
{
if ( $item )
{
$Response_ = Get-Node -Id $item.NodeId -svc $svc;
$null = $ResponseTemp.Add($Response_);
}
}
$Response = $ResponseTemp.ToArray();
}
if ( $ExpandBags )
{
$ResponseTemp = New-Object System.Collections.ArrayList;
foreach ($item in $Response)
{
if ( $item )
{
$Response_ = $svc.Core.ExternalNodeBags.AddQueryOption('$filter', 'ExternaldNodeId eq {0}L' -f $item.Id);
$null = $ResponseTemp.Add($Response_);
}
}
$Response = $ResponseTemp.ToArray();
}
}
if(1 -eq $Select.Count -And $ValueOnly)
{
$Response = $Response.$Select;
}
if($PSBoundParameters.ContainsKey('DefaultValue') -And !$Response)
{
$Response = $DefaultValue;
}
if($ValueOnly -And $ConvertFromJson)
{
$ResponseTemp = New-Object System.Collections.ArrayList;
foreach($item in $Response)
{
try
{
$null = $ResponseTemp.Add((ConvertFrom-Json -InputObject $item));
}
catch
{
$null = $ResponseTemp.Add($item);
}
}
$Response = $ResponseTemp.ToArray();
}
}
$OutputParameter = Format-ResultAs $Response $As
$fReturn = $true;
}
# Process
End
{
$datEnd = [datetime]::Now;
Log-Debug -fn $fn -msg ("RET. fReturn: [{0}]. Execution time: [{1}]ms. Started: [{2}]." -f $fReturn, ($datEnd - $datBegin).TotalMilliseconds, $datBegin.ToString('yyyy-MM-dd HH:mm:ss.fffzzz')) -fac 2;
# Return values are always and only returned via OutputParameter.
return $OutputParameter;
}
# End
} # function
if($MyInvocation.ScriptName) { Export-ModuleMember -Function Get-ExternalNode; }
#
# Copyright 2014-2015 d-fens GmbH
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SIG # Begin signature block
# MIIXDwYJKoZIhvcNAQcCoIIXADCCFvwCAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB
# gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR
# AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQU3M6LL0mWyz+69olpPYnVfJ3p
# QKSgghHCMIIEFDCCAvygAwIBAgILBAAAAAABL07hUtcwDQYJKoZIhvcNAQEFBQAw
# VzELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNV
# BAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkdsb2JhbFNpZ24gUm9vdCBDQTAeFw0xMTA0
# MTMxMDAwMDBaFw0yODAxMjgxMjAwMDBaMFIxCzAJBgNVBAYTAkJFMRkwFwYDVQQK
# ExBHbG9iYWxTaWduIG52LXNhMSgwJgYDVQQDEx9HbG9iYWxTaWduIFRpbWVzdGFt
# cGluZyBDQSAtIEcyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAlO9l
# +LVXn6BTDTQG6wkft0cYasvwW+T/J6U00feJGr+esc0SQW5m1IGghYtkWkYvmaCN
# d7HivFzdItdqZ9C76Mp03otPDbBS5ZBb60cO8eefnAuQZT4XljBFcm05oRc2yrmg
# jBtPCBn2gTGtYRakYua0QJ7D/PuV9vu1LpWBmODvxevYAll4d/eq41JrUJEpxfz3
# zZNl0mBhIvIG+zLdFlH6Dv2KMPAXCae78wSuq5DnbN96qfTvxGInX2+ZbTh0qhGL
# 2t/HFEzphbLswn1KJo/nVrqm4M+SU4B09APsaLJgvIQgAIMboe60dAXBKY5i0Eex
# +vBTzBj5Ljv5cH60JQIDAQABo4HlMIHiMA4GA1UdDwEB/wQEAwIBBjASBgNVHRMB
# Af8ECDAGAQH/AgEAMB0GA1UdDgQWBBRG2D7/3OO+/4Pm9IWbsN1q1hSpwTBHBgNV
# HSAEQDA+MDwGBFUdIAAwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93d3cuZ2xvYmFs
# c2lnbi5jb20vcmVwb3NpdG9yeS8wMwYDVR0fBCwwKjAooCagJIYiaHR0cDovL2Ny
# bC5nbG9iYWxzaWduLm5ldC9yb290LmNybDAfBgNVHSMEGDAWgBRge2YaRQ2XyolQ
# L30EzTSo//z9SzANBgkqhkiG9w0BAQUFAAOCAQEATl5WkB5GtNlJMfO7FzkoG8IW
# 3f1B3AkFBJtvsqKa1pkuQJkAVbXqP6UgdtOGNNQXzFU6x4Lu76i6vNgGnxVQ380W
# e1I6AtcZGv2v8Hhc4EvFGN86JB7arLipWAQCBzDbsBJe/jG+8ARI9PBw+DpeVoPP
# PfsNvPTF7ZedudTbpSeE4zibi6c1hkQgpDttpGoLoYP9KOva7yj2zIhd+wo7AKvg
# IeviLzVsD440RZfroveZMzV+y5qKu0VN5z+fwtmK+mWybsd+Zf/okuEsMaL3sCc2
# SI8mbzvuTXYfecPlf5Y1vC0OzAGwjn//UYCAp5LUs0RGZIyHTxZjBzFLY7Df8zCC
# BCkwggMRoAMCAQICCwQAAAAAATGJxjfoMA0GCSqGSIb3DQEBCwUAMEwxIDAeBgNV
# BAsTF0dsb2JhbFNpZ24gUm9vdCBDQSAtIFIzMRMwEQYDVQQKEwpHbG9iYWxTaWdu
# MRMwEQYDVQQDEwpHbG9iYWxTaWduMB4XDTExMDgwMjEwMDAwMFoXDTE5MDgwMjEw
# MDAwMFowWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKPv0Z8p6djTgnY8YqDS
# SdYWHvHP8NC6SEMDLacd8gE0SaQQ6WIT9BP0FoO11VdCSIYrlViH6igEdMtyEQ9h
# JuH6HGEVxyibTQuCDyYrkDqW7aTQaymc9WGI5qRXb+70cNCNF97mZnZfdB5eDFM4
# XZD03zAtGxPReZhUGks4BPQHxCMD05LL94BdqpxWBkQtQUxItC3sNZKaxpXX9c6Q
# MeJ2s2G48XVXQqw7zivIkEnotybPuwyJy9DDo2qhydXjnFMrVyb+Vpp2/WFGomDs
# KUZH8s3ggmLGBFrn7U5AXEgGfZ1f53TJnoRlDVve3NMkHLQUEeurv8QfpLqZ0BdY
# Nc0CAwEAAaOB/TCB+jAOBgNVHQ8BAf8EBAMCAQYwEgYDVR0TAQH/BAgwBgEB/wIB
# ADAdBgNVHQ4EFgQUGUq4WuRNMaUU5V7sL6Mc+oCMMmswRwYDVR0gBEAwPjA8BgRV
# HSAAMDQwMgYIKwYBBQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3Jl
# cG9zaXRvcnkvMDYGA1UdHwQvMC0wK6ApoCeGJWh0dHA6Ly9jcmwuZ2xvYmFsc2ln
# bi5uZXQvcm9vdC1yMy5jcmwwEwYDVR0lBAwwCgYIKwYBBQUHAwMwHwYDVR0jBBgw
# FoAUj/BLf6guRSSuTVD6Y5qL3uLdG7wwDQYJKoZIhvcNAQELBQADggEBAHmwaTTi
# BYf2/tRgLC+GeTQD4LEHkwyEXPnk3GzPbrXsCly6C9BoMS4/ZL0Pgmtmd4F/ximl
# F9jwiU2DJBH2bv6d4UgKKKDieySApOzCmgDXsG1szYjVFXjPE/mIpXNNwTYr3MvO
# 23580ovvL72zT006rbtibiiTxAzL2ebK4BEClAOwvT+UKFaQHlPCJ9XJPM0aYx6C
# WRW2QMqngarDVa8z0bV16AnqRwhIIvtdG/Mseml+xddaXlYzPK1X6JMlQsPSXnE7
# ShxU7alVrCgFx8RsXdw8k/ZpPIJRzhoVPV4Bc/9Aouq0rtOO+u5dbEfHQfXUVlfy
# GDcy1tTMS/Zx4HYwggSfMIIDh6ADAgECAhIRIdaZp2SXPvH4Qn7pGcxTQRQwDQYJ
# KoZIhvcNAQEFBQAwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24g
# bnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzIw
# HhcNMTYwNTI0MDAwMDAwWhcNMjcwNjI0MDAwMDAwWjBgMQswCQYDVQQGEwJTRzEf
# MB0GA1UEChMWR01PIEdsb2JhbFNpZ24gUHRlIEx0ZDEwMC4GA1UEAxMnR2xvYmFs
# U2lnbiBUU0EgZm9yIE1TIEF1dGhlbnRpY29kZSAtIEcyMIIBIjANBgkqhkiG9w0B
# AQEFAAOCAQ8AMIIBCgKCAQEAsBeuotO2BDBWHlgPse1VpNZUy9j2czrsXV6rJf02
# pfqEw2FAxUa1WVI7QqIuXxNiEKlb5nPWkiWxfSPjBrOHOg5D8NcAiVOiETFSKG5d
# QHI88gl3p0mSl9RskKB2p/243LOd8gdgLE9YmABr0xVU4Prd/4AsXximmP/Uq+yh
# RVmyLm9iXeDZGayLV5yoJivZF6UQ0kcIGnAsM4t/aIAqtaFda92NAgIpA6p8N7u7
# KU49U5OzpvqP0liTFUy5LauAo6Ml+6/3CGSwekQPXBDXX2E3qk5r09JTJZ2Cc/os
# +XKwqRk5KlD6qdA8OsroW+/1X1H0+QrZlzXeaoXmIwRCrwIDAQABo4IBXzCCAVsw
# DgYDVR0PAQH/BAQDAgeAMEwGA1UdIARFMEMwQQYJKwYBBAGgMgEeMDQwMgYIKwYB
# BQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3JlcG9zaXRvcnkvMAkG
# A1UdEwQCMAAwFgYDVR0lAQH/BAwwCgYIKwYBBQUHAwgwQgYDVR0fBDswOTA3oDWg
# M4YxaHR0cDovL2NybC5nbG9iYWxzaWduLmNvbS9ncy9nc3RpbWVzdGFtcGluZ2cy
# LmNybDBUBggrBgEFBQcBAQRIMEYwRAYIKwYBBQUHMAKGOGh0dHA6Ly9zZWN1cmUu
# Z2xvYmFsc2lnbi5jb20vY2FjZXJ0L2dzdGltZXN0YW1waW5nZzIuY3J0MB0GA1Ud
# DgQWBBTUooRKOFoYf7pPMFC9ndV6h9YJ9zAfBgNVHSMEGDAWgBRG2D7/3OO+/4Pm
# 9IWbsN1q1hSpwTANBgkqhkiG9w0BAQUFAAOCAQEAj6kakW0EpjcgDoOW3iPTa24f
# bt1kPWghIrX4RzZpjuGlRcckoiK3KQnMVFquxrzNY46zPVBI5bTMrs2SjZ4oixNK
# Eaq9o+/Tsjb8tKFyv22XY3mMRLxwL37zvN2CU6sa9uv6HJe8tjecpBwwvKu8LUc2
# 35IgA+hxxlj2dQWaNPALWVqCRDSqgOQvhPZHXZbJtsrKnbemuuRQ09Q3uLogDtDT
# kipbxFm7oW3bPM5EncE4Kq3jjb3NCXcaEL5nCgI2ZIi5sxsm7ueeYMRGqLxhM2zP
# TrmcuWrwnzf+tT1PmtNN/94gjk6Xpv2fCbxNyhh2ybBNhVDygNIdBvVYBAexGDCC
# BNYwggO+oAMCAQICEhEhDRayW4wRltP+V8mGEea62TANBgkqhkiG9w0BAQsFADBa
# MQswCQYDVQQGEwJCRTEZMBcGA1UEChMQR2xvYmFsU2lnbiBudi1zYTEwMC4GA1UE
# AxMnR2xvYmFsU2lnbiBDb2RlU2lnbmluZyBDQSAtIFNIQTI1NiAtIEcyMB4XDTE1
# MDUwNDE2NDMyMVoXDTE4MDUwNDE2NDMyMVowVTELMAkGA1UEBhMCQ0gxDDAKBgNV
# BAgTA1p1ZzEMMAoGA1UEBxMDWnVnMRQwEgYDVQQKEwtkLWZlbnMgR21iSDEUMBIG
# A1UEAxMLZC1mZW5zIEdtYkgwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB
# AQDNPSzSNPylU9jFM78Q/GjzB7N+VNqikf/use7p8mpnBZ4cf5b4qV3rqQd62rJH
# RlAsxgouCSNQrl8xxfg6/t/I02kPvrzsR4xnDgMiVCqVRAeQsWebafWdTvWmONBS
# lxJejPP8TSgXMKFaDa+2HleTycTBYSoErAZSWpQ0NqF9zBadjsJRVatQuPkTDrwL
# eWibiyOipK9fcNoQpl5ll5H9EG668YJR3fqX9o0TQTkOmxXIL3IJ0UxdpyDpLEkt
# tBG6Y5wAdpF2dQX2phrfFNVY54JOGtuBkNGMSiLFzTkBA1fOlA6ICMYjB8xIFxVv
# rN1tYojCrqYkKMOjwWQz5X8zAgMBAAGjggGZMIIBlTAOBgNVHQ8BAf8EBAMCB4Aw
# TAYDVR0gBEUwQzBBBgkrBgEEAaAyATIwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93
# d3cuZ2xvYmFsc2lnbi5jb20vcmVwb3NpdG9yeS8wCQYDVR0TBAIwADATBgNVHSUE
# DDAKBggrBgEFBQcDAzBCBgNVHR8EOzA5MDegNaAzhjFodHRwOi8vY3JsLmdsb2Jh
# bHNpZ24uY29tL2dzL2dzY29kZXNpZ25zaGEyZzIuY3JsMIGQBggrBgEFBQcBAQSB
# gzCBgDBEBggrBgEFBQcwAoY4aHR0cDovL3NlY3VyZS5nbG9iYWxzaWduLmNvbS9j
# YWNlcnQvZ3Njb2Rlc2lnbnNoYTJnMi5jcnQwOAYIKwYBBQUHMAGGLGh0dHA6Ly9v
# Y3NwMi5nbG9iYWxzaWduLmNvbS9nc2NvZGVzaWduc2hhMmcyMB0GA1UdDgQWBBTN
# GDddiIYZy9p3Z84iSIMd27rtUDAfBgNVHSMEGDAWgBQZSrha5E0xpRTlXuwvoxz6
# gIwyazANBgkqhkiG9w0BAQsFAAOCAQEAAApsOzSX1alF00fTeijB/aIthO3UB0ks
# 1Gg3xoKQC1iEQmFG/qlFLiufs52kRPN7L0a7ClNH3iQpaH5IEaUENT9cNEXdKTBG
# 8OrJS8lrDJXImgNEgtSwz0B40h7bM2Z+0DvXDvpmfyM2NwHF/nNVj7NzmczrLRqN
# 9de3tV0pgRqnIYordVcmb24CZl3bzpwzbQQy14Iz+P5Z2cnw+QaYzAuweTZxEUcJ
# bFwpM49c1LMPFJTuOKkUgY90JJ3gVTpyQxfkc7DNBnx74PlRzjFmeGC/hxQt0hvo
# eaAiBdjo/1uuCTToigVnyRH+c0T2AezTeoFb7ne3I538hWeTdU5q9jGCBLcwggSz
# AgEBMHAwWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MgISESENFrJbjBGW0/5XyYYR5rrZMAkGBSsOAwIaBQCgeDAYBgorBgEEAYI3AgEM
# MQowCKACgAChAoAAMBkGCSqGSIb3DQEJAzEMBgorBgEEAYI3AgEEMBwGCisGAQQB
# gjcCAQsxDjAMBgorBgEEAYI3AgEVMCMGCSqGSIb3DQEJBDEWBBSLtergZNg8EMW1
# E5f+Z2fQF9P8fjANBgkqhkiG9w0BAQEFAASCAQB3ACQ1iLaD6VF2MZ/FIH+r1VYM
# HxHZpqYuONJIHILFGSPmjarsxXkAaS5+9jLfumFcuymhaqgNMsrFyH/xL49p+Yo3
# QcwkjZ3q+H8DpJhsO5wlMEYyjqKY235GsSfozcNxq2C4+OEOK8IBzxk8PfKQuhZY
# 8YCtvigb5oBWlCuDe4QZwujcUOWhHA6Cw4ZpHlhMHrI3jUY7MuC2pqsgxGwhhPhE
# jyV28O20X6hIaMNHOr9I3RumFymwoqHFax2vLnqxC/0bAVV59ua2v4cnvC6Hww3I
# AYum1KcDIUalMib/LzLbeprX23WrCquMyiODKRpEj75WTHoxdRTltcLEdMd7oYIC
# ojCCAp4GCSqGSIb3DQEJBjGCAo8wggKLAgEBMGgwUjELMAkGA1UEBhMCQkUxGTAX
# BgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGlt
# ZXN0YW1waW5nIENBIC0gRzICEhEh1pmnZJc+8fhCfukZzFNBFDAJBgUrDgMCGgUA
# oIH9MBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTE2
# MDgzMTE5MTY0MVowIwYJKoZIhvcNAQkEMRYEFITcC9zfOH+KluBNhNv6aIPPodqw
# MIGdBgsqhkiG9w0BCRACDDGBjTCBijCBhzCBhAQUY7gvq2H1g5CWlQULACScUCkz
# 7HkwbDBWpFQwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYt
# c2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzICEhEh
# 1pmnZJc+8fhCfukZzFNBFDANBgkqhkiG9w0BAQEFAASCAQCioh2XOsCOS1dOBvGW
# ipCGrZXarpBbsEtc1jNYGyqhJ5/PBSWvYkmQ6HZHYS3Wmwd/pbzq6G5LnZkBfp00
# ZIQzEssC6WI92uaHXLA+G8PGQJfL8wXQE6fltRyK9KERSQO3OstusWWokNB2FJ9X
# e841gs8by/C7iGvKq68JffTuzWmD3laEhlwGArLhYinzgH3Ct4lqYsHMdsEJkZiT
# VRnyY4lxwdJ+iULlClsacxuVpAqzvaGMdaboPhbbCxFtYR2R3hIa9S+b96rhaJe3
# TmoOLw3yVuc/rCg5rMB2nn4sXTGwjWzZdABwj3TwLtXNPOXWnicds9SS1dBozux0
# tebs
# SIG # End signature block
|
PowerShellCorpus/PowerShellGallery/biz.dfch.PS.Appclusive.Client/5.2.1.20161201/Get-ManagementUri.ps1
|
Get-ManagementUri.ps1
|
function Get-ManagementUri {
<#
.SYNOPSIS
Retrieves one or more entities from the ManagementUri entity set.
.DESCRIPTION
Retrieves one or more entities from the ManagementUri entity set.
You can retrieve one ore more entities from the entity set by specifying
Id, Name or other properties.
.INPUTS
The Cmdlet can either return all available entities or filter entities on
specified conditions.
See PARAMETERS section on possible inputs.
.OUTPUTS
default | json | json-pretty | xml | xml-pretty
In addition output can be filtered on specified properties.
.EXAMPLE
Get-ManagementUri -ListAvailable -Select Name
Name
----
myvCenter
ActivitiClientUri
ServiceBusClientUri
WindowsAdminUri
Retrieves the name of all ManagementUris.
.EXAMPLE
Get-ManagementUri 4
Type : json
Value : {"ConnectionString":"Endpoint=sb://activiti.example.com/ServiceBusDefaultNamespace;SharedAccessKeyN
ame={0};SharedAccessKey={1}=;TransportType=Amqp"}
ManagementCredentialId : 5
Id : 4
Tid : 22222222-2222-2222-2222-222222222222
Name : ActivitiClientUri
Description : Connection String for Amqp messaging client
CreatedById : 1
ModifiedById : 1
Created : 15.12.2015 00:00:00 +01:00
Modified : 15.12.2015 00:00:00 +01:00
RowVersion : {0, 0, 0, 0...}
ManagementCredential :
Tenant :
CreatedBy : SYSTEM
ModifiedBy : SYSTEM
Retrieves the ManagementUri object with Id 4 and returns all properties of it.
.EXAMPLE
Get-ManagementUri ActivitiClientUri -Select Value -ValueOnly -ConvertFromJson
ConnectionString
----------------
Endpoint=sb://win-8a036g6jvpj/ServiceBusDefaultNamespace;SharedAccessKeyName={0};SharedAccessKey={1}=;TransportType=Amqp
Retrieves the ManagementUri 'ActivitiClientUri' and only returns the 'Description' property
of it. In addition the contents of the property will be converted from JSON.
.EXAMPLE
Get-ManagementUri -ListAvailable -Select Name, Id -First 3
Name Id
---- --
myvCenter 4
ActivitiClientUri 5
ServiceBusClientUri 8
Retrieves the name and id of the first 3 ManagementUris.
.EXAMPLE
Get-ManagementUri 8 -Select Name -ValueOnly
ServiceBusClientUri
Retrieves the name of the ManagementUri with Id 8.
.EXAMPLE
Get-ManagementUri -ModifiedBy SYSTEM -Select Id, Name
Id Name
-- ----
4 myvCenter
5 ActivitiClientUri
8 ServiceBusClientAcct
Retrieves id and name of all Users that have been modified by user
with name 'SYSTEM' (case insensitive substring match).
.EXAMPLE
Get-ManagementUri HttpProxy -Select Value -ValueOnly -DefaultValue 'http://proxy:8080'
http://proxy:8080
Retrieves the 'Value' property of a ManagementUri with Name 'HttpProxy'
and http://proxy:8080 if the entity is not found.
.LINK
Online Version: http://dfch.biz/biz/dfch/PS/Appclusive/Client/Get-ManagementUri/
.NOTES
See module manifest for required software versions and dependencies.
#>
[CmdletBinding(
SupportsShouldProcess = $true
,
ConfirmImpact = 'Low'
,
HelpURI = 'http://dfch.biz/biz/dfch/PS/Appclusive/Client/Get-ManagementUri/'
,
DefaultParameterSetName = 'list'
)]
PARAM
(
# Specifies the name of the entity
[Parameter(Mandatory = $false, Position = 0, ParameterSetName = 'id')]
[long] $Id
,
[Parameter(Mandatory = $false, Position = 0, ParameterSetName = 'name')]
[Alias('n')]
[string] $Name
,
# Filter by creator
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[string] $CreatedBy
,
# Filter by modifier
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[string] $ModifiedBy
,
# Specify the attributes of the entity to return
[Parameter(Mandatory = $false)]
[string[]] $Select = @()
,
# Specifies to return only values without header information.
# This parameter takes precendes over the 'Select' parameter.
[ValidateScript( { if(1 -ge $Select.Count -And $_) { $true; } else { throw("You must specify exactly one 'Select' property when using 'ValueOnly'."); } } )]
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[Parameter(Mandatory = $false, ParameterSetName = 'id')]
[Alias('HideTableHeaders')]
[switch] $ValueOnly
,
# This value is only returned if the regular search would have returned no results
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[Alias('default')]
$DefaultValue
,
# Specifies to deserialize JSON payloads
[ValidateScript( { if($ValueOnly -And $_) { $true; } else { throw("You must set the 'ValueOnly' switch when using 'ConvertFromJson'."); } } )]
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[Parameter(Mandatory = $false, ParameterSetName = 'id')]
[Alias('Convert')]
[switch] $ConvertFromJson
,
# Limits the output to the specified number of entries
[Parameter(Mandatory = $false)]
[Alias('top')]
[int] $First
,
# Service reference to Appclusive
[Parameter(Mandatory = $false)]
[Alias('Services')]
[hashtable] $svc = (Get-Variable -Name $MyInvocation.MyCommand.Module.PrivateData.MODULEVAR -ValueOnly).Services
,
# Indicates to return all file information
[Parameter(Mandatory = $false, ParameterSetName = 'list')]
[switch] $ListAvailable = $false
,
# Indicates to return credential information
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[Parameter(Mandatory = $false, ParameterSetName = 'id')]
[switch] $ExpandManagementCredential = $false
,
# Specifies the return format of the Cmdlet
[ValidateSet('default', 'json', 'json-pretty', 'xml', 'xml-pretty')]
[Parameter(Mandatory = $false)]
[alias('ReturnFormat')]
[string] $As = 'default'
)
Begin
{
trap { Log-Exception $_; break; }
$datBegin = [datetime]::Now;
[string] $fn = $MyInvocation.MyCommand.Name;
Log-Debug -fn $fn -msg ("CALL. svc '{0}'. Name '{1}'." -f ($svc -is [Object]), $Name) -fac 1;
$EntitySetName = 'ManagementUris';
# Parameter validation
Contract-Requires ($svc.Core -is [biz.dfch.CS.Appclusive.Api.Core.Core]) "Connect to the server before using the Cmdlet"
if($Select)
{
$Select = $Select | Select -Unique;
}
elseif ($ValueOnly)
{
$Select = 'Value';
}
}
# Begin
Process
{
trap { Log-Exception $_; break; }
# Default test variable for checking function response codes.
[Boolean] $fReturn = $false;
# Return values are always and only returned via OutputParameter.
$OutputParameter = $null;
Contract-Assert ($PSCmdlet.ShouldProcess(($PSBoundParameters | Out-String)))
if($PSCmdlet.ParameterSetName -eq 'list')
{
if($Select)
{
if($PSBoundParameters.ContainsKey('First'))
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$orderby','Name').AddQueryOption('$top', $First) | Select -Property $Select;
}
else
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$orderby','Name') | Select -Property $Select;
}
}
else
{
if($PSBoundParameters.ContainsKey('First'))
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$orderby','Name').AddQueryOption('$top', $First) | Select;
}
else
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$orderby','Name') | Select;
}
}
}
else
{
$Exp = @();
if($PSCmdlet.ParameterSetName -eq 'id')
{
$Exp += ("Id eq {0}" -f $Id);
}
if($Name)
{
$Exp += ("tolower(Name) eq '{0}'" -f $Name.ToLower());
}
if($CreatedBy)
{
$CreatedById = Get-User -svc $svc -Name $CreatedBy -Select Id -ValueOnly;
if ( !$CreatedById )
{
# User not found
return;
}
$Exp += ("(CreatedById eq {0})" -f $CreatedById);
}
if($ModifiedBy)
{
$ModifiedById = Get-User -svc $svc -Name $ModifiedBy -Select Id -ValueOnly;
if ( !$ModifiedById )
{
# User not found
return;
}
$Exp += ("(ModifiedById eq {0})" -f $ModifiedById);
}
$FilterExpression = [String]::Join(' and ', $Exp);
if($Select)
{
if($PSBoundParameters.ContainsKey('First'))
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$filter', $FilterExpression).AddQueryOption('$top', $First) | Select -Property $Select;
}
else
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$filter', $FilterExpression) | Select -Property $Select;
}
}
else
{
if($PSBoundParameters.ContainsKey('First'))
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$filter', $FilterExpression).AddQueryOption('$top', $First) | Select;
}
else
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$filter', $FilterExpression) | Select;
}
if ( $ExpandManagementCredential )
{
$ResponseTemp = New-Object System.Collections.ArrayList;
foreach ($item in $Response)
{
if ( $item.ManagementCredentialId )
{
$Response_ = Get-ManagementCredential -svc $svc -Id $Response.ManagementCredentialId;
$null = $ResponseTemp.Add($Response_);
}
}
$Response = $ResponseTemp.ToArray();
}
}
if(1 -eq $Select.Count -And $ValueOnly)
{
$Response = $Response.$Select;
}
if($PSBoundParameters.ContainsKey('DefaultValue') -And !$Response)
{
$Response = $DefaultValue;
}
if($ValueOnly -And $ConvertFromJson)
{
$ResponseTemp = New-Object System.Collections.ArrayList;
foreach($item in $Response)
{
try
{
$null = $ResponseTemp.Add((ConvertFrom-Json -InputObject $item));
}
catch
{
$null = $ResponseTemp.Add($item);
}
}
$Response = $ResponseTemp.ToArray();
}
}
$OutputParameter = Format-ResultAs $Response $As
$fReturn = $true;
}
# Process
End
{
$datEnd = [datetime]::Now;
Log-Debug -fn $fn -msg ("RET. fReturn: [{0}]. Execution time: [{1}]ms. Started: [{2}]." -f $fReturn, ($datEnd - $datBegin).TotalMilliseconds, $datBegin.ToString('yyyy-MM-dd HH:mm:ss.fffzzz')) -fac 2;
# Return values are always and only returned via OutputParameter.
return $OutputParameter;
}
# End
} # function
if($MyInvocation.ScriptName) { Export-ModuleMember -Function Get-ManagementUri; }
#
# Copyright 2014-2015 d-fens GmbH
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SIG # Begin signature block
# MIIXDwYJKoZIhvcNAQcCoIIXADCCFvwCAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB
# gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR
# AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQUfTcDaTp1EUTwyTl1G6e5i/pp
# QxKgghHCMIIEFDCCAvygAwIBAgILBAAAAAABL07hUtcwDQYJKoZIhvcNAQEFBQAw
# VzELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNV
# BAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkdsb2JhbFNpZ24gUm9vdCBDQTAeFw0xMTA0
# MTMxMDAwMDBaFw0yODAxMjgxMjAwMDBaMFIxCzAJBgNVBAYTAkJFMRkwFwYDVQQK
# ExBHbG9iYWxTaWduIG52LXNhMSgwJgYDVQQDEx9HbG9iYWxTaWduIFRpbWVzdGFt
# cGluZyBDQSAtIEcyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAlO9l
# +LVXn6BTDTQG6wkft0cYasvwW+T/J6U00feJGr+esc0SQW5m1IGghYtkWkYvmaCN
# d7HivFzdItdqZ9C76Mp03otPDbBS5ZBb60cO8eefnAuQZT4XljBFcm05oRc2yrmg
# jBtPCBn2gTGtYRakYua0QJ7D/PuV9vu1LpWBmODvxevYAll4d/eq41JrUJEpxfz3
# zZNl0mBhIvIG+zLdFlH6Dv2KMPAXCae78wSuq5DnbN96qfTvxGInX2+ZbTh0qhGL
# 2t/HFEzphbLswn1KJo/nVrqm4M+SU4B09APsaLJgvIQgAIMboe60dAXBKY5i0Eex
# +vBTzBj5Ljv5cH60JQIDAQABo4HlMIHiMA4GA1UdDwEB/wQEAwIBBjASBgNVHRMB
# Af8ECDAGAQH/AgEAMB0GA1UdDgQWBBRG2D7/3OO+/4Pm9IWbsN1q1hSpwTBHBgNV
# HSAEQDA+MDwGBFUdIAAwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93d3cuZ2xvYmFs
# c2lnbi5jb20vcmVwb3NpdG9yeS8wMwYDVR0fBCwwKjAooCagJIYiaHR0cDovL2Ny
# bC5nbG9iYWxzaWduLm5ldC9yb290LmNybDAfBgNVHSMEGDAWgBRge2YaRQ2XyolQ
# L30EzTSo//z9SzANBgkqhkiG9w0BAQUFAAOCAQEATl5WkB5GtNlJMfO7FzkoG8IW
# 3f1B3AkFBJtvsqKa1pkuQJkAVbXqP6UgdtOGNNQXzFU6x4Lu76i6vNgGnxVQ380W
# e1I6AtcZGv2v8Hhc4EvFGN86JB7arLipWAQCBzDbsBJe/jG+8ARI9PBw+DpeVoPP
# PfsNvPTF7ZedudTbpSeE4zibi6c1hkQgpDttpGoLoYP9KOva7yj2zIhd+wo7AKvg
# IeviLzVsD440RZfroveZMzV+y5qKu0VN5z+fwtmK+mWybsd+Zf/okuEsMaL3sCc2
# SI8mbzvuTXYfecPlf5Y1vC0OzAGwjn//UYCAp5LUs0RGZIyHTxZjBzFLY7Df8zCC
# BCkwggMRoAMCAQICCwQAAAAAATGJxjfoMA0GCSqGSIb3DQEBCwUAMEwxIDAeBgNV
# BAsTF0dsb2JhbFNpZ24gUm9vdCBDQSAtIFIzMRMwEQYDVQQKEwpHbG9iYWxTaWdu
# MRMwEQYDVQQDEwpHbG9iYWxTaWduMB4XDTExMDgwMjEwMDAwMFoXDTE5MDgwMjEw
# MDAwMFowWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKPv0Z8p6djTgnY8YqDS
# SdYWHvHP8NC6SEMDLacd8gE0SaQQ6WIT9BP0FoO11VdCSIYrlViH6igEdMtyEQ9h
# JuH6HGEVxyibTQuCDyYrkDqW7aTQaymc9WGI5qRXb+70cNCNF97mZnZfdB5eDFM4
# XZD03zAtGxPReZhUGks4BPQHxCMD05LL94BdqpxWBkQtQUxItC3sNZKaxpXX9c6Q
# MeJ2s2G48XVXQqw7zivIkEnotybPuwyJy9DDo2qhydXjnFMrVyb+Vpp2/WFGomDs
# KUZH8s3ggmLGBFrn7U5AXEgGfZ1f53TJnoRlDVve3NMkHLQUEeurv8QfpLqZ0BdY
# Nc0CAwEAAaOB/TCB+jAOBgNVHQ8BAf8EBAMCAQYwEgYDVR0TAQH/BAgwBgEB/wIB
# ADAdBgNVHQ4EFgQUGUq4WuRNMaUU5V7sL6Mc+oCMMmswRwYDVR0gBEAwPjA8BgRV
# HSAAMDQwMgYIKwYBBQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3Jl
# cG9zaXRvcnkvMDYGA1UdHwQvMC0wK6ApoCeGJWh0dHA6Ly9jcmwuZ2xvYmFsc2ln
# bi5uZXQvcm9vdC1yMy5jcmwwEwYDVR0lBAwwCgYIKwYBBQUHAwMwHwYDVR0jBBgw
# FoAUj/BLf6guRSSuTVD6Y5qL3uLdG7wwDQYJKoZIhvcNAQELBQADggEBAHmwaTTi
# BYf2/tRgLC+GeTQD4LEHkwyEXPnk3GzPbrXsCly6C9BoMS4/ZL0Pgmtmd4F/ximl
# F9jwiU2DJBH2bv6d4UgKKKDieySApOzCmgDXsG1szYjVFXjPE/mIpXNNwTYr3MvO
# 23580ovvL72zT006rbtibiiTxAzL2ebK4BEClAOwvT+UKFaQHlPCJ9XJPM0aYx6C
# WRW2QMqngarDVa8z0bV16AnqRwhIIvtdG/Mseml+xddaXlYzPK1X6JMlQsPSXnE7
# ShxU7alVrCgFx8RsXdw8k/ZpPIJRzhoVPV4Bc/9Aouq0rtOO+u5dbEfHQfXUVlfy
# GDcy1tTMS/Zx4HYwggSfMIIDh6ADAgECAhIRIdaZp2SXPvH4Qn7pGcxTQRQwDQYJ
# KoZIhvcNAQEFBQAwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24g
# bnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzIw
# HhcNMTYwNTI0MDAwMDAwWhcNMjcwNjI0MDAwMDAwWjBgMQswCQYDVQQGEwJTRzEf
# MB0GA1UEChMWR01PIEdsb2JhbFNpZ24gUHRlIEx0ZDEwMC4GA1UEAxMnR2xvYmFs
# U2lnbiBUU0EgZm9yIE1TIEF1dGhlbnRpY29kZSAtIEcyMIIBIjANBgkqhkiG9w0B
# AQEFAAOCAQ8AMIIBCgKCAQEAsBeuotO2BDBWHlgPse1VpNZUy9j2czrsXV6rJf02
# pfqEw2FAxUa1WVI7QqIuXxNiEKlb5nPWkiWxfSPjBrOHOg5D8NcAiVOiETFSKG5d
# QHI88gl3p0mSl9RskKB2p/243LOd8gdgLE9YmABr0xVU4Prd/4AsXximmP/Uq+yh
# RVmyLm9iXeDZGayLV5yoJivZF6UQ0kcIGnAsM4t/aIAqtaFda92NAgIpA6p8N7u7
# KU49U5OzpvqP0liTFUy5LauAo6Ml+6/3CGSwekQPXBDXX2E3qk5r09JTJZ2Cc/os
# +XKwqRk5KlD6qdA8OsroW+/1X1H0+QrZlzXeaoXmIwRCrwIDAQABo4IBXzCCAVsw
# DgYDVR0PAQH/BAQDAgeAMEwGA1UdIARFMEMwQQYJKwYBBAGgMgEeMDQwMgYIKwYB
# BQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3JlcG9zaXRvcnkvMAkG
# A1UdEwQCMAAwFgYDVR0lAQH/BAwwCgYIKwYBBQUHAwgwQgYDVR0fBDswOTA3oDWg
# M4YxaHR0cDovL2NybC5nbG9iYWxzaWduLmNvbS9ncy9nc3RpbWVzdGFtcGluZ2cy
# LmNybDBUBggrBgEFBQcBAQRIMEYwRAYIKwYBBQUHMAKGOGh0dHA6Ly9zZWN1cmUu
# Z2xvYmFsc2lnbi5jb20vY2FjZXJ0L2dzdGltZXN0YW1waW5nZzIuY3J0MB0GA1Ud
# DgQWBBTUooRKOFoYf7pPMFC9ndV6h9YJ9zAfBgNVHSMEGDAWgBRG2D7/3OO+/4Pm
# 9IWbsN1q1hSpwTANBgkqhkiG9w0BAQUFAAOCAQEAj6kakW0EpjcgDoOW3iPTa24f
# bt1kPWghIrX4RzZpjuGlRcckoiK3KQnMVFquxrzNY46zPVBI5bTMrs2SjZ4oixNK
# Eaq9o+/Tsjb8tKFyv22XY3mMRLxwL37zvN2CU6sa9uv6HJe8tjecpBwwvKu8LUc2
# 35IgA+hxxlj2dQWaNPALWVqCRDSqgOQvhPZHXZbJtsrKnbemuuRQ09Q3uLogDtDT
# kipbxFm7oW3bPM5EncE4Kq3jjb3NCXcaEL5nCgI2ZIi5sxsm7ueeYMRGqLxhM2zP
# TrmcuWrwnzf+tT1PmtNN/94gjk6Xpv2fCbxNyhh2ybBNhVDygNIdBvVYBAexGDCC
# BNYwggO+oAMCAQICEhEhDRayW4wRltP+V8mGEea62TANBgkqhkiG9w0BAQsFADBa
# MQswCQYDVQQGEwJCRTEZMBcGA1UEChMQR2xvYmFsU2lnbiBudi1zYTEwMC4GA1UE
# AxMnR2xvYmFsU2lnbiBDb2RlU2lnbmluZyBDQSAtIFNIQTI1NiAtIEcyMB4XDTE1
# MDUwNDE2NDMyMVoXDTE4MDUwNDE2NDMyMVowVTELMAkGA1UEBhMCQ0gxDDAKBgNV
# BAgTA1p1ZzEMMAoGA1UEBxMDWnVnMRQwEgYDVQQKEwtkLWZlbnMgR21iSDEUMBIG
# A1UEAxMLZC1mZW5zIEdtYkgwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB
# AQDNPSzSNPylU9jFM78Q/GjzB7N+VNqikf/use7p8mpnBZ4cf5b4qV3rqQd62rJH
# RlAsxgouCSNQrl8xxfg6/t/I02kPvrzsR4xnDgMiVCqVRAeQsWebafWdTvWmONBS
# lxJejPP8TSgXMKFaDa+2HleTycTBYSoErAZSWpQ0NqF9zBadjsJRVatQuPkTDrwL
# eWibiyOipK9fcNoQpl5ll5H9EG668YJR3fqX9o0TQTkOmxXIL3IJ0UxdpyDpLEkt
# tBG6Y5wAdpF2dQX2phrfFNVY54JOGtuBkNGMSiLFzTkBA1fOlA6ICMYjB8xIFxVv
# rN1tYojCrqYkKMOjwWQz5X8zAgMBAAGjggGZMIIBlTAOBgNVHQ8BAf8EBAMCB4Aw
# TAYDVR0gBEUwQzBBBgkrBgEEAaAyATIwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93
# d3cuZ2xvYmFsc2lnbi5jb20vcmVwb3NpdG9yeS8wCQYDVR0TBAIwADATBgNVHSUE
# DDAKBggrBgEFBQcDAzBCBgNVHR8EOzA5MDegNaAzhjFodHRwOi8vY3JsLmdsb2Jh
# bHNpZ24uY29tL2dzL2dzY29kZXNpZ25zaGEyZzIuY3JsMIGQBggrBgEFBQcBAQSB
# gzCBgDBEBggrBgEFBQcwAoY4aHR0cDovL3NlY3VyZS5nbG9iYWxzaWduLmNvbS9j
# YWNlcnQvZ3Njb2Rlc2lnbnNoYTJnMi5jcnQwOAYIKwYBBQUHMAGGLGh0dHA6Ly9v
# Y3NwMi5nbG9iYWxzaWduLmNvbS9nc2NvZGVzaWduc2hhMmcyMB0GA1UdDgQWBBTN
# GDddiIYZy9p3Z84iSIMd27rtUDAfBgNVHSMEGDAWgBQZSrha5E0xpRTlXuwvoxz6
# gIwyazANBgkqhkiG9w0BAQsFAAOCAQEAAApsOzSX1alF00fTeijB/aIthO3UB0ks
# 1Gg3xoKQC1iEQmFG/qlFLiufs52kRPN7L0a7ClNH3iQpaH5IEaUENT9cNEXdKTBG
# 8OrJS8lrDJXImgNEgtSwz0B40h7bM2Z+0DvXDvpmfyM2NwHF/nNVj7NzmczrLRqN
# 9de3tV0pgRqnIYordVcmb24CZl3bzpwzbQQy14Iz+P5Z2cnw+QaYzAuweTZxEUcJ
# bFwpM49c1LMPFJTuOKkUgY90JJ3gVTpyQxfkc7DNBnx74PlRzjFmeGC/hxQt0hvo
# eaAiBdjo/1uuCTToigVnyRH+c0T2AezTeoFb7ne3I538hWeTdU5q9jGCBLcwggSz
# AgEBMHAwWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MgISESENFrJbjBGW0/5XyYYR5rrZMAkGBSsOAwIaBQCgeDAYBgorBgEEAYI3AgEM
# MQowCKACgAChAoAAMBkGCSqGSIb3DQEJAzEMBgorBgEEAYI3AgEEMBwGCisGAQQB
# gjcCAQsxDjAMBgorBgEEAYI3AgEVMCMGCSqGSIb3DQEJBDEWBBR8oQphqP8hySwc
# fATHFHMYaHO1pTANBgkqhkiG9w0BAQEFAASCAQCyzavJnGnJYEVivo2klvbmHMX3
# oZbUGaSIoQUptDnFNBftgcHMAUbHuupQkXib/W3LfY6qr+0+1/tHdVekgsTi4PYz
# zGKGROWrg3TVxxyvgI31KHrmOQRtuLUyjNDrlRDcWgdAv3IbKcriIQSe/HGwPV/V
# GmfCZf2yy/RGkmtwvCYPs3RrBMYUEVJkpPDGu/HqcP+OqNGtKORFJT5/gE0fgLUO
# 6DhHR3KdC+tLZsoIPS3SY2z37+DKiCB2D96s6Y7tqMUORXHPc9i1BKTnFO9XFQ96
# AAFXM3D5KSL+tqFXB/diY2T1xE3XvHsesLLPx44jkzeY1H21z3vCNhLctqAjoYIC
# ojCCAp4GCSqGSIb3DQEJBjGCAo8wggKLAgEBMGgwUjELMAkGA1UEBhMCQkUxGTAX
# BgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGlt
# ZXN0YW1waW5nIENBIC0gRzICEhEh1pmnZJc+8fhCfukZzFNBFDAJBgUrDgMCGgUA
# oIH9MBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTE2
# MDgzMTE5MTY0NFowIwYJKoZIhvcNAQkEMRYEFLp835PxSj13mWEfTBJVD3lewSWa
# MIGdBgsqhkiG9w0BCRACDDGBjTCBijCBhzCBhAQUY7gvq2H1g5CWlQULACScUCkz
# 7HkwbDBWpFQwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYt
# c2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzICEhEh
# 1pmnZJc+8fhCfukZzFNBFDANBgkqhkiG9w0BAQEFAASCAQAucgGDEbtX7HV46UJp
# 43+0PwxT/+jWpZPY/BBuIymWW4YBJKwdZnS1PEALVK60Gd7IdjDAvahAbg4LSJ2d
# FQDaj7HzCzm0ncUXLEfo/gWJf8khRijYicrEV7vPlfVcnB2oa7PWYKTGRrY1JrOa
# 4sW9P+FBO5xsSCk+x2aXJlmeTHMbB9z9epXitz5ebKQVextCmOoFJigTaJuzKpe0
# 7nRvO4p461MhyZFEiiXH/WLJVNsgMgLqGoTECniQpWScXeLtl9APSKwTTkkHKaFt
# VGZBUAWUduMoJJyHqGQWkSxshLt6+1kowr8nx17638v7L0ipPqgAHMzrroTQwaXK
# jYlO
# SIG # End signature block
|
PowerShellCorpus/PowerShellGallery/biz.dfch.PS.Appclusive.Client/5.2.1.20161201/New-EntityBag.ps1
|
New-EntityBag.ps1
|
function New-EntityBag {
<#
.SYNOPSIS
Creates an EntityBag entry in Appclusive.
.DESCRIPTION
Creates an EntityBag entry in Appclusive.
You must specify the parameters 'Name', 'Value', 'EntityId' and 'EntityKindId'. If the entry already exists no update of the existing entry is performed.
.OUTPUTS
default | json | json-pretty | xml | xml-pretty
.EXAMPLE
New-EntityBag -Name "ArbitraryName" -Value "ArbitraryValue" -EntityId 2 -EntityKindId 1 -svc $svc
Name : ArbitraryName
Value : ArbitraryValue
EntityId : 2
EntityKindId : 1
ProtectionLevel : 0
Id : 159
Tid : 11111111-1111-1111-1111-111111111111
Description :
CreatedById : 1
ModifiedById : 1
Created : 23.08.2016 11:08:14 +02:00
Modified : 23.08.2016 11:08:14 +02:00
RowVersion : {0, 0, 0, 0...}
Tenant :
CreatedBy :
ModifiedBy :
Create a new EntityBag entry, if it does not yet exist.
.EXAMPLE
New-EntityBag -Name "ArbitraryName" -Value "ArbitraryValue" -EntityId 2 -EntityKindId 1 -svc $svc -Description "ArbitraryDescription" -ProtectionLevel [biz.dfch.CS.Appclusive.Public.OdataServices.Core.EntityBagProtectionLevelEnum]::Default.value__
Name : ArbitraryName
Value : ArbitraryValue
EntityId : 2
EntityKindId : 1
ProtectionLevel : 1
Id : 159
Tid : 11111111-1111-1111-1111-111111111111
Description : ArbitraryDescription
CreatedById : 1
ModifiedById : 1
Created : 23.08.2016 11:08:14 +02:00
Modified : 23.08.2016 11:08:14 +02:00
RowVersion : {0, 0, 0, 0...}
Tenant :
CreatedBy :
ModifiedBy :
Create a new EntityBag entry, if it does not yet exist, with description and protectionLevel...
.LINK
Online Version: http://dfch.biz/biz/dfch/PS/Appclusive/Client/New-EntityBag/
Set-EntityBag: http://dfch.biz/biz/dfch/PS/Appclusive/Client/Set-EntityBag/
.NOTES
See module manifest for dependencies and further requirements.
#>
[CmdletBinding(
SupportsShouldProcess = $true
,
ConfirmImpact = 'Low'
,
HelpURI='http://dfch.biz/biz/dfch/PS/Appclusive/Client/New-EntityBag/'
)]
Param
(
# Specifies the Name to modify
[Parameter(Mandatory = $true, Position = 0)]
[ValidateNotNullOrEmpty()]
[string] $Name
,
# Specifies the Value to modify
[Parameter(Mandatory = $true, Position = 1)]
[string] $Value
,
# Specifies the EntityKindId to modify
[Parameter(Mandatory = $true, Position = 2)]
[ValidateRange(1,[long]::MaxValue)]
[long] $EntityKindId
,
# Specifies the EntityId to modify
[Parameter(Mandatory = $true, Position = 3)]
[ValidateRange(1,[long]::MaxValue)]
[long] $EntityId
,
# Specifies the ProtectionLevel to modify
[Parameter(Mandatory = $false)]
[long] $ProtectionLevel
,
# Specifies the Description to modify
[Parameter(Mandatory = $false)]
[string] $Description
,
# Service reference to Appclusive
[Parameter(Mandatory = $false)]
[Alias('Services')]
[hashtable] $svc = (Get-Variable -Name $MyInvocation.MyCommand.Module.PrivateData.MODULEVAR -ValueOnly).Services
,
# Specifies the return format of the Cmdlet
[ValidateSet('default', 'json', 'json-pretty', 'xml', 'xml-pretty')]
[Parameter(Mandatory = $false)]
[alias('ReturnFormat')]
[string] $As = 'default'
)
Begin
{
trap { Log-Exception $_; break; }
$datBegin = [datetime]::Now;
[string] $fn = $MyInvocation.MyCommand.Name;
Log-Debug -fn $fn -msg ("CALL. svc '{0}'. Name '{1}'." -f ($svc -is [Object]), $Name) -fac 1;
# Parameter validation
Contract-Requires ($svc.Core -is [biz.dfch.CS.Appclusive.Api.Core.Core]) "Connect to the server before using the Cmdlet"
# ProtectionLevel param validation
$minProtectionLevelValue = [biz.dfch.CS.Appclusive.Public.OdataServices.Core.EntityBagProtectionLevelEnum]::MinValue.value__;
$maxProtectionLevelValue = [biz.dfch.CS.Appclusive.Public.OdataServices.Core.EntityBagProtectionLevelEnum]::MaxValue.value__;
Contract-Assert($minProtectionLevelValue -le $ProtectionLevel);
Contract-Assert($maxProtectionLevelValue -ge $ProtectionLevel);
}
# Begin
Process
{
# Default test variable for checking function response codes.
[Boolean] $fReturn = $false;
# Return values are always and only returned via OutputParameter.
$OutputParameter = $null;
$exp = @();
$entityBagContents = @();
$exp += ("(tolower(Name) eq '{0}')" -f $Name.ToLower());
$exp += ("(EntityId eq {0})" -f $EntityId);
$exp += ("(EntityKindId eq {0})" -f $EntityKindId);
$FilterExpression = [String]::Join(' and ', $exp);
$entityBagContents += $Name;
$entityBagContents += $Value;
$entityBagContents += $EntityId;
$entityBagContents += $EntityKindId;
$entityBag = $svc.Core.EntityBags.AddQueryOption('$filter', $FilterExpression).AddQueryOption('$top', 1) | Select;
Contract-Assert (!$entityBag) 'EntityBag does already exist';
if($PSCmdlet.ShouldProcess($entityBagContents))
{
if($PSBoundParameters.ContainsKey('Description') -And $PSBoundParameters.ContainsKey('ProtectionLevel'))
{
$r = Set-EntityBag -Name $Name -Value $Value -EntityId $EntityId -EntityKindId $EntityKindId -ProtectionLevel $ProtectionLevel -Description $Description -CreateIfNotExist -svc $svc;
}
elseif($PSBoundParameters.ContainsKey('Description'))
{
$r = Set-EntityBag -Name $Name -Value $Value -EntityId $EntityId -EntityKindId $EntityKindId -Description $Description -CreateIfNotExist -svc $svc;
}
elseif($PSBoundParameters.ContainsKey('ProtectionLevel'))
{
$r = Set-EntityBag -Name $Name -Value $Value -EntityId $EntityId -EntityKindId $EntityKindId -ProtectionLevel $ProtectionLevel -CreateIfNotExist -svc $svc;
}
else
{
$r = Set-EntityBag -Name $Name -Value $Value -EntityId $EntityId -EntityKindId $EntityKindId -CreateIfNotExist -svc $svc;
}
$OutputParameter = $r;
}
$fReturn = $true;
}
# Process
End
{
$datEnd = [datetime]::Now;
Log-Debug -fn $fn -msg ("RET. fReturn: [{0}]. Execution time: [{1}]ms. Started: [{2}]." -f $fReturn, ($datEnd - $datBegin).TotalMilliseconds, $datBegin.ToString('yyyy-MM-dd HH:mm:ss.fffzzz')) -fac 2;
# Return values are always and only returned via OutputParameter.
return $OutputParameter;
}
# End
}
if($MyInvocation.ScriptName)
{
Export-ModuleMember -Function New-EntityBag;
}
#
# Copyright 2016 d-fens GmbH
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
|
PowerShellCorpus/PowerShellGallery/biz.dfch.PS.Appclusive.Client/5.2.1.20161201/Get-Role.ps1
|
Get-Role.ps1
|
function Get-Role {
<#
.SYNOPSIS
Retrieves one or more entities from the Role entity set.
.DESCRIPTION
Retrieves one or more entities from the Role entity set.
You can retrieve one ore more entities from the entity set by either specifying
Id, Name or RoleType.
.INPUTS
The Cmdlet can either return all available entities or filter entities based on
specified conditions.
See PARAMETERS section for possible inputs.
.OUTPUTS
default | json | json-pretty | xml | xml-pretty
In addition output can be filtered on specified properties.
.EXAMPLE
Get-Role -ListAvailable -Select Name
Name
----
ArbitraryRole
AnotherRole
SomeRole
Retrieves the name of all Roles.
.EXAMPLE
Get-Role -Id 42
RoleType : BuiltIn
MailAddress :
Id : 42
Tid : 11111111-1111-1111-1111-111111111111
Name : ArbitraryRole
Description :
CreatedById : 1
ModifiedById : 1
Created : 23.08.2016 11:08:14 +02:00
Modified : 23.08.2016 11:08:14 +02:00
RowVersion :
Permissions : {}
Users : {}
Tenant :
CreatedBy :
ModifiedBy :
Retrieves the Role object with Id 42 and returns all properties of it.
.EXAMPLE
Get-Role -RoleType Distribution
RoleType : Distribution
MailAddress :
Id : 42
Tid : 11111111-1111-1111-1111-111111111111
Name : ArbitraryRole
Description :
CreatedById : 1
ModifiedById : 1
Created : 23.08.2016 11:08:14 +02:00
Modified : 23.08.2016 11:08:14 +02:00
RowVersion :
Permissions : {}
Users : {}
Tenant :
CreatedBy :
ModifiedBy :
...
Retrieves a list of Role objects with the corresponding RoleType.
.EXAMPLE
Get-Role -ListAvailable -Select Name, Id -First 3
Name Id
---- --
ArbitraryRole 4
AnotherRole 5
SomeRole 8
Retrieves the name and id of the first 3 Roles.
.EXAMPLE
Get-Role ArbitraryName -Select Name -ValueOnly -DefaultValue 'ArbitraryDefault'
ArbitraryName
Retrieves the 'Name' property of a Role with Name 'ArbitraryName'
and returns ArbitraryDefault, if the no results were found.
.LINK
Online Version: http://dfch.biz/biz/dfch/PS/Appclusive/Client/Get-Role/
.NOTES
See module manifest for required software versions and dependencies.
#>
[CmdletBinding(
SupportsShouldProcess = $true
,
ConfirmImpact = 'Low'
,
HelpURI = 'http://dfch.biz/biz/dfch/PS/Appclusive/Client/Get-Role/'
,
DefaultParameterSetName = 'list'
)]
PARAM
(
[Parameter(Mandatory = $true, Position = 0, ParameterSetName = 'id')]
[ValidateRange(1,[long]::MaxValue)]
[long] $Id
,
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[ValidateNotNullOrEmpty()]
[string] $Name
,
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[ValidateSet('Default', 'Security', 'Distribution', 'BuiltIn', 'External')]
[string] $RoleType
,
# Specify the attributes of the entity to return
[Parameter(Mandatory = $false)]
[string[]] $Select = @()
,
# Specifies to return only values without header information.
# This parameter takes precendes over the 'Select' parameter.
[ValidateScript( { if(1 -ge $Select.Count -And $_) { $true; } else { throw("You must specify exactly one 'Select' property when using 'ValueOnly'."); } } )]
[Parameter(Mandatory = $false)]
[Alias('HideTableHeaders')]
[switch] $ValueOnly
,
# This value is only returned if the regular search would have returned no results
[Parameter(Mandatory = $false)]
[Alias('default')]
$DefaultValue
,
# Specifies to deserialize JSON payloads
[ValidateScript( { if($ValueOnly -And $_) { $true; } else { throw("You must set the 'ValueOnly' switch when using 'ConvertFromJson'."); } } )]
[Parameter(Mandatory = $false)]
[Alias('Convert')]
[switch] $ConvertFromJson
,
# Limits the output to the specified number of entries
[Parameter(Mandatory = $false)]
[Alias('top')]
[long] $First
,
# Service reference to Appclusive
[Parameter(Mandatory = $false)]
[Alias('Services')]
[hashtable] $svc = (Get-Variable -Name $MyInvocation.MyCommand.Module.PrivateData.MODULEVAR -ValueOnly).Services
,
# Indicates to return all available entities
[Parameter(Mandatory = $false, ParameterSetName = 'list')]
[switch] $ListAvailable = $false
,
# Indicates to return permissions
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[Parameter(Mandatory = $false, ParameterSetName = 'id')]
[switch] $ExpandPermissions = $false
,
# Specifies the return format of the Cmdlet
[ValidateSet('default', 'json', 'json-pretty', 'xml', 'xml-pretty')]
[Parameter(Mandatory = $false)]
[alias('ReturnFormat')]
[string] $As = 'default'
)
Begin
{
trap { Log-Exception $_; break; }
$datBegin = [datetime]::Now;
[string] $fn = $MyInvocation.MyCommand.Name;
Log-Debug -fn $fn -msg ("CALL. svc '{0}'. Name '{1}'." -f ($svc -is [Object]), $Name) -fac 1;
$entitySetName = 'Roles';
$permissionsPropertyName = 'Permissions';
# Parameter validation
Contract-Requires ($svc.Core -is [biz.dfch.CS.Appclusive.Api.Core.Core]) "Connect to the server before using the Cmdlet";
if($Select)
{
$Select = $Select | Select -Unique;
}
elseif ($ValueOnly)
{
$Select = 'Value';
}
}
Process
{
trap { Log-Exception $_; break; }
# Default test variable for checking function response codes.
[Boolean] $fReturn = $false;
# Return values are always and only returned via OutputParameter.
$OutputParameter = $null;
Contract-Assert ($PSCmdlet.ShouldProcess(($PSBoundParameters | Out-String)));
$response = @();
$exp = @();
if($PSCmdlet.ParameterSetName -eq 'list')
{
if($Select)
{
if($PSBoundParameters.ContainsKey('First'))
{
$response = $svc.Core.$entitySetName.AddQueryOption('$orderby', 'Name').AddQueryOption('$top', $First) | Select -Property $Select;
}
else
{
$response = $svc.Core.$entitySetName.AddQueryOption('$orderby', 'Name') | Select -Property $Select;
}
}
else
{
if($PSBoundParameters.ContainsKey('First'))
{
$response = $svc.Core.$entitySetName.AddQueryOption('$orderby', 'Name').AddQueryOption('$top', $First) | Select;
}
else
{
$response = $svc.Core.$entitySetName.AddQueryOption('$orderby', 'Name') | Select;
}
}
}
else
{
if ($PSCmdlet.ParameterSetName -eq 'name')
{
if($PSBoundParameters.ContainsKey('Name'))
{
$exp += ("tolower(Name) eq '{0}'" -f $Name.ToLower());
}
if($PSBoundParameters.ContainsKey('RoleType'))
{
$exp += ("RoleType eq '{0}'" -f $RoleType);
}
}
elseif ($PSCmdlet.ParameterSetName -eq 'id')
{
$exp += ("Id eq {0}" -f $Id);
}
$filterExpression = [String]::Join(' and ', $exp);
if($Select -And 'object' -ne $As)
{
if($PSBoundParameters.ContainsKey('First'))
{
$response = $svc.Core.$entitySetName.AddQueryOption('$top', $First).AddQueryOption('$filter', $filterExpression) | Select -Property $Select;
}
else
{
$response = $svc.Core.$entitySetName.AddQueryOption('$filter', $filterExpression) | Select -Property $Select;
}
}
else
{
if($ExpandPermissions)
{
if($PSBoundParameters.ContainsKey('First'))
{
$response = $svc.Core.$entitySetName.AddQueryOption('$top', $First).AddQueryOption('$filter', $filterExpression) | Select;
}
else
{
$response = $svc.Core.$entitySetName.AddQueryOption('$filter', $filterExpression) | Select;
}
$permissionResult = New-Object System.Collections.ArrayList;
foreach ($role in $response)
{
$rolePermissions = New-Object System.Collections.ArrayList;
$rolePermissionsFromDb = $svc.Core.LoadProperty($role, $permissionsPropertyName) | Select;
if ($rolePermissionsFromDb)
{
$rolePermissions.AddRange($rolePermissionsFromDb);
}
# If only one role was found, permissions of this role
if ($response.Count -eq 1)
{
$permissionResult.AddRange($rolePermissions);
}
# If there is more than one role, a list of lists with permissions gets returned
else
{
$null = $permissionResult.Add($rolePermissions.ToArray());
}
}
$response = $permissionResult.ToArray();
}
else
{
if($PSBoundParameters.ContainsKey('First'))
{
$response = $svc.Core.$entitySetName.AddQueryOption('$top', $First).AddQueryOption('$filter', $filterExpression) | Select;
}
else
{
$response = $svc.Core.$entitySetName.AddQueryOption('$filter', $filterExpression) | Select;
}
}
}
}
if(1 -eq $Select.Count -And $ValueOnly)
{
$response = $response.$Select;
}
if($PSBoundParameters.ContainsKey('DefaultValue') -And !$response)
{
$response = $DefaultValue;
}
if($ValueOnly -And $ConvertFromJson)
{
$responseTemp = New-Object System.Collections.ArrayList;
foreach($item in $response)
{
try
{
$null = $responseTemp.Add((ConvertFrom-Json -InputObject $item));
}
catch
{
$null = $responseTemp.Add($item);
}
}
$response = $responseTemp.ToArray();
}
$OutputParameter = Format-ResultAs $response $As
$fReturn = $true;
}
End
{
$datEnd = [datetime]::Now;
Log-Debug -fn $fn -msg ("RET. fReturn: [{0}]. Execution time: [{1}]ms. Started: [{2}]." -f $fReturn, ($datEnd - $datBegin).TotalMilliseconds, $datBegin.ToString('yyyy-MM-dd HH:mm:ss.fffzzz')) -fac 2;
# Return values are always and only returned via OutputParameter.
return $OutputParameter;
}
} # function
if($MyInvocation.ScriptName) { Export-ModuleMember -Function Get-Role; }
#
# Copyright 2016 d-fens GmbH
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
|
PowerShellCorpus/PowerShellGallery/biz.dfch.PS.Appclusive.Client/5.2.1.20161201/Import-Product.ps1
|
Import-Product.ps1
|
function Import-Product {
<#
.SYNOPSIS
Creates or Updates a Product (based on .NET Class)
.DESCRIPTION
Creates or Updates a Product (based on .NET Class)
Inspects the .NET Class, based on it's attributes it will import the Class. Creating EntityKinds, Connectors, Interfaces, DataTypes and will even expand it to more Classes in the same Assembly which Require an Interface provided by the imported class.
.OUTPUTS
default | json | json-pretty | xml | xml-pretty
.EXAMPLE
# output suppressed
.LINK
Online Version: http://dfch.biz/biz/dfch/PS/Appclusive/Client/Import-Product/
.NOTES
See module manifest for dependencies and further requirements.
#>
[CmdletBinding(
SupportsShouldProcess = $true
,
ConfirmImpact = 'Medium'
,
HelpURI = 'http://dfch.biz/biz/dfch/PS/Appclusive/Client/Import-Product/'
)]
Param
(
# Specifies the Name of the Class to be imported
[Parameter(Mandatory = $true, Position = 0)]
[Alias("FQCN")]
[string] $Class
,
# Specifies to not also import dependent classes (connected children).
[Parameter(Mandatory = $false, Position = 1)]
[switch] $ExcludeDependent = $false
,
# Specifies to update existing data
[Parameter(Mandatory = $false, Position = 2)]
[switch] $Force = $false
,
# Service reference to Appclusive
[Parameter(Mandatory = $false, Position = 3)]
[Alias('Services')]
[hashtable] $svc = (Get-Variable -Name $MyInvocation.MyCommand.Module.PrivateData.MODULEVAR -ValueOnly).Services
,
# Specifies the return format of the Cmdlet
[ValidateSet('default', 'json', 'json-pretty', 'xml', 'xml-pretty')]
[Parameter(Mandatory = $false)]
[Alias('ReturnFormat')]
[string] $As = 'default'
)
Begin
{
trap { Log-Exception $_; break; }
$entitySetName = "DataTypes";
$datBegin = [datetime]::Now;
[string] $fn = $MyInvocation.MyCommand.Name;
Log-Debug -fn $fn -msg ("CALL. svc '{0}'. EntityKindVersion '{1}'." -f ($svc -is [Object]), $EntityKindVersion) -fac 1;
# Parameter validation
Contract-Requires ($svc.Core -is [biz.dfch.CS.Appclusive.Api.Core.Core]) "Connect to the server before using the Cmdlet"
}
# Begin
Process
{
# Default test variable for checking function response codes.
[Boolean] $fReturn = $false;
# Return values are always and only returned via OutputParameter.
$OutputParameter = $null;
try
{
$ImportProduct_r = @();
$instance = New-Object $Class;
Contract-Assert (!!$instance)
$entityType = $instance.GetType();
$entityKind = Get-ApcEntityKind -Version $Class;
if ($entityKind -and -not $Force)
{
Write-Host "Stopping. EntityKind already exists, use Force to update. This is not recommended";
return;
}
$null = RecursivelyImportProducts $entityType;
$OutputParameter = Format-ResultAs $ImportProduct_r $As;
$fReturn = $true;
}
catch
{
Write-Host ($error[0] | out-string);
}
}
# Process
End
{
$datEnd = [datetime]::Now;
Log-Debug -fn $fn -msg ("RET. fReturn: [{0}]. Execution time: [{1}]ms. Started: [{2}]." -f $fReturn, ($datEnd - $datBegin).TotalMilliseconds, $datBegin.ToString('yyyy-MM-dd HH:mm:ss.fffzzz')) -fac 2;
# Return values are always and only returned via OutputParameter.
return $OutputParameter;
}
# End
}
if($MyInvocation.ScriptName) { Export-ModuleMember -Function Import-Product; }
function RecursivelyImportProducts([Type] $entityKindType, [System.Collections.ArrayList] $importedEntityKinds)
{
if (-not $importedEntityKinds)
{
$importedEntityKinds = New-Object System.Collections.ArrayList($null);
}
Log-Info ("Importing Ek: '{0}'" -f ($entityKindType.FullName));
# import EntityKind (incl. all stuff)
$null = Import-EntityKind $entityKindType;
# remember we imported it.
$importedEntityKinds.Add($entityKindType);
# find attached EntityKinds
$provides = $entityKindType.GetCustomAttributes([biz.dfch.CS.Appclusive.Public.Configuration.ProvideInterfaceAttribute], $true);
$possibleImports = GetPossibleImports $entityKindType;
foreach ($provide in $provides)
{
$children = RequiresInterface $possibleImports $provide.Name $importedEntityKinds;
Log-Info ("Checking Interface: '{0}'" -f $provide);
foreach ($child in $children)
{
Log-Info ("Importing Ek: '{0}'" -f $child);
$null = RecursivelyImportProducts $child $importedEntityKinds;
}
}
}
function Import-EntityKind([Type] $entityType)
{
Log-Info ("Importing {0}" -f $entityType.FullName);
$instance = New-Object $entityType;
Contract-Assert (!!$instance)
$entityKind = CreateOrGetEntityKind $entityType.FullName;
$entityKind.Parameters = $instance.GetStateMachine().ToString();
$null = $svc.Core.UpdateObject($entityKind);
$null = $svc.Core.SaveChanges();
Log-Info ".. Importing DataTypes";
$null = Import-DataType -FQCN $entityType.FullName -svc $svc -RecreateIfExist -Confirm:$false;
$null = $Svc.Core.SaveChanges();
Log-Info ".. Importing Connectors";
$nul = CreateOrUpdateConnectors $entityKind $entityType;
$null = $Svc.Core.SaveChanges();
Log-Info ".. Importing ProductAttribute";
$null = HandleAppclusiveProductAttribute $entityKind $entityType;
$null = $Svc.Core.SaveChanges();
Log-Info ".. Importing Icon";
$null = HandleIconAttribute $entityKind $entityType;
$null = $Svc.Core.SaveChanges();
Log-Info ".. Importing Permissions";
$null = CreatePermissionsForEntityKindStateTransisitons $instance $entityKind;
$null = $Svc.Core.SaveChanges();
}
function CreateOrUpdateConnectors([biz.dfch.CS.Appclusive.Api.Core.EntityKind] $entityKind, [Type] $entityKindType)
{
$existingConnectors = $svc.Core.Connectors.AddQueryOption('$filter', ("EntityKindId eq {0}" -f $entityKind.Id)) | Select;
$shouldConnectors = $entityKindType.GetCustomAttributes([biz.dfch.CS.Appclusive.Public.Configuration.InterfaceBaseAttribute], $true);
$finalConnectors = New-Object System.Collections.ArrayList($null);
Log-Info "... Adding Connectors";
foreach ($shouldConnector in $shouldConnectors)
{
$interface = GetInterfaceIdByName $shouldConnector.Name;
$existingConnector = $existingConnectors | where { $_.InterfaceId -eq $interface.Id -and $_.ConnectionType -eq $shouldConnector.ConnectorType };
if (-not $existingConnector)
{
$existingConnector = New-Object biz.dfch.CS.Appclusive.Api.Core.Connector;
$null = $svc.Core.AddToConnectors($existingConnector);
$existingConnector.Name = "{0}_{1}::{2}" -f $entityKind.Id, $interface.Id, $shouldConnector.ConnectorType;
$existingConnector.InterfaceId = $interface.Id;
$existingConnector.EntityKindId = $entityKind.Id;
$existingConnector.ConnectionType = $shouldConnector.ConnectorType;
}
$existingConnector.Multiplicity = $shouldConnector.Multiplicity;
$null = $svc.Core.UpdateObject($existingConnector);
$null = $finalConnectors.Add($existingConnector);
}
Log-Info "... Removing Connectors";
foreach ($existingConnector in $existingConnectors)
{
$match = $finalConnectors | where { $_.InterfaceId -eq $existingConnector.InterfaceId -and $_.ConnectionType -eq $existingConnector.ConnectionType };
if (-not $match)
{
# Write-Host ($existingConnector | out-string);
# TODO FIX:
#
# "lang":"en-US","value":"[ActivityID: 00000000-0000-0000-0000-000000000000] Assertion failed: EntityKindManager.GetEntityKindId<TEntity>()"
#
# $null = $svc.Core.DeleteObject($existingConnector);
}
}
$null = $svc.Core.SaveChanges();
return $finalConnectors;
}
function CreatePermission([string] $PermissionName, $Svc)
{
$permission = $Svc.Core.Permissions.AddQueryOption('$filter', ("Name eq '{0}'" -f $PermissionName)) | Select -First 1;
if (-not $permission)
{
Log-Info $PermissionName;
$permission = New-Object biz.dfch.CS.Appclusive.Api.Core.Permission;
$null = $Svc.Core.AddToPermissions($permission);
$permission.Name = $PermissionName;
$permission.Description = $PermissionName;
$Svc.Core.UpdateObject($permission);
$null = $Svc.Core.SaveChanges();
Log-Info " Created";
}
else
{
Log-Info ("{0} already exists" -f $PermissionName);
}
}
function CreatePermissionsForEntityKindStateTransisitons([biz.dfch.CS.Appclusive.Public.Configuration.IEntityKindBaseDto] $instance, [biz.dfch.CS.Appclusive.Api.Core.EntityKind] $entityKind)
{
$null = CreatePermission -PermissionName ("{0}:*" -f $entityKind.Name) -Svc $svc;
foreach ($transition in $instance.GetStateMachine())
{
$null = CreatePermission -PermissionName ("{0}:{1}" -f $entityKind.Name, $transition.Transition) -Svc $svc;
}
}
function CreateOrGetEntityKind([Type] $entityType)
{
$entityKind = $svc.Core.EntityKinds.AddQueryOption('$filter', "Version eq '{0}'" -f $entityType.FullName) | Select -First 1;
if (-not $entityKind)
{
$entityKind = New-Object biz.dfch.CS.Appclusive.Api.Core.EntityKind;
$null = $svc.Core.AddToEntityKinds($entityKind);
$entityKind.Name = ("{0}.{1}" -f $entityType.Namespace.Substring(0, $entityType.Namespace.LastIndexOf(".")), $entityType.Name);
$entityKind.Version = $entityType.FullName;
$svc.Core.UpdateObject($entityKind);
$null = $Svc.Core.SaveChanges();
}
return $entityKind;
}
function GetInterfaceIdByName([string] $name)
{
$interface = $svc.Core.Interfaces.AddQueryOption('$filter', ("Name eq '{0}'" -f $name)).AddQueryOption('$top', 1L) | SELECT;
if (-not $interface)
{
$interface = Set-ApcInterface -Name $name -svc $svc -CreateIfNotExist;
}
return $interface;
}
function HandleAppclusiveProductAttribute([biz.dfch.CS.Appclusive.Api.Core.EntityKind] $entityKind, [Type] $entityKindType)
{
$appclusiveProduct = $entityKindType.GetCustomAttributes([biz.dfch.CS.Appclusive.Public.Configuration.AppclusiveProductAttribute], $true);
if ($appclusiveProduct)
{
$name = $appclusiveProduct.DisplayName;
$product = $svc.Core.Products.AddQueryOption('$filter', ("EntityKindId eq {0} and Name eq '{1}'" -f $entityKind.Id,$name)).AddQueryOption('$top', 1) | SELECT;
if (-not $product)
{
$product = New-Object biz.dfch.CS.Appclusive.Api.Core.Product;
$product.Name = $name;
$product.EntityKindId = $entityKind.Id;
$product.ValidFrom = [System.DateTimeOffset]::MinValue;
$product.ValidUntil = [System.DateTimeOffset]::MaxValue;
$product.EndOfLife = [System.DateTimeOffset]::MaxValue;
# DFTODO : Get Type from Product
$product.Type = "Product";
}
}
}
function HandleIconAttribute([biz.dfch.CS.Appclusive.Api.Core.EntityKind] $entityKind, [Type] $entityKindType)
{
$IconAttribute = $entityKindType.GetCustomAttributes([biz.dfch.CS.Appclusive.Public.Configuration.IconAttribute], $true);
if ($IconAttribute)
{
$key = $entityKind.Version;
$name = ("Icon-{0}" -f $IconAttribute.Type);
$value = ("picto-{0}" -f $IconAttribute.Name);
# $null = Set-ApcKeyNameValue -Key $key -Name $name -Value $value -svc $svc -CreateIfNotExist;
}
}
function GetPossibleImports([Type] $entityKindType)
{
$list = New-Object System.Collections.ArrayList($null);
$types = $entityKindType.Assembly.GetTypes();
$baseEntityKindInterface = [biz.dfch.CS.Appclusive.Public.Configuration.IEntityKindBaseDto];
foreach ($type in $types)
{
$isOfEntityKindBaseDtoType = $baseEntityKindInterface.IsAssignableFrom($type);
if ($isOfEntityKindBaseDtoType -and -not $type.IsAbstract)
{
$null = $list.Add($type);
}
}
return $list;
}
function RequiresInterface([System.Collections.ArrayList] $types, [string] $interfaceName, [System.Collections.ArrayList] $except)
{
$list = New-Object System.Collections.ArrayList($null);
foreach ($type in $types)
{
$isExcepted = $except.Contains($type);
if ($isExcepted)
{
continue;
}
$attributes = $type.GetCustomAttributes([biz.dfch.CS.Appclusive.Public.Configuration.RequireInterfaceAttribute], $true);
$requires = $false;
foreach ($attribute in $attributes)
{
if ($attribute.Name -eq $interfaceName)
{
$requires = $true;
}
}
if ($requires)
{
$null = $list.Add($type);
}
}
return $list;
}
#
# Copyright 2015-2016 d-fens GmbH
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
|
PowerShellCorpus/PowerShellGallery/biz.dfch.PS.Appclusive.Client/5.2.1.20161201/Get-User.ps1
|
Get-User.ps1
|
function Get-User {
<#
.SYNOPSIS
Retrieves one or more entities from the User entity set.
.DESCRIPTION
Retrieves one or more entities from the User entity set.
You can retrieve one ore more entities from the entity set by specifying
Id, Name or other properties.
.INPUTS
The Cmdlet can either return all available entities or filter entities on
specified conditions.
See PARAMETERS section on possible inputs.
.OUTPUTS
default | json | json-pretty | xml | xml-pretty
In addition output can be filtered on specified properties.
.EXAMPLE
Get-User -ListAvailable -Select Name, Id, ExternalId, Mail
Name Id ExternalId Mail
---- -- ---------- ----
Administrator 2 5ab3f3cf-d37e-4714-807b-5bfe14a1e51c Administrator@appclusive.net
User1 3 e67a2c50-b98b-4f25-be52-16ac1926234b User1@appclusive.net
...
Retrieves the Name, Id, ExternalId and Mail property of all Users.
.EXAMPLE
Get-User 2
ExternalId : 27af9d74-388b-46f2-90d6-a1545d89d16f
ExternalType : AuthenticationFilter
Mail : Administrator@appclusive.net
Id : 2
Tid : 22222222-2222-2222-2222-222222222222
Name : Administrator
Description : {"Tel":"+41-41-000 00 00"}
CreatedById : 1
ModifiedById : 2
Created : 15.12.2015 00:00:00 +01:00
Modified : 17.12.2015 00:00:00 +01:00
RowVersion : {0, 0, 0, 0...}
Tenant :
CreatedBy : SYSTEM
ModifiedBy : SYSTEM
Retrieves the User object with Id 2 and returns all properties of it.
.EXAMPLE
Get-User 2 -Select Description -ValueOnly -ConvertFromJson
Tel
---
+41-41-000 00 00
Similar to the previous example, but only returns the 'Description' property
of it. In addition the contents of the property will be converted from JSON.
.EXAMPLE
Get-User -ListAvailable -Select Id -First 3
Id
--
2
3
4
Retrieves the id of the first 3 Users.
.EXAMPLE
Get-User 2 -Select Name -ValueOnly
Administrator
Retrieves the name of the User with Id 2.
.EXAMPLE
Get-User -ModifiedBy Administrator -Select Id, Name
Id Name
-- ----
2 Administrator
3 User1
Retrieves id and name of all Users that have been modified by user
with name 'Administrator' (case insensitive substring match).
.EXAMPLE
Get-User SuperUser -Select Name -ValueOnly -DefaultValue 'Administrator'
Administrator
Retrieves the 'Name' property of a User with Name 'SuperUser'
and Administrator if the entity is not found.
.EXAMPLE
# Retrieves information about the currently logged in user
PS > Get-User -Current
ExternalId : schnittenfittich
ExternalType : Integrated
Mail : schnittenfittich@appclusive.net
Id : 42
Tid : f2de53c1-62d0-4c15-8626-dac575f857a1
Name : schnittenfittich
Description : schnittenfittich
CreatedById : 1
ModifiedById : 1
Created : 6/22/2016 3:22:29 PM +02:00
Modified : 6/22/2016 3:22:29 PM +02:00
RowVersion : {0, 0, 0, 0...}
Tenant :
CreatedBy :
ModifiedBy :
.EXAMPLE
# Retrieves tenant information about the currently logged in user
PS > Get-User -TenantInformation
Id : 4048fba5-b81e-4cae-b2f4-6dbb90352875
ParentId : 199a7dca-ca61-4932-ada6-6c19f4af68851
NodeId : 42
JobId : 5
CustomerId : 8
ConfigurationId : 43
BuiltInRoles : biz.dfch.CS.Appclusive.Core.Managers.BuiltInRoles
CloudAdmin : 19
CloudUser : 20
CloudGuest : 21
CreatorOwner : 18
Everyone : 17
AppclusiveEveryone : 7
.EXAMPLE
# Retrieves the name of the currently logged in user
PS > (Get-User -WhoAmi).Name
schnittenfittich
.EXAMPLE
# Gets information about the tenant of the currently logged in user
PS > $tenantInformation = Get-User -TenantInformation;
PS > $tenantInformation
Id : e3c70408-9da0-45f2-ab7b-29d1081e948a
ParentId : d9c2feda-f3da-488a-8dd3-3747e40b6c6a
NodeId : 42
JobId : 123
CustomerId : 5
ConfigurationId : 43
BuiltInRoles : biz.dfch.CS.Appclusive.Core.Managers.BuiltInRoles
PS > $tenantInformation.BuiltInRoles
CloudAdmin : 14
CloudUser : 15
CloudGuest : 16
CreatorOwner : 12
Everyone : 13
AppclusiveEveryone : 5
.LINK
Online Version: http://dfch.biz/biz/dfch/PS/Appclusive/Client/Get-User/
.NOTES
See module manifest for required software versions and dependencies.
#>
[CmdletBinding(
SupportsShouldProcess = $true
,
ConfirmImpact = 'Low'
,
HelpURI = 'http://dfch.biz/biz/dfch/PS/Appclusive/Client/Get-User/'
,
DefaultParameterSetName = 'list'
)]
PARAM
(
# Specifies the id of the entity
[Parameter(Mandatory = $false, Position = 0, ParameterSetName = 'id')]
[long] $Id
,
# Specifies the name of the entity
[Parameter(Mandatory = $false, Position = 0, ParameterSetName = 'name')]
[Alias('n')]
[string] $Name
,
# Filter by creator
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[string] $CreatedBy
,
# Filter by modifier
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[string] $ModifiedBy
,
# Specify the attributes of the entity to return
[Parameter(Mandatory = $false)]
[string[]] $Select = @()
,
# Specifies to return only values without header information.
# This parameter takes precendes over the 'Select' parameter.
[ValidateScript( { if(1 -eq $Select.Count -And $_) { $true; } else { throw("You must specify exactly one 'Select' property when using 'ValueOnly'."); } } )]
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[Parameter(Mandatory = $false, ParameterSetName = 'id')]
[Alias('HideTableHeaders')]
[switch] $ValueOnly
,
# This value is only returned if the regular search would have returned no results
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[Alias('default')]
$DefaultValue
,
# Specifies to deserialize JSON payloads
[ValidateScript( { if($ValueOnly -And $_) { $true; } else { throw("You must set the 'ValueOnly' switch when using 'ConvertFromJson'."); } } )]
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[Parameter(Mandatory = $false, ParameterSetName = 'id')]
[Alias('Convert')]
[switch] $ConvertFromJson
,
# Limits the output to the specified number of entries
[Parameter(Mandatory = $false)]
[Alias('top')]
[int] $First
,
# Service reference to Appclusive
[Parameter(Mandatory = $false)]
[Alias('Services')]
[hashtable] $svc = (Get-Variable -Name $MyInvocation.MyCommand.Module.PrivateData.MODULEVAR -ValueOnly).Services
,
# Indicates to return all file information
[Parameter(Mandatory = $false, ParameterSetName = 'list')]
[switch] $ListAvailable
,
# Specifies the return format of the Cmdlet
[ValidateSet('default', 'json', 'json-pretty', 'xml', 'xml-pretty')]
[Parameter(Mandatory = $false)]
[alias('ReturnFormat')]
[string] $As = 'default'
,
# Specifies to retrieve information about the currently logged in user
[Parameter(Mandatory = $false, ParameterSetName = 'current')]
[alias('WhoAmI')]
[alias('CurrentUser')]
[switch] $Current = $false
,
# Specifies to retrieve information about the currently logged in user
[Parameter(Mandatory = $false, ParameterSetName = 'tenant')]
[alias('Tenant')]
[switch] $TenantInformation = $false
)
Begin
{
trap { Log-Exception $_; break; }
$datBegin = [datetime]::Now;
[string] $fn = $MyInvocation.MyCommand.Name;
Log-Debug -fn $fn -msg ("CALL. svc '{0}'. Name '{1}'." -f ($svc -is [Object]), $Name) -fac 1;
$EntitySetName = 'Users';
# Parameter validation
Contract-Requires ($svc.Core -is [biz.dfch.CS.Appclusive.Api.Core.Core]) "Connect to the server before using the Cmdlet"
if($Select)
{
$Select = $Select | Select -Unique;
}
}
# Begin
Process
{
trap { Log-Exception $_; break; }
# Default test variable for checking function response codes.
[Boolean] $fReturn = $false;
# Return values are always and only returned via OutputParameter.
$OutputParameter = $null;
Contract-Assert ($PSCmdlet.ShouldProcess(($PSBoundParameters | Out-String)))
if($PSCmdlet.ParameterSetName -eq 'list')
{
if($Select)
{
if($PSBoundParameters.ContainsKey('First'))
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$orderby','Name').AddQueryOption('$top', $First) | Select -Property $Select;
}
else
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$orderby','Name') | Select -Property $Select;
}
}
else
{
if($PSBoundParameters.ContainsKey('First'))
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$orderby','Name').AddQueryOption('$top', $First) | Select;
}
else
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$orderby','Name') | Select;
}
}
}
elseif($PSCmdlet.ParameterSetName -eq 'current')
{
$Response = $svc.Core.InvokeEntitySetActionWithSingleResult("Users", "Current", [biz.dfch.CS.Appclusive.Api.Core.User], $null);
Contract-Assert (!!$Response);
}
elseif($PSCmdlet.ParameterSetName -eq 'tenant')
{
$Response = Get-Tenant -svc $svc -Current;
Contract-Assert (!!$Response);
}
else
{
$Exp = @();
if($PSCmdlet.ParameterSetName -eq 'id')
{
$Exp += ("Id eq {0}" -f $Id);
}
if($Name)
{
$Exp += ("tolower(Name) eq '{0}'" -f $Name.ToLower());
}
if($CreatedBy)
{
$CreatedById = Get-User -svc $svc -Name $CreatedBy -Select Id -ValueOnly;
if ( !$CreatedById )
{
# User not found
throw($gotoSuccess);
}
$Exp += ("(CreatedById eq {0})" -f $CreatedById);
}
if($ModifiedBy)
{
$ModifiedById = Get-User -svc $svc -Name $ModifiedBy -Select Id -ValueOnly;
if ( !$ModifiedById )
{
# User not found
throw($gotoSuccess);
}
$Exp += ("(ModifiedById eq {0})" -f $ModifiedById);
}
$FilterExpression = [String]::Join(' and ', $Exp);
if($Select)
{
if($PSBoundParameters.ContainsKey('First'))
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$filter', $FilterExpression).AddQueryOption('$top', $First) | Select -Property $Select;
}
else
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$filter', $FilterExpression) | Select -Property $Select;
}
}
else
{
if($PSBoundParameters.ContainsKey('First'))
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$filter', $FilterExpression).AddQueryOption('$top', $First) | Select;
}
else
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$filter', $FilterExpression) | Select;
}
}
if(1 -eq $Select.Count -And $ValueOnly)
{
$Response = $Response.$Select;
}
if($PSBoundParameters.ContainsKey('DefaultValue') -And !$Response)
{
$Response = $DefaultValue;
}
if($ValueOnly -And $ConvertFromJson)
{
$ResponseTemp = New-Object System.Collections.ArrayList;
foreach($item in $Response)
{
try
{
$null = $ResponseTemp.Add((ConvertFrom-Json -InputObject $item));
}
catch
{
$null = $ResponseTemp.Add($item);
}
}
$Response = $ResponseTemp.ToArray();
}
}
$OutputParameter = Format-ResultAs $Response $As
$fReturn = $true;
}
# Process
End
{
$datEnd = [datetime]::Now;
Log-Debug -fn $fn -msg ("RET. fReturn: [{0}]. Execution time: [{1}]ms. Started: [{2}]." -f $fReturn, ($datEnd - $datBegin).TotalMilliseconds, $datBegin.ToString('yyyy-MM-dd HH:mm:ss.fffzzz')) -fac 2;
# Return values are always and only returned via OutputParameter.
return $OutputParameter;
}
# End
} # function
if($MyInvocation.ScriptName) { Export-ModuleMember -Function Get-User; }
#
# Copyright 2014-2015 d-fens GmbH
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SIG # Begin signature block
# MIIXDwYJKoZIhvcNAQcCoIIXADCCFvwCAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB
# gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR
# AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQUeN+oKsnHkv2IfWnfg4s+Adr+
# +kegghHCMIIEFDCCAvygAwIBAgILBAAAAAABL07hUtcwDQYJKoZIhvcNAQEFBQAw
# VzELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNV
# BAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkdsb2JhbFNpZ24gUm9vdCBDQTAeFw0xMTA0
# MTMxMDAwMDBaFw0yODAxMjgxMjAwMDBaMFIxCzAJBgNVBAYTAkJFMRkwFwYDVQQK
# ExBHbG9iYWxTaWduIG52LXNhMSgwJgYDVQQDEx9HbG9iYWxTaWduIFRpbWVzdGFt
# cGluZyBDQSAtIEcyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAlO9l
# +LVXn6BTDTQG6wkft0cYasvwW+T/J6U00feJGr+esc0SQW5m1IGghYtkWkYvmaCN
# d7HivFzdItdqZ9C76Mp03otPDbBS5ZBb60cO8eefnAuQZT4XljBFcm05oRc2yrmg
# jBtPCBn2gTGtYRakYua0QJ7D/PuV9vu1LpWBmODvxevYAll4d/eq41JrUJEpxfz3
# zZNl0mBhIvIG+zLdFlH6Dv2KMPAXCae78wSuq5DnbN96qfTvxGInX2+ZbTh0qhGL
# 2t/HFEzphbLswn1KJo/nVrqm4M+SU4B09APsaLJgvIQgAIMboe60dAXBKY5i0Eex
# +vBTzBj5Ljv5cH60JQIDAQABo4HlMIHiMA4GA1UdDwEB/wQEAwIBBjASBgNVHRMB
# Af8ECDAGAQH/AgEAMB0GA1UdDgQWBBRG2D7/3OO+/4Pm9IWbsN1q1hSpwTBHBgNV
# HSAEQDA+MDwGBFUdIAAwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93d3cuZ2xvYmFs
# c2lnbi5jb20vcmVwb3NpdG9yeS8wMwYDVR0fBCwwKjAooCagJIYiaHR0cDovL2Ny
# bC5nbG9iYWxzaWduLm5ldC9yb290LmNybDAfBgNVHSMEGDAWgBRge2YaRQ2XyolQ
# L30EzTSo//z9SzANBgkqhkiG9w0BAQUFAAOCAQEATl5WkB5GtNlJMfO7FzkoG8IW
# 3f1B3AkFBJtvsqKa1pkuQJkAVbXqP6UgdtOGNNQXzFU6x4Lu76i6vNgGnxVQ380W
# e1I6AtcZGv2v8Hhc4EvFGN86JB7arLipWAQCBzDbsBJe/jG+8ARI9PBw+DpeVoPP
# PfsNvPTF7ZedudTbpSeE4zibi6c1hkQgpDttpGoLoYP9KOva7yj2zIhd+wo7AKvg
# IeviLzVsD440RZfroveZMzV+y5qKu0VN5z+fwtmK+mWybsd+Zf/okuEsMaL3sCc2
# SI8mbzvuTXYfecPlf5Y1vC0OzAGwjn//UYCAp5LUs0RGZIyHTxZjBzFLY7Df8zCC
# BCkwggMRoAMCAQICCwQAAAAAATGJxjfoMA0GCSqGSIb3DQEBCwUAMEwxIDAeBgNV
# BAsTF0dsb2JhbFNpZ24gUm9vdCBDQSAtIFIzMRMwEQYDVQQKEwpHbG9iYWxTaWdu
# MRMwEQYDVQQDEwpHbG9iYWxTaWduMB4XDTExMDgwMjEwMDAwMFoXDTE5MDgwMjEw
# MDAwMFowWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKPv0Z8p6djTgnY8YqDS
# SdYWHvHP8NC6SEMDLacd8gE0SaQQ6WIT9BP0FoO11VdCSIYrlViH6igEdMtyEQ9h
# JuH6HGEVxyibTQuCDyYrkDqW7aTQaymc9WGI5qRXb+70cNCNF97mZnZfdB5eDFM4
# XZD03zAtGxPReZhUGks4BPQHxCMD05LL94BdqpxWBkQtQUxItC3sNZKaxpXX9c6Q
# MeJ2s2G48XVXQqw7zivIkEnotybPuwyJy9DDo2qhydXjnFMrVyb+Vpp2/WFGomDs
# KUZH8s3ggmLGBFrn7U5AXEgGfZ1f53TJnoRlDVve3NMkHLQUEeurv8QfpLqZ0BdY
# Nc0CAwEAAaOB/TCB+jAOBgNVHQ8BAf8EBAMCAQYwEgYDVR0TAQH/BAgwBgEB/wIB
# ADAdBgNVHQ4EFgQUGUq4WuRNMaUU5V7sL6Mc+oCMMmswRwYDVR0gBEAwPjA8BgRV
# HSAAMDQwMgYIKwYBBQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3Jl
# cG9zaXRvcnkvMDYGA1UdHwQvMC0wK6ApoCeGJWh0dHA6Ly9jcmwuZ2xvYmFsc2ln
# bi5uZXQvcm9vdC1yMy5jcmwwEwYDVR0lBAwwCgYIKwYBBQUHAwMwHwYDVR0jBBgw
# FoAUj/BLf6guRSSuTVD6Y5qL3uLdG7wwDQYJKoZIhvcNAQELBQADggEBAHmwaTTi
# BYf2/tRgLC+GeTQD4LEHkwyEXPnk3GzPbrXsCly6C9BoMS4/ZL0Pgmtmd4F/ximl
# F9jwiU2DJBH2bv6d4UgKKKDieySApOzCmgDXsG1szYjVFXjPE/mIpXNNwTYr3MvO
# 23580ovvL72zT006rbtibiiTxAzL2ebK4BEClAOwvT+UKFaQHlPCJ9XJPM0aYx6C
# WRW2QMqngarDVa8z0bV16AnqRwhIIvtdG/Mseml+xddaXlYzPK1X6JMlQsPSXnE7
# ShxU7alVrCgFx8RsXdw8k/ZpPIJRzhoVPV4Bc/9Aouq0rtOO+u5dbEfHQfXUVlfy
# GDcy1tTMS/Zx4HYwggSfMIIDh6ADAgECAhIRIdaZp2SXPvH4Qn7pGcxTQRQwDQYJ
# KoZIhvcNAQEFBQAwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24g
# bnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzIw
# HhcNMTYwNTI0MDAwMDAwWhcNMjcwNjI0MDAwMDAwWjBgMQswCQYDVQQGEwJTRzEf
# MB0GA1UEChMWR01PIEdsb2JhbFNpZ24gUHRlIEx0ZDEwMC4GA1UEAxMnR2xvYmFs
# U2lnbiBUU0EgZm9yIE1TIEF1dGhlbnRpY29kZSAtIEcyMIIBIjANBgkqhkiG9w0B
# AQEFAAOCAQ8AMIIBCgKCAQEAsBeuotO2BDBWHlgPse1VpNZUy9j2czrsXV6rJf02
# pfqEw2FAxUa1WVI7QqIuXxNiEKlb5nPWkiWxfSPjBrOHOg5D8NcAiVOiETFSKG5d
# QHI88gl3p0mSl9RskKB2p/243LOd8gdgLE9YmABr0xVU4Prd/4AsXximmP/Uq+yh
# RVmyLm9iXeDZGayLV5yoJivZF6UQ0kcIGnAsM4t/aIAqtaFda92NAgIpA6p8N7u7
# KU49U5OzpvqP0liTFUy5LauAo6Ml+6/3CGSwekQPXBDXX2E3qk5r09JTJZ2Cc/os
# +XKwqRk5KlD6qdA8OsroW+/1X1H0+QrZlzXeaoXmIwRCrwIDAQABo4IBXzCCAVsw
# DgYDVR0PAQH/BAQDAgeAMEwGA1UdIARFMEMwQQYJKwYBBAGgMgEeMDQwMgYIKwYB
# BQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3JlcG9zaXRvcnkvMAkG
# A1UdEwQCMAAwFgYDVR0lAQH/BAwwCgYIKwYBBQUHAwgwQgYDVR0fBDswOTA3oDWg
# M4YxaHR0cDovL2NybC5nbG9iYWxzaWduLmNvbS9ncy9nc3RpbWVzdGFtcGluZ2cy
# LmNybDBUBggrBgEFBQcBAQRIMEYwRAYIKwYBBQUHMAKGOGh0dHA6Ly9zZWN1cmUu
# Z2xvYmFsc2lnbi5jb20vY2FjZXJ0L2dzdGltZXN0YW1waW5nZzIuY3J0MB0GA1Ud
# DgQWBBTUooRKOFoYf7pPMFC9ndV6h9YJ9zAfBgNVHSMEGDAWgBRG2D7/3OO+/4Pm
# 9IWbsN1q1hSpwTANBgkqhkiG9w0BAQUFAAOCAQEAj6kakW0EpjcgDoOW3iPTa24f
# bt1kPWghIrX4RzZpjuGlRcckoiK3KQnMVFquxrzNY46zPVBI5bTMrs2SjZ4oixNK
# Eaq9o+/Tsjb8tKFyv22XY3mMRLxwL37zvN2CU6sa9uv6HJe8tjecpBwwvKu8LUc2
# 35IgA+hxxlj2dQWaNPALWVqCRDSqgOQvhPZHXZbJtsrKnbemuuRQ09Q3uLogDtDT
# kipbxFm7oW3bPM5EncE4Kq3jjb3NCXcaEL5nCgI2ZIi5sxsm7ueeYMRGqLxhM2zP
# TrmcuWrwnzf+tT1PmtNN/94gjk6Xpv2fCbxNyhh2ybBNhVDygNIdBvVYBAexGDCC
# BNYwggO+oAMCAQICEhEhDRayW4wRltP+V8mGEea62TANBgkqhkiG9w0BAQsFADBa
# MQswCQYDVQQGEwJCRTEZMBcGA1UEChMQR2xvYmFsU2lnbiBudi1zYTEwMC4GA1UE
# AxMnR2xvYmFsU2lnbiBDb2RlU2lnbmluZyBDQSAtIFNIQTI1NiAtIEcyMB4XDTE1
# MDUwNDE2NDMyMVoXDTE4MDUwNDE2NDMyMVowVTELMAkGA1UEBhMCQ0gxDDAKBgNV
# BAgTA1p1ZzEMMAoGA1UEBxMDWnVnMRQwEgYDVQQKEwtkLWZlbnMgR21iSDEUMBIG
# A1UEAxMLZC1mZW5zIEdtYkgwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB
# AQDNPSzSNPylU9jFM78Q/GjzB7N+VNqikf/use7p8mpnBZ4cf5b4qV3rqQd62rJH
# RlAsxgouCSNQrl8xxfg6/t/I02kPvrzsR4xnDgMiVCqVRAeQsWebafWdTvWmONBS
# lxJejPP8TSgXMKFaDa+2HleTycTBYSoErAZSWpQ0NqF9zBadjsJRVatQuPkTDrwL
# eWibiyOipK9fcNoQpl5ll5H9EG668YJR3fqX9o0TQTkOmxXIL3IJ0UxdpyDpLEkt
# tBG6Y5wAdpF2dQX2phrfFNVY54JOGtuBkNGMSiLFzTkBA1fOlA6ICMYjB8xIFxVv
# rN1tYojCrqYkKMOjwWQz5X8zAgMBAAGjggGZMIIBlTAOBgNVHQ8BAf8EBAMCB4Aw
# TAYDVR0gBEUwQzBBBgkrBgEEAaAyATIwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93
# d3cuZ2xvYmFsc2lnbi5jb20vcmVwb3NpdG9yeS8wCQYDVR0TBAIwADATBgNVHSUE
# DDAKBggrBgEFBQcDAzBCBgNVHR8EOzA5MDegNaAzhjFodHRwOi8vY3JsLmdsb2Jh
# bHNpZ24uY29tL2dzL2dzY29kZXNpZ25zaGEyZzIuY3JsMIGQBggrBgEFBQcBAQSB
# gzCBgDBEBggrBgEFBQcwAoY4aHR0cDovL3NlY3VyZS5nbG9iYWxzaWduLmNvbS9j
# YWNlcnQvZ3Njb2Rlc2lnbnNoYTJnMi5jcnQwOAYIKwYBBQUHMAGGLGh0dHA6Ly9v
# Y3NwMi5nbG9iYWxzaWduLmNvbS9nc2NvZGVzaWduc2hhMmcyMB0GA1UdDgQWBBTN
# GDddiIYZy9p3Z84iSIMd27rtUDAfBgNVHSMEGDAWgBQZSrha5E0xpRTlXuwvoxz6
# gIwyazANBgkqhkiG9w0BAQsFAAOCAQEAAApsOzSX1alF00fTeijB/aIthO3UB0ks
# 1Gg3xoKQC1iEQmFG/qlFLiufs52kRPN7L0a7ClNH3iQpaH5IEaUENT9cNEXdKTBG
# 8OrJS8lrDJXImgNEgtSwz0B40h7bM2Z+0DvXDvpmfyM2NwHF/nNVj7NzmczrLRqN
# 9de3tV0pgRqnIYordVcmb24CZl3bzpwzbQQy14Iz+P5Z2cnw+QaYzAuweTZxEUcJ
# bFwpM49c1LMPFJTuOKkUgY90JJ3gVTpyQxfkc7DNBnx74PlRzjFmeGC/hxQt0hvo
# eaAiBdjo/1uuCTToigVnyRH+c0T2AezTeoFb7ne3I538hWeTdU5q9jGCBLcwggSz
# AgEBMHAwWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MgISESENFrJbjBGW0/5XyYYR5rrZMAkGBSsOAwIaBQCgeDAYBgorBgEEAYI3AgEM
# MQowCKACgAChAoAAMBkGCSqGSIb3DQEJAzEMBgorBgEEAYI3AgEEMBwGCisGAQQB
# gjcCAQsxDjAMBgorBgEEAYI3AgEVMCMGCSqGSIb3DQEJBDEWBBS96MiWoI9rjhM5
# 0qAe+nNG3JxS7zANBgkqhkiG9w0BAQEFAASCAQCCSNOri/8ENoDfUvWziLjhTJO2
# OfQrOx0B07FPUsV52Nfq+s2+4nGMSKWZO5vFvGQAkezuIZVcXXypuU4qEV1rx7GM
# FY5h/8ycMyE/y126yka+lwuMdjtmlaoB2uOGqt9zi1bI5nw1NxYElsNbZCiy7oAI
# mHH4/wZtIy9v6fSK7WuRwXdQTYaSVoSeGInVvNcJimj99iGrB4PZ5WrfLs6CxBnT
# zYD53hGLYY9CDhyqgzv2B6kHkv5X8Sysazm3pkUxzYnfDAZj0W8NKG/F7lPciWVF
# agk/0etKgiYSas8AZXugvGnXVxGB3Mx1wMDYBQQWezl7pvj/ZI9RA2U/WHmEoYIC
# ojCCAp4GCSqGSIb3DQEJBjGCAo8wggKLAgEBMGgwUjELMAkGA1UEBhMCQkUxGTAX
# BgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGlt
# ZXN0YW1waW5nIENBIC0gRzICEhEh1pmnZJc+8fhCfukZzFNBFDAJBgUrDgMCGgUA
# oIH9MBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTE2
# MDgzMTE5MTY0OFowIwYJKoZIhvcNAQkEMRYEFNB1wpfKAKbMbqcUxgI7qo4znyeT
# MIGdBgsqhkiG9w0BCRACDDGBjTCBijCBhzCBhAQUY7gvq2H1g5CWlQULACScUCkz
# 7HkwbDBWpFQwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYt
# c2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzICEhEh
# 1pmnZJc+8fhCfukZzFNBFDANBgkqhkiG9w0BAQEFAASCAQBXERoCj0zJnwWiki5Q
# vaqjtAF+ExPTLHxVGqe1XjNURBxs/IOExH9nQjMEK5v72/GOurYCx3gDHn2j+jH1
# 15+WvnwBeunOYNxQEl5DDt799jU/MM6Ew1LulqTmXFh0Bs+UJ4YXaTxZcROIbfG6
# iz1I3cBuGPx2Z/yVgMRLv2/w59FKK9zoMDSAtTGvSjBjg+hlTVoAQf8vHjTkx8j2
# tR9dF0tur6xgTfBilk42bWJgMccAb1hGcCxjLLZobZxwiUIzhhutEVki2vgE242l
# NtQPy17yakpj6Q5vHy/AhyJcxuW9tz3VbtPpffqciXIlPkiUVuhPdZ+3I5J/gzOw
# VKCV
# SIG # End signature block
|
PowerShellCorpus/PowerShellGallery/biz.dfch.PS.Appclusive.Client/5.2.1.20161201/Get-KeyNameValue.ps1
|
Get-KeyNameValue.ps1
|
function Get-KeyNameValue {
<#
.SYNOPSIS
Retrieves keyed name/value pairs from the Appclusive server.
.DESCRIPTION
Retrieves keyed name/value pairs from the Appclusive server.
The K/N/V store stores arbitrary data that can be selected by either key, name, value or a combination of both. Besides specifying a selection you can furthermore define the order, the selected columns and the return format.
If you specify 'object' as output type then all filter options such as 'Select' are ignored.
.OUTPUTS
default | json | json-pretty | xml | xml-pretty
.INPUTS
You basically specify key, name and value to be retrieved. If one or more of these parameters are omitted all entities are returned that match these criteria.
If you specify 'object' as output type then all filter options such as 'Select' are ignored.
.EXAMPLE
Retrieves the first 5 entities from the entity set. Not specifing Key, Name or Value is the same as you would specify the 'ListAvailable' parameter.
Get-KeyNameValue | Select -First 5
Key Name Value
--- ---- -----
com.acme.infrastructure.inventory ApplicationSystem Application Server
com.acme.infrastructure.inventory ApplicationSystem Exchange
com.acme.infrastructure.inventory ApplicationSystem Other
com.acme.infrastructure.inventory ApplicationSystem Print Server
com.acme.infrastructure.inventory ApplicationSystem Term Server
.EXAMPLE
Get-KeyNameValue biz.dfch.infrastructure.inventory
Gets all entris with Key 'biz.dfch.infrastructure.inventory'.
Key Name Value
--- ---- -----
biz.dfch.infrastructure.inventory ServerRole DEV
biz.dfch.infrastructure.inventory ServerRole INT
biz.dfch.infrastructure.inventory ServerRole PROD
biz.dfch.infrastructure.inventory ServerTier Tier 2
biz.dfch.infrastructure.inventory ServerTier Tier 3
biz.dfch.infrastructure.inventory ServerTier Tier 4
biz.dfch.infrastructure.inventory ServerTier Tier 5
biz.dfch.infrastructure.inventory ServerTier Unknown
biz.dfch.infrastructure.inventory Status Deployed
biz.dfch.infrastructure.inventory Status Disposed
.EXAMPLE
Get-KeyNameValue biz.dfch.infrastructure.inventory ServerRole
As previous example. Gets all entris with Key 'biz.dfch.infrastructure.inventory' but now also specifies Name 'ServerRole'.
Key Name Value
--- ---- -----
biz.dfch.infrastructure.inventory ServerRole DEV
biz.dfch.infrastructure.inventory ServerRole INT
biz.dfch.infrastructure.inventory ServerRole PROD
.EXAMPLE
Get-KeyNameValue biz.dfch.infrastructure.inventory ServerRole -First 2
As previous example. Gets all entris with Key 'biz.dfch.infrastructure.inventory' and Name 'ServerRole' but only return first 2 entries.
Key Name Value
--- ---- -----
biz.dfch.infrastructure.inventory ServerRole DEV
biz.dfch.infrastructure.inventory ServerRole INT
.EXAMPLE
Get-KeyNameValue biz.dfch.infrastructure.inventory -As json-pretty
As previous example. Gets all entris with Key 'biz.dfch.infrastructure.inventory' but now also specifies Name 'ServerRole' and also specify return format as 'json-pretty'.
[
{
"Key": "biz.dfch.infrastructure.inventory",
"Name": "ServerRole",
"Value": "DEV"
},
{
"Key": "biz.dfch.infrastructure.inventory",
"Name": "ServerRole",
"Value": "INT"
},
{
"Key": "biz.dfch.infrastructure.inventory",
"Name": "ServerRole",
"Value": "PROD"
}
]
.EXAMPLE
(Get-KeyNameValue ExistingKey NonExistingName -Select Value -DefaultValue "myDefaultValue").Value
myDefaultValue
.EXAMPLE
(Get-KeyNameValue biz.dfch.infrastructure.inventory ServerTier -Select Value).Value
Gets all entris with Key 'biz.dfch.infrastructure.inventory' and Name 'ServerTier' but only return the Value.
Tier 2
Tier 3
Tier 4
.EXAMPLE
Get-KeyNameValue biz.dfch.infrastructure.inventory ServerTier -ValueOnly
As previous example. Gets all entris with Key 'biz.dfch.infrastructure.inventory'
and Name 'ServerTier' but only return the Value. This example makes use of the
new 'ValueOnly' switch that facilitates the return of values only.
Tier 2
Tier 3
Tier 4
.EXAMPLE
PS > Get-KeyNameValue ConvertFromJsonTest
Key Name Value
--- ---- -----
ConvertFromJsonTest Name1 ["arr11","arr12"]
ConvertFromJsonTest Name2 ["arr21","arr22"]
ConvertFromJsonTest Name3 ["arr31","arr32"]
PS > Get-KeyNameValue ConvertFromJsonTest -ValueOnly
["arr11","arr12"]
["arr21","arr22"]
["arr31","arr32"]
PS > Get-KeyNameValue ConvertFromJsonTest -ValueOnly -Convert json
arr11
arr12
arr21
arr22
arr31
arr32
PS > Get-KeyNameValue ConvertFromJsonTest -ValueOnly -Convert json -First 1
arr11
arr12
PS > Set-KeyNameValue ConvertFromJsonTest Name20 Non-Valid-Json
PS > Set-KeyNameValue ConvertFromJsonTest Name20 Non-Valid-Json -CreateIfNotExist;
PS > Get-KeyNameValue ConvertFromJsonTest -ValueOnly
["arr11","arr12"]
["arr21","arr22"]
Non-Valid-Json
["arr31","arr32"]
PS > Get-KeyNameValue ConvertFromJsonTest -ValueOnly -Convert json -as json-pretty
[
[
"arr11",
"arr12"
],
[
"arr21",
"arr22"
],
"Non-Valid-Json",
[
"arr31",
"arr32"
]
]
This example shows how to decode JSON values while querying them from the KNV store.
When the returned data is not JSON it returned unchanged
.EXAMPLE
$r = Get-KeyNameValue SCCM.OSDOperatingSystemType -as object ; $r.GetType()
IsPublic IsSerial Name BaseType
-------- -------- ---- --------
True False KeyNameValue System.Object
PS > $r[0]
Id : 125
Key : SCCM.OSDOperatingSystemType
Name : Windows 2008 R2 STD
Value : 2008STDR2x64
CreatedBy : SERVER1\Administrator
Created : 8/16/2014 4:31:04 PM +00:00
ModifiedBy : SERVER1\Administrator
Modified : 8/16/2014 4:31:04 PM +00:00
RowVersion : {0, 0, 0, 0...}
In this example the KNV is returned as an object, so it could be piped to
another Cmdlet like 'Remove-Entity'.
Specifying 'object' as a return format overrides options like 'Select'.
.LINK
Online Version: http://dfch.biz/biz/dfch/PS/Appclusive/Client/Get-KeyNameValue/
.NOTES
See module manifest for dependencies and further requirements.
#>
[CmdletBinding(
SupportsShouldProcess = $false
,
ConfirmImpact = 'Low'
,
HelpURI='http://dfch.biz/biz/dfch/PS/Appclusive/Client/Get-KeyNameValue/'
,
DefaultParameterSetName = 'list'
)]
PARAM
(
# Specifies the Key property of the entity.
[Parameter(Mandatory = $false, Position = 0, ParameterSetName = 'name')]
[Alias("k")]
[string] $Key
,
# Specifies the Name property of the entity.
[Parameter(Mandatory = $false, Position = 1, ParameterSetName = 'name')]
[Alias('n')]
[string] $Name
,
# Specifies the Value property of the entity.
[Parameter(Mandatory = $false, Position = 2, ParameterSetName = 'name')]
[Alias("v")]
[string] $Value
,
# Specifies the order of the returned entites. You can specify more than one property (e.g. Key and Name).
[ValidateSet('Key', 'Name', 'Value')]
[Parameter(Mandatory = $false, Position = 3)]
[string[]] $OrderBy = @('Key','Name','Value')
,
# Specifies what to return from the search
[ValidateSet('Key', 'Name', 'Value')]
[Parameter(Mandatory = $false, Position = 4)]
[Alias("s")]
[Alias("Return")]
[string[]] $Select = @('Key','Name','Value')
,
# Specifies to return only values without header information.
# This parameter takes precendes over the 'Select' parameter.
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[Alias('HideTableHeaders')]
[switch] $ValueOnly
,
# Specifies to deserialize JSON payloads
[ValidateSet('json')]
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[Alias('Convert')]
[string] $ConvertFrom
,
# Limits the output to the specified number of entries
[Parameter(Mandatory = $false)]
[Alias('top')]
[int] $First
,
# This value is only returned if the regular search would have returned no results
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[Alias('default')]
$DefaultValue
,
# Specifies a references to the Appclusive endpoints
[Parameter(Mandatory = $false)]
[Alias('Services')]
[hashtable] $svc = (Get-Variable -Name $MyInvocation.MyCommand.Module.PrivateData.MODULEVAR -ValueOnly).Services
,
# Specifies to return all existing KNV entities
[Parameter(Mandatory = $false, ParameterSetName = 'list')]
[switch] $ListAvailable = $false
,
# Specifies the return format of the search
[ValidateSet('default', 'json', 'json-pretty', 'xml', 'xml-pretty', 'object')]
[Parameter(Mandatory = $false)]
[alias('ReturnFormat')]
[string] $As = 'default'
)
Begin
{
trap { Log-Exception $_; break; }
$datBegin = [datetime]::Now;
[string] $fn = $MyInvocation.MyCommand.Name;
Log-Debug -fn $fn -msg ("CALL. svc '{0}'. Name '{1}'." -f ($svc -is [Object]), $Name) -fac 1;
$EntitySetName = 'KeyNameValues';
$MaxPropertyLength = 475;
# Parameter validation
Contract-Requires ($svc.Core -is [biz.dfch.CS.Appclusive.Api.Core.Core]) "Connect to the server before using the Cmdlet"
$OrderBy = $OrderBy | Select -Unique;
$OrderByString = [string]::Join(',', $OrderBy);
$Select = $Select | Select -Unique;
if($ValueOnly)
{
if('object' -eq $As)
{
throw ("'ReturnFormat':'object' and 'ValueOnly' must not be specified at the same time." );
$e = New-CustomErrorRecord -m $msg -cat InvalidArgument -o $PSCmdlet;
$PSCmdlet.ThrowTerminatingError($e);
}
$Select = 'Value';
}
if($PSBoundParameters.ContainsKey('Select') -And 'object' -eq $As)
{
$msg = ("'ReturnFormat':'object' and 'Select' must not be specified at the same time." );
$e = New-CustomErrorRecord -m $msg -cat InvalidArgument -o $PSCmdlet;
$PSCmdlet.ThrowTerminatingError($e);
}
}
# Begin
Process
{
# Default test variable for checking function response codes.
[Boolean] $fReturn = $false;
# Return values are always and only returned via OutputParameter.
$OutputParameter = $null;
try
{
# Parameter validation
# N/A
if($PSCmdlet.ParameterSetName -eq 'list')
{
if($Select -And 'object' -ne $As)
{
if($PSBoundParameters.ContainsKey('First'))
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$orderby','Name').AddQueryOption('$top', $First) | Select -Property $Select;
}
else
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$orderby','Name') | Select -Property $Select;
}
}
else
{
if($PSBoundParameters.ContainsKey('First'))
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$orderby','Name').AddQueryOption('$top', $First) | Select;
}
else
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$orderby','Name') | Select;
}
}
}
else
{
$Exp = @();
if ($PSBoundParameters.ContainsKey('Key'))
{
if($Key.Length -lt $MaxPropertyLength)
{
$Exp += ("(tolower(Key) eq '{0}')" -f $Key.ToLower());
$KeyNameValueContents += $Key;
}
else
{
$shortenedKey = $Key.substring(0,$MaxPropertyLength);
$Exp += ("(startswith(tolower(Key), '{0}'))" -f $shortenedKey.ToLower());
$KeyNameValueContents += $Key;
}
}
if ($PSBoundParameters.ContainsKey('Name'))
{
if($Name.Length -lt $MaxPropertyLength)
{
$Exp += ("(tolower(Name) eq '{0}')" -f $Name.ToLower());
$KeyNameValueContents += $Name;
}
else
{
$shortenedName = $Name.substring(0,$MaxPropertyLength);
$Exp += ("(startswith(tolower(Name), '{0}'))" -f $shortenedName.ToLower());
$KeyNameValueContents += $Name;
}
}
if ($PSBoundParameters.ContainsKey('Value'))
{
if($Value.Length -lt $MaxPropertyLength)
{
$Exp += ("(tolower(Value) eq '{0}')" -f $Value.ToLower());
$KeyNameValueContents += $Value;
}
else
{
$shortenedValue = $Value.substring(0,$MaxPropertyLength);
$Exp += ("(startswith(tolower(Value), '{0}'))" -f $shortenedValue.ToLower());
$KeyNameValueContents += $Value;
}
}
$FilterExpression = [String]::Join(' and ', $Exp);
if($Select -And 'object' -ne $As)
{
if($PSBoundParameters.ContainsKey('First'))
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$filter', $FilterExpression).AddQueryOption('$orderby', $OrderByString).AddQueryOption('$top', $First) | Select -Property $Select;
}
else
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$filter', $FilterExpression).AddQueryOption('$orderby', $OrderByString) | Select -Property $Select;
}
}
else
{
if($PSBoundParameters.ContainsKey('First'))
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$filter', $FilterExpression).AddQueryOption('$orderby', $OrderByString).AddQueryOption('$top', $First) | Select;
}
else
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$filter', $FilterExpression).AddQueryOption('$orderby', $OrderByString) | Select;
}
}
if('Value' -eq $Select -And $ValueOnly)
{
$Response = ($Response).Value;
}
if($PSBoundParameters.ContainsKey('DefaultValue') -And !$Response)
{
$Response = $DefaultValue;
}
if('Value' -eq $Select -And $ConvertFrom)
{
$ResponseTemp = New-Object System.Collections.ArrayList;
foreach($item in $Response)
{
try
{
$null = $ResponseTemp.Add((ConvertFrom-Json -InputObject $item));
}
catch
{
$null = $ResponseTemp.Add($item);
}
}
$Response = $ResponseTemp.ToArray();
Remove-Variable ResponseTemp -Confirm:$false;
}
}
$OutputParameter = Format-ResultAs $Response $As
$fReturn = $true;
}
catch
{
if($gotoSuccess -eq $_.Exception.Message)
{
$fReturn = $true;
}
else
{
[string] $ErrorText = "catch [$($_.FullyQualifiedErrorId)]";
$ErrorText += (($_ | fl * -Force) | Out-String);
$ErrorText += (($_.Exception | fl * -Force) | Out-String);
$ErrorText += (Get-PSCallStack | Out-String);
if($_.Exception -is [System.Net.WebException])
{
Log-Critical $fn ("[WebException] Request FAILED with Status '{0}'. [{1}]." -f $_.Exception.Status, $_);
Log-Debug $fn $ErrorText -fac 3;
}
else
{
Log-Error $fn $ErrorText -fac 3;
if($gotoError -eq $_.Exception.Message)
{
Log-Error $fn $e.Exception.Message;
$PSCmdlet.ThrowTerminatingError($e);
}
elseif($gotoFailure -ne $_.Exception.Message)
{
Write-Verbose ("$fn`n$ErrorText");
}
else
{
# N/A
}
}
$fReturn = $false;
$OutputParameter = $null;
}
}
finally
{
# Clean up
# N/A
}
}
# Process
End
{
$datEnd = [datetime]::Now;
Log-Debug -fn $fn -msg ("RET. fReturn: [{0}]. Execution time: [{1}]ms. Started: [{2}]." -f $fReturn, ($datEnd - $datBegin).TotalMilliseconds, $datBegin.ToString('yyyy-MM-dd HH:mm:ss.fffzzz')) -fac 2;
# Return values are always and only returned via OutputParameter.
return $OutputParameter;
}
# End
}
if($MyInvocation.ScriptName) { Export-ModuleMember -Function Get-KeyNameValue; }
#
# Copyright 2014-2015 d-fens GmbH
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SIG # Begin signature block
# MIIXDwYJKoZIhvcNAQcCoIIXADCCFvwCAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB
# gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR
# AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQU+LDKNbPrNmpdCMqVrSnHdIzZ
# FCigghHCMIIEFDCCAvygAwIBAgILBAAAAAABL07hUtcwDQYJKoZIhvcNAQEFBQAw
# VzELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNV
# BAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkdsb2JhbFNpZ24gUm9vdCBDQTAeFw0xMTA0
# MTMxMDAwMDBaFw0yODAxMjgxMjAwMDBaMFIxCzAJBgNVBAYTAkJFMRkwFwYDVQQK
# ExBHbG9iYWxTaWduIG52LXNhMSgwJgYDVQQDEx9HbG9iYWxTaWduIFRpbWVzdGFt
# cGluZyBDQSAtIEcyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAlO9l
# +LVXn6BTDTQG6wkft0cYasvwW+T/J6U00feJGr+esc0SQW5m1IGghYtkWkYvmaCN
# d7HivFzdItdqZ9C76Mp03otPDbBS5ZBb60cO8eefnAuQZT4XljBFcm05oRc2yrmg
# jBtPCBn2gTGtYRakYua0QJ7D/PuV9vu1LpWBmODvxevYAll4d/eq41JrUJEpxfz3
# zZNl0mBhIvIG+zLdFlH6Dv2KMPAXCae78wSuq5DnbN96qfTvxGInX2+ZbTh0qhGL
# 2t/HFEzphbLswn1KJo/nVrqm4M+SU4B09APsaLJgvIQgAIMboe60dAXBKY5i0Eex
# +vBTzBj5Ljv5cH60JQIDAQABo4HlMIHiMA4GA1UdDwEB/wQEAwIBBjASBgNVHRMB
# Af8ECDAGAQH/AgEAMB0GA1UdDgQWBBRG2D7/3OO+/4Pm9IWbsN1q1hSpwTBHBgNV
# HSAEQDA+MDwGBFUdIAAwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93d3cuZ2xvYmFs
# c2lnbi5jb20vcmVwb3NpdG9yeS8wMwYDVR0fBCwwKjAooCagJIYiaHR0cDovL2Ny
# bC5nbG9iYWxzaWduLm5ldC9yb290LmNybDAfBgNVHSMEGDAWgBRge2YaRQ2XyolQ
# L30EzTSo//z9SzANBgkqhkiG9w0BAQUFAAOCAQEATl5WkB5GtNlJMfO7FzkoG8IW
# 3f1B3AkFBJtvsqKa1pkuQJkAVbXqP6UgdtOGNNQXzFU6x4Lu76i6vNgGnxVQ380W
# e1I6AtcZGv2v8Hhc4EvFGN86JB7arLipWAQCBzDbsBJe/jG+8ARI9PBw+DpeVoPP
# PfsNvPTF7ZedudTbpSeE4zibi6c1hkQgpDttpGoLoYP9KOva7yj2zIhd+wo7AKvg
# IeviLzVsD440RZfroveZMzV+y5qKu0VN5z+fwtmK+mWybsd+Zf/okuEsMaL3sCc2
# SI8mbzvuTXYfecPlf5Y1vC0OzAGwjn//UYCAp5LUs0RGZIyHTxZjBzFLY7Df8zCC
# BCkwggMRoAMCAQICCwQAAAAAATGJxjfoMA0GCSqGSIb3DQEBCwUAMEwxIDAeBgNV
# BAsTF0dsb2JhbFNpZ24gUm9vdCBDQSAtIFIzMRMwEQYDVQQKEwpHbG9iYWxTaWdu
# MRMwEQYDVQQDEwpHbG9iYWxTaWduMB4XDTExMDgwMjEwMDAwMFoXDTE5MDgwMjEw
# MDAwMFowWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKPv0Z8p6djTgnY8YqDS
# SdYWHvHP8NC6SEMDLacd8gE0SaQQ6WIT9BP0FoO11VdCSIYrlViH6igEdMtyEQ9h
# JuH6HGEVxyibTQuCDyYrkDqW7aTQaymc9WGI5qRXb+70cNCNF97mZnZfdB5eDFM4
# XZD03zAtGxPReZhUGks4BPQHxCMD05LL94BdqpxWBkQtQUxItC3sNZKaxpXX9c6Q
# MeJ2s2G48XVXQqw7zivIkEnotybPuwyJy9DDo2qhydXjnFMrVyb+Vpp2/WFGomDs
# KUZH8s3ggmLGBFrn7U5AXEgGfZ1f53TJnoRlDVve3NMkHLQUEeurv8QfpLqZ0BdY
# Nc0CAwEAAaOB/TCB+jAOBgNVHQ8BAf8EBAMCAQYwEgYDVR0TAQH/BAgwBgEB/wIB
# ADAdBgNVHQ4EFgQUGUq4WuRNMaUU5V7sL6Mc+oCMMmswRwYDVR0gBEAwPjA8BgRV
# HSAAMDQwMgYIKwYBBQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3Jl
# cG9zaXRvcnkvMDYGA1UdHwQvMC0wK6ApoCeGJWh0dHA6Ly9jcmwuZ2xvYmFsc2ln
# bi5uZXQvcm9vdC1yMy5jcmwwEwYDVR0lBAwwCgYIKwYBBQUHAwMwHwYDVR0jBBgw
# FoAUj/BLf6guRSSuTVD6Y5qL3uLdG7wwDQYJKoZIhvcNAQELBQADggEBAHmwaTTi
# BYf2/tRgLC+GeTQD4LEHkwyEXPnk3GzPbrXsCly6C9BoMS4/ZL0Pgmtmd4F/ximl
# F9jwiU2DJBH2bv6d4UgKKKDieySApOzCmgDXsG1szYjVFXjPE/mIpXNNwTYr3MvO
# 23580ovvL72zT006rbtibiiTxAzL2ebK4BEClAOwvT+UKFaQHlPCJ9XJPM0aYx6C
# WRW2QMqngarDVa8z0bV16AnqRwhIIvtdG/Mseml+xddaXlYzPK1X6JMlQsPSXnE7
# ShxU7alVrCgFx8RsXdw8k/ZpPIJRzhoVPV4Bc/9Aouq0rtOO+u5dbEfHQfXUVlfy
# GDcy1tTMS/Zx4HYwggSfMIIDh6ADAgECAhIRIdaZp2SXPvH4Qn7pGcxTQRQwDQYJ
# KoZIhvcNAQEFBQAwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24g
# bnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzIw
# HhcNMTYwNTI0MDAwMDAwWhcNMjcwNjI0MDAwMDAwWjBgMQswCQYDVQQGEwJTRzEf
# MB0GA1UEChMWR01PIEdsb2JhbFNpZ24gUHRlIEx0ZDEwMC4GA1UEAxMnR2xvYmFs
# U2lnbiBUU0EgZm9yIE1TIEF1dGhlbnRpY29kZSAtIEcyMIIBIjANBgkqhkiG9w0B
# AQEFAAOCAQ8AMIIBCgKCAQEAsBeuotO2BDBWHlgPse1VpNZUy9j2czrsXV6rJf02
# pfqEw2FAxUa1WVI7QqIuXxNiEKlb5nPWkiWxfSPjBrOHOg5D8NcAiVOiETFSKG5d
# QHI88gl3p0mSl9RskKB2p/243LOd8gdgLE9YmABr0xVU4Prd/4AsXximmP/Uq+yh
# RVmyLm9iXeDZGayLV5yoJivZF6UQ0kcIGnAsM4t/aIAqtaFda92NAgIpA6p8N7u7
# KU49U5OzpvqP0liTFUy5LauAo6Ml+6/3CGSwekQPXBDXX2E3qk5r09JTJZ2Cc/os
# +XKwqRk5KlD6qdA8OsroW+/1X1H0+QrZlzXeaoXmIwRCrwIDAQABo4IBXzCCAVsw
# DgYDVR0PAQH/BAQDAgeAMEwGA1UdIARFMEMwQQYJKwYBBAGgMgEeMDQwMgYIKwYB
# BQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3JlcG9zaXRvcnkvMAkG
# A1UdEwQCMAAwFgYDVR0lAQH/BAwwCgYIKwYBBQUHAwgwQgYDVR0fBDswOTA3oDWg
# M4YxaHR0cDovL2NybC5nbG9iYWxzaWduLmNvbS9ncy9nc3RpbWVzdGFtcGluZ2cy
# LmNybDBUBggrBgEFBQcBAQRIMEYwRAYIKwYBBQUHMAKGOGh0dHA6Ly9zZWN1cmUu
# Z2xvYmFsc2lnbi5jb20vY2FjZXJ0L2dzdGltZXN0YW1waW5nZzIuY3J0MB0GA1Ud
# DgQWBBTUooRKOFoYf7pPMFC9ndV6h9YJ9zAfBgNVHSMEGDAWgBRG2D7/3OO+/4Pm
# 9IWbsN1q1hSpwTANBgkqhkiG9w0BAQUFAAOCAQEAj6kakW0EpjcgDoOW3iPTa24f
# bt1kPWghIrX4RzZpjuGlRcckoiK3KQnMVFquxrzNY46zPVBI5bTMrs2SjZ4oixNK
# Eaq9o+/Tsjb8tKFyv22XY3mMRLxwL37zvN2CU6sa9uv6HJe8tjecpBwwvKu8LUc2
# 35IgA+hxxlj2dQWaNPALWVqCRDSqgOQvhPZHXZbJtsrKnbemuuRQ09Q3uLogDtDT
# kipbxFm7oW3bPM5EncE4Kq3jjb3NCXcaEL5nCgI2ZIi5sxsm7ueeYMRGqLxhM2zP
# TrmcuWrwnzf+tT1PmtNN/94gjk6Xpv2fCbxNyhh2ybBNhVDygNIdBvVYBAexGDCC
# BNYwggO+oAMCAQICEhEhDRayW4wRltP+V8mGEea62TANBgkqhkiG9w0BAQsFADBa
# MQswCQYDVQQGEwJCRTEZMBcGA1UEChMQR2xvYmFsU2lnbiBudi1zYTEwMC4GA1UE
# AxMnR2xvYmFsU2lnbiBDb2RlU2lnbmluZyBDQSAtIFNIQTI1NiAtIEcyMB4XDTE1
# MDUwNDE2NDMyMVoXDTE4MDUwNDE2NDMyMVowVTELMAkGA1UEBhMCQ0gxDDAKBgNV
# BAgTA1p1ZzEMMAoGA1UEBxMDWnVnMRQwEgYDVQQKEwtkLWZlbnMgR21iSDEUMBIG
# A1UEAxMLZC1mZW5zIEdtYkgwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB
# AQDNPSzSNPylU9jFM78Q/GjzB7N+VNqikf/use7p8mpnBZ4cf5b4qV3rqQd62rJH
# RlAsxgouCSNQrl8xxfg6/t/I02kPvrzsR4xnDgMiVCqVRAeQsWebafWdTvWmONBS
# lxJejPP8TSgXMKFaDa+2HleTycTBYSoErAZSWpQ0NqF9zBadjsJRVatQuPkTDrwL
# eWibiyOipK9fcNoQpl5ll5H9EG668YJR3fqX9o0TQTkOmxXIL3IJ0UxdpyDpLEkt
# tBG6Y5wAdpF2dQX2phrfFNVY54JOGtuBkNGMSiLFzTkBA1fOlA6ICMYjB8xIFxVv
# rN1tYojCrqYkKMOjwWQz5X8zAgMBAAGjggGZMIIBlTAOBgNVHQ8BAf8EBAMCB4Aw
# TAYDVR0gBEUwQzBBBgkrBgEEAaAyATIwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93
# d3cuZ2xvYmFsc2lnbi5jb20vcmVwb3NpdG9yeS8wCQYDVR0TBAIwADATBgNVHSUE
# DDAKBggrBgEFBQcDAzBCBgNVHR8EOzA5MDegNaAzhjFodHRwOi8vY3JsLmdsb2Jh
# bHNpZ24uY29tL2dzL2dzY29kZXNpZ25zaGEyZzIuY3JsMIGQBggrBgEFBQcBAQSB
# gzCBgDBEBggrBgEFBQcwAoY4aHR0cDovL3NlY3VyZS5nbG9iYWxzaWduLmNvbS9j
# YWNlcnQvZ3Njb2Rlc2lnbnNoYTJnMi5jcnQwOAYIKwYBBQUHMAGGLGh0dHA6Ly9v
# Y3NwMi5nbG9iYWxzaWduLmNvbS9nc2NvZGVzaWduc2hhMmcyMB0GA1UdDgQWBBTN
# GDddiIYZy9p3Z84iSIMd27rtUDAfBgNVHSMEGDAWgBQZSrha5E0xpRTlXuwvoxz6
# gIwyazANBgkqhkiG9w0BAQsFAAOCAQEAAApsOzSX1alF00fTeijB/aIthO3UB0ks
# 1Gg3xoKQC1iEQmFG/qlFLiufs52kRPN7L0a7ClNH3iQpaH5IEaUENT9cNEXdKTBG
# 8OrJS8lrDJXImgNEgtSwz0B40h7bM2Z+0DvXDvpmfyM2NwHF/nNVj7NzmczrLRqN
# 9de3tV0pgRqnIYordVcmb24CZl3bzpwzbQQy14Iz+P5Z2cnw+QaYzAuweTZxEUcJ
# bFwpM49c1LMPFJTuOKkUgY90JJ3gVTpyQxfkc7DNBnx74PlRzjFmeGC/hxQt0hvo
# eaAiBdjo/1uuCTToigVnyRH+c0T2AezTeoFb7ne3I538hWeTdU5q9jGCBLcwggSz
# AgEBMHAwWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MgISESENFrJbjBGW0/5XyYYR5rrZMAkGBSsOAwIaBQCgeDAYBgorBgEEAYI3AgEM
# MQowCKACgAChAoAAMBkGCSqGSIb3DQEJAzEMBgorBgEEAYI3AgEEMBwGCisGAQQB
# gjcCAQsxDjAMBgorBgEEAYI3AgEVMCMGCSqGSIb3DQEJBDEWBBTJkHeLhA+efWp/
# 3x41bPhzL4dcbjANBgkqhkiG9w0BAQEFAASCAQAKBJSfiHDWxh3XRMK3zq629gtm
# Clj6Dq0PnHmRL19EgWtN526F32Z6MW4zJPsiWPhi1Afr4JoKTNXkx8WllOk0lgAx
# zMSPKeaMK6bC5uuCG/riSRZN26rIkwY8wqLBbKy1k7rDX1cgAd1IyPBdAaaQOo/p
# yVdNhFhSa0nfjC8Szehy0MTdvcrHDjCRCxwCIrNQUg0lmXUf4SAf6QbfrwbN5s4a
# acHOX+Te6+mRNzyPnggtXSj9fwnlP3Ox9HEHCqLOOF9tYpOZp6otnZNRA1uFS6uO
# I5oby/ZLAgFbehzE7PtMTINGIdeXA85Wj59Z163eiB/3sxeREJcljafVvOjZoYIC
# ojCCAp4GCSqGSIb3DQEJBjGCAo8wggKLAgEBMGgwUjELMAkGA1UEBhMCQkUxGTAX
# BgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGlt
# ZXN0YW1waW5nIENBIC0gRzICEhEh1pmnZJc+8fhCfukZzFNBFDAJBgUrDgMCGgUA
# oIH9MBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTE2
# MDgzMTE5MTY0M1owIwYJKoZIhvcNAQkEMRYEFDGOXobqERN7agCqh3XATVY1QN4D
# MIGdBgsqhkiG9w0BCRACDDGBjTCBijCBhzCBhAQUY7gvq2H1g5CWlQULACScUCkz
# 7HkwbDBWpFQwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYt
# c2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzICEhEh
# 1pmnZJc+8fhCfukZzFNBFDANBgkqhkiG9w0BAQEFAASCAQAT4WTv8uF15J9d1Kyl
# YaPzVwzW7d7tAwyNDX8ffa155Dpqgbuium0rkiUf8LpGkWKczfnaUXkaVn53IIgR
# BpEGdT1atTyFH3MG/cepweH+vCE5f+5P4/kbb7xS5eio3X+ghunhPaz6VqF1Jn8w
# ibRN2uvygbnkZFv06HXvWf+osGxwfzWXvk0G8QWwZKtXIxkVb0R3zLC9GDsaEcx9
# 1B01HfQZV34pOZ2HpoxvfjoXf6uo3mX1Xcoaukc/dd5VTs7E/uJENb/EZxllADhk
# toti1RfMc1y6YtFRHlbb5f0AWSIQFQC8wH5IHQCfjeI+zfGSMsykWZtvlGPVkh1h
# UfI5
# SIG # End signature block
|
PowerShellCorpus/PowerShellGallery/biz.dfch.PS.Appclusive.Client/5.2.1.20161201/Set-ExternalNode.ps1
|
Set-ExternalNode.ps1
|
function Set-ExternalNode {
<#
.SYNOPSIS
Sets or creates a ExternalNode entry in Appclusive.
.DESCRIPTION
Sets or creates a ExternalNode entry in Appclusive.
By updating a ExternalNode entry you can specify if you want to update the Name.
.OUTPUTS
default
.EXAMPLE
Set-ExternalNode Srv01 -ExternalType com.swisscom.cms.rhel7 -CreateIfNotExist
Parameters : {}
ExternalId : 29
NodeId : 1
Id : 1442
Tid : 22222222-2222-2222-2222-222222222222
Name : Srv01
Description :
CreatedById : 60
ModifiedById : 60
Created : 05.01.2016 15:35:06 +01:00
Modified : 05.01.2016 15:35:06 +01:00
RowVersion : {0, 0, 0, 0...}
Parent :
EntityKind :
Children : {}
IncomingAssocs : {}
OutgoingAssocs : {}
Tenant :
CreatedBy :
ModifiedBy :
Create a new ExternalNode entry if it does not exists.
.EXAMPLE
Set-ExternalNode -Name Srv01 -NewName Srv02
Parameters : {}
ExternalId : 29
NodeId : 1
Id : 1442
Tid : 22222222-2222-2222-2222-222222222222
Name : Srv02
Description :
CreatedById : 60
ModifiedById : 60
Created : 05.01.2016 15:35:06 +01:00
Modified : 05.01.2016 15:35:06 +01:00
RowVersion : {0, 0, 0, 0...}
Parent :
EntityKind :
Children : {}
IncomingAssocs : {}
OutgoingAssocs : {}
Tenant :
CreatedBy :
ModifiedBy :
Update an existing ExternalNode with new name.
.LINK
Online Version: http://dfch.biz/biz/dfch/PS/Appclusive/Client/New-ExternalNode/
Set-ExternalNode: http://dfch.biz/biz/dfch/PS/Appclusive/Client/Set-ExternalNode/
.NOTES
See module manifest for dependencies and further requirements.
#>
[CmdletBinding(
SupportsShouldProcess = $false
,
ConfirmImpact = 'Low'
,
HelpURI = 'http://dfch.biz/biz/dfch/PS/Appclusive/Client/Set-ExternalNode/'
)]
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseShouldProcessForStateChangingFunctions", "")]
Param
(
# Specifies the name to modify
[Parameter(Mandatory = $true, Position = 0)]
[Alias('n')]
[string] $Name
,
# Specifies the new name name
[Parameter(Mandatory = $false)]
[string] $NewName
,
# Specifies the Parent id for this entity
[Parameter(Mandatory = $false)]
[long] $NodeId
,
# Specifies the description
[Parameter(Mandatory = $false)]
[Alias("d")]
[string] $Description
,
# Specifies the EntityKind id for this entity
[Parameter(Mandatory = $false)]
[string] $ExternalId
,
# Specifies the EntityKind name for this entity
[Parameter(Mandatory = $false)]
[string] $ExternalType
,
# Specifies the attributes for this entity
[Parameter(Mandatory = $false)]
[Alias("Parameters")]
[Alias("Bags")]
[hashtable] $Attributes = @{}
,
# Specifies to create a entity if it does not exist
[Parameter(Mandatory = $false)]
[Alias("c")]
[switch] $CreateIfNotExist = $false
,
# Service reference to Appclusive
[Parameter(Mandatory = $false)]
[Alias('Services')]
[hashtable] $svc = (Get-Variable -Name $MyInvocation.MyCommand.Module.PrivateData.MODULEVAR -ValueOnly).Services
,
# Specifies the return format of the Cmdlet
[ValidateSet('default', 'json', 'json-pretty', 'xml', 'xml-pretty')]
[Parameter(Mandatory = $false)]
[alias('ReturnFormat')]
[string] $As = 'default'
)
Begin
{
trap { Log-Exception $_; break; }
$datBegin = [datetime]::Now;
[string] $fn = $MyInvocation.MyCommand.Name;
Log-Debug -fn $fn -msg ("CALL. svc '{0}'. Name '{1}'." -f ($svc -is [Object]), $Name) -fac 1;
# Parameter validation
Contract-Requires ($svc.Core -is [biz.dfch.CS.Appclusive.Api.Core.Core]) "Connect to the server before using the Cmdlet"
Contract-Requires ($NodeId -ne $null);
Contract-Requires ($NodeId -gt 0);
Contract-Requires (![string]::IsNullOrWhiteSpace($ExternalId));
$node = Get-Node -Id $NodeId -svc $svc;
Contract-Assert (!!$node) "Node with Id = $NodeId does not exist";
$EntitySetName = 'ExternalNodes';
}
# Begin
Process
{
# Default test variable for checking function response codes.
[Boolean] $fReturn = $false;
# Return values are always and only returned via OutputParameter.
$OutputParameter = $null;
$AddedEntity = $null;
try
{
$Exp = @();
$Exp += "(tolower(Name) eq '{0}')" -f $Name.toLower();
$Exp += "(tolower(ExternalId) eq '{0}')" -f $ExternalId.toLower();
$Exp += "(NodeId eq {0})" -f $NodeId;
$FilterExpression = [String]::Join(' and ', $Exp);
$entity = $svc.Core.$EntitySetName.AddQueryOption('$filter', $FilterExpression) | Select;
if(!$CreateIfNotExist -And !$entity)
{
$msg = "Name: Parameter validation FAILED. Entity does not exist. Use '-CreateIfNotExist' to create resource: '{0}'" -f $Name;
$e = New-CustomErrorRecord -m $msg -cat ObjectNotFound -o $Name;
throw($gotoError);
}
if(!$entity)
{
$entity = New-Object biz.dfch.CS.Appclusive.Api.Core.ExternalNode;
$svc.Core.AddToExternalNodes($entity);
$AddedEntity = $entity;
$entity.Name = $Name;
$entity.Created = [System.DateTimeOffset]::Now;
$entity.Modified = $entity.Created;
$entity.CreatedById = 0;
$entity.ModifiedById = 0;
$entity.ExternalType = $ExternalType;
$entity.ExternalId = $ExternalId;
$entity.NodeId = $NodeId;
}
if($PSBoundParameters.ContainsKey('Description'))
{
$entity.Description = $Description;
}
if($NewName)
{
$entity.Name = $NewName;
}
$svc.Core.UpdateObject($entity);
$r = $svc.Core.SaveChanges();
Contract-Assert ($r.StatusCode -eq 201 -or $r.StatusCode -eq 204);
Contract-Assert ($entity.NodeId -eq $NodeId);
if($PSBoundParameters.ContainsKey('Attributes'))
{
foreach($attribute in $Attributes.Keys)
{
$Exp = @();
$Exp += "(tolower(Name) eq '{0}')" -f $attribute.toLower();
$Exp += "(ExternaldNodeId eq {0})" -f $entity.Id;
$FilterExpression = [String]::Join(' and ', $Exp);
$extAttr = $svc.Core.ExternalNodeBags.AddQueryOption('$filter', $FilterExpression) | Select;
if(!$extAttr)
{
$extAttr = New-Object biz.dfch.CS.Appclusive.Api.Core.ExternalNodeBag;
$extAttr.Name = $attribute;
$extAttr.ExternaldNodeId = $entity.Id;
$svc.Core.AddToExternalNodeBags($extAttr);
}
$extAttr.Value = $Attributes.Item($attribute);
$svc.Core.UpdateObject($extAttr);
}
$ra = $svc.Core.SaveChanges();
Contract-Assert ($ra.StatusCode.Count -eq $Attributes.Keys.Count);
for($i=0; $i -lt $Attributes.Keys.Count; $i++)
{
Contract-Assert ($ra.StatusCode[$i] -eq 201 -or $ra.StatusCode[$i] -eq 204)
Contract-Assert ($ra.Descriptor[$i].Entity.ExternaldNodeId -eq $entity.Id)
}
}
$r = $entity;
$OutputParameter = Format-ResultAs $r $As;
$fReturn = $true;
}
catch
{
if($gotoSuccess -eq $_.Exception.Message)
{
$fReturn = $true;
}
else
{
[string] $ErrorText = "catch [$($_.FullyQualifiedErrorId)]";
$ErrorText += (($_ | fl * -Force) | Out-String);
$ErrorText += (($_.Exception | fl * -Force) | Out-String);
$ErrorText += (Get-PSCallStack | Out-String);
if($_.Exception -is [System.Net.WebException])
{
Log-Critical $fn ("[WebException] Request FAILED with Status '{0}'. [{1}]." -f $_.Exception.Status, $_);
Log-Debug $fn $ErrorText -fac 3;
}
else
{
Log-Error $fn $ErrorText -fac 3;
if($gotoError -eq $_.Exception.Message)
{
Log-Error $fn $e.Exception.Message;
$PSCmdlet.ThrowTerminatingError($e);
}
elseif($gotoFailure -ne $_.Exception.Message)
{
Write-Verbose ("$fn`n$ErrorText");
}
else
{
# N/A
}
}
$fReturn = $false;
$OutputParameter = $null;
if($AddedEntity)
{
$svc.Core.DeleteObject($AddedEntity);
}
}
}
finally
{
# Clean up
# N/A
}
}
# Process
End
{
$datEnd = [datetime]::Now;
Log-Debug -fn $fn -msg ("RET. fReturn: [{0}]. Execution time: [{1}]ms. Started: [{2}]." -f $fReturn, ($datEnd - $datBegin).TotalMilliseconds, $datBegin.ToString('yyyy-MM-dd HH:mm:ss.fffzzz')) -fac 2;
# Return values are always and only returned via OutputParameter.
return $OutputParameter;
}
# End
}
if($MyInvocation.ScriptName) { Export-ModuleMember -Function Set-ExternalNode; }
#
# Copyright 2014-2015 d-fens GmbH
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SIG # Begin signature block
# MIIXDwYJKoZIhvcNAQcCoIIXADCCFvwCAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB
# gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR
# AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQU5f6Qa8bOwOHjBLNkXgwyDWT2
# IFygghHCMIIEFDCCAvygAwIBAgILBAAAAAABL07hUtcwDQYJKoZIhvcNAQEFBQAw
# VzELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNV
# BAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkdsb2JhbFNpZ24gUm9vdCBDQTAeFw0xMTA0
# MTMxMDAwMDBaFw0yODAxMjgxMjAwMDBaMFIxCzAJBgNVBAYTAkJFMRkwFwYDVQQK
# ExBHbG9iYWxTaWduIG52LXNhMSgwJgYDVQQDEx9HbG9iYWxTaWduIFRpbWVzdGFt
# cGluZyBDQSAtIEcyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAlO9l
# +LVXn6BTDTQG6wkft0cYasvwW+T/J6U00feJGr+esc0SQW5m1IGghYtkWkYvmaCN
# d7HivFzdItdqZ9C76Mp03otPDbBS5ZBb60cO8eefnAuQZT4XljBFcm05oRc2yrmg
# jBtPCBn2gTGtYRakYua0QJ7D/PuV9vu1LpWBmODvxevYAll4d/eq41JrUJEpxfz3
# zZNl0mBhIvIG+zLdFlH6Dv2KMPAXCae78wSuq5DnbN96qfTvxGInX2+ZbTh0qhGL
# 2t/HFEzphbLswn1KJo/nVrqm4M+SU4B09APsaLJgvIQgAIMboe60dAXBKY5i0Eex
# +vBTzBj5Ljv5cH60JQIDAQABo4HlMIHiMA4GA1UdDwEB/wQEAwIBBjASBgNVHRMB
# Af8ECDAGAQH/AgEAMB0GA1UdDgQWBBRG2D7/3OO+/4Pm9IWbsN1q1hSpwTBHBgNV
# HSAEQDA+MDwGBFUdIAAwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93d3cuZ2xvYmFs
# c2lnbi5jb20vcmVwb3NpdG9yeS8wMwYDVR0fBCwwKjAooCagJIYiaHR0cDovL2Ny
# bC5nbG9iYWxzaWduLm5ldC9yb290LmNybDAfBgNVHSMEGDAWgBRge2YaRQ2XyolQ
# L30EzTSo//z9SzANBgkqhkiG9w0BAQUFAAOCAQEATl5WkB5GtNlJMfO7FzkoG8IW
# 3f1B3AkFBJtvsqKa1pkuQJkAVbXqP6UgdtOGNNQXzFU6x4Lu76i6vNgGnxVQ380W
# e1I6AtcZGv2v8Hhc4EvFGN86JB7arLipWAQCBzDbsBJe/jG+8ARI9PBw+DpeVoPP
# PfsNvPTF7ZedudTbpSeE4zibi6c1hkQgpDttpGoLoYP9KOva7yj2zIhd+wo7AKvg
# IeviLzVsD440RZfroveZMzV+y5qKu0VN5z+fwtmK+mWybsd+Zf/okuEsMaL3sCc2
# SI8mbzvuTXYfecPlf5Y1vC0OzAGwjn//UYCAp5LUs0RGZIyHTxZjBzFLY7Df8zCC
# BCkwggMRoAMCAQICCwQAAAAAATGJxjfoMA0GCSqGSIb3DQEBCwUAMEwxIDAeBgNV
# BAsTF0dsb2JhbFNpZ24gUm9vdCBDQSAtIFIzMRMwEQYDVQQKEwpHbG9iYWxTaWdu
# MRMwEQYDVQQDEwpHbG9iYWxTaWduMB4XDTExMDgwMjEwMDAwMFoXDTE5MDgwMjEw
# MDAwMFowWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKPv0Z8p6djTgnY8YqDS
# SdYWHvHP8NC6SEMDLacd8gE0SaQQ6WIT9BP0FoO11VdCSIYrlViH6igEdMtyEQ9h
# JuH6HGEVxyibTQuCDyYrkDqW7aTQaymc9WGI5qRXb+70cNCNF97mZnZfdB5eDFM4
# XZD03zAtGxPReZhUGks4BPQHxCMD05LL94BdqpxWBkQtQUxItC3sNZKaxpXX9c6Q
# MeJ2s2G48XVXQqw7zivIkEnotybPuwyJy9DDo2qhydXjnFMrVyb+Vpp2/WFGomDs
# KUZH8s3ggmLGBFrn7U5AXEgGfZ1f53TJnoRlDVve3NMkHLQUEeurv8QfpLqZ0BdY
# Nc0CAwEAAaOB/TCB+jAOBgNVHQ8BAf8EBAMCAQYwEgYDVR0TAQH/BAgwBgEB/wIB
# ADAdBgNVHQ4EFgQUGUq4WuRNMaUU5V7sL6Mc+oCMMmswRwYDVR0gBEAwPjA8BgRV
# HSAAMDQwMgYIKwYBBQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3Jl
# cG9zaXRvcnkvMDYGA1UdHwQvMC0wK6ApoCeGJWh0dHA6Ly9jcmwuZ2xvYmFsc2ln
# bi5uZXQvcm9vdC1yMy5jcmwwEwYDVR0lBAwwCgYIKwYBBQUHAwMwHwYDVR0jBBgw
# FoAUj/BLf6guRSSuTVD6Y5qL3uLdG7wwDQYJKoZIhvcNAQELBQADggEBAHmwaTTi
# BYf2/tRgLC+GeTQD4LEHkwyEXPnk3GzPbrXsCly6C9BoMS4/ZL0Pgmtmd4F/ximl
# F9jwiU2DJBH2bv6d4UgKKKDieySApOzCmgDXsG1szYjVFXjPE/mIpXNNwTYr3MvO
# 23580ovvL72zT006rbtibiiTxAzL2ebK4BEClAOwvT+UKFaQHlPCJ9XJPM0aYx6C
# WRW2QMqngarDVa8z0bV16AnqRwhIIvtdG/Mseml+xddaXlYzPK1X6JMlQsPSXnE7
# ShxU7alVrCgFx8RsXdw8k/ZpPIJRzhoVPV4Bc/9Aouq0rtOO+u5dbEfHQfXUVlfy
# GDcy1tTMS/Zx4HYwggSfMIIDh6ADAgECAhIRIdaZp2SXPvH4Qn7pGcxTQRQwDQYJ
# KoZIhvcNAQEFBQAwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24g
# bnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzIw
# HhcNMTYwNTI0MDAwMDAwWhcNMjcwNjI0MDAwMDAwWjBgMQswCQYDVQQGEwJTRzEf
# MB0GA1UEChMWR01PIEdsb2JhbFNpZ24gUHRlIEx0ZDEwMC4GA1UEAxMnR2xvYmFs
# U2lnbiBUU0EgZm9yIE1TIEF1dGhlbnRpY29kZSAtIEcyMIIBIjANBgkqhkiG9w0B
# AQEFAAOCAQ8AMIIBCgKCAQEAsBeuotO2BDBWHlgPse1VpNZUy9j2czrsXV6rJf02
# pfqEw2FAxUa1WVI7QqIuXxNiEKlb5nPWkiWxfSPjBrOHOg5D8NcAiVOiETFSKG5d
# QHI88gl3p0mSl9RskKB2p/243LOd8gdgLE9YmABr0xVU4Prd/4AsXximmP/Uq+yh
# RVmyLm9iXeDZGayLV5yoJivZF6UQ0kcIGnAsM4t/aIAqtaFda92NAgIpA6p8N7u7
# KU49U5OzpvqP0liTFUy5LauAo6Ml+6/3CGSwekQPXBDXX2E3qk5r09JTJZ2Cc/os
# +XKwqRk5KlD6qdA8OsroW+/1X1H0+QrZlzXeaoXmIwRCrwIDAQABo4IBXzCCAVsw
# DgYDVR0PAQH/BAQDAgeAMEwGA1UdIARFMEMwQQYJKwYBBAGgMgEeMDQwMgYIKwYB
# BQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3JlcG9zaXRvcnkvMAkG
# A1UdEwQCMAAwFgYDVR0lAQH/BAwwCgYIKwYBBQUHAwgwQgYDVR0fBDswOTA3oDWg
# M4YxaHR0cDovL2NybC5nbG9iYWxzaWduLmNvbS9ncy9nc3RpbWVzdGFtcGluZ2cy
# LmNybDBUBggrBgEFBQcBAQRIMEYwRAYIKwYBBQUHMAKGOGh0dHA6Ly9zZWN1cmUu
# Z2xvYmFsc2lnbi5jb20vY2FjZXJ0L2dzdGltZXN0YW1waW5nZzIuY3J0MB0GA1Ud
# DgQWBBTUooRKOFoYf7pPMFC9ndV6h9YJ9zAfBgNVHSMEGDAWgBRG2D7/3OO+/4Pm
# 9IWbsN1q1hSpwTANBgkqhkiG9w0BAQUFAAOCAQEAj6kakW0EpjcgDoOW3iPTa24f
# bt1kPWghIrX4RzZpjuGlRcckoiK3KQnMVFquxrzNY46zPVBI5bTMrs2SjZ4oixNK
# Eaq9o+/Tsjb8tKFyv22XY3mMRLxwL37zvN2CU6sa9uv6HJe8tjecpBwwvKu8LUc2
# 35IgA+hxxlj2dQWaNPALWVqCRDSqgOQvhPZHXZbJtsrKnbemuuRQ09Q3uLogDtDT
# kipbxFm7oW3bPM5EncE4Kq3jjb3NCXcaEL5nCgI2ZIi5sxsm7ueeYMRGqLxhM2zP
# TrmcuWrwnzf+tT1PmtNN/94gjk6Xpv2fCbxNyhh2ybBNhVDygNIdBvVYBAexGDCC
# BNYwggO+oAMCAQICEhEhDRayW4wRltP+V8mGEea62TANBgkqhkiG9w0BAQsFADBa
# MQswCQYDVQQGEwJCRTEZMBcGA1UEChMQR2xvYmFsU2lnbiBudi1zYTEwMC4GA1UE
# AxMnR2xvYmFsU2lnbiBDb2RlU2lnbmluZyBDQSAtIFNIQTI1NiAtIEcyMB4XDTE1
# MDUwNDE2NDMyMVoXDTE4MDUwNDE2NDMyMVowVTELMAkGA1UEBhMCQ0gxDDAKBgNV
# BAgTA1p1ZzEMMAoGA1UEBxMDWnVnMRQwEgYDVQQKEwtkLWZlbnMgR21iSDEUMBIG
# A1UEAxMLZC1mZW5zIEdtYkgwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB
# AQDNPSzSNPylU9jFM78Q/GjzB7N+VNqikf/use7p8mpnBZ4cf5b4qV3rqQd62rJH
# RlAsxgouCSNQrl8xxfg6/t/I02kPvrzsR4xnDgMiVCqVRAeQsWebafWdTvWmONBS
# lxJejPP8TSgXMKFaDa+2HleTycTBYSoErAZSWpQ0NqF9zBadjsJRVatQuPkTDrwL
# eWibiyOipK9fcNoQpl5ll5H9EG668YJR3fqX9o0TQTkOmxXIL3IJ0UxdpyDpLEkt
# tBG6Y5wAdpF2dQX2phrfFNVY54JOGtuBkNGMSiLFzTkBA1fOlA6ICMYjB8xIFxVv
# rN1tYojCrqYkKMOjwWQz5X8zAgMBAAGjggGZMIIBlTAOBgNVHQ8BAf8EBAMCB4Aw
# TAYDVR0gBEUwQzBBBgkrBgEEAaAyATIwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93
# d3cuZ2xvYmFsc2lnbi5jb20vcmVwb3NpdG9yeS8wCQYDVR0TBAIwADATBgNVHSUE
# DDAKBggrBgEFBQcDAzBCBgNVHR8EOzA5MDegNaAzhjFodHRwOi8vY3JsLmdsb2Jh
# bHNpZ24uY29tL2dzL2dzY29kZXNpZ25zaGEyZzIuY3JsMIGQBggrBgEFBQcBAQSB
# gzCBgDBEBggrBgEFBQcwAoY4aHR0cDovL3NlY3VyZS5nbG9iYWxzaWduLmNvbS9j
# YWNlcnQvZ3Njb2Rlc2lnbnNoYTJnMi5jcnQwOAYIKwYBBQUHMAGGLGh0dHA6Ly9v
# Y3NwMi5nbG9iYWxzaWduLmNvbS9nc2NvZGVzaWduc2hhMmcyMB0GA1UdDgQWBBTN
# GDddiIYZy9p3Z84iSIMd27rtUDAfBgNVHSMEGDAWgBQZSrha5E0xpRTlXuwvoxz6
# gIwyazANBgkqhkiG9w0BAQsFAAOCAQEAAApsOzSX1alF00fTeijB/aIthO3UB0ks
# 1Gg3xoKQC1iEQmFG/qlFLiufs52kRPN7L0a7ClNH3iQpaH5IEaUENT9cNEXdKTBG
# 8OrJS8lrDJXImgNEgtSwz0B40h7bM2Z+0DvXDvpmfyM2NwHF/nNVj7NzmczrLRqN
# 9de3tV0pgRqnIYordVcmb24CZl3bzpwzbQQy14Iz+P5Z2cnw+QaYzAuweTZxEUcJ
# bFwpM49c1LMPFJTuOKkUgY90JJ3gVTpyQxfkc7DNBnx74PlRzjFmeGC/hxQt0hvo
# eaAiBdjo/1uuCTToigVnyRH+c0T2AezTeoFb7ne3I538hWeTdU5q9jGCBLcwggSz
# AgEBMHAwWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MgISESENFrJbjBGW0/5XyYYR5rrZMAkGBSsOAwIaBQCgeDAYBgorBgEEAYI3AgEM
# MQowCKACgAChAoAAMBkGCSqGSIb3DQEJAzEMBgorBgEEAYI3AgEEMBwGCisGAQQB
# gjcCAQsxDjAMBgorBgEEAYI3AgEVMCMGCSqGSIb3DQEJBDEWBBSr0N+ILQT5AYkE
# hDjLSPf0jCn2jTANBgkqhkiG9w0BAQEFAASCAQB5xoj4JbSkYL3FS0083yTavPoW
# R3t3sT1iivBjvDfdYFsMO0WbRgKJmxIz+lKTTTuHRoOKmausvCuG6DkjOX+cNTHd
# 6HoDHIPEW6dExBcUAn2uE2Jk+JUbpAa8o33Bi3A3xpYx2PYyncv8VW0rEV7ts22I
# qJfclQ6BugPcjZg4D8137rj1yGiLacT8rSlmEcq9f/HbB0qnHR8I2fdFFFSfa+qT
# CoBSQO/WlhU+8SrRivabfFEPXPN3Wq/OQopfmjock4D4HhjTJKUD5LXmgZCbETgT
# j8PSc7IxvmCTaZdkju6UnEU/EBx3Ei9CIoH/w65hZ950AuXzjKzOj/rZSvB5oYIC
# ojCCAp4GCSqGSIb3DQEJBjGCAo8wggKLAgEBMGgwUjELMAkGA1UEBhMCQkUxGTAX
# BgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGlt
# ZXN0YW1waW5nIENBIC0gRzICEhEh1pmnZJc+8fhCfukZzFNBFDAJBgUrDgMCGgUA
# oIH9MBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTE2
# MDgzMTE5MTcwM1owIwYJKoZIhvcNAQkEMRYEFAUbZVq/mjwxotWN2H2KMjAQhhWH
# MIGdBgsqhkiG9w0BCRACDDGBjTCBijCBhzCBhAQUY7gvq2H1g5CWlQULACScUCkz
# 7HkwbDBWpFQwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYt
# c2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzICEhEh
# 1pmnZJc+8fhCfukZzFNBFDANBgkqhkiG9w0BAQEFAASCAQCOPDxC4J1DH7qAKj/N
# KyOEZvVce29QfMUzmVIEROxUHEZf2A10SV7ppNeRSoSnS19qC9op7yBXKnJWJay9
# 5vnz2jy0IUnNP7EqfntJlZ3xeXgfXh9zIndXZ/4ghfFWXozBLkigOPav7CoJPMJb
# D0p7zEyOYx2BDukAs7Uko8H4Mpr6AeVOHoqV68+IFUwBaGriiu2S1dfYMThZCWCK
# nZI8ZUFF3uZENC3NkDJJ3A7xUo7eDrE2sx66yo1YS7slzgOMROoEM0Yg59AT7DAJ
# wHlq/DvX8xx3YHwRuRuSRBObafQupoAJpNjhBQwnBVS7Z3BsP9MGCgSgV24OJRKl
# O7vl
# SIG # End signature block
|
PowerShellCorpus/PowerShellGallery/biz.dfch.PS.Appclusive.Client/5.2.1.20161201/New-KeyNameValue.ps1
|
New-KeyNameValue.ps1
|
function New-KeyNameValue {
<#
.SYNOPSIS
Creates a K/N/V entry in Appclusive.
.DESCRIPTION
Creates a K/N/V entry in Appclusive.
You must specify all three parameters 'Key', 'Name' and 'Value'. If the entry already exists no update of the existing entry is performed.
.OUTPUTS
default | json | json-pretty | xml | xml-pretty
.EXAMPLE
New-KeyNameValue myKey myName myValue
Id : 3131
Key : myKey
Name : myName
Value : myValue
CreatedBy : SERVER1\Administrator
Created : 11/13/2014 11:08:46 PM +00:00
ModifiedBy : SERVER1\Administrator
Modified : 11/13/2014 11:08:46 PM +00:00
RowVersion : {0, 0, 0, 0...}
Create a new K/N/V entry if it not already exists.
.EXAMPLE
New-KeyNameValue -Key myKey -Name myName -Value myValue
Id : 3131
Key : myKey
Name : myName
Value : myValue
CreatedBy : SERVER1\Administrator
Created : 11/13/2014 11:08:46 PM +00:00
ModifiedBy : SERVER1\Administrator
Modified : 11/13/2014 11:08:46 PM +00:00
RowVersion : {0, 0, 0, 0...}
Create a new K/N/V entry if it not already exists.
.LINK
Online Version: http://dfch.biz/biz/dfch/PS/Appclusive/Client/New-KeyNameValue/
Set-KeyNameValue: http://dfch.biz/biz/dfch/PS/Appclusive/Client/Set-KeyNameValue/
.NOTES
See module manifest for dependencies and further requirements.
#>
[CmdletBinding(
SupportsShouldProcess = $true
,
ConfirmImpact = 'Low'
,
HelpURI='http://dfch.biz/biz/dfch/PS/Appclusive/Client/New-KeyNameValue/'
)]
Param
(
# Specifies the key to modify
[Parameter(Mandatory = $true, Position = 0)]
[ValidateNotNullOrEmpty()]
[Alias("k")]
[string] $Key
,
# Specifies the name to modify
[Parameter(Mandatory = $true, Position = 1)]
[ValidateNotNullOrEmpty()]
[Alias('n')]
[string] $Name
,
# Specifies the value to modify
[Parameter(Mandatory = $true, Position = 2)]
[ValidateNotNullOrEmpty()]
[Alias("v")]
[string] $Value
,
# Specifies the value to modify
[Parameter(Mandatory = $false)]
[string] $Description
,
# Service reference to Appclusive
[Parameter(Mandatory = $false)]
[Alias('Services')]
[hashtable] $svc = (Get-Variable -Name $MyInvocation.MyCommand.Module.PrivateData.MODULEVAR -ValueOnly).Services
,
# Specifies the return format of the Cmdlet
[ValidateSet('default', 'json', 'json-pretty', 'xml', 'xml-pretty')]
[Parameter(Mandatory = $false)]
[alias('ReturnFormat')]
[string] $As = 'default'
)
Begin
{
trap { Log-Exception $_; break; }
$datBegin = [datetime]::Now;
[string] $fn = $MyInvocation.MyCommand.Name;
Log-Debug -fn $fn -msg ("CALL. svc '{0}'. Name '{1}'." -f ($svc -is [Object]), $Name) -fac 1;
$MaxPropertyLength = 475;
# Parameter validation
Contract-Requires ($svc.Core -is [biz.dfch.CS.Appclusive.Api.Core.Core]) "Connect to the server before using the Cmdlet"
}
# Begin
Process
{
# Default test variable for checking function response codes.
[Boolean] $fReturn = $false;
# Return values are always and only returned via OutputParameter.
$OutputParameter = $null;
try
{
$Exp = @();
if($Key.Length -lt $MaxPropertyLength)
{
$Exp += ("(tolower(Key) eq '{0}')" -f $Key.ToLower());
$KeyNameValueContents += $Key;
}
else
{
$shortenedKey = $Key.substring(0,$MaxPropertyLength);
$Exp += ("(startswith(tolower(Key), '{0}'))" -f $shortenedKey.ToLower());
$KeyNameValueContents += $Key;
}
if($Name.Length -lt $MaxPropertyLength)
{
$Exp += ("(tolower(Name) eq '{0}')" -f $Name.ToLower());
$KeyNameValueContents += $Name;
}
else
{
$shortenedName = $Name.substring(0,$MaxPropertyLength);
$Exp += ("(startswith(tolower(Name), '{0}'))" -f $shortenedName.ToLower());
$KeyNameValueContents += $Name;
}
if($Value.Length -lt $MaxPropertyLength)
{
$Exp += ("(tolower(Value) eq '{0}')" -f $Value.ToLower());
$KeyNameValueContents += $Value;
}
else
{
$shortenedValue = $Value.substring(0,$MaxPropertyLength);
$Exp += ("(startswith(tolower(Value), '{0}'))" -f $shortenedValue.ToLower());
$KeyNameValueContents += $Value;
}
$FilterExpression = [String]::Join(' and ', $Exp);
$KeyNameValueContentsString = [String]::Join(',', $KeyNameValueContents);
$knv = $svc.Core.KeyNameValues.AddQueryOption('$filter', $FilterExpression).AddQueryOption('$top',1) | Select;
if($knv)
{
$msg = "Key/Name/Value: Parameter validation FAILED. Entity does already exist: '{0}'." -f $KeyNameValueContentsString;
Log-Error $fn $msg;
$e = New-CustomErrorRecord -m $msg -cat ResourceExists -o $KeyNameValueContentsString;
throw($gotoError);
}
if($PSCmdlet.ShouldProcess($KeyNameValueContents))
{
if($PSBoundParameters.ContainsKey('Description'))
{
$r = Set-KeyNameValue -Key $Key -Name $Name -Value $Value -Description $Description -CreateIfNotExist -svc $svc -As $As;
}
else
{
$r = Set-KeyNameValue -Key $Key -Name $Name -Value $Value -CreateIfNotExist -svc $svc -As $As;
}
$OutputParameter = $r;
}
$fReturn = $true;
}
catch
{
if($gotoSuccess -eq $_.Exception.Message)
{
$fReturn = $true;
}
else
{
[string] $ErrorText = "catch [$($_.FullyQualifiedErrorId)]";
$ErrorText += (($_ | fl * -Force) | Out-String);
$ErrorText += (($_.Exception | fl * -Force) | Out-String);
$ErrorText += (Get-PSCallStack | Out-String);
if($_.Exception -is [System.Net.WebException])
{
Log-Critical $fn ("[WebException] Request FAILED with Status '{0}'. [{1}]." -f $_.Exception.Status, $_);
Log-Debug $fn $ErrorText -fac 3;
}
else
{
Log-Error $fn $ErrorText -fac 3;
if($gotoError -eq $_.Exception.Message)
{
Log-Error $fn $e.Exception.Message;
$PSCmdlet.ThrowTerminatingError($e);
}
elseif($gotoFailure -ne $_.Exception.Message)
{
Write-Verbose ("$fn`n$ErrorText");
}
else
{
# N/A
}
}
$fReturn = $false;
$OutputParameter = $null;
}
}
finally
{
# Clean up
# N/A
}
}
# Process
End
{
$datEnd = [datetime]::Now;
Log-Debug -fn $fn -msg ("RET. fReturn: [{0}]. Execution time: [{1}]ms. Started: [{2}]." -f $fReturn, ($datEnd - $datBegin).TotalMilliseconds, $datBegin.ToString('yyyy-MM-dd HH:mm:ss.fffzzz')) -fac 2;
# Return values are always and only returned via OutputParameter.
return $OutputParameter;
}
# End
}
if($MyInvocation.ScriptName) { Export-ModuleMember -Function New-KeyNameValue; }
#
# Copyright 2014-2015 d-fens GmbH
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SIG # Begin signature block
# MIIXDwYJKoZIhvcNAQcCoIIXADCCFvwCAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB
# gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR
# AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQUrGS+r7CA42q1FvvF14tmAAa/
# t32gghHCMIIEFDCCAvygAwIBAgILBAAAAAABL07hUtcwDQYJKoZIhvcNAQEFBQAw
# VzELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNV
# BAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkdsb2JhbFNpZ24gUm9vdCBDQTAeFw0xMTA0
# MTMxMDAwMDBaFw0yODAxMjgxMjAwMDBaMFIxCzAJBgNVBAYTAkJFMRkwFwYDVQQK
# ExBHbG9iYWxTaWduIG52LXNhMSgwJgYDVQQDEx9HbG9iYWxTaWduIFRpbWVzdGFt
# cGluZyBDQSAtIEcyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAlO9l
# +LVXn6BTDTQG6wkft0cYasvwW+T/J6U00feJGr+esc0SQW5m1IGghYtkWkYvmaCN
# d7HivFzdItdqZ9C76Mp03otPDbBS5ZBb60cO8eefnAuQZT4XljBFcm05oRc2yrmg
# jBtPCBn2gTGtYRakYua0QJ7D/PuV9vu1LpWBmODvxevYAll4d/eq41JrUJEpxfz3
# zZNl0mBhIvIG+zLdFlH6Dv2KMPAXCae78wSuq5DnbN96qfTvxGInX2+ZbTh0qhGL
# 2t/HFEzphbLswn1KJo/nVrqm4M+SU4B09APsaLJgvIQgAIMboe60dAXBKY5i0Eex
# +vBTzBj5Ljv5cH60JQIDAQABo4HlMIHiMA4GA1UdDwEB/wQEAwIBBjASBgNVHRMB
# Af8ECDAGAQH/AgEAMB0GA1UdDgQWBBRG2D7/3OO+/4Pm9IWbsN1q1hSpwTBHBgNV
# HSAEQDA+MDwGBFUdIAAwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93d3cuZ2xvYmFs
# c2lnbi5jb20vcmVwb3NpdG9yeS8wMwYDVR0fBCwwKjAooCagJIYiaHR0cDovL2Ny
# bC5nbG9iYWxzaWduLm5ldC9yb290LmNybDAfBgNVHSMEGDAWgBRge2YaRQ2XyolQ
# L30EzTSo//z9SzANBgkqhkiG9w0BAQUFAAOCAQEATl5WkB5GtNlJMfO7FzkoG8IW
# 3f1B3AkFBJtvsqKa1pkuQJkAVbXqP6UgdtOGNNQXzFU6x4Lu76i6vNgGnxVQ380W
# e1I6AtcZGv2v8Hhc4EvFGN86JB7arLipWAQCBzDbsBJe/jG+8ARI9PBw+DpeVoPP
# PfsNvPTF7ZedudTbpSeE4zibi6c1hkQgpDttpGoLoYP9KOva7yj2zIhd+wo7AKvg
# IeviLzVsD440RZfroveZMzV+y5qKu0VN5z+fwtmK+mWybsd+Zf/okuEsMaL3sCc2
# SI8mbzvuTXYfecPlf5Y1vC0OzAGwjn//UYCAp5LUs0RGZIyHTxZjBzFLY7Df8zCC
# BCkwggMRoAMCAQICCwQAAAAAATGJxjfoMA0GCSqGSIb3DQEBCwUAMEwxIDAeBgNV
# BAsTF0dsb2JhbFNpZ24gUm9vdCBDQSAtIFIzMRMwEQYDVQQKEwpHbG9iYWxTaWdu
# MRMwEQYDVQQDEwpHbG9iYWxTaWduMB4XDTExMDgwMjEwMDAwMFoXDTE5MDgwMjEw
# MDAwMFowWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKPv0Z8p6djTgnY8YqDS
# SdYWHvHP8NC6SEMDLacd8gE0SaQQ6WIT9BP0FoO11VdCSIYrlViH6igEdMtyEQ9h
# JuH6HGEVxyibTQuCDyYrkDqW7aTQaymc9WGI5qRXb+70cNCNF97mZnZfdB5eDFM4
# XZD03zAtGxPReZhUGks4BPQHxCMD05LL94BdqpxWBkQtQUxItC3sNZKaxpXX9c6Q
# MeJ2s2G48XVXQqw7zivIkEnotybPuwyJy9DDo2qhydXjnFMrVyb+Vpp2/WFGomDs
# KUZH8s3ggmLGBFrn7U5AXEgGfZ1f53TJnoRlDVve3NMkHLQUEeurv8QfpLqZ0BdY
# Nc0CAwEAAaOB/TCB+jAOBgNVHQ8BAf8EBAMCAQYwEgYDVR0TAQH/BAgwBgEB/wIB
# ADAdBgNVHQ4EFgQUGUq4WuRNMaUU5V7sL6Mc+oCMMmswRwYDVR0gBEAwPjA8BgRV
# HSAAMDQwMgYIKwYBBQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3Jl
# cG9zaXRvcnkvMDYGA1UdHwQvMC0wK6ApoCeGJWh0dHA6Ly9jcmwuZ2xvYmFsc2ln
# bi5uZXQvcm9vdC1yMy5jcmwwEwYDVR0lBAwwCgYIKwYBBQUHAwMwHwYDVR0jBBgw
# FoAUj/BLf6guRSSuTVD6Y5qL3uLdG7wwDQYJKoZIhvcNAQELBQADggEBAHmwaTTi
# BYf2/tRgLC+GeTQD4LEHkwyEXPnk3GzPbrXsCly6C9BoMS4/ZL0Pgmtmd4F/ximl
# F9jwiU2DJBH2bv6d4UgKKKDieySApOzCmgDXsG1szYjVFXjPE/mIpXNNwTYr3MvO
# 23580ovvL72zT006rbtibiiTxAzL2ebK4BEClAOwvT+UKFaQHlPCJ9XJPM0aYx6C
# WRW2QMqngarDVa8z0bV16AnqRwhIIvtdG/Mseml+xddaXlYzPK1X6JMlQsPSXnE7
# ShxU7alVrCgFx8RsXdw8k/ZpPIJRzhoVPV4Bc/9Aouq0rtOO+u5dbEfHQfXUVlfy
# GDcy1tTMS/Zx4HYwggSfMIIDh6ADAgECAhIRIdaZp2SXPvH4Qn7pGcxTQRQwDQYJ
# KoZIhvcNAQEFBQAwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24g
# bnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzIw
# HhcNMTYwNTI0MDAwMDAwWhcNMjcwNjI0MDAwMDAwWjBgMQswCQYDVQQGEwJTRzEf
# MB0GA1UEChMWR01PIEdsb2JhbFNpZ24gUHRlIEx0ZDEwMC4GA1UEAxMnR2xvYmFs
# U2lnbiBUU0EgZm9yIE1TIEF1dGhlbnRpY29kZSAtIEcyMIIBIjANBgkqhkiG9w0B
# AQEFAAOCAQ8AMIIBCgKCAQEAsBeuotO2BDBWHlgPse1VpNZUy9j2czrsXV6rJf02
# pfqEw2FAxUa1WVI7QqIuXxNiEKlb5nPWkiWxfSPjBrOHOg5D8NcAiVOiETFSKG5d
# QHI88gl3p0mSl9RskKB2p/243LOd8gdgLE9YmABr0xVU4Prd/4AsXximmP/Uq+yh
# RVmyLm9iXeDZGayLV5yoJivZF6UQ0kcIGnAsM4t/aIAqtaFda92NAgIpA6p8N7u7
# KU49U5OzpvqP0liTFUy5LauAo6Ml+6/3CGSwekQPXBDXX2E3qk5r09JTJZ2Cc/os
# +XKwqRk5KlD6qdA8OsroW+/1X1H0+QrZlzXeaoXmIwRCrwIDAQABo4IBXzCCAVsw
# DgYDVR0PAQH/BAQDAgeAMEwGA1UdIARFMEMwQQYJKwYBBAGgMgEeMDQwMgYIKwYB
# BQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3JlcG9zaXRvcnkvMAkG
# A1UdEwQCMAAwFgYDVR0lAQH/BAwwCgYIKwYBBQUHAwgwQgYDVR0fBDswOTA3oDWg
# M4YxaHR0cDovL2NybC5nbG9iYWxzaWduLmNvbS9ncy9nc3RpbWVzdGFtcGluZ2cy
# LmNybDBUBggrBgEFBQcBAQRIMEYwRAYIKwYBBQUHMAKGOGh0dHA6Ly9zZWN1cmUu
# Z2xvYmFsc2lnbi5jb20vY2FjZXJ0L2dzdGltZXN0YW1waW5nZzIuY3J0MB0GA1Ud
# DgQWBBTUooRKOFoYf7pPMFC9ndV6h9YJ9zAfBgNVHSMEGDAWgBRG2D7/3OO+/4Pm
# 9IWbsN1q1hSpwTANBgkqhkiG9w0BAQUFAAOCAQEAj6kakW0EpjcgDoOW3iPTa24f
# bt1kPWghIrX4RzZpjuGlRcckoiK3KQnMVFquxrzNY46zPVBI5bTMrs2SjZ4oixNK
# Eaq9o+/Tsjb8tKFyv22XY3mMRLxwL37zvN2CU6sa9uv6HJe8tjecpBwwvKu8LUc2
# 35IgA+hxxlj2dQWaNPALWVqCRDSqgOQvhPZHXZbJtsrKnbemuuRQ09Q3uLogDtDT
# kipbxFm7oW3bPM5EncE4Kq3jjb3NCXcaEL5nCgI2ZIi5sxsm7ueeYMRGqLxhM2zP
# TrmcuWrwnzf+tT1PmtNN/94gjk6Xpv2fCbxNyhh2ybBNhVDygNIdBvVYBAexGDCC
# BNYwggO+oAMCAQICEhEhDRayW4wRltP+V8mGEea62TANBgkqhkiG9w0BAQsFADBa
# MQswCQYDVQQGEwJCRTEZMBcGA1UEChMQR2xvYmFsU2lnbiBudi1zYTEwMC4GA1UE
# AxMnR2xvYmFsU2lnbiBDb2RlU2lnbmluZyBDQSAtIFNIQTI1NiAtIEcyMB4XDTE1
# MDUwNDE2NDMyMVoXDTE4MDUwNDE2NDMyMVowVTELMAkGA1UEBhMCQ0gxDDAKBgNV
# BAgTA1p1ZzEMMAoGA1UEBxMDWnVnMRQwEgYDVQQKEwtkLWZlbnMgR21iSDEUMBIG
# A1UEAxMLZC1mZW5zIEdtYkgwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB
# AQDNPSzSNPylU9jFM78Q/GjzB7N+VNqikf/use7p8mpnBZ4cf5b4qV3rqQd62rJH
# RlAsxgouCSNQrl8xxfg6/t/I02kPvrzsR4xnDgMiVCqVRAeQsWebafWdTvWmONBS
# lxJejPP8TSgXMKFaDa+2HleTycTBYSoErAZSWpQ0NqF9zBadjsJRVatQuPkTDrwL
# eWibiyOipK9fcNoQpl5ll5H9EG668YJR3fqX9o0TQTkOmxXIL3IJ0UxdpyDpLEkt
# tBG6Y5wAdpF2dQX2phrfFNVY54JOGtuBkNGMSiLFzTkBA1fOlA6ICMYjB8xIFxVv
# rN1tYojCrqYkKMOjwWQz5X8zAgMBAAGjggGZMIIBlTAOBgNVHQ8BAf8EBAMCB4Aw
# TAYDVR0gBEUwQzBBBgkrBgEEAaAyATIwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93
# d3cuZ2xvYmFsc2lnbi5jb20vcmVwb3NpdG9yeS8wCQYDVR0TBAIwADATBgNVHSUE
# DDAKBggrBgEFBQcDAzBCBgNVHR8EOzA5MDegNaAzhjFodHRwOi8vY3JsLmdsb2Jh
# bHNpZ24uY29tL2dzL2dzY29kZXNpZ25zaGEyZzIuY3JsMIGQBggrBgEFBQcBAQSB
# gzCBgDBEBggrBgEFBQcwAoY4aHR0cDovL3NlY3VyZS5nbG9iYWxzaWduLmNvbS9j
# YWNlcnQvZ3Njb2Rlc2lnbnNoYTJnMi5jcnQwOAYIKwYBBQUHMAGGLGh0dHA6Ly9v
# Y3NwMi5nbG9iYWxzaWduLmNvbS9nc2NvZGVzaWduc2hhMmcyMB0GA1UdDgQWBBTN
# GDddiIYZy9p3Z84iSIMd27rtUDAfBgNVHSMEGDAWgBQZSrha5E0xpRTlXuwvoxz6
# gIwyazANBgkqhkiG9w0BAQsFAAOCAQEAAApsOzSX1alF00fTeijB/aIthO3UB0ks
# 1Gg3xoKQC1iEQmFG/qlFLiufs52kRPN7L0a7ClNH3iQpaH5IEaUENT9cNEXdKTBG
# 8OrJS8lrDJXImgNEgtSwz0B40h7bM2Z+0DvXDvpmfyM2NwHF/nNVj7NzmczrLRqN
# 9de3tV0pgRqnIYordVcmb24CZl3bzpwzbQQy14Iz+P5Z2cnw+QaYzAuweTZxEUcJ
# bFwpM49c1LMPFJTuOKkUgY90JJ3gVTpyQxfkc7DNBnx74PlRzjFmeGC/hxQt0hvo
# eaAiBdjo/1uuCTToigVnyRH+c0T2AezTeoFb7ne3I538hWeTdU5q9jGCBLcwggSz
# AgEBMHAwWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MgISESENFrJbjBGW0/5XyYYR5rrZMAkGBSsOAwIaBQCgeDAYBgorBgEEAYI3AgEM
# MQowCKACgAChAoAAMBkGCSqGSIb3DQEJAzEMBgorBgEEAYI3AgEEMBwGCisGAQQB
# gjcCAQsxDjAMBgorBgEEAYI3AgEVMCMGCSqGSIb3DQEJBDEWBBS17DLMz48XrHuV
# AVM5V3bN4s+0tTANBgkqhkiG9w0BAQEFAASCAQCS2sqdiJFUeW+nvYjD6id7M3Cc
# L7EOjEVm4yLeVhoBMxrmJTKnNKkjMux27hdf18+qNlG0JyFmjMLXq9mztTOmQGe5
# NuZJ1w4F38nqZNWuWCztOuZg8+TQcz+v7eTLpTCjKwJ3A6J9dkHyN2iQgwSpr5kM
# PUWX9ucwUe0Ud9Sb47hESde/nHDIIPejdis3UKtqKGt98TNBkjVCB5TgFRYG4MmY
# 2pje/sU4PIdPFR5re+u9zgD6/rhEqFD4Ld7WpitV277YpaGSvoGikYcuMVMu/1YA
# CMqRPiAqDx0x2adi62vT99ZNRacimIsx5YAdJv24h/8ge8gJxugyMzACgXlQoYIC
# ojCCAp4GCSqGSIb3DQEJBjGCAo8wggKLAgEBMGgwUjELMAkGA1UEBhMCQkUxGTAX
# BgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGlt
# ZXN0YW1waW5nIENBIC0gRzICEhEh1pmnZJc+8fhCfukZzFNBFDAJBgUrDgMCGgUA
# oIH9MBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTE2
# MDgzMTE5MTY1M1owIwYJKoZIhvcNAQkEMRYEFCdEgrrp7VGX4+HkpMubo6Ir7DAL
# MIGdBgsqhkiG9w0BCRACDDGBjTCBijCBhzCBhAQUY7gvq2H1g5CWlQULACScUCkz
# 7HkwbDBWpFQwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYt
# c2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzICEhEh
# 1pmnZJc+8fhCfukZzFNBFDANBgkqhkiG9w0BAQEFAASCAQA97gjPR+qKhGLZJzrZ
# 3JVqjfTjlNBVB8oSXgfh7BZoimkB/xOE5EEcsKvEzYTku7Sta3H1nDaCdPwcHkGH
# wHgGrjdo051rqn3TXe+T3NX1w/+DcOPet6gn+0ZatygvgVr64z6SfhYLki2Q4Ai5
# PCkyfkMWZEJeVLs0SQn/6X9PGz+xmcazLdJ81t+pbN+NJ+tcMywc22Zk1Is8LcCP
# 6oDjSB/0lwmgDhsBStrP2giwYv84wNbMr3BlDemLZs+SUib6HQPyNO77+TqAne33
# 1ETqIjn98S3wl8CqqfbjBPWBhhjQW+zo2NbB+B5m3Wrud2Swre8KZm2gpxMGdPcf
# Tv4E
# SIG # End signature block
|
PowerShellCorpus/PowerShellGallery/biz.dfch.PS.Appclusive.Client/5.2.1.20161201/Set-User.ps1
|
Set-User.ps1
|
function Set-User {
<#
.SYNOPSIS
Sets or creates a User entry in Appclusive.
.DESCRIPTION
Sets or creates a User entry in Appclusive.
By updating a User entry you can specify, if you want to update the Mail address, the description or both.
.OUTPUTS
[biz.dfch.CS.Appclusive.Api.Core.User]
.EXAMPLE
Set-User -Name ArbitraryName -Mail arbitrary@example.com -ExternalId ArbitraryExternalId -ExternalType ArbitraryExternalType -CreateIfNotExist
ExternalId : ArbitraryExternalId
ExternalType : ArbitraryExternalType
Mail : arbitrary@example.com
Id : 2
Tid : 22222222-2222-2222-2222-222222222222
Name : ArbitraryName
Description :
CreatedById : 1
ModifiedById : 1
Created : 15.12.2015 00:00:00 +01:00
Modified : 17.12.2015 00:00:00 +01:00
RowVersion : {0, 0, 0, 0...}
Tenant :
CreatedBy :
ModifiedBy :
Create a new User entry if it does not exists.
.EXAMPLE
Set-User -Name ArbitraryName -ExternalId ArbitraryExternalId -ExternalType ArbitraryExternalType -NewMail newmail@example.com
ExternalId : ArbitraryExternalId
ExternalType : ArbitraryExternalType
Mail : newmail@example.com
Id : 2
Tid : 22222222-2222-2222-2222-222222222222
Name : ArbitraryName
Description :
CreatedById : 1
ModifiedById : 1
Created : 15.12.2015 00:00:00 +01:00
Modified : 17.12.2015 00:00:00 +01:00
RowVersion : {0, 0, 0, 0...}
Tenant :
CreatedBy :
ModifiedBy :
Update an existing User with new Mail.
.EXAMPLE
Set-User -Name ArbitraryName -Mail arbitrary@example.com -NewMail newmail@example.com
ExternalId : ArbitraryExternalId
ExternalType : ArbitraryExternalType
Mail : newmail@example.com
Id : 2
Tid : 22222222-2222-2222-2222-222222222222
Name : ArbitraryName
Description :
CreatedById : 1
ModifiedById : 1
Created : 15.12.2015 00:00:00 +01:00
Modified : 17.12.2015 00:00:00 +01:00
RowVersion : {0, 0, 0, 0...}
Tenant :
CreatedBy :
ModifiedBy :
Update an existing User with new Mail.
.LINK
Online Version: http://dfch.biz/biz/dfch/PS/Appclusive/Client/New-User/
Set-User: http://dfch.biz/biz/dfch/PS/Appclusive/Client/Set-User/
.NOTES
See module manifest for dependencies and further requirements.
#>
[CmdletBinding(
SupportsShouldProcess = $true
,
ConfirmImpact = 'Low'
,
HelpURI = 'http://dfch.biz/biz/dfch/PS/Appclusive/Client/Set-User/'
)]
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseShouldProcessForStateChangingFunctions", "")]
Param
(
[Parameter(Mandatory = $true, ParameterSetName = 'create')]
[Alias('n')]
[ValidateNotNullOrEmpty()]
[string] $Name
,
[Parameter(Mandatory = $true, ParameterSetName = 'create')]
[Parameter(Mandatory = $true, ParameterSetName = 'email')]
[ValidateNotNullOrEmpty()]
[string] $Mail
,
[Parameter(Mandatory = $true, ParameterSetName = 'create')]
[Parameter(Mandatory = $true, ParameterSetName = 'external')]
[ValidateNotNullOrEmpty()]
[string] $ExternalId
,
[Parameter(Mandatory = $true, ParameterSetName = 'create')]
[Parameter(Mandatory = $true, ParameterSetName = 'external')]
[ValidateNotNullOrEmpty()]
[string] $ExternalType
,
[Parameter(Mandatory = $false, ParameterSetName = 'external')]
[Parameter(Mandatory = $false, ParameterSetName = 'email')]
[string] $NewMail
,
[Parameter(Mandatory = $false)]
[Alias("d")]
[string] $Description
,
# Specifies the tenant id for this entity
[Parameter(Mandatory = $false)]
[guid] $Tid
,
# Specifies to create a entity if it does not exist
[Parameter(Mandatory = $true, ParameterSetName = 'create')]
[Alias("c")]
[switch] $CreateIfNotExist = $false
,
# Service reference to Appclusive
[Parameter(Mandatory = $false)]
[Alias('Services')]
[hashtable] $svc = (Get-Variable -Name $MyInvocation.MyCommand.Module.PrivateData.MODULEVAR -ValueOnly).Services
,
# Specifies the return format of the Cmdlet
[ValidateSet('default', 'json', 'json-pretty', 'xml', 'xml-pretty')]
[Parameter(Mandatory = $false)]
[alias('ReturnFormat')]
[string] $As = 'default'
)
Begin
{
trap { Log-Exception $_; break; }
$datBegin = [datetime]::Now;
[string] $fn = $MyInvocation.MyCommand.Name;
Log-Debug -fn $fn -msg ("CALL. svc '{0}'. Name '{1}'." -f ($svc -is [Object]), $Name) -fac 1;
# Parameter validation
Contract-Requires ($svc.Core -is [biz.dfch.CS.Appclusive.Api.Core.Core]) "Connect to the server before using the Cmdlet"
}
# Begin
Process
{
trap { Log-Exception $_; break; }
# Default test variable for checking function response codes.
[Boolean] $fReturn = $false;
# Return values are always and only returned via OutputParameter.
$OutputParameter = $null;
$AddedEntity = $null;
if(!$Tid)
{
$currentTenant = Get-Tenant -svc $svc -Current;
$Tid = $currentTenant.Id;
}
# is true if entity doesn't exist and 'CreateIfNotExist' is set
if($PSCmdlet.ParameterSetName -eq 'create')
{
$UserContents = @($Name, $Mail, $ExternalId, $ExternalType);
$filterExpression = "(tolower(ExternalId) eq '{0}' and tolower(ExternalType) eq '{1}')" -f $ExternalId.toLower(), $ExternalType.toLower();
$entity = $svc.Core.Users.AddQueryOption('$filter', $filterExpression).AddQueryOption('$top',1) | Select;
Contract-Assert ($CreateIfNotExist -Or $entity) "Entity does not exist. Use '-CreateIfNotExist' to create the resource"
$entity = New-Object biz.dfch.CS.Appclusive.Api.Core.User;
$svc.Core.AddToUsers($entity);
$AddedEntity = $entity;
$entity.Name = $Name;
$entity.Tid = $Tid;
$entity.Mail = $Mail;
$entity.ExternalId = $ExternalId;
$entity.ExternalType = $ExternalType;
$entity.Created = [System.DateTimeOffset]::Now;
$entity.CreatedById = 0;
$entity.ModifiedById = 0;
}
# is true if entity exists and parameterset equals 'email'
if($PSCmdlet.ParameterSetName -eq 'email')
{
$UserContents = @($Mail);
$filterExpression = "(tolower(Mail) eq '{0}')" -f $Mail.toLower();
$entity = $svc.Core.Users.AddQueryOption('$filter', $filterExpression).AddQueryOption('$top',1) | Select;
}
if($PSCmdlet.ParameterSetName -eq 'external')
{
$UserContents = @($ExternalId, $ExternalType);
$filterExpression = "(tolower(ExternalId) eq '{0}' and tolower(ExternalType) eq '{1}')" -f $ExternalId.toLower(), $ExternalType.toLower();
$entity = $svc.Core.Users.AddQueryOption('$filter', $filterExpression).AddQueryOption('$top',1) | Select;
}
if($PSCmdlet.ParameterSetName -eq 'email' -or $PSCmdlet.ParameterSetName -eq 'external')
{
Contract-Assert ($entity) "Entity does not exist."
if($PSBoundParameters.ContainsKey('NewMail'))
{
$entity.Mail = $NewMail;
}
}
if($PSBoundParameters.ContainsKey('Description'))
{
$entity.Description = $Description;
}
if($PSCmdlet.ShouldProcess($UserContents))
{
$svc.Core.UpdateObject($entity);
$null = $svc.Core.SaveChanges();
$r = $entity;
$OutputParameter = Format-ResultAs $r $As;
}
$fReturn = $true;
}
# Process
End
{
$datEnd = [datetime]::Now;
Log-Debug -fn $fn -msg ("RET. fReturn: [{0}]. Execution time: [{1}]ms. Started: [{2}]." -f $fReturn, ($datEnd - $datBegin).TotalMilliseconds, $datBegin.ToString('yyyy-MM-dd HH:mm:ss.fffzzz')) -fac 2;
# Return values are always and only returned via OutputParameter.
return $OutputParameter;
}
# End
}
if($MyInvocation.ScriptName) { Export-ModuleMember -Function Set-User; }
#
# Copyright 2014-2016 d-fens GmbH
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SIG # Begin signature block
# MIIXDwYJKoZIhvcNAQcCoIIXADCCFvwCAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB
# gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR
# AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQUpc7kNWskBeux5bFJnczTs8Aa
# NRygghHCMIIEFDCCAvygAwIBAgILBAAAAAABL07hUtcwDQYJKoZIhvcNAQEFBQAw
# VzELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNV
# BAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkdsb2JhbFNpZ24gUm9vdCBDQTAeFw0xMTA0
# MTMxMDAwMDBaFw0yODAxMjgxMjAwMDBaMFIxCzAJBgNVBAYTAkJFMRkwFwYDVQQK
# ExBHbG9iYWxTaWduIG52LXNhMSgwJgYDVQQDEx9HbG9iYWxTaWduIFRpbWVzdGFt
# cGluZyBDQSAtIEcyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAlO9l
# +LVXn6BTDTQG6wkft0cYasvwW+T/J6U00feJGr+esc0SQW5m1IGghYtkWkYvmaCN
# d7HivFzdItdqZ9C76Mp03otPDbBS5ZBb60cO8eefnAuQZT4XljBFcm05oRc2yrmg
# jBtPCBn2gTGtYRakYua0QJ7D/PuV9vu1LpWBmODvxevYAll4d/eq41JrUJEpxfz3
# zZNl0mBhIvIG+zLdFlH6Dv2KMPAXCae78wSuq5DnbN96qfTvxGInX2+ZbTh0qhGL
# 2t/HFEzphbLswn1KJo/nVrqm4M+SU4B09APsaLJgvIQgAIMboe60dAXBKY5i0Eex
# +vBTzBj5Ljv5cH60JQIDAQABo4HlMIHiMA4GA1UdDwEB/wQEAwIBBjASBgNVHRMB
# Af8ECDAGAQH/AgEAMB0GA1UdDgQWBBRG2D7/3OO+/4Pm9IWbsN1q1hSpwTBHBgNV
# HSAEQDA+MDwGBFUdIAAwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93d3cuZ2xvYmFs
# c2lnbi5jb20vcmVwb3NpdG9yeS8wMwYDVR0fBCwwKjAooCagJIYiaHR0cDovL2Ny
# bC5nbG9iYWxzaWduLm5ldC9yb290LmNybDAfBgNVHSMEGDAWgBRge2YaRQ2XyolQ
# L30EzTSo//z9SzANBgkqhkiG9w0BAQUFAAOCAQEATl5WkB5GtNlJMfO7FzkoG8IW
# 3f1B3AkFBJtvsqKa1pkuQJkAVbXqP6UgdtOGNNQXzFU6x4Lu76i6vNgGnxVQ380W
# e1I6AtcZGv2v8Hhc4EvFGN86JB7arLipWAQCBzDbsBJe/jG+8ARI9PBw+DpeVoPP
# PfsNvPTF7ZedudTbpSeE4zibi6c1hkQgpDttpGoLoYP9KOva7yj2zIhd+wo7AKvg
# IeviLzVsD440RZfroveZMzV+y5qKu0VN5z+fwtmK+mWybsd+Zf/okuEsMaL3sCc2
# SI8mbzvuTXYfecPlf5Y1vC0OzAGwjn//UYCAp5LUs0RGZIyHTxZjBzFLY7Df8zCC
# BCkwggMRoAMCAQICCwQAAAAAATGJxjfoMA0GCSqGSIb3DQEBCwUAMEwxIDAeBgNV
# BAsTF0dsb2JhbFNpZ24gUm9vdCBDQSAtIFIzMRMwEQYDVQQKEwpHbG9iYWxTaWdu
# MRMwEQYDVQQDEwpHbG9iYWxTaWduMB4XDTExMDgwMjEwMDAwMFoXDTE5MDgwMjEw
# MDAwMFowWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKPv0Z8p6djTgnY8YqDS
# SdYWHvHP8NC6SEMDLacd8gE0SaQQ6WIT9BP0FoO11VdCSIYrlViH6igEdMtyEQ9h
# JuH6HGEVxyibTQuCDyYrkDqW7aTQaymc9WGI5qRXb+70cNCNF97mZnZfdB5eDFM4
# XZD03zAtGxPReZhUGks4BPQHxCMD05LL94BdqpxWBkQtQUxItC3sNZKaxpXX9c6Q
# MeJ2s2G48XVXQqw7zivIkEnotybPuwyJy9DDo2qhydXjnFMrVyb+Vpp2/WFGomDs
# KUZH8s3ggmLGBFrn7U5AXEgGfZ1f53TJnoRlDVve3NMkHLQUEeurv8QfpLqZ0BdY
# Nc0CAwEAAaOB/TCB+jAOBgNVHQ8BAf8EBAMCAQYwEgYDVR0TAQH/BAgwBgEB/wIB
# ADAdBgNVHQ4EFgQUGUq4WuRNMaUU5V7sL6Mc+oCMMmswRwYDVR0gBEAwPjA8BgRV
# HSAAMDQwMgYIKwYBBQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3Jl
# cG9zaXRvcnkvMDYGA1UdHwQvMC0wK6ApoCeGJWh0dHA6Ly9jcmwuZ2xvYmFsc2ln
# bi5uZXQvcm9vdC1yMy5jcmwwEwYDVR0lBAwwCgYIKwYBBQUHAwMwHwYDVR0jBBgw
# FoAUj/BLf6guRSSuTVD6Y5qL3uLdG7wwDQYJKoZIhvcNAQELBQADggEBAHmwaTTi
# BYf2/tRgLC+GeTQD4LEHkwyEXPnk3GzPbrXsCly6C9BoMS4/ZL0Pgmtmd4F/ximl
# F9jwiU2DJBH2bv6d4UgKKKDieySApOzCmgDXsG1szYjVFXjPE/mIpXNNwTYr3MvO
# 23580ovvL72zT006rbtibiiTxAzL2ebK4BEClAOwvT+UKFaQHlPCJ9XJPM0aYx6C
# WRW2QMqngarDVa8z0bV16AnqRwhIIvtdG/Mseml+xddaXlYzPK1X6JMlQsPSXnE7
# ShxU7alVrCgFx8RsXdw8k/ZpPIJRzhoVPV4Bc/9Aouq0rtOO+u5dbEfHQfXUVlfy
# GDcy1tTMS/Zx4HYwggSfMIIDh6ADAgECAhIRIdaZp2SXPvH4Qn7pGcxTQRQwDQYJ
# KoZIhvcNAQEFBQAwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24g
# bnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzIw
# HhcNMTYwNTI0MDAwMDAwWhcNMjcwNjI0MDAwMDAwWjBgMQswCQYDVQQGEwJTRzEf
# MB0GA1UEChMWR01PIEdsb2JhbFNpZ24gUHRlIEx0ZDEwMC4GA1UEAxMnR2xvYmFs
# U2lnbiBUU0EgZm9yIE1TIEF1dGhlbnRpY29kZSAtIEcyMIIBIjANBgkqhkiG9w0B
# AQEFAAOCAQ8AMIIBCgKCAQEAsBeuotO2BDBWHlgPse1VpNZUy9j2czrsXV6rJf02
# pfqEw2FAxUa1WVI7QqIuXxNiEKlb5nPWkiWxfSPjBrOHOg5D8NcAiVOiETFSKG5d
# QHI88gl3p0mSl9RskKB2p/243LOd8gdgLE9YmABr0xVU4Prd/4AsXximmP/Uq+yh
# RVmyLm9iXeDZGayLV5yoJivZF6UQ0kcIGnAsM4t/aIAqtaFda92NAgIpA6p8N7u7
# KU49U5OzpvqP0liTFUy5LauAo6Ml+6/3CGSwekQPXBDXX2E3qk5r09JTJZ2Cc/os
# +XKwqRk5KlD6qdA8OsroW+/1X1H0+QrZlzXeaoXmIwRCrwIDAQABo4IBXzCCAVsw
# DgYDVR0PAQH/BAQDAgeAMEwGA1UdIARFMEMwQQYJKwYBBAGgMgEeMDQwMgYIKwYB
# BQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3JlcG9zaXRvcnkvMAkG
# A1UdEwQCMAAwFgYDVR0lAQH/BAwwCgYIKwYBBQUHAwgwQgYDVR0fBDswOTA3oDWg
# M4YxaHR0cDovL2NybC5nbG9iYWxzaWduLmNvbS9ncy9nc3RpbWVzdGFtcGluZ2cy
# LmNybDBUBggrBgEFBQcBAQRIMEYwRAYIKwYBBQUHMAKGOGh0dHA6Ly9zZWN1cmUu
# Z2xvYmFsc2lnbi5jb20vY2FjZXJ0L2dzdGltZXN0YW1waW5nZzIuY3J0MB0GA1Ud
# DgQWBBTUooRKOFoYf7pPMFC9ndV6h9YJ9zAfBgNVHSMEGDAWgBRG2D7/3OO+/4Pm
# 9IWbsN1q1hSpwTANBgkqhkiG9w0BAQUFAAOCAQEAj6kakW0EpjcgDoOW3iPTa24f
# bt1kPWghIrX4RzZpjuGlRcckoiK3KQnMVFquxrzNY46zPVBI5bTMrs2SjZ4oixNK
# Eaq9o+/Tsjb8tKFyv22XY3mMRLxwL37zvN2CU6sa9uv6HJe8tjecpBwwvKu8LUc2
# 35IgA+hxxlj2dQWaNPALWVqCRDSqgOQvhPZHXZbJtsrKnbemuuRQ09Q3uLogDtDT
# kipbxFm7oW3bPM5EncE4Kq3jjb3NCXcaEL5nCgI2ZIi5sxsm7ueeYMRGqLxhM2zP
# TrmcuWrwnzf+tT1PmtNN/94gjk6Xpv2fCbxNyhh2ybBNhVDygNIdBvVYBAexGDCC
# BNYwggO+oAMCAQICEhEhDRayW4wRltP+V8mGEea62TANBgkqhkiG9w0BAQsFADBa
# MQswCQYDVQQGEwJCRTEZMBcGA1UEChMQR2xvYmFsU2lnbiBudi1zYTEwMC4GA1UE
# AxMnR2xvYmFsU2lnbiBDb2RlU2lnbmluZyBDQSAtIFNIQTI1NiAtIEcyMB4XDTE1
# MDUwNDE2NDMyMVoXDTE4MDUwNDE2NDMyMVowVTELMAkGA1UEBhMCQ0gxDDAKBgNV
# BAgTA1p1ZzEMMAoGA1UEBxMDWnVnMRQwEgYDVQQKEwtkLWZlbnMgR21iSDEUMBIG
# A1UEAxMLZC1mZW5zIEdtYkgwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB
# AQDNPSzSNPylU9jFM78Q/GjzB7N+VNqikf/use7p8mpnBZ4cf5b4qV3rqQd62rJH
# RlAsxgouCSNQrl8xxfg6/t/I02kPvrzsR4xnDgMiVCqVRAeQsWebafWdTvWmONBS
# lxJejPP8TSgXMKFaDa+2HleTycTBYSoErAZSWpQ0NqF9zBadjsJRVatQuPkTDrwL
# eWibiyOipK9fcNoQpl5ll5H9EG668YJR3fqX9o0TQTkOmxXIL3IJ0UxdpyDpLEkt
# tBG6Y5wAdpF2dQX2phrfFNVY54JOGtuBkNGMSiLFzTkBA1fOlA6ICMYjB8xIFxVv
# rN1tYojCrqYkKMOjwWQz5X8zAgMBAAGjggGZMIIBlTAOBgNVHQ8BAf8EBAMCB4Aw
# TAYDVR0gBEUwQzBBBgkrBgEEAaAyATIwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93
# d3cuZ2xvYmFsc2lnbi5jb20vcmVwb3NpdG9yeS8wCQYDVR0TBAIwADATBgNVHSUE
# DDAKBggrBgEFBQcDAzBCBgNVHR8EOzA5MDegNaAzhjFodHRwOi8vY3JsLmdsb2Jh
# bHNpZ24uY29tL2dzL2dzY29kZXNpZ25zaGEyZzIuY3JsMIGQBggrBgEFBQcBAQSB
# gzCBgDBEBggrBgEFBQcwAoY4aHR0cDovL3NlY3VyZS5nbG9iYWxzaWduLmNvbS9j
# YWNlcnQvZ3Njb2Rlc2lnbnNoYTJnMi5jcnQwOAYIKwYBBQUHMAGGLGh0dHA6Ly9v
# Y3NwMi5nbG9iYWxzaWduLmNvbS9nc2NvZGVzaWduc2hhMmcyMB0GA1UdDgQWBBTN
# GDddiIYZy9p3Z84iSIMd27rtUDAfBgNVHSMEGDAWgBQZSrha5E0xpRTlXuwvoxz6
# gIwyazANBgkqhkiG9w0BAQsFAAOCAQEAAApsOzSX1alF00fTeijB/aIthO3UB0ks
# 1Gg3xoKQC1iEQmFG/qlFLiufs52kRPN7L0a7ClNH3iQpaH5IEaUENT9cNEXdKTBG
# 8OrJS8lrDJXImgNEgtSwz0B40h7bM2Z+0DvXDvpmfyM2NwHF/nNVj7NzmczrLRqN
# 9de3tV0pgRqnIYordVcmb24CZl3bzpwzbQQy14Iz+P5Z2cnw+QaYzAuweTZxEUcJ
# bFwpM49c1LMPFJTuOKkUgY90JJ3gVTpyQxfkc7DNBnx74PlRzjFmeGC/hxQt0hvo
# eaAiBdjo/1uuCTToigVnyRH+c0T2AezTeoFb7ne3I538hWeTdU5q9jGCBLcwggSz
# AgEBMHAwWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MgISESENFrJbjBGW0/5XyYYR5rrZMAkGBSsOAwIaBQCgeDAYBgorBgEEAYI3AgEM
# MQowCKACgAChAoAAMBkGCSqGSIb3DQEJAzEMBgorBgEEAYI3AgEEMBwGCisGAQQB
# gjcCAQsxDjAMBgorBgEEAYI3AgEVMCMGCSqGSIb3DQEJBDEWBBRRiaRts+tR3aKA
# HiXw918P/2qZAjANBgkqhkiG9w0BAQEFAASCAQClatBQqlYYSYK0AaFZM84rJtv8
# M2hCZOGZKC1AXKsc9seuQOT2hBvrYjq+nsIDjRWlY7cbj1CGTsYxKaorE7FqWaio
# Sitx4QAbO03YTPz/Fg5W4vNOaZ3cngaWkh80uvWkPQO5gjccLW0nJJW0X6gCDPYg
# 7g5I8h0+HNM98Y+qkoYIAhvQW48PmFJjl7tNMndvtNABjflrFCSYxZomSFX6OItp
# gela+6bdf6fx0JWTpgnhdvjKnFu4UbUhwofs+GAMueXXvqiOnS0pQD5JM4IGrLaW
# U32y2mxEnBLnBW6GhTEth6oD3HVRoJKZ6Gh3FFZWZ9iiZFpXHKCTAKDXAgZBoYIC
# ojCCAp4GCSqGSIb3DQEJBjGCAo8wggKLAgEBMGgwUjELMAkGA1UEBhMCQkUxGTAX
# BgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGlt
# ZXN0YW1waW5nIENBIC0gRzICEhEh1pmnZJc+8fhCfukZzFNBFDAJBgUrDgMCGgUA
# oIH9MBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTE2
# MDgzMTE5MTcwOFowIwYJKoZIhvcNAQkEMRYEFCGxcubiVQzc6M+J0rMWb+qc30q7
# MIGdBgsqhkiG9w0BCRACDDGBjTCBijCBhzCBhAQUY7gvq2H1g5CWlQULACScUCkz
# 7HkwbDBWpFQwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYt
# c2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzICEhEh
# 1pmnZJc+8fhCfukZzFNBFDANBgkqhkiG9w0BAQEFAASCAQBuLbikjIvKfpTpA/qZ
# qc5bm/YQT9VYaDMwu8sqfF4Zk1BqsQQ7n/6//G5P9S8BrQCHjlKa9QxRE+HmNG0D
# YTzMCqEiD6thMM4k5AIHIll8lx0vkScBqRjujn2cgEQSYtTSjgRGBcda98FQibIH
# AJV3hwSdkJNqz8fZcwLWfCSBjQpuYnTeDdxwRtePQ0O0GqgporjdF7CVoHC+lBUT
# 1laxZkuaPC7hyJu1Q23rlGuG2vC9lCCf8kG5mFwdNEG6nibILvvy5vhAA50leoMJ
# BEbFpOAZY8MD69D/KYnRN0FLx2qVU6chzzVGUB4OO3kqH8GDBjfneQ6EDM8Ec7+f
# FhEC
# SIG # End signature block
|
PowerShellCorpus/PowerShellGallery/biz.dfch.PS.Appclusive.Client/5.2.1.20161201/Test-Connect.ps1
|
Test-Connect.ps1
|
function Test-Connect {
<#
.SYNOPSIS
Test connections (Interfaces/Connectors) created in Appclusive.
.DESCRIPTION
Test connections (Interfaces/Connectors) created in Appclusive.
Check if an EntityKind can connect to a different EntityKind or Node.
Check if a Connector can be removed.
Returns Flag.
.INPUTS
See PARAMETERS section on possible inputs.
.OUTPUTS
default | json | json-pretty | xml | xml-pretty
.EXAMPLE
.LINK
Online Version: http://dfch.biz/biz/dfch/PS/Appclusive/Client/Test-Connect/
.NOTES
See module manifest for required software versions and dependencies.
#>
[CmdletBinding(
SupportsShouldProcess = $false
,
ConfirmImpact = 'Low'
,
HelpURI = 'http://dfch.biz/biz/dfch/PS/Appclusive/Client/Test-Connect/'
,
DefaultParameterSetName = 'Node'
)]
PARAM
(
# EntityKindId of the Entity to check
[Parameter(Mandatory = $true, Position = 0, ParameterSetName = 'EntityKind')]
[Parameter(Mandatory = $true, Position = 0, ParameterSetName = 'Node')]
[Alias("EkId")]
[string] $EntityKindId
,
# Parent EntityKindId to check against
[Parameter(Mandatory = $true, Position = 1, ParameterSetName = 'EntityKind')]
[Alias("PEkId")]
[string] $ParentEntityKindId
,
# Parent NodeNodeId to check against
[Parameter(Mandatory = $true, Position = 1, ParameterSetName = 'Node')]
[Alias("Node")]
[Alias("NId")]
[string] $ParentNodeId
,
# Service Reference to Appclusive
[Parameter(Mandatory = $false)]
[Alias('Services')]
[hashtable] $svc = (Get-Variable -Name $MyInvocation.MyCommand.Module.PrivateData.MODULEVAR -ValueOnly).Services
)
Begin
{
trap { Log-Exception $_; break; }
$datBegin = [datetime]::Now;
[string] $fn = $MyInvocation.MyCommand.Name;
Log-Debug -fn $fn -msg ("CALL. svc '{0}'. InputObject '{1}'." -f ($svc -is [Object]), $InputObject) -fac 1;
# Parameter validation
Contract-Requires ($svc.Core -is [biz.dfch.CS.Appclusive.Api.Core.Core]) "Connect to the server before using the Cmdlet"
}
# Begin
Process
{
trap { Log-Exception $_; break; }
# Default test variable for checking function response codes.
[Boolean] $fReturn = $false;
# Return values are always and only returned via OutputParameter.
$OutputParameter = $null;
$entitySetName = "Nodes";
$entityId = $ParentNodeId;
if ($PSCmdlet.ParameterSetName -eq 'EntityKind')
{
$entitySetName = "EntityKinds";
$entityId = $ParentEntityKindId;
}
$response = $svc.Core.InvokeEntityActionWithSingleResult($entitySetName, $entityId, "CanConnect", [bool], @{"EntityKindId"=$EntityKindId});
$OutputParameter = $response;
$fReturn = $true;
}
# Process
End
{
$datEnd = [datetime]::Now;
Log-Debug -fn $fn -msg ("RET. fReturn: [{0}]. Execution time: [{1}]ms. Started: [{2}]." -f $fReturn, ($datEnd - $datBegin).TotalMilliseconds, $datBegin.ToString('yyyy-MM-dd HH:mm:ss.fffzzz')) -fac 2;
# Return values are always and only returned via OutputParameter.
return $OutputParameter;
}
# End
} # function
if($MyInvocation.ScriptName) { Export-ModuleMember -Function Test-Connect; }
#
# Copyright 2016 d-fens GmbH
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SIG # Begin signature block
# MIIXDwYJKoZIhvcNAQcCoIIXADCCFvwCAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB
# gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR
# AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQUpv+EkXqO7oe9O/nwNQ4d0pR2
# ZZigghHCMIIEFDCCAvygAwIBAgILBAAAAAABL07hUtcwDQYJKoZIhvcNAQEFBQAw
# VzELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNV
# BAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkdsb2JhbFNpZ24gUm9vdCBDQTAeFw0xMTA0
# MTMxMDAwMDBaFw0yODAxMjgxMjAwMDBaMFIxCzAJBgNVBAYTAkJFMRkwFwYDVQQK
# ExBHbG9iYWxTaWduIG52LXNhMSgwJgYDVQQDEx9HbG9iYWxTaWduIFRpbWVzdGFt
# cGluZyBDQSAtIEcyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAlO9l
# +LVXn6BTDTQG6wkft0cYasvwW+T/J6U00feJGr+esc0SQW5m1IGghYtkWkYvmaCN
# d7HivFzdItdqZ9C76Mp03otPDbBS5ZBb60cO8eefnAuQZT4XljBFcm05oRc2yrmg
# jBtPCBn2gTGtYRakYua0QJ7D/PuV9vu1LpWBmODvxevYAll4d/eq41JrUJEpxfz3
# zZNl0mBhIvIG+zLdFlH6Dv2KMPAXCae78wSuq5DnbN96qfTvxGInX2+ZbTh0qhGL
# 2t/HFEzphbLswn1KJo/nVrqm4M+SU4B09APsaLJgvIQgAIMboe60dAXBKY5i0Eex
# +vBTzBj5Ljv5cH60JQIDAQABo4HlMIHiMA4GA1UdDwEB/wQEAwIBBjASBgNVHRMB
# Af8ECDAGAQH/AgEAMB0GA1UdDgQWBBRG2D7/3OO+/4Pm9IWbsN1q1hSpwTBHBgNV
# HSAEQDA+MDwGBFUdIAAwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93d3cuZ2xvYmFs
# c2lnbi5jb20vcmVwb3NpdG9yeS8wMwYDVR0fBCwwKjAooCagJIYiaHR0cDovL2Ny
# bC5nbG9iYWxzaWduLm5ldC9yb290LmNybDAfBgNVHSMEGDAWgBRge2YaRQ2XyolQ
# L30EzTSo//z9SzANBgkqhkiG9w0BAQUFAAOCAQEATl5WkB5GtNlJMfO7FzkoG8IW
# 3f1B3AkFBJtvsqKa1pkuQJkAVbXqP6UgdtOGNNQXzFU6x4Lu76i6vNgGnxVQ380W
# e1I6AtcZGv2v8Hhc4EvFGN86JB7arLipWAQCBzDbsBJe/jG+8ARI9PBw+DpeVoPP
# PfsNvPTF7ZedudTbpSeE4zibi6c1hkQgpDttpGoLoYP9KOva7yj2zIhd+wo7AKvg
# IeviLzVsD440RZfroveZMzV+y5qKu0VN5z+fwtmK+mWybsd+Zf/okuEsMaL3sCc2
# SI8mbzvuTXYfecPlf5Y1vC0OzAGwjn//UYCAp5LUs0RGZIyHTxZjBzFLY7Df8zCC
# BCkwggMRoAMCAQICCwQAAAAAATGJxjfoMA0GCSqGSIb3DQEBCwUAMEwxIDAeBgNV
# BAsTF0dsb2JhbFNpZ24gUm9vdCBDQSAtIFIzMRMwEQYDVQQKEwpHbG9iYWxTaWdu
# MRMwEQYDVQQDEwpHbG9iYWxTaWduMB4XDTExMDgwMjEwMDAwMFoXDTE5MDgwMjEw
# MDAwMFowWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKPv0Z8p6djTgnY8YqDS
# SdYWHvHP8NC6SEMDLacd8gE0SaQQ6WIT9BP0FoO11VdCSIYrlViH6igEdMtyEQ9h
# JuH6HGEVxyibTQuCDyYrkDqW7aTQaymc9WGI5qRXb+70cNCNF97mZnZfdB5eDFM4
# XZD03zAtGxPReZhUGks4BPQHxCMD05LL94BdqpxWBkQtQUxItC3sNZKaxpXX9c6Q
# MeJ2s2G48XVXQqw7zivIkEnotybPuwyJy9DDo2qhydXjnFMrVyb+Vpp2/WFGomDs
# KUZH8s3ggmLGBFrn7U5AXEgGfZ1f53TJnoRlDVve3NMkHLQUEeurv8QfpLqZ0BdY
# Nc0CAwEAAaOB/TCB+jAOBgNVHQ8BAf8EBAMCAQYwEgYDVR0TAQH/BAgwBgEB/wIB
# ADAdBgNVHQ4EFgQUGUq4WuRNMaUU5V7sL6Mc+oCMMmswRwYDVR0gBEAwPjA8BgRV
# HSAAMDQwMgYIKwYBBQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3Jl
# cG9zaXRvcnkvMDYGA1UdHwQvMC0wK6ApoCeGJWh0dHA6Ly9jcmwuZ2xvYmFsc2ln
# bi5uZXQvcm9vdC1yMy5jcmwwEwYDVR0lBAwwCgYIKwYBBQUHAwMwHwYDVR0jBBgw
# FoAUj/BLf6guRSSuTVD6Y5qL3uLdG7wwDQYJKoZIhvcNAQELBQADggEBAHmwaTTi
# BYf2/tRgLC+GeTQD4LEHkwyEXPnk3GzPbrXsCly6C9BoMS4/ZL0Pgmtmd4F/ximl
# F9jwiU2DJBH2bv6d4UgKKKDieySApOzCmgDXsG1szYjVFXjPE/mIpXNNwTYr3MvO
# 23580ovvL72zT006rbtibiiTxAzL2ebK4BEClAOwvT+UKFaQHlPCJ9XJPM0aYx6C
# WRW2QMqngarDVa8z0bV16AnqRwhIIvtdG/Mseml+xddaXlYzPK1X6JMlQsPSXnE7
# ShxU7alVrCgFx8RsXdw8k/ZpPIJRzhoVPV4Bc/9Aouq0rtOO+u5dbEfHQfXUVlfy
# GDcy1tTMS/Zx4HYwggSfMIIDh6ADAgECAhIRIdaZp2SXPvH4Qn7pGcxTQRQwDQYJ
# KoZIhvcNAQEFBQAwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24g
# bnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzIw
# HhcNMTYwNTI0MDAwMDAwWhcNMjcwNjI0MDAwMDAwWjBgMQswCQYDVQQGEwJTRzEf
# MB0GA1UEChMWR01PIEdsb2JhbFNpZ24gUHRlIEx0ZDEwMC4GA1UEAxMnR2xvYmFs
# U2lnbiBUU0EgZm9yIE1TIEF1dGhlbnRpY29kZSAtIEcyMIIBIjANBgkqhkiG9w0B
# AQEFAAOCAQ8AMIIBCgKCAQEAsBeuotO2BDBWHlgPse1VpNZUy9j2czrsXV6rJf02
# pfqEw2FAxUa1WVI7QqIuXxNiEKlb5nPWkiWxfSPjBrOHOg5D8NcAiVOiETFSKG5d
# QHI88gl3p0mSl9RskKB2p/243LOd8gdgLE9YmABr0xVU4Prd/4AsXximmP/Uq+yh
# RVmyLm9iXeDZGayLV5yoJivZF6UQ0kcIGnAsM4t/aIAqtaFda92NAgIpA6p8N7u7
# KU49U5OzpvqP0liTFUy5LauAo6Ml+6/3CGSwekQPXBDXX2E3qk5r09JTJZ2Cc/os
# +XKwqRk5KlD6qdA8OsroW+/1X1H0+QrZlzXeaoXmIwRCrwIDAQABo4IBXzCCAVsw
# DgYDVR0PAQH/BAQDAgeAMEwGA1UdIARFMEMwQQYJKwYBBAGgMgEeMDQwMgYIKwYB
# BQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3JlcG9zaXRvcnkvMAkG
# A1UdEwQCMAAwFgYDVR0lAQH/BAwwCgYIKwYBBQUHAwgwQgYDVR0fBDswOTA3oDWg
# M4YxaHR0cDovL2NybC5nbG9iYWxzaWduLmNvbS9ncy9nc3RpbWVzdGFtcGluZ2cy
# LmNybDBUBggrBgEFBQcBAQRIMEYwRAYIKwYBBQUHMAKGOGh0dHA6Ly9zZWN1cmUu
# Z2xvYmFsc2lnbi5jb20vY2FjZXJ0L2dzdGltZXN0YW1waW5nZzIuY3J0MB0GA1Ud
# DgQWBBTUooRKOFoYf7pPMFC9ndV6h9YJ9zAfBgNVHSMEGDAWgBRG2D7/3OO+/4Pm
# 9IWbsN1q1hSpwTANBgkqhkiG9w0BAQUFAAOCAQEAj6kakW0EpjcgDoOW3iPTa24f
# bt1kPWghIrX4RzZpjuGlRcckoiK3KQnMVFquxrzNY46zPVBI5bTMrs2SjZ4oixNK
# Eaq9o+/Tsjb8tKFyv22XY3mMRLxwL37zvN2CU6sa9uv6HJe8tjecpBwwvKu8LUc2
# 35IgA+hxxlj2dQWaNPALWVqCRDSqgOQvhPZHXZbJtsrKnbemuuRQ09Q3uLogDtDT
# kipbxFm7oW3bPM5EncE4Kq3jjb3NCXcaEL5nCgI2ZIi5sxsm7ueeYMRGqLxhM2zP
# TrmcuWrwnzf+tT1PmtNN/94gjk6Xpv2fCbxNyhh2ybBNhVDygNIdBvVYBAexGDCC
# BNYwggO+oAMCAQICEhEhDRayW4wRltP+V8mGEea62TANBgkqhkiG9w0BAQsFADBa
# MQswCQYDVQQGEwJCRTEZMBcGA1UEChMQR2xvYmFsU2lnbiBudi1zYTEwMC4GA1UE
# AxMnR2xvYmFsU2lnbiBDb2RlU2lnbmluZyBDQSAtIFNIQTI1NiAtIEcyMB4XDTE1
# MDUwNDE2NDMyMVoXDTE4MDUwNDE2NDMyMVowVTELMAkGA1UEBhMCQ0gxDDAKBgNV
# BAgTA1p1ZzEMMAoGA1UEBxMDWnVnMRQwEgYDVQQKEwtkLWZlbnMgR21iSDEUMBIG
# A1UEAxMLZC1mZW5zIEdtYkgwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB
# AQDNPSzSNPylU9jFM78Q/GjzB7N+VNqikf/use7p8mpnBZ4cf5b4qV3rqQd62rJH
# RlAsxgouCSNQrl8xxfg6/t/I02kPvrzsR4xnDgMiVCqVRAeQsWebafWdTvWmONBS
# lxJejPP8TSgXMKFaDa+2HleTycTBYSoErAZSWpQ0NqF9zBadjsJRVatQuPkTDrwL
# eWibiyOipK9fcNoQpl5ll5H9EG668YJR3fqX9o0TQTkOmxXIL3IJ0UxdpyDpLEkt
# tBG6Y5wAdpF2dQX2phrfFNVY54JOGtuBkNGMSiLFzTkBA1fOlA6ICMYjB8xIFxVv
# rN1tYojCrqYkKMOjwWQz5X8zAgMBAAGjggGZMIIBlTAOBgNVHQ8BAf8EBAMCB4Aw
# TAYDVR0gBEUwQzBBBgkrBgEEAaAyATIwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93
# d3cuZ2xvYmFsc2lnbi5jb20vcmVwb3NpdG9yeS8wCQYDVR0TBAIwADATBgNVHSUE
# DDAKBggrBgEFBQcDAzBCBgNVHR8EOzA5MDegNaAzhjFodHRwOi8vY3JsLmdsb2Jh
# bHNpZ24uY29tL2dzL2dzY29kZXNpZ25zaGEyZzIuY3JsMIGQBggrBgEFBQcBAQSB
# gzCBgDBEBggrBgEFBQcwAoY4aHR0cDovL3NlY3VyZS5nbG9iYWxzaWduLmNvbS9j
# YWNlcnQvZ3Njb2Rlc2lnbnNoYTJnMi5jcnQwOAYIKwYBBQUHMAGGLGh0dHA6Ly9v
# Y3NwMi5nbG9iYWxzaWduLmNvbS9nc2NvZGVzaWduc2hhMmcyMB0GA1UdDgQWBBTN
# GDddiIYZy9p3Z84iSIMd27rtUDAfBgNVHSMEGDAWgBQZSrha5E0xpRTlXuwvoxz6
# gIwyazANBgkqhkiG9w0BAQsFAAOCAQEAAApsOzSX1alF00fTeijB/aIthO3UB0ks
# 1Gg3xoKQC1iEQmFG/qlFLiufs52kRPN7L0a7ClNH3iQpaH5IEaUENT9cNEXdKTBG
# 8OrJS8lrDJXImgNEgtSwz0B40h7bM2Z+0DvXDvpmfyM2NwHF/nNVj7NzmczrLRqN
# 9de3tV0pgRqnIYordVcmb24CZl3bzpwzbQQy14Iz+P5Z2cnw+QaYzAuweTZxEUcJ
# bFwpM49c1LMPFJTuOKkUgY90JJ3gVTpyQxfkc7DNBnx74PlRzjFmeGC/hxQt0hvo
# eaAiBdjo/1uuCTToigVnyRH+c0T2AezTeoFb7ne3I538hWeTdU5q9jGCBLcwggSz
# AgEBMHAwWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MgISESENFrJbjBGW0/5XyYYR5rrZMAkGBSsOAwIaBQCgeDAYBgorBgEEAYI3AgEM
# MQowCKACgAChAoAAMBkGCSqGSIb3DQEJAzEMBgorBgEEAYI3AgEEMBwGCisGAQQB
# gjcCAQsxDjAMBgorBgEEAYI3AgEVMCMGCSqGSIb3DQEJBDEWBBS32foHD6QiRbVn
# AU7UFwhks4F+DjANBgkqhkiG9w0BAQEFAASCAQBd1S/v2d3ilTta4Sn9P3WwNyxZ
# CutkNaEmlSgfmRr8hhPDeGVZsX7hmrhsC3k+Gug87OARMUele9zEvunaWUCL0G6A
# 0LJ1NZH9fGX8TDD+MPAEvs3ymlUPGyEsYbZvePmpXQGFWB3rU3m/jzGqhrhXLqQ0
# o72AlE8QyoTx/pXVQ4M3G65dEt9qa3B+RIyEOOG/7GIwXgKew0XuUKZn05fzq1/j
# paqlmtcHvU4FvqueBIAxITj0xy3t/+Hwk6U7xdPX6BmTjV/dVwVc0t+AjSTLPisQ
# mHo1XcF6GJIoLM3lCNdhfFWFa2009wPwaiWHdQ5cDtS7Qs5YJtRR61HiNmY7oYIC
# ojCCAp4GCSqGSIb3DQEJBjGCAo8wggKLAgEBMGgwUjELMAkGA1UEBhMCQkUxGTAX
# BgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGlt
# ZXN0YW1waW5nIENBIC0gRzICEhEh1pmnZJc+8fhCfukZzFNBFDAJBgUrDgMCGgUA
# oIH9MBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTE2
# MDgzMTE5MTcwOVowIwYJKoZIhvcNAQkEMRYEFBzz5ku8QKBpljrZEgqpfjg+1s/t
# MIGdBgsqhkiG9w0BCRACDDGBjTCBijCBhzCBhAQUY7gvq2H1g5CWlQULACScUCkz
# 7HkwbDBWpFQwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYt
# c2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzICEhEh
# 1pmnZJc+8fhCfukZzFNBFDANBgkqhkiG9w0BAQEFAASCAQA81n0ErCAuuyDHqdkm
# vGsULmRIK31kJ7zKkF1V+4u9EEd4v1F50efQJ3Y61WF753e+eVgxcvER5okOVGNH
# TuelJavHz+rLuT6/XMEHDWtiz+xh/pYYmkrgU0eneHObdU2d81TbP159Z0VznmnF
# A6W5A1aMlwkE4nMdml/fLBW2TvWxzcnLBuHNI4QPttlErXqbuP59Lw8PyvylF0hQ
# 8ScZfvJpVxKYpPlBkJFqrypXFOmu9D2htQXPpQhLKnhPju725nNPVk8/of3o6JGX
# 99lHU9Vks58NY7+VNZvnzOLxNSeN/ja1bT+0Ix1nq3Mo+hrzo+64GSz/IV+gZJK7
# iVR0
# SIG # End signature block
|
PowerShellCorpus/PowerShellGallery/biz.dfch.PS.Appclusive.Client/5.2.1.20161201/Get-Connector.ps1
|
Get-Connector.ps1
|
function Get-Connector {
<#
.SYNOPSIS
Retrieves Connectors from the Appclusive server.
.DESCRIPTION
Retrieves Connectors from the Appclusive server.
Interfaces are used to define Connectors between EntityKinds. Besides specifying a selection you can furthermore define the order, the selected columns and the return format.
If you specify 'object' as output type then all filter options such as 'Select' are ignored.
.OUTPUTS
default | json | json-pretty | xml | xml-pretty
.INPUTS
You basically specify key, name and value to be retrieved. If one or more of these parameters are omitted all entities are returned that match these criteria.
If you specify 'object' as output type then all filter options such as 'Select' are ignored.
.NOTES
See module manifest for dependencies and further requirements.
#>
[CmdletBinding(
SupportsShouldProcess = $false
,
ConfirmImpact = 'Low'
,
DefaultParameterSetName = 'list'
)]
PARAM
(
# Specifies the Key property of the entity.
[Parameter(Mandatory = $true, Position = 0, ParameterSetName = 'Id')]
[long] $Id
,
# Specifies to return all existing entities
[Parameter(Mandatory = $true, Position = 0, ParameterSetName = 'EntityKindId')]
[long] $EntityKindId
,
# Specifies to return all existing entities
[Parameter(Mandatory = $true, Position = 0, ParameterSetName = 'InterfaceId')]
[long] $InterfaceId
,
# Specifies the order of the returned entites. You can specify more than one property (e.g. Key and Name).
[ValidateSet('Id', 'Name', 'EntityKindId', 'InterfaceId')]
[Parameter(Mandatory = $false, Position = 1)]
[string[]] $OrderBy = @('Id','Name')
,
# Specifies to return only values without header information.
# This parameter takes precendes over the 'Select' parameter.
[Alias('HideTableHeaders')]
[switch] $ValueOnly
,
# Specifies to deserialize JSON payloads
[ValidateSet('json')]
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[Alias('Convert')]
[string] $ConvertFrom
,
# Limits the output to the specified number of entries
[Parameter(Mandatory = $false)]
[Alias('top')]
[int] $First
,
# This value is only returned if the regular search would have returned no results
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[Alias('default')]
$DefaultValue
,
# Specifies a references to the Appclusive endpoints
[Parameter(Mandatory = $false)]
[Alias('Services')]
[hashtable] $svc = (Get-Variable -Name $MyInvocation.MyCommand.Module.PrivateData.MODULEVAR -ValueOnly).Services
,
# Specifies to return all existing entities
[Parameter(Mandatory = $false, ParameterSetName = 'list')]
[switch] $ListAvailable = $false
,
# Specifies to return all existing entities
[Parameter(Mandatory = $false)]
[switch] $Require = $false
,
# Specifies to return all existing entities
[Parameter(Mandatory = $false)]
[switch] $Provide = $false
,
# Specifies the return format of the search
[ValidateSet('default', 'json', 'json-pretty', 'xml', 'xml-pretty', 'object')]
[Parameter(Mandatory = $false)]
[alias('ReturnFormat')]
[string] $As = 'default'
)
Begin
{
trap { Log-Exception $_; break; }
$datBegin = [datetime]::Now;
[string] $fn = $MyInvocation.MyCommand.Name;
Log-Debug -fn $fn -msg ("CALL. svc '{0}'. Name '{1}'." -f ($svc -is [Object]), $Name) -fac 1;
$EntitySetName = 'Connectors';
# Parameter validation
Contract-Requires ($svc.Core -is [biz.dfch.CS.Appclusive.Api.Core.Core]) "Connect to the server before using the Cmdlet"
$OrderBy = $OrderBy | Select -Unique;
$OrderByString = [string]::Join(',', $OrderBy);
$Select = $Select | Select -Unique;
if($ValueOnly)
{
if('object' -eq $As)
{
throw ("'ReturnFormat':'object' and 'ValueOnly' must not be specified at the same time." );
$e = New-CustomErrorRecord -m $msg -cat InvalidArgument -o $PSCmdlet;
$PSCmdlet.ThrowTerminatingError($e);
}
$Select = 'Value';
}
if($PSBoundParameters.ContainsKey('Select') -And 'object' -eq $As)
{
$msg = ("'ReturnFormat':'object' and 'Select' must not be specified at the same time." );
$e = New-CustomErrorRecord -m $msg -cat InvalidArgument -o $PSCmdlet;
$PSCmdlet.ThrowTerminatingError($e);
}
}
# Begin
Process
{
# Default test variable for checking function response codes.
[Boolean] $fReturn = $false;
# Return values are always and only returned via OutputParameter.
$OutputParameter = $null;
try
{
# Parameter validation
# N/A
if($PSCmdlet.ParameterSetName -eq 'list')
{
if($Select -And 'object' -ne $As)
{
if($PSBoundParameters.ContainsKey('First'))
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$orderby','Name').AddQueryOption('$top', $First) | Select -Property $Select;
}
else
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$orderby','Name') | Select -Property $Select;
}
}
else
{
if($PSBoundParameters.ContainsKey('First'))
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$orderby','Name').AddQueryOption('$top', $First) | Select;
}
else
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$orderby','Name') | Select;
}
}
}
else
{
$Exp = @();
if($PSBoundParameters.ContainsKey('Id'))
{
$Exp += ("(Id eq {0})" -f $Id);
}
if($PSBoundParameters.ContainsKey('EntityKindId'))
{
$Exp += ("(EntityKindId eq {0})" -f $EntityKindId);
}
if($PSBoundParameters.ContainsKey('InterfaceId'))
{
$Exp += ("(InterfaceId eq {0})" -f $InterfaceId);
}
if($PSBoundParameters.ContainsKey('Require'))
{
$Exp += ("(ConnectionType eq {0})" -f [biz.dfch.CS.Appclusive.Public.OdataServices.Core.ConnectorType]::Require.value__);
}
if($PSBoundParameters.ContainsKey('Provide'))
{
$Exp += ("(ConnectionType eq {0})" -f [biz.dfch.CS.Appclusive.Public.OdataServices.Core.ConnectorType]::Provide.value__);
}
$FilterExpression = [String]::Join(' and ', $Exp);
if($Select -And 'object' -ne $As)
{
if($PSBoundParameters.ContainsKey('First'))
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$filter', $FilterExpression).AddQueryOption('$orderby', $OrderByString).AddQueryOption('$top', $First) | Select -Property $Select;
}
else
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$filter', $FilterExpression).AddQueryOption('$orderby', $OrderByString) | Select -Property $Select;
}
}
else
{
if($PSBoundParameters.ContainsKey('First'))
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$filter', $FilterExpression).AddQueryOption('$orderby', $OrderByString).AddQueryOption('$top', $First) | Select;
}
else
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$filter', $FilterExpression).AddQueryOption('$orderby', $OrderByString) | Select;
}
}
if (!$Response)
{
if($PSBoundParameters.ContainsKey('DefaultValue'))
{
$Response = $DefaultValue;
}
}
if('Value' -eq $Select -And $ValueOnly)
{
$Response = ($Response).Value;
}
if('Value' -eq $Select -And $ConvertFrom)
{
$ResponseTemp = New-Object System.Collections.ArrayList;
foreach($item in $Response)
{
try
{
$null = $ResponseTemp.Add((ConvertFrom-Json -InputObject $item));
}
catch
{
$null = $ResponseTemp.Add($item);
}
}
$Response = $ResponseTemp.ToArray();
Remove-Variable ResponseTemp -Confirm:$false;
}
}
$OutputParameter = Format-ResultAs $Response $As
$fReturn = $true;
}
catch
{
if($gotoSuccess -eq $_.Exception.Message)
{
$fReturn = $true;
}
else
{
[string] $ErrorText = "catch [$($_.FullyQualifiedErrorId)]";
$ErrorText += (($_ | fl * -Force) | Out-String);
$ErrorText += (($_.Exception | fl * -Force) | Out-String);
$ErrorText += (Get-PSCallStack | Out-String);
if($_.Exception -is [System.Net.WebException])
{
Log-Critical $fn ("[WebException] Request FAILED with Status '{0}'. [{1}]." -f $_.Exception.Status, $_);
Log-Debug $fn $ErrorText -fac 3;
}
else
{
Log-Error $fn $ErrorText -fac 3;
if($gotoError -eq $_.Exception.Message)
{
Log-Error $fn $e.Exception.Message;
$PSCmdlet.ThrowTerminatingError($e);
}
elseif($gotoFailure -ne $_.Exception.Message)
{
Write-Verbose ("$fn`n$ErrorText");
}
else
{
# N/A
}
}
$fReturn = $false;
$OutputParameter = $null;
}
}
finally
{
# Clean up
# N/A
}
}
# Process
End
{
$datEnd = [datetime]::Now;
Log-Debug -fn $fn -msg ("RET. fReturn: [{0}]. Execution time: [{1}]ms. Started: [{2}]." -f $fReturn, ($datEnd - $datBegin).TotalMilliseconds, $datBegin.ToString('yyyy-MM-dd HH:mm:ss.fffzzz')) -fac 2;
# Return values are always and only returned via OutputParameter.
return $OutputParameter;
}
# End
}
if($MyInvocation.ScriptName) { Export-ModuleMember -Function Get-Connector; }
#
# Copyright 2016 d-fens GmbH
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SIG # Begin signature block
# MIIXDwYJKoZIhvcNAQcCoIIXADCCFvwCAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB
# gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR
# AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQUPUEPHM4IvG4kGpdEKxzszLz+
# s/6gghHCMIIEFDCCAvygAwIBAgILBAAAAAABL07hUtcwDQYJKoZIhvcNAQEFBQAw
# VzELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNV
# BAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkdsb2JhbFNpZ24gUm9vdCBDQTAeFw0xMTA0
# MTMxMDAwMDBaFw0yODAxMjgxMjAwMDBaMFIxCzAJBgNVBAYTAkJFMRkwFwYDVQQK
# ExBHbG9iYWxTaWduIG52LXNhMSgwJgYDVQQDEx9HbG9iYWxTaWduIFRpbWVzdGFt
# cGluZyBDQSAtIEcyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAlO9l
# +LVXn6BTDTQG6wkft0cYasvwW+T/J6U00feJGr+esc0SQW5m1IGghYtkWkYvmaCN
# d7HivFzdItdqZ9C76Mp03otPDbBS5ZBb60cO8eefnAuQZT4XljBFcm05oRc2yrmg
# jBtPCBn2gTGtYRakYua0QJ7D/PuV9vu1LpWBmODvxevYAll4d/eq41JrUJEpxfz3
# zZNl0mBhIvIG+zLdFlH6Dv2KMPAXCae78wSuq5DnbN96qfTvxGInX2+ZbTh0qhGL
# 2t/HFEzphbLswn1KJo/nVrqm4M+SU4B09APsaLJgvIQgAIMboe60dAXBKY5i0Eex
# +vBTzBj5Ljv5cH60JQIDAQABo4HlMIHiMA4GA1UdDwEB/wQEAwIBBjASBgNVHRMB
# Af8ECDAGAQH/AgEAMB0GA1UdDgQWBBRG2D7/3OO+/4Pm9IWbsN1q1hSpwTBHBgNV
# HSAEQDA+MDwGBFUdIAAwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93d3cuZ2xvYmFs
# c2lnbi5jb20vcmVwb3NpdG9yeS8wMwYDVR0fBCwwKjAooCagJIYiaHR0cDovL2Ny
# bC5nbG9iYWxzaWduLm5ldC9yb290LmNybDAfBgNVHSMEGDAWgBRge2YaRQ2XyolQ
# L30EzTSo//z9SzANBgkqhkiG9w0BAQUFAAOCAQEATl5WkB5GtNlJMfO7FzkoG8IW
# 3f1B3AkFBJtvsqKa1pkuQJkAVbXqP6UgdtOGNNQXzFU6x4Lu76i6vNgGnxVQ380W
# e1I6AtcZGv2v8Hhc4EvFGN86JB7arLipWAQCBzDbsBJe/jG+8ARI9PBw+DpeVoPP
# PfsNvPTF7ZedudTbpSeE4zibi6c1hkQgpDttpGoLoYP9KOva7yj2zIhd+wo7AKvg
# IeviLzVsD440RZfroveZMzV+y5qKu0VN5z+fwtmK+mWybsd+Zf/okuEsMaL3sCc2
# SI8mbzvuTXYfecPlf5Y1vC0OzAGwjn//UYCAp5LUs0RGZIyHTxZjBzFLY7Df8zCC
# BCkwggMRoAMCAQICCwQAAAAAATGJxjfoMA0GCSqGSIb3DQEBCwUAMEwxIDAeBgNV
# BAsTF0dsb2JhbFNpZ24gUm9vdCBDQSAtIFIzMRMwEQYDVQQKEwpHbG9iYWxTaWdu
# MRMwEQYDVQQDEwpHbG9iYWxTaWduMB4XDTExMDgwMjEwMDAwMFoXDTE5MDgwMjEw
# MDAwMFowWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKPv0Z8p6djTgnY8YqDS
# SdYWHvHP8NC6SEMDLacd8gE0SaQQ6WIT9BP0FoO11VdCSIYrlViH6igEdMtyEQ9h
# JuH6HGEVxyibTQuCDyYrkDqW7aTQaymc9WGI5qRXb+70cNCNF97mZnZfdB5eDFM4
# XZD03zAtGxPReZhUGks4BPQHxCMD05LL94BdqpxWBkQtQUxItC3sNZKaxpXX9c6Q
# MeJ2s2G48XVXQqw7zivIkEnotybPuwyJy9DDo2qhydXjnFMrVyb+Vpp2/WFGomDs
# KUZH8s3ggmLGBFrn7U5AXEgGfZ1f53TJnoRlDVve3NMkHLQUEeurv8QfpLqZ0BdY
# Nc0CAwEAAaOB/TCB+jAOBgNVHQ8BAf8EBAMCAQYwEgYDVR0TAQH/BAgwBgEB/wIB
# ADAdBgNVHQ4EFgQUGUq4WuRNMaUU5V7sL6Mc+oCMMmswRwYDVR0gBEAwPjA8BgRV
# HSAAMDQwMgYIKwYBBQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3Jl
# cG9zaXRvcnkvMDYGA1UdHwQvMC0wK6ApoCeGJWh0dHA6Ly9jcmwuZ2xvYmFsc2ln
# bi5uZXQvcm9vdC1yMy5jcmwwEwYDVR0lBAwwCgYIKwYBBQUHAwMwHwYDVR0jBBgw
# FoAUj/BLf6guRSSuTVD6Y5qL3uLdG7wwDQYJKoZIhvcNAQELBQADggEBAHmwaTTi
# BYf2/tRgLC+GeTQD4LEHkwyEXPnk3GzPbrXsCly6C9BoMS4/ZL0Pgmtmd4F/ximl
# F9jwiU2DJBH2bv6d4UgKKKDieySApOzCmgDXsG1szYjVFXjPE/mIpXNNwTYr3MvO
# 23580ovvL72zT006rbtibiiTxAzL2ebK4BEClAOwvT+UKFaQHlPCJ9XJPM0aYx6C
# WRW2QMqngarDVa8z0bV16AnqRwhIIvtdG/Mseml+xddaXlYzPK1X6JMlQsPSXnE7
# ShxU7alVrCgFx8RsXdw8k/ZpPIJRzhoVPV4Bc/9Aouq0rtOO+u5dbEfHQfXUVlfy
# GDcy1tTMS/Zx4HYwggSfMIIDh6ADAgECAhIRIdaZp2SXPvH4Qn7pGcxTQRQwDQYJ
# KoZIhvcNAQEFBQAwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24g
# bnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzIw
# HhcNMTYwNTI0MDAwMDAwWhcNMjcwNjI0MDAwMDAwWjBgMQswCQYDVQQGEwJTRzEf
# MB0GA1UEChMWR01PIEdsb2JhbFNpZ24gUHRlIEx0ZDEwMC4GA1UEAxMnR2xvYmFs
# U2lnbiBUU0EgZm9yIE1TIEF1dGhlbnRpY29kZSAtIEcyMIIBIjANBgkqhkiG9w0B
# AQEFAAOCAQ8AMIIBCgKCAQEAsBeuotO2BDBWHlgPse1VpNZUy9j2czrsXV6rJf02
# pfqEw2FAxUa1WVI7QqIuXxNiEKlb5nPWkiWxfSPjBrOHOg5D8NcAiVOiETFSKG5d
# QHI88gl3p0mSl9RskKB2p/243LOd8gdgLE9YmABr0xVU4Prd/4AsXximmP/Uq+yh
# RVmyLm9iXeDZGayLV5yoJivZF6UQ0kcIGnAsM4t/aIAqtaFda92NAgIpA6p8N7u7
# KU49U5OzpvqP0liTFUy5LauAo6Ml+6/3CGSwekQPXBDXX2E3qk5r09JTJZ2Cc/os
# +XKwqRk5KlD6qdA8OsroW+/1X1H0+QrZlzXeaoXmIwRCrwIDAQABo4IBXzCCAVsw
# DgYDVR0PAQH/BAQDAgeAMEwGA1UdIARFMEMwQQYJKwYBBAGgMgEeMDQwMgYIKwYB
# BQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3JlcG9zaXRvcnkvMAkG
# A1UdEwQCMAAwFgYDVR0lAQH/BAwwCgYIKwYBBQUHAwgwQgYDVR0fBDswOTA3oDWg
# M4YxaHR0cDovL2NybC5nbG9iYWxzaWduLmNvbS9ncy9nc3RpbWVzdGFtcGluZ2cy
# LmNybDBUBggrBgEFBQcBAQRIMEYwRAYIKwYBBQUHMAKGOGh0dHA6Ly9zZWN1cmUu
# Z2xvYmFsc2lnbi5jb20vY2FjZXJ0L2dzdGltZXN0YW1waW5nZzIuY3J0MB0GA1Ud
# DgQWBBTUooRKOFoYf7pPMFC9ndV6h9YJ9zAfBgNVHSMEGDAWgBRG2D7/3OO+/4Pm
# 9IWbsN1q1hSpwTANBgkqhkiG9w0BAQUFAAOCAQEAj6kakW0EpjcgDoOW3iPTa24f
# bt1kPWghIrX4RzZpjuGlRcckoiK3KQnMVFquxrzNY46zPVBI5bTMrs2SjZ4oixNK
# Eaq9o+/Tsjb8tKFyv22XY3mMRLxwL37zvN2CU6sa9uv6HJe8tjecpBwwvKu8LUc2
# 35IgA+hxxlj2dQWaNPALWVqCRDSqgOQvhPZHXZbJtsrKnbemuuRQ09Q3uLogDtDT
# kipbxFm7oW3bPM5EncE4Kq3jjb3NCXcaEL5nCgI2ZIi5sxsm7ueeYMRGqLxhM2zP
# TrmcuWrwnzf+tT1PmtNN/94gjk6Xpv2fCbxNyhh2ybBNhVDygNIdBvVYBAexGDCC
# BNYwggO+oAMCAQICEhEhDRayW4wRltP+V8mGEea62TANBgkqhkiG9w0BAQsFADBa
# MQswCQYDVQQGEwJCRTEZMBcGA1UEChMQR2xvYmFsU2lnbiBudi1zYTEwMC4GA1UE
# AxMnR2xvYmFsU2lnbiBDb2RlU2lnbmluZyBDQSAtIFNIQTI1NiAtIEcyMB4XDTE1
# MDUwNDE2NDMyMVoXDTE4MDUwNDE2NDMyMVowVTELMAkGA1UEBhMCQ0gxDDAKBgNV
# BAgTA1p1ZzEMMAoGA1UEBxMDWnVnMRQwEgYDVQQKEwtkLWZlbnMgR21iSDEUMBIG
# A1UEAxMLZC1mZW5zIEdtYkgwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB
# AQDNPSzSNPylU9jFM78Q/GjzB7N+VNqikf/use7p8mpnBZ4cf5b4qV3rqQd62rJH
# RlAsxgouCSNQrl8xxfg6/t/I02kPvrzsR4xnDgMiVCqVRAeQsWebafWdTvWmONBS
# lxJejPP8TSgXMKFaDa+2HleTycTBYSoErAZSWpQ0NqF9zBadjsJRVatQuPkTDrwL
# eWibiyOipK9fcNoQpl5ll5H9EG668YJR3fqX9o0TQTkOmxXIL3IJ0UxdpyDpLEkt
# tBG6Y5wAdpF2dQX2phrfFNVY54JOGtuBkNGMSiLFzTkBA1fOlA6ICMYjB8xIFxVv
# rN1tYojCrqYkKMOjwWQz5X8zAgMBAAGjggGZMIIBlTAOBgNVHQ8BAf8EBAMCB4Aw
# TAYDVR0gBEUwQzBBBgkrBgEEAaAyATIwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93
# d3cuZ2xvYmFsc2lnbi5jb20vcmVwb3NpdG9yeS8wCQYDVR0TBAIwADATBgNVHSUE
# DDAKBggrBgEFBQcDAzBCBgNVHR8EOzA5MDegNaAzhjFodHRwOi8vY3JsLmdsb2Jh
# bHNpZ24uY29tL2dzL2dzY29kZXNpZ25zaGEyZzIuY3JsMIGQBggrBgEFBQcBAQSB
# gzCBgDBEBggrBgEFBQcwAoY4aHR0cDovL3NlY3VyZS5nbG9iYWxzaWduLmNvbS9j
# YWNlcnQvZ3Njb2Rlc2lnbnNoYTJnMi5jcnQwOAYIKwYBBQUHMAGGLGh0dHA6Ly9v
# Y3NwMi5nbG9iYWxzaWduLmNvbS9nc2NvZGVzaWduc2hhMmcyMB0GA1UdDgQWBBTN
# GDddiIYZy9p3Z84iSIMd27rtUDAfBgNVHSMEGDAWgBQZSrha5E0xpRTlXuwvoxz6
# gIwyazANBgkqhkiG9w0BAQsFAAOCAQEAAApsOzSX1alF00fTeijB/aIthO3UB0ks
# 1Gg3xoKQC1iEQmFG/qlFLiufs52kRPN7L0a7ClNH3iQpaH5IEaUENT9cNEXdKTBG
# 8OrJS8lrDJXImgNEgtSwz0B40h7bM2Z+0DvXDvpmfyM2NwHF/nNVj7NzmczrLRqN
# 9de3tV0pgRqnIYordVcmb24CZl3bzpwzbQQy14Iz+P5Z2cnw+QaYzAuweTZxEUcJ
# bFwpM49c1LMPFJTuOKkUgY90JJ3gVTpyQxfkc7DNBnx74PlRzjFmeGC/hxQt0hvo
# eaAiBdjo/1uuCTToigVnyRH+c0T2AezTeoFb7ne3I538hWeTdU5q9jGCBLcwggSz
# AgEBMHAwWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MgISESENFrJbjBGW0/5XyYYR5rrZMAkGBSsOAwIaBQCgeDAYBgorBgEEAYI3AgEM
# MQowCKACgAChAoAAMBkGCSqGSIb3DQEJAzEMBgorBgEEAYI3AgEEMBwGCisGAQQB
# gjcCAQsxDjAMBgorBgEEAYI3AgEVMCMGCSqGSIb3DQEJBDEWBBRYoMw4WJox2ynE
# 5i4KQ/50WLTeTzANBgkqhkiG9w0BAQEFAASCAQAnmLv72buPWs9UPW4jZZBtso1U
# IcluvARGLbOUfnmdlo+EL7isBHtIR8B1td9sIu3LNPaS1+W+E6+HgM+Gp1CVZEyD
# Ek6D2G2Y0/N8di2/GJuKV7aHPW0aJb3qBI5OFZvfvgX9qtBM0go5XuWXnHzESgbl
# jjPIHTYAqLRmxGFdj1Lqg8xqn6jAKnOpnJzkeKDgXE8LTuf7pMB3Qu5CiYrdeBOp
# 7Ap3leR5g5mbMeWOUThMx1xh3NHgzj5Hee/jvMH56Rf7HDddbPO9vW896jXDyBnt
# D+mBJAgm+umQ81X/7F5VURKCcsOrh+ZAEzmJ7BVgzlv5v04AnDB4qdkrQ6UeoYIC
# ojCCAp4GCSqGSIb3DQEJBjGCAo8wggKLAgEBMGgwUjELMAkGA1UEBhMCQkUxGTAX
# BgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGlt
# ZXN0YW1waW5nIENBIC0gRzICEhEh1pmnZJc+8fhCfukZzFNBFDAJBgUrDgMCGgUA
# oIH9MBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTE2
# MDgzMTE5MTY0MFowIwYJKoZIhvcNAQkEMRYEFFIn8cwk2/Y2PVz+kf54xLmElfyA
# MIGdBgsqhkiG9w0BCRACDDGBjTCBijCBhzCBhAQUY7gvq2H1g5CWlQULACScUCkz
# 7HkwbDBWpFQwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYt
# c2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzICEhEh
# 1pmnZJc+8fhCfukZzFNBFDANBgkqhkiG9w0BAQEFAASCAQB2XJk39g4bZsXCot9/
# s5PJb/Cd9yW7dXXxioh2sERdErQGAkiWMw9SmgCzwEQC4aesxIFNIqtf31yPbTq3
# Z/f987L2hpIMiULAaweOixG0imovc/E1P7DUiWiC4y3+z84NSo0UWZvVxtP3qHMO
# TWUfhUD5qpcnT7NxvZrxIh9Aq7syN/4wf9SkQCEJLgDYFaVCg9w4ZsQo5ZiOmdrw
# KI/WfALy4Ha1Te1xb82sTMvNm7Qz8DP1cf+Mirs8rInljCUUQmC0eyfbgUsAhHuh
# ScQ2b53ZAz2ZsorKQo6juaaA5g4gZrlE+q3tCGbU0yo54hpl3OCnAkoOVIha+gsv
# OI1T
# SIG # End signature block
|
PowerShellCorpus/PowerShellGallery/biz.dfch.PS.Appclusive.Client/5.2.1.20161201/Get-Product.ps1
|
Get-Product.ps1
|
function Get-Product {
<#
.SYNOPSIS
Retrieves one or more entities from the product entity set.
.DESCRIPTION
Retrieves one or more entities from the product entity set.
You can retrieve one ore more entities from the entity set by specifying
Id, Name or other properties.
.INPUTS
The Cmdlet can either return all available entities or filter entities on
specified conditions.
See PARAMETERS section on possible inputs.
.OUTPUTS
default | json | json-pretty | xml | xml-pretty
.EXAMPLE
Get-Product
Type : com.swisscom.cms.rhel6
EntityKindId : 4862
ValidFrom : 01.01.0001 00:00:00 +00:00
ValidUntil : 31.12.9999 00:00:00 +01:00
EndOfLife : 31.12.9999 00:00:00 +01:00
Parameters : {}
Id : 50
Tid : 11111111-1111-1111-1111-111111111111
Name : RHEL6
Description :
CreatedById : 1011
ModifiedById : 1011
Created : 14.02.2016 11:21:49 +01:00
Modified : 14.02.2016 11:21:49 +01:00
RowVersion : {0, 0, 0, 0...}
CatalogueItems : {}
EntityKind :
Tenant :
CreatedBy :
ModifiedBy :
Type : com.swisscom.cms.rhel7
EntityKindId : 4097
ValidFrom : 01.01.0001 00:00:00 +00:00
ValidUntil : 31.12.9999 00:00:00 +01:00
EndOfLife : 31.12.9999 00:00:00 +01:00
Parameters : {}
Id : 11
Tid : 11111111-1111-1111-1111-111111111111
Name : RHEL7
Description :
CreatedById : 2
ModifiedById : 2
Created : 21.12.2015 09:17:45 +01:00
Modified : 21.12.2015 12:24:19 +01:00
RowVersion : {0, 0, 0, 0...}
CatalogueItems : {}
EntityKind :
Tenant :
CreatedBy :
ModifiedBy :
List all Products
.EXAMPLE
Get-ApcProduct -Id 12
Type : com.swisscom.cms.win
EntityKindId : 4098
ValidFrom : 01.01.0001 00:00:00 +00:00
ValidUntil : 01.01.2020 00:00:00 +01:00
EndOfLife : 01.01.2020 00:00:00 +01:00
Parameters :
Id : 12
Tid : 11111111-1111-1111-1111-111111111111
Name : WIN2012R2
Description :
CreatedById : 2
ModifiedById : 2
Created : 21.12.2015 16:00:10 +01:00
Modified : 18.01.2016 01:13:44 +01:00
RowVersion : {0, 0, 0, 0...}
CatalogueItems : {}
EntityKind :
Tenant :
CreatedBy :
ModifiedBy :
Retrieves the product with id 12
.EXAMPLE
Get-ApcProduct -Name "WIN2012R2"
Type : com.swisscom.cms.win
EntityKindId : 4098
ValidFrom : 01.01.0001 00:00:00 +00:00
ValidUntil : 01.01.2020 00:00:00 +01:00
EndOfLife : 01.01.2020 00:00:00 +01:00
Parameters :
Id : 12
Tid : 11111111-1111-1111-1111-111111111111
Name : WIN2012R2
Description :
CreatedById : 2
ModifiedById : 2
Created : 21.12.2015 16:00:10 +01:00
Modified : 18.01.2016 01:13:44 +01:00
RowVersion : {0, 0, 0, 0...}
CatalogueItems : {}
EntityKind :
Tenant :
CreatedBy :
ModifiedBy :
Retrieves the product with the Name WIN2012R2
.EXAMPLE
Get-ApcProduct -SearchByName "WIN"
Type : com.swisscom.cms.win
EntityKindId : 4098
ValidFrom : 01.01.0001 00:00:00 +00:00
ValidUntil : 01.01.2020 00:00:00 +01:00
EndOfLife : 01.01.2020 00:00:00 +01:00
Parameters :
Id : 12
Tid : 11111111-1111-1111-1111-111111111111
Name : WIN2012R2
Description :
CreatedById : 2
ModifiedById : 2
Created : 21.12.2015 16:00:10 +01:00
Modified : 18.01.2016 01:13:44 +01:00
RowVersion : {0, 0, 0, 0...}
CatalogueItems : {}
EntityKind :
Tenant :
CreatedBy :
ModifiedBy :
Type : com.swisscom.cms.win2008r2
EntityKindId : 4864
ValidFrom : 01.01.0001 00:00:00 +00:00
ValidUntil : 31.12.9999 23:59:59 +00:00
EndOfLife : 31.12.9999 23:59:59 +00:00
Parameters :
Id : 53
Tid : 11111111-1111-1111-1111-111111111111
Name : WIN2008R2
Description : Managed Windows Server 2008 R2
CreatedById : 2
ModifiedById : 2
Created : 15.02.2016 19:03:11 +01:00
Modified : 15.02.2016 19:03:11 +01:00
RowVersion : {0, 0, 0, 0...}
CatalogueItems : {}
EntityKind :
Tenant :
CreatedBy :
ModifiedBy :
Retrieves all products which contains WIN
.LINK
Online Version: http://dfch.biz/biz/dfch/PS/Appclusive/Client/Get-Product/
.NOTES
See module manifest for required software versions and dependencies.
#>
[CmdletBinding(
ConfirmImpact = 'Low'
,
HelpURI = 'http://dfch.biz/biz/dfch/PS/Appclusive/Client/Get-Product/'
,
DefaultParameterSetName = 'list'
)]
PARAM
(
# Id of the product
[Parameter(Mandatory = $false, ParameterSetName = 'Id')]
[ValidateNotNullOrEmpty()]
[long] $Id = $null
,
# Name of the product
[Parameter(Mandatory = $false, ParameterSetName = 'Parameter')]
[ValidateNotNullOrEmpty()]
[String] $Name = $null
,
# Name of the product type
[Parameter(Mandatory = $false, ParameterSetName = 'Parameter')]
[ValidateNotNullOrEmpty()]
[String] $ProductType = $null
,
# Part of the name of the product type you want to search - this is not case sensitive
[Parameter(Mandatory = $false, ParameterSetName = 'SearchByName')]
[ValidateNotNullOrEmpty()]
[String] $SearchByName = $null
,
# Lists all available products
[Parameter(Mandatory = $false, ParameterSetName = 'list')]
[Switch] $ListAvailable
,
# Service reference to Appclusive
[Parameter(Mandatory = $false)]
[Alias('Services')]
[hashtable] $svc = (Get-Variable -Name $MyInvocation.MyCommand.Module.PrivateData.MODULEVAR -ValueOnly).Services
,
# Specifies the return format of the Cmdlet
[ValidateSet('default', 'json', 'json-pretty', 'xml', 'xml-pretty')]
[Parameter(Mandatory = $false)]
[alias('ReturnFormat')]
[string] $As = 'default'
)
Begin
{
trap { Log-Exception $_; break; }
$datBegin = [datetime]::Now;
[string] $fn = $MyInvocation.MyCommand.Name;
Log-Debug -fn $fn -msg ("CALL. svc '{0}'. Name '{1}'." -f ($svc -is [Object]), $Name) -fac 1;
Contract-Requires ($svc.Core -is [biz.dfch.CS.Appclusive.Api.Core.Core]) "Connect to the server before using the Cmdlet"
$EntitySetName = 'Products';
}
# Begin
Process
{
trap { Log-Exception $_; break; }
# Default test variable for checking function response codes.
[Boolean] $fReturn = $false;
if($PSCmdlet.ParameterSetName -eq 'list')
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$orderby','Name') | Select;
}
else
{
$Exp = @();
If ($PSCmdlet.ParameterSetName -eq 'Id')
{
$Exp += ("Id eq {0}" -f $Id);
}
If ($PSCmdlet.ParameterSetName -eq 'SearchByName')
{
$Exp += ("substringof('{0}', tolower(Name))" -f $SearchByName.ToLower());
}
if (!([string]::IsNullOrEmpty($ProductType)))
{
$Exp += ("tolower(Type) eq '{0}'" -f $ProductType.ToLower());
}
if (!([string]::IsNullOrEmpty($Name)))
{
$Exp += ("tolower(Name) eq '{0}'" -f $Name.ToLower());
}
$FilterExpression = [String]::Join(' and ', $Exp);
$Response = $svc.Core.$EntitySetName.AddQueryOption('$filter', $FilterExpression) | Select;
}
# $OutputParameter = $result
$OutputParameter = Format-ResultAs $Response $As
$fReturn = $true;
}
# Process
End
{
$datEnd = [datetime]::Now;
Log-Debug -fn $fn -msg ("RET. fReturn: [{0}]. Execution time: [{1}]ms. Started: [{2}]." -f $fReturn, ($datEnd - $datBegin).TotalMilliseconds, $datBegin.ToString('yyyy-MM-dd HH:mm:ss.fffzzz')) -fac 2;
# Return values are always and only returned via OutputParameter.
return $OutputParameter;
}
# End
} # function
if($MyInvocation.ScriptName) { Export-ModuleMember -Function Get-Product; }
#
# Copyright 2016 d-fens GmbH
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SIG # Begin signature block
# MIIXDwYJKoZIhvcNAQcCoIIXADCCFvwCAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB
# gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR
# AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQUMNHUhn/RBIpjLCb59ZCyYttJ
# w1egghHCMIIEFDCCAvygAwIBAgILBAAAAAABL07hUtcwDQYJKoZIhvcNAQEFBQAw
# VzELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNV
# BAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkdsb2JhbFNpZ24gUm9vdCBDQTAeFw0xMTA0
# MTMxMDAwMDBaFw0yODAxMjgxMjAwMDBaMFIxCzAJBgNVBAYTAkJFMRkwFwYDVQQK
# ExBHbG9iYWxTaWduIG52LXNhMSgwJgYDVQQDEx9HbG9iYWxTaWduIFRpbWVzdGFt
# cGluZyBDQSAtIEcyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAlO9l
# +LVXn6BTDTQG6wkft0cYasvwW+T/J6U00feJGr+esc0SQW5m1IGghYtkWkYvmaCN
# d7HivFzdItdqZ9C76Mp03otPDbBS5ZBb60cO8eefnAuQZT4XljBFcm05oRc2yrmg
# jBtPCBn2gTGtYRakYua0QJ7D/PuV9vu1LpWBmODvxevYAll4d/eq41JrUJEpxfz3
# zZNl0mBhIvIG+zLdFlH6Dv2KMPAXCae78wSuq5DnbN96qfTvxGInX2+ZbTh0qhGL
# 2t/HFEzphbLswn1KJo/nVrqm4M+SU4B09APsaLJgvIQgAIMboe60dAXBKY5i0Eex
# +vBTzBj5Ljv5cH60JQIDAQABo4HlMIHiMA4GA1UdDwEB/wQEAwIBBjASBgNVHRMB
# Af8ECDAGAQH/AgEAMB0GA1UdDgQWBBRG2D7/3OO+/4Pm9IWbsN1q1hSpwTBHBgNV
# HSAEQDA+MDwGBFUdIAAwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93d3cuZ2xvYmFs
# c2lnbi5jb20vcmVwb3NpdG9yeS8wMwYDVR0fBCwwKjAooCagJIYiaHR0cDovL2Ny
# bC5nbG9iYWxzaWduLm5ldC9yb290LmNybDAfBgNVHSMEGDAWgBRge2YaRQ2XyolQ
# L30EzTSo//z9SzANBgkqhkiG9w0BAQUFAAOCAQEATl5WkB5GtNlJMfO7FzkoG8IW
# 3f1B3AkFBJtvsqKa1pkuQJkAVbXqP6UgdtOGNNQXzFU6x4Lu76i6vNgGnxVQ380W
# e1I6AtcZGv2v8Hhc4EvFGN86JB7arLipWAQCBzDbsBJe/jG+8ARI9PBw+DpeVoPP
# PfsNvPTF7ZedudTbpSeE4zibi6c1hkQgpDttpGoLoYP9KOva7yj2zIhd+wo7AKvg
# IeviLzVsD440RZfroveZMzV+y5qKu0VN5z+fwtmK+mWybsd+Zf/okuEsMaL3sCc2
# SI8mbzvuTXYfecPlf5Y1vC0OzAGwjn//UYCAp5LUs0RGZIyHTxZjBzFLY7Df8zCC
# BCkwggMRoAMCAQICCwQAAAAAATGJxjfoMA0GCSqGSIb3DQEBCwUAMEwxIDAeBgNV
# BAsTF0dsb2JhbFNpZ24gUm9vdCBDQSAtIFIzMRMwEQYDVQQKEwpHbG9iYWxTaWdu
# MRMwEQYDVQQDEwpHbG9iYWxTaWduMB4XDTExMDgwMjEwMDAwMFoXDTE5MDgwMjEw
# MDAwMFowWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKPv0Z8p6djTgnY8YqDS
# SdYWHvHP8NC6SEMDLacd8gE0SaQQ6WIT9BP0FoO11VdCSIYrlViH6igEdMtyEQ9h
# JuH6HGEVxyibTQuCDyYrkDqW7aTQaymc9WGI5qRXb+70cNCNF97mZnZfdB5eDFM4
# XZD03zAtGxPReZhUGks4BPQHxCMD05LL94BdqpxWBkQtQUxItC3sNZKaxpXX9c6Q
# MeJ2s2G48XVXQqw7zivIkEnotybPuwyJy9DDo2qhydXjnFMrVyb+Vpp2/WFGomDs
# KUZH8s3ggmLGBFrn7U5AXEgGfZ1f53TJnoRlDVve3NMkHLQUEeurv8QfpLqZ0BdY
# Nc0CAwEAAaOB/TCB+jAOBgNVHQ8BAf8EBAMCAQYwEgYDVR0TAQH/BAgwBgEB/wIB
# ADAdBgNVHQ4EFgQUGUq4WuRNMaUU5V7sL6Mc+oCMMmswRwYDVR0gBEAwPjA8BgRV
# HSAAMDQwMgYIKwYBBQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3Jl
# cG9zaXRvcnkvMDYGA1UdHwQvMC0wK6ApoCeGJWh0dHA6Ly9jcmwuZ2xvYmFsc2ln
# bi5uZXQvcm9vdC1yMy5jcmwwEwYDVR0lBAwwCgYIKwYBBQUHAwMwHwYDVR0jBBgw
# FoAUj/BLf6guRSSuTVD6Y5qL3uLdG7wwDQYJKoZIhvcNAQELBQADggEBAHmwaTTi
# BYf2/tRgLC+GeTQD4LEHkwyEXPnk3GzPbrXsCly6C9BoMS4/ZL0Pgmtmd4F/ximl
# F9jwiU2DJBH2bv6d4UgKKKDieySApOzCmgDXsG1szYjVFXjPE/mIpXNNwTYr3MvO
# 23580ovvL72zT006rbtibiiTxAzL2ebK4BEClAOwvT+UKFaQHlPCJ9XJPM0aYx6C
# WRW2QMqngarDVa8z0bV16AnqRwhIIvtdG/Mseml+xddaXlYzPK1X6JMlQsPSXnE7
# ShxU7alVrCgFx8RsXdw8k/ZpPIJRzhoVPV4Bc/9Aouq0rtOO+u5dbEfHQfXUVlfy
# GDcy1tTMS/Zx4HYwggSfMIIDh6ADAgECAhIRIdaZp2SXPvH4Qn7pGcxTQRQwDQYJ
# KoZIhvcNAQEFBQAwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24g
# bnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzIw
# HhcNMTYwNTI0MDAwMDAwWhcNMjcwNjI0MDAwMDAwWjBgMQswCQYDVQQGEwJTRzEf
# MB0GA1UEChMWR01PIEdsb2JhbFNpZ24gUHRlIEx0ZDEwMC4GA1UEAxMnR2xvYmFs
# U2lnbiBUU0EgZm9yIE1TIEF1dGhlbnRpY29kZSAtIEcyMIIBIjANBgkqhkiG9w0B
# AQEFAAOCAQ8AMIIBCgKCAQEAsBeuotO2BDBWHlgPse1VpNZUy9j2czrsXV6rJf02
# pfqEw2FAxUa1WVI7QqIuXxNiEKlb5nPWkiWxfSPjBrOHOg5D8NcAiVOiETFSKG5d
# QHI88gl3p0mSl9RskKB2p/243LOd8gdgLE9YmABr0xVU4Prd/4AsXximmP/Uq+yh
# RVmyLm9iXeDZGayLV5yoJivZF6UQ0kcIGnAsM4t/aIAqtaFda92NAgIpA6p8N7u7
# KU49U5OzpvqP0liTFUy5LauAo6Ml+6/3CGSwekQPXBDXX2E3qk5r09JTJZ2Cc/os
# +XKwqRk5KlD6qdA8OsroW+/1X1H0+QrZlzXeaoXmIwRCrwIDAQABo4IBXzCCAVsw
# DgYDVR0PAQH/BAQDAgeAMEwGA1UdIARFMEMwQQYJKwYBBAGgMgEeMDQwMgYIKwYB
# BQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3JlcG9zaXRvcnkvMAkG
# A1UdEwQCMAAwFgYDVR0lAQH/BAwwCgYIKwYBBQUHAwgwQgYDVR0fBDswOTA3oDWg
# M4YxaHR0cDovL2NybC5nbG9iYWxzaWduLmNvbS9ncy9nc3RpbWVzdGFtcGluZ2cy
# LmNybDBUBggrBgEFBQcBAQRIMEYwRAYIKwYBBQUHMAKGOGh0dHA6Ly9zZWN1cmUu
# Z2xvYmFsc2lnbi5jb20vY2FjZXJ0L2dzdGltZXN0YW1waW5nZzIuY3J0MB0GA1Ud
# DgQWBBTUooRKOFoYf7pPMFC9ndV6h9YJ9zAfBgNVHSMEGDAWgBRG2D7/3OO+/4Pm
# 9IWbsN1q1hSpwTANBgkqhkiG9w0BAQUFAAOCAQEAj6kakW0EpjcgDoOW3iPTa24f
# bt1kPWghIrX4RzZpjuGlRcckoiK3KQnMVFquxrzNY46zPVBI5bTMrs2SjZ4oixNK
# Eaq9o+/Tsjb8tKFyv22XY3mMRLxwL37zvN2CU6sa9uv6HJe8tjecpBwwvKu8LUc2
# 35IgA+hxxlj2dQWaNPALWVqCRDSqgOQvhPZHXZbJtsrKnbemuuRQ09Q3uLogDtDT
# kipbxFm7oW3bPM5EncE4Kq3jjb3NCXcaEL5nCgI2ZIi5sxsm7ueeYMRGqLxhM2zP
# TrmcuWrwnzf+tT1PmtNN/94gjk6Xpv2fCbxNyhh2ybBNhVDygNIdBvVYBAexGDCC
# BNYwggO+oAMCAQICEhEhDRayW4wRltP+V8mGEea62TANBgkqhkiG9w0BAQsFADBa
# MQswCQYDVQQGEwJCRTEZMBcGA1UEChMQR2xvYmFsU2lnbiBudi1zYTEwMC4GA1UE
# AxMnR2xvYmFsU2lnbiBDb2RlU2lnbmluZyBDQSAtIFNIQTI1NiAtIEcyMB4XDTE1
# MDUwNDE2NDMyMVoXDTE4MDUwNDE2NDMyMVowVTELMAkGA1UEBhMCQ0gxDDAKBgNV
# BAgTA1p1ZzEMMAoGA1UEBxMDWnVnMRQwEgYDVQQKEwtkLWZlbnMgR21iSDEUMBIG
# A1UEAxMLZC1mZW5zIEdtYkgwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB
# AQDNPSzSNPylU9jFM78Q/GjzB7N+VNqikf/use7p8mpnBZ4cf5b4qV3rqQd62rJH
# RlAsxgouCSNQrl8xxfg6/t/I02kPvrzsR4xnDgMiVCqVRAeQsWebafWdTvWmONBS
# lxJejPP8TSgXMKFaDa+2HleTycTBYSoErAZSWpQ0NqF9zBadjsJRVatQuPkTDrwL
# eWibiyOipK9fcNoQpl5ll5H9EG668YJR3fqX9o0TQTkOmxXIL3IJ0UxdpyDpLEkt
# tBG6Y5wAdpF2dQX2phrfFNVY54JOGtuBkNGMSiLFzTkBA1fOlA6ICMYjB8xIFxVv
# rN1tYojCrqYkKMOjwWQz5X8zAgMBAAGjggGZMIIBlTAOBgNVHQ8BAf8EBAMCB4Aw
# TAYDVR0gBEUwQzBBBgkrBgEEAaAyATIwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93
# d3cuZ2xvYmFsc2lnbi5jb20vcmVwb3NpdG9yeS8wCQYDVR0TBAIwADATBgNVHSUE
# DDAKBggrBgEFBQcDAzBCBgNVHR8EOzA5MDegNaAzhjFodHRwOi8vY3JsLmdsb2Jh
# bHNpZ24uY29tL2dzL2dzY29kZXNpZ25zaGEyZzIuY3JsMIGQBggrBgEFBQcBAQSB
# gzCBgDBEBggrBgEFBQcwAoY4aHR0cDovL3NlY3VyZS5nbG9iYWxzaWduLmNvbS9j
# YWNlcnQvZ3Njb2Rlc2lnbnNoYTJnMi5jcnQwOAYIKwYBBQUHMAGGLGh0dHA6Ly9v
# Y3NwMi5nbG9iYWxzaWduLmNvbS9nc2NvZGVzaWduc2hhMmcyMB0GA1UdDgQWBBTN
# GDddiIYZy9p3Z84iSIMd27rtUDAfBgNVHSMEGDAWgBQZSrha5E0xpRTlXuwvoxz6
# gIwyazANBgkqhkiG9w0BAQsFAAOCAQEAAApsOzSX1alF00fTeijB/aIthO3UB0ks
# 1Gg3xoKQC1iEQmFG/qlFLiufs52kRPN7L0a7ClNH3iQpaH5IEaUENT9cNEXdKTBG
# 8OrJS8lrDJXImgNEgtSwz0B40h7bM2Z+0DvXDvpmfyM2NwHF/nNVj7NzmczrLRqN
# 9de3tV0pgRqnIYordVcmb24CZl3bzpwzbQQy14Iz+P5Z2cnw+QaYzAuweTZxEUcJ
# bFwpM49c1LMPFJTuOKkUgY90JJ3gVTpyQxfkc7DNBnx74PlRzjFmeGC/hxQt0hvo
# eaAiBdjo/1uuCTToigVnyRH+c0T2AezTeoFb7ne3I538hWeTdU5q9jGCBLcwggSz
# AgEBMHAwWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MgISESENFrJbjBGW0/5XyYYR5rrZMAkGBSsOAwIaBQCgeDAYBgorBgEEAYI3AgEM
# MQowCKACgAChAoAAMBkGCSqGSIb3DQEJAzEMBgorBgEEAYI3AgEEMBwGCisGAQQB
# gjcCAQsxDjAMBgorBgEEAYI3AgEVMCMGCSqGSIb3DQEJBDEWBBT4d+4HNki+Cc1s
# jHlJqh5TlyJsETANBgkqhkiG9w0BAQEFAASCAQBPZcvUvbU8A7H5dg0nKsP0Xrf+
# h3VubZTZxpnR/wn3/aMZeBcsAtvin7MoTyvjJGRjvvlZUvlnAY91QBQ9zuyeCjvV
# 9z1eaS2urwHWAqiWybDnaMxoTD5f69t7C6H7hlyyEjeDfTb5+i/0oTjsqXNED8f9
# owqSU2ZFtm94287gdMT2bv7c8uztxTVPu9G3FU62UmuczNQn9NAw4YOdibdaHYFJ
# ahRNJgW3VNoUGjX/eWnWqbnFDrIv3FpYvbBtlE/oJHEo7Fbiz6CypSol+mm4yL1w
# dvOBjg97NBkope+K83RScuBktflcZgC6//UsJgP3OaJEko2AzT9q9OJvgqpXoYIC
# ojCCAp4GCSqGSIb3DQEJBjGCAo8wggKLAgEBMGgwUjELMAkGA1UEBhMCQkUxGTAX
# BgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGlt
# ZXN0YW1waW5nIENBIC0gRzICEhEh1pmnZJc+8fhCfukZzFNBFDAJBgUrDgMCGgUA
# oIH9MBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTE2
# MDgzMTE5MTY0NlowIwYJKoZIhvcNAQkEMRYEFETljBnLy64uOv7zKc0PXEdFquLJ
# MIGdBgsqhkiG9w0BCRACDDGBjTCBijCBhzCBhAQUY7gvq2H1g5CWlQULACScUCkz
# 7HkwbDBWpFQwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYt
# c2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzICEhEh
# 1pmnZJc+8fhCfukZzFNBFDANBgkqhkiG9w0BAQEFAASCAQATbFxgUaM/IJEI7not
# ca6j0O3IxTY1YgT9sILHE/SWD1w7HAnbReduq6yQpC1QSd000vS3L7wZgHNOD9nP
# 8cWL+K/IaFiSuei7m2Cd7n59aUTIy3n96yUKZmFpdDMG5YZ2SWjSvLDDUszY4d8M
# FjYJ0vg8u8rm/OvViUjeZgYx3wU0+JStCz/2fkmJR/hIfGIn2kaVmouhLmZoaHOq
# 3aAfXyCzeICneWyrQcd3rEG9GHiC/wl8X2r3qb8Zx4UvvJE4i0YFubcGeY9RO/kW
# rnX+4ynsm1M1b5qOUakDmvODn9TRQA1Fy8/H2uiuyrL5e4PKufXouaXEZ5+DNfXO
# LTQ+
# SIG # End signature block
|
PowerShellCorpus/PowerShellGallery/biz.dfch.PS.Appclusive.Client/5.2.1.20161201/New-Connector.ps1
|
New-Connector.ps1
|
function New-Connector {
<#
.SYNOPSIS
Creates an Connector entry in Appclusive.
.DESCRIPTION
Creates an Connector entry in Appclusive.
You must specify a Name, InterfaceId and EntityKindId.
.OUTPUTS
default | json | json-pretty | xml | xml-pretty
.EXAMPLE
.LINK
Online Version: http://dfch.biz/biz/dfch/PS/Appclusive/Client/New-Connector/
Set-Connector: http://dfch.biz/biz/dfch/PS/Appclusive/Client/Set-Connector/
.NOTES
See module manifest for dependencies and further requirements.
#>
[CmdletBinding(
SupportsShouldProcess = $true
,
ConfirmImpact = 'Low'
,
HelpURI='http://dfch.biz/biz/dfch/PS/Appclusive/Client/New-Connector/'
)]
PARAM
(
# Specifies the new name name
[Parameter(Mandatory = $true)]
[string] $Name
,
# Specifies the description
[Parameter(Mandatory = $true)]
[long] $InterfaceId
,
# Specifies the description
[Parameter(Mandatory = $true)]
[long] $EntityKindId
,
# Specifies the description
[Parameter(Mandatory = $false)]
[string] $Description
,
# Service reference to Appclusive
[Parameter(Mandatory = $false)]
[Alias('Services')]
[hashtable] $svc = (Get-Variable -Name $MyInvocation.MyCommand.Module.PrivateData.MODULEVAR -ValueOnly).Services
,
# Specifies the return format of the Cmdlet
[ValidateSet('default', 'json', 'json-pretty', 'xml', 'xml-pretty')]
[Parameter(Mandatory = $false)]
[alias('ReturnFormat')]
[string] $As = 'default'
)
Begin
{
trap { Log-Exception $_; break; }
$datBegin = [datetime]::Now;
$entitySetName = "Connectors";
[string] $fn = $MyInvocation.MyCommand.Name;
Log-Debug -fn $fn -msg ("CALL. svc '{0}'. Name '{1}'." -f ($svc -is [Object]), $Name) -fac 1;
# Parameter validation
Contract-Requires ($svc.Core -is [biz.dfch.CS.Appclusive.Api.Core.Core]) "Connect to the server before using the Cmdlet"
}
# Begin
Process
{
# Default test variable for checking function response codes.
[Boolean] $fReturn = $false;
# Return values are always and only returned via OutputParameter.
$OutputParameter = $null;
$Exp = @();
if($Name)
{
$Exp += ("(Name eq '{0}')" -f $Name);
}
$FilterExpression = [String]::Join(' and ', $Exp);
$entity = $svc.Core.$entitySetName.AddQueryOption('$filter',$FilterExpression).AddQueryOption('$top', 1);
if ($entity)
{
$msg = "{0}: Parameter validation FAILED. Entity with Name '{1}' already exists." -f $entitySetName,$Name;
Log-Error $fn $msg;
$null = New-CustomErrorRecord -m $msg -cat ResourceExists -o $Name;
throw($gotoError);
}
if($PSCmdlet.ShouldProcess($Name))
{
if($PSBoundParameters.ContainsKey('Description'))
{
$r = Set-Connector -Name $Name -InterfaceId $InterfaceId -EntityKindId $EntityKindId -Description $Description -CreateIfNotExist -svc $svc -As $As;
}
else
{
$r = Set-Connector -Name $Name -InterfaceId $InterfaceId -EntityKindId $EntityKindId -CreateIfNotExist -svc $svc -As $As;
}
$OutputParameter = $r;
}
$fReturn = $true;
}
# Process
End
{
$datEnd = [datetime]::Now;
Log-Debug -fn $fn -msg ("RET. fReturn: [{0}]. Execution time: [{1}]ms. Started: [{2}]." -f $fReturn, ($datEnd - $datBegin).TotalMilliseconds, $datBegin.ToString('yyyy-MM-dd HH:mm:ss.fffzzz')) -fac 2;
# Return values are always and only returned via OutputParameter.
return $OutputParameter;
}
# End
}
if($MyInvocation.ScriptName) { Export-ModuleMember -Function New-Connector; }
#
# Copyright 2016 d-fens GmbH
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SIG # Begin signature block
# MIIXDwYJKoZIhvcNAQcCoIIXADCCFvwCAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB
# gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR
# AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQUBK86lmzOlwCDoB6Xq4JmM2+g
# s5egghHCMIIEFDCCAvygAwIBAgILBAAAAAABL07hUtcwDQYJKoZIhvcNAQEFBQAw
# VzELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNV
# BAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkdsb2JhbFNpZ24gUm9vdCBDQTAeFw0xMTA0
# MTMxMDAwMDBaFw0yODAxMjgxMjAwMDBaMFIxCzAJBgNVBAYTAkJFMRkwFwYDVQQK
# ExBHbG9iYWxTaWduIG52LXNhMSgwJgYDVQQDEx9HbG9iYWxTaWduIFRpbWVzdGFt
# cGluZyBDQSAtIEcyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAlO9l
# +LVXn6BTDTQG6wkft0cYasvwW+T/J6U00feJGr+esc0SQW5m1IGghYtkWkYvmaCN
# d7HivFzdItdqZ9C76Mp03otPDbBS5ZBb60cO8eefnAuQZT4XljBFcm05oRc2yrmg
# jBtPCBn2gTGtYRakYua0QJ7D/PuV9vu1LpWBmODvxevYAll4d/eq41JrUJEpxfz3
# zZNl0mBhIvIG+zLdFlH6Dv2KMPAXCae78wSuq5DnbN96qfTvxGInX2+ZbTh0qhGL
# 2t/HFEzphbLswn1KJo/nVrqm4M+SU4B09APsaLJgvIQgAIMboe60dAXBKY5i0Eex
# +vBTzBj5Ljv5cH60JQIDAQABo4HlMIHiMA4GA1UdDwEB/wQEAwIBBjASBgNVHRMB
# Af8ECDAGAQH/AgEAMB0GA1UdDgQWBBRG2D7/3OO+/4Pm9IWbsN1q1hSpwTBHBgNV
# HSAEQDA+MDwGBFUdIAAwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93d3cuZ2xvYmFs
# c2lnbi5jb20vcmVwb3NpdG9yeS8wMwYDVR0fBCwwKjAooCagJIYiaHR0cDovL2Ny
# bC5nbG9iYWxzaWduLm5ldC9yb290LmNybDAfBgNVHSMEGDAWgBRge2YaRQ2XyolQ
# L30EzTSo//z9SzANBgkqhkiG9w0BAQUFAAOCAQEATl5WkB5GtNlJMfO7FzkoG8IW
# 3f1B3AkFBJtvsqKa1pkuQJkAVbXqP6UgdtOGNNQXzFU6x4Lu76i6vNgGnxVQ380W
# e1I6AtcZGv2v8Hhc4EvFGN86JB7arLipWAQCBzDbsBJe/jG+8ARI9PBw+DpeVoPP
# PfsNvPTF7ZedudTbpSeE4zibi6c1hkQgpDttpGoLoYP9KOva7yj2zIhd+wo7AKvg
# IeviLzVsD440RZfroveZMzV+y5qKu0VN5z+fwtmK+mWybsd+Zf/okuEsMaL3sCc2
# SI8mbzvuTXYfecPlf5Y1vC0OzAGwjn//UYCAp5LUs0RGZIyHTxZjBzFLY7Df8zCC
# BCkwggMRoAMCAQICCwQAAAAAATGJxjfoMA0GCSqGSIb3DQEBCwUAMEwxIDAeBgNV
# BAsTF0dsb2JhbFNpZ24gUm9vdCBDQSAtIFIzMRMwEQYDVQQKEwpHbG9iYWxTaWdu
# MRMwEQYDVQQDEwpHbG9iYWxTaWduMB4XDTExMDgwMjEwMDAwMFoXDTE5MDgwMjEw
# MDAwMFowWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKPv0Z8p6djTgnY8YqDS
# SdYWHvHP8NC6SEMDLacd8gE0SaQQ6WIT9BP0FoO11VdCSIYrlViH6igEdMtyEQ9h
# JuH6HGEVxyibTQuCDyYrkDqW7aTQaymc9WGI5qRXb+70cNCNF97mZnZfdB5eDFM4
# XZD03zAtGxPReZhUGks4BPQHxCMD05LL94BdqpxWBkQtQUxItC3sNZKaxpXX9c6Q
# MeJ2s2G48XVXQqw7zivIkEnotybPuwyJy9DDo2qhydXjnFMrVyb+Vpp2/WFGomDs
# KUZH8s3ggmLGBFrn7U5AXEgGfZ1f53TJnoRlDVve3NMkHLQUEeurv8QfpLqZ0BdY
# Nc0CAwEAAaOB/TCB+jAOBgNVHQ8BAf8EBAMCAQYwEgYDVR0TAQH/BAgwBgEB/wIB
# ADAdBgNVHQ4EFgQUGUq4WuRNMaUU5V7sL6Mc+oCMMmswRwYDVR0gBEAwPjA8BgRV
# HSAAMDQwMgYIKwYBBQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3Jl
# cG9zaXRvcnkvMDYGA1UdHwQvMC0wK6ApoCeGJWh0dHA6Ly9jcmwuZ2xvYmFsc2ln
# bi5uZXQvcm9vdC1yMy5jcmwwEwYDVR0lBAwwCgYIKwYBBQUHAwMwHwYDVR0jBBgw
# FoAUj/BLf6guRSSuTVD6Y5qL3uLdG7wwDQYJKoZIhvcNAQELBQADggEBAHmwaTTi
# BYf2/tRgLC+GeTQD4LEHkwyEXPnk3GzPbrXsCly6C9BoMS4/ZL0Pgmtmd4F/ximl
# F9jwiU2DJBH2bv6d4UgKKKDieySApOzCmgDXsG1szYjVFXjPE/mIpXNNwTYr3MvO
# 23580ovvL72zT006rbtibiiTxAzL2ebK4BEClAOwvT+UKFaQHlPCJ9XJPM0aYx6C
# WRW2QMqngarDVa8z0bV16AnqRwhIIvtdG/Mseml+xddaXlYzPK1X6JMlQsPSXnE7
# ShxU7alVrCgFx8RsXdw8k/ZpPIJRzhoVPV4Bc/9Aouq0rtOO+u5dbEfHQfXUVlfy
# GDcy1tTMS/Zx4HYwggSfMIIDh6ADAgECAhIRIdaZp2SXPvH4Qn7pGcxTQRQwDQYJ
# KoZIhvcNAQEFBQAwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24g
# bnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzIw
# HhcNMTYwNTI0MDAwMDAwWhcNMjcwNjI0MDAwMDAwWjBgMQswCQYDVQQGEwJTRzEf
# MB0GA1UEChMWR01PIEdsb2JhbFNpZ24gUHRlIEx0ZDEwMC4GA1UEAxMnR2xvYmFs
# U2lnbiBUU0EgZm9yIE1TIEF1dGhlbnRpY29kZSAtIEcyMIIBIjANBgkqhkiG9w0B
# AQEFAAOCAQ8AMIIBCgKCAQEAsBeuotO2BDBWHlgPse1VpNZUy9j2czrsXV6rJf02
# pfqEw2FAxUa1WVI7QqIuXxNiEKlb5nPWkiWxfSPjBrOHOg5D8NcAiVOiETFSKG5d
# QHI88gl3p0mSl9RskKB2p/243LOd8gdgLE9YmABr0xVU4Prd/4AsXximmP/Uq+yh
# RVmyLm9iXeDZGayLV5yoJivZF6UQ0kcIGnAsM4t/aIAqtaFda92NAgIpA6p8N7u7
# KU49U5OzpvqP0liTFUy5LauAo6Ml+6/3CGSwekQPXBDXX2E3qk5r09JTJZ2Cc/os
# +XKwqRk5KlD6qdA8OsroW+/1X1H0+QrZlzXeaoXmIwRCrwIDAQABo4IBXzCCAVsw
# DgYDVR0PAQH/BAQDAgeAMEwGA1UdIARFMEMwQQYJKwYBBAGgMgEeMDQwMgYIKwYB
# BQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3JlcG9zaXRvcnkvMAkG
# A1UdEwQCMAAwFgYDVR0lAQH/BAwwCgYIKwYBBQUHAwgwQgYDVR0fBDswOTA3oDWg
# M4YxaHR0cDovL2NybC5nbG9iYWxzaWduLmNvbS9ncy9nc3RpbWVzdGFtcGluZ2cy
# LmNybDBUBggrBgEFBQcBAQRIMEYwRAYIKwYBBQUHMAKGOGh0dHA6Ly9zZWN1cmUu
# Z2xvYmFsc2lnbi5jb20vY2FjZXJ0L2dzdGltZXN0YW1waW5nZzIuY3J0MB0GA1Ud
# DgQWBBTUooRKOFoYf7pPMFC9ndV6h9YJ9zAfBgNVHSMEGDAWgBRG2D7/3OO+/4Pm
# 9IWbsN1q1hSpwTANBgkqhkiG9w0BAQUFAAOCAQEAj6kakW0EpjcgDoOW3iPTa24f
# bt1kPWghIrX4RzZpjuGlRcckoiK3KQnMVFquxrzNY46zPVBI5bTMrs2SjZ4oixNK
# Eaq9o+/Tsjb8tKFyv22XY3mMRLxwL37zvN2CU6sa9uv6HJe8tjecpBwwvKu8LUc2
# 35IgA+hxxlj2dQWaNPALWVqCRDSqgOQvhPZHXZbJtsrKnbemuuRQ09Q3uLogDtDT
# kipbxFm7oW3bPM5EncE4Kq3jjb3NCXcaEL5nCgI2ZIi5sxsm7ueeYMRGqLxhM2zP
# TrmcuWrwnzf+tT1PmtNN/94gjk6Xpv2fCbxNyhh2ybBNhVDygNIdBvVYBAexGDCC
# BNYwggO+oAMCAQICEhEhDRayW4wRltP+V8mGEea62TANBgkqhkiG9w0BAQsFADBa
# MQswCQYDVQQGEwJCRTEZMBcGA1UEChMQR2xvYmFsU2lnbiBudi1zYTEwMC4GA1UE
# AxMnR2xvYmFsU2lnbiBDb2RlU2lnbmluZyBDQSAtIFNIQTI1NiAtIEcyMB4XDTE1
# MDUwNDE2NDMyMVoXDTE4MDUwNDE2NDMyMVowVTELMAkGA1UEBhMCQ0gxDDAKBgNV
# BAgTA1p1ZzEMMAoGA1UEBxMDWnVnMRQwEgYDVQQKEwtkLWZlbnMgR21iSDEUMBIG
# A1UEAxMLZC1mZW5zIEdtYkgwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB
# AQDNPSzSNPylU9jFM78Q/GjzB7N+VNqikf/use7p8mpnBZ4cf5b4qV3rqQd62rJH
# RlAsxgouCSNQrl8xxfg6/t/I02kPvrzsR4xnDgMiVCqVRAeQsWebafWdTvWmONBS
# lxJejPP8TSgXMKFaDa+2HleTycTBYSoErAZSWpQ0NqF9zBadjsJRVatQuPkTDrwL
# eWibiyOipK9fcNoQpl5ll5H9EG668YJR3fqX9o0TQTkOmxXIL3IJ0UxdpyDpLEkt
# tBG6Y5wAdpF2dQX2phrfFNVY54JOGtuBkNGMSiLFzTkBA1fOlA6ICMYjB8xIFxVv
# rN1tYojCrqYkKMOjwWQz5X8zAgMBAAGjggGZMIIBlTAOBgNVHQ8BAf8EBAMCB4Aw
# TAYDVR0gBEUwQzBBBgkrBgEEAaAyATIwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93
# d3cuZ2xvYmFsc2lnbi5jb20vcmVwb3NpdG9yeS8wCQYDVR0TBAIwADATBgNVHSUE
# DDAKBggrBgEFBQcDAzBCBgNVHR8EOzA5MDegNaAzhjFodHRwOi8vY3JsLmdsb2Jh
# bHNpZ24uY29tL2dzL2dzY29kZXNpZ25zaGEyZzIuY3JsMIGQBggrBgEFBQcBAQSB
# gzCBgDBEBggrBgEFBQcwAoY4aHR0cDovL3NlY3VyZS5nbG9iYWxzaWduLmNvbS9j
# YWNlcnQvZ3Njb2Rlc2lnbnNoYTJnMi5jcnQwOAYIKwYBBQUHMAGGLGh0dHA6Ly9v
# Y3NwMi5nbG9iYWxzaWduLmNvbS9nc2NvZGVzaWduc2hhMmcyMB0GA1UdDgQWBBTN
# GDddiIYZy9p3Z84iSIMd27rtUDAfBgNVHSMEGDAWgBQZSrha5E0xpRTlXuwvoxz6
# gIwyazANBgkqhkiG9w0BAQsFAAOCAQEAAApsOzSX1alF00fTeijB/aIthO3UB0ks
# 1Gg3xoKQC1iEQmFG/qlFLiufs52kRPN7L0a7ClNH3iQpaH5IEaUENT9cNEXdKTBG
# 8OrJS8lrDJXImgNEgtSwz0B40h7bM2Z+0DvXDvpmfyM2NwHF/nNVj7NzmczrLRqN
# 9de3tV0pgRqnIYordVcmb24CZl3bzpwzbQQy14Iz+P5Z2cnw+QaYzAuweTZxEUcJ
# bFwpM49c1LMPFJTuOKkUgY90JJ3gVTpyQxfkc7DNBnx74PlRzjFmeGC/hxQt0hvo
# eaAiBdjo/1uuCTToigVnyRH+c0T2AezTeoFb7ne3I538hWeTdU5q9jGCBLcwggSz
# AgEBMHAwWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MgISESENFrJbjBGW0/5XyYYR5rrZMAkGBSsOAwIaBQCgeDAYBgorBgEEAYI3AgEM
# MQowCKACgAChAoAAMBkGCSqGSIb3DQEJAzEMBgorBgEEAYI3AgEEMBwGCisGAQQB
# gjcCAQsxDjAMBgorBgEEAYI3AgEVMCMGCSqGSIb3DQEJBDEWBBTErHEfVbirWqhp
# 5p9Jeu/6VzFuyzANBgkqhkiG9w0BAQEFAASCAQBZPp2bJZOzAy+uKiGrppjTpUfy
# 1LZwM0f5LGB8iFQMeYpTb8oU4KyrJklAJyDw5wSY5MqywuCtHZQQgoku2LZCS2oF
# OJjUjeogZZFgXdteNN4eW/8o9q8oVgoBszwhqWctdZBEmu3jK3vqbMmtYx95Rf4w
# m+zWEj7oBIjNLVoMM1C9GRiCVO6SNxq9UVdelWnpGK11MlufR9vK36jp0peoRP3R
# rSwtTguTARjLK0rZehKZgJ8MW7Sn18P8LzBCaPl5VaefhNW87Mg3TRKaDUV91s6y
# sbtjd3eTf0MtCyFX+Pssi4EprCRJf3t3NAnli8ISdNPdmis84WDzC8zsur9xoYIC
# ojCCAp4GCSqGSIb3DQEJBjGCAo8wggKLAgEBMGgwUjELMAkGA1UEBhMCQkUxGTAX
# BgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGlt
# ZXN0YW1waW5nIENBIC0gRzICEhEh1pmnZJc+8fhCfukZzFNBFDAJBgUrDgMCGgUA
# oIH9MBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTE2
# MDgzMTE5MTY1MlowIwYJKoZIhvcNAQkEMRYEFKuiUV7MTmlbgKDQ/lolwTMBF7ZS
# MIGdBgsqhkiG9w0BCRACDDGBjTCBijCBhzCBhAQUY7gvq2H1g5CWlQULACScUCkz
# 7HkwbDBWpFQwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYt
# c2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzICEhEh
# 1pmnZJc+8fhCfukZzFNBFDANBgkqhkiG9w0BAQEFAASCAQBpnpFJQdDTzjyjj9gf
# Pteb5nZMZcJ6X2di4nZw5EdzizlXbFn51zbvIPUDmyvDPlAKCFpYG757XqlOl28W
# Sc226fWPVdyKv6Se6+AtqZm1/T9Secb0Q6qW7sqmswsU28ubkRhwHyaXy/EXogJD
# Enn3h9BR7zNpsrNttPoTH//Z6kbPBVSeu3A04bz3/WMo6xGRHxTNQES7YvzNch5q
# /98dRArJKx3QYCpXnHAJenjc/ns9/M4UBaaJwOhsokPC+FEFqVx9VPRjATef0sZj
# DBHy0CX8WrUqZDgQQObjMPR+fcLXvwRIuMw5/PtBJJFcyBpJgG0RRaBNOZZwCmEB
# l2a2
# SIG # End signature block
|
PowerShellCorpus/PowerShellGallery/biz.dfch.PS.Appclusive.Client/5.2.1.20161201/New-ExternalNode.ps1
|
New-ExternalNode.ps1
|
function New-ExternalNode {
<#
.SYNOPSIS
Creates a ExternalNode entry in Appclusive.
.DESCRIPTION
Creates a ExternalNode entry in Appclusive.
You must specify all four parameters 'Name', 'NodeId', 'ExternalId' and 'ExternalType'. If the entry already exists no update of the existing entry is performed.
.OUTPUTS
[biz.dfch.CS.Appclusive.Api.Core.ExternalNode]
.EXAMPLE
New-ApcExternalNode -Name "Arbitrary Name" -NodeId 42 -ExternalType ArbitraryType -ExternalId "http://example.com/api/items/1"
NodeId : 42
ExternalType : ArbitraryType
ExternalId : http://example.com/api/items/1
Id : 61059
Tid : 11111111-1111-1111-1111-111111111111
Name : Arbitrary Name
Description :
CreatedById : 1
ModifiedById : 1
Created : 22.08.2016 09:27:39 +02:00
Modified : 22.08.2016 09:27:39 +02:00
RowVersion : {0, 0, 0, 0...}
Node :
Properties : {}
Tenant :
CreatedBy :
ModifiedBy :
Create a new ExternalNode entry if it not already exists.
.LINK
Online Version: http://dfch.biz/biz/dfch/PS/Appclusive/Client/New-ExternalNode/
Set-ExternalNode: http://dfch.biz/biz/dfch/PS/Appclusive/Client/Set-ExternalNode/
.NOTES
See module manifest for dependencies and further requirements.
#>
[CmdletBinding(
SupportsShouldProcess = $true
,
ConfirmImpact = 'Low'
,
HelpURI = 'http://dfch.biz/biz/dfch/PS/Appclusive/Client/New-ExternalNode/'
)]
Param
(
# Specifies the name for this entity
[Parameter(Mandatory = $true, Position = 0)]
[ValidateNotNullOrEmpty()]
[string] $Name
,
# Specifies the Node id for this entity
[Parameter(Mandatory = $true, Position = 1)]
[ValidateRAnge(1, [long]::MaxValue)]
[long] $NodeId
,
# Specifies the External id for this entity
[Parameter(Mandatory = $true, Position = 2)]
[string] $ExternalId
,
# Specifies the EntityKind name for this entity
[Parameter(Mandatory = $true, Position = 3)]
[string] $ExternalType
,
# Specifies the attributes for this entity
[Parameter(Mandatory = $false)]
[Alias("Parameters")]
[Alias("Bags")]
[hashtable] $Attributes
,
# Specifies the description for this entity
[Parameter(Mandatory = $false)]
[string] $Description
,
# Service reference to Appclusive
[Parameter(Mandatory = $false)]
[Alias('Services')]
[hashtable] $svc = (Get-Variable -Name $MyInvocation.MyCommand.Module.PrivateData.MODULEVAR -ValueOnly).Services
)
Begin
{
trap { Log-Exception $_; break; }
$datBegin = [datetime]::Now;
[string] $fn = $MyInvocation.MyCommand.Name;
Log-Debug -fn $fn -msg ("CALL. svc '{0}'. Name '{1}'." -f ($svc -is [Object]), $Name) -fac 1;
# Parameter validation
Contract-Requires ($svc.Core -is [biz.dfch.CS.Appclusive.Api.Core.Core]) "Connect to the server before using the Cmdlet"
$EntitySetName = 'ExternalNodes';
}
# Begin
Process
{
trap { Log-Exception $_; break; }
# Default test variable for checking function response codes.
[Boolean] $fReturn = $false;
# Return values are always and only returned via OutputParameter.
$OutputParameter = $null;
$externalNodeContents = @($Name);
$exp = @();
$exp += "(tolower(Name) eq '{0}')" -f $Name.toLower();
$exp += "(tolower(ExternalId) eq '{0}')" -f $ExternalId.toLower();
$exp += "(NodeId eq {0}L)" -f $NodeId;
$FilterExpression = [String]::Join(' and ', $exp);
$entity = $svc.Core.$EntitySetName.AddQueryOption('$filter', $FilterExpression) | Select;
Contract-Assert (!$entity) 'Entity does already exist';
if($PSCmdlet.ShouldProcess($externalNodeContents))
{
$r = Set-ExternalNode @PSBoundParameters -CreateIfNotExist:$true;
$OutputParameter = $r;
}
$fReturn = $true;
}
# Process
End
{
$datEnd = [datetime]::Now;
Log-Debug -fn $fn -msg ("RET. fReturn: [{0}]. Execution time: [{1}]ms. Started: [{2}]." -f $fReturn, ($datEnd - $datBegin).TotalMilliseconds, $datBegin.ToString('yyyy-MM-dd HH:mm:ss.fffzzz')) -fac 2;
# Return values are always and only returned via OutputParameter.
return $OutputParameter;
}
# End
}
if($MyInvocation.ScriptName) { Export-ModuleMember -Function New-ExternalNode; }
#
# Copyright 2014-2015 d-fens GmbH
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SIG # Begin signature block
# MIIXDwYJKoZIhvcNAQcCoIIXADCCFvwCAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB
# gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR
# AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQUEn422/uoKjo1tOq9NSmw9kn1
# piagghHCMIIEFDCCAvygAwIBAgILBAAAAAABL07hUtcwDQYJKoZIhvcNAQEFBQAw
# VzELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNV
# BAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkdsb2JhbFNpZ24gUm9vdCBDQTAeFw0xMTA0
# MTMxMDAwMDBaFw0yODAxMjgxMjAwMDBaMFIxCzAJBgNVBAYTAkJFMRkwFwYDVQQK
# ExBHbG9iYWxTaWduIG52LXNhMSgwJgYDVQQDEx9HbG9iYWxTaWduIFRpbWVzdGFt
# cGluZyBDQSAtIEcyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAlO9l
# +LVXn6BTDTQG6wkft0cYasvwW+T/J6U00feJGr+esc0SQW5m1IGghYtkWkYvmaCN
# d7HivFzdItdqZ9C76Mp03otPDbBS5ZBb60cO8eefnAuQZT4XljBFcm05oRc2yrmg
# jBtPCBn2gTGtYRakYua0QJ7D/PuV9vu1LpWBmODvxevYAll4d/eq41JrUJEpxfz3
# zZNl0mBhIvIG+zLdFlH6Dv2KMPAXCae78wSuq5DnbN96qfTvxGInX2+ZbTh0qhGL
# 2t/HFEzphbLswn1KJo/nVrqm4M+SU4B09APsaLJgvIQgAIMboe60dAXBKY5i0Eex
# +vBTzBj5Ljv5cH60JQIDAQABo4HlMIHiMA4GA1UdDwEB/wQEAwIBBjASBgNVHRMB
# Af8ECDAGAQH/AgEAMB0GA1UdDgQWBBRG2D7/3OO+/4Pm9IWbsN1q1hSpwTBHBgNV
# HSAEQDA+MDwGBFUdIAAwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93d3cuZ2xvYmFs
# c2lnbi5jb20vcmVwb3NpdG9yeS8wMwYDVR0fBCwwKjAooCagJIYiaHR0cDovL2Ny
# bC5nbG9iYWxzaWduLm5ldC9yb290LmNybDAfBgNVHSMEGDAWgBRge2YaRQ2XyolQ
# L30EzTSo//z9SzANBgkqhkiG9w0BAQUFAAOCAQEATl5WkB5GtNlJMfO7FzkoG8IW
# 3f1B3AkFBJtvsqKa1pkuQJkAVbXqP6UgdtOGNNQXzFU6x4Lu76i6vNgGnxVQ380W
# e1I6AtcZGv2v8Hhc4EvFGN86JB7arLipWAQCBzDbsBJe/jG+8ARI9PBw+DpeVoPP
# PfsNvPTF7ZedudTbpSeE4zibi6c1hkQgpDttpGoLoYP9KOva7yj2zIhd+wo7AKvg
# IeviLzVsD440RZfroveZMzV+y5qKu0VN5z+fwtmK+mWybsd+Zf/okuEsMaL3sCc2
# SI8mbzvuTXYfecPlf5Y1vC0OzAGwjn//UYCAp5LUs0RGZIyHTxZjBzFLY7Df8zCC
# BCkwggMRoAMCAQICCwQAAAAAATGJxjfoMA0GCSqGSIb3DQEBCwUAMEwxIDAeBgNV
# BAsTF0dsb2JhbFNpZ24gUm9vdCBDQSAtIFIzMRMwEQYDVQQKEwpHbG9iYWxTaWdu
# MRMwEQYDVQQDEwpHbG9iYWxTaWduMB4XDTExMDgwMjEwMDAwMFoXDTE5MDgwMjEw
# MDAwMFowWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKPv0Z8p6djTgnY8YqDS
# SdYWHvHP8NC6SEMDLacd8gE0SaQQ6WIT9BP0FoO11VdCSIYrlViH6igEdMtyEQ9h
# JuH6HGEVxyibTQuCDyYrkDqW7aTQaymc9WGI5qRXb+70cNCNF97mZnZfdB5eDFM4
# XZD03zAtGxPReZhUGks4BPQHxCMD05LL94BdqpxWBkQtQUxItC3sNZKaxpXX9c6Q
# MeJ2s2G48XVXQqw7zivIkEnotybPuwyJy9DDo2qhydXjnFMrVyb+Vpp2/WFGomDs
# KUZH8s3ggmLGBFrn7U5AXEgGfZ1f53TJnoRlDVve3NMkHLQUEeurv8QfpLqZ0BdY
# Nc0CAwEAAaOB/TCB+jAOBgNVHQ8BAf8EBAMCAQYwEgYDVR0TAQH/BAgwBgEB/wIB
# ADAdBgNVHQ4EFgQUGUq4WuRNMaUU5V7sL6Mc+oCMMmswRwYDVR0gBEAwPjA8BgRV
# HSAAMDQwMgYIKwYBBQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3Jl
# cG9zaXRvcnkvMDYGA1UdHwQvMC0wK6ApoCeGJWh0dHA6Ly9jcmwuZ2xvYmFsc2ln
# bi5uZXQvcm9vdC1yMy5jcmwwEwYDVR0lBAwwCgYIKwYBBQUHAwMwHwYDVR0jBBgw
# FoAUj/BLf6guRSSuTVD6Y5qL3uLdG7wwDQYJKoZIhvcNAQELBQADggEBAHmwaTTi
# BYf2/tRgLC+GeTQD4LEHkwyEXPnk3GzPbrXsCly6C9BoMS4/ZL0Pgmtmd4F/ximl
# F9jwiU2DJBH2bv6d4UgKKKDieySApOzCmgDXsG1szYjVFXjPE/mIpXNNwTYr3MvO
# 23580ovvL72zT006rbtibiiTxAzL2ebK4BEClAOwvT+UKFaQHlPCJ9XJPM0aYx6C
# WRW2QMqngarDVa8z0bV16AnqRwhIIvtdG/Mseml+xddaXlYzPK1X6JMlQsPSXnE7
# ShxU7alVrCgFx8RsXdw8k/ZpPIJRzhoVPV4Bc/9Aouq0rtOO+u5dbEfHQfXUVlfy
# GDcy1tTMS/Zx4HYwggSfMIIDh6ADAgECAhIRIdaZp2SXPvH4Qn7pGcxTQRQwDQYJ
# KoZIhvcNAQEFBQAwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24g
# bnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzIw
# HhcNMTYwNTI0MDAwMDAwWhcNMjcwNjI0MDAwMDAwWjBgMQswCQYDVQQGEwJTRzEf
# MB0GA1UEChMWR01PIEdsb2JhbFNpZ24gUHRlIEx0ZDEwMC4GA1UEAxMnR2xvYmFs
# U2lnbiBUU0EgZm9yIE1TIEF1dGhlbnRpY29kZSAtIEcyMIIBIjANBgkqhkiG9w0B
# AQEFAAOCAQ8AMIIBCgKCAQEAsBeuotO2BDBWHlgPse1VpNZUy9j2czrsXV6rJf02
# pfqEw2FAxUa1WVI7QqIuXxNiEKlb5nPWkiWxfSPjBrOHOg5D8NcAiVOiETFSKG5d
# QHI88gl3p0mSl9RskKB2p/243LOd8gdgLE9YmABr0xVU4Prd/4AsXximmP/Uq+yh
# RVmyLm9iXeDZGayLV5yoJivZF6UQ0kcIGnAsM4t/aIAqtaFda92NAgIpA6p8N7u7
# KU49U5OzpvqP0liTFUy5LauAo6Ml+6/3CGSwekQPXBDXX2E3qk5r09JTJZ2Cc/os
# +XKwqRk5KlD6qdA8OsroW+/1X1H0+QrZlzXeaoXmIwRCrwIDAQABo4IBXzCCAVsw
# DgYDVR0PAQH/BAQDAgeAMEwGA1UdIARFMEMwQQYJKwYBBAGgMgEeMDQwMgYIKwYB
# BQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3JlcG9zaXRvcnkvMAkG
# A1UdEwQCMAAwFgYDVR0lAQH/BAwwCgYIKwYBBQUHAwgwQgYDVR0fBDswOTA3oDWg
# M4YxaHR0cDovL2NybC5nbG9iYWxzaWduLmNvbS9ncy9nc3RpbWVzdGFtcGluZ2cy
# LmNybDBUBggrBgEFBQcBAQRIMEYwRAYIKwYBBQUHMAKGOGh0dHA6Ly9zZWN1cmUu
# Z2xvYmFsc2lnbi5jb20vY2FjZXJ0L2dzdGltZXN0YW1waW5nZzIuY3J0MB0GA1Ud
# DgQWBBTUooRKOFoYf7pPMFC9ndV6h9YJ9zAfBgNVHSMEGDAWgBRG2D7/3OO+/4Pm
# 9IWbsN1q1hSpwTANBgkqhkiG9w0BAQUFAAOCAQEAj6kakW0EpjcgDoOW3iPTa24f
# bt1kPWghIrX4RzZpjuGlRcckoiK3KQnMVFquxrzNY46zPVBI5bTMrs2SjZ4oixNK
# Eaq9o+/Tsjb8tKFyv22XY3mMRLxwL37zvN2CU6sa9uv6HJe8tjecpBwwvKu8LUc2
# 35IgA+hxxlj2dQWaNPALWVqCRDSqgOQvhPZHXZbJtsrKnbemuuRQ09Q3uLogDtDT
# kipbxFm7oW3bPM5EncE4Kq3jjb3NCXcaEL5nCgI2ZIi5sxsm7ueeYMRGqLxhM2zP
# TrmcuWrwnzf+tT1PmtNN/94gjk6Xpv2fCbxNyhh2ybBNhVDygNIdBvVYBAexGDCC
# BNYwggO+oAMCAQICEhEhDRayW4wRltP+V8mGEea62TANBgkqhkiG9w0BAQsFADBa
# MQswCQYDVQQGEwJCRTEZMBcGA1UEChMQR2xvYmFsU2lnbiBudi1zYTEwMC4GA1UE
# AxMnR2xvYmFsU2lnbiBDb2RlU2lnbmluZyBDQSAtIFNIQTI1NiAtIEcyMB4XDTE1
# MDUwNDE2NDMyMVoXDTE4MDUwNDE2NDMyMVowVTELMAkGA1UEBhMCQ0gxDDAKBgNV
# BAgTA1p1ZzEMMAoGA1UEBxMDWnVnMRQwEgYDVQQKEwtkLWZlbnMgR21iSDEUMBIG
# A1UEAxMLZC1mZW5zIEdtYkgwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB
# AQDNPSzSNPylU9jFM78Q/GjzB7N+VNqikf/use7p8mpnBZ4cf5b4qV3rqQd62rJH
# RlAsxgouCSNQrl8xxfg6/t/I02kPvrzsR4xnDgMiVCqVRAeQsWebafWdTvWmONBS
# lxJejPP8TSgXMKFaDa+2HleTycTBYSoErAZSWpQ0NqF9zBadjsJRVatQuPkTDrwL
# eWibiyOipK9fcNoQpl5ll5H9EG668YJR3fqX9o0TQTkOmxXIL3IJ0UxdpyDpLEkt
# tBG6Y5wAdpF2dQX2phrfFNVY54JOGtuBkNGMSiLFzTkBA1fOlA6ICMYjB8xIFxVv
# rN1tYojCrqYkKMOjwWQz5X8zAgMBAAGjggGZMIIBlTAOBgNVHQ8BAf8EBAMCB4Aw
# TAYDVR0gBEUwQzBBBgkrBgEEAaAyATIwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93
# d3cuZ2xvYmFsc2lnbi5jb20vcmVwb3NpdG9yeS8wCQYDVR0TBAIwADATBgNVHSUE
# DDAKBggrBgEFBQcDAzBCBgNVHR8EOzA5MDegNaAzhjFodHRwOi8vY3JsLmdsb2Jh
# bHNpZ24uY29tL2dzL2dzY29kZXNpZ25zaGEyZzIuY3JsMIGQBggrBgEFBQcBAQSB
# gzCBgDBEBggrBgEFBQcwAoY4aHR0cDovL3NlY3VyZS5nbG9iYWxzaWduLmNvbS9j
# YWNlcnQvZ3Njb2Rlc2lnbnNoYTJnMi5jcnQwOAYIKwYBBQUHMAGGLGh0dHA6Ly9v
# Y3NwMi5nbG9iYWxzaWduLmNvbS9nc2NvZGVzaWduc2hhMmcyMB0GA1UdDgQWBBTN
# GDddiIYZy9p3Z84iSIMd27rtUDAfBgNVHSMEGDAWgBQZSrha5E0xpRTlXuwvoxz6
# gIwyazANBgkqhkiG9w0BAQsFAAOCAQEAAApsOzSX1alF00fTeijB/aIthO3UB0ks
# 1Gg3xoKQC1iEQmFG/qlFLiufs52kRPN7L0a7ClNH3iQpaH5IEaUENT9cNEXdKTBG
# 8OrJS8lrDJXImgNEgtSwz0B40h7bM2Z+0DvXDvpmfyM2NwHF/nNVj7NzmczrLRqN
# 9de3tV0pgRqnIYordVcmb24CZl3bzpwzbQQy14Iz+P5Z2cnw+QaYzAuweTZxEUcJ
# bFwpM49c1LMPFJTuOKkUgY90JJ3gVTpyQxfkc7DNBnx74PlRzjFmeGC/hxQt0hvo
# eaAiBdjo/1uuCTToigVnyRH+c0T2AezTeoFb7ne3I538hWeTdU5q9jGCBLcwggSz
# AgEBMHAwWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MgISESENFrJbjBGW0/5XyYYR5rrZMAkGBSsOAwIaBQCgeDAYBgorBgEEAYI3AgEM
# MQowCKACgAChAoAAMBkGCSqGSIb3DQEJAzEMBgorBgEEAYI3AgEEMBwGCisGAQQB
# gjcCAQsxDjAMBgorBgEEAYI3AgEVMCMGCSqGSIb3DQEJBDEWBBQvj7t7A0JrrOGY
# nonRnnLEIiCStjANBgkqhkiG9w0BAQEFAASCAQBOeD67uULj6we7xwwu/nnYeLan
# 1N+OmY+dIkyxn+9EfizzUhc4l7Vx2AUOETLVSxFvEACn7/aocRa/Rd6GPIMc6sPv
# BIGA1WcrI/AVVhhXdi5r065zfm/49V1SlrsPonPSJY2d75+Ab4P9nWczZRfiXqA8
# CuhHE0TM37bQdjRd5MlhsP7qwiDN7T5H63DBMRRVqwWuzFU7MbLeKesqP9KpSVM5
# Saz5S8m01I/6TcZylmHyTnHkUV4Qt1zx81cNnyLoHrmfsseLTYUThaKsfowdOow4
# 3ObFeU+LpjgmD9dYEh2Isx5bQp10v+7srS/lM36Vq0IuxL1tvNpB1HzkHWteoYIC
# ojCCAp4GCSqGSIb3DQEJBjGCAo8wggKLAgEBMGgwUjELMAkGA1UEBhMCQkUxGTAX
# BgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGlt
# ZXN0YW1waW5nIENBIC0gRzICEhEh1pmnZJc+8fhCfukZzFNBFDAJBgUrDgMCGgUA
# oIH9MBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTE2
# MDgzMTE5MTY1MlowIwYJKoZIhvcNAQkEMRYEFGmKGwC5XH2FSmRG5MsI4mq1tSBl
# MIGdBgsqhkiG9w0BCRACDDGBjTCBijCBhzCBhAQUY7gvq2H1g5CWlQULACScUCkz
# 7HkwbDBWpFQwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYt
# c2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzICEhEh
# 1pmnZJc+8fhCfukZzFNBFDANBgkqhkiG9w0BAQEFAASCAQBCjh+Hoau0CDJIwSYZ
# Kypv358DUlYv3Esaw6CbYGremt9t2/vDTpN4ChWu5cuLpM+u3VTpFLguhqmGL7Ae
# ejk4sAvmlLOqoD+bWAruJ4kMts130WA0VsCI4/atrya8mdRWodH0Lp644TVhfrcv
# arj3OopS0PAFdfcRTNadj6CeuQArpMpjlvTapaHTqqOyO6CfFBSkLw2O7bYhcymm
# YO/T3Ory7E5DS4TI7Euo0P6PDdWCEHm+Ys2s8XsCLWof1FEJRB7cE+IudmB8Csf+
# 4P5N1+s7AgJqMztXAUWNinuUKGxDMffD1AVkPp686LKJPda/072XGeop9oo0yq7d
# f+te
# SIG # End signature block
|
PowerShellCorpus/PowerShellGallery/biz.dfch.PS.Appclusive.Client/5.2.1.20161201/Get-Tenant.ps1
|
Get-Tenant.ps1
|
function Get-Tenant {
<#
.SYNOPSIS
Get tenant from the systems.
.DESCRIPTION
Get tenant from the systems.
You can search for tenants in the appclusive orch. There fore you can enter a name, guid or list all available tenants.
.INPUTS
The Cmdlet can either return all available tenants or filter entities on
specified conditions.
See PARAMETERS section on possible inputs.
.OUTPUTS
default | json | json-pretty | xml | xml-pretty
.EXAMPLE
Get-Tenant
Id : 33333333-3333-3333-3333-333333333333
Name : GROUP_TENANT
Description : GROUP_TENANT
ExternalId : 33333333-3333-3333-3333-333333333333
ExternalType : Internal
CreatedById : 1
ModifiedById : 1
Created : 14.12.2015 16:12:47 +00:00
Modified : 14.12.2015 16:12:47 +00:00
RowVersion : {0, 0, 0, 0...}
ParentId : 33333333-3333-3333-3333-333333333333
CustomerId :
Parent :
Customer :
Children : {}
Id : 22222222-2222-2222-2222-222222222222
Name : HOME_TENANT
Description : HOME_TENANT
ExternalId : 22222222-2222-2222-2222-222222222222
ExternalType : Internal
CreatedById : 1
ModifiedById : 1
Created : 14.12.2015 16:12:47 +00:00
Modified : 14.12.2015 16:12:47 +00:00
RowVersion : {0, 0, 0, 0...}
ParentId : 22222222-2222-2222-2222-222222222222
CustomerId :
Parent :
Customer :
Children : {}
Return all available tenants. This is the same as Get-ApcTenant -ListAvailable.
.EXAMPLE
Get-ApcTenant -Id 'bb7580a0-5d34-40b2-9851-86c66443f304'
Id : bb7580a0-5d34-40b2-9851-86c66443f304
Name : Managed Service Tenant
Description : Manage Service Tenant
(previously 2e2435b9-5a68-4d15-acc2-ca42aaa000fe)
ExternalId : d3a08f77-f848-4757-b7f2-1600ad851a0a
ExternalType : External
CreatedById : 1
ModifiedById : 1014
Created : 07.03.2016 00:00:00 +01:00
Modified : 15.03.2016 10:54:04 +01:00
RowVersion : {0, 0, 0, 0...}
ParentId : 11111111-1111-1111-1111-111111111111
CustomerId :
Parent :
Customer :
Children : {}
Return the tenant with the id "bb7580a0-5d34-40b2-9851-86c66443f304".
.EXAMPLE
Get-ApcTenant -Name "Te" -TenantTyp Internal
Id : 11111111-1111-1111-1111-111111111111
Name : SYSTEM_TENANT
Description : SYSTEM_TENANT
ExternalId : 11111111-1111-1111-1111-111111111111
ExternalType : Internal
CreatedById : 1
ModifiedById : 1
Created : 14.12.2015 16:12:47 +00:00
Modified : 06.01.2016 18:13:00 +01:00
RowVersion : {0, 0, 0, 0...}
ParentId : 11111111-1111-1111-1111-111111111111
CustomerId : 2
Parent :
Customer :
Children : {}
Id : 22222222-2222-2222-2222-222222222222
Name : HOME_TENANT
Description : HOME_TENANT
ExternalId : 22222222-2222-2222-2222-222222222222
ExternalType : Internal
CreatedById : 1
ModifiedById : 1
Created : 14.12.2015 16:12:47 +00:00
Modified : 14.12.2015 16:12:47 +00:00
RowVersion : {0, 0, 0, 0...}
ParentId : 22222222-2222-2222-2222-222222222222
CustomerId :
Parent :
Customer :
Children : {}
Id : 33333333-3333-3333-3333-333333333333
Name : GROUP_TENANT
...
This call return all tenants where the name "te" include and the ExternalType "Internal" is.
.EXAMPLE
# Gets information about the tenant of the currently logged in user
PS > $tenantInformation = Get-Tenant -Current;
PS > $tenantInformation
Id : e3c70408-9da0-45f2-ab7b-29d1081e948a
ParentId : d9c2feda-f3da-488a-8dd3-3747e40b6c6a
NodeId : 42
JobId : 123
CustomerId : 5
ConfigurationId : 43
BuiltInRoles : biz.dfch.CS.Appclusive.Core.Managers.BuiltInRoles
PS > $tenantInformation.BuiltInRoles
CloudAdmin : 14
CloudUser : 15
CloudGuest : 16
CreatorOwner : 12
Everyone : 13
AppclusiveEveryone : 5
.LINK
Online Version: http://dfch.biz/biz/dfch/PS/Appclusive/Client/Get-Tenant/
.NOTES
See module manifest for required software versions and dependencies.
#>
[CmdletBinding(
ConfirmImpact = 'Low'
,
HelpURI = 'http://dfch.biz/biz/dfch/PS/Appclusive/Client/Get-Tenant/'
,
DefaultParameterSetName = 'list'
)]
PARAM
(
# Lists all tenants
[Parameter(Mandatory = $false, ParameterSetName = 'list')]
[switch] $ListAvailable
,
# Tenant id to search for
[Parameter(Mandatory = $false, Position = 0, ParameterSetName = 'Id')]
[Guid] $Id
,
# Specifies to return all child with this tenant id
[Parameter(Mandatory = $false, ParameterSetName = 'Parent')]
[Guid] $ParentId
,
# External Tenant id
[Parameter(Mandatory = $false, ParameterSetName = 'ExternalId')]
[string] $ExternalId
,
# Tenant name or a part of it to search for
[Parameter(Mandatory = $false, Position = 0, ParameterSetName = 'Name')]
[ValidateNotNullOrEmpty()]
[string] $Name
,
# Specifies the type of tenant to search for
[ValidateSet('External', 'Internal')]
[Parameter(Mandatory = $false)]
[string] $ExternalType
,
# Service reference to Appclusive
[Parameter(Mandatory = $false)]
[Alias('Services')]
[hashtable] $svc = (Get-Variable -Name $MyInvocation.MyCommand.Module.PrivateData.MODULEVAR -ValueOnly).Services
,
# Specifies the return format of the Cmdlet
[ValidateSet('default', 'json', 'json-pretty', 'xml', 'xml-pretty')]
[Parameter(Mandatory = $false)]
[Alias('ReturnFormat')]
[string] $As = 'default'
,
# Specifies to retrieve tenant information about the currently logged in user
[Parameter(Mandatory = $false, ParameterSetName = 'current')]
[alias('WhoAmI')]
[switch] $Current = $false
)
Begin
{
trap { Log-Exception $_; break; }
$datBegin = [datetime]::Now;
[string] $fn = $MyInvocation.MyCommand.Name;
Log-Debug -fn $fn -msg ("CALL. svc '{0}'. Name '{1}'." -f ($svc -is [Object]), $Name) -fac 1;
Contract-Requires ($svc.Core -is [biz.dfch.CS.Appclusive.Api.Core.Core]) "Connect to the server before using the Cmdlet"
$EntitySetName = 'Tenants';
}
# Begin
Process
{
trap { Log-Exception $_; break; }
# Default test variable for checking function response codes.
[Boolean] $fReturn = $false;
if($PSCmdlet.ParameterSetName -eq 'list')
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$orderby','Name') | Select;
}
elseif($PSCmdlet.ParameterSetName -eq 'current')
{
$Response = $svc.Core.InvokeEntitySetActionWithSingleResult("Tenants", 'Current', [biz.dfch.CS.Appclusive.Core.Managers.TenantManagerInformation], $null);
}
else
{
$Exp = @();
if ($PSCmdlet.ParameterSetName -eq 'Id')
{
$Exp += ("Id eq guid'{0}'" -f $Id.Guid);
}
elseif ($PSCmdlet.ParameterSetName -eq 'Parent')
{
$Exp += ("ParentId eq guid'{0}'" -f $ParentId.Guid);
}
elseif ($PSCmdlet.ParameterSetName -eq 'ExternalId')
{
$Exp += ("ExternalId eq '{0}'" -f $ExternalId);
}
elseif ($PSCmdlet.ParameterSetName -eq 'Name')
{
$Exp += ("substringof('{0}', tolower(Name))" -f $Name.ToLower());
}
if($ExternalType)
{
$Exp += ("ExternalType eq '{0}'" -f $ExternalType);
}
$FilterExpression = [string]::Join(' and ', $Exp);
$Response = $svc.Core.$EntitySetName.AddQueryOption('$filter', $FilterExpression) | Select;
}
$OutputParameter = Format-ResultAs $Response $As
$fReturn = $true;
}
# Process
End
{
$datEnd = [datetime]::Now;
Log-Debug -fn $fn -msg ("RET. fReturn: [{0}]. Execution time: [{1}]ms. Started: [{2}]." -f $fReturn, ($datEnd - $datBegin).TotalMilliseconds, $datBegin.ToString('yyyy-MM-dd HH:mm:ss.fffzzz')) -fac 2;
# Return values are always and only returned via OutputParameter.
return $OutputParameter;
}
} # function
if($MyInvocation.ScriptName) { Export-ModuleMember -Function Get-Tenant; }
#
# Copyright 2016 d-fens GmbH
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SIG # Begin signature block
# MIIXDwYJKoZIhvcNAQcCoIIXADCCFvwCAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB
# gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR
# AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQUpt8ojnFGt2OoAaZw6QjPQwYY
# nUagghHCMIIEFDCCAvygAwIBAgILBAAAAAABL07hUtcwDQYJKoZIhvcNAQEFBQAw
# VzELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNV
# BAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkdsb2JhbFNpZ24gUm9vdCBDQTAeFw0xMTA0
# MTMxMDAwMDBaFw0yODAxMjgxMjAwMDBaMFIxCzAJBgNVBAYTAkJFMRkwFwYDVQQK
# ExBHbG9iYWxTaWduIG52LXNhMSgwJgYDVQQDEx9HbG9iYWxTaWduIFRpbWVzdGFt
# cGluZyBDQSAtIEcyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAlO9l
# +LVXn6BTDTQG6wkft0cYasvwW+T/J6U00feJGr+esc0SQW5m1IGghYtkWkYvmaCN
# d7HivFzdItdqZ9C76Mp03otPDbBS5ZBb60cO8eefnAuQZT4XljBFcm05oRc2yrmg
# jBtPCBn2gTGtYRakYua0QJ7D/PuV9vu1LpWBmODvxevYAll4d/eq41JrUJEpxfz3
# zZNl0mBhIvIG+zLdFlH6Dv2KMPAXCae78wSuq5DnbN96qfTvxGInX2+ZbTh0qhGL
# 2t/HFEzphbLswn1KJo/nVrqm4M+SU4B09APsaLJgvIQgAIMboe60dAXBKY5i0Eex
# +vBTzBj5Ljv5cH60JQIDAQABo4HlMIHiMA4GA1UdDwEB/wQEAwIBBjASBgNVHRMB
# Af8ECDAGAQH/AgEAMB0GA1UdDgQWBBRG2D7/3OO+/4Pm9IWbsN1q1hSpwTBHBgNV
# HSAEQDA+MDwGBFUdIAAwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93d3cuZ2xvYmFs
# c2lnbi5jb20vcmVwb3NpdG9yeS8wMwYDVR0fBCwwKjAooCagJIYiaHR0cDovL2Ny
# bC5nbG9iYWxzaWduLm5ldC9yb290LmNybDAfBgNVHSMEGDAWgBRge2YaRQ2XyolQ
# L30EzTSo//z9SzANBgkqhkiG9w0BAQUFAAOCAQEATl5WkB5GtNlJMfO7FzkoG8IW
# 3f1B3AkFBJtvsqKa1pkuQJkAVbXqP6UgdtOGNNQXzFU6x4Lu76i6vNgGnxVQ380W
# e1I6AtcZGv2v8Hhc4EvFGN86JB7arLipWAQCBzDbsBJe/jG+8ARI9PBw+DpeVoPP
# PfsNvPTF7ZedudTbpSeE4zibi6c1hkQgpDttpGoLoYP9KOva7yj2zIhd+wo7AKvg
# IeviLzVsD440RZfroveZMzV+y5qKu0VN5z+fwtmK+mWybsd+Zf/okuEsMaL3sCc2
# SI8mbzvuTXYfecPlf5Y1vC0OzAGwjn//UYCAp5LUs0RGZIyHTxZjBzFLY7Df8zCC
# BCkwggMRoAMCAQICCwQAAAAAATGJxjfoMA0GCSqGSIb3DQEBCwUAMEwxIDAeBgNV
# BAsTF0dsb2JhbFNpZ24gUm9vdCBDQSAtIFIzMRMwEQYDVQQKEwpHbG9iYWxTaWdu
# MRMwEQYDVQQDEwpHbG9iYWxTaWduMB4XDTExMDgwMjEwMDAwMFoXDTE5MDgwMjEw
# MDAwMFowWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKPv0Z8p6djTgnY8YqDS
# SdYWHvHP8NC6SEMDLacd8gE0SaQQ6WIT9BP0FoO11VdCSIYrlViH6igEdMtyEQ9h
# JuH6HGEVxyibTQuCDyYrkDqW7aTQaymc9WGI5qRXb+70cNCNF97mZnZfdB5eDFM4
# XZD03zAtGxPReZhUGks4BPQHxCMD05LL94BdqpxWBkQtQUxItC3sNZKaxpXX9c6Q
# MeJ2s2G48XVXQqw7zivIkEnotybPuwyJy9DDo2qhydXjnFMrVyb+Vpp2/WFGomDs
# KUZH8s3ggmLGBFrn7U5AXEgGfZ1f53TJnoRlDVve3NMkHLQUEeurv8QfpLqZ0BdY
# Nc0CAwEAAaOB/TCB+jAOBgNVHQ8BAf8EBAMCAQYwEgYDVR0TAQH/BAgwBgEB/wIB
# ADAdBgNVHQ4EFgQUGUq4WuRNMaUU5V7sL6Mc+oCMMmswRwYDVR0gBEAwPjA8BgRV
# HSAAMDQwMgYIKwYBBQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3Jl
# cG9zaXRvcnkvMDYGA1UdHwQvMC0wK6ApoCeGJWh0dHA6Ly9jcmwuZ2xvYmFsc2ln
# bi5uZXQvcm9vdC1yMy5jcmwwEwYDVR0lBAwwCgYIKwYBBQUHAwMwHwYDVR0jBBgw
# FoAUj/BLf6guRSSuTVD6Y5qL3uLdG7wwDQYJKoZIhvcNAQELBQADggEBAHmwaTTi
# BYf2/tRgLC+GeTQD4LEHkwyEXPnk3GzPbrXsCly6C9BoMS4/ZL0Pgmtmd4F/ximl
# F9jwiU2DJBH2bv6d4UgKKKDieySApOzCmgDXsG1szYjVFXjPE/mIpXNNwTYr3MvO
# 23580ovvL72zT006rbtibiiTxAzL2ebK4BEClAOwvT+UKFaQHlPCJ9XJPM0aYx6C
# WRW2QMqngarDVa8z0bV16AnqRwhIIvtdG/Mseml+xddaXlYzPK1X6JMlQsPSXnE7
# ShxU7alVrCgFx8RsXdw8k/ZpPIJRzhoVPV4Bc/9Aouq0rtOO+u5dbEfHQfXUVlfy
# GDcy1tTMS/Zx4HYwggSfMIIDh6ADAgECAhIRIdaZp2SXPvH4Qn7pGcxTQRQwDQYJ
# KoZIhvcNAQEFBQAwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24g
# bnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzIw
# HhcNMTYwNTI0MDAwMDAwWhcNMjcwNjI0MDAwMDAwWjBgMQswCQYDVQQGEwJTRzEf
# MB0GA1UEChMWR01PIEdsb2JhbFNpZ24gUHRlIEx0ZDEwMC4GA1UEAxMnR2xvYmFs
# U2lnbiBUU0EgZm9yIE1TIEF1dGhlbnRpY29kZSAtIEcyMIIBIjANBgkqhkiG9w0B
# AQEFAAOCAQ8AMIIBCgKCAQEAsBeuotO2BDBWHlgPse1VpNZUy9j2czrsXV6rJf02
# pfqEw2FAxUa1WVI7QqIuXxNiEKlb5nPWkiWxfSPjBrOHOg5D8NcAiVOiETFSKG5d
# QHI88gl3p0mSl9RskKB2p/243LOd8gdgLE9YmABr0xVU4Prd/4AsXximmP/Uq+yh
# RVmyLm9iXeDZGayLV5yoJivZF6UQ0kcIGnAsM4t/aIAqtaFda92NAgIpA6p8N7u7
# KU49U5OzpvqP0liTFUy5LauAo6Ml+6/3CGSwekQPXBDXX2E3qk5r09JTJZ2Cc/os
# +XKwqRk5KlD6qdA8OsroW+/1X1H0+QrZlzXeaoXmIwRCrwIDAQABo4IBXzCCAVsw
# DgYDVR0PAQH/BAQDAgeAMEwGA1UdIARFMEMwQQYJKwYBBAGgMgEeMDQwMgYIKwYB
# BQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3JlcG9zaXRvcnkvMAkG
# A1UdEwQCMAAwFgYDVR0lAQH/BAwwCgYIKwYBBQUHAwgwQgYDVR0fBDswOTA3oDWg
# M4YxaHR0cDovL2NybC5nbG9iYWxzaWduLmNvbS9ncy9nc3RpbWVzdGFtcGluZ2cy
# LmNybDBUBggrBgEFBQcBAQRIMEYwRAYIKwYBBQUHMAKGOGh0dHA6Ly9zZWN1cmUu
# Z2xvYmFsc2lnbi5jb20vY2FjZXJ0L2dzdGltZXN0YW1waW5nZzIuY3J0MB0GA1Ud
# DgQWBBTUooRKOFoYf7pPMFC9ndV6h9YJ9zAfBgNVHSMEGDAWgBRG2D7/3OO+/4Pm
# 9IWbsN1q1hSpwTANBgkqhkiG9w0BAQUFAAOCAQEAj6kakW0EpjcgDoOW3iPTa24f
# bt1kPWghIrX4RzZpjuGlRcckoiK3KQnMVFquxrzNY46zPVBI5bTMrs2SjZ4oixNK
# Eaq9o+/Tsjb8tKFyv22XY3mMRLxwL37zvN2CU6sa9uv6HJe8tjecpBwwvKu8LUc2
# 35IgA+hxxlj2dQWaNPALWVqCRDSqgOQvhPZHXZbJtsrKnbemuuRQ09Q3uLogDtDT
# kipbxFm7oW3bPM5EncE4Kq3jjb3NCXcaEL5nCgI2ZIi5sxsm7ueeYMRGqLxhM2zP
# TrmcuWrwnzf+tT1PmtNN/94gjk6Xpv2fCbxNyhh2ybBNhVDygNIdBvVYBAexGDCC
# BNYwggO+oAMCAQICEhEhDRayW4wRltP+V8mGEea62TANBgkqhkiG9w0BAQsFADBa
# MQswCQYDVQQGEwJCRTEZMBcGA1UEChMQR2xvYmFsU2lnbiBudi1zYTEwMC4GA1UE
# AxMnR2xvYmFsU2lnbiBDb2RlU2lnbmluZyBDQSAtIFNIQTI1NiAtIEcyMB4XDTE1
# MDUwNDE2NDMyMVoXDTE4MDUwNDE2NDMyMVowVTELMAkGA1UEBhMCQ0gxDDAKBgNV
# BAgTA1p1ZzEMMAoGA1UEBxMDWnVnMRQwEgYDVQQKEwtkLWZlbnMgR21iSDEUMBIG
# A1UEAxMLZC1mZW5zIEdtYkgwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB
# AQDNPSzSNPylU9jFM78Q/GjzB7N+VNqikf/use7p8mpnBZ4cf5b4qV3rqQd62rJH
# RlAsxgouCSNQrl8xxfg6/t/I02kPvrzsR4xnDgMiVCqVRAeQsWebafWdTvWmONBS
# lxJejPP8TSgXMKFaDa+2HleTycTBYSoErAZSWpQ0NqF9zBadjsJRVatQuPkTDrwL
# eWibiyOipK9fcNoQpl5ll5H9EG668YJR3fqX9o0TQTkOmxXIL3IJ0UxdpyDpLEkt
# tBG6Y5wAdpF2dQX2phrfFNVY54JOGtuBkNGMSiLFzTkBA1fOlA6ICMYjB8xIFxVv
# rN1tYojCrqYkKMOjwWQz5X8zAgMBAAGjggGZMIIBlTAOBgNVHQ8BAf8EBAMCB4Aw
# TAYDVR0gBEUwQzBBBgkrBgEEAaAyATIwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93
# d3cuZ2xvYmFsc2lnbi5jb20vcmVwb3NpdG9yeS8wCQYDVR0TBAIwADATBgNVHSUE
# DDAKBggrBgEFBQcDAzBCBgNVHR8EOzA5MDegNaAzhjFodHRwOi8vY3JsLmdsb2Jh
# bHNpZ24uY29tL2dzL2dzY29kZXNpZ25zaGEyZzIuY3JsMIGQBggrBgEFBQcBAQSB
# gzCBgDBEBggrBgEFBQcwAoY4aHR0cDovL3NlY3VyZS5nbG9iYWxzaWduLmNvbS9j
# YWNlcnQvZ3Njb2Rlc2lnbnNoYTJnMi5jcnQwOAYIKwYBBQUHMAGGLGh0dHA6Ly9v
# Y3NwMi5nbG9iYWxzaWduLmNvbS9nc2NvZGVzaWduc2hhMmcyMB0GA1UdDgQWBBTN
# GDddiIYZy9p3Z84iSIMd27rtUDAfBgNVHSMEGDAWgBQZSrha5E0xpRTlXuwvoxz6
# gIwyazANBgkqhkiG9w0BAQsFAAOCAQEAAApsOzSX1alF00fTeijB/aIthO3UB0ks
# 1Gg3xoKQC1iEQmFG/qlFLiufs52kRPN7L0a7ClNH3iQpaH5IEaUENT9cNEXdKTBG
# 8OrJS8lrDJXImgNEgtSwz0B40h7bM2Z+0DvXDvpmfyM2NwHF/nNVj7NzmczrLRqN
# 9de3tV0pgRqnIYordVcmb24CZl3bzpwzbQQy14Iz+P5Z2cnw+QaYzAuweTZxEUcJ
# bFwpM49c1LMPFJTuOKkUgY90JJ3gVTpyQxfkc7DNBnx74PlRzjFmeGC/hxQt0hvo
# eaAiBdjo/1uuCTToigVnyRH+c0T2AezTeoFb7ne3I538hWeTdU5q9jGCBLcwggSz
# AgEBMHAwWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MgISESENFrJbjBGW0/5XyYYR5rrZMAkGBSsOAwIaBQCgeDAYBgorBgEEAYI3AgEM
# MQowCKACgAChAoAAMBkGCSqGSIb3DQEJAzEMBgorBgEEAYI3AgEEMBwGCisGAQQB
# gjcCAQsxDjAMBgorBgEEAYI3AgEVMCMGCSqGSIb3DQEJBDEWBBTH8t05SclE1BOw
# IRh4vOtZBE/UHTANBgkqhkiG9w0BAQEFAASCAQChoZsUnbT/ToA3qWz2vljpohmF
# tg4rgjeuJfMrg/zEiQ4gRhogCmAi3czaE9mDfjsc5J9k2WtLMePbjP/Zj3pmFt1k
# WHRxq6IES1o/ivgeMQR+a+SgiIe0UR4g0DZeyxEyotcwEEtkjAb8FtUvypQSK0Hy
# kqAWVGgH2B5rIiJ6qJNVuiFWn8FPiwVMY/HQyJblYq7yndiRBlWpTevB1cyOKXmH
# MitdWEXn0wBtglIgSfNQe4tej8g7WQpsnsDwmkeABTeQRrAH00Vh10Tw9GKe6xAS
# XcexCJcX0fOmPjtFcuBTfksSlNd5vNk0Cecfo/cq3As7R58P6G+Xz9gHeT9yoYIC
# ojCCAp4GCSqGSIb3DQEJBjGCAo8wggKLAgEBMGgwUjELMAkGA1UEBhMCQkUxGTAX
# BgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGlt
# ZXN0YW1waW5nIENBIC0gRzICEhEh1pmnZJc+8fhCfukZzFNBFDAJBgUrDgMCGgUA
# oIH9MBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTE2
# MDgzMTE5MTY0N1owIwYJKoZIhvcNAQkEMRYEFDjMpMoTd79gIGuw6dtx8hUAhN6c
# MIGdBgsqhkiG9w0BCRACDDGBjTCBijCBhzCBhAQUY7gvq2H1g5CWlQULACScUCkz
# 7HkwbDBWpFQwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYt
# c2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzICEhEh
# 1pmnZJc+8fhCfukZzFNBFDANBgkqhkiG9w0BAQEFAASCAQCXkett0Lt8ACevQCWq
# RGmU0U4eseyfqfzSVHpTfPPwBj6QKMSrAjdQKYRBZZTYkPYfpU4SYF1AM29eDJ6W
# MGQFrpbaciEzD9mZlUiznFslW5f3wRt/sQW57BC7Qci+VNnrAIb4NzYlELnBGgT7
# vw95E8hb9v69DyroJkfNHkg4dhP9DqoaFzNrtsOekTi+OGzX9y7dx296J3lB2MMs
# ZDCQ7HVZTrVJFaAzRY0vK1d0xArO7wvpVbmG6wHExFCOAg2/voX6YhuThh2NbA6v
# hdQhgOaDyThx7AJNxUggMjXUrRAbQDakw1XqUe8uyqHCy6VRp5ic5CKdzvHaxz18
# s74H
# SIG # End signature block
|
PowerShellCorpus/PowerShellGallery/biz.dfch.PS.Appclusive.Client/5.2.1.20161201/Set-Customer.ps1
|
Set-Customer.ps1
|
function Set-Customer {
<#
.SYNOPSIS
Sets or creates a Customer entry in Appclusive.
.DESCRIPTION
Sets or creates a Customer entry in Appclusive.
By updating a Customer entry you can specify if you want to update the name, description or any combination thereof.
.OUTPUTS
default
.EXAMPLE
Set-Customer -Name "ArbitraryName" -Description "ArbitraryDescription" -ContractMappingExternalId "ArbitraryContract" -svc $svc -CreateIfNotExist;
Id : 42
Tid : deaddead-dead-dead-dead-deaddeaddead
Name : ArbitraryName
Description : ArbitraryDescription
CreatedById : 1
ModifiedById : 1
Created : 30.11.2016 12:00:00 +00:00
Modified : 30.11.2016 12:00:00 +00:00
RowVersion :
ContractMappings : {}
Tenants : {}
Tenant :
CreatedBy :
ModifiedBy :
Create a new Customer with an associated ContractMapping entry if it does not exists.
.EXAMPLE
Set-Customer -Id 42 -Name "AnotherName" -Description "AnotherDescription" -svc $svc;
Id : 42
Tid : deaddead-dead-dead-dead-deaddeaddead
Name : AnotherName
Description : AnotherDescription
CreatedById : 1
ModifiedById : 1
Created : 30.11.2016 12:00:00 +00:00
Modified : 30.11.2016 12:01:00 +00:00
RowVersion :
ContractMappings : {}
Tenants : {}
Tenant :
CreatedBy :
ModifiedBy :
Update an existing Customer with new Name and Description.
.LINK
Online Version: http://dfch.biz/biz/dfch/PS/Appclusive/Client/Set-Customer/
Set-Customer: http://dfch.biz/biz/dfch/PS/Appclusive/Client/Set-Customer/
.NOTES
See module manifest for dependencies and further requirements.
#>
[CmdletBinding(
SupportsShouldProcess = $false
,
ConfirmImpact = 'Low'
,
HelpURI = 'http://dfch.biz/biz/dfch/PS/Appclusive/Client/Set-Customer/'
)]
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseShouldProcessForStateChangingFunctions", "")]
Param
(
# Specifies the Id of the entry to modify
[Parameter(Mandatory = $true, Position = 0, ParameterSetName = 'id')]
[ValidateRange(1, [long]::MaxValue)]
[long] $Id
,
# Specifies the Id of the entry to modify
[Parameter(Mandatory = $true, Position = 0, ParameterSetName = 'create')]
[Parameter(Mandatory = $false, Position = 1, ParameterSetName = 'id')]
[ValidateNotNullOrEmpty()]
[Alias('n')]
[string] $Name
,
# Specifies the ExternalId of the ContractMapping to create for the Customer
[Parameter(Mandatory = $false, Position = 1, ParameterSetName = 'create')]
[ValidateNotNullOrEmpty()]
[Alias('contractId')]
[string] $ContractMappingExternalId
,
# Specifies the ExternalType of the ContractMapping to create for the Customer
[Parameter(Mandatory = $false, ParameterSetName = 'create')]
[ValidateNotNullOrEmpty()]
[Alias('contractType')]
[string] $ContractMappingExternalType = "SAM"
,
# Specifies the Name of the ContractMapping to create for the Customer
[Parameter(Mandatory = $false, ParameterSetName = 'create')]
[ValidateNotNullOrEmpty()]
[Alias('contractName')]
[string] $ContractMappingName = "Default"
,
[Parameter(Mandatory = $false)]
[ValidateNotNullOrEmpty()]
[string] $Description
,
# Specifies to create a entity if it does not exist
[Parameter(Mandatory = $true, ParameterSetName = 'create')]
[Alias("c")]
[switch] $CreateIfNotExist = $false
,
# Service reference to Appclusive
[Parameter(Mandatory = $false)]
[Alias('Services')]
[hashtable] $svc = (Get-Variable -Name $MyInvocation.MyCommand.Module.PrivateData.MODULEVAR -ValueOnly).Services
,
# Specifies the return format of the Cmdlet
[ValidateSet('default', 'json', 'json-pretty', 'xml', 'xml-pretty')]
[Parameter(Mandatory = $false)]
[alias('ReturnFormat')]
[string] $As = 'default'
)
Begin
{
trap { Log-Exception $_; break; }
$datBegin = [datetime]::Now;
[string] $fn = $MyInvocation.MyCommand.Name;
Log-Debug -fn $fn -msg ("CALL. svc '{0}'. Name '{1}'." -f ($svc -is [Object]), $Name) -fac 1;
# Parameter validation
Contract-Requires ($svc.Core -is [biz.dfch.CS.Appclusive.Api.Core.Core]) "Connect to the server before using the Cmdlet"
}
Process
{
trap { Log-Exception $_; break; }
# Default test variable for checking function response codes.
[Boolean] $fReturn = $false;
# Return values are always and only returned via OutputParameter.
$OutputParameter = $null;
if($PSCmdlet.ParameterSetName -eq 'id')
{
$filterExpression = "Id eq {0}L" -f $Id;
$entity = $svc.Core.Customers.AddQueryOption('$filter', $filterExpression).AddQueryOption('$top', 1) | Select;
Contract-Assert ($entity) "Entity does not exist";
}
else
{
$currentTenant = Get-Tenant -svc $svc -Current;
$filterExpression = "(tolower(Name) eq '{0}' and Tid eq guid'{1}')" -f $Name.ToLower(), $currentTenant.Id;
$entity = $svc.Core.Customers.AddQueryOption('$filter', $filterExpression).AddQueryOption('$top', 1) | Select;
Contract-Assert (!$entity) "Entity does already exist";
}
if($CreateIfNotExist -and !$entity)
{
$entity = New-Object biz.dfch.CS.Appclusive.Api.Core.Customer;
$svc.Core.AddToCustomers($entity);
}
if($PSBoundParameters.ContainsKey('Description'))
{
$entity.Description = $Description;
}
if($PSBoundParameters.ContainsKey('Name'))
{
$entity.Name = $Name;
}
$svc.Core.UpdateObject($entity);
$null = $svc.Core.SaveChanges();
# Create default contract
if($PSBoundParameters.ContainsKey('ContractMappingExternalId'))
{
$defaultContractMapping = New-Object biz.dfch.CS.Appclusive.Api.Core.ContractMapping;
$svc.Core.AddToContractMappings($defaultContractMapping);
$defaultContractMapping.Name = $ContractMappingName;
$defaultContractMapping.ExternalType = $ContractMappingExternalType;
$defaultContractMapping.ExternalId = $ContractMappingExternalId;
$defaultContractMapping.IsPrimary = $true;
$defaultContractMapping.ValidFrom = [System.DateTimeOffset]::MinValue;
$defaultContractMapping.ValidUntil = [System.DateTimeOffset]::MaxValue;
$defaultContractMapping.CustomerId = $entity.Id;
$svc.Core.UpdateObject($defaultContractMapping);
$null = $svc.Core.SaveChanges();
}
$r = $entity;
$OutputParameter = Format-ResultAs $r $As;
$fReturn = $true;
}
End
{
$datEnd = [datetime]::Now;
Log-Debug -fn $fn -msg ("RET. fReturn: [{0}]. Execution time: [{1}]ms. Started: [{2}]." -f $fReturn, ($datEnd - $datBegin).TotalMilliseconds, $datBegin.ToString('yyyy-MM-dd HH:mm:ss.fffzzz')) -fac 2;
# Return values are always and only returned via OutputParameter.
return $OutputParameter;
}
}
if($MyInvocation.ScriptName) { Export-ModuleMember -Function Set-Customer; }
#
# Copyright 2016 d-fens GmbH
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
|
PowerShellCorpus/PowerShellGallery/biz.dfch.PS.Appclusive.Client/5.2.1.20161201/Get-Job.ps1
|
Get-Job.ps1
|
function Get-Job {
<#
.SYNOPSIS
Retrieves one or more entities from the Job entity set.
.DESCRIPTION
Retrieves one or more entities from the Job entity set.
You can retrieve one ore more entities from the entity set by specifying
Id, Name or other properties.
.INPUTS
The Cmdlet can either return all available entities or filter entities on
specified conditions.
See PARAMETERS section on possible inputs.
.OUTPUTS
default | json | json-pretty | xml | xml-pretty
In addition output can be filtered on specified properties.
.EXAMPLE
Get-Job -ListAvailable -Select Id, Status, Name
Id Status Name
-- ------ ----
1029 Approved biz.dfch.CS.Appclusive.Core.OdataServices.Core.Node
1031 Approved biz.dfch.CS.Appclusive.Core.OdataServices.Core.Node
1033 Created biz.dfch.CS.Appclusive.Core.OdataServices.Core.Node
1035 Created biz.dfch.CS.Appclusive.Core.OdataServices.Core.Node
1037 Created biz.dfch.CS.Appclusive.Core.OdataServices.Core.Node
1039 Created biz.dfch.CS.Appclusive.Core.OdataServices.Core.Node
2 InitialState biz.dfch.CS.Appclusive.Core.OdataServices.Core.Node
3 InitialState biz.dfch.CS.Appclusive.Core.OdataServices.Core.Node
4 InitialState biz.dfch.CS.Appclusive.Core.OdataServices.Core.Node
5 InitialState biz.dfch.CS.Appclusive.Core.OdataServices.Core.Node
6 InitialState biz.dfch.CS.Appclusive.Core.OdataServices.Core.Node
...
Retrieves the id, status and name of all Jobs.
.EXAMPLE
Get-Job 1027
Status : InitialState
RefId : 1027
Token :
TenantId : 00000000-0000-0000-0000-000000000000
EntityKindId : 2
Parameters :
Condition :
ConditionParameters : {"ServiceId":"100054"}
Error :
EndTime :
ParentId : 1
Id : 2
Tid : 22222222-2222-2222-2222-222222222222
Name : biz.dfch.CS.Appclusive.Core.OdataServices.Core.Node
Description : This is a node job
CreatedById : 1
ModifiedById : 1
Created : 01.12.2015 00:00:00 +01:00
Modified : 01.12.2015 00:00:00 +01:00
RowVersion : {0, 0, 0, 0...}
EntityKind :
Parent :
Children : {}
Tenant :
CreatedBy :
ModifiedBy :
Retrieves the Job object with Id 1027 and returns all properties of it.
.EXAMPLE
Get-Job 1027 -Select ConditionParameters -ValueOnly -ConvertFromJson
ServiceId
---
100054
Similar to the previous example, but only returns the 'ConditionParameters' property
of it. In addition the contents of the property will be converted from JSON.
.EXAMPLE
Get-Job -ListAvailable -Select Id -First 3
Id
--
2
3
4
Retrieves the id of the first 3 Jobs.
.EXAMPLE
Get-Job 1027 -Select Name -ValueOnly
biz.dfch.CS.Appclusive.Core.OdataServices.Core.Node
Retrieves the name of the Job with Id 4005.
.EXAMPLE
Get-Job -ModifiedBy SYSTEM -Select Id, Name
Id Name
-- ----
1 Root Job
2 biz.dfch.CS.Appclusive.Core.OdataServices.Core.Node
3 biz.dfch.CS.Appclusive.Core.OdataServices.Core.Node
4 biz.dfch.CS.Appclusive.Core.OdataServices.Core.Node
5 biz.dfch.CS.Appclusive.Core.OdataServices.Core.Node
6 biz.dfch.CS.Appclusive.Core.OdataServices.Core.Node
7 biz.dfch.CS.Appclusive.Core.OdataServices.Core.Node
8 biz.dfch.CS.Appclusive.Core.OdataServices.Core.Node
9 biz.dfch.CS.Appclusive.Core.OdataServices.Core.Node
10 biz.dfch.CS.Appclusive.Core.OdataServices.Core.Node
11 biz.dfch.CS.Appclusive.Core.OdataServices.Core.Node
12 biz.dfch.CS.Appclusive.Core.OdataServices.Core.Node
13 biz.dfch.CS.Appclusive.Core.OdataServices.Core.Node
14 biz.dfch.CS.Appclusive.Core.OdataServices.Core.Node
15 biz.dfch.CS.Appclusive.Core.OdataServices.Core.Node
16 biz.dfch.CS.Appclusive.Core.OdataServices.Core.Node
17 biz.dfch.CS.Appclusive.Core.OdataServices.Core.Node
18 biz.dfch.CS.Appclusive.Core.OdataServices.Core.Node
19 biz.dfch.CS.Appclusive.Core.OdataServices.Core.Node
20 biz.dfch.CS.Appclusive.Core.OdataServices.Core.Node
Retrieves id and name of all Jobs that have been modified by user
with name 'SYSTEM' (case insensitive substring match).
.EXAMPLE
Get-Job AppclusiveScheduler -Select Name -ValueOnly -DefaultValue 'AppclusiveSchedulerNotAvailable'
AppclusiveSchedulerNotAvailable
Retrieves the 'Name' property of a Job with Name 'AppclusiveScheduler'
and AppclusiveSchedulerNotAvailable if the entity is not found.
.LINK
Online Version: http://dfch.biz/biz/dfch/PS/Appclusive/Client/Get-Job/
.NOTES
See module manifest for required software versions and dependencies.
#>
[CmdletBinding(
SupportsShouldProcess = $true
,
ConfirmImpact = 'Low'
,
HelpURI = 'http://dfch.biz/biz/dfch/PS/Appclusive/Client/Get-Job/'
,
DefaultParameterSetName = 'list'
)]
PARAM
(
# Specifies the id of the entity
[Parameter(Mandatory = $false, Position = 0, ParameterSetName = 'id')]
[long] $Id
,
# Specifies the name of the entity
[Parameter(Mandatory = $false, Position = 0, ParameterSetName = 'name')]
[Alias('n')]
[string] $Name
,
# Filter by creator
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[string] $CreatedBy
,
# Filter by modifier
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[string] $ModifiedBy
,
# Specifies the Parent id for this entity
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[long] $ParentId
,
# Specifies the Parent id for this entity
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[string] $Status
,
# Specifies the EntityKind id for this entity
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[long] $EntityKindId
,
# Specifies the EntityKind name for this entity
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[string] $EntityKindName
,
# Specify the attributes of the entity to return
[Parameter(Mandatory = $false)]
[string[]] $Select = @()
,
# Specifies to return only values without header information.
# This parameter takes precendes over the 'Select' parameter.
[ValidateScript( { if(1 -eq $Select.Count -And $_) { $true; } else { throw("You must specify exactly one 'Select' property when using 'ValueOnly'."); } } )]
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[Parameter(Mandatory = $false, ParameterSetName = 'id')]
[Alias('HideTableHeaders')]
[switch] $ValueOnly
,
# This value is only returned if the regular search would have returned no results
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[Alias('default')]
$DefaultValue
,
# Specifies to deserialize JSON payloads
[ValidateScript( { if($ValueOnly -And $_) { $true; } else { throw("You must set the 'ValueOnly' switch when using 'ConvertFromJson'."); } } )]
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[Parameter(Mandatory = $false, ParameterSetName = 'id')]
[Alias('Convert')]
[switch] $ConvertFromJson
,
# Limits the output to the specified number of entries
[Parameter(Mandatory = $false)]
[Alias('top')]
[int] $First
,
# Service reference to Appclusive
[Parameter(Mandatory = $false)]
[Alias('Services')]
[hashtable] $svc = (Get-Variable -Name $MyInvocation.MyCommand.Module.PrivateData.MODULEVAR -ValueOnly).Services
,
# Indicates to return all file information
[Parameter(Mandatory = $false, ParameterSetName = 'list')]
[switch] $ListAvailable = $false
,
# Indicates to return node information
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[Parameter(Mandatory = $false, ParameterSetName = 'id')]
[Alias('ExpandRef')]
[Alias('ExpandReferencedItem')]
[switch] $ExpandNode = $false
,
# Indicates to return child information
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[Parameter(Mandatory = $false, ParameterSetName = 'id')]
[Alias('ExpandChildJobs')]
[switch] $ExpandChildren = $false
,
# Indicates to return node information
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[Parameter(Mandatory = $false, ParameterSetName = 'id')]
[switch] $ExpandInterface = $false
,
# Indicates to return node information
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[Parameter(Mandatory = $false, ParameterSetName = 'id')]
[switch] $ExpandConnector = $false
,
# Specifies the return format of the Cmdlet
[ValidateSet('default', 'json', 'json-pretty', 'xml', 'xml-pretty')]
[Parameter(Mandatory = $false)]
[alias('ReturnFormat')]
[string] $As = 'default'
)
Begin
{
trap { Log-Exception $_; break; }
$datBegin = [datetime]::Now;
[string] $fn = $MyInvocation.MyCommand.Name;
Log-Debug -fn $fn -msg ("CALL. svc '{0}'. Name '{1}'." -f ($svc -is [Object]), $Name) -fac 1;
$EntitySetName = 'Jobs';
# Parameter validation
Contract-Requires ($svc.Core -is [biz.dfch.CS.Appclusive.Api.Core.Core]) "Connect to the server before using the Cmdlet";
Contract-Requires (1 -ge ($PSBoundParameters.GetEnumerator() | Where { $_.Key -match 'Expand' -and $_.Value -eq $true}).Count) "You can specify only one 'Expand...' param.";
if($Select)
{
$Select = $Select | Select -Unique;
}
}
# Begin
Process
{
trap { Log-Exception $_; break; }
# Default test variable for checking function response codes.
[Boolean] $fReturn = $false;
# Return values are always and only returned via OutputParameter.
$OutputParameter = $null;
Contract-Assert ($PSCmdlet.ShouldProcess(($PSBoundParameters | Out-String)))
if($PSCmdlet.ParameterSetName -eq 'list')
{
if($PSBoundParameters.ContainsKey('First'))
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$orderby','Name').AddQueryOption('$top', $First) | Select;
}
else
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$orderby','Name') | Select;
}
if($Select)
{
$Response = $Response | Select -Property $Select;
}
}
else
{
$Exp = @();
if($PSCmdlet.ParameterSetName -eq 'id')
{
$Exp += ("Id eq {0}" -f $Id);
}
if($Name)
{
$Exp += ("tolower(Name) eq '{0}'" -f $Name.ToLower());
}
if($Status)
{
$Exp += ("tolower(Status) eq '{0}'" -f $Status.ToLower());
}
if($ParentId)
{
$Exp += ("ParentId eq {0}" -f $ParentId);
}
if($CreatedBy)
{
$CreatedById = Get-User -svc $svc $CreatedBy -Select Id -ValueOnly;
Contract-Assert ( !!$CreatedById ) 'User not found';
$Exp += ("(CreatedById eq {0})" -f $CreatedById);
}
if($ModifiedBy)
{
$ModifiedById = Get-User -svc $svc $ModifiedBy -Select Id -ValueOnly;
Contract-Assert ( !!$ModifiedById ) 'User not found';
$Exp += ("(ModifiedById eq {0})" -f $ModifiedById);
}
if($EntityKindName)
{
$EntityKindId = Get-EntityKind -Name $EntityKindName -svc $svc -Select Id -ValueOnly;
Contract-Assert ( !!$EntityKindId ) 'EntityKind not found';
}
if($EntityKindId)
{
$Exp += ("(EntityKindId eq {0})" -f $EntityKindId);
}
$FilterExpression = [String]::Join(' and ', $Exp);
if($PSBoundParameters.ContainsKey('First'))
{
if(!$ExpandChildren)
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$filter', $FilterExpression).AddQueryOption('$top', $First) | Select;
}
else
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$filter', $FilterExpression).AddQueryOption('$expand', 'Children').AddQueryOption('$top', $First) | Select;
}
}
else
{
if(!$ExpandChildren)
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$filter', $FilterExpression) | Select;
}
else
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$filter', $FilterExpression).AddQueryOption('$expand', 'Children') | Select;
}
}
if($Select)
{
$Response = $Response | Select -Property $Select;
}
else
{
if ( $ExpandNode )
{
$ResponseTemp = New-Object System.Collections.ArrayList;
foreach ($item in $Response)
{
if ( $item.RefId )
{
$Response_ = Get-Node -Id $item.RefId -svc $svc;
$null = $ResponseTemp.Add($Response_);
}
}
$Response = $ResponseTemp.ToArray();
}
elseif ( $ExpandInterface )
{
$ResponseTemp = New-Object System.Collections.ArrayList;
foreach ($item in $Response)
{
if ( $item.RefId )
{
$Response_ = $svc.Core.Interfaces.AddQueryOption('$filter', ('Id eq {0}' -f $item.RefId)) | Select;
$null = $ResponseTemp.Add($Response_);
}
}
$Response = $ResponseTemp.ToArray();
}
elseif ( $ExpandConnector )
{
$ResponseTemp = New-Object System.Collections.ArrayList;
foreach ($item in $Response)
{
if ( $item.RefId )
{
$Response_ = $svc.Core.Connectors.AddQueryOption('$filter', ('Id eq {0}' -f $item.RefId)) | Select;
$null = $ResponseTemp.Add($Response_);
}
}
$Response = $ResponseTemp.ToArray();
}
}
if(1 -eq $Select.Count -And $ValueOnly)
{
$Response = $Response.$Select;
}
if($PSBoundParameters.ContainsKey('DefaultValue') -And !$Response)
{
$Response = $DefaultValue;
}
if($ValueOnly -And $ConvertFromJson)
{
$ResponseTemp = New-Object System.Collections.ArrayList;
foreach($item in $Response)
{
try
{
$null = $ResponseTemp.Add((ConvertFrom-Json -InputObject $item));
}
catch
{
$null = $ResponseTemp.Add($item);
}
}
$Response = $ResponseTemp.ToArray();
}
}
$OutputParameter = Format-ResultAs $Response $As
$fReturn = $true;
}
# Process
End
{
$datEnd = [datetime]::Now;
Log-Debug -fn $fn -msg ("RET. fReturn: [{0}]. Execution time: [{1}]ms. Started: [{2}]." -f $fReturn, ($datEnd - $datBegin).TotalMilliseconds, $datBegin.ToString('yyyy-MM-dd HH:mm:ss.fffzzz')) -fac 2;
# Return values are always and only returned via OutputParameter.
return $OutputParameter;
}
# End
} # function
if($MyInvocation.ScriptName) { Export-ModuleMember -Function Get-Job; }
#
# Copyright 2014-2015 d-fens GmbH
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SIG # Begin signature block
# MIIXDwYJKoZIhvcNAQcCoIIXADCCFvwCAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB
# gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR
# AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQUhN8+3GZoJXFeJ5mS3//ComWg
# viOgghHCMIIEFDCCAvygAwIBAgILBAAAAAABL07hUtcwDQYJKoZIhvcNAQEFBQAw
# VzELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNV
# BAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkdsb2JhbFNpZ24gUm9vdCBDQTAeFw0xMTA0
# MTMxMDAwMDBaFw0yODAxMjgxMjAwMDBaMFIxCzAJBgNVBAYTAkJFMRkwFwYDVQQK
# ExBHbG9iYWxTaWduIG52LXNhMSgwJgYDVQQDEx9HbG9iYWxTaWduIFRpbWVzdGFt
# cGluZyBDQSAtIEcyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAlO9l
# +LVXn6BTDTQG6wkft0cYasvwW+T/J6U00feJGr+esc0SQW5m1IGghYtkWkYvmaCN
# d7HivFzdItdqZ9C76Mp03otPDbBS5ZBb60cO8eefnAuQZT4XljBFcm05oRc2yrmg
# jBtPCBn2gTGtYRakYua0QJ7D/PuV9vu1LpWBmODvxevYAll4d/eq41JrUJEpxfz3
# zZNl0mBhIvIG+zLdFlH6Dv2KMPAXCae78wSuq5DnbN96qfTvxGInX2+ZbTh0qhGL
# 2t/HFEzphbLswn1KJo/nVrqm4M+SU4B09APsaLJgvIQgAIMboe60dAXBKY5i0Eex
# +vBTzBj5Ljv5cH60JQIDAQABo4HlMIHiMA4GA1UdDwEB/wQEAwIBBjASBgNVHRMB
# Af8ECDAGAQH/AgEAMB0GA1UdDgQWBBRG2D7/3OO+/4Pm9IWbsN1q1hSpwTBHBgNV
# HSAEQDA+MDwGBFUdIAAwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93d3cuZ2xvYmFs
# c2lnbi5jb20vcmVwb3NpdG9yeS8wMwYDVR0fBCwwKjAooCagJIYiaHR0cDovL2Ny
# bC5nbG9iYWxzaWduLm5ldC9yb290LmNybDAfBgNVHSMEGDAWgBRge2YaRQ2XyolQ
# L30EzTSo//z9SzANBgkqhkiG9w0BAQUFAAOCAQEATl5WkB5GtNlJMfO7FzkoG8IW
# 3f1B3AkFBJtvsqKa1pkuQJkAVbXqP6UgdtOGNNQXzFU6x4Lu76i6vNgGnxVQ380W
# e1I6AtcZGv2v8Hhc4EvFGN86JB7arLipWAQCBzDbsBJe/jG+8ARI9PBw+DpeVoPP
# PfsNvPTF7ZedudTbpSeE4zibi6c1hkQgpDttpGoLoYP9KOva7yj2zIhd+wo7AKvg
# IeviLzVsD440RZfroveZMzV+y5qKu0VN5z+fwtmK+mWybsd+Zf/okuEsMaL3sCc2
# SI8mbzvuTXYfecPlf5Y1vC0OzAGwjn//UYCAp5LUs0RGZIyHTxZjBzFLY7Df8zCC
# BCkwggMRoAMCAQICCwQAAAAAATGJxjfoMA0GCSqGSIb3DQEBCwUAMEwxIDAeBgNV
# BAsTF0dsb2JhbFNpZ24gUm9vdCBDQSAtIFIzMRMwEQYDVQQKEwpHbG9iYWxTaWdu
# MRMwEQYDVQQDEwpHbG9iYWxTaWduMB4XDTExMDgwMjEwMDAwMFoXDTE5MDgwMjEw
# MDAwMFowWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKPv0Z8p6djTgnY8YqDS
# SdYWHvHP8NC6SEMDLacd8gE0SaQQ6WIT9BP0FoO11VdCSIYrlViH6igEdMtyEQ9h
# JuH6HGEVxyibTQuCDyYrkDqW7aTQaymc9WGI5qRXb+70cNCNF97mZnZfdB5eDFM4
# XZD03zAtGxPReZhUGks4BPQHxCMD05LL94BdqpxWBkQtQUxItC3sNZKaxpXX9c6Q
# MeJ2s2G48XVXQqw7zivIkEnotybPuwyJy9DDo2qhydXjnFMrVyb+Vpp2/WFGomDs
# KUZH8s3ggmLGBFrn7U5AXEgGfZ1f53TJnoRlDVve3NMkHLQUEeurv8QfpLqZ0BdY
# Nc0CAwEAAaOB/TCB+jAOBgNVHQ8BAf8EBAMCAQYwEgYDVR0TAQH/BAgwBgEB/wIB
# ADAdBgNVHQ4EFgQUGUq4WuRNMaUU5V7sL6Mc+oCMMmswRwYDVR0gBEAwPjA8BgRV
# HSAAMDQwMgYIKwYBBQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3Jl
# cG9zaXRvcnkvMDYGA1UdHwQvMC0wK6ApoCeGJWh0dHA6Ly9jcmwuZ2xvYmFsc2ln
# bi5uZXQvcm9vdC1yMy5jcmwwEwYDVR0lBAwwCgYIKwYBBQUHAwMwHwYDVR0jBBgw
# FoAUj/BLf6guRSSuTVD6Y5qL3uLdG7wwDQYJKoZIhvcNAQELBQADggEBAHmwaTTi
# BYf2/tRgLC+GeTQD4LEHkwyEXPnk3GzPbrXsCly6C9BoMS4/ZL0Pgmtmd4F/ximl
# F9jwiU2DJBH2bv6d4UgKKKDieySApOzCmgDXsG1szYjVFXjPE/mIpXNNwTYr3MvO
# 23580ovvL72zT006rbtibiiTxAzL2ebK4BEClAOwvT+UKFaQHlPCJ9XJPM0aYx6C
# WRW2QMqngarDVa8z0bV16AnqRwhIIvtdG/Mseml+xddaXlYzPK1X6JMlQsPSXnE7
# ShxU7alVrCgFx8RsXdw8k/ZpPIJRzhoVPV4Bc/9Aouq0rtOO+u5dbEfHQfXUVlfy
# GDcy1tTMS/Zx4HYwggSfMIIDh6ADAgECAhIRIdaZp2SXPvH4Qn7pGcxTQRQwDQYJ
# KoZIhvcNAQEFBQAwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24g
# bnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzIw
# HhcNMTYwNTI0MDAwMDAwWhcNMjcwNjI0MDAwMDAwWjBgMQswCQYDVQQGEwJTRzEf
# MB0GA1UEChMWR01PIEdsb2JhbFNpZ24gUHRlIEx0ZDEwMC4GA1UEAxMnR2xvYmFs
# U2lnbiBUU0EgZm9yIE1TIEF1dGhlbnRpY29kZSAtIEcyMIIBIjANBgkqhkiG9w0B
# AQEFAAOCAQ8AMIIBCgKCAQEAsBeuotO2BDBWHlgPse1VpNZUy9j2czrsXV6rJf02
# pfqEw2FAxUa1WVI7QqIuXxNiEKlb5nPWkiWxfSPjBrOHOg5D8NcAiVOiETFSKG5d
# QHI88gl3p0mSl9RskKB2p/243LOd8gdgLE9YmABr0xVU4Prd/4AsXximmP/Uq+yh
# RVmyLm9iXeDZGayLV5yoJivZF6UQ0kcIGnAsM4t/aIAqtaFda92NAgIpA6p8N7u7
# KU49U5OzpvqP0liTFUy5LauAo6Ml+6/3CGSwekQPXBDXX2E3qk5r09JTJZ2Cc/os
# +XKwqRk5KlD6qdA8OsroW+/1X1H0+QrZlzXeaoXmIwRCrwIDAQABo4IBXzCCAVsw
# DgYDVR0PAQH/BAQDAgeAMEwGA1UdIARFMEMwQQYJKwYBBAGgMgEeMDQwMgYIKwYB
# BQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3JlcG9zaXRvcnkvMAkG
# A1UdEwQCMAAwFgYDVR0lAQH/BAwwCgYIKwYBBQUHAwgwQgYDVR0fBDswOTA3oDWg
# M4YxaHR0cDovL2NybC5nbG9iYWxzaWduLmNvbS9ncy9nc3RpbWVzdGFtcGluZ2cy
# LmNybDBUBggrBgEFBQcBAQRIMEYwRAYIKwYBBQUHMAKGOGh0dHA6Ly9zZWN1cmUu
# Z2xvYmFsc2lnbi5jb20vY2FjZXJ0L2dzdGltZXN0YW1waW5nZzIuY3J0MB0GA1Ud
# DgQWBBTUooRKOFoYf7pPMFC9ndV6h9YJ9zAfBgNVHSMEGDAWgBRG2D7/3OO+/4Pm
# 9IWbsN1q1hSpwTANBgkqhkiG9w0BAQUFAAOCAQEAj6kakW0EpjcgDoOW3iPTa24f
# bt1kPWghIrX4RzZpjuGlRcckoiK3KQnMVFquxrzNY46zPVBI5bTMrs2SjZ4oixNK
# Eaq9o+/Tsjb8tKFyv22XY3mMRLxwL37zvN2CU6sa9uv6HJe8tjecpBwwvKu8LUc2
# 35IgA+hxxlj2dQWaNPALWVqCRDSqgOQvhPZHXZbJtsrKnbemuuRQ09Q3uLogDtDT
# kipbxFm7oW3bPM5EncE4Kq3jjb3NCXcaEL5nCgI2ZIi5sxsm7ueeYMRGqLxhM2zP
# TrmcuWrwnzf+tT1PmtNN/94gjk6Xpv2fCbxNyhh2ybBNhVDygNIdBvVYBAexGDCC
# BNYwggO+oAMCAQICEhEhDRayW4wRltP+V8mGEea62TANBgkqhkiG9w0BAQsFADBa
# MQswCQYDVQQGEwJCRTEZMBcGA1UEChMQR2xvYmFsU2lnbiBudi1zYTEwMC4GA1UE
# AxMnR2xvYmFsU2lnbiBDb2RlU2lnbmluZyBDQSAtIFNIQTI1NiAtIEcyMB4XDTE1
# MDUwNDE2NDMyMVoXDTE4MDUwNDE2NDMyMVowVTELMAkGA1UEBhMCQ0gxDDAKBgNV
# BAgTA1p1ZzEMMAoGA1UEBxMDWnVnMRQwEgYDVQQKEwtkLWZlbnMgR21iSDEUMBIG
# A1UEAxMLZC1mZW5zIEdtYkgwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB
# AQDNPSzSNPylU9jFM78Q/GjzB7N+VNqikf/use7p8mpnBZ4cf5b4qV3rqQd62rJH
# RlAsxgouCSNQrl8xxfg6/t/I02kPvrzsR4xnDgMiVCqVRAeQsWebafWdTvWmONBS
# lxJejPP8TSgXMKFaDa+2HleTycTBYSoErAZSWpQ0NqF9zBadjsJRVatQuPkTDrwL
# eWibiyOipK9fcNoQpl5ll5H9EG668YJR3fqX9o0TQTkOmxXIL3IJ0UxdpyDpLEkt
# tBG6Y5wAdpF2dQX2phrfFNVY54JOGtuBkNGMSiLFzTkBA1fOlA6ICMYjB8xIFxVv
# rN1tYojCrqYkKMOjwWQz5X8zAgMBAAGjggGZMIIBlTAOBgNVHQ8BAf8EBAMCB4Aw
# TAYDVR0gBEUwQzBBBgkrBgEEAaAyATIwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93
# d3cuZ2xvYmFsc2lnbi5jb20vcmVwb3NpdG9yeS8wCQYDVR0TBAIwADATBgNVHSUE
# DDAKBggrBgEFBQcDAzBCBgNVHR8EOzA5MDegNaAzhjFodHRwOi8vY3JsLmdsb2Jh
# bHNpZ24uY29tL2dzL2dzY29kZXNpZ25zaGEyZzIuY3JsMIGQBggrBgEFBQcBAQSB
# gzCBgDBEBggrBgEFBQcwAoY4aHR0cDovL3NlY3VyZS5nbG9iYWxzaWduLmNvbS9j
# YWNlcnQvZ3Njb2Rlc2lnbnNoYTJnMi5jcnQwOAYIKwYBBQUHMAGGLGh0dHA6Ly9v
# Y3NwMi5nbG9iYWxzaWduLmNvbS9nc2NvZGVzaWduc2hhMmcyMB0GA1UdDgQWBBTN
# GDddiIYZy9p3Z84iSIMd27rtUDAfBgNVHSMEGDAWgBQZSrha5E0xpRTlXuwvoxz6
# gIwyazANBgkqhkiG9w0BAQsFAAOCAQEAAApsOzSX1alF00fTeijB/aIthO3UB0ks
# 1Gg3xoKQC1iEQmFG/qlFLiufs52kRPN7L0a7ClNH3iQpaH5IEaUENT9cNEXdKTBG
# 8OrJS8lrDJXImgNEgtSwz0B40h7bM2Z+0DvXDvpmfyM2NwHF/nNVj7NzmczrLRqN
# 9de3tV0pgRqnIYordVcmb24CZl3bzpwzbQQy14Iz+P5Z2cnw+QaYzAuweTZxEUcJ
# bFwpM49c1LMPFJTuOKkUgY90JJ3gVTpyQxfkc7DNBnx74PlRzjFmeGC/hxQt0hvo
# eaAiBdjo/1uuCTToigVnyRH+c0T2AezTeoFb7ne3I538hWeTdU5q9jGCBLcwggSz
# AgEBMHAwWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MgISESENFrJbjBGW0/5XyYYR5rrZMAkGBSsOAwIaBQCgeDAYBgorBgEEAYI3AgEM
# MQowCKACgAChAoAAMBkGCSqGSIb3DQEJAzEMBgorBgEEAYI3AgEEMBwGCisGAQQB
# gjcCAQsxDjAMBgorBgEEAYI3AgEVMCMGCSqGSIb3DQEJBDEWBBSoZk6nUiNryrwi
# rZ/xRQIzGY9nRjANBgkqhkiG9w0BAQEFAASCAQDMBeXCOETd3qtszX6VAkScjCJN
# fSDTmO1JjJtXOCxIbBj2FjcCOroucCMWGJ8GOHtybd8hoOLSJLdA9zhFFRm+7lxj
# 8wQ/t9/JzINSNciqKMv/eR9XBZiKKvYE6TaX4w6bZkWq/ineJ3qteQRS308C5JmS
# /xf0QzVF28tYC5Dc4ToLz3Q5OkMI6KeQuoYAC+zl3R4RR0Q/e8Q+zh3Gr3Frfma8
# ED7Xmjx2JPIImBkS8S6guxIILeAIGBQzcB/2MdTTzFFo6sQvE14IWiar+E7UA3+J
# tBNSqj5fZdGAfwXmVo79S5sUswht2tKwByQK9fzOEsEFRBEYgUIW4nAXHToHoYIC
# ojCCAp4GCSqGSIb3DQEJBjGCAo8wggKLAgEBMGgwUjELMAkGA1UEBhMCQkUxGTAX
# BgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGlt
# ZXN0YW1waW5nIENBIC0gRzICEhEh1pmnZJc+8fhCfukZzFNBFDAJBgUrDgMCGgUA
# oIH9MBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTE2
# MDgzMTE5MTY0MlowIwYJKoZIhvcNAQkEMRYEFPmC/K1IoaU4b8xMeY6ML7tB8UFD
# MIGdBgsqhkiG9w0BCRACDDGBjTCBijCBhzCBhAQUY7gvq2H1g5CWlQULACScUCkz
# 7HkwbDBWpFQwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYt
# c2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzICEhEh
# 1pmnZJc+8fhCfukZzFNBFDANBgkqhkiG9w0BAQEFAASCAQCBoZSpea3TVwRxZlC5
# cC95oF+3PhcQhHzqonOSe7vhc8ec4uajpUu0/JVJVzIGWvDpP0Os5GZtXIOi4etY
# CrdpEFbu3zoQyjAG2BFWbrOuGkdgmYLrwAXSy9EfGrb2sgUpxsoCZFBQkWhHNlHi
# PDZmUhRZzZVfWbEpIgncrZlUDBbmp2fZWuP43yyGsRoi7e65kDB0g50X2sDt/7a2
# l8wnnbOC/Bq655/rBP/pG70t6UfHqMrsZGC7LERpu7c1Xrr6f6A6VARE3vf8wx9Z
# eAinrHUyhyK/2yCE6Oa2/px64EOxwnnp2MnFgoCYiHLmTCmFFKuHowwjgZaZxZ1B
# iwiK
# SIG # End signature block
|
PowerShellCorpus/PowerShellGallery/biz.dfch.PS.Appclusive.Client/5.2.1.20161201/Set-Interface.ps1
|
Set-Interface.ps1
|
function Set-Interface {
<#
.SYNOPSIS
Sets or creates an Interface entry in Appclusive.
.DESCRIPTION
Sets or creates an Interface entry in Appclusive.
Can create or update an Interface, needs Name and ParentId.
.OUTPUTS
default | json | json-pretty | xml | xml-pretty | PSCredential | Clear
.EXAMPLE
.LINK
Online Version: http://dfch.biz/biz/dfch/PS/Appclusive/Client/Set-Interface/
.NOTES
See module manifest for dependencies and further requirements.
#>
[CmdletBinding(
SupportsShouldProcess = $false
,
ConfirmImpact = 'Low'
,
HelpURI = 'http://dfch.biz/biz/dfch/PS/Appclusive/Client/Set-Interface/'
)]
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseShouldProcessForStateChangingFunctions", "")]
Param
(
# Specifies the name to modify
[Parameter(Mandatory = $true, Position = 0, ParameterSetName="Id")]
[long] $Id
,
# Specifies the name to modify
[Parameter(Mandatory = $true, Position = 0, ParameterSetName="Name")]
[Alias('n')]
[string] $Name
,
# Specifies the new name name
[Parameter(Mandatory = $false)]
[string] $NewName
,
# Specifies the description
[Parameter(Mandatory = $false)]
[long] $ParentId = 1
,
# Specifies the description
[Parameter(Mandatory = $false)]
[string] $Description
,
# Specifies to create a KNV if it does not exist
[Parameter(Mandatory = $false)]
[Alias("c")]
[switch] $CreateIfNotExist = $false
,
# Service reference to Appclusive
[Parameter(Mandatory = $false)]
[Alias('Services')]
[hashtable] $svc = (Get-Variable -Name $MyInvocation.MyCommand.Module.PrivateData.MODULEVAR -ValueOnly).Services
,
# Specifies the return format of the Cmdlet
[ValidateSet('default', 'json', 'json-pretty', 'xml', 'xml-pretty')]
[Parameter(Mandatory = $false)]
[alias('ReturnFormat')]
[string] $As = 'default'
)
Begin
{
trap { Log-Exception $_; break; }
$datBegin = [datetime]::Now;
[string] $fn = $MyInvocation.MyCommand.Name;
Log-Debug -fn $fn -msg ("CALL. svc '{0}'. Name '{1}'." -f ($svc -is [Object]), $Name) -fac 1;
# Parameter validation
Contract-Requires ($svc.Core -is [biz.dfch.CS.Appclusive.Api.Core.Core]) "Connect to the server before using the Cmdlet"
}
# Begin
Process
{
# Default test variable for checking function response codes.
[Boolean] $fReturn = $false;
# Return values are always and only returned via OutputParameter.
$OutputParameter = $null;
$AddedEntity = $null;
$filter = ("Name eq '{0}'" -f $Name);
$interface = $svc.Core.Interfaces.AddQueryOption('$filter', $filter).AddQueryOption('$top',1) | Select;
$Exp = @();
if($Id)
{
$Exp += ("(Id eq {0})" -f $Id);
}
if($Name)
{
$Exp += ("(Name eq '{0}')" -f $Name);
}
$FilterExpression = [String]::Join(' and ', $Exp);
$interface = $svc.Core.Interfaces.AddQueryOption('$filter', $FilterExpression).AddQueryOption('$top', 1) | Select;
$r = @();
if(!$CreateIfNotExist -And !$interface)
{
$msg = "Interface: Parameter validation FAILED. Entity does not exist. Use '-CreateIfNotExist' to create resource.";
$null = New-CustomErrorRecord -m $msg -cat ObjectNotFound -o $Name;
throw($gotoError);
}
if(!$interface)
{
$interface = New-Object biz.dfch.CS.Appclusive.Api.Core.Interface;
$interface.Name = $Name;
$interface.ParentId = $ParentId;
$svc.Core.AddToInterfaces($interface);
$AddedEntity = $interface;
$interface.Created = [System.DateTimeOffset]::Now;
$interface.Modified = [System.DateTimeOffset]::Now;
$interface.CreatedById = 0;
$interface.ModifiedById = 0;
$interface.Tid = [guid]::Empty.ToString();
}
if($NewName) { $interface.Name = $NewName; }
if($PSBoundParameters.ContainsKey('Description'))
{
$interface.Description = $Description;
}
$svc.Core.UpdateObject($interface);
$r = $svc.Core.SaveChanges();
$r = $interface | Select @{ Name="JobUri"; Expression={$_.Name.Replace('http://','https://').Replace('JobResponses','Jobs')} }, @{ Name="JobId"; Expression={$_.Id} };
if ( !$Async )
{
$r = Get-Job -Id $r.JobId -svc $svc -ExpandInterface;
# DFTODO retry handling
}
$OutputParameter = Format-ResultAs $r $As;
$fReturn = $true;
}
# Process
End
{
$datEnd = [datetime]::Now;
Log-Debug -fn $fn -msg ("RET. fReturn: [{0}]. Execution time: [{1}]ms. Started: [{2}]." -f $fReturn, ($datEnd - $datBegin).TotalMilliseconds, $datBegin.ToString('yyyy-MM-dd HH:mm:ss.fffzzz')) -fac 2;
# Return values are always and only returned via OutputParameter.
return $OutputParameter;
}
# End
}
if($MyInvocation.ScriptName) { Export-ModuleMember -Function Set-Interface; }
#
# Copyright 2015-2016 d-fens GmbH
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SIG # Begin signature block
# MIIXDwYJKoZIhvcNAQcCoIIXADCCFvwCAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB
# gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR
# AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQUAzCxJsG0vIHrQ1YShkcoGiH0
# 3CKgghHCMIIEFDCCAvygAwIBAgILBAAAAAABL07hUtcwDQYJKoZIhvcNAQEFBQAw
# VzELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNV
# BAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkdsb2JhbFNpZ24gUm9vdCBDQTAeFw0xMTA0
# MTMxMDAwMDBaFw0yODAxMjgxMjAwMDBaMFIxCzAJBgNVBAYTAkJFMRkwFwYDVQQK
# ExBHbG9iYWxTaWduIG52LXNhMSgwJgYDVQQDEx9HbG9iYWxTaWduIFRpbWVzdGFt
# cGluZyBDQSAtIEcyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAlO9l
# +LVXn6BTDTQG6wkft0cYasvwW+T/J6U00feJGr+esc0SQW5m1IGghYtkWkYvmaCN
# d7HivFzdItdqZ9C76Mp03otPDbBS5ZBb60cO8eefnAuQZT4XljBFcm05oRc2yrmg
# jBtPCBn2gTGtYRakYua0QJ7D/PuV9vu1LpWBmODvxevYAll4d/eq41JrUJEpxfz3
# zZNl0mBhIvIG+zLdFlH6Dv2KMPAXCae78wSuq5DnbN96qfTvxGInX2+ZbTh0qhGL
# 2t/HFEzphbLswn1KJo/nVrqm4M+SU4B09APsaLJgvIQgAIMboe60dAXBKY5i0Eex
# +vBTzBj5Ljv5cH60JQIDAQABo4HlMIHiMA4GA1UdDwEB/wQEAwIBBjASBgNVHRMB
# Af8ECDAGAQH/AgEAMB0GA1UdDgQWBBRG2D7/3OO+/4Pm9IWbsN1q1hSpwTBHBgNV
# HSAEQDA+MDwGBFUdIAAwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93d3cuZ2xvYmFs
# c2lnbi5jb20vcmVwb3NpdG9yeS8wMwYDVR0fBCwwKjAooCagJIYiaHR0cDovL2Ny
# bC5nbG9iYWxzaWduLm5ldC9yb290LmNybDAfBgNVHSMEGDAWgBRge2YaRQ2XyolQ
# L30EzTSo//z9SzANBgkqhkiG9w0BAQUFAAOCAQEATl5WkB5GtNlJMfO7FzkoG8IW
# 3f1B3AkFBJtvsqKa1pkuQJkAVbXqP6UgdtOGNNQXzFU6x4Lu76i6vNgGnxVQ380W
# e1I6AtcZGv2v8Hhc4EvFGN86JB7arLipWAQCBzDbsBJe/jG+8ARI9PBw+DpeVoPP
# PfsNvPTF7ZedudTbpSeE4zibi6c1hkQgpDttpGoLoYP9KOva7yj2zIhd+wo7AKvg
# IeviLzVsD440RZfroveZMzV+y5qKu0VN5z+fwtmK+mWybsd+Zf/okuEsMaL3sCc2
# SI8mbzvuTXYfecPlf5Y1vC0OzAGwjn//UYCAp5LUs0RGZIyHTxZjBzFLY7Df8zCC
# BCkwggMRoAMCAQICCwQAAAAAATGJxjfoMA0GCSqGSIb3DQEBCwUAMEwxIDAeBgNV
# BAsTF0dsb2JhbFNpZ24gUm9vdCBDQSAtIFIzMRMwEQYDVQQKEwpHbG9iYWxTaWdu
# MRMwEQYDVQQDEwpHbG9iYWxTaWduMB4XDTExMDgwMjEwMDAwMFoXDTE5MDgwMjEw
# MDAwMFowWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKPv0Z8p6djTgnY8YqDS
# SdYWHvHP8NC6SEMDLacd8gE0SaQQ6WIT9BP0FoO11VdCSIYrlViH6igEdMtyEQ9h
# JuH6HGEVxyibTQuCDyYrkDqW7aTQaymc9WGI5qRXb+70cNCNF97mZnZfdB5eDFM4
# XZD03zAtGxPReZhUGks4BPQHxCMD05LL94BdqpxWBkQtQUxItC3sNZKaxpXX9c6Q
# MeJ2s2G48XVXQqw7zivIkEnotybPuwyJy9DDo2qhydXjnFMrVyb+Vpp2/WFGomDs
# KUZH8s3ggmLGBFrn7U5AXEgGfZ1f53TJnoRlDVve3NMkHLQUEeurv8QfpLqZ0BdY
# Nc0CAwEAAaOB/TCB+jAOBgNVHQ8BAf8EBAMCAQYwEgYDVR0TAQH/BAgwBgEB/wIB
# ADAdBgNVHQ4EFgQUGUq4WuRNMaUU5V7sL6Mc+oCMMmswRwYDVR0gBEAwPjA8BgRV
# HSAAMDQwMgYIKwYBBQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3Jl
# cG9zaXRvcnkvMDYGA1UdHwQvMC0wK6ApoCeGJWh0dHA6Ly9jcmwuZ2xvYmFsc2ln
# bi5uZXQvcm9vdC1yMy5jcmwwEwYDVR0lBAwwCgYIKwYBBQUHAwMwHwYDVR0jBBgw
# FoAUj/BLf6guRSSuTVD6Y5qL3uLdG7wwDQYJKoZIhvcNAQELBQADggEBAHmwaTTi
# BYf2/tRgLC+GeTQD4LEHkwyEXPnk3GzPbrXsCly6C9BoMS4/ZL0Pgmtmd4F/ximl
# F9jwiU2DJBH2bv6d4UgKKKDieySApOzCmgDXsG1szYjVFXjPE/mIpXNNwTYr3MvO
# 23580ovvL72zT006rbtibiiTxAzL2ebK4BEClAOwvT+UKFaQHlPCJ9XJPM0aYx6C
# WRW2QMqngarDVa8z0bV16AnqRwhIIvtdG/Mseml+xddaXlYzPK1X6JMlQsPSXnE7
# ShxU7alVrCgFx8RsXdw8k/ZpPIJRzhoVPV4Bc/9Aouq0rtOO+u5dbEfHQfXUVlfy
# GDcy1tTMS/Zx4HYwggSfMIIDh6ADAgECAhIRIdaZp2SXPvH4Qn7pGcxTQRQwDQYJ
# KoZIhvcNAQEFBQAwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24g
# bnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzIw
# HhcNMTYwNTI0MDAwMDAwWhcNMjcwNjI0MDAwMDAwWjBgMQswCQYDVQQGEwJTRzEf
# MB0GA1UEChMWR01PIEdsb2JhbFNpZ24gUHRlIEx0ZDEwMC4GA1UEAxMnR2xvYmFs
# U2lnbiBUU0EgZm9yIE1TIEF1dGhlbnRpY29kZSAtIEcyMIIBIjANBgkqhkiG9w0B
# AQEFAAOCAQ8AMIIBCgKCAQEAsBeuotO2BDBWHlgPse1VpNZUy9j2czrsXV6rJf02
# pfqEw2FAxUa1WVI7QqIuXxNiEKlb5nPWkiWxfSPjBrOHOg5D8NcAiVOiETFSKG5d
# QHI88gl3p0mSl9RskKB2p/243LOd8gdgLE9YmABr0xVU4Prd/4AsXximmP/Uq+yh
# RVmyLm9iXeDZGayLV5yoJivZF6UQ0kcIGnAsM4t/aIAqtaFda92NAgIpA6p8N7u7
# KU49U5OzpvqP0liTFUy5LauAo6Ml+6/3CGSwekQPXBDXX2E3qk5r09JTJZ2Cc/os
# +XKwqRk5KlD6qdA8OsroW+/1X1H0+QrZlzXeaoXmIwRCrwIDAQABo4IBXzCCAVsw
# DgYDVR0PAQH/BAQDAgeAMEwGA1UdIARFMEMwQQYJKwYBBAGgMgEeMDQwMgYIKwYB
# BQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3JlcG9zaXRvcnkvMAkG
# A1UdEwQCMAAwFgYDVR0lAQH/BAwwCgYIKwYBBQUHAwgwQgYDVR0fBDswOTA3oDWg
# M4YxaHR0cDovL2NybC5nbG9iYWxzaWduLmNvbS9ncy9nc3RpbWVzdGFtcGluZ2cy
# LmNybDBUBggrBgEFBQcBAQRIMEYwRAYIKwYBBQUHMAKGOGh0dHA6Ly9zZWN1cmUu
# Z2xvYmFsc2lnbi5jb20vY2FjZXJ0L2dzdGltZXN0YW1waW5nZzIuY3J0MB0GA1Ud
# DgQWBBTUooRKOFoYf7pPMFC9ndV6h9YJ9zAfBgNVHSMEGDAWgBRG2D7/3OO+/4Pm
# 9IWbsN1q1hSpwTANBgkqhkiG9w0BAQUFAAOCAQEAj6kakW0EpjcgDoOW3iPTa24f
# bt1kPWghIrX4RzZpjuGlRcckoiK3KQnMVFquxrzNY46zPVBI5bTMrs2SjZ4oixNK
# Eaq9o+/Tsjb8tKFyv22XY3mMRLxwL37zvN2CU6sa9uv6HJe8tjecpBwwvKu8LUc2
# 35IgA+hxxlj2dQWaNPALWVqCRDSqgOQvhPZHXZbJtsrKnbemuuRQ09Q3uLogDtDT
# kipbxFm7oW3bPM5EncE4Kq3jjb3NCXcaEL5nCgI2ZIi5sxsm7ueeYMRGqLxhM2zP
# TrmcuWrwnzf+tT1PmtNN/94gjk6Xpv2fCbxNyhh2ybBNhVDygNIdBvVYBAexGDCC
# BNYwggO+oAMCAQICEhEhDRayW4wRltP+V8mGEea62TANBgkqhkiG9w0BAQsFADBa
# MQswCQYDVQQGEwJCRTEZMBcGA1UEChMQR2xvYmFsU2lnbiBudi1zYTEwMC4GA1UE
# AxMnR2xvYmFsU2lnbiBDb2RlU2lnbmluZyBDQSAtIFNIQTI1NiAtIEcyMB4XDTE1
# MDUwNDE2NDMyMVoXDTE4MDUwNDE2NDMyMVowVTELMAkGA1UEBhMCQ0gxDDAKBgNV
# BAgTA1p1ZzEMMAoGA1UEBxMDWnVnMRQwEgYDVQQKEwtkLWZlbnMgR21iSDEUMBIG
# A1UEAxMLZC1mZW5zIEdtYkgwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB
# AQDNPSzSNPylU9jFM78Q/GjzB7N+VNqikf/use7p8mpnBZ4cf5b4qV3rqQd62rJH
# RlAsxgouCSNQrl8xxfg6/t/I02kPvrzsR4xnDgMiVCqVRAeQsWebafWdTvWmONBS
# lxJejPP8TSgXMKFaDa+2HleTycTBYSoErAZSWpQ0NqF9zBadjsJRVatQuPkTDrwL
# eWibiyOipK9fcNoQpl5ll5H9EG668YJR3fqX9o0TQTkOmxXIL3IJ0UxdpyDpLEkt
# tBG6Y5wAdpF2dQX2phrfFNVY54JOGtuBkNGMSiLFzTkBA1fOlA6ICMYjB8xIFxVv
# rN1tYojCrqYkKMOjwWQz5X8zAgMBAAGjggGZMIIBlTAOBgNVHQ8BAf8EBAMCB4Aw
# TAYDVR0gBEUwQzBBBgkrBgEEAaAyATIwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93
# d3cuZ2xvYmFsc2lnbi5jb20vcmVwb3NpdG9yeS8wCQYDVR0TBAIwADATBgNVHSUE
# DDAKBggrBgEFBQcDAzBCBgNVHR8EOzA5MDegNaAzhjFodHRwOi8vY3JsLmdsb2Jh
# bHNpZ24uY29tL2dzL2dzY29kZXNpZ25zaGEyZzIuY3JsMIGQBggrBgEFBQcBAQSB
# gzCBgDBEBggrBgEFBQcwAoY4aHR0cDovL3NlY3VyZS5nbG9iYWxzaWduLmNvbS9j
# YWNlcnQvZ3Njb2Rlc2lnbnNoYTJnMi5jcnQwOAYIKwYBBQUHMAGGLGh0dHA6Ly9v
# Y3NwMi5nbG9iYWxzaWduLmNvbS9nc2NvZGVzaWduc2hhMmcyMB0GA1UdDgQWBBTN
# GDddiIYZy9p3Z84iSIMd27rtUDAfBgNVHSMEGDAWgBQZSrha5E0xpRTlXuwvoxz6
# gIwyazANBgkqhkiG9w0BAQsFAAOCAQEAAApsOzSX1alF00fTeijB/aIthO3UB0ks
# 1Gg3xoKQC1iEQmFG/qlFLiufs52kRPN7L0a7ClNH3iQpaH5IEaUENT9cNEXdKTBG
# 8OrJS8lrDJXImgNEgtSwz0B40h7bM2Z+0DvXDvpmfyM2NwHF/nNVj7NzmczrLRqN
# 9de3tV0pgRqnIYordVcmb24CZl3bzpwzbQQy14Iz+P5Z2cnw+QaYzAuweTZxEUcJ
# bFwpM49c1LMPFJTuOKkUgY90JJ3gVTpyQxfkc7DNBnx74PlRzjFmeGC/hxQt0hvo
# eaAiBdjo/1uuCTToigVnyRH+c0T2AezTeoFb7ne3I538hWeTdU5q9jGCBLcwggSz
# AgEBMHAwWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MgISESENFrJbjBGW0/5XyYYR5rrZMAkGBSsOAwIaBQCgeDAYBgorBgEEAYI3AgEM
# MQowCKACgAChAoAAMBkGCSqGSIb3DQEJAzEMBgorBgEEAYI3AgEEMBwGCisGAQQB
# gjcCAQsxDjAMBgorBgEEAYI3AgEVMCMGCSqGSIb3DQEJBDEWBBRjhoGmzyQqlcnV
# 9DS946TLT9RtHDANBgkqhkiG9w0BAQEFAASCAQCjJDratQ/appUb/+IaGn7Jd7e6
# 5FdJx6jpnN3wMnSNnbpCsmFSBXmAYbIVheAtmvCrDHMSsCO7q1PeVTTX70RdKfXd
# uH/6nt8YlstCjUKalSI2Eo9sER0tGyzY1mA3omCOWPjDEpae1Na4Q0DWemRkCf37
# p9cmm75bNtf14ZqUespGUx7rscDTA4YACkeGLJlW2c2SfVsAmo6x/TpUZNObHJax
# K1TNL6Jn0CcgI75hmEt+itYr3fqpNlVaLHxHN4xiHel0inqQTmU7rFE/aFtMWET0
# rmIfeTbv0TnnKqVrsWnpabpFNhWp/KwDGjMLbFxKRXCX5rz2GQHY2NQv+6lSoYIC
# ojCCAp4GCSqGSIb3DQEJBjGCAo8wggKLAgEBMGgwUjELMAkGA1UEBhMCQkUxGTAX
# BgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGlt
# ZXN0YW1waW5nIENBIC0gRzICEhEh1pmnZJc+8fhCfukZzFNBFDAJBgUrDgMCGgUA
# oIH9MBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTE2
# MDgzMTE5MTcwNFowIwYJKoZIhvcNAQkEMRYEFGCfqxbz1/IcAzM/5wJtsgQ7uIhY
# MIGdBgsqhkiG9w0BCRACDDGBjTCBijCBhzCBhAQUY7gvq2H1g5CWlQULACScUCkz
# 7HkwbDBWpFQwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYt
# c2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzICEhEh
# 1pmnZJc+8fhCfukZzFNBFDANBgkqhkiG9w0BAQEFAASCAQCWshF/AQwjjufetHyD
# D535MsCG9goT73m527QcBzOUucGrdADSMUxDXVRnMqizVwJfa9wtGG7/eCn7tnWn
# W7VNx1itH5podIlGlUc1sYtHWF/FZraoiJKzTs+s9jsSZkd5Lj+wMH/ExxOcKQja
# TeYJtsXn0oLuDxue+4trH/XmmO4nB5R575jdZobptzNQxN8KuYy+jDG4rvcGfdBv
# dntTqZXSDiIbuUdhaQ/7lhf1RhU4Nax1zSgVRV2sZQ5uue4Rdz1h9WuUrYkxWk1C
# SUwcusHDXZoouxPU32Xzm/ZlrHruQfvL665+O28r8RHZbMluP8P7zmQRakrZMqNK
# INEn
# SIG # End signature block
|
PowerShellCorpus/PowerShellGallery/biz.dfch.PS.Appclusive.Client/5.2.1.20161201/Set-Role.ps1
|
Set-Role.ps1
|
function Set-Role {
<#
.SYNOPSIS
Sets or creates a Role entry in Appclusive.
.DESCRIPTION
Sets or creates a Role entry in Appclusive.
By updating an Role entry you can specify, if you want to update the
Description, MailAddress, Name, RoleType, PermissionsToAdd, PermissionsToRemove or any combination thereof.
For updating Name or RoleType you need to use the Argument '-NewName'/'-NewRoleType'
.OUTPUTS
default
.EXAMPLE
Set-Role -Name "ArbitraryRole" -RoleType External -svc $svc -CreateIfNotExist;
RoleType : External
MailAddress :
Id : 42
Tid : 11111111-1111-1111-1111-111111111111
Name : ArbitraryRole
Description :
CreatedById : 1
ModifiedById : 1
Created : 23.08.2016 11:08:14 +02:00
Modified : 23.08.2016 11:08:14 +02:00
RowVersion :
Permissions : {}
Users : {}
Tenant :
CreatedBy :
ModifiedBy :
Create a new Role entry if it does not exist.
.EXAMPLE
Set-Role -Name "ArbitraryName" -Description "UpdatedDescription" -NewName "UpdatedName"
RoleType : Distribution
MailAddress :
Id : 42
Tid : 11111111-1111-1111-1111-111111111111
Name : UpdatedName
Description : UpdatedDescription
CreatedById : 1
ModifiedById : 1
Created : 23.08.2016 11:08:14 +02:00
Modified : 23.08.2016 11:08:14 +02:00
RowVersion :
Permissions : {}
Users : {}
Tenant :
CreatedBy :
ModifiedBy :
Update an existing Role with new Name and new Description.
.EXAMPLE
Set-Role -Id 42 -RoleType Distribution -MailAddress "arbitrary@example.com" -NewName "UpdatedName"
RoleType : Distribution
MailAddress : arbitrary@example.com
Id : 42
Tid : 11111111-1111-1111-1111-111111111111
Name : UpdatedName
Description :
CreatedById : 1
ModifiedById : 1
Created : 23.08.2016 11:08:14 +02:00
Modified : 23.08.2016 11:08:14 +02:00
RowVersion :
Permissions : {}
Users : {}
Tenant :
CreatedBy :
ModifiedBy :
Update an existing Role with new Name and MailAddress and RoleType.
.EXAMPLE
Set-Role -Id 42 -PermissionsToAdd @("Apc:NodesCanRead","Apc:NodesCanCreate") -CreateIfNotExist
RoleType : Distribution
MailAddress :
Id : 42
Tid : 11111111-1111-1111-1111-111111111111
Name : ArbitraryName
Description :
CreatedById : 1
ModifiedById : 1
Created : 23.08.2016 11:08:14 +02:00
Modified : 23.08.2016 11:08:14 +02:00
RowVersion :
Permissions : {}
Users : {}
Tenant :
CreatedBy :
ModifiedBy :
Create/Update Role by adding specified permissions
.EXAMPLE
Set-Role -Id 42 -PermissionsToRemove @("Apc:NodesCanRead","Apc:NodesCanCreate")
RoleType : Distribution
MailAddress :
Id : 42
Tid : 11111111-1111-1111-1111-111111111111
Name : ArbitraryName
Description :
CreatedById : 1
ModifiedById : 1
Created : 23.08.2016 11:08:14 +02:00
Modified : 23.08.2016 11:08:14 +02:00
RowVersion :
Permissions : {}
Users : {}
Tenant :
CreatedBy :
ModifiedBy :
Update an existing Role by removing the specified permissions
.LINK
Online Version: http://dfch.biz/biz/dfch/PS/Appclusive/Client/Set-Role/
Set-Role: http://dfch.biz/biz/dfch/PS/Appclusive/Client/Set-Role/
.NOTES
See module manifest for dependencies and further requirements.
#>
[CmdletBinding(
SupportsShouldProcess = $false
,
ConfirmImpact = 'Low'
,
HelpURI = 'http://dfch.biz/biz/dfch/PS/Appclusive/Client/Set-Role/'
)]
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseShouldProcessForStateChangingFunctions", "")]
Param
(
[Parameter(Mandatory = $true, ParameterSetName = 'id', Position = 0)]
[ValidateRange(1, [long]::MaxValue)]
[long] $Id
,
[Parameter(Mandatory = $true, ParameterSetName = 'create', Position = 0)]
[Parameter(Mandatory = $true, ParameterSetName = 'name', Position = 0)]
[ValidateNotNullOrEmpty()]
[Alias('n')]
[string] $Name
,
[Parameter(Mandatory = $true, ParameterSetName = 'create', Position = 1)]
[Parameter(Mandatory = $false, ParameterSetName = 'name', Position = 1)]
[Parameter(Mandatory = $false, ParameterSetName = 'id', Position = 1)]
[ValidateSet('Default', 'Security', 'Distribution', 'BuiltIn', 'External')]
[string] $RoleType
,
[Parameter(Mandatory = $false)]
[ValidateNotNullOrEmpty()]
[string] $MailAddress
,
[Parameter(Mandatory = $false)]
[ValidateNotNullOrEmpty()]
[string] $Description
,
# Specifies the permissions which should be added/removed
[Parameter(Mandatory = $false)]
[Alias('add')]
[string[]] $PermissionsToAdd = @()
,
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[Parameter(Mandatory = $false, ParameterSetName = 'id')]
[Alias('remove')]
[string[]] $PermissionsToRemove = @()
,
[Parameter(Mandatory = $false, ParameterSetName = 'id')]
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[ValidateNotNullOrEmpty()]
[string] $NewName
,
# Specifies to create a entity if it does not exist
[Parameter(Mandatory = $true, ParameterSetName = 'create')]
[Alias("c")]
[switch] $CreateIfNotExist = $false
,
# Service reference to Appclusive
[Parameter(Mandatory = $false)]
[Alias('Services')]
[hashtable] $svc = (Get-Variable -Name $MyInvocation.MyCommand.Module.PrivateData.MODULEVAR -ValueOnly).Services
,
# Specifies the return format of the Cmdlet
[ValidateSet('default', 'json', 'json-pretty', 'xml', 'xml-pretty')]
[Parameter(Mandatory = $false)]
[alias('ReturnFormat')]
[string] $As = 'default'
)
Begin
{
trap { Log-Exception $_; break; }
$datBegin = [datetime]::Now;
[string] $fn = $MyInvocation.MyCommand.Name;
Log-Debug -fn $fn -msg ("CALL. svc '{0}'. Name '{1}'." -f ($svc -is [Object]), $Name) -fac 1;
# Parameter validation
Contract-Requires ($svc.Core -is [biz.dfch.CS.Appclusive.Api.Core.Core]) "Connect to the server before using the Cmdlet";
if ($PSBoundParameters.ContainsKey('PermissionsToAdd') -and $PSBoundParameters.ContainsKey('PermissionsToRemove'))
{
$commonPermissionEntries = Compare-Object $PermissionsToAdd $PermissionsToRemove -PassThru -IncludeEqual -ExcludeDifferent;
Contract-Assert($commonPermissionEntries.Count -eq 0) "Same permission name(s) found in 'PermissionsToAdd' and 'PermissionsToRemove'";
}
}
Process
{
trap { Log-Exception $_; break; }
# Default test variable for checking function response codes.
[Boolean] $fReturn = $false;
# Return values are always and only returned via OutputParameter.
$OutputParameter = $null;
$AddedEntity = $null;
if($PSCmdlet.ParameterSetName -eq 'id')
{
$filterExpression = "Id eq {0}L" -f $Id;
$entity = $svc.Core.Roles.AddQueryOption('$filter', $filterExpression).AddQueryOption('$top',1) | Select;
Contract-Assert ($entity) "Entity does not exist";
}
else
{
$currentTenant = Get-Tenant -svc $svc -Current;
$filterExpression = "(tolower(Name) eq '{0}' and Tid eq guid'{1}')" -f $Name.ToLower(), $currentTenant.Id;
$entity = $svc.Core.Roles.AddQueryOption('$filter', $filterExpression).AddQueryOption('$top',1) | Select;
Contract-Assert ($CreateIfNotExist -or $entity) "Entity does not exist. Use '-CreateIfNotExist' to create the resource";
}
if($PSCmdlet.ParameterSetName -eq 'create')
{
$entity = New-Object biz.dfch.CS.Appclusive.Api.Core.Role;
$svc.Core.AddToRoles($entity);
$AddedEntity = $entity;
$entity.Name = $Name;
$entity.RoleType = $RoleType
$entity.Created = [System.DateTimeOffset]::Now;
$entity.Modified = $entity.Created;
$entity.CreatedById = 0;
$entity.ModifiedById = 0;
}
else
{
if($PSBoundParameters.ContainsKey('NewName'))
{
$entity.Name = $NewName;
}
if($PSBoundParameters.ContainsKey('RoleType'))
{
$entity.RoleType = $RoleType;
}
}
if($PSBoundParameters.ContainsKey('Description'))
{
$entity.Description = $Description;
}
if($PSBoundParameters.ContainsKey('MailAddress'))
{
$entity.MailAddress = $MailAddress;
}
$svc.Core.UpdateObject($entity);
$null = $svc.Core.SaveChanges();
$originalPermissions = Get-Role -Id $entity.Id -svc $svc -ExpandPermissions;
if($PSBoundParameters.ContainsKey('PermissionsToAdd'))
{
# assert, that specified permissions do not contain duplicates
Contract-Assert($PermissionsToAdd.Count -eq ($PermissionsToAdd | Select -Unique).Count) "Duplicates found in PermissionsToAdd";
$permissionEntitiesToBeAdded = New-Object System.Collections.ArrayList;
foreach($permissionName in $PermissionsToAdd)
{
$query = "Name eq '{0}'" -f $permissionName;
$apcPermission = $svc.Core.Permissions.AddQueryOption('$filter', $query).AddQueryOption('$top', 1) | Select;
Contract-Assert($apcPermission) ("Permissions with Name '{0}' not found." -f $permissionName);
if (!$originalPermissions -or !$originalPermissions.Name.Contains($permissionName))
{
$null = $permissionEntitiesToBeAdded.Add($apcPermission);
}
}
}
if($PSBoundParameters.ContainsKey('PermissionsToRemove'))
{
# assert, that specified permissions do not contain duplicates
Contract-Assert($PermissionsToRemove.Count -eq ($PermissionsToRemove | Select -Unique).Count) "Duplicates found in PermissionsToAdd";
$permissionEntitiesToBeRemoved = New-Object System.Collections.ArrayList;
$permissionsCanBeRemoved = $true;
foreach($permissionName in $PermissionsToRemove)
{
$query = "Name eq '{0}'" -f $permissionName;
$apcPermission = $svc.Core.Permissions.AddQueryOption('$filter', $query).AddQueryOption('$top', 1) | Select;
Contract-Assert($apcPermission) ("Permissions with Name '{0}' not found." -f $permissionName);
# check, if every specified permission can be removed
if (!$originalPermissions -or !$originalPermissions.Name.Contains($permissionName))
{
$permissionsCanBeRemoved = $false;
continue;
}
$null = $permissionEntitiesToBeRemoved.Add($apcPermission);
}
Contract-Assert($permissionsCanBeRemoved) "One or more of the specified permissions cannot be removed as they are not linked to the corresponding role";
}
foreach($apcPermission in $permissionEntitiesToBeAdded)
{
$svc.Core.AddLink($entity, 'Permissions', $apcPermission);
$null = $svc.Core.SaveChanges();
}
foreach($apcPermission in $permissionEntitiesToBeRemoved)
{
$svc.Core.DeleteLink($entity, 'Permissions', $apcPermission);
$null = $svc.Core.SaveChanges();
}
$r = $entity;
$OutputParameter = Format-ResultAs $r $As;
$fReturn = $true;
}
End
{
$datEnd = [datetime]::Now;
Log-Debug -fn $fn -msg ("RET. fReturn: [{0}]. Execution time: [{1}]ms. Started: [{2}]." -f $fReturn, ($datEnd - $datBegin).TotalMilliseconds, $datBegin.ToString('yyyy-MM-dd HH:mm:ss.fffzzz')) -fac 2;
# Return values are always and only returned via OutputParameter.
return $OutputParameter;
}
} # function
if($MyInvocation.ScriptName) { Export-ModuleMember -Function Set-Role; }
#
# Copyright 2016 d-fens GmbH
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
|
PowerShellCorpus/PowerShellGallery/biz.dfch.PS.Appclusive.Client/5.2.1.20161201/New-User.ps1
|
New-User.ps1
|
function New-User {
<#
.SYNOPSIS
Creates a User entry in Appclusive.
.DESCRIPTION
Creates a User entry in Appclusive.
You must specify parameters 'Name', 'Mail', 'ExternalId' and 'ExternalType'. If the entry already exists no update of the existing entry is performed.
.OUTPUTS
[biz.dfch.CS.Appclusive.Api.Core.User]
.EXAMPLE
New-User -Name ArbitraryName -Mail arbitrary@example.com -ExternalId ArbitraryExternalId -ExternalType ArbitraryExternalType
ExternalId : ArbitraryExternalId
ExternalType : ArbitraryExternalType
Mail : arbitrary@example.com
Id : 2
Tid : 22222222-2222-2222-2222-222222222222
Name : ArbitraryName
Description :
CreatedById : 1
ModifiedById : 1
Created : 15.12.2015 00:00:00 +01:00
Modified : 17.12.2015 00:00:00 +01:00
RowVersion : {0, 0, 0, 0...}
Tenant :
CreatedBy :
ModifiedBy :
Create a new User entry if it not already exists.
.EXAMPLE
New-User -Name ArbitraryName -Mail arbitrary@example.com -ExternalId ArbitraryExternalId -ExternalType ArbitraryExternalType -Description ArbitraryDescription
ExternalId : ArbitraryExternalId
ExternalType : ArbitraryExternalType
Mail : arbitrary@example.com
Id : 2
Tid : 22222222-2222-2222-2222-222222222222
Name : ArbitraryName
Description : ArbitraryDescription
CreatedById : 1
ModifiedById : 1
Created : 15.12.2015 00:00:00 +01:00
Modified : 17.12.2015 00:00:00 +01:00
RowVersion : {0, 0, 0, 0...}
Tenant :
CreatedBy :
ModifiedBy :
Create a new User entry if it not already exists.
.LINK
Online Version: http://dfch.biz/biz/dfch/PS/Appclusive/Client/New-User/
Set-KeyNameValue: http://dfch.biz/biz/dfch/PS/Appclusive/Client/Set-User/
.NOTES
See module manifest for dependencies and further requirements.
#>
[CmdletBinding(
SupportsShouldProcess = $true
,
ConfirmImpact = 'Low'
,
HelpURI = 'http://dfch.biz/biz/dfch/PS/Appclusive/Client/New-User/'
)]
Param
(
[Parameter(Mandatory = $true, Position = 0)]
[ValidateNotNullOrEmpty()]
[string] $Name
,
[Parameter(Mandatory = $true, Position = 1)]
[ValidateNotNullOrEmpty()]
[string] $Mail
,
[Parameter(Mandatory = $true, Position = 2)]
[ValidateNotNullOrEmpty()]
[string] $ExternalId
,
[Parameter(Mandatory = $true, Position = 3)]
[ValidateNotNullOrEmpty()]
[string] $ExternalType
,
[Parameter(Mandatory = $false)]
[string] $Description
,
# Service reference to Appclusive
[Parameter(Mandatory = $false)]
[Alias('Services')]
[hashtable] $svc = (Get-Variable -Name $MyInvocation.MyCommand.Module.PrivateData.MODULEVAR -ValueOnly).Services
)
Begin
{
trap { Log-Exception $_; break; }
$datBegin = [datetime]::Now;
[string] $fn = $MyInvocation.MyCommand.Name;
Log-Debug -fn $fn -msg ("CALL. svc '{0}'. Name '{1}'." -f ($svc -is [Object]), $Name) -fac 1;
# Parameter validation
Contract-Requires ($svc.Core -is [biz.dfch.CS.Appclusive.Api.Core.Core]) "Connect to the server before using the Cmdlet"
}
# Begin
Process
{
trap { Log-Exception $_; break; }
# Default test variable for checking function response codes.
[Boolean] $fReturn = $false;
# Return values are always and only returned via OutputParameter.
$OutputParameter = $null;
$UserContents = @($Mail, $ExternalId, $ExternalType);
$FilterExpression = "(tolower(Name) eq '{0}')" -f $Name.toLower();
$entity = $svc.Core.Users.AddQueryOption('$filter', $FilterExpression).AddQueryOption('$top',1) | Select;
Contract-Requires (!$entity) 'Entity does already exist'
if($PSCmdlet.ShouldProcess($UserContents))
{
$r = Set-User -Name $Name -Mail $Mail -ExternalId $ExternalId -ExternalType $ExternalType -Description $Description -CreateIfNotExist -svc $svc;
$OutputParameter = $r;
}
$fReturn = $true;
}
# Process
End
{
$datEnd = [datetime]::Now;
Log-Debug -fn $fn -msg ("RET. fReturn: [{0}]. Execution time: [{1}]ms. Started: [{2}]." -f $fReturn, ($datEnd - $datBegin).TotalMilliseconds, $datBegin.ToString('yyyy-MM-dd HH:mm:ss.fffzzz')) -fac 2;
# Return values are always and only returned via OutputParameter.
return $OutputParameter;
}
# End
}
if($MyInvocation.ScriptName) { Export-ModuleMember -Function New-User; }
#
# Copyright 2014-2015 d-fens GmbH
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SIG # Begin signature block
# MIIXDwYJKoZIhvcNAQcCoIIXADCCFvwCAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB
# gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR
# AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQUPxN00cczeqRdm+UPzl1YxJ2h
# zhmgghHCMIIEFDCCAvygAwIBAgILBAAAAAABL07hUtcwDQYJKoZIhvcNAQEFBQAw
# VzELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNV
# BAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkdsb2JhbFNpZ24gUm9vdCBDQTAeFw0xMTA0
# MTMxMDAwMDBaFw0yODAxMjgxMjAwMDBaMFIxCzAJBgNVBAYTAkJFMRkwFwYDVQQK
# ExBHbG9iYWxTaWduIG52LXNhMSgwJgYDVQQDEx9HbG9iYWxTaWduIFRpbWVzdGFt
# cGluZyBDQSAtIEcyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAlO9l
# +LVXn6BTDTQG6wkft0cYasvwW+T/J6U00feJGr+esc0SQW5m1IGghYtkWkYvmaCN
# d7HivFzdItdqZ9C76Mp03otPDbBS5ZBb60cO8eefnAuQZT4XljBFcm05oRc2yrmg
# jBtPCBn2gTGtYRakYua0QJ7D/PuV9vu1LpWBmODvxevYAll4d/eq41JrUJEpxfz3
# zZNl0mBhIvIG+zLdFlH6Dv2KMPAXCae78wSuq5DnbN96qfTvxGInX2+ZbTh0qhGL
# 2t/HFEzphbLswn1KJo/nVrqm4M+SU4B09APsaLJgvIQgAIMboe60dAXBKY5i0Eex
# +vBTzBj5Ljv5cH60JQIDAQABo4HlMIHiMA4GA1UdDwEB/wQEAwIBBjASBgNVHRMB
# Af8ECDAGAQH/AgEAMB0GA1UdDgQWBBRG2D7/3OO+/4Pm9IWbsN1q1hSpwTBHBgNV
# HSAEQDA+MDwGBFUdIAAwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93d3cuZ2xvYmFs
# c2lnbi5jb20vcmVwb3NpdG9yeS8wMwYDVR0fBCwwKjAooCagJIYiaHR0cDovL2Ny
# bC5nbG9iYWxzaWduLm5ldC9yb290LmNybDAfBgNVHSMEGDAWgBRge2YaRQ2XyolQ
# L30EzTSo//z9SzANBgkqhkiG9w0BAQUFAAOCAQEATl5WkB5GtNlJMfO7FzkoG8IW
# 3f1B3AkFBJtvsqKa1pkuQJkAVbXqP6UgdtOGNNQXzFU6x4Lu76i6vNgGnxVQ380W
# e1I6AtcZGv2v8Hhc4EvFGN86JB7arLipWAQCBzDbsBJe/jG+8ARI9PBw+DpeVoPP
# PfsNvPTF7ZedudTbpSeE4zibi6c1hkQgpDttpGoLoYP9KOva7yj2zIhd+wo7AKvg
# IeviLzVsD440RZfroveZMzV+y5qKu0VN5z+fwtmK+mWybsd+Zf/okuEsMaL3sCc2
# SI8mbzvuTXYfecPlf5Y1vC0OzAGwjn//UYCAp5LUs0RGZIyHTxZjBzFLY7Df8zCC
# BCkwggMRoAMCAQICCwQAAAAAATGJxjfoMA0GCSqGSIb3DQEBCwUAMEwxIDAeBgNV
# BAsTF0dsb2JhbFNpZ24gUm9vdCBDQSAtIFIzMRMwEQYDVQQKEwpHbG9iYWxTaWdu
# MRMwEQYDVQQDEwpHbG9iYWxTaWduMB4XDTExMDgwMjEwMDAwMFoXDTE5MDgwMjEw
# MDAwMFowWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKPv0Z8p6djTgnY8YqDS
# SdYWHvHP8NC6SEMDLacd8gE0SaQQ6WIT9BP0FoO11VdCSIYrlViH6igEdMtyEQ9h
# JuH6HGEVxyibTQuCDyYrkDqW7aTQaymc9WGI5qRXb+70cNCNF97mZnZfdB5eDFM4
# XZD03zAtGxPReZhUGks4BPQHxCMD05LL94BdqpxWBkQtQUxItC3sNZKaxpXX9c6Q
# MeJ2s2G48XVXQqw7zivIkEnotybPuwyJy9DDo2qhydXjnFMrVyb+Vpp2/WFGomDs
# KUZH8s3ggmLGBFrn7U5AXEgGfZ1f53TJnoRlDVve3NMkHLQUEeurv8QfpLqZ0BdY
# Nc0CAwEAAaOB/TCB+jAOBgNVHQ8BAf8EBAMCAQYwEgYDVR0TAQH/BAgwBgEB/wIB
# ADAdBgNVHQ4EFgQUGUq4WuRNMaUU5V7sL6Mc+oCMMmswRwYDVR0gBEAwPjA8BgRV
# HSAAMDQwMgYIKwYBBQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3Jl
# cG9zaXRvcnkvMDYGA1UdHwQvMC0wK6ApoCeGJWh0dHA6Ly9jcmwuZ2xvYmFsc2ln
# bi5uZXQvcm9vdC1yMy5jcmwwEwYDVR0lBAwwCgYIKwYBBQUHAwMwHwYDVR0jBBgw
# FoAUj/BLf6guRSSuTVD6Y5qL3uLdG7wwDQYJKoZIhvcNAQELBQADggEBAHmwaTTi
# BYf2/tRgLC+GeTQD4LEHkwyEXPnk3GzPbrXsCly6C9BoMS4/ZL0Pgmtmd4F/ximl
# F9jwiU2DJBH2bv6d4UgKKKDieySApOzCmgDXsG1szYjVFXjPE/mIpXNNwTYr3MvO
# 23580ovvL72zT006rbtibiiTxAzL2ebK4BEClAOwvT+UKFaQHlPCJ9XJPM0aYx6C
# WRW2QMqngarDVa8z0bV16AnqRwhIIvtdG/Mseml+xddaXlYzPK1X6JMlQsPSXnE7
# ShxU7alVrCgFx8RsXdw8k/ZpPIJRzhoVPV4Bc/9Aouq0rtOO+u5dbEfHQfXUVlfy
# GDcy1tTMS/Zx4HYwggSfMIIDh6ADAgECAhIRIdaZp2SXPvH4Qn7pGcxTQRQwDQYJ
# KoZIhvcNAQEFBQAwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24g
# bnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzIw
# HhcNMTYwNTI0MDAwMDAwWhcNMjcwNjI0MDAwMDAwWjBgMQswCQYDVQQGEwJTRzEf
# MB0GA1UEChMWR01PIEdsb2JhbFNpZ24gUHRlIEx0ZDEwMC4GA1UEAxMnR2xvYmFs
# U2lnbiBUU0EgZm9yIE1TIEF1dGhlbnRpY29kZSAtIEcyMIIBIjANBgkqhkiG9w0B
# AQEFAAOCAQ8AMIIBCgKCAQEAsBeuotO2BDBWHlgPse1VpNZUy9j2czrsXV6rJf02
# pfqEw2FAxUa1WVI7QqIuXxNiEKlb5nPWkiWxfSPjBrOHOg5D8NcAiVOiETFSKG5d
# QHI88gl3p0mSl9RskKB2p/243LOd8gdgLE9YmABr0xVU4Prd/4AsXximmP/Uq+yh
# RVmyLm9iXeDZGayLV5yoJivZF6UQ0kcIGnAsM4t/aIAqtaFda92NAgIpA6p8N7u7
# KU49U5OzpvqP0liTFUy5LauAo6Ml+6/3CGSwekQPXBDXX2E3qk5r09JTJZ2Cc/os
# +XKwqRk5KlD6qdA8OsroW+/1X1H0+QrZlzXeaoXmIwRCrwIDAQABo4IBXzCCAVsw
# DgYDVR0PAQH/BAQDAgeAMEwGA1UdIARFMEMwQQYJKwYBBAGgMgEeMDQwMgYIKwYB
# BQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3JlcG9zaXRvcnkvMAkG
# A1UdEwQCMAAwFgYDVR0lAQH/BAwwCgYIKwYBBQUHAwgwQgYDVR0fBDswOTA3oDWg
# M4YxaHR0cDovL2NybC5nbG9iYWxzaWduLmNvbS9ncy9nc3RpbWVzdGFtcGluZ2cy
# LmNybDBUBggrBgEFBQcBAQRIMEYwRAYIKwYBBQUHMAKGOGh0dHA6Ly9zZWN1cmUu
# Z2xvYmFsc2lnbi5jb20vY2FjZXJ0L2dzdGltZXN0YW1waW5nZzIuY3J0MB0GA1Ud
# DgQWBBTUooRKOFoYf7pPMFC9ndV6h9YJ9zAfBgNVHSMEGDAWgBRG2D7/3OO+/4Pm
# 9IWbsN1q1hSpwTANBgkqhkiG9w0BAQUFAAOCAQEAj6kakW0EpjcgDoOW3iPTa24f
# bt1kPWghIrX4RzZpjuGlRcckoiK3KQnMVFquxrzNY46zPVBI5bTMrs2SjZ4oixNK
# Eaq9o+/Tsjb8tKFyv22XY3mMRLxwL37zvN2CU6sa9uv6HJe8tjecpBwwvKu8LUc2
# 35IgA+hxxlj2dQWaNPALWVqCRDSqgOQvhPZHXZbJtsrKnbemuuRQ09Q3uLogDtDT
# kipbxFm7oW3bPM5EncE4Kq3jjb3NCXcaEL5nCgI2ZIi5sxsm7ueeYMRGqLxhM2zP
# TrmcuWrwnzf+tT1PmtNN/94gjk6Xpv2fCbxNyhh2ybBNhVDygNIdBvVYBAexGDCC
# BNYwggO+oAMCAQICEhEhDRayW4wRltP+V8mGEea62TANBgkqhkiG9w0BAQsFADBa
# MQswCQYDVQQGEwJCRTEZMBcGA1UEChMQR2xvYmFsU2lnbiBudi1zYTEwMC4GA1UE
# AxMnR2xvYmFsU2lnbiBDb2RlU2lnbmluZyBDQSAtIFNIQTI1NiAtIEcyMB4XDTE1
# MDUwNDE2NDMyMVoXDTE4MDUwNDE2NDMyMVowVTELMAkGA1UEBhMCQ0gxDDAKBgNV
# BAgTA1p1ZzEMMAoGA1UEBxMDWnVnMRQwEgYDVQQKEwtkLWZlbnMgR21iSDEUMBIG
# A1UEAxMLZC1mZW5zIEdtYkgwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB
# AQDNPSzSNPylU9jFM78Q/GjzB7N+VNqikf/use7p8mpnBZ4cf5b4qV3rqQd62rJH
# RlAsxgouCSNQrl8xxfg6/t/I02kPvrzsR4xnDgMiVCqVRAeQsWebafWdTvWmONBS
# lxJejPP8TSgXMKFaDa+2HleTycTBYSoErAZSWpQ0NqF9zBadjsJRVatQuPkTDrwL
# eWibiyOipK9fcNoQpl5ll5H9EG668YJR3fqX9o0TQTkOmxXIL3IJ0UxdpyDpLEkt
# tBG6Y5wAdpF2dQX2phrfFNVY54JOGtuBkNGMSiLFzTkBA1fOlA6ICMYjB8xIFxVv
# rN1tYojCrqYkKMOjwWQz5X8zAgMBAAGjggGZMIIBlTAOBgNVHQ8BAf8EBAMCB4Aw
# TAYDVR0gBEUwQzBBBgkrBgEEAaAyATIwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93
# d3cuZ2xvYmFsc2lnbi5jb20vcmVwb3NpdG9yeS8wCQYDVR0TBAIwADATBgNVHSUE
# DDAKBggrBgEFBQcDAzBCBgNVHR8EOzA5MDegNaAzhjFodHRwOi8vY3JsLmdsb2Jh
# bHNpZ24uY29tL2dzL2dzY29kZXNpZ25zaGEyZzIuY3JsMIGQBggrBgEFBQcBAQSB
# gzCBgDBEBggrBgEFBQcwAoY4aHR0cDovL3NlY3VyZS5nbG9iYWxzaWduLmNvbS9j
# YWNlcnQvZ3Njb2Rlc2lnbnNoYTJnMi5jcnQwOAYIKwYBBQUHMAGGLGh0dHA6Ly9v
# Y3NwMi5nbG9iYWxzaWduLmNvbS9nc2NvZGVzaWduc2hhMmcyMB0GA1UdDgQWBBTN
# GDddiIYZy9p3Z84iSIMd27rtUDAfBgNVHSMEGDAWgBQZSrha5E0xpRTlXuwvoxz6
# gIwyazANBgkqhkiG9w0BAQsFAAOCAQEAAApsOzSX1alF00fTeijB/aIthO3UB0ks
# 1Gg3xoKQC1iEQmFG/qlFLiufs52kRPN7L0a7ClNH3iQpaH5IEaUENT9cNEXdKTBG
# 8OrJS8lrDJXImgNEgtSwz0B40h7bM2Z+0DvXDvpmfyM2NwHF/nNVj7NzmczrLRqN
# 9de3tV0pgRqnIYordVcmb24CZl3bzpwzbQQy14Iz+P5Z2cnw+QaYzAuweTZxEUcJ
# bFwpM49c1LMPFJTuOKkUgY90JJ3gVTpyQxfkc7DNBnx74PlRzjFmeGC/hxQt0hvo
# eaAiBdjo/1uuCTToigVnyRH+c0T2AezTeoFb7ne3I538hWeTdU5q9jGCBLcwggSz
# AgEBMHAwWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MgISESENFrJbjBGW0/5XyYYR5rrZMAkGBSsOAwIaBQCgeDAYBgorBgEEAYI3AgEM
# MQowCKACgAChAoAAMBkGCSqGSIb3DQEJAzEMBgorBgEEAYI3AgEEMBwGCisGAQQB
# gjcCAQsxDjAMBgorBgEEAYI3AgEVMCMGCSqGSIb3DQEJBDEWBBT8PoEMnSQUm5YG
# xfbYMu73BQ+j5DANBgkqhkiG9w0BAQEFAASCAQCyErh+AXM+mfmQxvokM70ZbUtw
# EkqNqMfAygmTDdHbZbX8FPD09KViGOB2FtzRnRZMYjmUar2JECBwXyHvKp74g/aD
# Q2kw/o1GY+d1QWXeeDdNynuDXJYFpxe5KWDpjHawpWgkpQ0y8pJzOyETmSlPhllX
# Ee5vpdJZHs6KnLiVBvlR1dAGCg42KVvvDF8nqIrrwvQz7RVdCiLk3J6URYlUNlMc
# GkF0ftbkQ7Yf2hImnCVIosKoCHJ7fmsebg9K0OV9gqac71egBH37SVUGUjElUjWp
# qMtFShzESqwqLgxt96YimRgAx0eBu8XWXd38fz+NbOaKzc71c/NYWnN2IwF2oYIC
# ojCCAp4GCSqGSIb3DQEJBjGCAo8wggKLAgEBMGgwUjELMAkGA1UEBhMCQkUxGTAX
# BgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGlt
# ZXN0YW1waW5nIENBIC0gRzICEhEh1pmnZJc+8fhCfukZzFNBFDAJBgUrDgMCGgUA
# oIH9MBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTE2
# MDgzMTE5MTY1NlowIwYJKoZIhvcNAQkEMRYEFEybZ3FWIbHCnOKhs7JXZ9nP9xwP
# MIGdBgsqhkiG9w0BCRACDDGBjTCBijCBhzCBhAQUY7gvq2H1g5CWlQULACScUCkz
# 7HkwbDBWpFQwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYt
# c2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzICEhEh
# 1pmnZJc+8fhCfukZzFNBFDANBgkqhkiG9w0BAQEFAASCAQCcy8BJC5zt9auaRHAt
# EabLLOvZPHMuf1SDbJJ0tbgKSsyUYoTrjELQMVFfs+m4Vi/H46zIob3Wkf8cWUG7
# UPN8x7yWSYk2Gnazv3aT0FVfse5J7jkC3LRWFw/SJAAGeALDkBvrqK7GmuqdKyHV
# 5OBuO4yMGl6GzOr9Zi9hMbyJYFtLMVXIP6cRcfpxYRiIjD2DT0zl1L5ae8SStVIA
# EC2X07RvK9aoc5BOObeJj4fpeL0lwM3hMpmcRQ5qt4nFEN7E7eBe/yLOSAB0ilg7
# 7Z9pSam6DEbr7r64/BchIye7PhlNEbsTpo913+In4xI4PmEMFO0qUbUZgZaRyvqG
# 9x+X
# SIG # End signature block
|
PowerShellCorpus/PowerShellGallery/biz.dfch.PS.Appclusive.Client/5.2.1.20161201/New-Interface.ps1
|
New-Interface.ps1
|
function New-Interface {
<#
.SYNOPSIS
Creates an Interface entry in Appclusive.
.DESCRIPTION
Creates an Interface entry in Appclusive.
You must specify a Name and a ParentId (default is 1, which is the root Node).
.OUTPUTS
default | json | json-pretty | xml | xml-pretty
.EXAMPLE
.LINK
Online Version: http://dfch.biz/biz/dfch/PS/Appclusive/Client/New-Interface/
Set-KeyNameValue: http://dfch.biz/biz/dfch/PS/Appclusive/Client/Set-Interface/
.NOTES
See module manifest for dependencies and further requirements.
#>
[CmdletBinding(
SupportsShouldProcess = $true
,
ConfirmImpact = 'Low'
,
HelpURI='http://dfch.biz/biz/dfch/PS/Appclusive/Client/New-Interface/'
)]
Param
(
# Specifies the name to modify
[Parameter(Mandatory = $true, Position = 0)]
[ValidateNotNullOrEmpty()]
[string] $Name
,
# Specifies the value to modify
[Parameter(Mandatory = $false, Position = 1)]
[long] $ParentId = 1
,
# Specifies the value to modify
[Parameter(Mandatory = $false)]
[string] $Description
,
# Service reference to Appclusive
[Parameter(Mandatory = $false)]
[Alias('Services')]
[hashtable] $svc = (Get-Variable -Name $MyInvocation.MyCommand.Module.PrivateData.MODULEVAR -ValueOnly).Services
,
# Specifies the return format of the Cmdlet
[ValidateSet('default', 'json', 'json-pretty', 'xml', 'xml-pretty')]
[Parameter(Mandatory = $false)]
[alias('ReturnFormat')]
[string] $As = 'default'
)
Begin
{
trap { Log-Exception $_; break; }
$datBegin = [datetime]::Now;
[string] $fn = $MyInvocation.MyCommand.Name;
Log-Debug -fn $fn -msg ("CALL. svc '{0}'. Name '{1}'." -f ($svc -is [Object]), $Name) -fac 1;
# Parameter validation
Contract-Requires ($svc.Core -is [biz.dfch.CS.Appclusive.Api.Core.Core]) "Connect to the server before using the Cmdlet"
}
# Begin
Process
{
# Default test variable for checking function response codes.
[Boolean] $fReturn = $false;
# Return values are always and only returned via OutputParameter.
$OutputParameter = $null;
$Exp = @();
if($Name)
{
$Exp += ("(Name eq '{0}')" -f $Name);
}
$FilterExpression = [String]::Join(' and ', $Exp);
$interface = $svc.Core.Interfaces.AddQueryOption('$filter',$FilterExpression).AddQueryOption('$top', 1);
if ($interface)
{
$msg = "Parameter validation FAILED. Interface with Name '{0}' already exists." -f $Name;
Log-Error $fn $msg;
$null = New-CustomErrorRecord -m $msg -cat ResourceExists -o $Name;
throw($gotoError);
}
if($PSCmdlet.ShouldProcess($KeyNameValueContents))
{
if($PSBoundParameters.ContainsKey('Description'))
{
$r = Set-Interface -Name $Name -Value $Value -Description $Description -CreateIfNotExist -svc $svc -As $As;
}
else
{
$r = Set-Interface -Name $Name -Value $Value -CreateIfNotExist -svc $svc -As $As;
}
$OutputParameter = $r;
}
$fReturn = $true;
}
# Process
End
{
$datEnd = [datetime]::Now;
Log-Debug -fn $fn -msg ("RET. fReturn: [{0}]. Execution time: [{1}]ms. Started: [{2}]." -f $fReturn, ($datEnd - $datBegin).TotalMilliseconds, $datBegin.ToString('yyyy-MM-dd HH:mm:ss.fffzzz')) -fac 2;
# Return values are always and only returned via OutputParameter.
return $OutputParameter;
}
# End
}
if($MyInvocation.ScriptName) { Export-ModuleMember -Function New-Interface; }
#
# Copyright 2015-2016 d-fens GmbH
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SIG # Begin signature block
# MIIXDwYJKoZIhvcNAQcCoIIXADCCFvwCAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB
# gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR
# AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQUOZrNpDEo7Sl2plOPIzqYlEag
# tfagghHCMIIEFDCCAvygAwIBAgILBAAAAAABL07hUtcwDQYJKoZIhvcNAQEFBQAw
# VzELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNV
# BAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkdsb2JhbFNpZ24gUm9vdCBDQTAeFw0xMTA0
# MTMxMDAwMDBaFw0yODAxMjgxMjAwMDBaMFIxCzAJBgNVBAYTAkJFMRkwFwYDVQQK
# ExBHbG9iYWxTaWduIG52LXNhMSgwJgYDVQQDEx9HbG9iYWxTaWduIFRpbWVzdGFt
# cGluZyBDQSAtIEcyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAlO9l
# +LVXn6BTDTQG6wkft0cYasvwW+T/J6U00feJGr+esc0SQW5m1IGghYtkWkYvmaCN
# d7HivFzdItdqZ9C76Mp03otPDbBS5ZBb60cO8eefnAuQZT4XljBFcm05oRc2yrmg
# jBtPCBn2gTGtYRakYua0QJ7D/PuV9vu1LpWBmODvxevYAll4d/eq41JrUJEpxfz3
# zZNl0mBhIvIG+zLdFlH6Dv2KMPAXCae78wSuq5DnbN96qfTvxGInX2+ZbTh0qhGL
# 2t/HFEzphbLswn1KJo/nVrqm4M+SU4B09APsaLJgvIQgAIMboe60dAXBKY5i0Eex
# +vBTzBj5Ljv5cH60JQIDAQABo4HlMIHiMA4GA1UdDwEB/wQEAwIBBjASBgNVHRMB
# Af8ECDAGAQH/AgEAMB0GA1UdDgQWBBRG2D7/3OO+/4Pm9IWbsN1q1hSpwTBHBgNV
# HSAEQDA+MDwGBFUdIAAwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93d3cuZ2xvYmFs
# c2lnbi5jb20vcmVwb3NpdG9yeS8wMwYDVR0fBCwwKjAooCagJIYiaHR0cDovL2Ny
# bC5nbG9iYWxzaWduLm5ldC9yb290LmNybDAfBgNVHSMEGDAWgBRge2YaRQ2XyolQ
# L30EzTSo//z9SzANBgkqhkiG9w0BAQUFAAOCAQEATl5WkB5GtNlJMfO7FzkoG8IW
# 3f1B3AkFBJtvsqKa1pkuQJkAVbXqP6UgdtOGNNQXzFU6x4Lu76i6vNgGnxVQ380W
# e1I6AtcZGv2v8Hhc4EvFGN86JB7arLipWAQCBzDbsBJe/jG+8ARI9PBw+DpeVoPP
# PfsNvPTF7ZedudTbpSeE4zibi6c1hkQgpDttpGoLoYP9KOva7yj2zIhd+wo7AKvg
# IeviLzVsD440RZfroveZMzV+y5qKu0VN5z+fwtmK+mWybsd+Zf/okuEsMaL3sCc2
# SI8mbzvuTXYfecPlf5Y1vC0OzAGwjn//UYCAp5LUs0RGZIyHTxZjBzFLY7Df8zCC
# BCkwggMRoAMCAQICCwQAAAAAATGJxjfoMA0GCSqGSIb3DQEBCwUAMEwxIDAeBgNV
# BAsTF0dsb2JhbFNpZ24gUm9vdCBDQSAtIFIzMRMwEQYDVQQKEwpHbG9iYWxTaWdu
# MRMwEQYDVQQDEwpHbG9iYWxTaWduMB4XDTExMDgwMjEwMDAwMFoXDTE5MDgwMjEw
# MDAwMFowWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKPv0Z8p6djTgnY8YqDS
# SdYWHvHP8NC6SEMDLacd8gE0SaQQ6WIT9BP0FoO11VdCSIYrlViH6igEdMtyEQ9h
# JuH6HGEVxyibTQuCDyYrkDqW7aTQaymc9WGI5qRXb+70cNCNF97mZnZfdB5eDFM4
# XZD03zAtGxPReZhUGks4BPQHxCMD05LL94BdqpxWBkQtQUxItC3sNZKaxpXX9c6Q
# MeJ2s2G48XVXQqw7zivIkEnotybPuwyJy9DDo2qhydXjnFMrVyb+Vpp2/WFGomDs
# KUZH8s3ggmLGBFrn7U5AXEgGfZ1f53TJnoRlDVve3NMkHLQUEeurv8QfpLqZ0BdY
# Nc0CAwEAAaOB/TCB+jAOBgNVHQ8BAf8EBAMCAQYwEgYDVR0TAQH/BAgwBgEB/wIB
# ADAdBgNVHQ4EFgQUGUq4WuRNMaUU5V7sL6Mc+oCMMmswRwYDVR0gBEAwPjA8BgRV
# HSAAMDQwMgYIKwYBBQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3Jl
# cG9zaXRvcnkvMDYGA1UdHwQvMC0wK6ApoCeGJWh0dHA6Ly9jcmwuZ2xvYmFsc2ln
# bi5uZXQvcm9vdC1yMy5jcmwwEwYDVR0lBAwwCgYIKwYBBQUHAwMwHwYDVR0jBBgw
# FoAUj/BLf6guRSSuTVD6Y5qL3uLdG7wwDQYJKoZIhvcNAQELBQADggEBAHmwaTTi
# BYf2/tRgLC+GeTQD4LEHkwyEXPnk3GzPbrXsCly6C9BoMS4/ZL0Pgmtmd4F/ximl
# F9jwiU2DJBH2bv6d4UgKKKDieySApOzCmgDXsG1szYjVFXjPE/mIpXNNwTYr3MvO
# 23580ovvL72zT006rbtibiiTxAzL2ebK4BEClAOwvT+UKFaQHlPCJ9XJPM0aYx6C
# WRW2QMqngarDVa8z0bV16AnqRwhIIvtdG/Mseml+xddaXlYzPK1X6JMlQsPSXnE7
# ShxU7alVrCgFx8RsXdw8k/ZpPIJRzhoVPV4Bc/9Aouq0rtOO+u5dbEfHQfXUVlfy
# GDcy1tTMS/Zx4HYwggSfMIIDh6ADAgECAhIRIdaZp2SXPvH4Qn7pGcxTQRQwDQYJ
# KoZIhvcNAQEFBQAwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24g
# bnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzIw
# HhcNMTYwNTI0MDAwMDAwWhcNMjcwNjI0MDAwMDAwWjBgMQswCQYDVQQGEwJTRzEf
# MB0GA1UEChMWR01PIEdsb2JhbFNpZ24gUHRlIEx0ZDEwMC4GA1UEAxMnR2xvYmFs
# U2lnbiBUU0EgZm9yIE1TIEF1dGhlbnRpY29kZSAtIEcyMIIBIjANBgkqhkiG9w0B
# AQEFAAOCAQ8AMIIBCgKCAQEAsBeuotO2BDBWHlgPse1VpNZUy9j2czrsXV6rJf02
# pfqEw2FAxUa1WVI7QqIuXxNiEKlb5nPWkiWxfSPjBrOHOg5D8NcAiVOiETFSKG5d
# QHI88gl3p0mSl9RskKB2p/243LOd8gdgLE9YmABr0xVU4Prd/4AsXximmP/Uq+yh
# RVmyLm9iXeDZGayLV5yoJivZF6UQ0kcIGnAsM4t/aIAqtaFda92NAgIpA6p8N7u7
# KU49U5OzpvqP0liTFUy5LauAo6Ml+6/3CGSwekQPXBDXX2E3qk5r09JTJZ2Cc/os
# +XKwqRk5KlD6qdA8OsroW+/1X1H0+QrZlzXeaoXmIwRCrwIDAQABo4IBXzCCAVsw
# DgYDVR0PAQH/BAQDAgeAMEwGA1UdIARFMEMwQQYJKwYBBAGgMgEeMDQwMgYIKwYB
# BQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3JlcG9zaXRvcnkvMAkG
# A1UdEwQCMAAwFgYDVR0lAQH/BAwwCgYIKwYBBQUHAwgwQgYDVR0fBDswOTA3oDWg
# M4YxaHR0cDovL2NybC5nbG9iYWxzaWduLmNvbS9ncy9nc3RpbWVzdGFtcGluZ2cy
# LmNybDBUBggrBgEFBQcBAQRIMEYwRAYIKwYBBQUHMAKGOGh0dHA6Ly9zZWN1cmUu
# Z2xvYmFsc2lnbi5jb20vY2FjZXJ0L2dzdGltZXN0YW1waW5nZzIuY3J0MB0GA1Ud
# DgQWBBTUooRKOFoYf7pPMFC9ndV6h9YJ9zAfBgNVHSMEGDAWgBRG2D7/3OO+/4Pm
# 9IWbsN1q1hSpwTANBgkqhkiG9w0BAQUFAAOCAQEAj6kakW0EpjcgDoOW3iPTa24f
# bt1kPWghIrX4RzZpjuGlRcckoiK3KQnMVFquxrzNY46zPVBI5bTMrs2SjZ4oixNK
# Eaq9o+/Tsjb8tKFyv22XY3mMRLxwL37zvN2CU6sa9uv6HJe8tjecpBwwvKu8LUc2
# 35IgA+hxxlj2dQWaNPALWVqCRDSqgOQvhPZHXZbJtsrKnbemuuRQ09Q3uLogDtDT
# kipbxFm7oW3bPM5EncE4Kq3jjb3NCXcaEL5nCgI2ZIi5sxsm7ueeYMRGqLxhM2zP
# TrmcuWrwnzf+tT1PmtNN/94gjk6Xpv2fCbxNyhh2ybBNhVDygNIdBvVYBAexGDCC
# BNYwggO+oAMCAQICEhEhDRayW4wRltP+V8mGEea62TANBgkqhkiG9w0BAQsFADBa
# MQswCQYDVQQGEwJCRTEZMBcGA1UEChMQR2xvYmFsU2lnbiBudi1zYTEwMC4GA1UE
# AxMnR2xvYmFsU2lnbiBDb2RlU2lnbmluZyBDQSAtIFNIQTI1NiAtIEcyMB4XDTE1
# MDUwNDE2NDMyMVoXDTE4MDUwNDE2NDMyMVowVTELMAkGA1UEBhMCQ0gxDDAKBgNV
# BAgTA1p1ZzEMMAoGA1UEBxMDWnVnMRQwEgYDVQQKEwtkLWZlbnMgR21iSDEUMBIG
# A1UEAxMLZC1mZW5zIEdtYkgwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB
# AQDNPSzSNPylU9jFM78Q/GjzB7N+VNqikf/use7p8mpnBZ4cf5b4qV3rqQd62rJH
# RlAsxgouCSNQrl8xxfg6/t/I02kPvrzsR4xnDgMiVCqVRAeQsWebafWdTvWmONBS
# lxJejPP8TSgXMKFaDa+2HleTycTBYSoErAZSWpQ0NqF9zBadjsJRVatQuPkTDrwL
# eWibiyOipK9fcNoQpl5ll5H9EG668YJR3fqX9o0TQTkOmxXIL3IJ0UxdpyDpLEkt
# tBG6Y5wAdpF2dQX2phrfFNVY54JOGtuBkNGMSiLFzTkBA1fOlA6ICMYjB8xIFxVv
# rN1tYojCrqYkKMOjwWQz5X8zAgMBAAGjggGZMIIBlTAOBgNVHQ8BAf8EBAMCB4Aw
# TAYDVR0gBEUwQzBBBgkrBgEEAaAyATIwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93
# d3cuZ2xvYmFsc2lnbi5jb20vcmVwb3NpdG9yeS8wCQYDVR0TBAIwADATBgNVHSUE
# DDAKBggrBgEFBQcDAzBCBgNVHR8EOzA5MDegNaAzhjFodHRwOi8vY3JsLmdsb2Jh
# bHNpZ24uY29tL2dzL2dzY29kZXNpZ25zaGEyZzIuY3JsMIGQBggrBgEFBQcBAQSB
# gzCBgDBEBggrBgEFBQcwAoY4aHR0cDovL3NlY3VyZS5nbG9iYWxzaWduLmNvbS9j
# YWNlcnQvZ3Njb2Rlc2lnbnNoYTJnMi5jcnQwOAYIKwYBBQUHMAGGLGh0dHA6Ly9v
# Y3NwMi5nbG9iYWxzaWduLmNvbS9nc2NvZGVzaWduc2hhMmcyMB0GA1UdDgQWBBTN
# GDddiIYZy9p3Z84iSIMd27rtUDAfBgNVHSMEGDAWgBQZSrha5E0xpRTlXuwvoxz6
# gIwyazANBgkqhkiG9w0BAQsFAAOCAQEAAApsOzSX1alF00fTeijB/aIthO3UB0ks
# 1Gg3xoKQC1iEQmFG/qlFLiufs52kRPN7L0a7ClNH3iQpaH5IEaUENT9cNEXdKTBG
# 8OrJS8lrDJXImgNEgtSwz0B40h7bM2Z+0DvXDvpmfyM2NwHF/nNVj7NzmczrLRqN
# 9de3tV0pgRqnIYordVcmb24CZl3bzpwzbQQy14Iz+P5Z2cnw+QaYzAuweTZxEUcJ
# bFwpM49c1LMPFJTuOKkUgY90JJ3gVTpyQxfkc7DNBnx74PlRzjFmeGC/hxQt0hvo
# eaAiBdjo/1uuCTToigVnyRH+c0T2AezTeoFb7ne3I538hWeTdU5q9jGCBLcwggSz
# AgEBMHAwWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MgISESENFrJbjBGW0/5XyYYR5rrZMAkGBSsOAwIaBQCgeDAYBgorBgEEAYI3AgEM
# MQowCKACgAChAoAAMBkGCSqGSIb3DQEJAzEMBgorBgEEAYI3AgEEMBwGCisGAQQB
# gjcCAQsxDjAMBgorBgEEAYI3AgEVMCMGCSqGSIb3DQEJBDEWBBRt2I9pXmRr3rZY
# Ewe1znjufoxMPTANBgkqhkiG9w0BAQEFAASCAQCOc1uJ7rWyePBlhU2mWx9G5Ogp
# fjiKf67LbqyGcxXFBtTNIphgOgLJyNSd5gswPQN/ZfEHwecfGoTxb0sAjHjIgKO9
# RWvqx13PHXBrRESiHsdyhA2tf6CskO8wXKI3fHfWvzR4ztJ7JiRqyrbVJbbSr0iU
# rlvB6AApIaIlU8KwVXiytr7vadQgbILdaf1SfoSSKmoCTaEdLFftLtOPsAZTwRAj
# tByaPLkr93MKyK1nnB/NUxI/w5UWEnUuXGZL9Ae20JPru0N5O/V4AI7SP5J++Tdm
# X2R5UEZrVJt56d7ZlWwPr1tODOTlUAQqMROkxsTPAhavLQ6wnhSV1WUGMV8UoYIC
# ojCCAp4GCSqGSIb3DQEJBjGCAo8wggKLAgEBMGgwUjELMAkGA1UEBhMCQkUxGTAX
# BgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGlt
# ZXN0YW1waW5nIENBIC0gRzICEhEh1pmnZJc+8fhCfukZzFNBFDAJBgUrDgMCGgUA
# oIH9MBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTE2
# MDgzMTE5MTY1M1owIwYJKoZIhvcNAQkEMRYEFFY3rdnl6UgZhCQzCWgPyXGnCzvZ
# MIGdBgsqhkiG9w0BCRACDDGBjTCBijCBhzCBhAQUY7gvq2H1g5CWlQULACScUCkz
# 7HkwbDBWpFQwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYt
# c2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzICEhEh
# 1pmnZJc+8fhCfukZzFNBFDANBgkqhkiG9w0BAQEFAASCAQCbfJNTiJlnguAJK8Mr
# /e7PLqmTqw9sS3sf+oQHR8FuBYntTAvNXXvOQA6vACs/qQt32CklEl5dofcbOmdl
# IbhDgRPjKy9aGWTNqEwCHkRaW1snFd+Ub7xoc22IjG4RRNyHoMNyfPbu0V4kIUTa
# lHL0ZZnYV1b6FzOsh/jz0aOvSXCfu6XqDbTlAOV7F+EH9wAQMpUGeQSSjhv6Du7i
# ATYTQzmbC5EJ6AUNf3qz/NU6+iTmpZ4vkZX7yNyzG+6WUpG4X/KS9bhjoGM2aH5P
# Nlqtb1VjLN8eQF+XXd8Il59tDVExlofp7h6HmUbPELOdma76kp73/b3ytVoirYic
# Hn7u
# SIG # End signature block
|
PowerShellCorpus/PowerShellGallery/biz.dfch.PS.Appclusive.Client/5.2.1.20161201/New-ManagementUri.ps1
|
New-ManagementUri.ps1
|
function New-ManagementUri {
<#
.SYNOPSIS
Creates a ManagementUri entry in Appclusive.
.DESCRIPTION
Creates a ManagementUri entry in Appclusive.
You must specify the parameters 'Name' and 'Type' and 'Value'. If the entry already exists no update of the existing entry is performed.
.OUTPUTS
default | json | json-pretty | xml | xml-pretty
.EXAMPLE
New-ManagementUri -Name ArbitraryName -Type ArbitraryType -Value ArbitraryValue
Type : ArbitraryType
Value : ArbitraryValue
ManagementCredentialId :
Id : 180
Tid : 11111111-1111-1111-1111-111111111111
Name : AritraryName
Description :
CreatedById : 1
ModifiedById : 1
Created : 22.08.2016 10:26:53 +02:00
Modified : 22.08.2016 10:31:00 +02:00
RowVersion : {0, 0, 0, 0...}
ManagementCredential :
Tenant :
CreatedBy :
ModifiedBy :
Create a new ManagementUri entry if it not already exists.
.EXAMPLE
New-ManagementUri -Name ArbitraryName -Type ArbitraryType -Value ArbitraryValue -Description ArbitraryDescription -ManagementCredentialId 1
Type : ArbitraryType
Value : ArbitraryValue
ManagementCredentialId : 1
Id : 180
Tid : 11111111-1111-1111-1111-111111111111
Name : ArbitraryName
Description : ArbitraryDescription
CreatedById : 1
ModifiedById : 1
Created : 22.08.2016 10:26:53 +02:00
Modified : 22.08.2016 10:31:00 +02:00
RowVersion : {0, 0, 0, 0...}
ManagementCredential :
Tenant :
CreatedBy :
ModifiedBy :
Create a new ManagementUri entry if it not already exists, with description, value,...
.LINK
Online Version: http://dfch.biz/biz/dfch/PS/Appclusive/Client/New-ManagementUri/
Set-ManagementUri: http://dfch.biz/biz/dfch/PS/Appclusive/Client/Set-ManagementUri/
.NOTES
See module manifest for dependencies and further requirements.
#>
[CmdletBinding(
SupportsShouldProcess = $true
,
ConfirmImpact = 'Low'
,
HelpURI='http://dfch.biz/biz/dfch/PS/Appclusive/Client/ManagementUri/'
)]
Param
(
# Specifies the type to modify
[Parameter(Mandatory = $true, Position = 0)]
[ValidateNotNullOrEmpty()]
[Alias("t")]
[string] $Type
,
# Specifies the Name to modify
[Parameter(Mandatory = $true, Position = 1)]
[ValidateNotNullOrEmpty()]
[Alias('n')]
[string] $Name
,
# Specifies the value to modify
[Parameter(Mandatory = $true, Position = 2)]
[ValidateNotNullOrEmpty()]
[Alias('v')]
[string] $Value
,
# Specifies the ManagementCredential to modify
[Parameter(Mandatory = $false)]
[Alias('m')]
[ValidateRange(1,[long]::MaxValue)]
[long] $ManagementCredentialId
,
# Specifies the value to modify
[Parameter(Mandatory = $false)]
[string] $Description
,
# Service reference to Appclusive
[Parameter(Mandatory = $false)]
[Alias('Services')]
[hashtable] $svc = (Get-Variable -Name $MyInvocation.MyCommand.Module.PrivateData.MODULEVAR -ValueOnly).Services
,
# Specifies the return format of the Cmdlet
[ValidateSet('default', 'json', 'json-pretty', 'xml', 'xml-pretty')]
[Parameter(Mandatory = $false)]
[alias('ReturnFormat')]
[string] $As = 'default'
)
Begin
{
trap { Log-Exception $_; break; }
$datBegin = [datetime]::Now;
[string] $fn = $MyInvocation.MyCommand.Name;
Log-Debug -fn $fn -msg ("CALL. svc '{0}'. Name '{1}'." -f ($svc -is [Object]), $Name) -fac 1;
# Parameter validation
Contract-Requires ($svc.Core -is [biz.dfch.CS.Appclusive.Api.Core.Core]) "Connect to the server before using the Cmdlet"
}
# Begin
Process
{
trap { Log-Exception $_; break; }
# Default test variable for checking function response codes.
[Boolean] $fReturn = $false;
# Return values are always and only returned via OutputParameter.
$OutputParameter = $null;
$Exp = @();
$ManagementUriContents = @();
$Exp += ("(tolower(Type) eq '{0}')" -f $Type.ToLower());
$Exp += ("(tolower(Name) eq '{0}')" -f $Name.ToLower());
$FilterExpression = [String]::Join(' and ', $Exp);
$ManagementUriContents += $Type;
$ManagementUriContents += $Name;
$mgmtUri = $svc.Core.ManagementUris.AddQueryOption('$filter', $FilterExpression).AddQueryOption('$top',1) | Select;
Contract-Assert (!$mgmtUri) 'Entity does already exist';
if($PSCmdlet.ShouldProcess($ManagementUriContents))
{
if($PSBoundParameters.ContainsKey('Description') -And $PSBoundParameters.ContainsKey('ManagementCredentialId'))
{
$r = Set-ManagementUri -Name $Name -type $type -Value $Value -ManagementCredentialId $ManagementCredentialId -Description $Description -CreateIfNotExist -svc $svc;
}
elseif($PSBoundParameters.ContainsKey('Description'))
{
$r = Set-ManagementUri -Name $Name -type $type -Value $Value -Description $Description -CreateIfNotExist -svc $svc;
}
elseif($PSBoundParameters.ContainsKey('ManagementCredentialId'))
{
$r = Set-ManagementUri -Name $Name -type $type -Value $Value -ManagementCredentialId $ManagementCredentialId -CreateIfNotExist -svc $svc;
}
else
{
$r = Set-ManagementUri -Name $Name -type $type -Value $Value -CreateIfNotExist -svc $svc;
}
$OutputParameter = $r;
}
$fReturn = $true;
}
# Process
End
{
$datEnd = [datetime]::Now;
Log-Debug -fn $fn -msg ("RET. fReturn: [{0}]. Execution time: [{1}]ms. Started: [{2}]." -f $fReturn, ($datEnd - $datBegin).TotalMilliseconds, $datBegin.ToString('yyyy-MM-dd HH:mm:ss.fffzzz')) -fac 2;
# Return values are always and only returned via OutputParameter.
return $OutputParameter;
}
# End
}
if($MyInvocation.ScriptName) { Export-ModuleMember -Function New-ManagementUri; }
#
# Copyright 2014-2015 d-fens GmbH
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SIG # Begin signature block
# MIIXDwYJKoZIhvcNAQcCoIIXADCCFvwCAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB
# gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR
# AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQUI2N0dQWx9Rb3eqA/zALlMS7p
# O0WgghHCMIIEFDCCAvygAwIBAgILBAAAAAABL07hUtcwDQYJKoZIhvcNAQEFBQAw
# VzELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNV
# BAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkdsb2JhbFNpZ24gUm9vdCBDQTAeFw0xMTA0
# MTMxMDAwMDBaFw0yODAxMjgxMjAwMDBaMFIxCzAJBgNVBAYTAkJFMRkwFwYDVQQK
# ExBHbG9iYWxTaWduIG52LXNhMSgwJgYDVQQDEx9HbG9iYWxTaWduIFRpbWVzdGFt
# cGluZyBDQSAtIEcyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAlO9l
# +LVXn6BTDTQG6wkft0cYasvwW+T/J6U00feJGr+esc0SQW5m1IGghYtkWkYvmaCN
# d7HivFzdItdqZ9C76Mp03otPDbBS5ZBb60cO8eefnAuQZT4XljBFcm05oRc2yrmg
# jBtPCBn2gTGtYRakYua0QJ7D/PuV9vu1LpWBmODvxevYAll4d/eq41JrUJEpxfz3
# zZNl0mBhIvIG+zLdFlH6Dv2KMPAXCae78wSuq5DnbN96qfTvxGInX2+ZbTh0qhGL
# 2t/HFEzphbLswn1KJo/nVrqm4M+SU4B09APsaLJgvIQgAIMboe60dAXBKY5i0Eex
# +vBTzBj5Ljv5cH60JQIDAQABo4HlMIHiMA4GA1UdDwEB/wQEAwIBBjASBgNVHRMB
# Af8ECDAGAQH/AgEAMB0GA1UdDgQWBBRG2D7/3OO+/4Pm9IWbsN1q1hSpwTBHBgNV
# HSAEQDA+MDwGBFUdIAAwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93d3cuZ2xvYmFs
# c2lnbi5jb20vcmVwb3NpdG9yeS8wMwYDVR0fBCwwKjAooCagJIYiaHR0cDovL2Ny
# bC5nbG9iYWxzaWduLm5ldC9yb290LmNybDAfBgNVHSMEGDAWgBRge2YaRQ2XyolQ
# L30EzTSo//z9SzANBgkqhkiG9w0BAQUFAAOCAQEATl5WkB5GtNlJMfO7FzkoG8IW
# 3f1B3AkFBJtvsqKa1pkuQJkAVbXqP6UgdtOGNNQXzFU6x4Lu76i6vNgGnxVQ380W
# e1I6AtcZGv2v8Hhc4EvFGN86JB7arLipWAQCBzDbsBJe/jG+8ARI9PBw+DpeVoPP
# PfsNvPTF7ZedudTbpSeE4zibi6c1hkQgpDttpGoLoYP9KOva7yj2zIhd+wo7AKvg
# IeviLzVsD440RZfroveZMzV+y5qKu0VN5z+fwtmK+mWybsd+Zf/okuEsMaL3sCc2
# SI8mbzvuTXYfecPlf5Y1vC0OzAGwjn//UYCAp5LUs0RGZIyHTxZjBzFLY7Df8zCC
# BCkwggMRoAMCAQICCwQAAAAAATGJxjfoMA0GCSqGSIb3DQEBCwUAMEwxIDAeBgNV
# BAsTF0dsb2JhbFNpZ24gUm9vdCBDQSAtIFIzMRMwEQYDVQQKEwpHbG9iYWxTaWdu
# MRMwEQYDVQQDEwpHbG9iYWxTaWduMB4XDTExMDgwMjEwMDAwMFoXDTE5MDgwMjEw
# MDAwMFowWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKPv0Z8p6djTgnY8YqDS
# SdYWHvHP8NC6SEMDLacd8gE0SaQQ6WIT9BP0FoO11VdCSIYrlViH6igEdMtyEQ9h
# JuH6HGEVxyibTQuCDyYrkDqW7aTQaymc9WGI5qRXb+70cNCNF97mZnZfdB5eDFM4
# XZD03zAtGxPReZhUGks4BPQHxCMD05LL94BdqpxWBkQtQUxItC3sNZKaxpXX9c6Q
# MeJ2s2G48XVXQqw7zivIkEnotybPuwyJy9DDo2qhydXjnFMrVyb+Vpp2/WFGomDs
# KUZH8s3ggmLGBFrn7U5AXEgGfZ1f53TJnoRlDVve3NMkHLQUEeurv8QfpLqZ0BdY
# Nc0CAwEAAaOB/TCB+jAOBgNVHQ8BAf8EBAMCAQYwEgYDVR0TAQH/BAgwBgEB/wIB
# ADAdBgNVHQ4EFgQUGUq4WuRNMaUU5V7sL6Mc+oCMMmswRwYDVR0gBEAwPjA8BgRV
# HSAAMDQwMgYIKwYBBQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3Jl
# cG9zaXRvcnkvMDYGA1UdHwQvMC0wK6ApoCeGJWh0dHA6Ly9jcmwuZ2xvYmFsc2ln
# bi5uZXQvcm9vdC1yMy5jcmwwEwYDVR0lBAwwCgYIKwYBBQUHAwMwHwYDVR0jBBgw
# FoAUj/BLf6guRSSuTVD6Y5qL3uLdG7wwDQYJKoZIhvcNAQELBQADggEBAHmwaTTi
# BYf2/tRgLC+GeTQD4LEHkwyEXPnk3GzPbrXsCly6C9BoMS4/ZL0Pgmtmd4F/ximl
# F9jwiU2DJBH2bv6d4UgKKKDieySApOzCmgDXsG1szYjVFXjPE/mIpXNNwTYr3MvO
# 23580ovvL72zT006rbtibiiTxAzL2ebK4BEClAOwvT+UKFaQHlPCJ9XJPM0aYx6C
# WRW2QMqngarDVa8z0bV16AnqRwhIIvtdG/Mseml+xddaXlYzPK1X6JMlQsPSXnE7
# ShxU7alVrCgFx8RsXdw8k/ZpPIJRzhoVPV4Bc/9Aouq0rtOO+u5dbEfHQfXUVlfy
# GDcy1tTMS/Zx4HYwggSfMIIDh6ADAgECAhIRIdaZp2SXPvH4Qn7pGcxTQRQwDQYJ
# KoZIhvcNAQEFBQAwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24g
# bnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzIw
# HhcNMTYwNTI0MDAwMDAwWhcNMjcwNjI0MDAwMDAwWjBgMQswCQYDVQQGEwJTRzEf
# MB0GA1UEChMWR01PIEdsb2JhbFNpZ24gUHRlIEx0ZDEwMC4GA1UEAxMnR2xvYmFs
# U2lnbiBUU0EgZm9yIE1TIEF1dGhlbnRpY29kZSAtIEcyMIIBIjANBgkqhkiG9w0B
# AQEFAAOCAQ8AMIIBCgKCAQEAsBeuotO2BDBWHlgPse1VpNZUy9j2czrsXV6rJf02
# pfqEw2FAxUa1WVI7QqIuXxNiEKlb5nPWkiWxfSPjBrOHOg5D8NcAiVOiETFSKG5d
# QHI88gl3p0mSl9RskKB2p/243LOd8gdgLE9YmABr0xVU4Prd/4AsXximmP/Uq+yh
# RVmyLm9iXeDZGayLV5yoJivZF6UQ0kcIGnAsM4t/aIAqtaFda92NAgIpA6p8N7u7
# KU49U5OzpvqP0liTFUy5LauAo6Ml+6/3CGSwekQPXBDXX2E3qk5r09JTJZ2Cc/os
# +XKwqRk5KlD6qdA8OsroW+/1X1H0+QrZlzXeaoXmIwRCrwIDAQABo4IBXzCCAVsw
# DgYDVR0PAQH/BAQDAgeAMEwGA1UdIARFMEMwQQYJKwYBBAGgMgEeMDQwMgYIKwYB
# BQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3JlcG9zaXRvcnkvMAkG
# A1UdEwQCMAAwFgYDVR0lAQH/BAwwCgYIKwYBBQUHAwgwQgYDVR0fBDswOTA3oDWg
# M4YxaHR0cDovL2NybC5nbG9iYWxzaWduLmNvbS9ncy9nc3RpbWVzdGFtcGluZ2cy
# LmNybDBUBggrBgEFBQcBAQRIMEYwRAYIKwYBBQUHMAKGOGh0dHA6Ly9zZWN1cmUu
# Z2xvYmFsc2lnbi5jb20vY2FjZXJ0L2dzdGltZXN0YW1waW5nZzIuY3J0MB0GA1Ud
# DgQWBBTUooRKOFoYf7pPMFC9ndV6h9YJ9zAfBgNVHSMEGDAWgBRG2D7/3OO+/4Pm
# 9IWbsN1q1hSpwTANBgkqhkiG9w0BAQUFAAOCAQEAj6kakW0EpjcgDoOW3iPTa24f
# bt1kPWghIrX4RzZpjuGlRcckoiK3KQnMVFquxrzNY46zPVBI5bTMrs2SjZ4oixNK
# Eaq9o+/Tsjb8tKFyv22XY3mMRLxwL37zvN2CU6sa9uv6HJe8tjecpBwwvKu8LUc2
# 35IgA+hxxlj2dQWaNPALWVqCRDSqgOQvhPZHXZbJtsrKnbemuuRQ09Q3uLogDtDT
# kipbxFm7oW3bPM5EncE4Kq3jjb3NCXcaEL5nCgI2ZIi5sxsm7ueeYMRGqLxhM2zP
# TrmcuWrwnzf+tT1PmtNN/94gjk6Xpv2fCbxNyhh2ybBNhVDygNIdBvVYBAexGDCC
# BNYwggO+oAMCAQICEhEhDRayW4wRltP+V8mGEea62TANBgkqhkiG9w0BAQsFADBa
# MQswCQYDVQQGEwJCRTEZMBcGA1UEChMQR2xvYmFsU2lnbiBudi1zYTEwMC4GA1UE
# AxMnR2xvYmFsU2lnbiBDb2RlU2lnbmluZyBDQSAtIFNIQTI1NiAtIEcyMB4XDTE1
# MDUwNDE2NDMyMVoXDTE4MDUwNDE2NDMyMVowVTELMAkGA1UEBhMCQ0gxDDAKBgNV
# BAgTA1p1ZzEMMAoGA1UEBxMDWnVnMRQwEgYDVQQKEwtkLWZlbnMgR21iSDEUMBIG
# A1UEAxMLZC1mZW5zIEdtYkgwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB
# AQDNPSzSNPylU9jFM78Q/GjzB7N+VNqikf/use7p8mpnBZ4cf5b4qV3rqQd62rJH
# RlAsxgouCSNQrl8xxfg6/t/I02kPvrzsR4xnDgMiVCqVRAeQsWebafWdTvWmONBS
# lxJejPP8TSgXMKFaDa+2HleTycTBYSoErAZSWpQ0NqF9zBadjsJRVatQuPkTDrwL
# eWibiyOipK9fcNoQpl5ll5H9EG668YJR3fqX9o0TQTkOmxXIL3IJ0UxdpyDpLEkt
# tBG6Y5wAdpF2dQX2phrfFNVY54JOGtuBkNGMSiLFzTkBA1fOlA6ICMYjB8xIFxVv
# rN1tYojCrqYkKMOjwWQz5X8zAgMBAAGjggGZMIIBlTAOBgNVHQ8BAf8EBAMCB4Aw
# TAYDVR0gBEUwQzBBBgkrBgEEAaAyATIwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93
# d3cuZ2xvYmFsc2lnbi5jb20vcmVwb3NpdG9yeS8wCQYDVR0TBAIwADATBgNVHSUE
# DDAKBggrBgEFBQcDAzBCBgNVHR8EOzA5MDegNaAzhjFodHRwOi8vY3JsLmdsb2Jh
# bHNpZ24uY29tL2dzL2dzY29kZXNpZ25zaGEyZzIuY3JsMIGQBggrBgEFBQcBAQSB
# gzCBgDBEBggrBgEFBQcwAoY4aHR0cDovL3NlY3VyZS5nbG9iYWxzaWduLmNvbS9j
# YWNlcnQvZ3Njb2Rlc2lnbnNoYTJnMi5jcnQwOAYIKwYBBQUHMAGGLGh0dHA6Ly9v
# Y3NwMi5nbG9iYWxzaWduLmNvbS9nc2NvZGVzaWduc2hhMmcyMB0GA1UdDgQWBBTN
# GDddiIYZy9p3Z84iSIMd27rtUDAfBgNVHSMEGDAWgBQZSrha5E0xpRTlXuwvoxz6
# gIwyazANBgkqhkiG9w0BAQsFAAOCAQEAAApsOzSX1alF00fTeijB/aIthO3UB0ks
# 1Gg3xoKQC1iEQmFG/qlFLiufs52kRPN7L0a7ClNH3iQpaH5IEaUENT9cNEXdKTBG
# 8OrJS8lrDJXImgNEgtSwz0B40h7bM2Z+0DvXDvpmfyM2NwHF/nNVj7NzmczrLRqN
# 9de3tV0pgRqnIYordVcmb24CZl3bzpwzbQQy14Iz+P5Z2cnw+QaYzAuweTZxEUcJ
# bFwpM49c1LMPFJTuOKkUgY90JJ3gVTpyQxfkc7DNBnx74PlRzjFmeGC/hxQt0hvo
# eaAiBdjo/1uuCTToigVnyRH+c0T2AezTeoFb7ne3I538hWeTdU5q9jGCBLcwggSz
# AgEBMHAwWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MgISESENFrJbjBGW0/5XyYYR5rrZMAkGBSsOAwIaBQCgeDAYBgorBgEEAYI3AgEM
# MQowCKACgAChAoAAMBkGCSqGSIb3DQEJAzEMBgorBgEEAYI3AgEEMBwGCisGAQQB
# gjcCAQsxDjAMBgorBgEEAYI3AgEVMCMGCSqGSIb3DQEJBDEWBBTVt+dp8eWP6fV2
# 6KsUo5p86ouP3zANBgkqhkiG9w0BAQEFAASCAQBXA+ga0ATMPpGRwbZWByiLOoOc
# IdSG/vveVt/30ZZH/x85+PMsaEtZvIhfhDpVqw4y0rK6f+81a8599mtNlDfCYj17
# vaqkmMykUawJRGFb3OBQyVijuAtdAHQgTq7sw6s+e1M8NYg2ciPo4ek2xqrzH7GL
# f5kNNIcuZN1JRyjzFCBPceJWv8VI6QtirJbcHG6Hx88fD6F/2gcf7ZXyTdDVymbZ
# Y47BRGaFGV2+6S5uPS5oausemAMJLEqSzpb6H/W7tkCZxL7j4tYCIgDDM7lJWgT5
# 5HsiKmuyZ9oYo4mKXEryuyDWKmD3nTsMparv9dkwbdEDTtYhp22XyqerUcufoYIC
# ojCCAp4GCSqGSIb3DQEJBjGCAo8wggKLAgEBMGgwUjELMAkGA1UEBhMCQkUxGTAX
# BgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGlt
# ZXN0YW1waW5nIENBIC0gRzICEhEh1pmnZJc+8fhCfukZzFNBFDAJBgUrDgMCGgUA
# oIH9MBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTE2
# MDgyNDE1NTQyMVowIwYJKoZIhvcNAQkEMRYEFFxe6srIBXZvkzOJGb1p6MwGGhw2
# MIGdBgsqhkiG9w0BCRACDDGBjTCBijCBhzCBhAQUY7gvq2H1g5CWlQULACScUCkz
# 7HkwbDBWpFQwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYt
# c2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzICEhEh
# 1pmnZJc+8fhCfukZzFNBFDANBgkqhkiG9w0BAQEFAASCAQCQkew5dlFohTzAFOLN
# ICsq4VeHEzy5u4P+bp42U3R4w/1j/ON7K/ERam77cjDBEEJNh9VTFNlybRX9M+0F
# ofD1LR+VLCaW3Ggid5uiRjsUgY2gMhmPagYX5iwuXtp8fZDq7TgdbsjpzSPlgNkF
# TPem94gvFdWpEhB8KJnJ2O7m06giFpV+jKq4foTV9AlaBfjlWm3R6XwGpfXOb7oJ
# 3XGT3eTrctN36FCkBVU+zugTUL6iFi+O6NW33AczrdA23rlm+J141VRjGzuhWgYc
# 27a2QUqzOjXw1YT6FZeV13xB8XQL0OsqK+JHjKzCMICBqFJZm+iIG5xTFjExZ580
# S4Fr
# SIG # End signature block
|
PowerShellCorpus/PowerShellGallery/biz.dfch.PS.Appclusive.Client/5.2.1.20161201/Pop-ChangeTracker.ps1
|
Pop-ChangeTracker.ps1
|
function Pop-ChangeTracker {
<#
.SYNOPSIS
Pops the contents of the DataServiceContext ChangeTracker from the DataContext stack.
.DESCRIPTION
Pops the contents of the DataServiceContext ChangeTracker from the DataContext stack.
.INPUTS
The Cmdlet can either pop a context or clear the contents of the DataContext stack.
See PARAMETERS section on possible inputs.
.OUTPUTS
[System.Collections.Hashtable]
.LINK
Online Version: http://dfch.biz/biz/dfch/PS/Appclusive/Client/Push-ChangeTracker/
.NOTES
See module manifest for required software versions and dependencies.
#>
[CmdletBinding(
SupportsShouldProcess = $false
,
ConfirmImpact = 'Medium'
,
HelpURI = 'http://dfch.biz/PS/Appclusive/Client/Pop-ChangeTracker/'
)]
[OutputType([Boolean])]
Param
(
[ValidateScript({$_.ContainsKey('Entities') -And $_.ContainsKey('Links')})]
[Parameter(Mandatory = $false, Position = 0)]
[hashtable] $DataContext = (Get-Variable -Name $MyInvocation.MyCommand.Module.PrivateData.MODULEVAR -ValueOnly).DataContext.Pop()
,
# Specifies a references to the Appclusive endpoints
[Parameter(Mandatory = $false)]
[Alias('Services')]
[hashtable] $svc = (Get-Variable -Name $MyInvocation.MyCommand.Module.PrivateData.MODULEVAR -ValueOnly).Services
,
# Specifies the service or container name of the entity to remove
[ValidateScript( { if($svc.Keys -contains $_) { $true; } else { throw('{0}: Invalid service name specified.' -f $_); } } )]
[Parameter(Mandatory = $false, Position = 0)]
[Alias("Container")]
[string] $Service = 'Core'
,
[Parameter(Mandatory = $false)]
[switch] $Clear = $false
,
[Parameter(Mandatory = $false)]
[Object[]] $Exclude
)
trap { Log-Exception $_; break; }
$datBegin = [datetime]::Now;
[string] $fn = $MyInvocation.MyCommand.Name;
$ModuleVar = Get-ModuleVariable;
Log-Debug -fn $fn -msg ("CALL. DataContext stack size '{0}'." -f $ModuleVar.DataContext.Count) -fac 1;
# Parameter validation
Contract-Requires ($svc.Core -is [biz.dfch.CS.Appclusive.Api.Core.Core]) "Connect to the server before using the Cmdlet"
$EntitySetName = 'Entities';
Contract-Requires (!!(Get-Member -InputObject $svc.$Service -MemberType Properties -Name $EntitySetName)) "'Entities' is not a valid entity set in specified Service"
$EntitySetName = 'Links';
Contract-Requires (!!(Get-Member -InputObject $svc.$Service -MemberType Properties -Name $EntitySetName)) "'Links' is not a valid entity set in specified Service"
Contract-Requires ($DataContext -is [hashtable])
Contract-Requires ($svc.$Service.GetType().BaseType.FullName -eq 'biz.dfch.CS.Appclusive.Api.DataServiceContextBase')
$m = $svc.$Service;
$fReturn = $false;
$fLinks = $false;
$fEntities = $false;
if($Clear)
{
foreach($e in $m.Entities)
{
$null = $m.Detach($e.Entity);
}
foreach($l in $m.Links)
{
$null = $m.DetachLink($l.Source, $l.SourceProperty, $l.Target);
}
}
else
{
if($DataContext.ContainsKey('Entities'))
{
$e = '';
$aE = $DataContext.Entities;
foreach($e in $m.Entities)
{
if(!$aE.Contains($e.Entity))
{
$null = $m.Detach($e.Entity);
}
}
$aE.Clear();
Remove-Variable aE;
Remove-Variable e;
$fEntities = $true;
}
if($DataContext.ContainsKey('Links'))
{
$l = '';
$aL = $DataContext.Links;
foreach($l in $m.Links)
{
if(!$aL.Contains($l))
{
$null = $m.DetachLink($l.Source, $l.SourceProperty, $l.Target);
}
}
$aL.Clear();
Remove-Variable aL;
Remove-Variable l;
$fLinks = $true;
}
}
if($fLinks -Or $fEntities)
{
$fReturn = $true;
}
$datEnd = [datetime]::Now;
Log-Debug -fn $fn -msg ("RET. fReturn: [{0}]. Execution time: [{1}]ms. Started: [{2}]. Tracked objects currently: Entities [{3}]. Links [{4}]." -f $fReturn, ($datEnd - $datBegin).TotalMilliseconds, $datBegin.ToString('yyyy-MM-dd HH:mm:ss.fffzzz'), $m.Entities.Count, $m.Links.Count) -fac 2;
return $fReturn;
}
if($MyInvocation.ScriptName) { Export-ModuleMember -Function Pop-ChangeTracker; }
#
# Copyright 2014-2015 d-fens GmbH
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SIG # Begin signature block
# MIIXDwYJKoZIhvcNAQcCoIIXADCCFvwCAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB
# gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR
# AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQUbfVvE5ojMfwL/6q/vpm/J//1
# 0GmgghHCMIIEFDCCAvygAwIBAgILBAAAAAABL07hUtcwDQYJKoZIhvcNAQEFBQAw
# VzELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNV
# BAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkdsb2JhbFNpZ24gUm9vdCBDQTAeFw0xMTA0
# MTMxMDAwMDBaFw0yODAxMjgxMjAwMDBaMFIxCzAJBgNVBAYTAkJFMRkwFwYDVQQK
# ExBHbG9iYWxTaWduIG52LXNhMSgwJgYDVQQDEx9HbG9iYWxTaWduIFRpbWVzdGFt
# cGluZyBDQSAtIEcyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAlO9l
# +LVXn6BTDTQG6wkft0cYasvwW+T/J6U00feJGr+esc0SQW5m1IGghYtkWkYvmaCN
# d7HivFzdItdqZ9C76Mp03otPDbBS5ZBb60cO8eefnAuQZT4XljBFcm05oRc2yrmg
# jBtPCBn2gTGtYRakYua0QJ7D/PuV9vu1LpWBmODvxevYAll4d/eq41JrUJEpxfz3
# zZNl0mBhIvIG+zLdFlH6Dv2KMPAXCae78wSuq5DnbN96qfTvxGInX2+ZbTh0qhGL
# 2t/HFEzphbLswn1KJo/nVrqm4M+SU4B09APsaLJgvIQgAIMboe60dAXBKY5i0Eex
# +vBTzBj5Ljv5cH60JQIDAQABo4HlMIHiMA4GA1UdDwEB/wQEAwIBBjASBgNVHRMB
# Af8ECDAGAQH/AgEAMB0GA1UdDgQWBBRG2D7/3OO+/4Pm9IWbsN1q1hSpwTBHBgNV
# HSAEQDA+MDwGBFUdIAAwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93d3cuZ2xvYmFs
# c2lnbi5jb20vcmVwb3NpdG9yeS8wMwYDVR0fBCwwKjAooCagJIYiaHR0cDovL2Ny
# bC5nbG9iYWxzaWduLm5ldC9yb290LmNybDAfBgNVHSMEGDAWgBRge2YaRQ2XyolQ
# L30EzTSo//z9SzANBgkqhkiG9w0BAQUFAAOCAQEATl5WkB5GtNlJMfO7FzkoG8IW
# 3f1B3AkFBJtvsqKa1pkuQJkAVbXqP6UgdtOGNNQXzFU6x4Lu76i6vNgGnxVQ380W
# e1I6AtcZGv2v8Hhc4EvFGN86JB7arLipWAQCBzDbsBJe/jG+8ARI9PBw+DpeVoPP
# PfsNvPTF7ZedudTbpSeE4zibi6c1hkQgpDttpGoLoYP9KOva7yj2zIhd+wo7AKvg
# IeviLzVsD440RZfroveZMzV+y5qKu0VN5z+fwtmK+mWybsd+Zf/okuEsMaL3sCc2
# SI8mbzvuTXYfecPlf5Y1vC0OzAGwjn//UYCAp5LUs0RGZIyHTxZjBzFLY7Df8zCC
# BCkwggMRoAMCAQICCwQAAAAAATGJxjfoMA0GCSqGSIb3DQEBCwUAMEwxIDAeBgNV
# BAsTF0dsb2JhbFNpZ24gUm9vdCBDQSAtIFIzMRMwEQYDVQQKEwpHbG9iYWxTaWdu
# MRMwEQYDVQQDEwpHbG9iYWxTaWduMB4XDTExMDgwMjEwMDAwMFoXDTE5MDgwMjEw
# MDAwMFowWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKPv0Z8p6djTgnY8YqDS
# SdYWHvHP8NC6SEMDLacd8gE0SaQQ6WIT9BP0FoO11VdCSIYrlViH6igEdMtyEQ9h
# JuH6HGEVxyibTQuCDyYrkDqW7aTQaymc9WGI5qRXb+70cNCNF97mZnZfdB5eDFM4
# XZD03zAtGxPReZhUGks4BPQHxCMD05LL94BdqpxWBkQtQUxItC3sNZKaxpXX9c6Q
# MeJ2s2G48XVXQqw7zivIkEnotybPuwyJy9DDo2qhydXjnFMrVyb+Vpp2/WFGomDs
# KUZH8s3ggmLGBFrn7U5AXEgGfZ1f53TJnoRlDVve3NMkHLQUEeurv8QfpLqZ0BdY
# Nc0CAwEAAaOB/TCB+jAOBgNVHQ8BAf8EBAMCAQYwEgYDVR0TAQH/BAgwBgEB/wIB
# ADAdBgNVHQ4EFgQUGUq4WuRNMaUU5V7sL6Mc+oCMMmswRwYDVR0gBEAwPjA8BgRV
# HSAAMDQwMgYIKwYBBQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3Jl
# cG9zaXRvcnkvMDYGA1UdHwQvMC0wK6ApoCeGJWh0dHA6Ly9jcmwuZ2xvYmFsc2ln
# bi5uZXQvcm9vdC1yMy5jcmwwEwYDVR0lBAwwCgYIKwYBBQUHAwMwHwYDVR0jBBgw
# FoAUj/BLf6guRSSuTVD6Y5qL3uLdG7wwDQYJKoZIhvcNAQELBQADggEBAHmwaTTi
# BYf2/tRgLC+GeTQD4LEHkwyEXPnk3GzPbrXsCly6C9BoMS4/ZL0Pgmtmd4F/ximl
# F9jwiU2DJBH2bv6d4UgKKKDieySApOzCmgDXsG1szYjVFXjPE/mIpXNNwTYr3MvO
# 23580ovvL72zT006rbtibiiTxAzL2ebK4BEClAOwvT+UKFaQHlPCJ9XJPM0aYx6C
# WRW2QMqngarDVa8z0bV16AnqRwhIIvtdG/Mseml+xddaXlYzPK1X6JMlQsPSXnE7
# ShxU7alVrCgFx8RsXdw8k/ZpPIJRzhoVPV4Bc/9Aouq0rtOO+u5dbEfHQfXUVlfy
# GDcy1tTMS/Zx4HYwggSfMIIDh6ADAgECAhIRIdaZp2SXPvH4Qn7pGcxTQRQwDQYJ
# KoZIhvcNAQEFBQAwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24g
# bnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzIw
# HhcNMTYwNTI0MDAwMDAwWhcNMjcwNjI0MDAwMDAwWjBgMQswCQYDVQQGEwJTRzEf
# MB0GA1UEChMWR01PIEdsb2JhbFNpZ24gUHRlIEx0ZDEwMC4GA1UEAxMnR2xvYmFs
# U2lnbiBUU0EgZm9yIE1TIEF1dGhlbnRpY29kZSAtIEcyMIIBIjANBgkqhkiG9w0B
# AQEFAAOCAQ8AMIIBCgKCAQEAsBeuotO2BDBWHlgPse1VpNZUy9j2czrsXV6rJf02
# pfqEw2FAxUa1WVI7QqIuXxNiEKlb5nPWkiWxfSPjBrOHOg5D8NcAiVOiETFSKG5d
# QHI88gl3p0mSl9RskKB2p/243LOd8gdgLE9YmABr0xVU4Prd/4AsXximmP/Uq+yh
# RVmyLm9iXeDZGayLV5yoJivZF6UQ0kcIGnAsM4t/aIAqtaFda92NAgIpA6p8N7u7
# KU49U5OzpvqP0liTFUy5LauAo6Ml+6/3CGSwekQPXBDXX2E3qk5r09JTJZ2Cc/os
# +XKwqRk5KlD6qdA8OsroW+/1X1H0+QrZlzXeaoXmIwRCrwIDAQABo4IBXzCCAVsw
# DgYDVR0PAQH/BAQDAgeAMEwGA1UdIARFMEMwQQYJKwYBBAGgMgEeMDQwMgYIKwYB
# BQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3JlcG9zaXRvcnkvMAkG
# A1UdEwQCMAAwFgYDVR0lAQH/BAwwCgYIKwYBBQUHAwgwQgYDVR0fBDswOTA3oDWg
# M4YxaHR0cDovL2NybC5nbG9iYWxzaWduLmNvbS9ncy9nc3RpbWVzdGFtcGluZ2cy
# LmNybDBUBggrBgEFBQcBAQRIMEYwRAYIKwYBBQUHMAKGOGh0dHA6Ly9zZWN1cmUu
# Z2xvYmFsc2lnbi5jb20vY2FjZXJ0L2dzdGltZXN0YW1waW5nZzIuY3J0MB0GA1Ud
# DgQWBBTUooRKOFoYf7pPMFC9ndV6h9YJ9zAfBgNVHSMEGDAWgBRG2D7/3OO+/4Pm
# 9IWbsN1q1hSpwTANBgkqhkiG9w0BAQUFAAOCAQEAj6kakW0EpjcgDoOW3iPTa24f
# bt1kPWghIrX4RzZpjuGlRcckoiK3KQnMVFquxrzNY46zPVBI5bTMrs2SjZ4oixNK
# Eaq9o+/Tsjb8tKFyv22XY3mMRLxwL37zvN2CU6sa9uv6HJe8tjecpBwwvKu8LUc2
# 35IgA+hxxlj2dQWaNPALWVqCRDSqgOQvhPZHXZbJtsrKnbemuuRQ09Q3uLogDtDT
# kipbxFm7oW3bPM5EncE4Kq3jjb3NCXcaEL5nCgI2ZIi5sxsm7ueeYMRGqLxhM2zP
# TrmcuWrwnzf+tT1PmtNN/94gjk6Xpv2fCbxNyhh2ybBNhVDygNIdBvVYBAexGDCC
# BNYwggO+oAMCAQICEhEhDRayW4wRltP+V8mGEea62TANBgkqhkiG9w0BAQsFADBa
# MQswCQYDVQQGEwJCRTEZMBcGA1UEChMQR2xvYmFsU2lnbiBudi1zYTEwMC4GA1UE
# AxMnR2xvYmFsU2lnbiBDb2RlU2lnbmluZyBDQSAtIFNIQTI1NiAtIEcyMB4XDTE1
# MDUwNDE2NDMyMVoXDTE4MDUwNDE2NDMyMVowVTELMAkGA1UEBhMCQ0gxDDAKBgNV
# BAgTA1p1ZzEMMAoGA1UEBxMDWnVnMRQwEgYDVQQKEwtkLWZlbnMgR21iSDEUMBIG
# A1UEAxMLZC1mZW5zIEdtYkgwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB
# AQDNPSzSNPylU9jFM78Q/GjzB7N+VNqikf/use7p8mpnBZ4cf5b4qV3rqQd62rJH
# RlAsxgouCSNQrl8xxfg6/t/I02kPvrzsR4xnDgMiVCqVRAeQsWebafWdTvWmONBS
# lxJejPP8TSgXMKFaDa+2HleTycTBYSoErAZSWpQ0NqF9zBadjsJRVatQuPkTDrwL
# eWibiyOipK9fcNoQpl5ll5H9EG668YJR3fqX9o0TQTkOmxXIL3IJ0UxdpyDpLEkt
# tBG6Y5wAdpF2dQX2phrfFNVY54JOGtuBkNGMSiLFzTkBA1fOlA6ICMYjB8xIFxVv
# rN1tYojCrqYkKMOjwWQz5X8zAgMBAAGjggGZMIIBlTAOBgNVHQ8BAf8EBAMCB4Aw
# TAYDVR0gBEUwQzBBBgkrBgEEAaAyATIwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93
# d3cuZ2xvYmFsc2lnbi5jb20vcmVwb3NpdG9yeS8wCQYDVR0TBAIwADATBgNVHSUE
# DDAKBggrBgEFBQcDAzBCBgNVHR8EOzA5MDegNaAzhjFodHRwOi8vY3JsLmdsb2Jh
# bHNpZ24uY29tL2dzL2dzY29kZXNpZ25zaGEyZzIuY3JsMIGQBggrBgEFBQcBAQSB
# gzCBgDBEBggrBgEFBQcwAoY4aHR0cDovL3NlY3VyZS5nbG9iYWxzaWduLmNvbS9j
# YWNlcnQvZ3Njb2Rlc2lnbnNoYTJnMi5jcnQwOAYIKwYBBQUHMAGGLGh0dHA6Ly9v
# Y3NwMi5nbG9iYWxzaWduLmNvbS9nc2NvZGVzaWduc2hhMmcyMB0GA1UdDgQWBBTN
# GDddiIYZy9p3Z84iSIMd27rtUDAfBgNVHSMEGDAWgBQZSrha5E0xpRTlXuwvoxz6
# gIwyazANBgkqhkiG9w0BAQsFAAOCAQEAAApsOzSX1alF00fTeijB/aIthO3UB0ks
# 1Gg3xoKQC1iEQmFG/qlFLiufs52kRPN7L0a7ClNH3iQpaH5IEaUENT9cNEXdKTBG
# 8OrJS8lrDJXImgNEgtSwz0B40h7bM2Z+0DvXDvpmfyM2NwHF/nNVj7NzmczrLRqN
# 9de3tV0pgRqnIYordVcmb24CZl3bzpwzbQQy14Iz+P5Z2cnw+QaYzAuweTZxEUcJ
# bFwpM49c1LMPFJTuOKkUgY90JJ3gVTpyQxfkc7DNBnx74PlRzjFmeGC/hxQt0hvo
# eaAiBdjo/1uuCTToigVnyRH+c0T2AezTeoFb7ne3I538hWeTdU5q9jGCBLcwggSz
# AgEBMHAwWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MgISESENFrJbjBGW0/5XyYYR5rrZMAkGBSsOAwIaBQCgeDAYBgorBgEEAYI3AgEM
# MQowCKACgAChAoAAMBkGCSqGSIb3DQEJAzEMBgorBgEEAYI3AgEEMBwGCisGAQQB
# gjcCAQsxDjAMBgorBgEEAYI3AgEVMCMGCSqGSIb3DQEJBDEWBBT1Grqyz3Hf4k+n
# PDNs7YTXKx3+FzANBgkqhkiG9w0BAQEFAASCAQAlEg9IVtcr1eC4OWOZ1fv9fBmr
# F2qSbGfR+in3cW9vE2GcEqRenVoqOGhWZL1zz0Y96Aas6nh2JnqHZQy90lb8tv9r
# 2shNE5g1PzIYAsw46WgIH09excr3rgiWAGBr6MgAXmN5SXrZfiFC7N4L+L2zRgUr
# o4SvUH3JBBZDker6iOlOLax77wqP99g2EQWZRHYKYYtgMvOq/jnETla7R2/nvlm/
# AMeDBp4v3rPuHIyLr0p8ydCGcxnB6BfZv5PCHnE6NqfGOo1Y+0i3YeWa8yHahxNG
# QxbRiHtmMTRN+9oA+KarNhAw9g6UzYXOWE2aNuCTGyfX2Byo+ix5GENFgW/8oYIC
# ojCCAp4GCSqGSIb3DQEJBjGCAo8wggKLAgEBMGgwUjELMAkGA1UEBhMCQkUxGTAX
# BgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGlt
# ZXN0YW1waW5nIENBIC0gRzICEhEh1pmnZJc+8fhCfukZzFNBFDAJBgUrDgMCGgUA
# oIH9MBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTE2
# MDgzMTE5MTY1N1owIwYJKoZIhvcNAQkEMRYEFEtowOQ4SuehOnVZYWq7RZvkWEwk
# MIGdBgsqhkiG9w0BCRACDDGBjTCBijCBhzCBhAQUY7gvq2H1g5CWlQULACScUCkz
# 7HkwbDBWpFQwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYt
# c2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzICEhEh
# 1pmnZJc+8fhCfukZzFNBFDANBgkqhkiG9w0BAQEFAASCAQA/Be+ylGPs7uY4TEqj
# vw2bjIGU7MNEfo40TkVH/CwZoz5nJZt//XMR4D4poyylNl9eDlpcNi0OHqfcQRfo
# NfaNHVBRPEWtgoPbVFPG5QTPsFaxXtG1/NwI7+WdFiGQzSnmvvuxtsps0xLI6Z1o
# r3nL1QLMeWJNSv4GvEu1j7YVVilsj1/SwnEfg13qQM9y8lXk6TIBS/TbsROiIjKZ
# dZlfnF+kjVa+wGymt9971LsxKih+EPixZ/jxcJ380fSxRy+CvV54nZEGq2t3AHsK
# 3ID1mkf4u7tAi+jpMs2Ew/3nCEp+UIDJAd1pmbZFIy4E8bLRhbwfeQiG9RLTzkqs
# sXUK
# SIG # End signature block
|
PowerShellCorpus/PowerShellGallery/biz.dfch.PS.Appclusive.Client/5.2.1.20161201/Import-DataType.ps1
|
Import-DataType.ps1
|
function Import-DataType {
<#
.SYNOPSIS
Creates or Recreates DataTypes for an EntityKind (based on .NET class)
.DESCRIPTION
Creates or Recreates DataTypes for an EntityKind (based on .NET class)
Inspects a given .NET class and all its properties and creates a DataType for each property. All supported Validation Attributes will be parsed into the DataTypes.
.OUTPUTS
default | json | json-pretty | xml | xml-pretty
.EXAMPLE
# Imports all properties of the product 'biz.dfch.Appclusive.Products.Infrastructure.V001.VirtualMachine'. Existing properties will be deleted if they already exist.
Import-DataType -EntityKindVersion biz.dfch.Appclusive.Products.Infrastructure.V001.VirtualMachine -RecreateIfExist
EntityKindId : 4099
ValidateSet :
ValidatePattern :
ValidateScript :
Type : System.Double
KeyNameValueFilter :
Default : 4
Minimum : 0.5
Maximum : 384
Increment : 0.1
IncrementFunction :
IsRequired : True
Unit : GB
Id : 88
Tid : 11111111-1111-1111-1111-111111111111
Name : biz.dfch.Appclusive.Products.Infrastructure.VirtualMachine.Memory.Size
Description : This property specifies the memory in MB of the virtual machine.
CreatedById : 3
ModifiedById : 3
Created : 8/24/2016 8:31:04 PM +02:00
Modified : 8/24/2016 8:31:04 PM +02:00
RowVersion : {0, 0, 0, 0...}
EntityKind :
Tenant :
CreatedBy :
ModifiedBy :
# output suppressed
.LINK
Online Version: http://dfch.biz/biz/dfch/PS/Appclusive/Client/Import-DataType/
.NOTES
See module manifest for dependencies and further requirements.
#>
[CmdletBinding(
SupportsShouldProcess = $true
,
ConfirmImpact = 'High'
,
HelpURI = 'http://dfch.biz/biz/dfch/PS/Appclusive/Client/Import-DataType/'
)]
Param
(
# Specifies the Version of the EntityKind to be imported
[Parameter(Mandatory = $true, Position = 0)]
[Alias("FQCN")]
[string] $EntityKindVersion
,
# Specifies to delete already existing entities during import
[Parameter(Mandatory = $false, Position = 1)]
[Alias("f")]
[Alias("force")]
[switch] $RecreateIfExist = $false
,
# Service reference to Appclusive
[Parameter(Mandatory = $false, Position = 2)]
[Alias('Services')]
[hashtable] $svc = (Get-Variable -Name $MyInvocation.MyCommand.Module.PrivateData.MODULEVAR -ValueOnly).Services
,
# Specifies the return format of the Cmdlet
[ValidateSet('default', 'json', 'json-pretty', 'xml', 'xml-pretty')]
[Parameter(Mandatory = $false, Position = 3)]
[Alias('ReturnFormat')]
[string] $As = 'default'
)
Begin
{
trap { Log-Exception $_; break; }
$entitySetName = "DataTypes";
$datBegin = [datetime]::Now;
[string] $fn = $MyInvocation.MyCommand.Name;
Log-Debug -fn $fn -msg ("CALL. svc '{0}'. EntityKindVersion '{1}'." -f ($svc -is [Object]), $EntityKindVersion) -fac 1;
# Parameter validation
Contract-Requires ($svc.Core -is [biz.dfch.CS.Appclusive.Api.Core.Core]) "Connect to the server before using the Cmdlet"
}
# Begin
Process
{
# Default test variable for checking function response codes.
[Boolean] $fReturn = $false;
# Return values are always and only returned via OutputParameter.
$OutputParameter = $null;
Log-Debug $fn ("Resolving EntityKind.Version '{0}' ..." -f $EntityKindVersion);
$entityKind = Get-EntityKind -Version $EntityKindVersion -svc $svc;
Contract-Assert (!!$entityKind) "EntityKindVersion does not exist";
Log-Info $fn ("Resolving EntityKind.Version '{0}' ['{1}'] SUCCEEDED." -f $EntityKindVersion, $entityKind.Id);
$entityFqcn = biz.dfch.PS.System.Utilities\Get-DataType $entityKind.Version -Literal;
Contract-Assert (1 -eq $entityFqcn.Count)
$instance = New-Object $entityFqcn;
Contract-Assert (!!$instance)
$properties = $instance.GetType().GetProperties([System.Reflection.BindingFlags]::Public -bor [System.Reflection.BindingFlags]::FlattenHierarchy -bor [System.Reflection.BindingFlags]::Instance);
$r = @();
$q = "EntityKindId eq {0}" -f $entityKind.Id;
$dataTypes = $svc.Diagnostics.DataTypes.AddQueryOption('$filter', $q) | Select;
if ($PSBoundParameters.ContainsKey('RecreateIfExist'))
{
$null = $dataTypes | Remove-Entity -svc $svc;
$dataTypes = @();
}
foreach ($property in $properties)
{
$entityBagAttributeName = GetEntityBagAttributeName $property;
if (!$entityBagAttributeName)
{
continue;
}
Log-Info $fn ("Importing '{0}' ..." -f $entityBagAttributeName);
$dataType = $dataTypes |? Name -eq $entityBagAttributeName;
if ($dataType)
{
# Do not change an existing dataType
Log-Warning $fn ("Importing '{0}' FAILED. DataType already exists." -f $entityBagAttributeName);
continue;
}
$dataType = New-Object biz.dfch.CS.Appclusive.Core.OdataServices.Diagnostics.DataType;
$svc.Diagnostics.AddToDataTypes($dataType);
$dataType.EntityKindId = $entityKind.Id;
$dataType.Name = $entityBagAttributeName;
$dataType.Type = $property.PropertyType.FullName;
SetPropertyDescriptionAttribute $dataType $property;
SetDefaultValueAttribute $dataType $property;
SetRequiredAttribute $dataType $property;
SetRangeAttribute $dataType $property;
SetIncrementAttribute $dataType $property;
SetUnitAttribute $dataType $property;
SetValidatePatternAttribute $dataType $property;
SetValidateScriptAttribute $dataType $property;
SetValidateSetAttribute $dataType $property;
SetKeyNameValueFilterAttribute $dataType $property;
SetStringLengthAttribute $dataType $property;
$svc.Diagnostics.UpdateObject($dataType);
if($PSCmdlet.ShouldProcess(($dataType | Out-String)))
{
$null = $svc.Diagnostics.SaveChanges();
Log-Info $fn ("Importing '{0}' SUCCEEDED." -f $entityBagAttributeName);
$r += $dataType;
}
}
$OutputParameter = Format-ResultAs $r $As;
$fReturn = $true;
}
# Process
End
{
$datEnd = [datetime]::Now;
Log-Debug -fn $fn -msg ("RET. fReturn: [{0}]. Execution time: [{1}]ms. Started: [{2}]." -f $fReturn, ($datEnd - $datBegin).TotalMilliseconds, $datBegin.ToString('yyyy-MM-dd HH:mm:ss.fffzzz')) -fac 2;
# Return values are always and only returned via OutputParameter.
return $OutputParameter;
}
# End
}
if($MyInvocation.ScriptName) { Export-ModuleMember -Function Import-DataType; }
function GetEntityBagAttributeName($property)
{
$attr = $property.GetCustomAttributes([biz.dfch.CS.Appclusive.Public.Converters.EntityBagAttribute], $true);
$attr = $attr | Select -First 1;
if(!$attr)
{
return $null;
}
return $attr.Name;
}
function SetPropertyDescriptionAttribute([biz.dfch.CS.Appclusive.Core.OdataServices.Diagnostics.DataType] $dataType, $property)
{
$attr = $property.GetCustomAttributes([System.ComponentModel.DescriptionAttribute], $true);
if (!$attr)
{
return;
}
$dataType.Description = $attr.Description;
}
function SetDefaultValueAttribute([biz.dfch.CS.Appclusive.Core.OdataServices.Diagnostics.DataType] $dataType, $property)
{
$attr = $property.GetCustomAttributes([System.ComponentModel.DefaultValueAttribute], $true);
if (!$attr)
{
return;
}
$dataType.Default = $attr.Value;
}
function SetRequiredAttribute([biz.dfch.CS.Appclusive.Core.OdataServices.Diagnostics.DataType] $dataType, $property)
{
$attr = $property.GetCustomAttributes([System.ComponentModel.DataAnnotations.RequiredAttribute], $true);
$dataType.IsRequired = $false;
if (!$attr)
{
return;
}
$dataType.IsRequired = $true;
}
function SetRangeAttribute([biz.dfch.CS.Appclusive.Core.OdataServices.Diagnostics.DataType] $dataType, $property)
{
$attr = $property.GetCustomAttributes([System.ComponentModel.DataAnnotations.RangeAttribute], $true);
if (!$attr)
{
return;
}
$dataType.Minimum = $attr.Minimum;
$dataType.Maximum = $attr.Maximum;
}
function SetIncrementAttribute([biz.dfch.CS.Appclusive.Core.OdataServices.Diagnostics.DataType] $dataType, $property)
{
$attr = $property.GetCustomAttributes([biz.dfch.CS.Appclusive.Public.Configuration.IncrementAttribute], $true);
if (!$attr)
{
return;
}
$dataType.Increment = $attr.Increment;
$dataType.IncrementFunction = $attr.IncrementFunction;
}
function SetUnitAttribute([biz.dfch.CS.Appclusive.Core.OdataServices.Diagnostics.DataType] $dataType, $property)
{
$attr = $property.GetCustomAttributes([biz.dfch.CS.Appclusive.Public.Configuration.UnitAttribute], $true);
if (!$attr)
{
return;
}
$dataType.Unit = $attr.Unit;
}
function SetValidateSetAttribute([biz.dfch.CS.Appclusive.Core.OdataServices.Diagnostics.DataType] $dataType, $property)
{
$attr = $property.GetCustomAttributes([biz.dfch.CS.Appclusive.Public.Configuration.ValidateSetIfNotDefaultAttribute], $true);
if (!$attr)
{
return;
}
$dataType.ValidateSet = $attr.Set;
}
function SetValidateScriptAttribute([biz.dfch.CS.Appclusive.Core.OdataServices.Diagnostics.DataType] $dataType, $property)
{
$attr = $property.GetCustomAttributes([biz.dfch.CS.Appclusive.Public.Configuration.ValidateScriptIfNotDefaultAttribute], $true);
if (!$attr)
{
return;
}
$dataType.ValidateScript = $attr.Script;
}
function SetValidatePatternAttribute([biz.dfch.CS.Appclusive.Core.OdataServices.Diagnostics.DataType] $dataType, $property)
{
$attr = $property.GetCustomAttributes([biz.dfch.CS.Appclusive.Public.Configuration.ValidatePatternIfNotDefaultAttribute], $true);
if (!$attr)
{
return;
}
$dataType.ValidatePattern = $attr.Pattern;
}
function SetKeyNameValueFilterAttribute([biz.dfch.CS.Appclusive.Core.OdataServices.Diagnostics.DataType] $dataType, $property)
{
$attr = $property.GetCustomAttributes([biz.dfch.CS.Appclusive.Public.Configuration.KeyNameValueFilterAttribute], $true);
if (!$attr)
{
return;
}
$dataType.KeyNameValueFilter = $attr.Pattern;
}
function SetStringLengthAttribute([biz.dfch.CS.Appclusive.Core.OdataServices.Diagnostics.DataType] $dataType, $property)
{
$attr = $property.GetCustomAttributes([System.ComponentModel.DataAnnotations.StringLengthAttribute], $true);
if (!$attr)
{
return;
}
$dataType.Maximum = $attr.MaximumLength;
$dataType.Minimum = $attr.MinimumLength;
}
#
# Copyright 2015-2016 d-fens GmbH
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
|
PowerShellCorpus/PowerShellGallery/biz.dfch.PS.Appclusive.Client/5.2.1.20161201/Get-CatalogueItem.ps1
|
Get-CatalogueItem.ps1
|
function Get-CatalogueItem {
<#
.SYNOPSIS
Retrieves one or more entities from the catalogueItem entity set.
.DESCRIPTION
Retrieves one or more entities from the catalogueItem entity set.
You can retrieve one ore more entities from the entity set by specifying
Id, Name or other properties.
.INPUTS
The Cmdlet can either return all available entities or filter entities on
specified conditions.
See PARAMETERS section on possible inputs.
.OUTPUTS
default | json | json-pretty | xml | xml-pretty
.EXAMPLE
Get-CatalogueItem
CatalogueId : 15
ProductId : 14
ValidFrom : 01.01.0001 00:00:00 +00:00
ValidUntil : 01.01.2025 00:00:00 +01:00
EndOfLife : 01.01.2025 00:00:00 +01:00
Parameters :
Id : 36
Tid : 9e210b40-3b9c-466a-bc4d-9f9243933350
Name : VDI Personal
Description :
CreatedById : 1014
ModifiedById : 1014
Created : 14.02.2016 15:34:39 +01:00
Modified : 14.02.2016 15:34:39 +01:00
RowVersion : {0, 0, 0, 0...}
Catalogue :
Product :
Tenant :
CreatedBy :
ModifiedBy :
CatalogueId : 15
ProductId : 14
ValidFrom : 01.01.0001 00:00:00 +00:00
ValidUntil : 01.01.2025 00:00:00 +01:00
EndOfLife : 01.01.2025 00:00:00 +01:00
Parameters :
Id : 37
Tid : 9e210b40-3b9c-466a-bc4d-9f9243933350
Name : VDI Technical
Description :
CreatedById : 1014
ModifiedById : 1014
Created : 14.02.2016 15:35:19 +01:00
Modified : 14.02.2016 15:35:19 +01:00
RowVersion : {0, 0, 0, 0...}
Catalogue :
Product :
Tenant :
CreatedBy :
ModifiedBy :
List all available catalogue items
.EXAMPLE
Get-CatalogueItem -Id 37
CatalogueId : 15
ProductId : 14
ValidFrom : 01.01.0001 00:00:00 +00:00
ValidUntil : 01.01.2025 00:00:00 +01:00
EndOfLife : 01.01.2025 00:00:00 +01:00
Parameters :
Id : 37
Tid : 9e210b40-3b9c-466a-bc4d-9f9243933350
Name : VDI Technical
Description :
CreatedById : 1014
ModifiedById : 1014
Created : 14.02.2016 15:35:19 +01:00
Modified : 14.02.2016 15:35:19 +01:00
RowVersion : {0, 0, 0, 0...}
Catalogue :
Product :
Tenant :
CreatedBy :
ModifiedBy :
Retrieves the catalogue item with id 37
.EXAMPLE
Get-ApcProduct -SearchByName "vdi"
CatalogueId : 15
ProductId : 14
ValidFrom : 01.01.0001 00:00:00 +00:00
ValidUntil : 01.01.2025 00:00:00 +01:00
EndOfLife : 01.01.2025 00:00:00 +01:00
Parameters :
Id : 36
Tid : 9e210b40-3b9c-466a-bc4d-9f9243933350
Name : VDI Personal
Description :
CreatedById : 1014
ModifiedById : 1014
Created : 14.02.2016 15:34:39 +01:00
Modified : 14.02.2016 15:34:39 +01:00
RowVersion : {0, 0, 0, 0...}
Catalogue :
Product :
Tenant :
CreatedBy :
ModifiedBy :
CatalogueId : 15
ProductId : 14
ValidFrom : 01.01.0001 00:00:00 +00:00
ValidUntil : 01.01.2025 00:00:00 +01:00
EndOfLife : 01.01.2025 00:00:00 +01:00
Parameters :
Id : 37
Tid : 9e210b40-3b9c-466a-bc4d-9f9243933350
Name : VDI Technical
Description :
CreatedById : 1014
ModifiedById : 1014
Created : 14.02.2016 15:35:19 +01:00
Modified : 14.02.2016 15:35:19 +01:00
RowVersion : {0, 0, 0, 0...}
Catalogue :
Product :
Tenant :
CreatedBy :
ModifiedBy :
Retrieves the catalogue items which contains "vdi"
.EXAMPLE
Get-ApcProduct -CatalogueId 4
CatalogueId : 4
ProductId : 50
ValidFrom : 01.01.0001 00:00:00 +00:00
ValidUntil : 02.01.9999 00:00:00 +01:00
EndOfLife : 02.01.9999 00:00:00 +01:00
Parameters :
Id : 35
Tid : 9e210b40-3b9c-466a-bc4d-9f9243933350
Name : Managed Red Hat Enterprise Linux 6
Description : Managed Red Hat Enterprise Linux 6
CreatedById : 1014
ModifiedById : 1014
Created : 14.02.2016 11:51:25 +01:00
Modified : 14.02.2016 11:53:08 +01:00
RowVersion : {0, 0, 0, 0...}
Catalogue :
Product :
Tenant :
CreatedBy :
ModifiedBy :
CatalogueId : 4
ProductId : 53
ValidFrom : 01.01.0001 00:00:00 +00:00
ValidUntil : 31.12.9999 23:59:59 +00:00
EndOfLife : 31.12.9999 23:59:59 +00:00
Parameters :
Id : 40
Tid : 9e210b40-3b9c-466a-bc4d-9f9243933350
Name : Managed Windows Server 2008 R2
Description : Managed Windows Server 2008 R2
CreatedById : 2
ModifiedById : 2
Created : 15.02.2016 19:12:47 +01:00
Modified : 15.02.2016 19:12:47 +01:00
RowVersion : {0, 0, 0, 0...}
Catalogue :
Product :
Tenant :
CreatedBy :
ModifiedBy :
Retrieves all products which are in the catalogue with id 4
.LINK
Online Version: http://dfch.biz/biz/dfch/PS/Appclusive/Client/Get-CatalogueItem/
.NOTES
See module manifest for required software versions and dependencies.
#>
[CmdletBinding(
ConfirmImpact = 'Low'
,
HelpURI = 'http://dfch.biz/biz/dfch/PS/Appclusive/Client/Get-CatalogueItem/'
,
DefaultParameterSetName = 'list'
)]
PARAM
(
# Id of the catalogue item
[Parameter(Mandatory = $false, ParameterSetName = 'Id')]
[ValidateNotNullOrEmpty()]
[long] $Id = $null
,
# Full name or part of it, for the item you want to search - this is not case sensitive
[Parameter(Mandatory = $false, ParameterSetName = 'SearchByName')]
[ValidateNotNullOrEmpty()]
[String] $Name = $null
,
# Id of the product
[Parameter(Mandatory = $false, ParameterSetName = 'ProductId')]
[ValidateNotNullOrEmpty()]
[String] $ProductId = $null
,
# Id of the catalogue
[Parameter(Mandatory = $false, ParameterSetName = 'CatalogueId')]
[ValidateNotNullOrEmpty()]
[String] $CatalogueId = $null
,
# Lists all available products
[Parameter(Mandatory = $false, ParameterSetName = 'list')]
[Switch] $ListAvailable
,
# Service reference to Appclusive
[Parameter(Mandatory = $false)]
[Alias('Services')]
[hashtable] $svc = (Get-Variable -Name $MyInvocation.MyCommand.Module.PrivateData.MODULEVAR -ValueOnly).Services
,
# Specifies the return format of the Cmdlet
[ValidateSet('default', 'json', 'json-pretty', 'xml', 'xml-pretty')]
[Parameter(Mandatory = $false)]
[alias('ReturnFormat')]
[string] $As = 'default'
)
Begin
{
trap { Log-Exception $_; break; }
$datBegin = [datetime]::Now;
[string] $fn = $MyInvocation.MyCommand.Name;
Log-Debug -fn $fn -msg ("CALL. svc '{0}'. Name '{1}'." -f ($svc -is [Object]), $Name) -fac 1;
Contract-Requires ($svc.Core -is [biz.dfch.CS.Appclusive.Api.Core.Core]) "Connect to the server before using the Cmdlet"
$EntitySetName = 'CatalogueItems';
}
# Begin
Process
{
trap { Log-Exception $_; break; }
# Default test variable for checking function response codes.
[Boolean] $fReturn = $false;
if($PSCmdlet.ParameterSetName -eq 'list')
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$orderby','Name') | Select;
}
else
{
$Exp = @();
If ($PSCmdlet.ParameterSetName -eq 'Id')
{
$Exp += ("Id eq {0}" -f $Id);
}
If ($PSCmdlet.ParameterSetName -eq 'SearchByName')
{
$Exp += ("substringof('{0}', tolower(Name))" -f $Name.ToLower());
}
If ($PSCmdlet.ParameterSetName -eq 'ProductId')
{
$Exp += ("ProductId eq {0}" -f $ProductId);
}
If ($PSCmdlet.ParameterSetName -eq 'CatalogueId')
{
$Exp += ("CatalogueId eq {0}" -f $CatalogueId);
}
$FilterExpression = [String]::Join(' and ', $Exp);
$Response = $svc.Core.$EntitySetName.AddQueryOption('$filter', $FilterExpression) | Select;
}
# $OutputParameter = $result
$OutputParameter = Format-ResultAs $Response $As
$fReturn = $true;
}
# Process
End
{
$datEnd = [datetime]::Now;
Log-Debug -fn $fn -msg ("RET. fReturn: [{0}]. Execution time: [{1}]ms. Started: [{2}]." -f $fReturn, ($datEnd - $datBegin).TotalMilliseconds, $datBegin.ToString('yyyy-MM-dd HH:mm:ss.fffzzz')) -fac 2;
# Return values are always and only returned via OutputParameter.
return $OutputParameter;
}
# End
} # function
if($MyInvocation.ScriptName) { Export-ModuleMember -Function Get-CatalogueItem; }
#
# Copyright 2016 d-fens GmbH
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SIG # Begin signature block
# MIIXDwYJKoZIhvcNAQcCoIIXADCCFvwCAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB
# gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR
# AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQUDaVBqmmuAtkDYa5KEqgy7z3p
# aFygghHCMIIEFDCCAvygAwIBAgILBAAAAAABL07hUtcwDQYJKoZIhvcNAQEFBQAw
# VzELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNV
# BAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkdsb2JhbFNpZ24gUm9vdCBDQTAeFw0xMTA0
# MTMxMDAwMDBaFw0yODAxMjgxMjAwMDBaMFIxCzAJBgNVBAYTAkJFMRkwFwYDVQQK
# ExBHbG9iYWxTaWduIG52LXNhMSgwJgYDVQQDEx9HbG9iYWxTaWduIFRpbWVzdGFt
# cGluZyBDQSAtIEcyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAlO9l
# +LVXn6BTDTQG6wkft0cYasvwW+T/J6U00feJGr+esc0SQW5m1IGghYtkWkYvmaCN
# d7HivFzdItdqZ9C76Mp03otPDbBS5ZBb60cO8eefnAuQZT4XljBFcm05oRc2yrmg
# jBtPCBn2gTGtYRakYua0QJ7D/PuV9vu1LpWBmODvxevYAll4d/eq41JrUJEpxfz3
# zZNl0mBhIvIG+zLdFlH6Dv2KMPAXCae78wSuq5DnbN96qfTvxGInX2+ZbTh0qhGL
# 2t/HFEzphbLswn1KJo/nVrqm4M+SU4B09APsaLJgvIQgAIMboe60dAXBKY5i0Eex
# +vBTzBj5Ljv5cH60JQIDAQABo4HlMIHiMA4GA1UdDwEB/wQEAwIBBjASBgNVHRMB
# Af8ECDAGAQH/AgEAMB0GA1UdDgQWBBRG2D7/3OO+/4Pm9IWbsN1q1hSpwTBHBgNV
# HSAEQDA+MDwGBFUdIAAwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93d3cuZ2xvYmFs
# c2lnbi5jb20vcmVwb3NpdG9yeS8wMwYDVR0fBCwwKjAooCagJIYiaHR0cDovL2Ny
# bC5nbG9iYWxzaWduLm5ldC9yb290LmNybDAfBgNVHSMEGDAWgBRge2YaRQ2XyolQ
# L30EzTSo//z9SzANBgkqhkiG9w0BAQUFAAOCAQEATl5WkB5GtNlJMfO7FzkoG8IW
# 3f1B3AkFBJtvsqKa1pkuQJkAVbXqP6UgdtOGNNQXzFU6x4Lu76i6vNgGnxVQ380W
# e1I6AtcZGv2v8Hhc4EvFGN86JB7arLipWAQCBzDbsBJe/jG+8ARI9PBw+DpeVoPP
# PfsNvPTF7ZedudTbpSeE4zibi6c1hkQgpDttpGoLoYP9KOva7yj2zIhd+wo7AKvg
# IeviLzVsD440RZfroveZMzV+y5qKu0VN5z+fwtmK+mWybsd+Zf/okuEsMaL3sCc2
# SI8mbzvuTXYfecPlf5Y1vC0OzAGwjn//UYCAp5LUs0RGZIyHTxZjBzFLY7Df8zCC
# BCkwggMRoAMCAQICCwQAAAAAATGJxjfoMA0GCSqGSIb3DQEBCwUAMEwxIDAeBgNV
# BAsTF0dsb2JhbFNpZ24gUm9vdCBDQSAtIFIzMRMwEQYDVQQKEwpHbG9iYWxTaWdu
# MRMwEQYDVQQDEwpHbG9iYWxTaWduMB4XDTExMDgwMjEwMDAwMFoXDTE5MDgwMjEw
# MDAwMFowWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKPv0Z8p6djTgnY8YqDS
# SdYWHvHP8NC6SEMDLacd8gE0SaQQ6WIT9BP0FoO11VdCSIYrlViH6igEdMtyEQ9h
# JuH6HGEVxyibTQuCDyYrkDqW7aTQaymc9WGI5qRXb+70cNCNF97mZnZfdB5eDFM4
# XZD03zAtGxPReZhUGks4BPQHxCMD05LL94BdqpxWBkQtQUxItC3sNZKaxpXX9c6Q
# MeJ2s2G48XVXQqw7zivIkEnotybPuwyJy9DDo2qhydXjnFMrVyb+Vpp2/WFGomDs
# KUZH8s3ggmLGBFrn7U5AXEgGfZ1f53TJnoRlDVve3NMkHLQUEeurv8QfpLqZ0BdY
# Nc0CAwEAAaOB/TCB+jAOBgNVHQ8BAf8EBAMCAQYwEgYDVR0TAQH/BAgwBgEB/wIB
# ADAdBgNVHQ4EFgQUGUq4WuRNMaUU5V7sL6Mc+oCMMmswRwYDVR0gBEAwPjA8BgRV
# HSAAMDQwMgYIKwYBBQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3Jl
# cG9zaXRvcnkvMDYGA1UdHwQvMC0wK6ApoCeGJWh0dHA6Ly9jcmwuZ2xvYmFsc2ln
# bi5uZXQvcm9vdC1yMy5jcmwwEwYDVR0lBAwwCgYIKwYBBQUHAwMwHwYDVR0jBBgw
# FoAUj/BLf6guRSSuTVD6Y5qL3uLdG7wwDQYJKoZIhvcNAQELBQADggEBAHmwaTTi
# BYf2/tRgLC+GeTQD4LEHkwyEXPnk3GzPbrXsCly6C9BoMS4/ZL0Pgmtmd4F/ximl
# F9jwiU2DJBH2bv6d4UgKKKDieySApOzCmgDXsG1szYjVFXjPE/mIpXNNwTYr3MvO
# 23580ovvL72zT006rbtibiiTxAzL2ebK4BEClAOwvT+UKFaQHlPCJ9XJPM0aYx6C
# WRW2QMqngarDVa8z0bV16AnqRwhIIvtdG/Mseml+xddaXlYzPK1X6JMlQsPSXnE7
# ShxU7alVrCgFx8RsXdw8k/ZpPIJRzhoVPV4Bc/9Aouq0rtOO+u5dbEfHQfXUVlfy
# GDcy1tTMS/Zx4HYwggSfMIIDh6ADAgECAhIRIdaZp2SXPvH4Qn7pGcxTQRQwDQYJ
# KoZIhvcNAQEFBQAwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24g
# bnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzIw
# HhcNMTYwNTI0MDAwMDAwWhcNMjcwNjI0MDAwMDAwWjBgMQswCQYDVQQGEwJTRzEf
# MB0GA1UEChMWR01PIEdsb2JhbFNpZ24gUHRlIEx0ZDEwMC4GA1UEAxMnR2xvYmFs
# U2lnbiBUU0EgZm9yIE1TIEF1dGhlbnRpY29kZSAtIEcyMIIBIjANBgkqhkiG9w0B
# AQEFAAOCAQ8AMIIBCgKCAQEAsBeuotO2BDBWHlgPse1VpNZUy9j2czrsXV6rJf02
# pfqEw2FAxUa1WVI7QqIuXxNiEKlb5nPWkiWxfSPjBrOHOg5D8NcAiVOiETFSKG5d
# QHI88gl3p0mSl9RskKB2p/243LOd8gdgLE9YmABr0xVU4Prd/4AsXximmP/Uq+yh
# RVmyLm9iXeDZGayLV5yoJivZF6UQ0kcIGnAsM4t/aIAqtaFda92NAgIpA6p8N7u7
# KU49U5OzpvqP0liTFUy5LauAo6Ml+6/3CGSwekQPXBDXX2E3qk5r09JTJZ2Cc/os
# +XKwqRk5KlD6qdA8OsroW+/1X1H0+QrZlzXeaoXmIwRCrwIDAQABo4IBXzCCAVsw
# DgYDVR0PAQH/BAQDAgeAMEwGA1UdIARFMEMwQQYJKwYBBAGgMgEeMDQwMgYIKwYB
# BQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3JlcG9zaXRvcnkvMAkG
# A1UdEwQCMAAwFgYDVR0lAQH/BAwwCgYIKwYBBQUHAwgwQgYDVR0fBDswOTA3oDWg
# M4YxaHR0cDovL2NybC5nbG9iYWxzaWduLmNvbS9ncy9nc3RpbWVzdGFtcGluZ2cy
# LmNybDBUBggrBgEFBQcBAQRIMEYwRAYIKwYBBQUHMAKGOGh0dHA6Ly9zZWN1cmUu
# Z2xvYmFsc2lnbi5jb20vY2FjZXJ0L2dzdGltZXN0YW1waW5nZzIuY3J0MB0GA1Ud
# DgQWBBTUooRKOFoYf7pPMFC9ndV6h9YJ9zAfBgNVHSMEGDAWgBRG2D7/3OO+/4Pm
# 9IWbsN1q1hSpwTANBgkqhkiG9w0BAQUFAAOCAQEAj6kakW0EpjcgDoOW3iPTa24f
# bt1kPWghIrX4RzZpjuGlRcckoiK3KQnMVFquxrzNY46zPVBI5bTMrs2SjZ4oixNK
# Eaq9o+/Tsjb8tKFyv22XY3mMRLxwL37zvN2CU6sa9uv6HJe8tjecpBwwvKu8LUc2
# 35IgA+hxxlj2dQWaNPALWVqCRDSqgOQvhPZHXZbJtsrKnbemuuRQ09Q3uLogDtDT
# kipbxFm7oW3bPM5EncE4Kq3jjb3NCXcaEL5nCgI2ZIi5sxsm7ueeYMRGqLxhM2zP
# TrmcuWrwnzf+tT1PmtNN/94gjk6Xpv2fCbxNyhh2ybBNhVDygNIdBvVYBAexGDCC
# BNYwggO+oAMCAQICEhEhDRayW4wRltP+V8mGEea62TANBgkqhkiG9w0BAQsFADBa
# MQswCQYDVQQGEwJCRTEZMBcGA1UEChMQR2xvYmFsU2lnbiBudi1zYTEwMC4GA1UE
# AxMnR2xvYmFsU2lnbiBDb2RlU2lnbmluZyBDQSAtIFNIQTI1NiAtIEcyMB4XDTE1
# MDUwNDE2NDMyMVoXDTE4MDUwNDE2NDMyMVowVTELMAkGA1UEBhMCQ0gxDDAKBgNV
# BAgTA1p1ZzEMMAoGA1UEBxMDWnVnMRQwEgYDVQQKEwtkLWZlbnMgR21iSDEUMBIG
# A1UEAxMLZC1mZW5zIEdtYkgwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB
# AQDNPSzSNPylU9jFM78Q/GjzB7N+VNqikf/use7p8mpnBZ4cf5b4qV3rqQd62rJH
# RlAsxgouCSNQrl8xxfg6/t/I02kPvrzsR4xnDgMiVCqVRAeQsWebafWdTvWmONBS
# lxJejPP8TSgXMKFaDa+2HleTycTBYSoErAZSWpQ0NqF9zBadjsJRVatQuPkTDrwL
# eWibiyOipK9fcNoQpl5ll5H9EG668YJR3fqX9o0TQTkOmxXIL3IJ0UxdpyDpLEkt
# tBG6Y5wAdpF2dQX2phrfFNVY54JOGtuBkNGMSiLFzTkBA1fOlA6ICMYjB8xIFxVv
# rN1tYojCrqYkKMOjwWQz5X8zAgMBAAGjggGZMIIBlTAOBgNVHQ8BAf8EBAMCB4Aw
# TAYDVR0gBEUwQzBBBgkrBgEEAaAyATIwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93
# d3cuZ2xvYmFsc2lnbi5jb20vcmVwb3NpdG9yeS8wCQYDVR0TBAIwADATBgNVHSUE
# DDAKBggrBgEFBQcDAzBCBgNVHR8EOzA5MDegNaAzhjFodHRwOi8vY3JsLmdsb2Jh
# bHNpZ24uY29tL2dzL2dzY29kZXNpZ25zaGEyZzIuY3JsMIGQBggrBgEFBQcBAQSB
# gzCBgDBEBggrBgEFBQcwAoY4aHR0cDovL3NlY3VyZS5nbG9iYWxzaWduLmNvbS9j
# YWNlcnQvZ3Njb2Rlc2lnbnNoYTJnMi5jcnQwOAYIKwYBBQUHMAGGLGh0dHA6Ly9v
# Y3NwMi5nbG9iYWxzaWduLmNvbS9nc2NvZGVzaWduc2hhMmcyMB0GA1UdDgQWBBTN
# GDddiIYZy9p3Z84iSIMd27rtUDAfBgNVHSMEGDAWgBQZSrha5E0xpRTlXuwvoxz6
# gIwyazANBgkqhkiG9w0BAQsFAAOCAQEAAApsOzSX1alF00fTeijB/aIthO3UB0ks
# 1Gg3xoKQC1iEQmFG/qlFLiufs52kRPN7L0a7ClNH3iQpaH5IEaUENT9cNEXdKTBG
# 8OrJS8lrDJXImgNEgtSwz0B40h7bM2Z+0DvXDvpmfyM2NwHF/nNVj7NzmczrLRqN
# 9de3tV0pgRqnIYordVcmb24CZl3bzpwzbQQy14Iz+P5Z2cnw+QaYzAuweTZxEUcJ
# bFwpM49c1LMPFJTuOKkUgY90JJ3gVTpyQxfkc7DNBnx74PlRzjFmeGC/hxQt0hvo
# eaAiBdjo/1uuCTToigVnyRH+c0T2AezTeoFb7ne3I538hWeTdU5q9jGCBLcwggSz
# AgEBMHAwWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MgISESENFrJbjBGW0/5XyYYR5rrZMAkGBSsOAwIaBQCgeDAYBgorBgEEAYI3AgEM
# MQowCKACgAChAoAAMBkGCSqGSIb3DQEJAzEMBgorBgEEAYI3AgEEMBwGCisGAQQB
# gjcCAQsxDjAMBgorBgEEAYI3AgEVMCMGCSqGSIb3DQEJBDEWBBQMqyKjrsnY1gWt
# k7qdZZPOcY0QDzANBgkqhkiG9w0BAQEFAASCAQC5UvSsbEkWstesIixiW1/onYTF
# OyQnaueVPLOIy/VgDLBp7m5VTgjsM1D/vbXcqHjOi0rtwp0oNr9Dr7LornoYyU55
# GWg9Qh05GgVUFwaf1wXUg1TjZnafF0p/USgvu43M61w4ncCa2YVJQHBa9ZkKDShN
# KxYy/o8GK/rtvxvS7aM7msPZfAwor+kkxHFiKM27xOkb2Nr/LVNME3Y9gQLGFq5L
# Nhh2ObW0A4QJOJTCna4lPMNUZrpAZjNNdw1zdu6G4aF8QH4GV/D98a2x/Dofph3y
# Vjqk42TqaTv1iMDg5vC7BLjuAnpGU7z2GhYR+PoFY3LNhbkItutiipWHZpqvoYIC
# ojCCAp4GCSqGSIb3DQEJBjGCAo8wggKLAgEBMGgwUjELMAkGA1UEBhMCQkUxGTAX
# BgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGlt
# ZXN0YW1waW5nIENBIC0gRzICEhEh1pmnZJc+8fhCfukZzFNBFDAJBgUrDgMCGgUA
# oIH9MBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTE2
# MDgzMTE5MTYzOVowIwYJKoZIhvcNAQkEMRYEFPtXMKACRkZW8EXEXAZmP/Rbilz2
# MIGdBgsqhkiG9w0BCRACDDGBjTCBijCBhzCBhAQUY7gvq2H1g5CWlQULACScUCkz
# 7HkwbDBWpFQwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYt
# c2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzICEhEh
# 1pmnZJc+8fhCfukZzFNBFDANBgkqhkiG9w0BAQEFAASCAQBaz2JFy3IPWVIPrgZ4
# ZXEZqtYZhFky9cxs14xiAO5yFKaHPvw2KJZlHMKGHAGFKd9iPf8BT0W/J5664Ce8
# tmh9H51zYLdAntvAHVhTjolLzHVecKozA80ZUv4tIt+iOrNZ4AIF53+nmA1SiKU1
# 06N0Q5BNdK08dZGSrxaM0LrXLXjOaIl8SdEldxl7FyX1DVHRiJdLuhLAkxE1eP0a
# 6j5MZH6zRLfv/AMfMrxPavTSmLfGkvryPgKsz3IPnXsUatdMC2s5U1Z3gGOG1RH4
# LhXgOUWarIRTMkco7UJN3o+cmrSoqID78J0yEnP9my1CbvOmipe8Xt9cTAxcMkaZ
# P4JU
# SIG # End signature block
|
PowerShellCorpus/PowerShellGallery/biz.dfch.PS.Appclusive.Client/5.2.1.20161201/Invoke-NodeAction.ps1
|
Invoke-NodeAction.ps1
|
function Invoke-NodeAction {
<#
.SYNOPSIS
Invokes a Node entity action in Appclusive.
.DESCRIPTION
Invokes a Node entity action in Appclusive.
You must specify parameter 'Id' or pipe on an existing Node entity and the input action name.
.EXAMPLE
Invoke-NodeAction -Node 12 -InputName Installed -InputParameters @{'Computername'='Server01'}
Name Id InputParameters
---- -- ---------------
Nodes 12 {Name, Parameters}
Updates a Node entry to Status 'Installed'.
.EXAMPLE
Get-Node -First 3 | Invoke-NodeAction -InputName Installed -InputParameters @{'Operation'='Bulk'}
Name Id InputParameters
---- -- ---------------
Srv01 12 {Name, Parameters}
Updates the 3 first Nodes to Status 'Installed'.
.LINK
Online Version: http://dfch.biz/biz/dfch/PS/Appclusive/Client/Invoke-NodeAction/
.NOTES
See module manifest for dependencies and further requirements.
#>
[CmdletBinding(
SupportsShouldProcess = $true
,
ConfirmImpact = 'Low'
,
HelpURI = 'http://dfch.biz/biz/dfch/PS/Appclusive/Client/Invoke-NodeAction/'
)]
PARAM
(
# Specifies an reference object of the entity
[Parameter(Mandatory = $false, ValueFromPipeline = $true, Position = 0, ParameterSetName = 'pipe')]
[biz.dfch.CS.Appclusive.Api.Core.Node] $InputObject
,
# Specifies the id of the entity
[Parameter(Mandatory = $false, Position = 0, ParameterSetName = 'id')]
[Alias('NodeId')]
[long] $EntityId
,
# Specifies the name of the entity action
[Parameter(Mandatory = $true, Position = 1)]
[string] $InputName
,
# Specifies the parameters of the entity action
[Parameter(Mandatory = $false, Position = 2)]
[hashtable] $InputParameters = @{}
,
# Service reference to Appclusive
[Parameter(Mandatory = $false, Position = 3)]
[Alias('Services')]
[hashtable] $svc = (Get-Variable -Name $MyInvocation.MyCommand.Module.PrivateData.MODULEVAR -ValueOnly).Services
,
# Specifies the return format of the Cnmdlet
[ValidateSet('default', 'json', 'json-pretty', 'xml', 'xml-pretty')]
[Parameter(Mandatory = $false, Position = 4)]
[alias('ReturnFormat')]
[string] $As = 'default'
)
Begin
{
trap { Log-Exception $_; break; }
$datBegin = [datetime]::Now;
[string] $fn = $MyInvocation.MyCommand.Name;
Log-Debug -fn $fn -msg ("CALL. svc '{0}'. Name '{1}'." -f ($svc -is [Object]), $Name) -fac 1;
$EntitySetName = 'Nodes';
[string] $EntityActionName = 'InvokeAction';
# Parameter validation
Contract-Requires ($svc.Core -is [biz.dfch.CS.Appclusive.Api.Core.Core]) "Connect to the server before using the Cmdlet"
}
# Begin
Process
{
trap { Log-Exception $_; break; }
# Default test variable for checking function response codes.
[Boolean] $fReturn = $false;
# Return values are always and only returned via OutputParameter.
$OutputParameter = $null;
# Parameter validation
Contract-Assert ($PSCmdlet.ShouldProcess(($PSBoundParameters | Out-String)))
[hashtable] $EntityActionInputParameters =
@{
'Name' = $InputName
;
'Parameters' = ($InputParameters | ConvertTo-Json -Compress).ToString()
};
$r = @();
if($PSCmdlet.ParameterSetName -eq 'pipe')
{
# Get ValueFromPipeline
foreach($Object in $InputObject)
{
if($PSCmdlet.ShouldProcess($Object))
{
$r += ($Object | Select -Property Name, Id, @{Name="InputName"; Expression={$InputName}});
$svc.Core.InvokeEntityActionWithVoidResult($Object, $EntityActionName, $EntityActionInputParameters);
}
}
}
else
{
$r += ($EntityId | Select -Property @{Name="Id"; Expression={$_}}, @{Name="InputName"; Expression={$InputName}});
$svc.Core.InvokeEntityActionWithVoidResult($EntitySetName, [long]$EntityId, $EntityActionName, $EntityActionInputParameters);
}
$OutputParameter = Format-ResultAs $r $As;
$fReturn = $true;
}
# Process
End
{
$datEnd = [datetime]::Now;
Log-Debug -fn $fn -msg ("RET. fReturn: [{0}]. Execution time: [{1}]ms. Started: [{2}]." -f $fReturn, ($datEnd - $datBegin).TotalMilliseconds, $datBegin.ToString('yyyy-MM-dd HH:mm:ss.fffzzz')) -fac 2;
# Return values are always and only returned via OutputParameter.
return $OutputParameter;
}
# End
} # function
if($MyInvocation.ScriptName) { Export-ModuleMember -Function Invoke-NodeAction; }
#
# Copyright 2014-2015 d-fens GmbH
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SIG # Begin signature block
# MIIXDwYJKoZIhvcNAQcCoIIXADCCFvwCAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB
# gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR
# AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQUV99QM3T6LuEojuHQiOPVVFv4
# DU+gghHCMIIEFDCCAvygAwIBAgILBAAAAAABL07hUtcwDQYJKoZIhvcNAQEFBQAw
# VzELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNV
# BAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkdsb2JhbFNpZ24gUm9vdCBDQTAeFw0xMTA0
# MTMxMDAwMDBaFw0yODAxMjgxMjAwMDBaMFIxCzAJBgNVBAYTAkJFMRkwFwYDVQQK
# ExBHbG9iYWxTaWduIG52LXNhMSgwJgYDVQQDEx9HbG9iYWxTaWduIFRpbWVzdGFt
# cGluZyBDQSAtIEcyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAlO9l
# +LVXn6BTDTQG6wkft0cYasvwW+T/J6U00feJGr+esc0SQW5m1IGghYtkWkYvmaCN
# d7HivFzdItdqZ9C76Mp03otPDbBS5ZBb60cO8eefnAuQZT4XljBFcm05oRc2yrmg
# jBtPCBn2gTGtYRakYua0QJ7D/PuV9vu1LpWBmODvxevYAll4d/eq41JrUJEpxfz3
# zZNl0mBhIvIG+zLdFlH6Dv2KMPAXCae78wSuq5DnbN96qfTvxGInX2+ZbTh0qhGL
# 2t/HFEzphbLswn1KJo/nVrqm4M+SU4B09APsaLJgvIQgAIMboe60dAXBKY5i0Eex
# +vBTzBj5Ljv5cH60JQIDAQABo4HlMIHiMA4GA1UdDwEB/wQEAwIBBjASBgNVHRMB
# Af8ECDAGAQH/AgEAMB0GA1UdDgQWBBRG2D7/3OO+/4Pm9IWbsN1q1hSpwTBHBgNV
# HSAEQDA+MDwGBFUdIAAwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93d3cuZ2xvYmFs
# c2lnbi5jb20vcmVwb3NpdG9yeS8wMwYDVR0fBCwwKjAooCagJIYiaHR0cDovL2Ny
# bC5nbG9iYWxzaWduLm5ldC9yb290LmNybDAfBgNVHSMEGDAWgBRge2YaRQ2XyolQ
# L30EzTSo//z9SzANBgkqhkiG9w0BAQUFAAOCAQEATl5WkB5GtNlJMfO7FzkoG8IW
# 3f1B3AkFBJtvsqKa1pkuQJkAVbXqP6UgdtOGNNQXzFU6x4Lu76i6vNgGnxVQ380W
# e1I6AtcZGv2v8Hhc4EvFGN86JB7arLipWAQCBzDbsBJe/jG+8ARI9PBw+DpeVoPP
# PfsNvPTF7ZedudTbpSeE4zibi6c1hkQgpDttpGoLoYP9KOva7yj2zIhd+wo7AKvg
# IeviLzVsD440RZfroveZMzV+y5qKu0VN5z+fwtmK+mWybsd+Zf/okuEsMaL3sCc2
# SI8mbzvuTXYfecPlf5Y1vC0OzAGwjn//UYCAp5LUs0RGZIyHTxZjBzFLY7Df8zCC
# BCkwggMRoAMCAQICCwQAAAAAATGJxjfoMA0GCSqGSIb3DQEBCwUAMEwxIDAeBgNV
# BAsTF0dsb2JhbFNpZ24gUm9vdCBDQSAtIFIzMRMwEQYDVQQKEwpHbG9iYWxTaWdu
# MRMwEQYDVQQDEwpHbG9iYWxTaWduMB4XDTExMDgwMjEwMDAwMFoXDTE5MDgwMjEw
# MDAwMFowWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKPv0Z8p6djTgnY8YqDS
# SdYWHvHP8NC6SEMDLacd8gE0SaQQ6WIT9BP0FoO11VdCSIYrlViH6igEdMtyEQ9h
# JuH6HGEVxyibTQuCDyYrkDqW7aTQaymc9WGI5qRXb+70cNCNF97mZnZfdB5eDFM4
# XZD03zAtGxPReZhUGks4BPQHxCMD05LL94BdqpxWBkQtQUxItC3sNZKaxpXX9c6Q
# MeJ2s2G48XVXQqw7zivIkEnotybPuwyJy9DDo2qhydXjnFMrVyb+Vpp2/WFGomDs
# KUZH8s3ggmLGBFrn7U5AXEgGfZ1f53TJnoRlDVve3NMkHLQUEeurv8QfpLqZ0BdY
# Nc0CAwEAAaOB/TCB+jAOBgNVHQ8BAf8EBAMCAQYwEgYDVR0TAQH/BAgwBgEB/wIB
# ADAdBgNVHQ4EFgQUGUq4WuRNMaUU5V7sL6Mc+oCMMmswRwYDVR0gBEAwPjA8BgRV
# HSAAMDQwMgYIKwYBBQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3Jl
# cG9zaXRvcnkvMDYGA1UdHwQvMC0wK6ApoCeGJWh0dHA6Ly9jcmwuZ2xvYmFsc2ln
# bi5uZXQvcm9vdC1yMy5jcmwwEwYDVR0lBAwwCgYIKwYBBQUHAwMwHwYDVR0jBBgw
# FoAUj/BLf6guRSSuTVD6Y5qL3uLdG7wwDQYJKoZIhvcNAQELBQADggEBAHmwaTTi
# BYf2/tRgLC+GeTQD4LEHkwyEXPnk3GzPbrXsCly6C9BoMS4/ZL0Pgmtmd4F/ximl
# F9jwiU2DJBH2bv6d4UgKKKDieySApOzCmgDXsG1szYjVFXjPE/mIpXNNwTYr3MvO
# 23580ovvL72zT006rbtibiiTxAzL2ebK4BEClAOwvT+UKFaQHlPCJ9XJPM0aYx6C
# WRW2QMqngarDVa8z0bV16AnqRwhIIvtdG/Mseml+xddaXlYzPK1X6JMlQsPSXnE7
# ShxU7alVrCgFx8RsXdw8k/ZpPIJRzhoVPV4Bc/9Aouq0rtOO+u5dbEfHQfXUVlfy
# GDcy1tTMS/Zx4HYwggSfMIIDh6ADAgECAhIRIdaZp2SXPvH4Qn7pGcxTQRQwDQYJ
# KoZIhvcNAQEFBQAwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24g
# bnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzIw
# HhcNMTYwNTI0MDAwMDAwWhcNMjcwNjI0MDAwMDAwWjBgMQswCQYDVQQGEwJTRzEf
# MB0GA1UEChMWR01PIEdsb2JhbFNpZ24gUHRlIEx0ZDEwMC4GA1UEAxMnR2xvYmFs
# U2lnbiBUU0EgZm9yIE1TIEF1dGhlbnRpY29kZSAtIEcyMIIBIjANBgkqhkiG9w0B
# AQEFAAOCAQ8AMIIBCgKCAQEAsBeuotO2BDBWHlgPse1VpNZUy9j2czrsXV6rJf02
# pfqEw2FAxUa1WVI7QqIuXxNiEKlb5nPWkiWxfSPjBrOHOg5D8NcAiVOiETFSKG5d
# QHI88gl3p0mSl9RskKB2p/243LOd8gdgLE9YmABr0xVU4Prd/4AsXximmP/Uq+yh
# RVmyLm9iXeDZGayLV5yoJivZF6UQ0kcIGnAsM4t/aIAqtaFda92NAgIpA6p8N7u7
# KU49U5OzpvqP0liTFUy5LauAo6Ml+6/3CGSwekQPXBDXX2E3qk5r09JTJZ2Cc/os
# +XKwqRk5KlD6qdA8OsroW+/1X1H0+QrZlzXeaoXmIwRCrwIDAQABo4IBXzCCAVsw
# DgYDVR0PAQH/BAQDAgeAMEwGA1UdIARFMEMwQQYJKwYBBAGgMgEeMDQwMgYIKwYB
# BQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3JlcG9zaXRvcnkvMAkG
# A1UdEwQCMAAwFgYDVR0lAQH/BAwwCgYIKwYBBQUHAwgwQgYDVR0fBDswOTA3oDWg
# M4YxaHR0cDovL2NybC5nbG9iYWxzaWduLmNvbS9ncy9nc3RpbWVzdGFtcGluZ2cy
# LmNybDBUBggrBgEFBQcBAQRIMEYwRAYIKwYBBQUHMAKGOGh0dHA6Ly9zZWN1cmUu
# Z2xvYmFsc2lnbi5jb20vY2FjZXJ0L2dzdGltZXN0YW1waW5nZzIuY3J0MB0GA1Ud
# DgQWBBTUooRKOFoYf7pPMFC9ndV6h9YJ9zAfBgNVHSMEGDAWgBRG2D7/3OO+/4Pm
# 9IWbsN1q1hSpwTANBgkqhkiG9w0BAQUFAAOCAQEAj6kakW0EpjcgDoOW3iPTa24f
# bt1kPWghIrX4RzZpjuGlRcckoiK3KQnMVFquxrzNY46zPVBI5bTMrs2SjZ4oixNK
# Eaq9o+/Tsjb8tKFyv22XY3mMRLxwL37zvN2CU6sa9uv6HJe8tjecpBwwvKu8LUc2
# 35IgA+hxxlj2dQWaNPALWVqCRDSqgOQvhPZHXZbJtsrKnbemuuRQ09Q3uLogDtDT
# kipbxFm7oW3bPM5EncE4Kq3jjb3NCXcaEL5nCgI2ZIi5sxsm7ueeYMRGqLxhM2zP
# TrmcuWrwnzf+tT1PmtNN/94gjk6Xpv2fCbxNyhh2ybBNhVDygNIdBvVYBAexGDCC
# BNYwggO+oAMCAQICEhEhDRayW4wRltP+V8mGEea62TANBgkqhkiG9w0BAQsFADBa
# MQswCQYDVQQGEwJCRTEZMBcGA1UEChMQR2xvYmFsU2lnbiBudi1zYTEwMC4GA1UE
# AxMnR2xvYmFsU2lnbiBDb2RlU2lnbmluZyBDQSAtIFNIQTI1NiAtIEcyMB4XDTE1
# MDUwNDE2NDMyMVoXDTE4MDUwNDE2NDMyMVowVTELMAkGA1UEBhMCQ0gxDDAKBgNV
# BAgTA1p1ZzEMMAoGA1UEBxMDWnVnMRQwEgYDVQQKEwtkLWZlbnMgR21iSDEUMBIG
# A1UEAxMLZC1mZW5zIEdtYkgwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB
# AQDNPSzSNPylU9jFM78Q/GjzB7N+VNqikf/use7p8mpnBZ4cf5b4qV3rqQd62rJH
# RlAsxgouCSNQrl8xxfg6/t/I02kPvrzsR4xnDgMiVCqVRAeQsWebafWdTvWmONBS
# lxJejPP8TSgXMKFaDa+2HleTycTBYSoErAZSWpQ0NqF9zBadjsJRVatQuPkTDrwL
# eWibiyOipK9fcNoQpl5ll5H9EG668YJR3fqX9o0TQTkOmxXIL3IJ0UxdpyDpLEkt
# tBG6Y5wAdpF2dQX2phrfFNVY54JOGtuBkNGMSiLFzTkBA1fOlA6ICMYjB8xIFxVv
# rN1tYojCrqYkKMOjwWQz5X8zAgMBAAGjggGZMIIBlTAOBgNVHQ8BAf8EBAMCB4Aw
# TAYDVR0gBEUwQzBBBgkrBgEEAaAyATIwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93
# d3cuZ2xvYmFsc2lnbi5jb20vcmVwb3NpdG9yeS8wCQYDVR0TBAIwADATBgNVHSUE
# DDAKBggrBgEFBQcDAzBCBgNVHR8EOzA5MDegNaAzhjFodHRwOi8vY3JsLmdsb2Jh
# bHNpZ24uY29tL2dzL2dzY29kZXNpZ25zaGEyZzIuY3JsMIGQBggrBgEFBQcBAQSB
# gzCBgDBEBggrBgEFBQcwAoY4aHR0cDovL3NlY3VyZS5nbG9iYWxzaWduLmNvbS9j
# YWNlcnQvZ3Njb2Rlc2lnbnNoYTJnMi5jcnQwOAYIKwYBBQUHMAGGLGh0dHA6Ly9v
# Y3NwMi5nbG9iYWxzaWduLmNvbS9nc2NvZGVzaWduc2hhMmcyMB0GA1UdDgQWBBTN
# GDddiIYZy9p3Z84iSIMd27rtUDAfBgNVHSMEGDAWgBQZSrha5E0xpRTlXuwvoxz6
# gIwyazANBgkqhkiG9w0BAQsFAAOCAQEAAApsOzSX1alF00fTeijB/aIthO3UB0ks
# 1Gg3xoKQC1iEQmFG/qlFLiufs52kRPN7L0a7ClNH3iQpaH5IEaUENT9cNEXdKTBG
# 8OrJS8lrDJXImgNEgtSwz0B40h7bM2Z+0DvXDvpmfyM2NwHF/nNVj7NzmczrLRqN
# 9de3tV0pgRqnIYordVcmb24CZl3bzpwzbQQy14Iz+P5Z2cnw+QaYzAuweTZxEUcJ
# bFwpM49c1LMPFJTuOKkUgY90JJ3gVTpyQxfkc7DNBnx74PlRzjFmeGC/hxQt0hvo
# eaAiBdjo/1uuCTToigVnyRH+c0T2AezTeoFb7ne3I538hWeTdU5q9jGCBLcwggSz
# AgEBMHAwWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MgISESENFrJbjBGW0/5XyYYR5rrZMAkGBSsOAwIaBQCgeDAYBgorBgEEAYI3AgEM
# MQowCKACgAChAoAAMBkGCSqGSIb3DQEJAzEMBgorBgEEAYI3AgEEMBwGCisGAQQB
# gjcCAQsxDjAMBgorBgEEAYI3AgEVMCMGCSqGSIb3DQEJBDEWBBRtsn/3RH1rY9t4
# vSaHNoO/Ta18CDANBgkqhkiG9w0BAQEFAASCAQATnWQUwH9SWg9bqMwBOtqg6th6
# oqTCacg3EDpVCRZvBc48iq40DzrBFLq2xSimNMtaddkgttjP8lU0zO8v0EHWJi/t
# 4E+e8WmmTMbmAdIZ/Ns5v5lWAPBOj2RHrcv0JRK018kQW3UqupEOP0TgAKBnpnPw
# y5Fl+tKFDpZJKk4PSNGZUFHWsURfBx8bIGYIXHs5dhftfiRL1nTgJR7Y+s9V/yby
# v5lhnaeyFbXaCCMTxAYOgz4X9JtV3devCai0ZPuHlQccc/K2x51dIi2u5CIp454h
# Oz8kpzwCbQqA6RAM1cByLZQ24SVnSWuhG9W+Sl+41fqA5/YBhZVNB1bbJ/yNoYIC
# ojCCAp4GCSqGSIb3DQEJBjGCAo8wggKLAgEBMGgwUjELMAkGA1UEBhMCQkUxGTAX
# BgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGlt
# ZXN0YW1waW5nIENBIC0gRzICEhEh1pmnZJc+8fhCfukZzFNBFDAJBgUrDgMCGgUA
# oIH9MBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTE2
# MDgzMTE5MTY1MVowIwYJKoZIhvcNAQkEMRYEFL0y+7JhOJnUktLokfI0DWsqySwb
# MIGdBgsqhkiG9w0BCRACDDGBjTCBijCBhzCBhAQUY7gvq2H1g5CWlQULACScUCkz
# 7HkwbDBWpFQwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYt
# c2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzICEhEh
# 1pmnZJc+8fhCfukZzFNBFDANBgkqhkiG9w0BAQEFAASCAQCRe5KJsEQHGA0ShFky
# 5H5TdEoaLMR/2tbhbUsb3mDMON8YBFQpSvMOt330GbxfOrcPiLpU/s1oVrK0jBbY
# tV8FffxOO5LawdndvFgw2JMaxCSnoJLqNlikbw2QE3twvLtT08J/QmNH69ep6Wup
# y9OQNRZ2ZoSvjRL6o8/Fm9DHFhyd3WaS5BiNVWzbST8BIy9JUcF9+WiQr9LrSeA4
# qWzIkOkmK3p57zzAUE7JQaLCWE1/izcZThtGK5SUy3Rd1N9hh21e0ViSci6290+g
# fuZPIJ8lAQ5A81DNPv+Xdhg7iHncl4O08Aas1BHgT+8xFDp6NSuaMDKqtmGPbGjL
# tisn
# SIG # End signature block
|
PowerShellCorpus/PowerShellGallery/biz.dfch.PS.Appclusive.Client/5.2.1.20161201/Remove-Interface.ps1
|
Remove-Interface.ps1
|
function Remove-Interface {
<#
.SYNOPSIS
Removes a Interface.
.DESCRIPTION
Removes a Interface.
The Cmdlet lets you remove an existing entry from the Interface.
.EXAMPLE
Remove-Interface -Id interfaceId -Confirm
Removes the Interface with explicit confirmation.
#>
[CmdletBinding(
ConfirmImpact = 'High'
,
HelpURI = 'http://dfch.biz/biz/dfch/PS/Appclusive/Client/Remove-Interface/'
)]
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseShouldProcessForStateChangingFunctions", "")]
Param
(
# The key name portion of the KNV to remove
[Parameter(Mandatory = $false, Position = 0, ParameterSetName = 'Id')]
[string] $Id
,
# The name name portion of the KNV to remove
[Parameter(Mandatory = $false, Position = 1, ParameterSetName = 'Name')]
[string] $Name
,
# Service reference to Appclusive
[Parameter(Mandatory = $false)]
[Alias('Services')]
[hashtable] $svc = (Get-Variable -Name $MyInvocation.MyCommand.Module.PrivateData.MODULEVAR -ValueOnly).Services
,
# Specifies the return format of the Cnmdlet
[ValidateSet('default', 'json', 'json-pretty', 'xml', 'xml-pretty')]
[Parameter(Mandatory = $false)]
[alias('ReturnFormat')]
[string] $As = 'default'
)
Begin
{
trap { Log-Exception $_; break; }
$entitySetName = "Interfaces";
$datBegin = [datetime]::Now;
[string] $fn = $MyInvocation.MyCommand.Name;
Log-Debug -fn $fn -msg ("CALL. svc '{0}'. Name '{1}'." -f ($svc -is [Object]), $Name) -fac 1;
# Parameter validation
Contract-Requires ($svc.Core -is [biz.dfch.CS.Appclusive.Api.Core.Core]) "Connect to the server before using the Cmdlet"
}
# Begin
Process
{
trap { Log-Exception $_; break; }
# Default test variable for checking function response codes.
[Boolean] $fReturn = $false;
# Return values are always and only returned via OutputParameter.
$OutputParameter = $null;
$Exp = @();
if($Id)
{
$Exp += ("(Id eq {0})" -f $Id);
}
if($Name)
{
$Exp += ("(tolower(Name) eq '{0}')" -f $Name.ToLower());
}
$FilterExpression = [String]::Join(' and ', $Exp);
$interface = $svc.Core.$entitySetName.AddQueryOption('$filter',$FilterExpression).AddQueryOption('$top', 1);
Remove-Entity -svc $svc -Id $interface.Id -EntitySetName $entitySetName -Confirm:$false;
$OutputParameter = Format-ResultAs $r $As
$fReturn = $true;
}
# Process
End
{
$datEnd = [datetime]::Now;
Log-Debug -fn $fn -msg ("RET. fReturn: [{0}]. Execution time: [{1}]ms. Started: [{2}]." -f $fReturn, ($datEnd - $datBegin).TotalMilliseconds, $datBegin.ToString('yyyy-MM-dd HH:mm:ss.fffzzz')) -fac 2;
# Return values are always and only returned via OutputParameter.
return $OutputParameter;
}
# End
}
if($MyInvocation.ScriptName) { Export-ModuleMember -Function Remove-Interface; }
#
# Copyright 2016 d-fens GmbH
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SIG # Begin signature block
# MIIXDwYJKoZIhvcNAQcCoIIXADCCFvwCAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB
# gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR
# AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQUwQsbvbAE4N+ND9brBJINBPMu
# qP2gghHCMIIEFDCCAvygAwIBAgILBAAAAAABL07hUtcwDQYJKoZIhvcNAQEFBQAw
# VzELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNV
# BAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkdsb2JhbFNpZ24gUm9vdCBDQTAeFw0xMTA0
# MTMxMDAwMDBaFw0yODAxMjgxMjAwMDBaMFIxCzAJBgNVBAYTAkJFMRkwFwYDVQQK
# ExBHbG9iYWxTaWduIG52LXNhMSgwJgYDVQQDEx9HbG9iYWxTaWduIFRpbWVzdGFt
# cGluZyBDQSAtIEcyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAlO9l
# +LVXn6BTDTQG6wkft0cYasvwW+T/J6U00feJGr+esc0SQW5m1IGghYtkWkYvmaCN
# d7HivFzdItdqZ9C76Mp03otPDbBS5ZBb60cO8eefnAuQZT4XljBFcm05oRc2yrmg
# jBtPCBn2gTGtYRakYua0QJ7D/PuV9vu1LpWBmODvxevYAll4d/eq41JrUJEpxfz3
# zZNl0mBhIvIG+zLdFlH6Dv2KMPAXCae78wSuq5DnbN96qfTvxGInX2+ZbTh0qhGL
# 2t/HFEzphbLswn1KJo/nVrqm4M+SU4B09APsaLJgvIQgAIMboe60dAXBKY5i0Eex
# +vBTzBj5Ljv5cH60JQIDAQABo4HlMIHiMA4GA1UdDwEB/wQEAwIBBjASBgNVHRMB
# Af8ECDAGAQH/AgEAMB0GA1UdDgQWBBRG2D7/3OO+/4Pm9IWbsN1q1hSpwTBHBgNV
# HSAEQDA+MDwGBFUdIAAwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93d3cuZ2xvYmFs
# c2lnbi5jb20vcmVwb3NpdG9yeS8wMwYDVR0fBCwwKjAooCagJIYiaHR0cDovL2Ny
# bC5nbG9iYWxzaWduLm5ldC9yb290LmNybDAfBgNVHSMEGDAWgBRge2YaRQ2XyolQ
# L30EzTSo//z9SzANBgkqhkiG9w0BAQUFAAOCAQEATl5WkB5GtNlJMfO7FzkoG8IW
# 3f1B3AkFBJtvsqKa1pkuQJkAVbXqP6UgdtOGNNQXzFU6x4Lu76i6vNgGnxVQ380W
# e1I6AtcZGv2v8Hhc4EvFGN86JB7arLipWAQCBzDbsBJe/jG+8ARI9PBw+DpeVoPP
# PfsNvPTF7ZedudTbpSeE4zibi6c1hkQgpDttpGoLoYP9KOva7yj2zIhd+wo7AKvg
# IeviLzVsD440RZfroveZMzV+y5qKu0VN5z+fwtmK+mWybsd+Zf/okuEsMaL3sCc2
# SI8mbzvuTXYfecPlf5Y1vC0OzAGwjn//UYCAp5LUs0RGZIyHTxZjBzFLY7Df8zCC
# BCkwggMRoAMCAQICCwQAAAAAATGJxjfoMA0GCSqGSIb3DQEBCwUAMEwxIDAeBgNV
# BAsTF0dsb2JhbFNpZ24gUm9vdCBDQSAtIFIzMRMwEQYDVQQKEwpHbG9iYWxTaWdu
# MRMwEQYDVQQDEwpHbG9iYWxTaWduMB4XDTExMDgwMjEwMDAwMFoXDTE5MDgwMjEw
# MDAwMFowWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKPv0Z8p6djTgnY8YqDS
# SdYWHvHP8NC6SEMDLacd8gE0SaQQ6WIT9BP0FoO11VdCSIYrlViH6igEdMtyEQ9h
# JuH6HGEVxyibTQuCDyYrkDqW7aTQaymc9WGI5qRXb+70cNCNF97mZnZfdB5eDFM4
# XZD03zAtGxPReZhUGks4BPQHxCMD05LL94BdqpxWBkQtQUxItC3sNZKaxpXX9c6Q
# MeJ2s2G48XVXQqw7zivIkEnotybPuwyJy9DDo2qhydXjnFMrVyb+Vpp2/WFGomDs
# KUZH8s3ggmLGBFrn7U5AXEgGfZ1f53TJnoRlDVve3NMkHLQUEeurv8QfpLqZ0BdY
# Nc0CAwEAAaOB/TCB+jAOBgNVHQ8BAf8EBAMCAQYwEgYDVR0TAQH/BAgwBgEB/wIB
# ADAdBgNVHQ4EFgQUGUq4WuRNMaUU5V7sL6Mc+oCMMmswRwYDVR0gBEAwPjA8BgRV
# HSAAMDQwMgYIKwYBBQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3Jl
# cG9zaXRvcnkvMDYGA1UdHwQvMC0wK6ApoCeGJWh0dHA6Ly9jcmwuZ2xvYmFsc2ln
# bi5uZXQvcm9vdC1yMy5jcmwwEwYDVR0lBAwwCgYIKwYBBQUHAwMwHwYDVR0jBBgw
# FoAUj/BLf6guRSSuTVD6Y5qL3uLdG7wwDQYJKoZIhvcNAQELBQADggEBAHmwaTTi
# BYf2/tRgLC+GeTQD4LEHkwyEXPnk3GzPbrXsCly6C9BoMS4/ZL0Pgmtmd4F/ximl
# F9jwiU2DJBH2bv6d4UgKKKDieySApOzCmgDXsG1szYjVFXjPE/mIpXNNwTYr3MvO
# 23580ovvL72zT006rbtibiiTxAzL2ebK4BEClAOwvT+UKFaQHlPCJ9XJPM0aYx6C
# WRW2QMqngarDVa8z0bV16AnqRwhIIvtdG/Mseml+xddaXlYzPK1X6JMlQsPSXnE7
# ShxU7alVrCgFx8RsXdw8k/ZpPIJRzhoVPV4Bc/9Aouq0rtOO+u5dbEfHQfXUVlfy
# GDcy1tTMS/Zx4HYwggSfMIIDh6ADAgECAhIRIdaZp2SXPvH4Qn7pGcxTQRQwDQYJ
# KoZIhvcNAQEFBQAwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24g
# bnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzIw
# HhcNMTYwNTI0MDAwMDAwWhcNMjcwNjI0MDAwMDAwWjBgMQswCQYDVQQGEwJTRzEf
# MB0GA1UEChMWR01PIEdsb2JhbFNpZ24gUHRlIEx0ZDEwMC4GA1UEAxMnR2xvYmFs
# U2lnbiBUU0EgZm9yIE1TIEF1dGhlbnRpY29kZSAtIEcyMIIBIjANBgkqhkiG9w0B
# AQEFAAOCAQ8AMIIBCgKCAQEAsBeuotO2BDBWHlgPse1VpNZUy9j2czrsXV6rJf02
# pfqEw2FAxUa1WVI7QqIuXxNiEKlb5nPWkiWxfSPjBrOHOg5D8NcAiVOiETFSKG5d
# QHI88gl3p0mSl9RskKB2p/243LOd8gdgLE9YmABr0xVU4Prd/4AsXximmP/Uq+yh
# RVmyLm9iXeDZGayLV5yoJivZF6UQ0kcIGnAsM4t/aIAqtaFda92NAgIpA6p8N7u7
# KU49U5OzpvqP0liTFUy5LauAo6Ml+6/3CGSwekQPXBDXX2E3qk5r09JTJZ2Cc/os
# +XKwqRk5KlD6qdA8OsroW+/1X1H0+QrZlzXeaoXmIwRCrwIDAQABo4IBXzCCAVsw
# DgYDVR0PAQH/BAQDAgeAMEwGA1UdIARFMEMwQQYJKwYBBAGgMgEeMDQwMgYIKwYB
# BQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3JlcG9zaXRvcnkvMAkG
# A1UdEwQCMAAwFgYDVR0lAQH/BAwwCgYIKwYBBQUHAwgwQgYDVR0fBDswOTA3oDWg
# M4YxaHR0cDovL2NybC5nbG9iYWxzaWduLmNvbS9ncy9nc3RpbWVzdGFtcGluZ2cy
# LmNybDBUBggrBgEFBQcBAQRIMEYwRAYIKwYBBQUHMAKGOGh0dHA6Ly9zZWN1cmUu
# Z2xvYmFsc2lnbi5jb20vY2FjZXJ0L2dzdGltZXN0YW1waW5nZzIuY3J0MB0GA1Ud
# DgQWBBTUooRKOFoYf7pPMFC9ndV6h9YJ9zAfBgNVHSMEGDAWgBRG2D7/3OO+/4Pm
# 9IWbsN1q1hSpwTANBgkqhkiG9w0BAQUFAAOCAQEAj6kakW0EpjcgDoOW3iPTa24f
# bt1kPWghIrX4RzZpjuGlRcckoiK3KQnMVFquxrzNY46zPVBI5bTMrs2SjZ4oixNK
# Eaq9o+/Tsjb8tKFyv22XY3mMRLxwL37zvN2CU6sa9uv6HJe8tjecpBwwvKu8LUc2
# 35IgA+hxxlj2dQWaNPALWVqCRDSqgOQvhPZHXZbJtsrKnbemuuRQ09Q3uLogDtDT
# kipbxFm7oW3bPM5EncE4Kq3jjb3NCXcaEL5nCgI2ZIi5sxsm7ueeYMRGqLxhM2zP
# TrmcuWrwnzf+tT1PmtNN/94gjk6Xpv2fCbxNyhh2ybBNhVDygNIdBvVYBAexGDCC
# BNYwggO+oAMCAQICEhEhDRayW4wRltP+V8mGEea62TANBgkqhkiG9w0BAQsFADBa
# MQswCQYDVQQGEwJCRTEZMBcGA1UEChMQR2xvYmFsU2lnbiBudi1zYTEwMC4GA1UE
# AxMnR2xvYmFsU2lnbiBDb2RlU2lnbmluZyBDQSAtIFNIQTI1NiAtIEcyMB4XDTE1
# MDUwNDE2NDMyMVoXDTE4MDUwNDE2NDMyMVowVTELMAkGA1UEBhMCQ0gxDDAKBgNV
# BAgTA1p1ZzEMMAoGA1UEBxMDWnVnMRQwEgYDVQQKEwtkLWZlbnMgR21iSDEUMBIG
# A1UEAxMLZC1mZW5zIEdtYkgwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB
# AQDNPSzSNPylU9jFM78Q/GjzB7N+VNqikf/use7p8mpnBZ4cf5b4qV3rqQd62rJH
# RlAsxgouCSNQrl8xxfg6/t/I02kPvrzsR4xnDgMiVCqVRAeQsWebafWdTvWmONBS
# lxJejPP8TSgXMKFaDa+2HleTycTBYSoErAZSWpQ0NqF9zBadjsJRVatQuPkTDrwL
# eWibiyOipK9fcNoQpl5ll5H9EG668YJR3fqX9o0TQTkOmxXIL3IJ0UxdpyDpLEkt
# tBG6Y5wAdpF2dQX2phrfFNVY54JOGtuBkNGMSiLFzTkBA1fOlA6ICMYjB8xIFxVv
# rN1tYojCrqYkKMOjwWQz5X8zAgMBAAGjggGZMIIBlTAOBgNVHQ8BAf8EBAMCB4Aw
# TAYDVR0gBEUwQzBBBgkrBgEEAaAyATIwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93
# d3cuZ2xvYmFsc2lnbi5jb20vcmVwb3NpdG9yeS8wCQYDVR0TBAIwADATBgNVHSUE
# DDAKBggrBgEFBQcDAzBCBgNVHR8EOzA5MDegNaAzhjFodHRwOi8vY3JsLmdsb2Jh
# bHNpZ24uY29tL2dzL2dzY29kZXNpZ25zaGEyZzIuY3JsMIGQBggrBgEFBQcBAQSB
# gzCBgDBEBggrBgEFBQcwAoY4aHR0cDovL3NlY3VyZS5nbG9iYWxzaWduLmNvbS9j
# YWNlcnQvZ3Njb2Rlc2lnbnNoYTJnMi5jcnQwOAYIKwYBBQUHMAGGLGh0dHA6Ly9v
# Y3NwMi5nbG9iYWxzaWduLmNvbS9nc2NvZGVzaWduc2hhMmcyMB0GA1UdDgQWBBTN
# GDddiIYZy9p3Z84iSIMd27rtUDAfBgNVHSMEGDAWgBQZSrha5E0xpRTlXuwvoxz6
# gIwyazANBgkqhkiG9w0BAQsFAAOCAQEAAApsOzSX1alF00fTeijB/aIthO3UB0ks
# 1Gg3xoKQC1iEQmFG/qlFLiufs52kRPN7L0a7ClNH3iQpaH5IEaUENT9cNEXdKTBG
# 8OrJS8lrDJXImgNEgtSwz0B40h7bM2Z+0DvXDvpmfyM2NwHF/nNVj7NzmczrLRqN
# 9de3tV0pgRqnIYordVcmb24CZl3bzpwzbQQy14Iz+P5Z2cnw+QaYzAuweTZxEUcJ
# bFwpM49c1LMPFJTuOKkUgY90JJ3gVTpyQxfkc7DNBnx74PlRzjFmeGC/hxQt0hvo
# eaAiBdjo/1uuCTToigVnyRH+c0T2AezTeoFb7ne3I538hWeTdU5q9jGCBLcwggSz
# AgEBMHAwWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MgISESENFrJbjBGW0/5XyYYR5rrZMAkGBSsOAwIaBQCgeDAYBgorBgEEAYI3AgEM
# MQowCKACgAChAoAAMBkGCSqGSIb3DQEJAzEMBgorBgEEAYI3AgEEMBwGCisGAQQB
# gjcCAQsxDjAMBgorBgEEAYI3AgEVMCMGCSqGSIb3DQEJBDEWBBTb09Woc56dOE+4
# KDiPXhvHRxwIhDANBgkqhkiG9w0BAQEFAASCAQCthkwD+QeWS7mDDXNd0TH72vBl
# m7+wCgOOCqqUoY0cwZcFsCy6SAQyyvcq2Z5JujWO2H/I5zaBhjNUIkASAhljdS7G
# gw4bnQOQalUTIr9GMudUUovPojoSneTK1umVGG/JsmxRPUps4lN4vC4+TOEE8ic3
# 1KgLcXMfrxCYBQJ5uebx05dhFcexcmmfKBI2yvJwCKyoPBLYoZHMon2KdijTKJyp
# crwuViNg1e1pmuww0jbXjF4V8Jf2PD795GnCEyrCLm8vx6g28tOcW+Gp4Kbvtz6Z
# kwDs4sxsDTr5av5Evs1davXHmZc1uzQduXGuVc+G/v9pDNfZVQ2vy6uyQZR9oYIC
# ojCCAp4GCSqGSIb3DQEJBjGCAo8wggKLAgEBMGgwUjELMAkGA1UEBhMCQkUxGTAX
# BgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGlt
# ZXN0YW1waW5nIENBIC0gRzICEhEh1pmnZJc+8fhCfukZzFNBFDAJBgUrDgMCGgUA
# oIH9MBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTE2
# MDgzMTE5MTY1OVowIwYJKoZIhvcNAQkEMRYEFDM1yPaMOpA4lEsOkfIyVaeYeF3k
# MIGdBgsqhkiG9w0BCRACDDGBjTCBijCBhzCBhAQUY7gvq2H1g5CWlQULACScUCkz
# 7HkwbDBWpFQwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYt
# c2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzICEhEh
# 1pmnZJc+8fhCfukZzFNBFDANBgkqhkiG9w0BAQEFAASCAQCTZq8hSv+zKY3kW3Fs
# YOTZrXQFN3cPhV8xXl0XeqrzV7jxTHC9lom/NZaZk4HZXBm5S2cdLeVLrPiF3Z3X
# wmLb3rnOLO8NsMlh/w5hys4047zOMFR/jAmL6H9euVv3TNE1oYcQ1kMWfSuUqRcI
# zmszGEDgP/S3TMwzPyer2SA9FgOcXvPBBtL/WfBdz63TKIj38JQRJWDJwg8fq6z+
# CKKq1bmertMKPWfM0dEY0YhojLd5z1B8hdJQqTmr5auki5cngWaxa/y7qHabbk9m
# KtDu9Ad6riP3q5boDu40Z4R+yWuHlcg49VDLrrU7x1/7p+U9FLzTJ9bZLj898fHt
# WbNu
# SIG # End signature block
|
PowerShellCorpus/PowerShellGallery/biz.dfch.PS.Appclusive.Client/5.2.1.20161201/Set-EntityBag.ps1
|
Set-EntityBag.ps1
|
function Set-EntityBag {
<#
.SYNOPSIS
Sets or creates a EntityBag entry in Appclusive.
.DESCRIPTION
Sets or creates a EntityBag entry in Appclusive.
By updating an EntityBag entry you can specify if you want to update the description, protectionLevel or value or any combination thereof. For updating the value you need to use the Argument '-NewValue'
.OUTPUTS
default
.EXAMPLE
Set-EntityBag -Name "ArbitraryName" -Value "ArbitraryValue" -EntityKindId 1 -EntityId 2 -svc $svc -CreateIfNotExist;
Name : ArbitraryName
Value : ArbitraryValue
EntityId : 2
EntityKindId : 1
ProtectionLevel : 0
Id : 159
Tid : 11111111-1111-1111-1111-111111111111
Description :
CreatedById : 1
ModifiedById : 1
Created : 23.08.2016 11:08:14 +02:00
Modified : 23.08.2016 11:08:14 +02:00
RowVersion : {0, 0, 0, 0...}
Tenant :
CreatedBy :
ModifiedBy :
Create a new EntityBag entry if it does not exists.
.EXAMPLE
Set-EntityBag -Name "ArbitraryName" -Value "ArbitraryValue" -EntityKindId 1 -EntityId 2 -Description "updatedDescription" -NewValue "Arbitrary updated value" -svc $svc;
Name : ArbitraryName
Value : Arbitrary updated value
EntityId : 2
EntityKindId : 1
ProtectionLevel : 0
Id : 159
Tid : 11111111-1111-1111-1111-111111111111
Description : updatedDescription
CreatedById : 1
ModifiedById : 1
Created : 23.08.2016 11:08:14 +02:00
Modified : 23.08.2016 11:08:14 +02:00
RowVersion : {0, 0, 0, 0...}
Tenant :
CreatedBy :
ModifiedBy :
Update an existing EntityBag with new value and description.
.LINK
Online Version: http://dfch.biz/biz/dfch/PS/Appclusive/Client/Set-EntityBag/
Set-EntityBag: http://dfch.biz/biz/dfch/PS/Appclusive/Client/Set-EntityBag/
.NOTES
See module manifest for dependencies and further requirements.
#>
[CmdletBinding(
SupportsShouldProcess = $false
,
ConfirmImpact = 'Low'
,
HelpURI = 'http://dfch.biz/biz/dfch/PS/Appclusive/Client/Set-EntityBag/'
)]
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseShouldProcessForStateChangingFunctions", "")]
Param
(
# Specifies the name to modify
[Parameter(Mandatory = $true, Position = 0)]
[ValidateNotNullOrEmpty()]
[Alias('n')]
[string] $Name
,
# Specifies the value to modify
[Parameter(Mandatory = $true, Position = 1)]
[string] $Value
,
# Specifies the EntityKindId
[Parameter(Mandatory = $true, Position = 2)]
[ValidateRange(1, [long]::MaxValue)]
[long] $EntityKindId
,
# Specifies the EntityId
[Parameter(Mandatory = $true, Position = 3)]
[ValidateRange(1, [long]::MaxValue)]
[long] $EntityId
,
# Specifies the new value
[Parameter(Mandatory = $false)]
[string] $NewValue
,
[Parameter(Mandatory = $false)]
[ValidateNotNullOrEmpty()]
[string] $Description
,
# Specifies the ProtectionLevel
[Parameter(Mandatory = $false)]
[long] $ProtectionLevel
,
# Specifies to create a entity if it does not exist
[Parameter(Mandatory = $false)]
[Alias("c")]
[switch] $CreateIfNotExist = $false
,
# Service reference to Appclusive
[Parameter(Mandatory = $false)]
[Alias('Services')]
[hashtable] $svc = (Get-Variable -Name $MyInvocation.MyCommand.Module.PrivateData.MODULEVAR -ValueOnly).Services
,
# Specifies the return format of the Cmdlet
[ValidateSet('default', 'json', 'json-pretty', 'xml', 'xml-pretty')]
[Parameter(Mandatory = $false)]
[alias('ReturnFormat')]
[string] $As = 'default'
)
# Begin
Begin
{
trap { Log-Exception $_; break; }
$datBegin = [datetime]::Now;
[string] $fn = $MyInvocation.MyCommand.Name;
Log-Debug -fn $fn -msg ("CALL. svc '{0}'. Name '{1}'." -f ($svc -is [Object]), $Name) -fac 1;
# Parameter validation
Contract-Requires ($svc.Core -is [biz.dfch.CS.Appclusive.Api.Core.Core]) "Connect to the server before using the Cmdlet"
# ProtectionLevel param validation
$minProtectionLevelValue = [biz.dfch.CS.Appclusive.Public.OdataServices.Core.EntityBagProtectionLevelEnum]::MinValue.value__;
$maxProtectionLevelValue = [biz.dfch.CS.Appclusive.Public.OdataServices.Core.EntityBagProtectionLevelEnum]::MaxValue.value__;
if ($ProtectionLevel)
{
Contract-Assert($minProtectionLevelValue -le $ProtectionLevel);
Contract-Assert($maxProtectionLevelValue -ge $ProtectionLevel);
}
}
Process
{
# Default test variable for checking function response codes.
[Boolean] $fReturn = $false;
# Return values are always and only returned via OutputParameter.
$OutputParameter = $null;
$AddedEntity = $null;
try
{
$exp = @();
$exp += ("(tolower(Name) eq '{0}')" -f $Name.ToLower());
$exp += ("(EntityId eq {0})" -f $EntityId);
$exp += ("(EntityKindId eq {0})" -f $EntityKindId);
$FilterExpression = [String]::Join(' and ', $exp);
$entity = $svc.Core.EntityBags.AddQueryOption('$filter', $FilterExpression).AddQueryOption('$top',1) | Select;
if(!$CreateIfNotExist -And !$entity)
{
$msg = "Name: Parameter validation FAILED. Entity does not exist. Use '-CreateIfNotExist' to create resource: '{0}'" -f $Name;
$e = New-CustomErrorRecord -m $msg -cat ObjectNotFound -o $Name;
throw($gotoError);
}
if(!$entity)
{
$entity = New-Object biz.dfch.CS.Appclusive.Api.Core.EntityBag;
$svc.Core.AddToEntityBags($entity);
$AddedEntity = $entity;
$entity.Name = $Name;
$entity.Value = $Value;
$entity.EntityId = $EntityId;
$entity.EntityKindId = $EntityKindId;
$entity.Created = [System.DateTimeOffset]::Now;
$entity.Modified = $entity.Created;
$entity.CreatedById = 0;
$entity.ModifiedById = 0;
$entity.Tid = [guid]::Empty.ToString();
}
if($PSBoundParameters.ContainsKey('Description'))
{
$entity.Description = $Description;
}
if($PSBoundParameters.ContainsKey('ProtectionLevel'))
{
$entity.ProtectionLevel = $ProtectionLevel;
}
if($PSBoundParameters.ContainsKey('NewValue'))
{
$entity.Value = $NewValue;
}
$svc.Core.UpdateObject($entity);
$r = $svc.Core.SaveChanges();
$r = $entity;
$OutputParameter = Format-ResultAs $r $As;
$fReturn = $true;
}
catch
{
if($gotoSuccess -eq $_.Exception.Message)
{
$fReturn = $true;
}
else
{
[string] $ErrorText = "catch [$($_.FullyQualifiedErrorId)]";
$ErrorText += (($_ | fl * -Force) | Out-String);
$ErrorText += (($_.Exception | fl * -Force) | Out-String);
$ErrorText += (Get-PSCallStack | Out-String);
if($_.Exception -is [System.Net.WebException])
{
Log-Critical $fn ("[WebException] Request FAILED with Status '{0}'. [{1}]." -f $_.Exception.Status, $_);
Log-Debug $fn $ErrorText -fac 3;
}
else
{
Log-Error $fn $ErrorText -fac 3;
if($gotoError -eq $_.Exception.Message)
{
Log-Error $fn $e.Exception.Message;
$PSCmdlet.ThrowTerminatingError($e);
}
elseif($gotoFailure -ne $_.Exception.Message)
{
Write-Verbose ("$fn`n$ErrorText");
}
else
{
# N/A
}
}
$fReturn = $false;
$OutputParameter = $null;
if($AddedEntity)
{
$svc.Core.DeleteObject($AddedEntity);
}
}
}
finally
{
# Clean up
# N/A
}
}
# Process
End
{
$datEnd = [datetime]::Now;
Log-Debug -fn $fn -msg ("RET. fReturn: [{0}]. Execution time: [{1}]ms. Started: [{2}]." -f $fReturn, ($datEnd - $datBegin).TotalMilliseconds, $datBegin.ToString('yyyy-MM-dd HH:mm:ss.fffzzz')) -fac 2;
# Return values are always and only returned via OutputParameter.
return $OutputParameter;
}
# End
}
if($MyInvocation.ScriptName) { Export-ModuleMember -Function Set-EntityBag; }
#
# Copyright 2016 d-fens GmbH
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
|
PowerShellCorpus/PowerShellGallery/biz.dfch.PS.Appclusive.Client/5.2.1.20161201/Get-ModuleVariable.ps1
|
Get-ModuleVariable.ps1
|
function Get-ModuleVariable {
[CmdletBinding(
SupportsShouldProcess = $false
,
ConfirmImpact = 'Low'
,
HelpURI = 'http://dfch.biz/PS/Appclusive/Client/Get-ModuleVariable/'
)]
[OutputType([hashtable])]
PARAM
(
# Specifies a references to the Appclusive endpoints
[Parameter(Mandatory = $false)]
[hashtable] $InputObject = (Get-Variable -Name $MyInvocation.MyCommand.Module.PrivateData.MODULEVAR -ValueOnly)
)
$OutputParameter = $InputObject;
return $OutputParameter;
}
#
# Copyright 2015 d-fens GmbH
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SIG # Begin signature block
# MIIXDwYJKoZIhvcNAQcCoIIXADCCFvwCAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB
# gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR
# AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQUkkHs7+JjMOAJOiFawuwmKCAu
# ml+gghHCMIIEFDCCAvygAwIBAgILBAAAAAABL07hUtcwDQYJKoZIhvcNAQEFBQAw
# VzELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNV
# BAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkdsb2JhbFNpZ24gUm9vdCBDQTAeFw0xMTA0
# MTMxMDAwMDBaFw0yODAxMjgxMjAwMDBaMFIxCzAJBgNVBAYTAkJFMRkwFwYDVQQK
# ExBHbG9iYWxTaWduIG52LXNhMSgwJgYDVQQDEx9HbG9iYWxTaWduIFRpbWVzdGFt
# cGluZyBDQSAtIEcyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAlO9l
# +LVXn6BTDTQG6wkft0cYasvwW+T/J6U00feJGr+esc0SQW5m1IGghYtkWkYvmaCN
# d7HivFzdItdqZ9C76Mp03otPDbBS5ZBb60cO8eefnAuQZT4XljBFcm05oRc2yrmg
# jBtPCBn2gTGtYRakYua0QJ7D/PuV9vu1LpWBmODvxevYAll4d/eq41JrUJEpxfz3
# zZNl0mBhIvIG+zLdFlH6Dv2KMPAXCae78wSuq5DnbN96qfTvxGInX2+ZbTh0qhGL
# 2t/HFEzphbLswn1KJo/nVrqm4M+SU4B09APsaLJgvIQgAIMboe60dAXBKY5i0Eex
# +vBTzBj5Ljv5cH60JQIDAQABo4HlMIHiMA4GA1UdDwEB/wQEAwIBBjASBgNVHRMB
# Af8ECDAGAQH/AgEAMB0GA1UdDgQWBBRG2D7/3OO+/4Pm9IWbsN1q1hSpwTBHBgNV
# HSAEQDA+MDwGBFUdIAAwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93d3cuZ2xvYmFs
# c2lnbi5jb20vcmVwb3NpdG9yeS8wMwYDVR0fBCwwKjAooCagJIYiaHR0cDovL2Ny
# bC5nbG9iYWxzaWduLm5ldC9yb290LmNybDAfBgNVHSMEGDAWgBRge2YaRQ2XyolQ
# L30EzTSo//z9SzANBgkqhkiG9w0BAQUFAAOCAQEATl5WkB5GtNlJMfO7FzkoG8IW
# 3f1B3AkFBJtvsqKa1pkuQJkAVbXqP6UgdtOGNNQXzFU6x4Lu76i6vNgGnxVQ380W
# e1I6AtcZGv2v8Hhc4EvFGN86JB7arLipWAQCBzDbsBJe/jG+8ARI9PBw+DpeVoPP
# PfsNvPTF7ZedudTbpSeE4zibi6c1hkQgpDttpGoLoYP9KOva7yj2zIhd+wo7AKvg
# IeviLzVsD440RZfroveZMzV+y5qKu0VN5z+fwtmK+mWybsd+Zf/okuEsMaL3sCc2
# SI8mbzvuTXYfecPlf5Y1vC0OzAGwjn//UYCAp5LUs0RGZIyHTxZjBzFLY7Df8zCC
# BCkwggMRoAMCAQICCwQAAAAAATGJxjfoMA0GCSqGSIb3DQEBCwUAMEwxIDAeBgNV
# BAsTF0dsb2JhbFNpZ24gUm9vdCBDQSAtIFIzMRMwEQYDVQQKEwpHbG9iYWxTaWdu
# MRMwEQYDVQQDEwpHbG9iYWxTaWduMB4XDTExMDgwMjEwMDAwMFoXDTE5MDgwMjEw
# MDAwMFowWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKPv0Z8p6djTgnY8YqDS
# SdYWHvHP8NC6SEMDLacd8gE0SaQQ6WIT9BP0FoO11VdCSIYrlViH6igEdMtyEQ9h
# JuH6HGEVxyibTQuCDyYrkDqW7aTQaymc9WGI5qRXb+70cNCNF97mZnZfdB5eDFM4
# XZD03zAtGxPReZhUGks4BPQHxCMD05LL94BdqpxWBkQtQUxItC3sNZKaxpXX9c6Q
# MeJ2s2G48XVXQqw7zivIkEnotybPuwyJy9DDo2qhydXjnFMrVyb+Vpp2/WFGomDs
# KUZH8s3ggmLGBFrn7U5AXEgGfZ1f53TJnoRlDVve3NMkHLQUEeurv8QfpLqZ0BdY
# Nc0CAwEAAaOB/TCB+jAOBgNVHQ8BAf8EBAMCAQYwEgYDVR0TAQH/BAgwBgEB/wIB
# ADAdBgNVHQ4EFgQUGUq4WuRNMaUU5V7sL6Mc+oCMMmswRwYDVR0gBEAwPjA8BgRV
# HSAAMDQwMgYIKwYBBQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3Jl
# cG9zaXRvcnkvMDYGA1UdHwQvMC0wK6ApoCeGJWh0dHA6Ly9jcmwuZ2xvYmFsc2ln
# bi5uZXQvcm9vdC1yMy5jcmwwEwYDVR0lBAwwCgYIKwYBBQUHAwMwHwYDVR0jBBgw
# FoAUj/BLf6guRSSuTVD6Y5qL3uLdG7wwDQYJKoZIhvcNAQELBQADggEBAHmwaTTi
# BYf2/tRgLC+GeTQD4LEHkwyEXPnk3GzPbrXsCly6C9BoMS4/ZL0Pgmtmd4F/ximl
# F9jwiU2DJBH2bv6d4UgKKKDieySApOzCmgDXsG1szYjVFXjPE/mIpXNNwTYr3MvO
# 23580ovvL72zT006rbtibiiTxAzL2ebK4BEClAOwvT+UKFaQHlPCJ9XJPM0aYx6C
# WRW2QMqngarDVa8z0bV16AnqRwhIIvtdG/Mseml+xddaXlYzPK1X6JMlQsPSXnE7
# ShxU7alVrCgFx8RsXdw8k/ZpPIJRzhoVPV4Bc/9Aouq0rtOO+u5dbEfHQfXUVlfy
# GDcy1tTMS/Zx4HYwggSfMIIDh6ADAgECAhIRIdaZp2SXPvH4Qn7pGcxTQRQwDQYJ
# KoZIhvcNAQEFBQAwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24g
# bnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzIw
# HhcNMTYwNTI0MDAwMDAwWhcNMjcwNjI0MDAwMDAwWjBgMQswCQYDVQQGEwJTRzEf
# MB0GA1UEChMWR01PIEdsb2JhbFNpZ24gUHRlIEx0ZDEwMC4GA1UEAxMnR2xvYmFs
# U2lnbiBUU0EgZm9yIE1TIEF1dGhlbnRpY29kZSAtIEcyMIIBIjANBgkqhkiG9w0B
# AQEFAAOCAQ8AMIIBCgKCAQEAsBeuotO2BDBWHlgPse1VpNZUy9j2czrsXV6rJf02
# pfqEw2FAxUa1WVI7QqIuXxNiEKlb5nPWkiWxfSPjBrOHOg5D8NcAiVOiETFSKG5d
# QHI88gl3p0mSl9RskKB2p/243LOd8gdgLE9YmABr0xVU4Prd/4AsXximmP/Uq+yh
# RVmyLm9iXeDZGayLV5yoJivZF6UQ0kcIGnAsM4t/aIAqtaFda92NAgIpA6p8N7u7
# KU49U5OzpvqP0liTFUy5LauAo6Ml+6/3CGSwekQPXBDXX2E3qk5r09JTJZ2Cc/os
# +XKwqRk5KlD6qdA8OsroW+/1X1H0+QrZlzXeaoXmIwRCrwIDAQABo4IBXzCCAVsw
# DgYDVR0PAQH/BAQDAgeAMEwGA1UdIARFMEMwQQYJKwYBBAGgMgEeMDQwMgYIKwYB
# BQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3JlcG9zaXRvcnkvMAkG
# A1UdEwQCMAAwFgYDVR0lAQH/BAwwCgYIKwYBBQUHAwgwQgYDVR0fBDswOTA3oDWg
# M4YxaHR0cDovL2NybC5nbG9iYWxzaWduLmNvbS9ncy9nc3RpbWVzdGFtcGluZ2cy
# LmNybDBUBggrBgEFBQcBAQRIMEYwRAYIKwYBBQUHMAKGOGh0dHA6Ly9zZWN1cmUu
# Z2xvYmFsc2lnbi5jb20vY2FjZXJ0L2dzdGltZXN0YW1waW5nZzIuY3J0MB0GA1Ud
# DgQWBBTUooRKOFoYf7pPMFC9ndV6h9YJ9zAfBgNVHSMEGDAWgBRG2D7/3OO+/4Pm
# 9IWbsN1q1hSpwTANBgkqhkiG9w0BAQUFAAOCAQEAj6kakW0EpjcgDoOW3iPTa24f
# bt1kPWghIrX4RzZpjuGlRcckoiK3KQnMVFquxrzNY46zPVBI5bTMrs2SjZ4oixNK
# Eaq9o+/Tsjb8tKFyv22XY3mMRLxwL37zvN2CU6sa9uv6HJe8tjecpBwwvKu8LUc2
# 35IgA+hxxlj2dQWaNPALWVqCRDSqgOQvhPZHXZbJtsrKnbemuuRQ09Q3uLogDtDT
# kipbxFm7oW3bPM5EncE4Kq3jjb3NCXcaEL5nCgI2ZIi5sxsm7ueeYMRGqLxhM2zP
# TrmcuWrwnzf+tT1PmtNN/94gjk6Xpv2fCbxNyhh2ybBNhVDygNIdBvVYBAexGDCC
# BNYwggO+oAMCAQICEhEhDRayW4wRltP+V8mGEea62TANBgkqhkiG9w0BAQsFADBa
# MQswCQYDVQQGEwJCRTEZMBcGA1UEChMQR2xvYmFsU2lnbiBudi1zYTEwMC4GA1UE
# AxMnR2xvYmFsU2lnbiBDb2RlU2lnbmluZyBDQSAtIFNIQTI1NiAtIEcyMB4XDTE1
# MDUwNDE2NDMyMVoXDTE4MDUwNDE2NDMyMVowVTELMAkGA1UEBhMCQ0gxDDAKBgNV
# BAgTA1p1ZzEMMAoGA1UEBxMDWnVnMRQwEgYDVQQKEwtkLWZlbnMgR21iSDEUMBIG
# A1UEAxMLZC1mZW5zIEdtYkgwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB
# AQDNPSzSNPylU9jFM78Q/GjzB7N+VNqikf/use7p8mpnBZ4cf5b4qV3rqQd62rJH
# RlAsxgouCSNQrl8xxfg6/t/I02kPvrzsR4xnDgMiVCqVRAeQsWebafWdTvWmONBS
# lxJejPP8TSgXMKFaDa+2HleTycTBYSoErAZSWpQ0NqF9zBadjsJRVatQuPkTDrwL
# eWibiyOipK9fcNoQpl5ll5H9EG668YJR3fqX9o0TQTkOmxXIL3IJ0UxdpyDpLEkt
# tBG6Y5wAdpF2dQX2phrfFNVY54JOGtuBkNGMSiLFzTkBA1fOlA6ICMYjB8xIFxVv
# rN1tYojCrqYkKMOjwWQz5X8zAgMBAAGjggGZMIIBlTAOBgNVHQ8BAf8EBAMCB4Aw
# TAYDVR0gBEUwQzBBBgkrBgEEAaAyATIwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93
# d3cuZ2xvYmFsc2lnbi5jb20vcmVwb3NpdG9yeS8wCQYDVR0TBAIwADATBgNVHSUE
# DDAKBggrBgEFBQcDAzBCBgNVHR8EOzA5MDegNaAzhjFodHRwOi8vY3JsLmdsb2Jh
# bHNpZ24uY29tL2dzL2dzY29kZXNpZ25zaGEyZzIuY3JsMIGQBggrBgEFBQcBAQSB
# gzCBgDBEBggrBgEFBQcwAoY4aHR0cDovL3NlY3VyZS5nbG9iYWxzaWduLmNvbS9j
# YWNlcnQvZ3Njb2Rlc2lnbnNoYTJnMi5jcnQwOAYIKwYBBQUHMAGGLGh0dHA6Ly9v
# Y3NwMi5nbG9iYWxzaWduLmNvbS9nc2NvZGVzaWduc2hhMmcyMB0GA1UdDgQWBBTN
# GDddiIYZy9p3Z84iSIMd27rtUDAfBgNVHSMEGDAWgBQZSrha5E0xpRTlXuwvoxz6
# gIwyazANBgkqhkiG9w0BAQsFAAOCAQEAAApsOzSX1alF00fTeijB/aIthO3UB0ks
# 1Gg3xoKQC1iEQmFG/qlFLiufs52kRPN7L0a7ClNH3iQpaH5IEaUENT9cNEXdKTBG
# 8OrJS8lrDJXImgNEgtSwz0B40h7bM2Z+0DvXDvpmfyM2NwHF/nNVj7NzmczrLRqN
# 9de3tV0pgRqnIYordVcmb24CZl3bzpwzbQQy14Iz+P5Z2cnw+QaYzAuweTZxEUcJ
# bFwpM49c1LMPFJTuOKkUgY90JJ3gVTpyQxfkc7DNBnx74PlRzjFmeGC/hxQt0hvo
# eaAiBdjo/1uuCTToigVnyRH+c0T2AezTeoFb7ne3I538hWeTdU5q9jGCBLcwggSz
# AgEBMHAwWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MgISESENFrJbjBGW0/5XyYYR5rrZMAkGBSsOAwIaBQCgeDAYBgorBgEEAYI3AgEM
# MQowCKACgAChAoAAMBkGCSqGSIb3DQEJAzEMBgorBgEEAYI3AgEEMBwGCisGAQQB
# gjcCAQsxDjAMBgorBgEEAYI3AgEVMCMGCSqGSIb3DQEJBDEWBBSm80EhFNKfairW
# WPxtAl71a7Kj3DANBgkqhkiG9w0BAQEFAASCAQAUYG06TWm49dkBAo/6oLePB2Kn
# xSEBakh73UEL3qOPEJGowo3O0S1ieffru/Z0WVt3NBTgprk9R11zhJpNH2FYVRY5
# ApGrEbTpMHRKy1F/vVQUZIL9EwWg0EMyg7XdiA0q+1Gbmbu8OKoKvESQXfeAwFXl
# GG2NVAQsoIKsrpaXihPyA0fR2wmM9913K2nzFdDCzjKHmZQw2DcNbyCD/VFqxzhu
# nKFY0s9JzZtjx7+w0DLglAzfai+0wbHpbfNr7BkdRKG8sLHoj9pXu59XOUrwOoYi
# U5Xojsgf48JWhhtYTy7hNi2/OcwhKJTqwC8n7HYyP88ABtU43mX4IXSX+g5HoYIC
# ojCCAp4GCSqGSIb3DQEJBjGCAo8wggKLAgEBMGgwUjELMAkGA1UEBhMCQkUxGTAX
# BgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGlt
# ZXN0YW1waW5nIENBIC0gRzICEhEh1pmnZJc+8fhCfukZzFNBFDAJBgUrDgMCGgUA
# oIH9MBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTE2
# MDgzMTE5MTY0NVowIwYJKoZIhvcNAQkEMRYEFNcyg+PCoVsH7l893JKiM9Ktkw3r
# MIGdBgsqhkiG9w0BCRACDDGBjTCBijCBhzCBhAQUY7gvq2H1g5CWlQULACScUCkz
# 7HkwbDBWpFQwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYt
# c2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzICEhEh
# 1pmnZJc+8fhCfukZzFNBFDANBgkqhkiG9w0BAQEFAASCAQAUG7gjyFNE6mup/rJ3
# FRFCVHGSJBhMbJ8mLN6WWNJd79kh3IL0XxoSkvS9+DRiXqvE1PF+Rly32FqJZYf1
# SHhSqrXjh3LGFJEPDVP1DkeEHm/MJw6Il3bsvD/u4Y8nmwCMzzIBY1+62FCI2E+k
# k8vNhvkdrDQk3/o9uz9egFQJgkXH6j9zZF/8Yz/VTI3sqkdluuD2O3fArMgAezUu
# C/w4NTktNH6nDp15TnMkH4o5R0w/cxvqxhtURlnisYKr8MAoZuvtOOyBLoujv+mt
# AGHRCjmL7Xcxc1zuq6UnT0ckDkPea2xBUdICqa5lauNk5a03ktyhlklk8FgQga9G
# iVVY
# SIG # End signature block
|
PowerShellCorpus/PowerShellGallery/biz.dfch.PS.Appclusive.Client/5.2.1.20161201/New-Node.ps1
|
New-Node.ps1
|
function New-Node {
<#
.SYNOPSIS
Creates a Node entry in Appclusive.
.DESCRIPTION
Creates a Node entry in Appclusive.
You must specify the parameters 'Name' and 'ParentId'. If the entry already exists no update of the existing entry is performed.
.OUTPUTS
[biz.dfch.CS.Appclusive.Api.Core.Node]
.EXAMPLE
New-Node Srv01 -EntityKindName com.swisscom.cms.rhel7
Parameters : {}
EntityKindId : 29
ParentId : 1
Id : 1442
Tid : 22222222-2222-2222-2222-222222222222
Name : Srv01
Description :
CreatedById : 60
ModifiedById : 60
Created : 05.01.2016 15:35:06 +01:00
Modified : 05.01.2016 15:35:06 +01:00
RowVersion : {0, 0, 0, 0...}
Parent :
EntityKind :
Children : {}
IncomingAssocs : {}
OutgoingAssocs : {}
Tenant :
CreatedBy :
ModifiedBy :
Create a new Node entry if it not already exists.
.EXAMPLE
New-Node -Name myName -ParentId 1 -EntityKindName com.swisscom.cms.rhel7 -Description myDescription
Parameters : {}
EntityKindId : 29
ParentId : 1
Id : 1442
Tid : 22222222-2222-2222-2222-222222222222
Name : myName
Description : myDescription
CreatedById : 60
ModifiedById : 60
Created : 05.01.2016 15:35:06 +01:00
Modified : 05.01.2016 15:35:06 +01:00
RowVersion : {0, 0, 0, 0...}
Parent :
EntityKind :
Children : {}
IncomingAssocs : {}
OutgoingAssocs : {}
Tenant :
CreatedBy :
ModifiedBy :
Create a new Node entry if it not already exists.
.LINK
Online Version: http://dfch.biz/biz/dfch/PS/Appclusive/Client/New-Node/
Set-Node: http://dfch.biz/biz/dfch/PS/Appclusive/Client/Set-Node/
.NOTES
See module manifest for dependencies and further requirements.
#>
[CmdletBinding(
SupportsShouldProcess = $true
,
ConfirmImpact = 'Low'
,
HelpURI = 'http://dfch.biz/biz/dfch/PS/Appclusive/Client/New-Node/'
)]
Param
(
# Specifies the name for this entity
[Parameter(Mandatory = $true, Position = 0)]
[ValidateNotNullOrEmpty()]
[string] $Name
,
# Specifies the Parent id for this entity
[Parameter(Mandatory = $true, Position = 1)]
[long] $ParentId
,
# Specifies the EntityKind id for this entity
[Parameter(Mandatory = $false)]
[long] $EntityKindId
,
# Specifies the EntityKind name for this entity
[Parameter(Mandatory = $false)]
[string] $EntityKindName
,
# Specifies the parameters for this entity
[Parameter(Mandatory = $false)]
[hashtable] $Parameters
,
# Specifies the description for this entity
[Parameter(Mandatory = $false)]
[string] $Description
,
# Service reference to Appclusive
[Parameter(Mandatory = $false)]
[Alias('Services')]
[hashtable] $svc = (Get-Variable -Name $MyInvocation.MyCommand.Module.PrivateData.MODULEVAR -ValueOnly).Services
,
# Specifies the return method
[Parameter(Mandatory = $false)]
[switch] $Async = $false
)
Begin
{
trap { Log-Exception $_; break; }
$datBegin = [datetime]::Now;
[string] $fn = $MyInvocation.MyCommand.Name;
Log-Debug -fn $fn -msg ("CALL. svc '{0}'. Name '{1}'." -f ($svc -is [Object]), $Name) -fac 1;
# Parameter validation
Contract-Requires ($svc.Core -is [biz.dfch.CS.Appclusive.Api.Core.Core]) "Connect to the server before using the Cmdlet"
$EntitySetName = 'Nodes';
}
# Begin
Process
{
trap { Log-Exception $_; break; }
# Default test variable for checking function response codes.
[Boolean] $fReturn = $false;
# Return values are always and only returned via OutputParameter.
$OutputParameter = $null;
$NodeContents = @($Name);
$FilterExpression = "(tolower(Name) eq '{0}')" -f $Name.toLower();
$entity = $svc.Core.$EntitySetName.AddQueryOption('$filter', $FilterExpression).AddQueryOption('$top',1) | Select;
Contract-Assert (!$entity) 'Entity does already exist'
if($PSCmdlet.ShouldProcess($NodeContents))
{
$r = Set-Node @PSBoundParameters -CreateIfNotExist:$true;
$OutputParameter = $r;
}
$fReturn = $true;
}
# Process
End
{
$datEnd = [datetime]::Now;
Log-Debug -fn $fn -msg ("RET. fReturn: [{0}]. Execution time: [{1}]ms. Started: [{2}]." -f $fReturn, ($datEnd - $datBegin).TotalMilliseconds, $datBegin.ToString('yyyy-MM-dd HH:mm:ss.fffzzz')) -fac 2;
# Return values are always and only returned via OutputParameter.
return $OutputParameter;
}
# End
}
if($MyInvocation.ScriptName) { Export-ModuleMember -Function New-Node; }
#
# Copyright 2014-2015 d-fens GmbH
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SIG # Begin signature block
# MIIXDwYJKoZIhvcNAQcCoIIXADCCFvwCAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB
# gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR
# AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQUMiBgB3r8SE6x+X4sXZoxvUmz
# Y+qgghHCMIIEFDCCAvygAwIBAgILBAAAAAABL07hUtcwDQYJKoZIhvcNAQEFBQAw
# VzELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNV
# BAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkdsb2JhbFNpZ24gUm9vdCBDQTAeFw0xMTA0
# MTMxMDAwMDBaFw0yODAxMjgxMjAwMDBaMFIxCzAJBgNVBAYTAkJFMRkwFwYDVQQK
# ExBHbG9iYWxTaWduIG52LXNhMSgwJgYDVQQDEx9HbG9iYWxTaWduIFRpbWVzdGFt
# cGluZyBDQSAtIEcyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAlO9l
# +LVXn6BTDTQG6wkft0cYasvwW+T/J6U00feJGr+esc0SQW5m1IGghYtkWkYvmaCN
# d7HivFzdItdqZ9C76Mp03otPDbBS5ZBb60cO8eefnAuQZT4XljBFcm05oRc2yrmg
# jBtPCBn2gTGtYRakYua0QJ7D/PuV9vu1LpWBmODvxevYAll4d/eq41JrUJEpxfz3
# zZNl0mBhIvIG+zLdFlH6Dv2KMPAXCae78wSuq5DnbN96qfTvxGInX2+ZbTh0qhGL
# 2t/HFEzphbLswn1KJo/nVrqm4M+SU4B09APsaLJgvIQgAIMboe60dAXBKY5i0Eex
# +vBTzBj5Ljv5cH60JQIDAQABo4HlMIHiMA4GA1UdDwEB/wQEAwIBBjASBgNVHRMB
# Af8ECDAGAQH/AgEAMB0GA1UdDgQWBBRG2D7/3OO+/4Pm9IWbsN1q1hSpwTBHBgNV
# HSAEQDA+MDwGBFUdIAAwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93d3cuZ2xvYmFs
# c2lnbi5jb20vcmVwb3NpdG9yeS8wMwYDVR0fBCwwKjAooCagJIYiaHR0cDovL2Ny
# bC5nbG9iYWxzaWduLm5ldC9yb290LmNybDAfBgNVHSMEGDAWgBRge2YaRQ2XyolQ
# L30EzTSo//z9SzANBgkqhkiG9w0BAQUFAAOCAQEATl5WkB5GtNlJMfO7FzkoG8IW
# 3f1B3AkFBJtvsqKa1pkuQJkAVbXqP6UgdtOGNNQXzFU6x4Lu76i6vNgGnxVQ380W
# e1I6AtcZGv2v8Hhc4EvFGN86JB7arLipWAQCBzDbsBJe/jG+8ARI9PBw+DpeVoPP
# PfsNvPTF7ZedudTbpSeE4zibi6c1hkQgpDttpGoLoYP9KOva7yj2zIhd+wo7AKvg
# IeviLzVsD440RZfroveZMzV+y5qKu0VN5z+fwtmK+mWybsd+Zf/okuEsMaL3sCc2
# SI8mbzvuTXYfecPlf5Y1vC0OzAGwjn//UYCAp5LUs0RGZIyHTxZjBzFLY7Df8zCC
# BCkwggMRoAMCAQICCwQAAAAAATGJxjfoMA0GCSqGSIb3DQEBCwUAMEwxIDAeBgNV
# BAsTF0dsb2JhbFNpZ24gUm9vdCBDQSAtIFIzMRMwEQYDVQQKEwpHbG9iYWxTaWdu
# MRMwEQYDVQQDEwpHbG9iYWxTaWduMB4XDTExMDgwMjEwMDAwMFoXDTE5MDgwMjEw
# MDAwMFowWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKPv0Z8p6djTgnY8YqDS
# SdYWHvHP8NC6SEMDLacd8gE0SaQQ6WIT9BP0FoO11VdCSIYrlViH6igEdMtyEQ9h
# JuH6HGEVxyibTQuCDyYrkDqW7aTQaymc9WGI5qRXb+70cNCNF97mZnZfdB5eDFM4
# XZD03zAtGxPReZhUGks4BPQHxCMD05LL94BdqpxWBkQtQUxItC3sNZKaxpXX9c6Q
# MeJ2s2G48XVXQqw7zivIkEnotybPuwyJy9DDo2qhydXjnFMrVyb+Vpp2/WFGomDs
# KUZH8s3ggmLGBFrn7U5AXEgGfZ1f53TJnoRlDVve3NMkHLQUEeurv8QfpLqZ0BdY
# Nc0CAwEAAaOB/TCB+jAOBgNVHQ8BAf8EBAMCAQYwEgYDVR0TAQH/BAgwBgEB/wIB
# ADAdBgNVHQ4EFgQUGUq4WuRNMaUU5V7sL6Mc+oCMMmswRwYDVR0gBEAwPjA8BgRV
# HSAAMDQwMgYIKwYBBQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3Jl
# cG9zaXRvcnkvMDYGA1UdHwQvMC0wK6ApoCeGJWh0dHA6Ly9jcmwuZ2xvYmFsc2ln
# bi5uZXQvcm9vdC1yMy5jcmwwEwYDVR0lBAwwCgYIKwYBBQUHAwMwHwYDVR0jBBgw
# FoAUj/BLf6guRSSuTVD6Y5qL3uLdG7wwDQYJKoZIhvcNAQELBQADggEBAHmwaTTi
# BYf2/tRgLC+GeTQD4LEHkwyEXPnk3GzPbrXsCly6C9BoMS4/ZL0Pgmtmd4F/ximl
# F9jwiU2DJBH2bv6d4UgKKKDieySApOzCmgDXsG1szYjVFXjPE/mIpXNNwTYr3MvO
# 23580ovvL72zT006rbtibiiTxAzL2ebK4BEClAOwvT+UKFaQHlPCJ9XJPM0aYx6C
# WRW2QMqngarDVa8z0bV16AnqRwhIIvtdG/Mseml+xddaXlYzPK1X6JMlQsPSXnE7
# ShxU7alVrCgFx8RsXdw8k/ZpPIJRzhoVPV4Bc/9Aouq0rtOO+u5dbEfHQfXUVlfy
# GDcy1tTMS/Zx4HYwggSfMIIDh6ADAgECAhIRIdaZp2SXPvH4Qn7pGcxTQRQwDQYJ
# KoZIhvcNAQEFBQAwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24g
# bnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzIw
# HhcNMTYwNTI0MDAwMDAwWhcNMjcwNjI0MDAwMDAwWjBgMQswCQYDVQQGEwJTRzEf
# MB0GA1UEChMWR01PIEdsb2JhbFNpZ24gUHRlIEx0ZDEwMC4GA1UEAxMnR2xvYmFs
# U2lnbiBUU0EgZm9yIE1TIEF1dGhlbnRpY29kZSAtIEcyMIIBIjANBgkqhkiG9w0B
# AQEFAAOCAQ8AMIIBCgKCAQEAsBeuotO2BDBWHlgPse1VpNZUy9j2czrsXV6rJf02
# pfqEw2FAxUa1WVI7QqIuXxNiEKlb5nPWkiWxfSPjBrOHOg5D8NcAiVOiETFSKG5d
# QHI88gl3p0mSl9RskKB2p/243LOd8gdgLE9YmABr0xVU4Prd/4AsXximmP/Uq+yh
# RVmyLm9iXeDZGayLV5yoJivZF6UQ0kcIGnAsM4t/aIAqtaFda92NAgIpA6p8N7u7
# KU49U5OzpvqP0liTFUy5LauAo6Ml+6/3CGSwekQPXBDXX2E3qk5r09JTJZ2Cc/os
# +XKwqRk5KlD6qdA8OsroW+/1X1H0+QrZlzXeaoXmIwRCrwIDAQABo4IBXzCCAVsw
# DgYDVR0PAQH/BAQDAgeAMEwGA1UdIARFMEMwQQYJKwYBBAGgMgEeMDQwMgYIKwYB
# BQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3JlcG9zaXRvcnkvMAkG
# A1UdEwQCMAAwFgYDVR0lAQH/BAwwCgYIKwYBBQUHAwgwQgYDVR0fBDswOTA3oDWg
# M4YxaHR0cDovL2NybC5nbG9iYWxzaWduLmNvbS9ncy9nc3RpbWVzdGFtcGluZ2cy
# LmNybDBUBggrBgEFBQcBAQRIMEYwRAYIKwYBBQUHMAKGOGh0dHA6Ly9zZWN1cmUu
# Z2xvYmFsc2lnbi5jb20vY2FjZXJ0L2dzdGltZXN0YW1waW5nZzIuY3J0MB0GA1Ud
# DgQWBBTUooRKOFoYf7pPMFC9ndV6h9YJ9zAfBgNVHSMEGDAWgBRG2D7/3OO+/4Pm
# 9IWbsN1q1hSpwTANBgkqhkiG9w0BAQUFAAOCAQEAj6kakW0EpjcgDoOW3iPTa24f
# bt1kPWghIrX4RzZpjuGlRcckoiK3KQnMVFquxrzNY46zPVBI5bTMrs2SjZ4oixNK
# Eaq9o+/Tsjb8tKFyv22XY3mMRLxwL37zvN2CU6sa9uv6HJe8tjecpBwwvKu8LUc2
# 35IgA+hxxlj2dQWaNPALWVqCRDSqgOQvhPZHXZbJtsrKnbemuuRQ09Q3uLogDtDT
# kipbxFm7oW3bPM5EncE4Kq3jjb3NCXcaEL5nCgI2ZIi5sxsm7ueeYMRGqLxhM2zP
# TrmcuWrwnzf+tT1PmtNN/94gjk6Xpv2fCbxNyhh2ybBNhVDygNIdBvVYBAexGDCC
# BNYwggO+oAMCAQICEhEhDRayW4wRltP+V8mGEea62TANBgkqhkiG9w0BAQsFADBa
# MQswCQYDVQQGEwJCRTEZMBcGA1UEChMQR2xvYmFsU2lnbiBudi1zYTEwMC4GA1UE
# AxMnR2xvYmFsU2lnbiBDb2RlU2lnbmluZyBDQSAtIFNIQTI1NiAtIEcyMB4XDTE1
# MDUwNDE2NDMyMVoXDTE4MDUwNDE2NDMyMVowVTELMAkGA1UEBhMCQ0gxDDAKBgNV
# BAgTA1p1ZzEMMAoGA1UEBxMDWnVnMRQwEgYDVQQKEwtkLWZlbnMgR21iSDEUMBIG
# A1UEAxMLZC1mZW5zIEdtYkgwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB
# AQDNPSzSNPylU9jFM78Q/GjzB7N+VNqikf/use7p8mpnBZ4cf5b4qV3rqQd62rJH
# RlAsxgouCSNQrl8xxfg6/t/I02kPvrzsR4xnDgMiVCqVRAeQsWebafWdTvWmONBS
# lxJejPP8TSgXMKFaDa+2HleTycTBYSoErAZSWpQ0NqF9zBadjsJRVatQuPkTDrwL
# eWibiyOipK9fcNoQpl5ll5H9EG668YJR3fqX9o0TQTkOmxXIL3IJ0UxdpyDpLEkt
# tBG6Y5wAdpF2dQX2phrfFNVY54JOGtuBkNGMSiLFzTkBA1fOlA6ICMYjB8xIFxVv
# rN1tYojCrqYkKMOjwWQz5X8zAgMBAAGjggGZMIIBlTAOBgNVHQ8BAf8EBAMCB4Aw
# TAYDVR0gBEUwQzBBBgkrBgEEAaAyATIwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93
# d3cuZ2xvYmFsc2lnbi5jb20vcmVwb3NpdG9yeS8wCQYDVR0TBAIwADATBgNVHSUE
# DDAKBggrBgEFBQcDAzBCBgNVHR8EOzA5MDegNaAzhjFodHRwOi8vY3JsLmdsb2Jh
# bHNpZ24uY29tL2dzL2dzY29kZXNpZ25zaGEyZzIuY3JsMIGQBggrBgEFBQcBAQSB
# gzCBgDBEBggrBgEFBQcwAoY4aHR0cDovL3NlY3VyZS5nbG9iYWxzaWduLmNvbS9j
# YWNlcnQvZ3Njb2Rlc2lnbnNoYTJnMi5jcnQwOAYIKwYBBQUHMAGGLGh0dHA6Ly9v
# Y3NwMi5nbG9iYWxzaWduLmNvbS9nc2NvZGVzaWduc2hhMmcyMB0GA1UdDgQWBBTN
# GDddiIYZy9p3Z84iSIMd27rtUDAfBgNVHSMEGDAWgBQZSrha5E0xpRTlXuwvoxz6
# gIwyazANBgkqhkiG9w0BAQsFAAOCAQEAAApsOzSX1alF00fTeijB/aIthO3UB0ks
# 1Gg3xoKQC1iEQmFG/qlFLiufs52kRPN7L0a7ClNH3iQpaH5IEaUENT9cNEXdKTBG
# 8OrJS8lrDJXImgNEgtSwz0B40h7bM2Z+0DvXDvpmfyM2NwHF/nNVj7NzmczrLRqN
# 9de3tV0pgRqnIYordVcmb24CZl3bzpwzbQQy14Iz+P5Z2cnw+QaYzAuweTZxEUcJ
# bFwpM49c1LMPFJTuOKkUgY90JJ3gVTpyQxfkc7DNBnx74PlRzjFmeGC/hxQt0hvo
# eaAiBdjo/1uuCTToigVnyRH+c0T2AezTeoFb7ne3I538hWeTdU5q9jGCBLcwggSz
# AgEBMHAwWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MgISESENFrJbjBGW0/5XyYYR5rrZMAkGBSsOAwIaBQCgeDAYBgorBgEEAYI3AgEM
# MQowCKACgAChAoAAMBkGCSqGSIb3DQEJAzEMBgorBgEEAYI3AgEEMBwGCisGAQQB
# gjcCAQsxDjAMBgorBgEEAYI3AgEVMCMGCSqGSIb3DQEJBDEWBBQikCjD81rWN8P5
# jerptRGSZCOlxjANBgkqhkiG9w0BAQEFAASCAQCeBnA8h2uj0plqA99W4NvR5mzE
# mQ2FYiUqm5a/04lwIkQTkS1Ixeu1ifVQSYyVyPXTdh22ykObQoqUmzvh8msLOKo3
# lZHdwahhFRdh5k5SyslgTumaLnzNJsSXYm7O7eGw2x9yPGcjeVMnR8RTO+wo32kW
# zxSudG+601DX6L2eQGQqbYlXrUbWRNScUnLO8NUh2aRfZBLzgHLHkFQw5QdVRFpA
# q/ebMxVVkHZtqJvupLvkXfpZ2PypQdse2oVr2kOcfdPvywRe6/u0vaM5s2CfbY3A
# Qgor3eK1Dd/NOaM5pHY4/g8EUNYzOsCjwMCwnOj2mhlQeaWAq0dNb9+OkxiroYIC
# ojCCAp4GCSqGSIb3DQEJBjGCAo8wggKLAgEBMGgwUjELMAkGA1UEBhMCQkUxGTAX
# BgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGlt
# ZXN0YW1waW5nIENBIC0gRzICEhEh1pmnZJc+8fhCfukZzFNBFDAJBgUrDgMCGgUA
# oIH9MBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTE2
# MDgzMTE5MTY1NVowIwYJKoZIhvcNAQkEMRYEFGDopvwSbWB/aMAyEkw4BKEbBS8p
# MIGdBgsqhkiG9w0BCRACDDGBjTCBijCBhzCBhAQUY7gvq2H1g5CWlQULACScUCkz
# 7HkwbDBWpFQwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYt
# c2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzICEhEh
# 1pmnZJc+8fhCfukZzFNBFDANBgkqhkiG9w0BAQEFAASCAQAMTkcGt9biPWdBVQ+C
# eeUeFVHVZME10kZC76qKqyXyQpo6nndgWEXrluvqgxR2YaOXyTxQNhZRYYXy7EBx
# Z4qVUI2DnZlbs/HG3oJZnsMqHk0W97taKpdTWyMjsztC9Xs/3DINJDSSpoEQZb/7
# mP+cbXEOa7bH4JJfi6HKwRh21hBL+RuSCL4IcQP0NCbb9APXce7hJ546Iwqyqz1A
# t+06Zmfzvw2yDB7HNP130w5aeO7rr+ocKhzc8SuL3x98mYnMYEKxfwN1Wv0aMEIu
# 20p8iO3KH3g23C9xnxvNJ+orYxGr7PhGm/muDFN6MwopqZNvbud55LxXdYKgKxX6
# YucI
# SIG # End signature block
|
PowerShellCorpus/PowerShellGallery/biz.dfch.PS.Appclusive.Client/5.2.1.20161201/Get-ManagementCredential.ps1
|
Get-ManagementCredential.ps1
|
function Get-ManagementCredential {
<#
.SYNOPSIS
Retrieves one or more entities from the ManagementCredential entity set.
.DESCRIPTION
Retrieves one or more entities from the ManagementCredential entity set.
You can retrieve one ore more entities from the entity set by specifying
Id, Name or other properties.
.INPUTS
The Cmdlet can either return all available entities or filter entities on
specified conditions.
See PARAMETERS section on possible inputs.
.OUTPUTS
default | json | json-pretty | xml | xml-pretty | PSCredential
In addition output can be filtered on specified properties.
.EXAMPLE
Get-ManagementCredential -ListAvailable -Select Name
Name
----
myvCenter
ActivitiClientAcct
ServiceBusClientAcct
WindowsAdminAcct
Retrieves the name of all ManagementCredentials.
.EXAMPLE
Get-ManagementCredential 4
Username : Administrator
EncryptedPassword : ***
Id : 4
Tid : 22222222-2222-2222-2222-222222222222
Name : myvCenter
Description : Description of myvCenter
CreatedById : 1
ModifiedById : 1
Created : 01.12.2015 00:00:00 +01:00
Modified : 01.12.2015 00:00:00 +01:00
RowVersion : {0, 0, 0, 0...}
ManagementUris : {}
Tenant :
CreatedBy : SYSTEM
ModifiedBy : SYSTEM
Retrieves the ManagementCredential object with Id 4 and returns all properties of it.
.EXAMPLE
Get-ManagementCredential myvCenter -Select Description -ValueOnly -ConvertFromJson
Description of myvCenter
Retrieves the ManagementCredential 'myvCenter' and only returns the 'Description' property
of it. In addition the contents of the property will be converted from JSON.
.EXAMPLE
Get-ManagementCredential -ListAvailable -Select Name, Id -First 3
Name Id
---- --
myvCenter 4
ActivitiClientAcct 3
ServiceBusClientAcct 8
Retrieves the name and id of the first 3 ManagementCredentials.
.EXAMPLE
Get-ManagementCredential 8 -Select Name -ValueOnly
ServiceBusClientAcct
Retrieves the name of the ManagementCredential with Id 8.
.EXAMPLE
Get-ManagementCredential -ModifiedBy SYSTEM -Select Id, Name
Id Name
-- ----
4 myvCenter
8 ServiceBusClientAcct
Retrieves id and name of all Users that have been modified by user
with name 'SYSTEM' (case insensitive substring match).
.EXAMPLE
Get-ManagementCredential AppclusiveScheduler -Select Value -ValueOnly -DefaultValue 42
42
Retrieves the 'Value' property of a ManagementCredential with Name 'AppclusiveScheduler'
and 42 if the entity is not found.
.LINK
Online Version: http://dfch.biz/biz/dfch/PS/Appclusive/Client/Get-ManagementCredential/
.NOTES
See module manifest for required software versions and dependencies.
#>
[CmdletBinding(
SupportsShouldProcess = $true
,
ConfirmImpact = 'Low'
,
HelpURI = 'http://dfch.biz/biz/dfch/PS/Appclusive/Client/Get-ManagementCredential/'
,
DefaultParameterSetName = 'list'
)]
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidUsingConvertToSecureStringWithPlainText", "")]
PARAM
(
# Specifies an reference object of the entity
[Parameter(Mandatory = $false, ValueFromPipeline = $true, Position = 0, ParameterSetName = 'pipe')]
[biz.dfch.CS.Appclusive.Api.Core.ManagementUri] $InputObject
,
# Specifies the id of the entity
[Parameter(Mandatory = $false, Position = 0, ParameterSetName = 'id')]
[long] $Id
,
# Specifies the name of the entity
[Parameter(Mandatory = $false, Position = 0, ParameterSetName = 'name')]
[Alias('n')]
[string] $Name
,
# Filter by creator
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[string] $CreatedBy
,
# Filter by modifier
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[string] $ModifiedBy
,
# Specify the attributes of the entity to return
[Parameter(Mandatory = $false)]
[string[]] $Select = @()
,
# Specifies to return only values without header information.
# This parameter takes precendes over the 'Select' parameter.
[ValidateScript( { if(1 -eq $Select.Count -And $_) { $true; } else { throw("You must specify exactly one 'Select' property when using 'ValueOnly'."); } } )]
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[Parameter(Mandatory = $false, ParameterSetName = 'id')]
[Alias('HideTableHeaders')]
[switch] $ValueOnly
,
# This value is only returned if the regular search would have returned no results
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[Alias('default')]
$DefaultValue
,
# Specifies to deserialize JSON payloads
[ValidateScript( { if($ValueOnly -And $_) { $true; } else { throw("You must set the 'ValueOnly' switch when using 'ConvertFromJson'."); } } )]
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[Parameter(Mandatory = $false, ParameterSetName = 'id')]
[Alias('Convert')]
[switch] $ConvertFromJson
,
# Limits the output to the specified number of entries
[Parameter(Mandatory = $false)]
[Alias('top')]
[int] $First
,
# Service reference to Appclusive
[Parameter(Mandatory = $false)]
[Alias('Services')]
[hashtable] $svc = (Get-Variable -Name $MyInvocation.MyCommand.Module.PrivateData.MODULEVAR -ValueOnly).Services
,
# Indicates to return all file information
[Parameter(Mandatory = $false, ParameterSetName = 'list')]
[switch] $ListAvailable = $false
,
# Specifies the return format of the Cmdlet
[ValidateSet('default', 'json', 'json-pretty', 'xml', 'xml-pretty', 'PSCredential')]
[Parameter(Mandatory = $false)]
[alias('ReturnFormat')]
[string] $As = 'default'
)
Begin
{
trap { Log-Exception $_; break; }
$datBegin = [datetime]::Now;
[string] $fn = $MyInvocation.MyCommand.Name;
Log-Debug -fn $fn -msg ("CALL. ParameterSetName '{0}'." -f $PSCmdlet.ParameterSetName) -fac 1;
$EntitySetName = 'ManagementCredentials';
# Parameter validation
Contract-Requires ($svc.Core -is [biz.dfch.CS.Appclusive.Api.Core.Core]) "Connect to the server before using the Cmdlet"
if($Select)
{
$Select = $Select | Select -Unique;
}
}
# Begin
Process
{
trap { Log-Exception $_; break; }
# Default test variable for checking function response codes.
[Boolean] $fReturn = $false;
# Return values are always and only returned via OutputParameter.
$OutputParameter = $null;
Contract-Assert ($PSCmdlet.ShouldProcess(($PSBoundParameters | Out-String)))
if($PSCmdlet.ParameterSetName -eq 'pipe')
{
# Get ValueFromPipeline
foreach($Object in $InputObject)
{
if($PSCmdlet.ShouldProcess($Object) -and $Object.ManagementCredentialId)
{
$LimitedParameters = $PSBoundParameters;
$null = $LimitedParameters.Remove("InputObject");
return Get-ManagementCredential -Id $Object.ManagementCredentialId @LimitedParameters;
}
}
return;
}
if($PSCmdlet.ParameterSetName -eq 'list')
{
if($Select)
{
if($PSBoundParameters.ContainsKey('First'))
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$orderby','Name').AddQueryOption('$top', $First) | Select -Property $Select;
}
else
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$orderby','Name') | Select -Property $Select;
}
}
else
{
if($PSBoundParameters.ContainsKey('First'))
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$orderby','Name').AddQueryOption('$top', $First) | Select;
}
else
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$orderby','Name') | Select;
}
}
}
else
{
$Exp = @();
if($PSCmdlet.ParameterSetName -eq 'id')
{
$Exp += ("Id eq {0}L" -f $Id);
}
if($Name)
{
$Exp += ("tolower(Name) eq '{0}'" -f $Name.ToLower());
}
if($CreatedBy)
{
$CreatedById = Get-User -svc $svc -Name $CreatedBy -Select Id -ValueOnly;
if ( !$CreatedById )
{
# User not found
return;
}
$Exp += ("(CreatedById eq {0}L)" -f $CreatedById);
}
if($ModifiedBy)
{
$ModifiedById = Get-User -svc $svc -Name $ModifiedBy -Select Id -ValueOnly;
if ( !$ModifiedById )
{
# User not found
return;
}
$Exp += ("(ModifiedById eq {0}L)" -f $ModifiedById);
}
$FilterExpression = [String]::Join(' and ', $Exp);
if($Select)
{
if($PSBoundParameters.ContainsKey('First'))
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$filter', $FilterExpression).AddQueryOption('$top', $First) | Select -Property $Select;
}
else
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$filter', $FilterExpression) | Select -Property $Select;
}
}
else
{
if($PSBoundParameters.ContainsKey('First'))
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$filter', $FilterExpression).AddQueryOption('$top', $First) | Select;
}
else
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$filter', $FilterExpression) | Select;
}
}
if(1 -eq $Select.Count -And $ValueOnly)
{
$Response = $Response.$Select;
}
if($PSBoundParameters.ContainsKey('DefaultValue') -And !$Response)
{
$Response = $DefaultValue;
}
if($ValueOnly -And $ConvertFromJson)
{
$ResponseTemp = New-Object System.Collections.ArrayList;
foreach($item in $Response)
{
try
{
$null = $ResponseTemp.Add((ConvertFrom-Json -InputObject $item));
}
catch
{
$null = $ResponseTemp.Add($item);
}
}
$Response = $ResponseTemp.ToArray();
}
}
if($As -eq 'PSCredential')
{
$password = $Response.Password | ConvertTo-SecureString -asPlainText -Force;
$credential = New-Object System.Management.Automation.PSCredential($Response.Username, $password);
$OutputParameter = $credential;
}
else
{
$OutputParameter = Format-ResultAs $Response $As
}
$fReturn = $true;
}
# Process
End
{
$datEnd = [datetime]::Now;
Log-Debug -fn $fn -msg ("RET. fReturn: [{0}]. Execution time: [{1}]ms. Started: [{2}]." -f $fReturn, ($datEnd - $datBegin).TotalMilliseconds, $datBegin.ToString('yyyy-MM-dd HH:mm:ss.fffzzz')) -fac 2;
# Return values are always and only returned via OutputParameter.
return $OutputParameter;
}
# End
} # function
if($MyInvocation.ScriptName) { Export-ModuleMember -Function Get-ManagementCredential; }
#
# Copyright 2014-2015 d-fens GmbH
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SIG # Begin signature block
# MIIXDwYJKoZIhvcNAQcCoIIXADCCFvwCAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB
# gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR
# AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQUKFjRh8cMqoABxYyPFibuwR50
# 2yKgghHCMIIEFDCCAvygAwIBAgILBAAAAAABL07hUtcwDQYJKoZIhvcNAQEFBQAw
# VzELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNV
# BAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkdsb2JhbFNpZ24gUm9vdCBDQTAeFw0xMTA0
# MTMxMDAwMDBaFw0yODAxMjgxMjAwMDBaMFIxCzAJBgNVBAYTAkJFMRkwFwYDVQQK
# ExBHbG9iYWxTaWduIG52LXNhMSgwJgYDVQQDEx9HbG9iYWxTaWduIFRpbWVzdGFt
# cGluZyBDQSAtIEcyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAlO9l
# +LVXn6BTDTQG6wkft0cYasvwW+T/J6U00feJGr+esc0SQW5m1IGghYtkWkYvmaCN
# d7HivFzdItdqZ9C76Mp03otPDbBS5ZBb60cO8eefnAuQZT4XljBFcm05oRc2yrmg
# jBtPCBn2gTGtYRakYua0QJ7D/PuV9vu1LpWBmODvxevYAll4d/eq41JrUJEpxfz3
# zZNl0mBhIvIG+zLdFlH6Dv2KMPAXCae78wSuq5DnbN96qfTvxGInX2+ZbTh0qhGL
# 2t/HFEzphbLswn1KJo/nVrqm4M+SU4B09APsaLJgvIQgAIMboe60dAXBKY5i0Eex
# +vBTzBj5Ljv5cH60JQIDAQABo4HlMIHiMA4GA1UdDwEB/wQEAwIBBjASBgNVHRMB
# Af8ECDAGAQH/AgEAMB0GA1UdDgQWBBRG2D7/3OO+/4Pm9IWbsN1q1hSpwTBHBgNV
# HSAEQDA+MDwGBFUdIAAwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93d3cuZ2xvYmFs
# c2lnbi5jb20vcmVwb3NpdG9yeS8wMwYDVR0fBCwwKjAooCagJIYiaHR0cDovL2Ny
# bC5nbG9iYWxzaWduLm5ldC9yb290LmNybDAfBgNVHSMEGDAWgBRge2YaRQ2XyolQ
# L30EzTSo//z9SzANBgkqhkiG9w0BAQUFAAOCAQEATl5WkB5GtNlJMfO7FzkoG8IW
# 3f1B3AkFBJtvsqKa1pkuQJkAVbXqP6UgdtOGNNQXzFU6x4Lu76i6vNgGnxVQ380W
# e1I6AtcZGv2v8Hhc4EvFGN86JB7arLipWAQCBzDbsBJe/jG+8ARI9PBw+DpeVoPP
# PfsNvPTF7ZedudTbpSeE4zibi6c1hkQgpDttpGoLoYP9KOva7yj2zIhd+wo7AKvg
# IeviLzVsD440RZfroveZMzV+y5qKu0VN5z+fwtmK+mWybsd+Zf/okuEsMaL3sCc2
# SI8mbzvuTXYfecPlf5Y1vC0OzAGwjn//UYCAp5LUs0RGZIyHTxZjBzFLY7Df8zCC
# BCkwggMRoAMCAQICCwQAAAAAATGJxjfoMA0GCSqGSIb3DQEBCwUAMEwxIDAeBgNV
# BAsTF0dsb2JhbFNpZ24gUm9vdCBDQSAtIFIzMRMwEQYDVQQKEwpHbG9iYWxTaWdu
# MRMwEQYDVQQDEwpHbG9iYWxTaWduMB4XDTExMDgwMjEwMDAwMFoXDTE5MDgwMjEw
# MDAwMFowWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKPv0Z8p6djTgnY8YqDS
# SdYWHvHP8NC6SEMDLacd8gE0SaQQ6WIT9BP0FoO11VdCSIYrlViH6igEdMtyEQ9h
# JuH6HGEVxyibTQuCDyYrkDqW7aTQaymc9WGI5qRXb+70cNCNF97mZnZfdB5eDFM4
# XZD03zAtGxPReZhUGks4BPQHxCMD05LL94BdqpxWBkQtQUxItC3sNZKaxpXX9c6Q
# MeJ2s2G48XVXQqw7zivIkEnotybPuwyJy9DDo2qhydXjnFMrVyb+Vpp2/WFGomDs
# KUZH8s3ggmLGBFrn7U5AXEgGfZ1f53TJnoRlDVve3NMkHLQUEeurv8QfpLqZ0BdY
# Nc0CAwEAAaOB/TCB+jAOBgNVHQ8BAf8EBAMCAQYwEgYDVR0TAQH/BAgwBgEB/wIB
# ADAdBgNVHQ4EFgQUGUq4WuRNMaUU5V7sL6Mc+oCMMmswRwYDVR0gBEAwPjA8BgRV
# HSAAMDQwMgYIKwYBBQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3Jl
# cG9zaXRvcnkvMDYGA1UdHwQvMC0wK6ApoCeGJWh0dHA6Ly9jcmwuZ2xvYmFsc2ln
# bi5uZXQvcm9vdC1yMy5jcmwwEwYDVR0lBAwwCgYIKwYBBQUHAwMwHwYDVR0jBBgw
# FoAUj/BLf6guRSSuTVD6Y5qL3uLdG7wwDQYJKoZIhvcNAQELBQADggEBAHmwaTTi
# BYf2/tRgLC+GeTQD4LEHkwyEXPnk3GzPbrXsCly6C9BoMS4/ZL0Pgmtmd4F/ximl
# F9jwiU2DJBH2bv6d4UgKKKDieySApOzCmgDXsG1szYjVFXjPE/mIpXNNwTYr3MvO
# 23580ovvL72zT006rbtibiiTxAzL2ebK4BEClAOwvT+UKFaQHlPCJ9XJPM0aYx6C
# WRW2QMqngarDVa8z0bV16AnqRwhIIvtdG/Mseml+xddaXlYzPK1X6JMlQsPSXnE7
# ShxU7alVrCgFx8RsXdw8k/ZpPIJRzhoVPV4Bc/9Aouq0rtOO+u5dbEfHQfXUVlfy
# GDcy1tTMS/Zx4HYwggSfMIIDh6ADAgECAhIRIdaZp2SXPvH4Qn7pGcxTQRQwDQYJ
# KoZIhvcNAQEFBQAwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24g
# bnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzIw
# HhcNMTYwNTI0MDAwMDAwWhcNMjcwNjI0MDAwMDAwWjBgMQswCQYDVQQGEwJTRzEf
# MB0GA1UEChMWR01PIEdsb2JhbFNpZ24gUHRlIEx0ZDEwMC4GA1UEAxMnR2xvYmFs
# U2lnbiBUU0EgZm9yIE1TIEF1dGhlbnRpY29kZSAtIEcyMIIBIjANBgkqhkiG9w0B
# AQEFAAOCAQ8AMIIBCgKCAQEAsBeuotO2BDBWHlgPse1VpNZUy9j2czrsXV6rJf02
# pfqEw2FAxUa1WVI7QqIuXxNiEKlb5nPWkiWxfSPjBrOHOg5D8NcAiVOiETFSKG5d
# QHI88gl3p0mSl9RskKB2p/243LOd8gdgLE9YmABr0xVU4Prd/4AsXximmP/Uq+yh
# RVmyLm9iXeDZGayLV5yoJivZF6UQ0kcIGnAsM4t/aIAqtaFda92NAgIpA6p8N7u7
# KU49U5OzpvqP0liTFUy5LauAo6Ml+6/3CGSwekQPXBDXX2E3qk5r09JTJZ2Cc/os
# +XKwqRk5KlD6qdA8OsroW+/1X1H0+QrZlzXeaoXmIwRCrwIDAQABo4IBXzCCAVsw
# DgYDVR0PAQH/BAQDAgeAMEwGA1UdIARFMEMwQQYJKwYBBAGgMgEeMDQwMgYIKwYB
# BQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3JlcG9zaXRvcnkvMAkG
# A1UdEwQCMAAwFgYDVR0lAQH/BAwwCgYIKwYBBQUHAwgwQgYDVR0fBDswOTA3oDWg
# M4YxaHR0cDovL2NybC5nbG9iYWxzaWduLmNvbS9ncy9nc3RpbWVzdGFtcGluZ2cy
# LmNybDBUBggrBgEFBQcBAQRIMEYwRAYIKwYBBQUHMAKGOGh0dHA6Ly9zZWN1cmUu
# Z2xvYmFsc2lnbi5jb20vY2FjZXJ0L2dzdGltZXN0YW1waW5nZzIuY3J0MB0GA1Ud
# DgQWBBTUooRKOFoYf7pPMFC9ndV6h9YJ9zAfBgNVHSMEGDAWgBRG2D7/3OO+/4Pm
# 9IWbsN1q1hSpwTANBgkqhkiG9w0BAQUFAAOCAQEAj6kakW0EpjcgDoOW3iPTa24f
# bt1kPWghIrX4RzZpjuGlRcckoiK3KQnMVFquxrzNY46zPVBI5bTMrs2SjZ4oixNK
# Eaq9o+/Tsjb8tKFyv22XY3mMRLxwL37zvN2CU6sa9uv6HJe8tjecpBwwvKu8LUc2
# 35IgA+hxxlj2dQWaNPALWVqCRDSqgOQvhPZHXZbJtsrKnbemuuRQ09Q3uLogDtDT
# kipbxFm7oW3bPM5EncE4Kq3jjb3NCXcaEL5nCgI2ZIi5sxsm7ueeYMRGqLxhM2zP
# TrmcuWrwnzf+tT1PmtNN/94gjk6Xpv2fCbxNyhh2ybBNhVDygNIdBvVYBAexGDCC
# BNYwggO+oAMCAQICEhEhDRayW4wRltP+V8mGEea62TANBgkqhkiG9w0BAQsFADBa
# MQswCQYDVQQGEwJCRTEZMBcGA1UEChMQR2xvYmFsU2lnbiBudi1zYTEwMC4GA1UE
# AxMnR2xvYmFsU2lnbiBDb2RlU2lnbmluZyBDQSAtIFNIQTI1NiAtIEcyMB4XDTE1
# MDUwNDE2NDMyMVoXDTE4MDUwNDE2NDMyMVowVTELMAkGA1UEBhMCQ0gxDDAKBgNV
# BAgTA1p1ZzEMMAoGA1UEBxMDWnVnMRQwEgYDVQQKEwtkLWZlbnMgR21iSDEUMBIG
# A1UEAxMLZC1mZW5zIEdtYkgwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB
# AQDNPSzSNPylU9jFM78Q/GjzB7N+VNqikf/use7p8mpnBZ4cf5b4qV3rqQd62rJH
# RlAsxgouCSNQrl8xxfg6/t/I02kPvrzsR4xnDgMiVCqVRAeQsWebafWdTvWmONBS
# lxJejPP8TSgXMKFaDa+2HleTycTBYSoErAZSWpQ0NqF9zBadjsJRVatQuPkTDrwL
# eWibiyOipK9fcNoQpl5ll5H9EG668YJR3fqX9o0TQTkOmxXIL3IJ0UxdpyDpLEkt
# tBG6Y5wAdpF2dQX2phrfFNVY54JOGtuBkNGMSiLFzTkBA1fOlA6ICMYjB8xIFxVv
# rN1tYojCrqYkKMOjwWQz5X8zAgMBAAGjggGZMIIBlTAOBgNVHQ8BAf8EBAMCB4Aw
# TAYDVR0gBEUwQzBBBgkrBgEEAaAyATIwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93
# d3cuZ2xvYmFsc2lnbi5jb20vcmVwb3NpdG9yeS8wCQYDVR0TBAIwADATBgNVHSUE
# DDAKBggrBgEFBQcDAzBCBgNVHR8EOzA5MDegNaAzhjFodHRwOi8vY3JsLmdsb2Jh
# bHNpZ24uY29tL2dzL2dzY29kZXNpZ25zaGEyZzIuY3JsMIGQBggrBgEFBQcBAQSB
# gzCBgDBEBggrBgEFBQcwAoY4aHR0cDovL3NlY3VyZS5nbG9iYWxzaWduLmNvbS9j
# YWNlcnQvZ3Njb2Rlc2lnbnNoYTJnMi5jcnQwOAYIKwYBBQUHMAGGLGh0dHA6Ly9v
# Y3NwMi5nbG9iYWxzaWduLmNvbS9nc2NvZGVzaWduc2hhMmcyMB0GA1UdDgQWBBTN
# GDddiIYZy9p3Z84iSIMd27rtUDAfBgNVHSMEGDAWgBQZSrha5E0xpRTlXuwvoxz6
# gIwyazANBgkqhkiG9w0BAQsFAAOCAQEAAApsOzSX1alF00fTeijB/aIthO3UB0ks
# 1Gg3xoKQC1iEQmFG/qlFLiufs52kRPN7L0a7ClNH3iQpaH5IEaUENT9cNEXdKTBG
# 8OrJS8lrDJXImgNEgtSwz0B40h7bM2Z+0DvXDvpmfyM2NwHF/nNVj7NzmczrLRqN
# 9de3tV0pgRqnIYordVcmb24CZl3bzpwzbQQy14Iz+P5Z2cnw+QaYzAuweTZxEUcJ
# bFwpM49c1LMPFJTuOKkUgY90JJ3gVTpyQxfkc7DNBnx74PlRzjFmeGC/hxQt0hvo
# eaAiBdjo/1uuCTToigVnyRH+c0T2AezTeoFb7ne3I538hWeTdU5q9jGCBLcwggSz
# AgEBMHAwWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MgISESENFrJbjBGW0/5XyYYR5rrZMAkGBSsOAwIaBQCgeDAYBgorBgEEAYI3AgEM
# MQowCKACgAChAoAAMBkGCSqGSIb3DQEJAzEMBgorBgEEAYI3AgEEMBwGCisGAQQB
# gjcCAQsxDjAMBgorBgEEAYI3AgEVMCMGCSqGSIb3DQEJBDEWBBTlmC2SCf93c5Rj
# nxIqe3xTUv/Y8jANBgkqhkiG9w0BAQEFAASCAQAQ2cDuOgA0LeJTu+mmufxAblGI
# 0XcsyuFQcpopXg0oOxW1rfF6g4T6vQRQ1q/0tpeX2DKHOXQI2upoDJPcBIzpQg5x
# 3Vbl8Oo6YtFzGZlAMw43yA/trMtMX0c1NGDE2jclTcir2eSH3BMYgnfOukALnjNB
# SOKux6swsk1DZnmikJoLt79q7YQg20dvuecm2Iq7EX4UkVQQd7TXBLp3JnoUUHab
# Cb7yN7Wt8UKrRBGO/G7+li0mU0DL4gl/bA0ZFMftCMjSE5lWagToMVMpNFrqzl9W
# 42jSjp4dHm2tcBkx4ZrXHTehkIg35QbXx99w+nMZXtb4SaTGyCcdGV06zNvAoYIC
# ojCCAp4GCSqGSIb3DQEJBjGCAo8wggKLAgEBMGgwUjELMAkGA1UEBhMCQkUxGTAX
# BgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGlt
# ZXN0YW1waW5nIENBIC0gRzICEhEh1pmnZJc+8fhCfukZzFNBFDAJBgUrDgMCGgUA
# oIH9MBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTE2
# MDgzMTE5MTY0M1owIwYJKoZIhvcNAQkEMRYEFI9/R1s8dRnBX1ax83bZrbupkkN2
# MIGdBgsqhkiG9w0BCRACDDGBjTCBijCBhzCBhAQUY7gvq2H1g5CWlQULACScUCkz
# 7HkwbDBWpFQwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYt
# c2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzICEhEh
# 1pmnZJc+8fhCfukZzFNBFDANBgkqhkiG9w0BAQEFAASCAQBWCSDK0SyvOhO/nGs4
# 9FCX7PVMYHlJCUTy2EF+0a9VTqyR49Gjk+Jm97f3Bvk6y9tjxhsaS4dxXx6UZdGu
# SvlBy+PzSlQjx9b2NNKR7oT2ETmom3eacxQRcW7QCOijBFdq8Eot2lmvYjULMm9/
# j4nMGPl8IAkmM4+YMsdOq57BTfQqMapCzZAHvw9Crve623xpc+oUPrIZNldDG+IW
# h12Qj7ZPJVEEg25nAaKaSctQDIp4z6fVGC+ettqqCV+renLmaQhMJafX9LADxnYW
# riFZpaODU2bWsyogmjHzAmSublzK0NpjYuEO8PYb7oOnFQk4/ZblHivXpLzUj1jA
# yuDu
# SIG # End signature block
|
PowerShellCorpus/PowerShellGallery/biz.dfch.PS.Appclusive.Client/5.2.1.20161201/New-ManagementCredential.ps1
|
New-ManagementCredential.ps1
|
function New-ManagementCredential {
<#
.SYNOPSIS
Creates a ManagementCredential entry in Appclusive.
.DESCRIPTION
Creates a ManagementCredential entry in Appclusive.
You must specify all three parameters 'Name', 'Username' and 'Password'. If the entry already exists no update of the existing entry is performed.
.OUTPUTS
[biz.dfch.CS.Appclusive.Api.Core.ManagementCredential]
.EXAMPLE
New-ManagementCredential myName myUserName myPassword
Username : myUserName
EncryptedPassword : ***
Id : 4
Tid : 22222222-2222-2222-2222-222222222222
Name : myName
Description :
CreatedById : 1
ModifiedById : 1
Created : 01.12.2015 00:00:00 +01:00
Modified : 01.12.2015 00:00:00 +01:00
RowVersion : {0, 0, 0, 0...}
ManagementUris : {}
Tenant :
CreatedBy : SYSTEM
ModifiedBy : SYSTEM
Create a new ManagementCredential entry if it not already exists.
.EXAMPLE
New-ManagementCredential -Name myName -Username myUserName -Password myPassword -Description myDescription
Username : myUserName
EncryptedPassword : ***
Id : 4
Tid : 22222222-2222-2222-2222-222222222222
Name : myName
Description : myDescription
CreatedById : 1
ModifiedById : 1
Created : 01.12.2015 00:00:00 +01:00
Modified : 01.12.2015 00:00:00 +01:00
RowVersion : {0, 0, 0, 0...}
ManagementUris : {}
Tenant :
CreatedBy : SYSTEM
ModifiedBy : SYSTEM
Create a new ManagementCredential entry if it not already exists.
.LINK
Online Version: http://dfch.biz/biz/dfch/PS/Appclusive/Client/New-ManagementCredential/
Set-ManagementCredential: http://dfch.biz/biz/dfch/PS/Appclusive/Client/Set-ManagementCredential/
.NOTES
See module manifest for dependencies and further requirements.
#>
[CmdletBinding(
SupportsShouldProcess = $true
,
ConfirmImpact = 'Low'
,
HelpURI = 'http://dfch.biz/biz/dfch/PS/Appclusive/Client/New-ManagementCredential/'
)]
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidUsingUserNameAndPassWordParams", "")]
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidUsingPlainTextForPassword", "")]
Param
(
# Specifies the name for this entity
[Parameter(Mandatory = $true, Position = 0)]
[ValidateNotNullOrEmpty()]
[string] $Name
,
# Specifies the key for this entity
[Parameter(Mandatory = $true, Position = 1)]
[ValidateNotNullOrEmpty()]
[string] $Username
,
# Specifies the key for this entity
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidUsingUserNameAndPassWordParams", "Password")]
[Parameter(Mandatory = $true, Position = 2)]
[ValidateNotNullOrEmpty()]
[string] $Password
,
# Specifies the description for this entity
[Parameter(Mandatory = $false)]
[string] $Description
,
# Service reference to Appclusive
[Parameter(Mandatory = $false)]
[Alias('Services')]
[hashtable] $svc = (Get-Variable -Name $MyInvocation.MyCommand.Module.PrivateData.MODULEVAR -ValueOnly).Services
)
Begin
{
trap { Log-Exception $_; break; }
$datBegin = [datetime]::Now;
[string] $fn = $MyInvocation.MyCommand.Name;
Log-Debug -fn $fn -msg ("CALL. svc '{0}'. Name '{1}'." -f ($svc -is [Object]), $Name) -fac 1;
# Parameter validation
Contract-Requires ($svc.Core -is [biz.dfch.CS.Appclusive.Api.Core.Core]) "Connect to the server before using the Cmdlet"
}
# Begin
Process
{
trap { Log-Exception $_; break; }
# Default test variable for checking function response codes.
[Boolean] $fReturn = $false;
# Return values are always and only returned via OutputParameter.
$OutputParameter = $null;
$ManagementCredentialContents = @($Name);
$FilterExpression = "(tolower(Name) eq '{0}')" -f $Name.toLower();
$entity = $svc.Core.ManagementCredentials.AddQueryOption('$filter', $FilterExpression).AddQueryOption('$top',1) | Select;
Contract-Assert (!$entity) 'Entity does already exist'
if($PSCmdlet.ShouldProcess($ManagementCredentialContents))
{
$r = Set-ManagementCredential -Name $Name -Username $Username -Password $Password -Description $Description -CreateIfNotExist:$true -svc $svc;
$OutputParameter = $r;
}
$fReturn = $true;
}
# Process
End
{
$datEnd = [datetime]::Now;
Log-Debug -fn $fn -msg ("RET. fReturn: [{0}]. Execution time: [{1}]ms. Started: [{2}]." -f $fReturn, ($datEnd - $datBegin).TotalMilliseconds, $datBegin.ToString('yyyy-MM-dd HH:mm:ss.fffzzz')) -fac 2;
# Return values are always and only returned via OutputParameter.
return $OutputParameter;
}
# End
}
if($MyInvocation.ScriptName) { Export-ModuleMember -Function New-ManagementCredential; }
#
# Copyright 2014-2015 d-fens GmbH
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SIG # Begin signature block
# MIIXDwYJKoZIhvcNAQcCoIIXADCCFvwCAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB
# gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR
# AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQUCPpzEkFYLK8yrZtmfNPiBTkv
# oTKgghHCMIIEFDCCAvygAwIBAgILBAAAAAABL07hUtcwDQYJKoZIhvcNAQEFBQAw
# VzELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNV
# BAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkdsb2JhbFNpZ24gUm9vdCBDQTAeFw0xMTA0
# MTMxMDAwMDBaFw0yODAxMjgxMjAwMDBaMFIxCzAJBgNVBAYTAkJFMRkwFwYDVQQK
# ExBHbG9iYWxTaWduIG52LXNhMSgwJgYDVQQDEx9HbG9iYWxTaWduIFRpbWVzdGFt
# cGluZyBDQSAtIEcyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAlO9l
# +LVXn6BTDTQG6wkft0cYasvwW+T/J6U00feJGr+esc0SQW5m1IGghYtkWkYvmaCN
# d7HivFzdItdqZ9C76Mp03otPDbBS5ZBb60cO8eefnAuQZT4XljBFcm05oRc2yrmg
# jBtPCBn2gTGtYRakYua0QJ7D/PuV9vu1LpWBmODvxevYAll4d/eq41JrUJEpxfz3
# zZNl0mBhIvIG+zLdFlH6Dv2KMPAXCae78wSuq5DnbN96qfTvxGInX2+ZbTh0qhGL
# 2t/HFEzphbLswn1KJo/nVrqm4M+SU4B09APsaLJgvIQgAIMboe60dAXBKY5i0Eex
# +vBTzBj5Ljv5cH60JQIDAQABo4HlMIHiMA4GA1UdDwEB/wQEAwIBBjASBgNVHRMB
# Af8ECDAGAQH/AgEAMB0GA1UdDgQWBBRG2D7/3OO+/4Pm9IWbsN1q1hSpwTBHBgNV
# HSAEQDA+MDwGBFUdIAAwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93d3cuZ2xvYmFs
# c2lnbi5jb20vcmVwb3NpdG9yeS8wMwYDVR0fBCwwKjAooCagJIYiaHR0cDovL2Ny
# bC5nbG9iYWxzaWduLm5ldC9yb290LmNybDAfBgNVHSMEGDAWgBRge2YaRQ2XyolQ
# L30EzTSo//z9SzANBgkqhkiG9w0BAQUFAAOCAQEATl5WkB5GtNlJMfO7FzkoG8IW
# 3f1B3AkFBJtvsqKa1pkuQJkAVbXqP6UgdtOGNNQXzFU6x4Lu76i6vNgGnxVQ380W
# e1I6AtcZGv2v8Hhc4EvFGN86JB7arLipWAQCBzDbsBJe/jG+8ARI9PBw+DpeVoPP
# PfsNvPTF7ZedudTbpSeE4zibi6c1hkQgpDttpGoLoYP9KOva7yj2zIhd+wo7AKvg
# IeviLzVsD440RZfroveZMzV+y5qKu0VN5z+fwtmK+mWybsd+Zf/okuEsMaL3sCc2
# SI8mbzvuTXYfecPlf5Y1vC0OzAGwjn//UYCAp5LUs0RGZIyHTxZjBzFLY7Df8zCC
# BCkwggMRoAMCAQICCwQAAAAAATGJxjfoMA0GCSqGSIb3DQEBCwUAMEwxIDAeBgNV
# BAsTF0dsb2JhbFNpZ24gUm9vdCBDQSAtIFIzMRMwEQYDVQQKEwpHbG9iYWxTaWdu
# MRMwEQYDVQQDEwpHbG9iYWxTaWduMB4XDTExMDgwMjEwMDAwMFoXDTE5MDgwMjEw
# MDAwMFowWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKPv0Z8p6djTgnY8YqDS
# SdYWHvHP8NC6SEMDLacd8gE0SaQQ6WIT9BP0FoO11VdCSIYrlViH6igEdMtyEQ9h
# JuH6HGEVxyibTQuCDyYrkDqW7aTQaymc9WGI5qRXb+70cNCNF97mZnZfdB5eDFM4
# XZD03zAtGxPReZhUGks4BPQHxCMD05LL94BdqpxWBkQtQUxItC3sNZKaxpXX9c6Q
# MeJ2s2G48XVXQqw7zivIkEnotybPuwyJy9DDo2qhydXjnFMrVyb+Vpp2/WFGomDs
# KUZH8s3ggmLGBFrn7U5AXEgGfZ1f53TJnoRlDVve3NMkHLQUEeurv8QfpLqZ0BdY
# Nc0CAwEAAaOB/TCB+jAOBgNVHQ8BAf8EBAMCAQYwEgYDVR0TAQH/BAgwBgEB/wIB
# ADAdBgNVHQ4EFgQUGUq4WuRNMaUU5V7sL6Mc+oCMMmswRwYDVR0gBEAwPjA8BgRV
# HSAAMDQwMgYIKwYBBQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3Jl
# cG9zaXRvcnkvMDYGA1UdHwQvMC0wK6ApoCeGJWh0dHA6Ly9jcmwuZ2xvYmFsc2ln
# bi5uZXQvcm9vdC1yMy5jcmwwEwYDVR0lBAwwCgYIKwYBBQUHAwMwHwYDVR0jBBgw
# FoAUj/BLf6guRSSuTVD6Y5qL3uLdG7wwDQYJKoZIhvcNAQELBQADggEBAHmwaTTi
# BYf2/tRgLC+GeTQD4LEHkwyEXPnk3GzPbrXsCly6C9BoMS4/ZL0Pgmtmd4F/ximl
# F9jwiU2DJBH2bv6d4UgKKKDieySApOzCmgDXsG1szYjVFXjPE/mIpXNNwTYr3MvO
# 23580ovvL72zT006rbtibiiTxAzL2ebK4BEClAOwvT+UKFaQHlPCJ9XJPM0aYx6C
# WRW2QMqngarDVa8z0bV16AnqRwhIIvtdG/Mseml+xddaXlYzPK1X6JMlQsPSXnE7
# ShxU7alVrCgFx8RsXdw8k/ZpPIJRzhoVPV4Bc/9Aouq0rtOO+u5dbEfHQfXUVlfy
# GDcy1tTMS/Zx4HYwggSfMIIDh6ADAgECAhIRIdaZp2SXPvH4Qn7pGcxTQRQwDQYJ
# KoZIhvcNAQEFBQAwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24g
# bnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzIw
# HhcNMTYwNTI0MDAwMDAwWhcNMjcwNjI0MDAwMDAwWjBgMQswCQYDVQQGEwJTRzEf
# MB0GA1UEChMWR01PIEdsb2JhbFNpZ24gUHRlIEx0ZDEwMC4GA1UEAxMnR2xvYmFs
# U2lnbiBUU0EgZm9yIE1TIEF1dGhlbnRpY29kZSAtIEcyMIIBIjANBgkqhkiG9w0B
# AQEFAAOCAQ8AMIIBCgKCAQEAsBeuotO2BDBWHlgPse1VpNZUy9j2czrsXV6rJf02
# pfqEw2FAxUa1WVI7QqIuXxNiEKlb5nPWkiWxfSPjBrOHOg5D8NcAiVOiETFSKG5d
# QHI88gl3p0mSl9RskKB2p/243LOd8gdgLE9YmABr0xVU4Prd/4AsXximmP/Uq+yh
# RVmyLm9iXeDZGayLV5yoJivZF6UQ0kcIGnAsM4t/aIAqtaFda92NAgIpA6p8N7u7
# KU49U5OzpvqP0liTFUy5LauAo6Ml+6/3CGSwekQPXBDXX2E3qk5r09JTJZ2Cc/os
# +XKwqRk5KlD6qdA8OsroW+/1X1H0+QrZlzXeaoXmIwRCrwIDAQABo4IBXzCCAVsw
# DgYDVR0PAQH/BAQDAgeAMEwGA1UdIARFMEMwQQYJKwYBBAGgMgEeMDQwMgYIKwYB
# BQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3JlcG9zaXRvcnkvMAkG
# A1UdEwQCMAAwFgYDVR0lAQH/BAwwCgYIKwYBBQUHAwgwQgYDVR0fBDswOTA3oDWg
# M4YxaHR0cDovL2NybC5nbG9iYWxzaWduLmNvbS9ncy9nc3RpbWVzdGFtcGluZ2cy
# LmNybDBUBggrBgEFBQcBAQRIMEYwRAYIKwYBBQUHMAKGOGh0dHA6Ly9zZWN1cmUu
# Z2xvYmFsc2lnbi5jb20vY2FjZXJ0L2dzdGltZXN0YW1waW5nZzIuY3J0MB0GA1Ud
# DgQWBBTUooRKOFoYf7pPMFC9ndV6h9YJ9zAfBgNVHSMEGDAWgBRG2D7/3OO+/4Pm
# 9IWbsN1q1hSpwTANBgkqhkiG9w0BAQUFAAOCAQEAj6kakW0EpjcgDoOW3iPTa24f
# bt1kPWghIrX4RzZpjuGlRcckoiK3KQnMVFquxrzNY46zPVBI5bTMrs2SjZ4oixNK
# Eaq9o+/Tsjb8tKFyv22XY3mMRLxwL37zvN2CU6sa9uv6HJe8tjecpBwwvKu8LUc2
# 35IgA+hxxlj2dQWaNPALWVqCRDSqgOQvhPZHXZbJtsrKnbemuuRQ09Q3uLogDtDT
# kipbxFm7oW3bPM5EncE4Kq3jjb3NCXcaEL5nCgI2ZIi5sxsm7ueeYMRGqLxhM2zP
# TrmcuWrwnzf+tT1PmtNN/94gjk6Xpv2fCbxNyhh2ybBNhVDygNIdBvVYBAexGDCC
# BNYwggO+oAMCAQICEhEhDRayW4wRltP+V8mGEea62TANBgkqhkiG9w0BAQsFADBa
# MQswCQYDVQQGEwJCRTEZMBcGA1UEChMQR2xvYmFsU2lnbiBudi1zYTEwMC4GA1UE
# AxMnR2xvYmFsU2lnbiBDb2RlU2lnbmluZyBDQSAtIFNIQTI1NiAtIEcyMB4XDTE1
# MDUwNDE2NDMyMVoXDTE4MDUwNDE2NDMyMVowVTELMAkGA1UEBhMCQ0gxDDAKBgNV
# BAgTA1p1ZzEMMAoGA1UEBxMDWnVnMRQwEgYDVQQKEwtkLWZlbnMgR21iSDEUMBIG
# A1UEAxMLZC1mZW5zIEdtYkgwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB
# AQDNPSzSNPylU9jFM78Q/GjzB7N+VNqikf/use7p8mpnBZ4cf5b4qV3rqQd62rJH
# RlAsxgouCSNQrl8xxfg6/t/I02kPvrzsR4xnDgMiVCqVRAeQsWebafWdTvWmONBS
# lxJejPP8TSgXMKFaDa+2HleTycTBYSoErAZSWpQ0NqF9zBadjsJRVatQuPkTDrwL
# eWibiyOipK9fcNoQpl5ll5H9EG668YJR3fqX9o0TQTkOmxXIL3IJ0UxdpyDpLEkt
# tBG6Y5wAdpF2dQX2phrfFNVY54JOGtuBkNGMSiLFzTkBA1fOlA6ICMYjB8xIFxVv
# rN1tYojCrqYkKMOjwWQz5X8zAgMBAAGjggGZMIIBlTAOBgNVHQ8BAf8EBAMCB4Aw
# TAYDVR0gBEUwQzBBBgkrBgEEAaAyATIwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93
# d3cuZ2xvYmFsc2lnbi5jb20vcmVwb3NpdG9yeS8wCQYDVR0TBAIwADATBgNVHSUE
# DDAKBggrBgEFBQcDAzBCBgNVHR8EOzA5MDegNaAzhjFodHRwOi8vY3JsLmdsb2Jh
# bHNpZ24uY29tL2dzL2dzY29kZXNpZ25zaGEyZzIuY3JsMIGQBggrBgEFBQcBAQSB
# gzCBgDBEBggrBgEFBQcwAoY4aHR0cDovL3NlY3VyZS5nbG9iYWxzaWduLmNvbS9j
# YWNlcnQvZ3Njb2Rlc2lnbnNoYTJnMi5jcnQwOAYIKwYBBQUHMAGGLGh0dHA6Ly9v
# Y3NwMi5nbG9iYWxzaWduLmNvbS9nc2NvZGVzaWduc2hhMmcyMB0GA1UdDgQWBBTN
# GDddiIYZy9p3Z84iSIMd27rtUDAfBgNVHSMEGDAWgBQZSrha5E0xpRTlXuwvoxz6
# gIwyazANBgkqhkiG9w0BAQsFAAOCAQEAAApsOzSX1alF00fTeijB/aIthO3UB0ks
# 1Gg3xoKQC1iEQmFG/qlFLiufs52kRPN7L0a7ClNH3iQpaH5IEaUENT9cNEXdKTBG
# 8OrJS8lrDJXImgNEgtSwz0B40h7bM2Z+0DvXDvpmfyM2NwHF/nNVj7NzmczrLRqN
# 9de3tV0pgRqnIYordVcmb24CZl3bzpwzbQQy14Iz+P5Z2cnw+QaYzAuweTZxEUcJ
# bFwpM49c1LMPFJTuOKkUgY90JJ3gVTpyQxfkc7DNBnx74PlRzjFmeGC/hxQt0hvo
# eaAiBdjo/1uuCTToigVnyRH+c0T2AezTeoFb7ne3I538hWeTdU5q9jGCBLcwggSz
# AgEBMHAwWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MgISESENFrJbjBGW0/5XyYYR5rrZMAkGBSsOAwIaBQCgeDAYBgorBgEEAYI3AgEM
# MQowCKACgAChAoAAMBkGCSqGSIb3DQEJAzEMBgorBgEEAYI3AgEEMBwGCisGAQQB
# gjcCAQsxDjAMBgorBgEEAYI3AgEVMCMGCSqGSIb3DQEJBDEWBBRfgKUL/l/4CKUO
# da07xSdT5dqALDANBgkqhkiG9w0BAQEFAASCAQCqupASTmBvgLVuudpL3F6MoeNi
# 7CfER9rEgsy05Xc4w8IYc6xh64VK1emMFh/23B7lOKP98jkS4Mi4Em/pG6uw37+Q
# mTZtf5NFvhqBHOMABUHsGHaC6EuUnwPTBhUSM5ZyrenCD+HvrQP/L35beF1Ag1iM
# t/8WygmuNH0H0EARQ77eNHo49zrmNyywqKofp/6R6Eq7cfS2h31diskYIvHdd2s8
# hkGRJBSCaOvKjcUe/9oGDLBUjjwv+V6KGEcN0yfU6ZbsiznlJUo/p1I2e1tfMp/J
# 58EnBoFt7KbNEm30FvncBviXY73l5ufFlEnx+txL23R6UetqvTAFkKql2cTboYIC
# ojCCAp4GCSqGSIb3DQEJBjGCAo8wggKLAgEBMGgwUjELMAkGA1UEBhMCQkUxGTAX
# BgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGlt
# ZXN0YW1waW5nIENBIC0gRzICEhEh1pmnZJc+8fhCfukZzFNBFDAJBgUrDgMCGgUA
# oIH9MBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTE2
# MDgzMTE5MTY1NFowIwYJKoZIhvcNAQkEMRYEFAFbMKDvhjLc3rPEGI4aqGflnvfI
# MIGdBgsqhkiG9w0BCRACDDGBjTCBijCBhzCBhAQUY7gvq2H1g5CWlQULACScUCkz
# 7HkwbDBWpFQwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYt
# c2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzICEhEh
# 1pmnZJc+8fhCfukZzFNBFDANBgkqhkiG9w0BAQEFAASCAQAFCVULlqPAc3gZC+ET
# QJMMifVy4UsEkmLF9Lm3aRkOo3GN9SpcY8UOiJuvzsbjfSGRV2XkKbcu4C1nD/K9
# 6iLP6+HmVRoTaBIwNYO+Sq5h71XEuJv03RtbPpNW01t8sfuDMzf8LVE86EPjeASU
# 1jShRmVkFGrHsXasd+1D755ZKBqLZAnCagCApU+sTZse1e/0fHrCsEfGOfI+81fY
# 8JASGgE+Epy90ghiPfbLhw+gg+427YnfewUmF+mYuz2AsAy8QCm9sPOrljvEXLnE
# vabUA9b96bXyvZ4x8nWn0Hd83ZyLFmYvs9m2a4jmI32m9XYTzInTncdSXPpyrUjt
# +vY8
# SIG # End signature block
|
PowerShellCorpus/PowerShellGallery/biz.dfch.PS.Appclusive.Client/5.2.1.20161201/Set-SessionTenant.ps1
|
Set-SessionTenant.ps1
|
function Set-SessionTenant {
<#
.SYNOPSIS
Sets the tenant id for the current session, so all CRUD operations are performed under this tenant.
.DESCRIPTION
Sets the tenant id for the current session, so all CRUD operations are performed under this tenant.
By default all operations are performed under the home tenant of the caller. To change this, you can set the tenant id for the current session. From there on all CRUD operations are performed under this tenant.
In addition to setting a tenant id, the caller must have actual permissions to operate under that tenant. This means that setting of the tenant id may succeed. But subsequent operations may fail due to insufficient permissions of the caller.
.INPUTS
The tenant id as a GUID
.OUTPUTS
Retuns the tenant entity of the id specified. Throws an error if the tenant id could not be found or the caller did not have permission to view the tenant.
default | json | json-pretty | xml | xml-pretty
.EXAMPLE
#In this example we set the tenant id to an id where the caller has permissions to read the tenant. The result is the entity represented by the tenant id.
PS > Set-SessionTenant cb62d4c5-a354-408f-8658-1eb944762dec
Id : cb62d4c5-a354-408f-8658-1eb944762dec
Name : Fantabulous
Description : A supercalifragilisticexpialidocius tenant, but shorter and easier to spell.
ExternalId : bd16aeab-f354-43b4-9da9-60a1d64a15d0
ExternalType : External
CreatedById : 1
ModifiedById : 1
Created : 3/7/2016 12:00:00 AM +01:00
Modified : 7/15/2016 4:33:24 PM +02:00
RowVersion : {0, 0, 0, 0...}
ParentId : 5d31dbbd-d09c-4881-83b3-412d82ba84e5
CustomerId :
Parent :
Customer :
Children : {}
.EXAMPLE
# Setting in invalid tenant id will result in an exception being raised.
PS > Set-SessionTenant deaddead-dead-dead-dead-deaddeaddead
WARNING: : Assertion failed: (!!$tenant) "Tenant not found"
.LINK
Online Version: http://dfch.biz/biz/dfch/PS/Appclusive/Client/Set-SessionTenant/
.NOTES
See module manifest for required software versions and dependencies.
#>
[CmdletBinding(
SupportsShouldProcess = $false
,
ConfirmImpact = 'Low'
,
HelpURI = 'http://dfch.biz/biz/dfch/PS/Appclusive/Client/Set-SessionTenant/'
,
DefaultParameterSetName = 'id'
)]
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseShouldProcessForStateChangingFunctions", "")]
PARAM
(
# Specifies the tenant guid to set for this session
[Parameter(Mandatory = $true, Position = 0, ParameterSetName = 'id')]
[Alias("Tid")]
[Alias("TenantId")]
[ValidateNotNullOrEmpty()]
[string] $Id
,
[ValidateSet('Biz-Dfch-Tenant-Id', 'Tenant-Id')]
[Parameter(Mandatory = $false, ParameterSetName = 'id')]
[string] $TenantHeaderName = 'Biz-Dfch-Tenant-Id'
,
# Specifies the tenant guid to set for this session
[Parameter(Mandatory = $true, ParameterSetName = 'clear')]
[switch] $Clear
,
# Service reference to Appclusive
[Parameter(Mandatory = $false)]
[Alias('Services')]
[hashtable] $svc = (Get-Variable -Name $MyInvocation.MyCommand.Module.PrivateData.MODULEVAR -ValueOnly).Services
,
# Specifies the return format of the Cmdlet
[ValidateSet('default', 'json', 'json-pretty', 'xml', 'xml-pretty')]
[Parameter(Mandatory = $false)]
[alias('ReturnFormat')]
[string] $As = 'default'
)
Begin
{
trap { Log-Exception $_; break; }
$datBegin = [datetime]::Now;
[string] $fn = $MyInvocation.MyCommand.Name;
Log-Debug -fn $fn -msg ("CALL. svc '{0}'. Name '{1}'." -f ($svc -is [Object]), $Name) -fac 1;
Contract-Requires ($svc.Core -is [biz.dfch.CS.Appclusive.Api.Core.Core]) "Connect to the server before using the Cmdlet"
}
# Begin
Process
{
trap { Log-Exception $_; break; }
if($PSCmdlet.ParameterSetName -eq 'id')
{
foreach($key in $svc.Keys)
{
$endpoint = $svc.$key;
$propertyTenantID = ($endpoint | gm -Type Properties -Name TenantID);
if(!$propertyTenantID)
{
$message = ("Endpoint '{0}' does not contain 'TenantID' property." -f $key)
Write-Warning $message
Log-Error $fn $message;
continue;
}
$endpoint.TenantHeaderName = $TenantHeaderName;
$endpoint.TenantID = $Id;
}
$tenant = Get-Tenant -svc $svc -ExternalId $Id;
$OutputParameter = Format-ResultAs $tenant $As
}
elseif($PSCmdlet.ParameterSetName -eq 'clear')
{
foreach($key in $svc.Keys)
{
$endpoint = $svc.$key;
$propertyTenantID = ($endpoint | gm -Type Properties -Name TenantID);
if(!$propertyTenantID)
{
$message = ("Endpoint '{0}' does not contain 'TenantID' property." -f $key)
Write-Warning $message
Log-Error $fn $message;
continue;
}
$endpoint.TenantHeaderName = $null;
$endpoint.TenantID = $null;
}
$OutputParameter = $null;
}
else
{
Write-Error "Invalid ParameterSetName found";
}
$fReturn = $true;
}
# Process
End
{
$datEnd = [datetime]::Now;
Log-Debug -fn $fn -msg ("RET. fReturn: [{0}]. Execution time: [{1}]ms. Started: [{2}]." -f $fReturn, ($datEnd - $datBegin).TotalMilliseconds, $datBegin.ToString('yyyy-MM-dd HH:mm:ss.fffzzz')) -fac 2;
# Return values are always and only returned via OutputParameter.
return $OutputParameter;
}
} # function
if($MyInvocation.ScriptName) { Export-ModuleMember -Function Set-SessionTenant; }
#
# Copyright 2014-2016 d-fens GmbH
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SIG # Begin signature block
# MIIXDwYJKoZIhvcNAQcCoIIXADCCFvwCAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB
# gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR
# AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQUw4G2/Iiu4n+UJyAW0uNUgiZN
# 8dKgghHCMIIEFDCCAvygAwIBAgILBAAAAAABL07hUtcwDQYJKoZIhvcNAQEFBQAw
# VzELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNV
# BAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkdsb2JhbFNpZ24gUm9vdCBDQTAeFw0xMTA0
# MTMxMDAwMDBaFw0yODAxMjgxMjAwMDBaMFIxCzAJBgNVBAYTAkJFMRkwFwYDVQQK
# ExBHbG9iYWxTaWduIG52LXNhMSgwJgYDVQQDEx9HbG9iYWxTaWduIFRpbWVzdGFt
# cGluZyBDQSAtIEcyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAlO9l
# +LVXn6BTDTQG6wkft0cYasvwW+T/J6U00feJGr+esc0SQW5m1IGghYtkWkYvmaCN
# d7HivFzdItdqZ9C76Mp03otPDbBS5ZBb60cO8eefnAuQZT4XljBFcm05oRc2yrmg
# jBtPCBn2gTGtYRakYua0QJ7D/PuV9vu1LpWBmODvxevYAll4d/eq41JrUJEpxfz3
# zZNl0mBhIvIG+zLdFlH6Dv2KMPAXCae78wSuq5DnbN96qfTvxGInX2+ZbTh0qhGL
# 2t/HFEzphbLswn1KJo/nVrqm4M+SU4B09APsaLJgvIQgAIMboe60dAXBKY5i0Eex
# +vBTzBj5Ljv5cH60JQIDAQABo4HlMIHiMA4GA1UdDwEB/wQEAwIBBjASBgNVHRMB
# Af8ECDAGAQH/AgEAMB0GA1UdDgQWBBRG2D7/3OO+/4Pm9IWbsN1q1hSpwTBHBgNV
# HSAEQDA+MDwGBFUdIAAwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93d3cuZ2xvYmFs
# c2lnbi5jb20vcmVwb3NpdG9yeS8wMwYDVR0fBCwwKjAooCagJIYiaHR0cDovL2Ny
# bC5nbG9iYWxzaWduLm5ldC9yb290LmNybDAfBgNVHSMEGDAWgBRge2YaRQ2XyolQ
# L30EzTSo//z9SzANBgkqhkiG9w0BAQUFAAOCAQEATl5WkB5GtNlJMfO7FzkoG8IW
# 3f1B3AkFBJtvsqKa1pkuQJkAVbXqP6UgdtOGNNQXzFU6x4Lu76i6vNgGnxVQ380W
# e1I6AtcZGv2v8Hhc4EvFGN86JB7arLipWAQCBzDbsBJe/jG+8ARI9PBw+DpeVoPP
# PfsNvPTF7ZedudTbpSeE4zibi6c1hkQgpDttpGoLoYP9KOva7yj2zIhd+wo7AKvg
# IeviLzVsD440RZfroveZMzV+y5qKu0VN5z+fwtmK+mWybsd+Zf/okuEsMaL3sCc2
# SI8mbzvuTXYfecPlf5Y1vC0OzAGwjn//UYCAp5LUs0RGZIyHTxZjBzFLY7Df8zCC
# BCkwggMRoAMCAQICCwQAAAAAATGJxjfoMA0GCSqGSIb3DQEBCwUAMEwxIDAeBgNV
# BAsTF0dsb2JhbFNpZ24gUm9vdCBDQSAtIFIzMRMwEQYDVQQKEwpHbG9iYWxTaWdu
# MRMwEQYDVQQDEwpHbG9iYWxTaWduMB4XDTExMDgwMjEwMDAwMFoXDTE5MDgwMjEw
# MDAwMFowWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKPv0Z8p6djTgnY8YqDS
# SdYWHvHP8NC6SEMDLacd8gE0SaQQ6WIT9BP0FoO11VdCSIYrlViH6igEdMtyEQ9h
# JuH6HGEVxyibTQuCDyYrkDqW7aTQaymc9WGI5qRXb+70cNCNF97mZnZfdB5eDFM4
# XZD03zAtGxPReZhUGks4BPQHxCMD05LL94BdqpxWBkQtQUxItC3sNZKaxpXX9c6Q
# MeJ2s2G48XVXQqw7zivIkEnotybPuwyJy9DDo2qhydXjnFMrVyb+Vpp2/WFGomDs
# KUZH8s3ggmLGBFrn7U5AXEgGfZ1f53TJnoRlDVve3NMkHLQUEeurv8QfpLqZ0BdY
# Nc0CAwEAAaOB/TCB+jAOBgNVHQ8BAf8EBAMCAQYwEgYDVR0TAQH/BAgwBgEB/wIB
# ADAdBgNVHQ4EFgQUGUq4WuRNMaUU5V7sL6Mc+oCMMmswRwYDVR0gBEAwPjA8BgRV
# HSAAMDQwMgYIKwYBBQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3Jl
# cG9zaXRvcnkvMDYGA1UdHwQvMC0wK6ApoCeGJWh0dHA6Ly9jcmwuZ2xvYmFsc2ln
# bi5uZXQvcm9vdC1yMy5jcmwwEwYDVR0lBAwwCgYIKwYBBQUHAwMwHwYDVR0jBBgw
# FoAUj/BLf6guRSSuTVD6Y5qL3uLdG7wwDQYJKoZIhvcNAQELBQADggEBAHmwaTTi
# BYf2/tRgLC+GeTQD4LEHkwyEXPnk3GzPbrXsCly6C9BoMS4/ZL0Pgmtmd4F/ximl
# F9jwiU2DJBH2bv6d4UgKKKDieySApOzCmgDXsG1szYjVFXjPE/mIpXNNwTYr3MvO
# 23580ovvL72zT006rbtibiiTxAzL2ebK4BEClAOwvT+UKFaQHlPCJ9XJPM0aYx6C
# WRW2QMqngarDVa8z0bV16AnqRwhIIvtdG/Mseml+xddaXlYzPK1X6JMlQsPSXnE7
# ShxU7alVrCgFx8RsXdw8k/ZpPIJRzhoVPV4Bc/9Aouq0rtOO+u5dbEfHQfXUVlfy
# GDcy1tTMS/Zx4HYwggSfMIIDh6ADAgECAhIRIdaZp2SXPvH4Qn7pGcxTQRQwDQYJ
# KoZIhvcNAQEFBQAwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24g
# bnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzIw
# HhcNMTYwNTI0MDAwMDAwWhcNMjcwNjI0MDAwMDAwWjBgMQswCQYDVQQGEwJTRzEf
# MB0GA1UEChMWR01PIEdsb2JhbFNpZ24gUHRlIEx0ZDEwMC4GA1UEAxMnR2xvYmFs
# U2lnbiBUU0EgZm9yIE1TIEF1dGhlbnRpY29kZSAtIEcyMIIBIjANBgkqhkiG9w0B
# AQEFAAOCAQ8AMIIBCgKCAQEAsBeuotO2BDBWHlgPse1VpNZUy9j2czrsXV6rJf02
# pfqEw2FAxUa1WVI7QqIuXxNiEKlb5nPWkiWxfSPjBrOHOg5D8NcAiVOiETFSKG5d
# QHI88gl3p0mSl9RskKB2p/243LOd8gdgLE9YmABr0xVU4Prd/4AsXximmP/Uq+yh
# RVmyLm9iXeDZGayLV5yoJivZF6UQ0kcIGnAsM4t/aIAqtaFda92NAgIpA6p8N7u7
# KU49U5OzpvqP0liTFUy5LauAo6Ml+6/3CGSwekQPXBDXX2E3qk5r09JTJZ2Cc/os
# +XKwqRk5KlD6qdA8OsroW+/1X1H0+QrZlzXeaoXmIwRCrwIDAQABo4IBXzCCAVsw
# DgYDVR0PAQH/BAQDAgeAMEwGA1UdIARFMEMwQQYJKwYBBAGgMgEeMDQwMgYIKwYB
# BQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3JlcG9zaXRvcnkvMAkG
# A1UdEwQCMAAwFgYDVR0lAQH/BAwwCgYIKwYBBQUHAwgwQgYDVR0fBDswOTA3oDWg
# M4YxaHR0cDovL2NybC5nbG9iYWxzaWduLmNvbS9ncy9nc3RpbWVzdGFtcGluZ2cy
# LmNybDBUBggrBgEFBQcBAQRIMEYwRAYIKwYBBQUHMAKGOGh0dHA6Ly9zZWN1cmUu
# Z2xvYmFsc2lnbi5jb20vY2FjZXJ0L2dzdGltZXN0YW1waW5nZzIuY3J0MB0GA1Ud
# DgQWBBTUooRKOFoYf7pPMFC9ndV6h9YJ9zAfBgNVHSMEGDAWgBRG2D7/3OO+/4Pm
# 9IWbsN1q1hSpwTANBgkqhkiG9w0BAQUFAAOCAQEAj6kakW0EpjcgDoOW3iPTa24f
# bt1kPWghIrX4RzZpjuGlRcckoiK3KQnMVFquxrzNY46zPVBI5bTMrs2SjZ4oixNK
# Eaq9o+/Tsjb8tKFyv22XY3mMRLxwL37zvN2CU6sa9uv6HJe8tjecpBwwvKu8LUc2
# 35IgA+hxxlj2dQWaNPALWVqCRDSqgOQvhPZHXZbJtsrKnbemuuRQ09Q3uLogDtDT
# kipbxFm7oW3bPM5EncE4Kq3jjb3NCXcaEL5nCgI2ZIi5sxsm7ueeYMRGqLxhM2zP
# TrmcuWrwnzf+tT1PmtNN/94gjk6Xpv2fCbxNyhh2ybBNhVDygNIdBvVYBAexGDCC
# BNYwggO+oAMCAQICEhEhDRayW4wRltP+V8mGEea62TANBgkqhkiG9w0BAQsFADBa
# MQswCQYDVQQGEwJCRTEZMBcGA1UEChMQR2xvYmFsU2lnbiBudi1zYTEwMC4GA1UE
# AxMnR2xvYmFsU2lnbiBDb2RlU2lnbmluZyBDQSAtIFNIQTI1NiAtIEcyMB4XDTE1
# MDUwNDE2NDMyMVoXDTE4MDUwNDE2NDMyMVowVTELMAkGA1UEBhMCQ0gxDDAKBgNV
# BAgTA1p1ZzEMMAoGA1UEBxMDWnVnMRQwEgYDVQQKEwtkLWZlbnMgR21iSDEUMBIG
# A1UEAxMLZC1mZW5zIEdtYkgwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB
# AQDNPSzSNPylU9jFM78Q/GjzB7N+VNqikf/use7p8mpnBZ4cf5b4qV3rqQd62rJH
# RlAsxgouCSNQrl8xxfg6/t/I02kPvrzsR4xnDgMiVCqVRAeQsWebafWdTvWmONBS
# lxJejPP8TSgXMKFaDa+2HleTycTBYSoErAZSWpQ0NqF9zBadjsJRVatQuPkTDrwL
# eWibiyOipK9fcNoQpl5ll5H9EG668YJR3fqX9o0TQTkOmxXIL3IJ0UxdpyDpLEkt
# tBG6Y5wAdpF2dQX2phrfFNVY54JOGtuBkNGMSiLFzTkBA1fOlA6ICMYjB8xIFxVv
# rN1tYojCrqYkKMOjwWQz5X8zAgMBAAGjggGZMIIBlTAOBgNVHQ8BAf8EBAMCB4Aw
# TAYDVR0gBEUwQzBBBgkrBgEEAaAyATIwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93
# d3cuZ2xvYmFsc2lnbi5jb20vcmVwb3NpdG9yeS8wCQYDVR0TBAIwADATBgNVHSUE
# DDAKBggrBgEFBQcDAzBCBgNVHR8EOzA5MDegNaAzhjFodHRwOi8vY3JsLmdsb2Jh
# bHNpZ24uY29tL2dzL2dzY29kZXNpZ25zaGEyZzIuY3JsMIGQBggrBgEFBQcBAQSB
# gzCBgDBEBggrBgEFBQcwAoY4aHR0cDovL3NlY3VyZS5nbG9iYWxzaWduLmNvbS9j
# YWNlcnQvZ3Njb2Rlc2lnbnNoYTJnMi5jcnQwOAYIKwYBBQUHMAGGLGh0dHA6Ly9v
# Y3NwMi5nbG9iYWxzaWduLmNvbS9nc2NvZGVzaWduc2hhMmcyMB0GA1UdDgQWBBTN
# GDddiIYZy9p3Z84iSIMd27rtUDAfBgNVHSMEGDAWgBQZSrha5E0xpRTlXuwvoxz6
# gIwyazANBgkqhkiG9w0BAQsFAAOCAQEAAApsOzSX1alF00fTeijB/aIthO3UB0ks
# 1Gg3xoKQC1iEQmFG/qlFLiufs52kRPN7L0a7ClNH3iQpaH5IEaUENT9cNEXdKTBG
# 8OrJS8lrDJXImgNEgtSwz0B40h7bM2Z+0DvXDvpmfyM2NwHF/nNVj7NzmczrLRqN
# 9de3tV0pgRqnIYordVcmb24CZl3bzpwzbQQy14Iz+P5Z2cnw+QaYzAuweTZxEUcJ
# bFwpM49c1LMPFJTuOKkUgY90JJ3gVTpyQxfkc7DNBnx74PlRzjFmeGC/hxQt0hvo
# eaAiBdjo/1uuCTToigVnyRH+c0T2AezTeoFb7ne3I538hWeTdU5q9jGCBLcwggSz
# AgEBMHAwWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MgISESENFrJbjBGW0/5XyYYR5rrZMAkGBSsOAwIaBQCgeDAYBgorBgEEAYI3AgEM
# MQowCKACgAChAoAAMBkGCSqGSIb3DQEJAzEMBgorBgEEAYI3AgEEMBwGCisGAQQB
# gjcCAQsxDjAMBgorBgEEAYI3AgEVMCMGCSqGSIb3DQEJBDEWBBQ8Q3tELmgoTycu
# 43avqAF0ltLBLzANBgkqhkiG9w0BAQEFAASCAQCrC4NtqT3t8jetuFEkiXwFnU9K
# vGN2HMkpTYNou9fKXorZvf/ckZgWZEqUF1GfxSRcFmPJnYIrQludKLIhzBKhFoCi
# hRxPLN7+ccQDRuW0mv+UZwfEZs5G83r4T/bNaAVR+7eYXS1PoF5vVw22AlasMak5
# yv1spMFV9MmvjomAXgJP8qmkBpKXFeM5YfXbGC8ZsYMpkScSGI/54QxIj63lmyS6
# 4gL5a7coxwNJhSvdv/igqnGUPlNaVyi3APkHkBF1j/CABu551NTB/nyM2iMlUlbG
# 23vnRntt7VjAa/Pkf82h2KDptxhYwMtCwIsijfgdRJqFuVN/L2vxzzT17Pc4oYIC
# ojCCAp4GCSqGSIb3DQEJBjGCAo8wggKLAgEBMGgwUjELMAkGA1UEBhMCQkUxGTAX
# BgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGlt
# ZXN0YW1waW5nIENBIC0gRzICEhEh1pmnZJc+8fhCfukZzFNBFDAJBgUrDgMCGgUA
# oIH9MBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTE2
# MDgzMTE5MTcwOFowIwYJKoZIhvcNAQkEMRYEFFx8C0pqHVavIOGR5BzZAvGErIr1
# MIGdBgsqhkiG9w0BCRACDDGBjTCBijCBhzCBhAQUY7gvq2H1g5CWlQULACScUCkz
# 7HkwbDBWpFQwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYt
# c2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzICEhEh
# 1pmnZJc+8fhCfukZzFNBFDANBgkqhkiG9w0BAQEFAASCAQCFW1Xac1vR7i2PuQsC
# lZJ6FddWtyUPDGg1jvbOUwLB/PF1mtnqP46E7dF6F/fhyYc1YZsH6s7jX8EnE25s
# xiVvla7mWa/ShO7wKUtXqKr/lJWL4XZdIGBfhhM+d535k3e7sxLK8192fEu0wSqc
# 7xssbwuMR2Q5uugDh5S0pWivlv18Ru26uSw9n+X9n+5SReFeoZp4O8tbnc06jlsJ
# geelhuM0qUGixsymFU/9CJ65NXqhUdsj3HwzEpQlzFOpOc3Fj3HeWiTsxAW1pcmO
# SitCMhPBNRWXRc/IdkTJpe43CczsgNfm6v6vDCKA3Ait7D6CFN5stTJs13VVfG5g
# 3xG/
# SIG # End signature block
|
PowerShellCorpus/PowerShellGallery/biz.dfch.PS.Appclusive.Client/5.2.1.20161201/Get-EntityBag.ps1
|
Get-EntityBag.ps1
|
function Get-EntityBag {
<#
.SYNOPSIS
Retrieves one or more entities from the EntityBag entity set.
.DESCRIPTION
Retrieves one or more entities from the EntityBag entity set.
You can retrieve one ore more entities from the entity set by specifying
Id, Name or other properties.
.INPUTS
The Cmdlet can either return all available entities or filter entities based on specified conditions
specified conditions.
See PARAMETERS section for possible inputs.
.OUTPUTS
default | json | json-pretty | xml | xml-pretty
In addition output can be filtered on specified properties.
.EXAMPLE
Get-EntityBag -ListAvailable -Select Name
Name
----
arbitrary.name
some.name
another.name
Retrieves the name of all EntityBags.
.EXAMPLE
Get-EntityBag -id 159
Name : ArbitraryName
Value : ArbitraryValue
EntityId : 2
EntityKindId : 1
ProtectionLevel : 0
Id : 159
Tid : 11111111-1111-1111-1111-111111111111
Description :
CreatedById : 1
ModifiedById : 1
Created : 23.08.2016 11:08:14 +02:00
Modified : 23.08.2016 11:08:14 +02:00
RowVersion : {0, 0, 0, 0...}
Tenant :
CreatedBy :
ModifiedBy :
Retrieves the EntityBag object with Id 159 and returns all properties of it.
.EXAMPLE
Get-EntityBag -ListAvailable -Select Name, Id -First 3
Name Id
---- --
arbitrary.name 4
some.name 5
another.name 8
Retrieves the name and id of the first 3 EntityBags.
.EXAMPLE
Get-EntityBag Arbitrary.Name -Select Value -ValueOnly -DefaultValue 'http://proxy:8080'
http://proxy:8080
Retrieves the 'Value' property of a EntityBag with Name 'Arbitrary.Name'
and returns arbitrary.value, if the no results were found.
.LINK
Online Version: http://dfch.biz/biz/dfch/PS/Appclusive/Client/Get-EntityBag/
.NOTES
See module manifest for required software versions and dependencies.
#>
[CmdletBinding(
SupportsShouldProcess = $true
,
ConfirmImpact = 'Low'
,
HelpURI = 'http://dfch.biz/biz/dfch/PS/Appclusive/Client/Get-EntityBag/'
,
DefaultParameterSetName = 'list'
)]
PARAM
(
[Parameter(Mandatory = $true, Position = 0, ParameterSetName = 'id')]
[ValidateRange(1,[long]::MaxValue)]
[long] $Id
,
[Parameter(Mandatory = $true, Position = 0, ParameterSetName = 'name')]
[Parameter(Mandatory = $false, ParameterSetName = 'entityReference')]
[Alias('n')]
[ValidateNotNullOrEmpty()]
[string] $Name
,
[Parameter(Mandatory = $true, ParameterSetName = 'entityReference')]
[ValidateRange(1,[long]::MaxValue)]
[long] $EntityKindId
,
[Parameter(Mandatory = $true, ParameterSetName = 'entityReference')]
[ValidateRange(1,[long]::MaxValue)]
[long] $EntityId
,
# Specify the attributes of the entity to return
[Parameter(Mandatory = $false)]
[string[]] $Select = @()
,
# Specifies to return only values without header information.
# This parameter takes precendes over the 'Select' parameter.
[ValidateScript( { if(1 -ge $Select.Count -And $_) { $true; } else { throw("You must specify exactly one 'Select' property when using 'ValueOnly'."); } } )]
[Parameter(Mandatory = $false)]
[Alias('HideTableHeaders')]
[switch] $ValueOnly
,
# This value is only returned if the regular search would have returned no results
[Parameter(Mandatory = $false)]
[Alias('default')]
$DefaultValue
,
# Specifies to deserialize JSON payloads
[ValidateScript( { if($ValueOnly -And $_) { $true; } else { throw("You must set the 'ValueOnly' switch when using 'ConvertFromJson'."); } } )]
[Parameter(Mandatory = $false)]
[Alias('Convert')]
[switch] $ConvertFromJson
,
# Limits the output to the specified number of entries
[Parameter(Mandatory = $false)]
[Alias('top')]
[long] $First
,
# Service reference to Appclusive
[Parameter(Mandatory = $false)]
[Alias('Services')]
[hashtable] $svc = (Get-Variable -Name $MyInvocation.MyCommand.Module.PrivateData.MODULEVAR -ValueOnly).Services
,
# Indicates to return all file information
[Parameter(Mandatory = $false, ParameterSetName = 'list')]
[switch] $ListAvailable = $false
,
# Specifies the return format of the Cmdlet
[ValidateSet('default', 'json', 'json-pretty', 'xml', 'xml-pretty')]
[Parameter(Mandatory = $false)]
[alias('ReturnFormat')]
[string] $As = 'default'
)
Begin
{
trap { Log-Exception $_; break; }
$datBegin = [datetime]::Now;
[string] $fn = $MyInvocation.MyCommand.Name;
Log-Debug -fn $fn -msg ("CALL. svc '{0}'. Name '{1}'." -f ($svc -is [Object]), $Name) -fac 1;
$EntitySetName = 'EntityBags';
# Parameter validation
Contract-Requires ($svc.Core -is [biz.dfch.CS.Appclusive.Api.Core.Core]) "Connect to the server before using the Cmdlet"
if($Select)
{
$Select = $Select | Select -Unique;
}
elseif ($ValueOnly)
{
$Select = 'Value';
}
}
# Begin
Process
{
trap { Log-Exception $_; break; }
# Default test variable for checking function response codes.
[Boolean] $fReturn = $false;
# Return values are always and only returned via OutputParameter.
$OutputParameter = $null;
Contract-Assert ($PSCmdlet.ShouldProcess(($PSBoundParameters | Out-String)));
$response = @();
$exp = @();
if($PSCmdlet.ParameterSetName -eq 'list')
{
if($Select)
{
if($PSBoundParameters.ContainsKey('First'))
{
$response = $svc.Core.$EntitySetName.AddQueryOption('$orderby', 'Name').AddQueryOption('$top', $First) | Select -Property $Select;
}
else
{
$response = $svc.Core.$EntitySetName.AddQueryOption('$orderby', 'Name') | Select -Property $Select;
}
}
else
{
if($PSBoundParameters.ContainsKey('First'))
{
$response = $svc.Core.$EntitySetName.AddQueryOption('$orderby', 'Name').AddQueryOption('$top', $First) | Select;
}
else
{
$response = $svc.Core.$EntitySetName.AddQueryOption('$orderby', 'Name') | Select;
}
}
}
else
{
if ($PSCmdlet.ParameterSetName -eq 'name')
{
$exp += ("(tolower(Name) eq '{0}')" -f $name.ToLower());
}
elseif ($PSCmdlet.ParameterSetName -eq 'id')
{
$exp += ("Id eq {0}" -f $Id);
}
elseif ($PSCmdlet.ParameterSetName -eq 'entityReference')
{
$exp += ("EntityKindId eq {0}" -f $EntityKindId);
$exp += ("EntityId eq {0}" -f $EntityId);
if($Name)
{
$exp += ("(tolower(Name) eq '{0}')" -f $name.ToLower());
}
}
$filterExpression = [String]::Join(' and ', $exp);
if($Select -And 'object' -ne $As)
{
if($PSBoundParameters.ContainsKey('First'))
{
$response = $svc.Core.$EntitySetName.AddQueryOption('$top', $First).AddQueryOption('$filter', $filterExpression) | Select -Property $Select;
}
else
{
$response = $svc.Core.$EntitySetName.AddQueryOption('$filter', $filterExpression) | Select -Property $Select;
}
}
else
{
if($PSBoundParameters.ContainsKey('First'))
{
$response = $svc.Core.$EntitySetName.AddQueryOption('$top', $First).AddQueryOption('$filter', $filterExpression) | Select;
}
else
{
$response = $svc.Core.$EntitySetName.AddQueryOption('$filter', $filterExpression) | Select;
}
}
}
if(1 -eq $Select.Count -And $ValueOnly)
{
$response = $response.$Select;
}
if($PSBoundParameters.ContainsKey('DefaultValue') -And !$response)
{
$response = $DefaultValue;
}
if($ValueOnly -And $ConvertFromJson)
{
$responseTemp = New-Object System.Collections.ArrayList;
foreach($item in $response)
{
try
{
$null = $responseTemp.Add((ConvertFrom-Json -InputObject $item));
}
catch
{
$null = $responseTemp.Add($item);
}
}
$response = $responseTemp.ToArray();
}
$OutputParameter = Format-ResultAs $response $As
$fReturn = $true;
}
# Process
End
{
$datEnd = [datetime]::Now;
Log-Debug -fn $fn -msg ("RET. fReturn: [{0}]. Execution time: [{1}]ms. Started: [{2}]." -f $fReturn, ($datEnd - $datBegin).TotalMilliseconds, $datBegin.ToString('yyyy-MM-dd HH:mm:ss.fffzzz')) -fac 2;
# Return values are always and only returned via OutputParameter.
return $OutputParameter;
}
# End
} # function
if($MyInvocation.ScriptName) { Export-ModuleMember -Function Get-EntityBag; }
#
# Copyright 2016 d-fens GmbH
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
|
PowerShellCorpus/PowerShellGallery/biz.dfch.PS.Appclusive.Client/5.2.1.20161201/Remove-ManagementCredential.ps1
|
Remove-ManagementCredential.ps1
|
function Remove-ManagementCredential {
<#
.SYNOPSIS
Removes a ManagementCredential entry from the ManagementCredential entity set.
.DESCRIPTION
Removes a ManagementCredential entry from the ManagementCredential entity set.
The Cmdlet lets you remove an existing ManagementCredential entry from the ManagementCredential entity set.
.INPUTS
The Cmdlet can remove entities by name.
.OUTPUTS
default | json | json-pretty | xml | xml-pretty
.EXAMPLE
PS > Remove-ManagementCredential -Name 'ArbitraryName'
Removes the ManagementCredential with Name 'ArbitraryName' from the ManagementCredential entity set.
.LINK
Online Version: http://dfch.biz/biz/dfch/PS/Appclusive/Client/Remove-ManagementCredential/
.NOTES
See module manifest for required software versions and dependencies.
#>
[CmdletBinding(
SupportsShouldProcess = $true
,
ConfirmImpact = 'High'
,
HelpURI = 'http://dfch.biz/biz/dfch/PS/Appclusive/Client/Remove-ManagementCredential/'
)]
Param
(
# The name of the ManagementCredential to remove
[Parameter(Mandatory = $false, Position = 0, ParameterSetName = 'name')]
[string] $Name
,
# Service reference to Appclusive
[Parameter(Mandatory = $false)]
[Alias('Services')]
[hashtable] $svc = (Get-Variable -Name $MyInvocation.MyCommand.Module.PrivateData.MODULEVAR -ValueOnly).Services
,
# Specifies the return format of the Cnmdlet
[ValidateSet('default', 'json', 'json-pretty', 'xml', 'xml-pretty')]
[Parameter(Mandatory = $false)]
[alias('ReturnFormat')]
[string] $As = 'default'
)
Begin
{
trap { Log-Exception $_; break; }
$datBegin = [datetime]::Now;
[string] $fn = $MyInvocation.MyCommand.Name;
Log-Debug -fn $fn -msg ("CALL. svc '{0}'. Name '{1}'." -f ($svc -is [Object]), $Name) -fac 1;
# Parameter validation
Contract-Requires ($svc.Core -is [biz.dfch.CS.Appclusive.Api.Core.Core]) "Connect to the server before using the Cmdlet"
}
# Begin
Process
{
trap { Log-Exception $_; break; }
# Default test variable for checking function response codes.
[Boolean] $fReturn = $false;
# Return values are always and only returned via OutputParameter.
$OutputParameter = $null;
$FilterExpression = "Name eq '{0}'" -f $Name;
$entity = $svc.Core.ManagementCredentials.AddQueryOption('$filter', $FilterExpression).AddQueryOption('$top',1) | Select;
$r = @();
$objectFoundToBeRemoved = $false;
foreach($item in $entity)
{
$objectFoundToBeRemoved = $true;
$itemString = '{0}' -f $item.Name;
if($PSCmdlet.ShouldProcess($itemString))
{
$r += ($item | Select -Property Name, Username);
Log-Notice $fn ("Removing '{0}' ..." -f $itemString);
$svc.Core.DeleteObject($item);
$null = $svc.Core.SaveChanges();
}
}
Contract-Assert ($objectFoundToBeRemoved)
$OutputParameter = Format-ResultAs $r $As;
$fReturn = $true;
}
# Process
End
{
$datEnd = [datetime]::Now;
Log-Debug -fn $fn -msg ("RET. fReturn: [{0}]. Execution time: [{1}]ms. Started: [{2}]." -f $fReturn, ($datEnd - $datBegin).TotalMilliseconds, $datBegin.ToString('yyyy-MM-dd HH:mm:ss.fffzzz')) -fac 2;
# Return values are always and only returned via OutputParameter.
return $OutputParameter;
}
# End
}
if($MyInvocation.ScriptName) { Export-ModuleMember -Function Remove-ManagementCredential; }
#
# Copyright 2014-2015 d-fens GmbH
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SIG # Begin signature block
# MIIXDwYJKoZIhvcNAQcCoIIXADCCFvwCAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB
# gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR
# AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQUkIkA8Y39IOx6aJh3xosdBj66
# mB+gghHCMIIEFDCCAvygAwIBAgILBAAAAAABL07hUtcwDQYJKoZIhvcNAQEFBQAw
# VzELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNV
# BAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkdsb2JhbFNpZ24gUm9vdCBDQTAeFw0xMTA0
# MTMxMDAwMDBaFw0yODAxMjgxMjAwMDBaMFIxCzAJBgNVBAYTAkJFMRkwFwYDVQQK
# ExBHbG9iYWxTaWduIG52LXNhMSgwJgYDVQQDEx9HbG9iYWxTaWduIFRpbWVzdGFt
# cGluZyBDQSAtIEcyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAlO9l
# +LVXn6BTDTQG6wkft0cYasvwW+T/J6U00feJGr+esc0SQW5m1IGghYtkWkYvmaCN
# d7HivFzdItdqZ9C76Mp03otPDbBS5ZBb60cO8eefnAuQZT4XljBFcm05oRc2yrmg
# jBtPCBn2gTGtYRakYua0QJ7D/PuV9vu1LpWBmODvxevYAll4d/eq41JrUJEpxfz3
# zZNl0mBhIvIG+zLdFlH6Dv2KMPAXCae78wSuq5DnbN96qfTvxGInX2+ZbTh0qhGL
# 2t/HFEzphbLswn1KJo/nVrqm4M+SU4B09APsaLJgvIQgAIMboe60dAXBKY5i0Eex
# +vBTzBj5Ljv5cH60JQIDAQABo4HlMIHiMA4GA1UdDwEB/wQEAwIBBjASBgNVHRMB
# Af8ECDAGAQH/AgEAMB0GA1UdDgQWBBRG2D7/3OO+/4Pm9IWbsN1q1hSpwTBHBgNV
# HSAEQDA+MDwGBFUdIAAwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93d3cuZ2xvYmFs
# c2lnbi5jb20vcmVwb3NpdG9yeS8wMwYDVR0fBCwwKjAooCagJIYiaHR0cDovL2Ny
# bC5nbG9iYWxzaWduLm5ldC9yb290LmNybDAfBgNVHSMEGDAWgBRge2YaRQ2XyolQ
# L30EzTSo//z9SzANBgkqhkiG9w0BAQUFAAOCAQEATl5WkB5GtNlJMfO7FzkoG8IW
# 3f1B3AkFBJtvsqKa1pkuQJkAVbXqP6UgdtOGNNQXzFU6x4Lu76i6vNgGnxVQ380W
# e1I6AtcZGv2v8Hhc4EvFGN86JB7arLipWAQCBzDbsBJe/jG+8ARI9PBw+DpeVoPP
# PfsNvPTF7ZedudTbpSeE4zibi6c1hkQgpDttpGoLoYP9KOva7yj2zIhd+wo7AKvg
# IeviLzVsD440RZfroveZMzV+y5qKu0VN5z+fwtmK+mWybsd+Zf/okuEsMaL3sCc2
# SI8mbzvuTXYfecPlf5Y1vC0OzAGwjn//UYCAp5LUs0RGZIyHTxZjBzFLY7Df8zCC
# BCkwggMRoAMCAQICCwQAAAAAATGJxjfoMA0GCSqGSIb3DQEBCwUAMEwxIDAeBgNV
# BAsTF0dsb2JhbFNpZ24gUm9vdCBDQSAtIFIzMRMwEQYDVQQKEwpHbG9iYWxTaWdu
# MRMwEQYDVQQDEwpHbG9iYWxTaWduMB4XDTExMDgwMjEwMDAwMFoXDTE5MDgwMjEw
# MDAwMFowWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKPv0Z8p6djTgnY8YqDS
# SdYWHvHP8NC6SEMDLacd8gE0SaQQ6WIT9BP0FoO11VdCSIYrlViH6igEdMtyEQ9h
# JuH6HGEVxyibTQuCDyYrkDqW7aTQaymc9WGI5qRXb+70cNCNF97mZnZfdB5eDFM4
# XZD03zAtGxPReZhUGks4BPQHxCMD05LL94BdqpxWBkQtQUxItC3sNZKaxpXX9c6Q
# MeJ2s2G48XVXQqw7zivIkEnotybPuwyJy9DDo2qhydXjnFMrVyb+Vpp2/WFGomDs
# KUZH8s3ggmLGBFrn7U5AXEgGfZ1f53TJnoRlDVve3NMkHLQUEeurv8QfpLqZ0BdY
# Nc0CAwEAAaOB/TCB+jAOBgNVHQ8BAf8EBAMCAQYwEgYDVR0TAQH/BAgwBgEB/wIB
# ADAdBgNVHQ4EFgQUGUq4WuRNMaUU5V7sL6Mc+oCMMmswRwYDVR0gBEAwPjA8BgRV
# HSAAMDQwMgYIKwYBBQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3Jl
# cG9zaXRvcnkvMDYGA1UdHwQvMC0wK6ApoCeGJWh0dHA6Ly9jcmwuZ2xvYmFsc2ln
# bi5uZXQvcm9vdC1yMy5jcmwwEwYDVR0lBAwwCgYIKwYBBQUHAwMwHwYDVR0jBBgw
# FoAUj/BLf6guRSSuTVD6Y5qL3uLdG7wwDQYJKoZIhvcNAQELBQADggEBAHmwaTTi
# BYf2/tRgLC+GeTQD4LEHkwyEXPnk3GzPbrXsCly6C9BoMS4/ZL0Pgmtmd4F/ximl
# F9jwiU2DJBH2bv6d4UgKKKDieySApOzCmgDXsG1szYjVFXjPE/mIpXNNwTYr3MvO
# 23580ovvL72zT006rbtibiiTxAzL2ebK4BEClAOwvT+UKFaQHlPCJ9XJPM0aYx6C
# WRW2QMqngarDVa8z0bV16AnqRwhIIvtdG/Mseml+xddaXlYzPK1X6JMlQsPSXnE7
# ShxU7alVrCgFx8RsXdw8k/ZpPIJRzhoVPV4Bc/9Aouq0rtOO+u5dbEfHQfXUVlfy
# GDcy1tTMS/Zx4HYwggSfMIIDh6ADAgECAhIRIdaZp2SXPvH4Qn7pGcxTQRQwDQYJ
# KoZIhvcNAQEFBQAwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24g
# bnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzIw
# HhcNMTYwNTI0MDAwMDAwWhcNMjcwNjI0MDAwMDAwWjBgMQswCQYDVQQGEwJTRzEf
# MB0GA1UEChMWR01PIEdsb2JhbFNpZ24gUHRlIEx0ZDEwMC4GA1UEAxMnR2xvYmFs
# U2lnbiBUU0EgZm9yIE1TIEF1dGhlbnRpY29kZSAtIEcyMIIBIjANBgkqhkiG9w0B
# AQEFAAOCAQ8AMIIBCgKCAQEAsBeuotO2BDBWHlgPse1VpNZUy9j2czrsXV6rJf02
# pfqEw2FAxUa1WVI7QqIuXxNiEKlb5nPWkiWxfSPjBrOHOg5D8NcAiVOiETFSKG5d
# QHI88gl3p0mSl9RskKB2p/243LOd8gdgLE9YmABr0xVU4Prd/4AsXximmP/Uq+yh
# RVmyLm9iXeDZGayLV5yoJivZF6UQ0kcIGnAsM4t/aIAqtaFda92NAgIpA6p8N7u7
# KU49U5OzpvqP0liTFUy5LauAo6Ml+6/3CGSwekQPXBDXX2E3qk5r09JTJZ2Cc/os
# +XKwqRk5KlD6qdA8OsroW+/1X1H0+QrZlzXeaoXmIwRCrwIDAQABo4IBXzCCAVsw
# DgYDVR0PAQH/BAQDAgeAMEwGA1UdIARFMEMwQQYJKwYBBAGgMgEeMDQwMgYIKwYB
# BQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3JlcG9zaXRvcnkvMAkG
# A1UdEwQCMAAwFgYDVR0lAQH/BAwwCgYIKwYBBQUHAwgwQgYDVR0fBDswOTA3oDWg
# M4YxaHR0cDovL2NybC5nbG9iYWxzaWduLmNvbS9ncy9nc3RpbWVzdGFtcGluZ2cy
# LmNybDBUBggrBgEFBQcBAQRIMEYwRAYIKwYBBQUHMAKGOGh0dHA6Ly9zZWN1cmUu
# Z2xvYmFsc2lnbi5jb20vY2FjZXJ0L2dzdGltZXN0YW1waW5nZzIuY3J0MB0GA1Ud
# DgQWBBTUooRKOFoYf7pPMFC9ndV6h9YJ9zAfBgNVHSMEGDAWgBRG2D7/3OO+/4Pm
# 9IWbsN1q1hSpwTANBgkqhkiG9w0BAQUFAAOCAQEAj6kakW0EpjcgDoOW3iPTa24f
# bt1kPWghIrX4RzZpjuGlRcckoiK3KQnMVFquxrzNY46zPVBI5bTMrs2SjZ4oixNK
# Eaq9o+/Tsjb8tKFyv22XY3mMRLxwL37zvN2CU6sa9uv6HJe8tjecpBwwvKu8LUc2
# 35IgA+hxxlj2dQWaNPALWVqCRDSqgOQvhPZHXZbJtsrKnbemuuRQ09Q3uLogDtDT
# kipbxFm7oW3bPM5EncE4Kq3jjb3NCXcaEL5nCgI2ZIi5sxsm7ueeYMRGqLxhM2zP
# TrmcuWrwnzf+tT1PmtNN/94gjk6Xpv2fCbxNyhh2ybBNhVDygNIdBvVYBAexGDCC
# BNYwggO+oAMCAQICEhEhDRayW4wRltP+V8mGEea62TANBgkqhkiG9w0BAQsFADBa
# MQswCQYDVQQGEwJCRTEZMBcGA1UEChMQR2xvYmFsU2lnbiBudi1zYTEwMC4GA1UE
# AxMnR2xvYmFsU2lnbiBDb2RlU2lnbmluZyBDQSAtIFNIQTI1NiAtIEcyMB4XDTE1
# MDUwNDE2NDMyMVoXDTE4MDUwNDE2NDMyMVowVTELMAkGA1UEBhMCQ0gxDDAKBgNV
# BAgTA1p1ZzEMMAoGA1UEBxMDWnVnMRQwEgYDVQQKEwtkLWZlbnMgR21iSDEUMBIG
# A1UEAxMLZC1mZW5zIEdtYkgwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB
# AQDNPSzSNPylU9jFM78Q/GjzB7N+VNqikf/use7p8mpnBZ4cf5b4qV3rqQd62rJH
# RlAsxgouCSNQrl8xxfg6/t/I02kPvrzsR4xnDgMiVCqVRAeQsWebafWdTvWmONBS
# lxJejPP8TSgXMKFaDa+2HleTycTBYSoErAZSWpQ0NqF9zBadjsJRVatQuPkTDrwL
# eWibiyOipK9fcNoQpl5ll5H9EG668YJR3fqX9o0TQTkOmxXIL3IJ0UxdpyDpLEkt
# tBG6Y5wAdpF2dQX2phrfFNVY54JOGtuBkNGMSiLFzTkBA1fOlA6ICMYjB8xIFxVv
# rN1tYojCrqYkKMOjwWQz5X8zAgMBAAGjggGZMIIBlTAOBgNVHQ8BAf8EBAMCB4Aw
# TAYDVR0gBEUwQzBBBgkrBgEEAaAyATIwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93
# d3cuZ2xvYmFsc2lnbi5jb20vcmVwb3NpdG9yeS8wCQYDVR0TBAIwADATBgNVHSUE
# DDAKBggrBgEFBQcDAzBCBgNVHR8EOzA5MDegNaAzhjFodHRwOi8vY3JsLmdsb2Jh
# bHNpZ24uY29tL2dzL2dzY29kZXNpZ25zaGEyZzIuY3JsMIGQBggrBgEFBQcBAQSB
# gzCBgDBEBggrBgEFBQcwAoY4aHR0cDovL3NlY3VyZS5nbG9iYWxzaWduLmNvbS9j
# YWNlcnQvZ3Njb2Rlc2lnbnNoYTJnMi5jcnQwOAYIKwYBBQUHMAGGLGh0dHA6Ly9v
# Y3NwMi5nbG9iYWxzaWduLmNvbS9nc2NvZGVzaWduc2hhMmcyMB0GA1UdDgQWBBTN
# GDddiIYZy9p3Z84iSIMd27rtUDAfBgNVHSMEGDAWgBQZSrha5E0xpRTlXuwvoxz6
# gIwyazANBgkqhkiG9w0BAQsFAAOCAQEAAApsOzSX1alF00fTeijB/aIthO3UB0ks
# 1Gg3xoKQC1iEQmFG/qlFLiufs52kRPN7L0a7ClNH3iQpaH5IEaUENT9cNEXdKTBG
# 8OrJS8lrDJXImgNEgtSwz0B40h7bM2Z+0DvXDvpmfyM2NwHF/nNVj7NzmczrLRqN
# 9de3tV0pgRqnIYordVcmb24CZl3bzpwzbQQy14Iz+P5Z2cnw+QaYzAuweTZxEUcJ
# bFwpM49c1LMPFJTuOKkUgY90JJ3gVTpyQxfkc7DNBnx74PlRzjFmeGC/hxQt0hvo
# eaAiBdjo/1uuCTToigVnyRH+c0T2AezTeoFb7ne3I538hWeTdU5q9jGCBLcwggSz
# AgEBMHAwWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MgISESENFrJbjBGW0/5XyYYR5rrZMAkGBSsOAwIaBQCgeDAYBgorBgEEAYI3AgEM
# MQowCKACgAChAoAAMBkGCSqGSIb3DQEJAzEMBgorBgEEAYI3AgEEMBwGCisGAQQB
# gjcCAQsxDjAMBgorBgEEAYI3AgEVMCMGCSqGSIb3DQEJBDEWBBT9AC8BB6z15RcZ
# JN0ra6Dj5z00HjANBgkqhkiG9w0BAQEFAASCAQCqDhA9DvonbglrIMZNLoq4A7Po
# Lq6so1dcTPmshnZDBl8Myfmr54q3nG8iXUok1Kle27j6ScszNx5aBV5paVOWD04c
# Sp4MdwX6ps1z+GfbQaLUH+dJ7YXhGEoXFigUxnOxlPtnLwC/F0gsZKJGz76XcYKV
# ulpwXdSX7oX+tkUvzBv6cCIvOGZP1b7PTpVML93YAIAWgnf5pHDJ9IRfwvk/ZE0e
# VyOfPh2Iy9NbivMFYRMvuLutkRDkGaC2/4KIgywVeaQ1+8aLnBD7BMwNjOuM9qCc
# XvzhwxYHEoLvxPnfZoPFgISGvtwDnsrv5hzxUMCQvcs2xhBvfGhZucwVDvKroYIC
# ojCCAp4GCSqGSIb3DQEJBjGCAo8wggKLAgEBMGgwUjELMAkGA1UEBhMCQkUxGTAX
# BgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGlt
# ZXN0YW1waW5nIENBIC0gRzICEhEh1pmnZJc+8fhCfukZzFNBFDAJBgUrDgMCGgUA
# oIH9MBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTE2
# MDgzMTE5MTcwMVowIwYJKoZIhvcNAQkEMRYEFEIPiwEai0Rx/pkfSeeVxmg7rOZM
# MIGdBgsqhkiG9w0BCRACDDGBjTCBijCBhzCBhAQUY7gvq2H1g5CWlQULACScUCkz
# 7HkwbDBWpFQwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYt
# c2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzICEhEh
# 1pmnZJc+8fhCfukZzFNBFDANBgkqhkiG9w0BAQEFAASCAQCRnor1DGpe2CapzOzg
# i31+ok00ymYiMUmJLXkJMBYhJR7VQzE8THN3YptN8M552eAFyDinAg0I2kzLkMum
# 9SpYH9YA+jcNIeNK1x/b2kV+Z9SQo+mdlr119BshvCfUBWv/EYlNkmbAuUQIvFEs
# a/tbakqq0L2sZfinoHQlDlsrEtJ3o0qfN0nwOTYqw9ks2M7vZQHHFtALDUm0+TPy
# pXg76TTzPRTRJOq1k1oBgwrgInWCymCFNi45kFFYyBI4ymNUjvqd+d3HpVKsMrx2
# w4QAd9QVve3FgKxEobpnjoSI3VX9ImxI04sJ7Fb+83cWQCs0Dol2qrpfu2TLwHZj
# VYF0
# SIG # End signature block
|
PowerShellCorpus/PowerShellGallery/biz.dfch.PS.Appclusive.Client/5.2.1.20161201/Remove-Entity.ps1
|
Remove-Entity.ps1
|
function Remove-Entity {
<#
.SYNOPSIS
Removes one or more entities from an Appclusive entity set.
.DESCRIPTION
Removes one or more entities from an Appclusive entity set.
.INPUTS
The Cmdlet can either remove entities by id or by object reference.
See PARAMETERS section on possible inputs.
.OUTPUTS
default | json | json-pretty | xml | xml-pretty
.EXAMPLE
Remove-Entity $entity;
Removes an entity.
.EXAMPLE
Remove-Entity -Id 42 -EntitySetName Command -Confirm;
Removes entity with Id 42 from entity set 'Commands' in the default Services
reference. Operation must be confirmed interactively
.EXAMPLE
Remove-Entity -Id 42 -EntitySetName Command -Service Diagnostics;
Removes entity with Id 42 from entity set 'Commands' in the 'Diagnostics'
Services reference.
.EXAMPLE
Remove-Entity $entity -Force;
Remove entity '$entity' even if the entity is in a state other than 'Unchanged'
.EXAMPLE
$svc.ApplicationData.Commands |? Status -eq 'FAILED' | Remove-Entity -Confirm:$false;
Retrieves all Commands with Status 'FAILED'.
.EXAMPLE
Remove-Entity -Id 1,2,3,4 -EntitySetName Commands -Confirm:$false;
Retrieves all Command entities with Id 1,2,3,4.
.LINK
Online Version: http://dfch.biz/biz/dfch/PS/Appclusive/Client/Remove-Entity/
.NOTES
See module manifest for required software versions and dependencies.
#>
[CmdletBinding(
SupportsShouldProcess = $true
,
ConfirmImpact = 'High'
,
HelpURI = 'http://dfch.biz/biz/dfch/PS/Appclusive/Client/Remove-Entity/'
,
DefaultParameterSetName = 'o'
)]
PARAM
(
# Specifies the id of the entity to remove
[Parameter(Mandatory = $true, Position = 0, ParameterSetName = 'id')]
[ValidateRange(1, [long]::MaxValue)]
$Id
,
# Specifies the entity set name of the entity to remove
[Parameter(Mandatory = $true, Position = 1, ParameterSetName = 'id')]
[ValidateNotNullOrEmpty()]
[string] $EntitySetName
,
# Specifies the service or container name of the entity to remove
[ValidateScript( { if($svc.Keys -contains $_) { $true; } else { throw('{0}: Invalid service name specified.' -f $_); } } )]
[Parameter(Mandatory = $false, Position = 2, ParameterSetName = 'id')]
[Alias("Container")]
[string] $Service = 'Core'
,
# Specifies the entity to remove
[Parameter(Mandatory = $true, ValueFromPipeline = $true, Position = 0, ParameterSetName = 'o')]
[Alias("Entity")]
$InputObject
,
# Specifies the entity to remove
[Parameter(Mandatory = $false)]
[switch] $Force
,
# Service reference to Appclusive
[Parameter(Mandatory = $false)]
[Alias('Services')]
[hashtable] $svc = (Get-Variable -Name $MyInvocation.MyCommand.Module.PrivateData.MODULEVAR -ValueOnly).Services
,
# Specifies the return format of the Cmdlet
[ValidateSet('default', 'json', 'json-pretty', 'xml', 'xml-pretty')]
[Parameter(Mandatory = $false)]
[alias('ReturnFormat')]
[string] $As = 'default'
)
Begin
{
trap { Log-Exception $_; break; }
$datBegin = [datetime]::Now;
[string] $fn = $MyInvocation.MyCommand.Name;
Log-Debug -fn $fn -msg ("CALL. svc '{0}'. Name '{1}'." -f ($svc -is [Object]), $Name) -fac 1;
# Parameter validation
Contract-Requires ($svc.Core -is [biz.dfch.CS.Appclusive.Api.Core.Core]) "Connect to the server before using the Cmdlet"
if($PSCmdlet.ParameterSetName -eq 'id')
{
if(!(Get-Member -InputObject $svc.$Service -MemberType Properties -Name $EntitySetName))
{
$msg = "EntitySetName: Parameter validation FAILED. '{0}' is not a valid entity set in '{1}'." -f $EntitySetName, $Service;
Log-Error $fn $msg;
$e = New-CustomErrorRecord -m $msg -cat ObjectNotFound -o $EntitySetName;
$PSCmdlet.ThrowTerminatingError($e);
}
$InputObjectTemp = New-Object System.Collections.ArrayList($Id.Count);
foreach($Object in $Id)
{
$ObjectTemp = $svc.$Service.$EntitySetName.AddQueryOption('$filter', ('Id eq {0}' -f $Object)).AddQueryOption('$top', 1) | Select;
if(!$ObjectTemp)
{
$EntityToRemoveMsg = '{0}-{1}-{2}' -f $Service, $EntitySetName, $Object;
$msg = "Id: Parameter validation FAILED. '{0}' is not a valid entity." -f $EntityToRemoveMsg;
Log-Error $fn $msg;
$e = New-CustomErrorRecord -m $msg -cat ObjectNotFound -o $EntityToRemoveMsg;
$PSCmdlet.ThrowTerminatingError($e);
}
$null = $InputObjectTemp.Add($ObjectTemp);
}
$InputObject = $InputObjectTemp.ToArray();
Remove-Variable InputObjectTemp -ErrorAction:SilentlyContinue -Confirm:$false;
Remove-Variable ObjectTemp -ErrorAction:SilentlyContinue -Confirm:$false;
}
$r = @();
}
# Begin
Process
{
# Default test variable for checking function response codes.
[Boolean] $fReturn = $false;
# Return values are always and only returned via OutputParameter.
$OutputParameter = $null;
try
{
# Parameter validation
# N/A
foreach($Object in $InputObject)
{
$ObjectDescriptor = $null;
foreach($Service in $svc.Keys)
{
$ObjectDescriptor = $svc.$Service.GetEntityDescriptor($Object);
if($ObjectDescriptor)
{
break;
}
}
if(!$ObjectDescriptor -Or !$Service)
{
$msg = "Object: Parameter validation FAILED. Object is not a valid entity.`r`n{0}" -f ($Object | Out-String);
Log-Error $fn $msg;
$e = New-CustomErrorRecord -m $msg -cat ObjectNotFound -o $Object;
$PSCmdlet.ThrowTerminatingError($e);
}
$EntitySetName = 'UnknownEntitySetName';
if(([uri] $svc.$Service.GetEntityDescriptor($Object).Identity).Segments[-1] -match '^([^(]+)\(.+$')
{
$EntitySetName = $Matches[1];
}
$EntityToRemoveMsg = '{0}-{1}-{2}' -f $Service, $EntitySetName, $Object.Id;
if(!$PSCmdlet.ShouldProcess(($Object | Out-String)))
{
continue;
}
if( $ObjectDescriptor.State -ne [System.Data.Services.Client.EntityStates]::Unchanged -And !$Force )
{
$msg = "Objects with a status '{0}' can only be removed with the 'Force' parameter.`r`n{1}" -f $ObjectDescriptor.State, ($Object | Out-String);
Log-Error $fn $msg;
$e = New-CustomErrorRecord -m $msg -cat ObjectNotFound -o $Object;
$PSCmdlet.ThrowTerminatingError($e);
}
# Delete object
Log-Debug $fn ("Deleting entity '{0}' ..." -f $EntityToRemoveMsg);
try
{
$svc.$Service.DeleteObject($Object);
$Response = $svc.$Service.SaveChanges();
}
catch
{
Log-Error $fn ("Deleting entity '{0}' FAILED." -f $EntityToRemoveMsg);
throw($_);
}
Log-Info $fn ("Deleting entity '{0}' SUCCEEDED." -f $EntityToRemoveMsg);
$r += $Response;
}
}
catch
{
if($gotoSuccess -eq $_.Exception.Message)
{
$fReturn = $true;
}
else
{
[string] $ErrorText = "catch [$($_.FullyQualifiedErrorId)]";
$ErrorText += (($_ | fl * -Force) | Out-String);
$ErrorText += (($_.Exception | fl * -Force) | Out-String);
$ErrorText += (Get-PSCallStack | Out-String);
if($_.Exception -is [System.Net.WebException])
{
Log-Critical $fn ("[WebException] Request FAILED with Status '{0}'. [{1}]." -f $_.Execption.Status, $_);
Log-Debug $fn $ErrorText -fac 3;
}
else
{
Log-Error $fn $ErrorText -fac 3;
if($gotoError -eq $_.Exception.Message)
{
Log-Error $fn $e.Exception.Message;
$PSCmdlet.ThrowTerminatingError($e);
}
elseif($gotoFailure -ne $_.Exception.Message)
{
Write-Verbose ("$fn`n$ErrorText");
}
else
{
# N/A
}
}
$fReturn = $false;
$OutputParameter = $null;
}
}
finally
{
# Clean up
# N/A
}
}
# Process
End
{
if(0 -eq $r.Count)
{
$r = $null;
}
elseif(1 -eq $r.Count)
{
$r = $r[0];
}
$OutputParameter = Format-ResultAs $r $As
$OutputParameter
$fReturn = $true;
$datEnd = [datetime]::Now;
Log-Debug -fn $fn -msg ("RET. fReturn: [{0}]. Execution time: [{1}]ms. Started: [{2}]." -f $fReturn, ($datEnd - $datBegin).TotalMilliseconds, $datBegin.ToString('yyyy-MM-dd HH:mm:ss.fffzzz')) -fac 2;
}
# End
} # function
if($MyInvocation.ScriptName) { Export-ModuleMember -Function Remove-Entity; }
#
# Copyright 2014-2015 d-fens GmbH
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SIG # Begin signature block
# MIIXDwYJKoZIhvcNAQcCoIIXADCCFvwCAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB
# gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR
# AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQU4wLALPsybDoOpmWo8I/Wvzlk
# JK6gghHCMIIEFDCCAvygAwIBAgILBAAAAAABL07hUtcwDQYJKoZIhvcNAQEFBQAw
# VzELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNV
# BAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkdsb2JhbFNpZ24gUm9vdCBDQTAeFw0xMTA0
# MTMxMDAwMDBaFw0yODAxMjgxMjAwMDBaMFIxCzAJBgNVBAYTAkJFMRkwFwYDVQQK
# ExBHbG9iYWxTaWduIG52LXNhMSgwJgYDVQQDEx9HbG9iYWxTaWduIFRpbWVzdGFt
# cGluZyBDQSAtIEcyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAlO9l
# +LVXn6BTDTQG6wkft0cYasvwW+T/J6U00feJGr+esc0SQW5m1IGghYtkWkYvmaCN
# d7HivFzdItdqZ9C76Mp03otPDbBS5ZBb60cO8eefnAuQZT4XljBFcm05oRc2yrmg
# jBtPCBn2gTGtYRakYua0QJ7D/PuV9vu1LpWBmODvxevYAll4d/eq41JrUJEpxfz3
# zZNl0mBhIvIG+zLdFlH6Dv2KMPAXCae78wSuq5DnbN96qfTvxGInX2+ZbTh0qhGL
# 2t/HFEzphbLswn1KJo/nVrqm4M+SU4B09APsaLJgvIQgAIMboe60dAXBKY5i0Eex
# +vBTzBj5Ljv5cH60JQIDAQABo4HlMIHiMA4GA1UdDwEB/wQEAwIBBjASBgNVHRMB
# Af8ECDAGAQH/AgEAMB0GA1UdDgQWBBRG2D7/3OO+/4Pm9IWbsN1q1hSpwTBHBgNV
# HSAEQDA+MDwGBFUdIAAwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93d3cuZ2xvYmFs
# c2lnbi5jb20vcmVwb3NpdG9yeS8wMwYDVR0fBCwwKjAooCagJIYiaHR0cDovL2Ny
# bC5nbG9iYWxzaWduLm5ldC9yb290LmNybDAfBgNVHSMEGDAWgBRge2YaRQ2XyolQ
# L30EzTSo//z9SzANBgkqhkiG9w0BAQUFAAOCAQEATl5WkB5GtNlJMfO7FzkoG8IW
# 3f1B3AkFBJtvsqKa1pkuQJkAVbXqP6UgdtOGNNQXzFU6x4Lu76i6vNgGnxVQ380W
# e1I6AtcZGv2v8Hhc4EvFGN86JB7arLipWAQCBzDbsBJe/jG+8ARI9PBw+DpeVoPP
# PfsNvPTF7ZedudTbpSeE4zibi6c1hkQgpDttpGoLoYP9KOva7yj2zIhd+wo7AKvg
# IeviLzVsD440RZfroveZMzV+y5qKu0VN5z+fwtmK+mWybsd+Zf/okuEsMaL3sCc2
# SI8mbzvuTXYfecPlf5Y1vC0OzAGwjn//UYCAp5LUs0RGZIyHTxZjBzFLY7Df8zCC
# BCkwggMRoAMCAQICCwQAAAAAATGJxjfoMA0GCSqGSIb3DQEBCwUAMEwxIDAeBgNV
# BAsTF0dsb2JhbFNpZ24gUm9vdCBDQSAtIFIzMRMwEQYDVQQKEwpHbG9iYWxTaWdu
# MRMwEQYDVQQDEwpHbG9iYWxTaWduMB4XDTExMDgwMjEwMDAwMFoXDTE5MDgwMjEw
# MDAwMFowWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKPv0Z8p6djTgnY8YqDS
# SdYWHvHP8NC6SEMDLacd8gE0SaQQ6WIT9BP0FoO11VdCSIYrlViH6igEdMtyEQ9h
# JuH6HGEVxyibTQuCDyYrkDqW7aTQaymc9WGI5qRXb+70cNCNF97mZnZfdB5eDFM4
# XZD03zAtGxPReZhUGks4BPQHxCMD05LL94BdqpxWBkQtQUxItC3sNZKaxpXX9c6Q
# MeJ2s2G48XVXQqw7zivIkEnotybPuwyJy9DDo2qhydXjnFMrVyb+Vpp2/WFGomDs
# KUZH8s3ggmLGBFrn7U5AXEgGfZ1f53TJnoRlDVve3NMkHLQUEeurv8QfpLqZ0BdY
# Nc0CAwEAAaOB/TCB+jAOBgNVHQ8BAf8EBAMCAQYwEgYDVR0TAQH/BAgwBgEB/wIB
# ADAdBgNVHQ4EFgQUGUq4WuRNMaUU5V7sL6Mc+oCMMmswRwYDVR0gBEAwPjA8BgRV
# HSAAMDQwMgYIKwYBBQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3Jl
# cG9zaXRvcnkvMDYGA1UdHwQvMC0wK6ApoCeGJWh0dHA6Ly9jcmwuZ2xvYmFsc2ln
# bi5uZXQvcm9vdC1yMy5jcmwwEwYDVR0lBAwwCgYIKwYBBQUHAwMwHwYDVR0jBBgw
# FoAUj/BLf6guRSSuTVD6Y5qL3uLdG7wwDQYJKoZIhvcNAQELBQADggEBAHmwaTTi
# BYf2/tRgLC+GeTQD4LEHkwyEXPnk3GzPbrXsCly6C9BoMS4/ZL0Pgmtmd4F/ximl
# F9jwiU2DJBH2bv6d4UgKKKDieySApOzCmgDXsG1szYjVFXjPE/mIpXNNwTYr3MvO
# 23580ovvL72zT006rbtibiiTxAzL2ebK4BEClAOwvT+UKFaQHlPCJ9XJPM0aYx6C
# WRW2QMqngarDVa8z0bV16AnqRwhIIvtdG/Mseml+xddaXlYzPK1X6JMlQsPSXnE7
# ShxU7alVrCgFx8RsXdw8k/ZpPIJRzhoVPV4Bc/9Aouq0rtOO+u5dbEfHQfXUVlfy
# GDcy1tTMS/Zx4HYwggSfMIIDh6ADAgECAhIRIdaZp2SXPvH4Qn7pGcxTQRQwDQYJ
# KoZIhvcNAQEFBQAwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24g
# bnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzIw
# HhcNMTYwNTI0MDAwMDAwWhcNMjcwNjI0MDAwMDAwWjBgMQswCQYDVQQGEwJTRzEf
# MB0GA1UEChMWR01PIEdsb2JhbFNpZ24gUHRlIEx0ZDEwMC4GA1UEAxMnR2xvYmFs
# U2lnbiBUU0EgZm9yIE1TIEF1dGhlbnRpY29kZSAtIEcyMIIBIjANBgkqhkiG9w0B
# AQEFAAOCAQ8AMIIBCgKCAQEAsBeuotO2BDBWHlgPse1VpNZUy9j2czrsXV6rJf02
# pfqEw2FAxUa1WVI7QqIuXxNiEKlb5nPWkiWxfSPjBrOHOg5D8NcAiVOiETFSKG5d
# QHI88gl3p0mSl9RskKB2p/243LOd8gdgLE9YmABr0xVU4Prd/4AsXximmP/Uq+yh
# RVmyLm9iXeDZGayLV5yoJivZF6UQ0kcIGnAsM4t/aIAqtaFda92NAgIpA6p8N7u7
# KU49U5OzpvqP0liTFUy5LauAo6Ml+6/3CGSwekQPXBDXX2E3qk5r09JTJZ2Cc/os
# +XKwqRk5KlD6qdA8OsroW+/1X1H0+QrZlzXeaoXmIwRCrwIDAQABo4IBXzCCAVsw
# DgYDVR0PAQH/BAQDAgeAMEwGA1UdIARFMEMwQQYJKwYBBAGgMgEeMDQwMgYIKwYB
# BQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3JlcG9zaXRvcnkvMAkG
# A1UdEwQCMAAwFgYDVR0lAQH/BAwwCgYIKwYBBQUHAwgwQgYDVR0fBDswOTA3oDWg
# M4YxaHR0cDovL2NybC5nbG9iYWxzaWduLmNvbS9ncy9nc3RpbWVzdGFtcGluZ2cy
# LmNybDBUBggrBgEFBQcBAQRIMEYwRAYIKwYBBQUHMAKGOGh0dHA6Ly9zZWN1cmUu
# Z2xvYmFsc2lnbi5jb20vY2FjZXJ0L2dzdGltZXN0YW1waW5nZzIuY3J0MB0GA1Ud
# DgQWBBTUooRKOFoYf7pPMFC9ndV6h9YJ9zAfBgNVHSMEGDAWgBRG2D7/3OO+/4Pm
# 9IWbsN1q1hSpwTANBgkqhkiG9w0BAQUFAAOCAQEAj6kakW0EpjcgDoOW3iPTa24f
# bt1kPWghIrX4RzZpjuGlRcckoiK3KQnMVFquxrzNY46zPVBI5bTMrs2SjZ4oixNK
# Eaq9o+/Tsjb8tKFyv22XY3mMRLxwL37zvN2CU6sa9uv6HJe8tjecpBwwvKu8LUc2
# 35IgA+hxxlj2dQWaNPALWVqCRDSqgOQvhPZHXZbJtsrKnbemuuRQ09Q3uLogDtDT
# kipbxFm7oW3bPM5EncE4Kq3jjb3NCXcaEL5nCgI2ZIi5sxsm7ueeYMRGqLxhM2zP
# TrmcuWrwnzf+tT1PmtNN/94gjk6Xpv2fCbxNyhh2ybBNhVDygNIdBvVYBAexGDCC
# BNYwggO+oAMCAQICEhEhDRayW4wRltP+V8mGEea62TANBgkqhkiG9w0BAQsFADBa
# MQswCQYDVQQGEwJCRTEZMBcGA1UEChMQR2xvYmFsU2lnbiBudi1zYTEwMC4GA1UE
# AxMnR2xvYmFsU2lnbiBDb2RlU2lnbmluZyBDQSAtIFNIQTI1NiAtIEcyMB4XDTE1
# MDUwNDE2NDMyMVoXDTE4MDUwNDE2NDMyMVowVTELMAkGA1UEBhMCQ0gxDDAKBgNV
# BAgTA1p1ZzEMMAoGA1UEBxMDWnVnMRQwEgYDVQQKEwtkLWZlbnMgR21iSDEUMBIG
# A1UEAxMLZC1mZW5zIEdtYkgwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB
# AQDNPSzSNPylU9jFM78Q/GjzB7N+VNqikf/use7p8mpnBZ4cf5b4qV3rqQd62rJH
# RlAsxgouCSNQrl8xxfg6/t/I02kPvrzsR4xnDgMiVCqVRAeQsWebafWdTvWmONBS
# lxJejPP8TSgXMKFaDa+2HleTycTBYSoErAZSWpQ0NqF9zBadjsJRVatQuPkTDrwL
# eWibiyOipK9fcNoQpl5ll5H9EG668YJR3fqX9o0TQTkOmxXIL3IJ0UxdpyDpLEkt
# tBG6Y5wAdpF2dQX2phrfFNVY54JOGtuBkNGMSiLFzTkBA1fOlA6ICMYjB8xIFxVv
# rN1tYojCrqYkKMOjwWQz5X8zAgMBAAGjggGZMIIBlTAOBgNVHQ8BAf8EBAMCB4Aw
# TAYDVR0gBEUwQzBBBgkrBgEEAaAyATIwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93
# d3cuZ2xvYmFsc2lnbi5jb20vcmVwb3NpdG9yeS8wCQYDVR0TBAIwADATBgNVHSUE
# DDAKBggrBgEFBQcDAzBCBgNVHR8EOzA5MDegNaAzhjFodHRwOi8vY3JsLmdsb2Jh
# bHNpZ24uY29tL2dzL2dzY29kZXNpZ25zaGEyZzIuY3JsMIGQBggrBgEFBQcBAQSB
# gzCBgDBEBggrBgEFBQcwAoY4aHR0cDovL3NlY3VyZS5nbG9iYWxzaWduLmNvbS9j
# YWNlcnQvZ3Njb2Rlc2lnbnNoYTJnMi5jcnQwOAYIKwYBBQUHMAGGLGh0dHA6Ly9v
# Y3NwMi5nbG9iYWxzaWduLmNvbS9nc2NvZGVzaWduc2hhMmcyMB0GA1UdDgQWBBTN
# GDddiIYZy9p3Z84iSIMd27rtUDAfBgNVHSMEGDAWgBQZSrha5E0xpRTlXuwvoxz6
# gIwyazANBgkqhkiG9w0BAQsFAAOCAQEAAApsOzSX1alF00fTeijB/aIthO3UB0ks
# 1Gg3xoKQC1iEQmFG/qlFLiufs52kRPN7L0a7ClNH3iQpaH5IEaUENT9cNEXdKTBG
# 8OrJS8lrDJXImgNEgtSwz0B40h7bM2Z+0DvXDvpmfyM2NwHF/nNVj7NzmczrLRqN
# 9de3tV0pgRqnIYordVcmb24CZl3bzpwzbQQy14Iz+P5Z2cnw+QaYzAuweTZxEUcJ
# bFwpM49c1LMPFJTuOKkUgY90JJ3gVTpyQxfkc7DNBnx74PlRzjFmeGC/hxQt0hvo
# eaAiBdjo/1uuCTToigVnyRH+c0T2AezTeoFb7ne3I538hWeTdU5q9jGCBLcwggSz
# AgEBMHAwWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MgISESENFrJbjBGW0/5XyYYR5rrZMAkGBSsOAwIaBQCgeDAYBgorBgEEAYI3AgEM
# MQowCKACgAChAoAAMBkGCSqGSIb3DQEJAzEMBgorBgEEAYI3AgEEMBwGCisGAQQB
# gjcCAQsxDjAMBgorBgEEAYI3AgEVMCMGCSqGSIb3DQEJBDEWBBRwsh9M6xmqDyv7
# /xV4VrZ+p6befDANBgkqhkiG9w0BAQEFAASCAQAfLH0t857OfQwffcprWSYKBs4d
# cl5/rPc6SNZ+JAb26ccLIX2kDkllFPCC7xNNpaYWvAiPGQ0exSc+PcCcKh3Bgl+l
# nXZZ2+qBJ/QnKWhrA3+pabvKex5kTEB1AkawIcDCC4Q5TwNy4Ze+hfnBtfFUGzoX
# D6TsrUlF/8dLAW7hu2KuRH/WXAeXqsA6+/zNQUi4CRT3+d1986T/IP12kRKT88Nv
# 3pOvh6VdIpfgtDmIBCJKHx5MedlKA8q8z2tpgkfiZ7Kh1aw9A1fFsL0aomvLE1iM
# eyoNGQPNrg6F5SIkXXGUKTMY2VIYYlsm1C2dWhfadTCVZ8X+AbP6n72WdfN7oYIC
# ojCCAp4GCSqGSIb3DQEJBjGCAo8wggKLAgEBMGgwUjELMAkGA1UEBhMCQkUxGTAX
# BgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGlt
# ZXN0YW1waW5nIENBIC0gRzICEhEh1pmnZJc+8fhCfukZzFNBFDAJBgUrDgMCGgUA
# oIH9MBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTE2
# MDgzMTE5MTY1OVowIwYJKoZIhvcNAQkEMRYEFE5KLAziI2PGoi/GWANXaYOe1DU3
# MIGdBgsqhkiG9w0BCRACDDGBjTCBijCBhzCBhAQUY7gvq2H1g5CWlQULACScUCkz
# 7HkwbDBWpFQwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYt
# c2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzICEhEh
# 1pmnZJc+8fhCfukZzFNBFDANBgkqhkiG9w0BAQEFAASCAQA210v/48EEo2Uad9UE
# jZG4q07EPfxZj+Hg6auyObOcvo4He1sYQRNP5Os29gCTrbCF1wdQtJKKw5jrTcbX
# 5Ei6s2j5DzdBdNMMZnS3mo0W/7hmHx605zg5l7PNOSSuA3tECqabgr6CsZI1T43+
# K99U9Sbm+hAUWh32voXe3+Zt5IlwfviIVaqH4txnURrdwPZS0fYH5AFXbqjwuxVx
# MKlmW7sGtKv8CSHgpGHrfnEewfu5Uj2mVVZey+/um1bzmyuLpXUDo9YYdi6bEwO+
# I7uXt1O0b/BiGY7h9VRy1wLhIaG+fn0krQfUC11YaQwamiosqMP+ykdNZGhCW+cI
# TVDn
# SIG # End signature block
|
PowerShellCorpus/PowerShellGallery/biz.dfch.PS.Appclusive.Client/5.2.1.20161201/Get-Version.ps1
|
Get-Version.ps1
|
function Get-Version {
<#
.SYNOPSIS
Displays the version of all Appclusive related components.
.DESCRIPTION
Displays the version of all Appclusive related components.
.INPUTS
The Cmdlet can either return all available versions or version per single
item.
See PARAMETERS section on possible inputs.
.OUTPUTS
default | json | json-pretty | xml | xml-pretty
.EXAMPLE
# List all available versions
PS > Get-Version -All
Name Value
---- -----
Core 2.15.2.25140
biz.dfch.PS.Appclusive.Client 2.8.2.20160704
biz.dfch.CS.Appclusive.Api 2.8.0.24089
Infrastructure 2.15.2.25140
Cmp 2.15.2.25140
biz.dfch.CS.Appclusive.Public 2.8.3.40225
Diagnostics 2.15.2.25140
BaseUri 0.0.0.0
Csm 2.15.2.25140
.EXAMPLE
# List module version
PS > Get-Version -Module
Major Minor Build Revision
----- ----- ----- --------
2 8 2 20160704
.EXAMPLE
# List biz.dfch.CS.Appclusive.Api version
PS > Get-Version -Api
Major Minor Build Revision
----- ----- ----- --------
2 8 0 24089
.EXAMPLE
# List biz.dfch.CS.Appclusive.Public version
PS > Get-Version -Public
Major Minor Build Revision
----- ----- ----- --------
2 8 3 40225
.EXAMPLE
# List Server version
PS > Get-Version -Server
Name Value
---- -----
Diagnostics 2.15.2.25140
Infrastructure 2.15.2.25140
Cmp 2.15.2.25140
Core 2.15.2.25140
BaseUri 0.0.0.0
Csm 2.15.2.25140
.LINK
Online Version: http://dfch.biz/biz/dfch/PS/Appclusive/Client/Get-Version/
.NOTES
See module manifest for required software versions and dependencies.
#>
[CmdletBinding(
SupportsShouldProcess = $false
,
ConfirmImpact = 'Low'
,
HelpURI = 'http://dfch.biz/biz/dfch/PS/Appclusive/Client/Get-Version/'
,
DefaultParameterSetName = 'list'
)]
PARAM
(
# Display version of Appclusive Server
[Parameter(Mandatory = $false, ParameterSetName = 'Server')]
[Switch] $Server
,
# Display version of biz.dfch.CS.Appclusive.Api
[Parameter(Mandatory = $false, ParameterSetName = 'Api')]
[Switch] $Api
,
# Display version of biz.dfch.CS.Appclusive.Public
[Parameter(Mandatory = $false, ParameterSetName = 'Public')]
[Switch] $Public
,
# Display module version
[Parameter(Mandatory = $false, ParameterSetName = 'Module')]
[Switch] $Module
,
# Lists all available versions
[Parameter(Mandatory = $false, ParameterSetName = 'list')]
[Switch] $All
,
# Lists all available versions
[Parameter(Mandatory = $false, ParameterSetName = 'ApiServerComp')]
[Switch] $ApiServerCompatibility
,
# Service reference to Appclusive
[Parameter(Mandatory = $false)]
[Alias('Services')]
[hashtable] $svc = (Get-Variable -Name $MyInvocation.MyCommand.Module.PrivateData.MODULEVAR -ValueOnly).Services
,
# Specifies the return format of the Cmdlet
[ValidateSet('default', 'json', 'json-pretty', 'xml', 'xml-pretty')]
[Parameter(Mandatory = $false)]
[alias('ReturnFormat')]
[string] $As = 'default'
)
Begin
{
trap { Log-Exception $_; break; }
$datBegin = [datetime]::Now;
[string] $fn = $MyInvocation.MyCommand.Name;
Log-Debug -fn $fn -msg ("CALL.") -fac 1;
Contract-Requires ($svc.Core -is [biz.dfch.CS.Appclusive.Api.Core.Core]) "Connect to the server before using the Cmdlet"
}
# Begin
Process
{
trap { Log-Exception $_; break; }
# Default test variable for checking function response codes.
[Boolean] $fReturn = $false;
switch($PSCmdlet.ParameterSetName)
{
'list'
{
$Response = [ordered] @{};
$Response.'biz.dfch.PS.Appclusive.Client' = GetVersionModule;
$Response.'biz.dfch.CS.Appclusive.Public' = GetVersionPublic;
$Response.'biz.dfch.CS.Appclusive.Api' = GetVersionApi;
$endpoints = GetVersionEndpoints;
$Response = Merge-Hashtable $Response $endpoints;
}
'Module'
{
$Response = GetVersionModule;
}
'Public'
{
$Response = GetVersionModule;
}
'Api'
{
$Response = GetVersionApi;
}
'Server'
{
$Response = GetVersionEndpoints;
}
'ApiServerComp'
{
$Response = GetApiServerCompatibility;
}
}
$OutputParameter = Format-ResultAs $Response $As
$fReturn = $true;
}
# Process
End
{
$datEnd = [datetime]::Now;
Log-Debug -fn $fn -msg ("RET. fReturn: [{0}]. Execution time: [{1}]ms. Started: [{2}]." -f $fReturn, ($datEnd - $datBegin).TotalMilliseconds, $datBegin.ToString('yyyy-MM-dd HH:mm:ss.fffzzz')) -fac 2;
# Return values are always and only returned via OutputParameter.
return $OutputParameter;
}
# End
} # function
function GetVersionModule
{
$m = Get-Module 'biz.dfch.PS.Appclusive.Client';
$response = $m.Version;
return $response;
}
function GetVersionPublic
{
$canPublicVersionBeExtracted = [biz.dfch.CS.Appclusive.Public.Constants].AssemblyQualifiedName -match 'Version=(\d+\.\d+\.\d+\.\d+)';
Contract-Assert $canPublicVersionBeExtracted;
$response = $Matches[1] -as [Version];
return $response;
}
function GetVersionApi
{
$response = [biz.dfch.CS.Appclusive.Api.Diagnostics.Diagnostics]::GetVersion();
Contract-Assert (!!$response);
return $response;
}
function GetApiServerCompatibility
{
$response = $svc.Diagnostics.GetSemverCompatibility();
return $response;
}
function GetVersionEndpoints
{
$response = @{};
try
{
$endpoints = $svc.Diagnostics.Endpoints | Select;
foreach($endpoint in $endpoints)
{
$Response.Add($endpoint.Name, [Version] $endpoint.Version);
}
}
catch
{
$message = ("An error occurred retrieving endpoint information from '{0}' with user '{1}'" -f $biz_dfch_PS_Appclusive_Client.ServerBaseUri, $biz_dfch_PS_Appclusive_Client.Credential.UserName);
Log-Warning $fn $message;
Write-Warning $message;
}
return $response;
}
if($MyInvocation.ScriptName) { Export-ModuleMember -Function Get-Version; }
#
# Copyright 2015-2016 d-fens GmbH
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SIG # Begin signature block
# MIIXDwYJKoZIhvcNAQcCoIIXADCCFvwCAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB
# gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR
# AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQUHLvk7lOi08bbp/L2OARxd6cy
# HN6gghHCMIIEFDCCAvygAwIBAgILBAAAAAABL07hUtcwDQYJKoZIhvcNAQEFBQAw
# VzELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNV
# BAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkdsb2JhbFNpZ24gUm9vdCBDQTAeFw0xMTA0
# MTMxMDAwMDBaFw0yODAxMjgxMjAwMDBaMFIxCzAJBgNVBAYTAkJFMRkwFwYDVQQK
# ExBHbG9iYWxTaWduIG52LXNhMSgwJgYDVQQDEx9HbG9iYWxTaWduIFRpbWVzdGFt
# cGluZyBDQSAtIEcyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAlO9l
# +LVXn6BTDTQG6wkft0cYasvwW+T/J6U00feJGr+esc0SQW5m1IGghYtkWkYvmaCN
# d7HivFzdItdqZ9C76Mp03otPDbBS5ZBb60cO8eefnAuQZT4XljBFcm05oRc2yrmg
# jBtPCBn2gTGtYRakYua0QJ7D/PuV9vu1LpWBmODvxevYAll4d/eq41JrUJEpxfz3
# zZNl0mBhIvIG+zLdFlH6Dv2KMPAXCae78wSuq5DnbN96qfTvxGInX2+ZbTh0qhGL
# 2t/HFEzphbLswn1KJo/nVrqm4M+SU4B09APsaLJgvIQgAIMboe60dAXBKY5i0Eex
# +vBTzBj5Ljv5cH60JQIDAQABo4HlMIHiMA4GA1UdDwEB/wQEAwIBBjASBgNVHRMB
# Af8ECDAGAQH/AgEAMB0GA1UdDgQWBBRG2D7/3OO+/4Pm9IWbsN1q1hSpwTBHBgNV
# HSAEQDA+MDwGBFUdIAAwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93d3cuZ2xvYmFs
# c2lnbi5jb20vcmVwb3NpdG9yeS8wMwYDVR0fBCwwKjAooCagJIYiaHR0cDovL2Ny
# bC5nbG9iYWxzaWduLm5ldC9yb290LmNybDAfBgNVHSMEGDAWgBRge2YaRQ2XyolQ
# L30EzTSo//z9SzANBgkqhkiG9w0BAQUFAAOCAQEATl5WkB5GtNlJMfO7FzkoG8IW
# 3f1B3AkFBJtvsqKa1pkuQJkAVbXqP6UgdtOGNNQXzFU6x4Lu76i6vNgGnxVQ380W
# e1I6AtcZGv2v8Hhc4EvFGN86JB7arLipWAQCBzDbsBJe/jG+8ARI9PBw+DpeVoPP
# PfsNvPTF7ZedudTbpSeE4zibi6c1hkQgpDttpGoLoYP9KOva7yj2zIhd+wo7AKvg
# IeviLzVsD440RZfroveZMzV+y5qKu0VN5z+fwtmK+mWybsd+Zf/okuEsMaL3sCc2
# SI8mbzvuTXYfecPlf5Y1vC0OzAGwjn//UYCAp5LUs0RGZIyHTxZjBzFLY7Df8zCC
# BCkwggMRoAMCAQICCwQAAAAAATGJxjfoMA0GCSqGSIb3DQEBCwUAMEwxIDAeBgNV
# BAsTF0dsb2JhbFNpZ24gUm9vdCBDQSAtIFIzMRMwEQYDVQQKEwpHbG9iYWxTaWdu
# MRMwEQYDVQQDEwpHbG9iYWxTaWduMB4XDTExMDgwMjEwMDAwMFoXDTE5MDgwMjEw
# MDAwMFowWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKPv0Z8p6djTgnY8YqDS
# SdYWHvHP8NC6SEMDLacd8gE0SaQQ6WIT9BP0FoO11VdCSIYrlViH6igEdMtyEQ9h
# JuH6HGEVxyibTQuCDyYrkDqW7aTQaymc9WGI5qRXb+70cNCNF97mZnZfdB5eDFM4
# XZD03zAtGxPReZhUGks4BPQHxCMD05LL94BdqpxWBkQtQUxItC3sNZKaxpXX9c6Q
# MeJ2s2G48XVXQqw7zivIkEnotybPuwyJy9DDo2qhydXjnFMrVyb+Vpp2/WFGomDs
# KUZH8s3ggmLGBFrn7U5AXEgGfZ1f53TJnoRlDVve3NMkHLQUEeurv8QfpLqZ0BdY
# Nc0CAwEAAaOB/TCB+jAOBgNVHQ8BAf8EBAMCAQYwEgYDVR0TAQH/BAgwBgEB/wIB
# ADAdBgNVHQ4EFgQUGUq4WuRNMaUU5V7sL6Mc+oCMMmswRwYDVR0gBEAwPjA8BgRV
# HSAAMDQwMgYIKwYBBQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3Jl
# cG9zaXRvcnkvMDYGA1UdHwQvMC0wK6ApoCeGJWh0dHA6Ly9jcmwuZ2xvYmFsc2ln
# bi5uZXQvcm9vdC1yMy5jcmwwEwYDVR0lBAwwCgYIKwYBBQUHAwMwHwYDVR0jBBgw
# FoAUj/BLf6guRSSuTVD6Y5qL3uLdG7wwDQYJKoZIhvcNAQELBQADggEBAHmwaTTi
# BYf2/tRgLC+GeTQD4LEHkwyEXPnk3GzPbrXsCly6C9BoMS4/ZL0Pgmtmd4F/ximl
# F9jwiU2DJBH2bv6d4UgKKKDieySApOzCmgDXsG1szYjVFXjPE/mIpXNNwTYr3MvO
# 23580ovvL72zT006rbtibiiTxAzL2ebK4BEClAOwvT+UKFaQHlPCJ9XJPM0aYx6C
# WRW2QMqngarDVa8z0bV16AnqRwhIIvtdG/Mseml+xddaXlYzPK1X6JMlQsPSXnE7
# ShxU7alVrCgFx8RsXdw8k/ZpPIJRzhoVPV4Bc/9Aouq0rtOO+u5dbEfHQfXUVlfy
# GDcy1tTMS/Zx4HYwggSfMIIDh6ADAgECAhIRIdaZp2SXPvH4Qn7pGcxTQRQwDQYJ
# KoZIhvcNAQEFBQAwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24g
# bnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzIw
# HhcNMTYwNTI0MDAwMDAwWhcNMjcwNjI0MDAwMDAwWjBgMQswCQYDVQQGEwJTRzEf
# MB0GA1UEChMWR01PIEdsb2JhbFNpZ24gUHRlIEx0ZDEwMC4GA1UEAxMnR2xvYmFs
# U2lnbiBUU0EgZm9yIE1TIEF1dGhlbnRpY29kZSAtIEcyMIIBIjANBgkqhkiG9w0B
# AQEFAAOCAQ8AMIIBCgKCAQEAsBeuotO2BDBWHlgPse1VpNZUy9j2czrsXV6rJf02
# pfqEw2FAxUa1WVI7QqIuXxNiEKlb5nPWkiWxfSPjBrOHOg5D8NcAiVOiETFSKG5d
# QHI88gl3p0mSl9RskKB2p/243LOd8gdgLE9YmABr0xVU4Prd/4AsXximmP/Uq+yh
# RVmyLm9iXeDZGayLV5yoJivZF6UQ0kcIGnAsM4t/aIAqtaFda92NAgIpA6p8N7u7
# KU49U5OzpvqP0liTFUy5LauAo6Ml+6/3CGSwekQPXBDXX2E3qk5r09JTJZ2Cc/os
# +XKwqRk5KlD6qdA8OsroW+/1X1H0+QrZlzXeaoXmIwRCrwIDAQABo4IBXzCCAVsw
# DgYDVR0PAQH/BAQDAgeAMEwGA1UdIARFMEMwQQYJKwYBBAGgMgEeMDQwMgYIKwYB
# BQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3JlcG9zaXRvcnkvMAkG
# A1UdEwQCMAAwFgYDVR0lAQH/BAwwCgYIKwYBBQUHAwgwQgYDVR0fBDswOTA3oDWg
# M4YxaHR0cDovL2NybC5nbG9iYWxzaWduLmNvbS9ncy9nc3RpbWVzdGFtcGluZ2cy
# LmNybDBUBggrBgEFBQcBAQRIMEYwRAYIKwYBBQUHMAKGOGh0dHA6Ly9zZWN1cmUu
# Z2xvYmFsc2lnbi5jb20vY2FjZXJ0L2dzdGltZXN0YW1waW5nZzIuY3J0MB0GA1Ud
# DgQWBBTUooRKOFoYf7pPMFC9ndV6h9YJ9zAfBgNVHSMEGDAWgBRG2D7/3OO+/4Pm
# 9IWbsN1q1hSpwTANBgkqhkiG9w0BAQUFAAOCAQEAj6kakW0EpjcgDoOW3iPTa24f
# bt1kPWghIrX4RzZpjuGlRcckoiK3KQnMVFquxrzNY46zPVBI5bTMrs2SjZ4oixNK
# Eaq9o+/Tsjb8tKFyv22XY3mMRLxwL37zvN2CU6sa9uv6HJe8tjecpBwwvKu8LUc2
# 35IgA+hxxlj2dQWaNPALWVqCRDSqgOQvhPZHXZbJtsrKnbemuuRQ09Q3uLogDtDT
# kipbxFm7oW3bPM5EncE4Kq3jjb3NCXcaEL5nCgI2ZIi5sxsm7ueeYMRGqLxhM2zP
# TrmcuWrwnzf+tT1PmtNN/94gjk6Xpv2fCbxNyhh2ybBNhVDygNIdBvVYBAexGDCC
# BNYwggO+oAMCAQICEhEhDRayW4wRltP+V8mGEea62TANBgkqhkiG9w0BAQsFADBa
# MQswCQYDVQQGEwJCRTEZMBcGA1UEChMQR2xvYmFsU2lnbiBudi1zYTEwMC4GA1UE
# AxMnR2xvYmFsU2lnbiBDb2RlU2lnbmluZyBDQSAtIFNIQTI1NiAtIEcyMB4XDTE1
# MDUwNDE2NDMyMVoXDTE4MDUwNDE2NDMyMVowVTELMAkGA1UEBhMCQ0gxDDAKBgNV
# BAgTA1p1ZzEMMAoGA1UEBxMDWnVnMRQwEgYDVQQKEwtkLWZlbnMgR21iSDEUMBIG
# A1UEAxMLZC1mZW5zIEdtYkgwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB
# AQDNPSzSNPylU9jFM78Q/GjzB7N+VNqikf/use7p8mpnBZ4cf5b4qV3rqQd62rJH
# RlAsxgouCSNQrl8xxfg6/t/I02kPvrzsR4xnDgMiVCqVRAeQsWebafWdTvWmONBS
# lxJejPP8TSgXMKFaDa+2HleTycTBYSoErAZSWpQ0NqF9zBadjsJRVatQuPkTDrwL
# eWibiyOipK9fcNoQpl5ll5H9EG668YJR3fqX9o0TQTkOmxXIL3IJ0UxdpyDpLEkt
# tBG6Y5wAdpF2dQX2phrfFNVY54JOGtuBkNGMSiLFzTkBA1fOlA6ICMYjB8xIFxVv
# rN1tYojCrqYkKMOjwWQz5X8zAgMBAAGjggGZMIIBlTAOBgNVHQ8BAf8EBAMCB4Aw
# TAYDVR0gBEUwQzBBBgkrBgEEAaAyATIwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93
# d3cuZ2xvYmFsc2lnbi5jb20vcmVwb3NpdG9yeS8wCQYDVR0TBAIwADATBgNVHSUE
# DDAKBggrBgEFBQcDAzBCBgNVHR8EOzA5MDegNaAzhjFodHRwOi8vY3JsLmdsb2Jh
# bHNpZ24uY29tL2dzL2dzY29kZXNpZ25zaGEyZzIuY3JsMIGQBggrBgEFBQcBAQSB
# gzCBgDBEBggrBgEFBQcwAoY4aHR0cDovL3NlY3VyZS5nbG9iYWxzaWduLmNvbS9j
# YWNlcnQvZ3Njb2Rlc2lnbnNoYTJnMi5jcnQwOAYIKwYBBQUHMAGGLGh0dHA6Ly9v
# Y3NwMi5nbG9iYWxzaWduLmNvbS9nc2NvZGVzaWduc2hhMmcyMB0GA1UdDgQWBBTN
# GDddiIYZy9p3Z84iSIMd27rtUDAfBgNVHSMEGDAWgBQZSrha5E0xpRTlXuwvoxz6
# gIwyazANBgkqhkiG9w0BAQsFAAOCAQEAAApsOzSX1alF00fTeijB/aIthO3UB0ks
# 1Gg3xoKQC1iEQmFG/qlFLiufs52kRPN7L0a7ClNH3iQpaH5IEaUENT9cNEXdKTBG
# 8OrJS8lrDJXImgNEgtSwz0B40h7bM2Z+0DvXDvpmfyM2NwHF/nNVj7NzmczrLRqN
# 9de3tV0pgRqnIYordVcmb24CZl3bzpwzbQQy14Iz+P5Z2cnw+QaYzAuweTZxEUcJ
# bFwpM49c1LMPFJTuOKkUgY90JJ3gVTpyQxfkc7DNBnx74PlRzjFmeGC/hxQt0hvo
# eaAiBdjo/1uuCTToigVnyRH+c0T2AezTeoFb7ne3I538hWeTdU5q9jGCBLcwggSz
# AgEBMHAwWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MgISESENFrJbjBGW0/5XyYYR5rrZMAkGBSsOAwIaBQCgeDAYBgorBgEEAYI3AgEM
# MQowCKACgAChAoAAMBkGCSqGSIb3DQEJAzEMBgorBgEEAYI3AgEEMBwGCisGAQQB
# gjcCAQsxDjAMBgorBgEEAYI3AgEVMCMGCSqGSIb3DQEJBDEWBBQysnj2PDLvGNds
# pgLZYcEy1M+J2TANBgkqhkiG9w0BAQEFAASCAQDLxMkGH4g9EIjz2FILDREccv3w
# SOt+xj2xgMN5cwYl/1xaDmNmsp0IUF2qxGPYcH0lYDToDtcWfTaEo8syQVa6tFf3
# WJsgbX5h5rtJuVErG/W0QRvr4JHxwVYpJrzjadQw3QAssX8r9Y0vALLqkIM3+a/8
# 8PD/b36Vxu0P6YYET14HpWN89ho3kVyZg9M5DCIHIKihlisi+j2GjTxGhu/lx7EQ
# ipkHx00bm1gRhmXQOryNvBGPggyFTcCC6NjVrBb4lGeYZpHfTspHqwvBy21yzETY
# 72mQj9dQ7xisop4Kj1HjwTLesm1/OmF9dy5laZ2aOP7mi+zYLJm1+uKWEbaUoYIC
# ojCCAp4GCSqGSIb3DQEJBjGCAo8wggKLAgEBMGgwUjELMAkGA1UEBhMCQkUxGTAX
# BgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGlt
# ZXN0YW1waW5nIENBIC0gRzICEhEh1pmnZJc+8fhCfukZzFNBFDAJBgUrDgMCGgUA
# oIH9MBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTE2
# MDgzMTE5MTY0OVowIwYJKoZIhvcNAQkEMRYEFLoIREXodT52ZZv6azcDHJWMk6WK
# MIGdBgsqhkiG9w0BCRACDDGBjTCBijCBhzCBhAQUY7gvq2H1g5CWlQULACScUCkz
# 7HkwbDBWpFQwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYt
# c2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzICEhEh
# 1pmnZJc+8fhCfukZzFNBFDANBgkqhkiG9w0BAQEFAASCAQCUxD79Ddo8IAKBP3/9
# QUTBc+GPpuCng9T/Ooi/OmUNhllYad2Ix1SkjPIx9MLMseba+ntmdCHAaZa0CBGO
# sk2e+AF67y7gaFlwP5tffeuIAG8g15yAh55Q5J30wQdrFA1KFnG/YqDi3nDxp3rp
# I400/lUUfmAQCjy3NcSrY5F+NuCG6dZPX+T5nmnaoNLiMQ/V2wtTfGbK73n/CyHb
# TXDJ2a8LoR2U9f+OuI4a3oY7WkIQZ1NGdnoIw+cVPN81DKOvejWRkNsg6yspaLwg
# 5JwV+vSZ+jLmzhoODiawITOOqRcQsBOoOmZvNBkVm9q+zkpQ2pC6PjX5JmiPvx/6
# uLNW
# SIG # End signature block
|
PowerShellCorpus/PowerShellGallery/biz.dfch.PS.Appclusive.Client/5.2.1.20161201/Set-Tenant.ps1
|
Set-Tenant.ps1
|
function Set-Tenant {
<#
.SYNOPSIS
Connects a Tenant entry with a Customer entry in Appclusive.
.DESCRIPTION
Connects a Tenant entry with a Customer entry in Appclusive.
By connecting a Tenant entry with a Customer you can specify the Customer
by Name, Id or by the ContractMapping ExternalId.
.OUTPUTS
default
.EXAMPLE
Set-Tenant -Id 'deaddead-dead-dead-dead-deaddeaddead' -CustomerId 42 -svc $svc;
Id : deaddead-dead-dead-dead-deaddeaddead
Name : Arbitrary Tenant
Description : Arbitrary Tenant
ExternalId : deaddead-dead-dead-dead-deaddeaddead
ExternalType : External
CreatedById : 1
ModifiedById : 1
Created : 01.12.2016 09:00:00 +00:00
Modified : 01.12.2016 13:57:53 +00:00
RowVersion : {0, 0, 0, 0...}
ParentId : 11111111-1111-1111-1111-111111111111
CustomerId : 42
Parent :
Customer :
Children : {}
Connect a Tenant entry with the specified Customer.
.EXAMPLE
Set-Tenant -Id 'deaddead-dead-dead-dead-deaddeaddead' -CustomerName 'Arbitrary Customer' -svc $svc;
Id : deaddead-dead-dead-dead-deaddeaddead
Name : Arbitrary Tenant
Description : Arbitrary Tenant
ExternalId : deaddead-dead-dead-dead-deaddeaddead
ExternalType : External
CreatedById : 1
ModifiedById : 1
Created : 01.12.2016 09:00:00 +00:00
Modified : 01.12.2016 13:57:53 +00:00
RowVersion : {0, 0, 0, 0...}
ParentId : 11111111-1111-1111-1111-111111111111
CustomerId : 42
Parent :
Customer :
Children : {}
Connect a Tenant entry with the specified Customer.
.EXAMPLE
Set-Tenant -Id 'deaddead-dead-dead-dead-deaddeaddead' -ContractMappingExternalId 'Arbitrary Contract' -svc $svc;
Id : deaddead-dead-dead-dead-deaddeaddead
Name : Arbitrary Tenant
Description : Arbitrary Tenant
ExternalId : deaddead-dead-dead-dead-deaddeaddead
ExternalType : External
CreatedById : 1
ModifiedById : 1
Created : 01.12.2016 09:00:00 +00:00
Modified : 01.12.2016 13:57:53 +00:00
RowVersion : {0, 0, 0, 0...}
ParentId : 11111111-1111-1111-1111-111111111111
CustomerId : 42
Parent :
Customer :
Children : {}
Connect a Tenant entry with the Customer of the specified ContractMapping.
.LINK
Online Version: http://dfch.biz/biz/dfch/PS/Appclusive/Client/Set-Tenant/
Set-Tenant: http://dfch.biz/biz/dfch/PS/Appclusive/Client/Set-Tenant/
.NOTES
See module manifest for dependencies and further requirements.
#>
[CmdletBinding(
SupportsShouldProcess = $false
,
ConfirmImpact = 'Low'
,
HelpURI = 'http://dfch.biz/biz/dfch/PS/Appclusive/Client/Set-Tenant/'
)]
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseShouldProcessForStateChangingFunctions", "")]
Param
(
[Parameter(Mandatory = $true, Position = 0)]
[Guid] $Id
,
[Parameter(Mandatory = $true, ParameterSetName = 'customerId', Position = 1)]
[ValidateRange(1, [long]::MaxValue)]
[long] $CustomerId
,
[Parameter(Mandatory = $true, ParameterSetName = 'customerName', Position = 1)]
[ValidateNotNullOrEmpty()]
[string] $CustomerName
,
[Parameter(Mandatory = $true, ParameterSetName = 'contractMappingId', Position = 1)]
[ValidateNotNullOrEmpty()]
[Alias('contractId')]
[string] $ContractMappingExternalId
,
# Service reference to Appclusive
[Parameter(Mandatory = $false)]
[Alias('Services')]
[hashtable] $svc = (Get-Variable -Name $MyInvocation.MyCommand.Module.PrivateData.MODULEVAR -ValueOnly).Services
,
# Specifies the return format of the Cmdlet
[ValidateSet('default', 'json', 'json-pretty', 'xml', 'xml-pretty')]
[Parameter(Mandatory = $false)]
[alias('ReturnFormat')]
[string] $As = 'default'
)
Begin
{
trap { Log-Exception $_; break; }
$datBegin = [datetime]::Now;
[string] $fn = $MyInvocation.MyCommand.Name;
Log-Debug -fn $fn -msg ("CALL. svc '{0}'. Name '{1}'." -f ($svc -is [Object]), $Name) -fac 1;
# Parameter validation
Contract-Requires ($svc.Core -is [biz.dfch.CS.Appclusive.Api.Core.Core]) "Connect to the server before using the Cmdlet";
}
Process
{
trap { Log-Exception $_; break; }
# Default test variable for checking function response codes.
[Boolean] $fReturn = $false;
# Return values are always and only returned via OutputParameter.
$OutputParameter = $null;
# Get Tenant
$filterExpression = "Id eq guid'{0}'" -f $Id;
$entity = $svc.Core.Tenants.AddQueryOption('$filter', $filterExpression).AddQueryOption('$top', 1) | Select;
Contract-Assert ($entity) "Entity does not exist";
if($PSCmdlet.ParameterSetName -eq 'contractMappingId')
{
$filterExpression = "ExternalId eq '{0}'" -f $ContractMappingExternalId;
$contractMapping = $svc.Core.ContractMappings.AddQueryOption('$filter', $filterExpression) | Select;
Contract-Assert($contractMapping);
Contract-Assert(1 -eq $contractMapping.Count) "More than one ContractMapping with specified ExternalId found";
$filterExpression = "Id eq {0}" -f $contractMapping.CustomerId;
$customer = $svc.Core.Customers.AddQueryOption('$filter', $filterExpression) | Select;
Contract-Assert($customer);
$entity.CustomerId = $customer.Id;
}
elseif($PSCmdlet.ParameterSetName -eq 'customerId')
{
$filterExpression = "Id eq {0}" -f $CustomerId;
$customer = $svc.Core.Customers.AddQueryOption('$filter', $filterExpression) | Select;
Contract-Assert($customer);
$entity.CustomerId = $customer.Id;
}
elseif($PSCmdlet.ParameterSetName -eq 'customerName')
{
$filterExpression = "Name eq '{0}'" -f $CustomerName;
$customer = $svc.Core.Customers.AddQueryOption('$filter', $filterExpression) | Select;
Contract-Assert($customer);
Contract-Assert(1 -eq $customer.Count) "More than one Customer with specified Name found";
$entity.CustomerId = $customer.Id;
}
$svc.Core.UpdateObject($entity);
$null = $svc.Core.SaveChanges();
$r = $entity;
$OutputParameter = Format-ResultAs $r $As;
$fReturn = $true;
}
End
{
$datEnd = [datetime]::Now;
Log-Debug -fn $fn -msg ("RET. fReturn: [{0}]. Execution time: [{1}]ms. Started: [{2}]." -f $fReturn, ($datEnd - $datBegin).TotalMilliseconds, $datBegin.ToString('yyyy-MM-dd HH:mm:ss.fffzzz')) -fac 2;
# Return values are always and only returned via OutputParameter.
return $OutputParameter;
}
}
if($MyInvocation.ScriptName) { Export-ModuleMember -Function Set-Tenant; }
#
# Copyright 2016 d-fens GmbH
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
|
PowerShellCorpus/PowerShellGallery/biz.dfch.PS.Appclusive.Client/5.2.1.20161201/Remove-KeyNameValue.ps1
|
Remove-KeyNameValue.ps1
|
function Remove-KeyNameValue {
<#
.SYNOPSIS
Removes a KNV entry from the KNV store.
.DESCRIPTION
Removes a KNV entry from the KNV store.
The Cmdlet lets you remove an existing entry from the KNV store.
.EXAMPLE
Remove-KeyNameValue myKey myName myValue -Confirm
Removes the KNV myKey/myName/myValue with explicit confirmation.
#>
[CmdletBinding(
SupportsShouldProcess = $true
,
ConfirmImpact = 'High'
,
HelpURI = 'http://dfch.biz/biz/dfch/PS/Appclusive/Client/Remove-KeyNameValue/'
)]
Param
(
# The key name portion of the KNV to remove
[Parameter(Mandatory = $false, Position = 0, ParameterSetName = 'name')]
[string] $Key
,
# The name name portion of the KNV to remove
[Parameter(Mandatory = $false, Position = 1, ParameterSetName = 'name')]
[string] $Name
,
# The value name portion of the KNV to remove
[Parameter(Mandatory = $false, Position = 2, ParameterSetName = 'name')]
[string] $Value
,
# Service reference to Appclusive
[Parameter(Mandatory = $false)]
[Alias('Services')]
[hashtable] $svc = (Get-Variable -Name $MyInvocation.MyCommand.Module.PrivateData.MODULEVAR -ValueOnly).Services
,
# Specifies the return format of the Cnmdlet
[ValidateSet('default', 'json', 'json-pretty', 'xml', 'xml-pretty')]
[Parameter(Mandatory = $false)]
[alias('ReturnFormat')]
[string] $As = 'default'
)
Begin
{
trap { Log-Exception $_; break; }
$datBegin = [datetime]::Now;
[string] $fn = $MyInvocation.MyCommand.Name;
Log-Debug -fn $fn -msg ("CALL. svc '{0}'. Name '{1}'." -f ($svc -is [Object]), $Name) -fac 1;
# Parameter validation
Contract-Requires ($svc.Core -is [biz.dfch.CS.Appclusive.Api.Core.Core]) "Connect to the server before using the Cmdlet"
}
# Begin
Process
{
trap { Log-Exception $_; break; }
# Default test variable for checking function response codes.
[Boolean] $fReturn = $false;
# Return values are always and only returned via OutputParameter.
$OutputParameter = $null;
$MaxPropertyLength = 475;
$Exp = @();
if($Key.Length -lt $MaxPropertyLength)
{
$Exp += ("(tolower(Key) eq '{0}')" -f $Key.ToLower());
$KeyNameValueContents += $Key;
}
else
{
$shortenedKey = $Key.substring(0,$MaxPropertyLength);
$Exp += ("(startswith(tolower(Key), '{0}'))" -f $shortenedKey.ToLower());
$KeyNameValueContents += $Key;
}
if($Name.Length -lt $MaxPropertyLength)
{
$Exp += ("(tolower(Name) eq '{0}')" -f $Name.ToLower());
$KeyNameValueContents += $Name;
}
else
{
$shortenedName = $Name.substring(0,$MaxPropertyLength);
$Exp += ("(startswith(tolower(Name), '{0}'))" -f $shortenedName.ToLower());
$KeyNameValueContents += $Name;
}
if($Value.Length -lt $MaxPropertyLength)
{
$Exp += ("(tolower(Value) eq '{0}')" -f $Value.ToLower());
$KeyNameValueContents += $Value;
}
else
{
$shortenedValue = $Value.substring(0,$MaxPropertyLength);
$Exp += ("(startswith(tolower(Value), '{0}'))" -f $shortenedValue.ToLower());
$KeyNameValueContents += $Value;
}
$FilterExpression = [String]::Join(' and ', $Exp);
$knv = $svc.Core.KeyNameValues.AddQueryOption('$filter',$FilterExpression);
$r = @();
$keyNameValueExists = $false;
foreach($item in $knv)
{
$keyNameValueExists = $true;
$itemString = '{0}/{1}/{2}' -f $item.Key, $item.Name, $item.Value;
if($PSCmdlet.ShouldProcess($itemString))
{
$r += ($item | Select -Property Key, Name, Value);
Log-Notice $fn ("Removing '{0}' ..." -f $itemString);
$svc.Core.DeleteObject($item);
$null = $svc.Core.SaveChanges();
}
}
Contract-Assert ($keyNameValueExists)
$OutputParameter = Format-ResultAs $r $As
$fReturn = $true;
}
# Process
End
{
$datEnd = [datetime]::Now;
Log-Debug -fn $fn -msg ("RET. fReturn: [{0}]. Execution time: [{1}]ms. Started: [{2}]." -f $fReturn, ($datEnd - $datBegin).TotalMilliseconds, $datBegin.ToString('yyyy-MM-dd HH:mm:ss.fffzzz')) -fac 2;
# Return values are always and only returned via OutputParameter.
return $OutputParameter;
}
# End
}
if($MyInvocation.ScriptName) { Export-ModuleMember -Function Remove-KeyNameValue; }
#
# Copyright 2014-2015 d-fens GmbH
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SIG # Begin signature block
# MIIXDwYJKoZIhvcNAQcCoIIXADCCFvwCAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB
# gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR
# AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQU5EafSiXZGc1aeQ0Uf7Xmp5Xj
# TyWgghHCMIIEFDCCAvygAwIBAgILBAAAAAABL07hUtcwDQYJKoZIhvcNAQEFBQAw
# VzELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNV
# BAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkdsb2JhbFNpZ24gUm9vdCBDQTAeFw0xMTA0
# MTMxMDAwMDBaFw0yODAxMjgxMjAwMDBaMFIxCzAJBgNVBAYTAkJFMRkwFwYDVQQK
# ExBHbG9iYWxTaWduIG52LXNhMSgwJgYDVQQDEx9HbG9iYWxTaWduIFRpbWVzdGFt
# cGluZyBDQSAtIEcyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAlO9l
# +LVXn6BTDTQG6wkft0cYasvwW+T/J6U00feJGr+esc0SQW5m1IGghYtkWkYvmaCN
# d7HivFzdItdqZ9C76Mp03otPDbBS5ZBb60cO8eefnAuQZT4XljBFcm05oRc2yrmg
# jBtPCBn2gTGtYRakYua0QJ7D/PuV9vu1LpWBmODvxevYAll4d/eq41JrUJEpxfz3
# zZNl0mBhIvIG+zLdFlH6Dv2KMPAXCae78wSuq5DnbN96qfTvxGInX2+ZbTh0qhGL
# 2t/HFEzphbLswn1KJo/nVrqm4M+SU4B09APsaLJgvIQgAIMboe60dAXBKY5i0Eex
# +vBTzBj5Ljv5cH60JQIDAQABo4HlMIHiMA4GA1UdDwEB/wQEAwIBBjASBgNVHRMB
# Af8ECDAGAQH/AgEAMB0GA1UdDgQWBBRG2D7/3OO+/4Pm9IWbsN1q1hSpwTBHBgNV
# HSAEQDA+MDwGBFUdIAAwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93d3cuZ2xvYmFs
# c2lnbi5jb20vcmVwb3NpdG9yeS8wMwYDVR0fBCwwKjAooCagJIYiaHR0cDovL2Ny
# bC5nbG9iYWxzaWduLm5ldC9yb290LmNybDAfBgNVHSMEGDAWgBRge2YaRQ2XyolQ
# L30EzTSo//z9SzANBgkqhkiG9w0BAQUFAAOCAQEATl5WkB5GtNlJMfO7FzkoG8IW
# 3f1B3AkFBJtvsqKa1pkuQJkAVbXqP6UgdtOGNNQXzFU6x4Lu76i6vNgGnxVQ380W
# e1I6AtcZGv2v8Hhc4EvFGN86JB7arLipWAQCBzDbsBJe/jG+8ARI9PBw+DpeVoPP
# PfsNvPTF7ZedudTbpSeE4zibi6c1hkQgpDttpGoLoYP9KOva7yj2zIhd+wo7AKvg
# IeviLzVsD440RZfroveZMzV+y5qKu0VN5z+fwtmK+mWybsd+Zf/okuEsMaL3sCc2
# SI8mbzvuTXYfecPlf5Y1vC0OzAGwjn//UYCAp5LUs0RGZIyHTxZjBzFLY7Df8zCC
# BCkwggMRoAMCAQICCwQAAAAAATGJxjfoMA0GCSqGSIb3DQEBCwUAMEwxIDAeBgNV
# BAsTF0dsb2JhbFNpZ24gUm9vdCBDQSAtIFIzMRMwEQYDVQQKEwpHbG9iYWxTaWdu
# MRMwEQYDVQQDEwpHbG9iYWxTaWduMB4XDTExMDgwMjEwMDAwMFoXDTE5MDgwMjEw
# MDAwMFowWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKPv0Z8p6djTgnY8YqDS
# SdYWHvHP8NC6SEMDLacd8gE0SaQQ6WIT9BP0FoO11VdCSIYrlViH6igEdMtyEQ9h
# JuH6HGEVxyibTQuCDyYrkDqW7aTQaymc9WGI5qRXb+70cNCNF97mZnZfdB5eDFM4
# XZD03zAtGxPReZhUGks4BPQHxCMD05LL94BdqpxWBkQtQUxItC3sNZKaxpXX9c6Q
# MeJ2s2G48XVXQqw7zivIkEnotybPuwyJy9DDo2qhydXjnFMrVyb+Vpp2/WFGomDs
# KUZH8s3ggmLGBFrn7U5AXEgGfZ1f53TJnoRlDVve3NMkHLQUEeurv8QfpLqZ0BdY
# Nc0CAwEAAaOB/TCB+jAOBgNVHQ8BAf8EBAMCAQYwEgYDVR0TAQH/BAgwBgEB/wIB
# ADAdBgNVHQ4EFgQUGUq4WuRNMaUU5V7sL6Mc+oCMMmswRwYDVR0gBEAwPjA8BgRV
# HSAAMDQwMgYIKwYBBQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3Jl
# cG9zaXRvcnkvMDYGA1UdHwQvMC0wK6ApoCeGJWh0dHA6Ly9jcmwuZ2xvYmFsc2ln
# bi5uZXQvcm9vdC1yMy5jcmwwEwYDVR0lBAwwCgYIKwYBBQUHAwMwHwYDVR0jBBgw
# FoAUj/BLf6guRSSuTVD6Y5qL3uLdG7wwDQYJKoZIhvcNAQELBQADggEBAHmwaTTi
# BYf2/tRgLC+GeTQD4LEHkwyEXPnk3GzPbrXsCly6C9BoMS4/ZL0Pgmtmd4F/ximl
# F9jwiU2DJBH2bv6d4UgKKKDieySApOzCmgDXsG1szYjVFXjPE/mIpXNNwTYr3MvO
# 23580ovvL72zT006rbtibiiTxAzL2ebK4BEClAOwvT+UKFaQHlPCJ9XJPM0aYx6C
# WRW2QMqngarDVa8z0bV16AnqRwhIIvtdG/Mseml+xddaXlYzPK1X6JMlQsPSXnE7
# ShxU7alVrCgFx8RsXdw8k/ZpPIJRzhoVPV4Bc/9Aouq0rtOO+u5dbEfHQfXUVlfy
# GDcy1tTMS/Zx4HYwggSfMIIDh6ADAgECAhIRIdaZp2SXPvH4Qn7pGcxTQRQwDQYJ
# KoZIhvcNAQEFBQAwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24g
# bnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzIw
# HhcNMTYwNTI0MDAwMDAwWhcNMjcwNjI0MDAwMDAwWjBgMQswCQYDVQQGEwJTRzEf
# MB0GA1UEChMWR01PIEdsb2JhbFNpZ24gUHRlIEx0ZDEwMC4GA1UEAxMnR2xvYmFs
# U2lnbiBUU0EgZm9yIE1TIEF1dGhlbnRpY29kZSAtIEcyMIIBIjANBgkqhkiG9w0B
# AQEFAAOCAQ8AMIIBCgKCAQEAsBeuotO2BDBWHlgPse1VpNZUy9j2czrsXV6rJf02
# pfqEw2FAxUa1WVI7QqIuXxNiEKlb5nPWkiWxfSPjBrOHOg5D8NcAiVOiETFSKG5d
# QHI88gl3p0mSl9RskKB2p/243LOd8gdgLE9YmABr0xVU4Prd/4AsXximmP/Uq+yh
# RVmyLm9iXeDZGayLV5yoJivZF6UQ0kcIGnAsM4t/aIAqtaFda92NAgIpA6p8N7u7
# KU49U5OzpvqP0liTFUy5LauAo6Ml+6/3CGSwekQPXBDXX2E3qk5r09JTJZ2Cc/os
# +XKwqRk5KlD6qdA8OsroW+/1X1H0+QrZlzXeaoXmIwRCrwIDAQABo4IBXzCCAVsw
# DgYDVR0PAQH/BAQDAgeAMEwGA1UdIARFMEMwQQYJKwYBBAGgMgEeMDQwMgYIKwYB
# BQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3JlcG9zaXRvcnkvMAkG
# A1UdEwQCMAAwFgYDVR0lAQH/BAwwCgYIKwYBBQUHAwgwQgYDVR0fBDswOTA3oDWg
# M4YxaHR0cDovL2NybC5nbG9iYWxzaWduLmNvbS9ncy9nc3RpbWVzdGFtcGluZ2cy
# LmNybDBUBggrBgEFBQcBAQRIMEYwRAYIKwYBBQUHMAKGOGh0dHA6Ly9zZWN1cmUu
# Z2xvYmFsc2lnbi5jb20vY2FjZXJ0L2dzdGltZXN0YW1waW5nZzIuY3J0MB0GA1Ud
# DgQWBBTUooRKOFoYf7pPMFC9ndV6h9YJ9zAfBgNVHSMEGDAWgBRG2D7/3OO+/4Pm
# 9IWbsN1q1hSpwTANBgkqhkiG9w0BAQUFAAOCAQEAj6kakW0EpjcgDoOW3iPTa24f
# bt1kPWghIrX4RzZpjuGlRcckoiK3KQnMVFquxrzNY46zPVBI5bTMrs2SjZ4oixNK
# Eaq9o+/Tsjb8tKFyv22XY3mMRLxwL37zvN2CU6sa9uv6HJe8tjecpBwwvKu8LUc2
# 35IgA+hxxlj2dQWaNPALWVqCRDSqgOQvhPZHXZbJtsrKnbemuuRQ09Q3uLogDtDT
# kipbxFm7oW3bPM5EncE4Kq3jjb3NCXcaEL5nCgI2ZIi5sxsm7ueeYMRGqLxhM2zP
# TrmcuWrwnzf+tT1PmtNN/94gjk6Xpv2fCbxNyhh2ybBNhVDygNIdBvVYBAexGDCC
# BNYwggO+oAMCAQICEhEhDRayW4wRltP+V8mGEea62TANBgkqhkiG9w0BAQsFADBa
# MQswCQYDVQQGEwJCRTEZMBcGA1UEChMQR2xvYmFsU2lnbiBudi1zYTEwMC4GA1UE
# AxMnR2xvYmFsU2lnbiBDb2RlU2lnbmluZyBDQSAtIFNIQTI1NiAtIEcyMB4XDTE1
# MDUwNDE2NDMyMVoXDTE4MDUwNDE2NDMyMVowVTELMAkGA1UEBhMCQ0gxDDAKBgNV
# BAgTA1p1ZzEMMAoGA1UEBxMDWnVnMRQwEgYDVQQKEwtkLWZlbnMgR21iSDEUMBIG
# A1UEAxMLZC1mZW5zIEdtYkgwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB
# AQDNPSzSNPylU9jFM78Q/GjzB7N+VNqikf/use7p8mpnBZ4cf5b4qV3rqQd62rJH
# RlAsxgouCSNQrl8xxfg6/t/I02kPvrzsR4xnDgMiVCqVRAeQsWebafWdTvWmONBS
# lxJejPP8TSgXMKFaDa+2HleTycTBYSoErAZSWpQ0NqF9zBadjsJRVatQuPkTDrwL
# eWibiyOipK9fcNoQpl5ll5H9EG668YJR3fqX9o0TQTkOmxXIL3IJ0UxdpyDpLEkt
# tBG6Y5wAdpF2dQX2phrfFNVY54JOGtuBkNGMSiLFzTkBA1fOlA6ICMYjB8xIFxVv
# rN1tYojCrqYkKMOjwWQz5X8zAgMBAAGjggGZMIIBlTAOBgNVHQ8BAf8EBAMCB4Aw
# TAYDVR0gBEUwQzBBBgkrBgEEAaAyATIwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93
# d3cuZ2xvYmFsc2lnbi5jb20vcmVwb3NpdG9yeS8wCQYDVR0TBAIwADATBgNVHSUE
# DDAKBggrBgEFBQcDAzBCBgNVHR8EOzA5MDegNaAzhjFodHRwOi8vY3JsLmdsb2Jh
# bHNpZ24uY29tL2dzL2dzY29kZXNpZ25zaGEyZzIuY3JsMIGQBggrBgEFBQcBAQSB
# gzCBgDBEBggrBgEFBQcwAoY4aHR0cDovL3NlY3VyZS5nbG9iYWxzaWduLmNvbS9j
# YWNlcnQvZ3Njb2Rlc2lnbnNoYTJnMi5jcnQwOAYIKwYBBQUHMAGGLGh0dHA6Ly9v
# Y3NwMi5nbG9iYWxzaWduLmNvbS9nc2NvZGVzaWduc2hhMmcyMB0GA1UdDgQWBBTN
# GDddiIYZy9p3Z84iSIMd27rtUDAfBgNVHSMEGDAWgBQZSrha5E0xpRTlXuwvoxz6
# gIwyazANBgkqhkiG9w0BAQsFAAOCAQEAAApsOzSX1alF00fTeijB/aIthO3UB0ks
# 1Gg3xoKQC1iEQmFG/qlFLiufs52kRPN7L0a7ClNH3iQpaH5IEaUENT9cNEXdKTBG
# 8OrJS8lrDJXImgNEgtSwz0B40h7bM2Z+0DvXDvpmfyM2NwHF/nNVj7NzmczrLRqN
# 9de3tV0pgRqnIYordVcmb24CZl3bzpwzbQQy14Iz+P5Z2cnw+QaYzAuweTZxEUcJ
# bFwpM49c1LMPFJTuOKkUgY90JJ3gVTpyQxfkc7DNBnx74PlRzjFmeGC/hxQt0hvo
# eaAiBdjo/1uuCTToigVnyRH+c0T2AezTeoFb7ne3I538hWeTdU5q9jGCBLcwggSz
# AgEBMHAwWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MgISESENFrJbjBGW0/5XyYYR5rrZMAkGBSsOAwIaBQCgeDAYBgorBgEEAYI3AgEM
# MQowCKACgAChAoAAMBkGCSqGSIb3DQEJAzEMBgorBgEEAYI3AgEEMBwGCisGAQQB
# gjcCAQsxDjAMBgorBgEEAYI3AgEVMCMGCSqGSIb3DQEJBDEWBBSLToLN9jl9bgEI
# eRZBIuArHYcM1TANBgkqhkiG9w0BAQEFAASCAQA582oc7WiXtTquGZJ0T24yEpsA
# BMjDaHMgLn+SI73+rNVtf1aeBNNCUka8ZX7ef+fGA2CkMpPZ9N79HkyH5XlHK1qv
# 0RK5nPvtQrEGdX9PTW2n2fp9QxtW+YLjuKYvB+mVLT8EXnCZUpeRw4JWcSEkvQZr
# w/WRbGyyGDyFiOgwFfZrm49a6seqhedM6VIfhGLBw5gQjPb2Z6Rw55LmaWYZ4XEl
# s/CFNW61kLkQO5rrsXZ+EHsGIDZo+ls8roqRwkwm8sn7enqysk+xiqDxY5t/swUq
# y29mvcnfadLr4qdiMA9sPCafyGlpsB+6tKMzpN4N6eQU+dxPy/j/QNKBQpJfoYIC
# ojCCAp4GCSqGSIb3DQEJBjGCAo8wggKLAgEBMGgwUjELMAkGA1UEBhMCQkUxGTAX
# BgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGlt
# ZXN0YW1waW5nIENBIC0gRzICEhEh1pmnZJc+8fhCfukZzFNBFDAJBgUrDgMCGgUA
# oIH9MBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTE2
# MDgzMTE5MTcwMFowIwYJKoZIhvcNAQkEMRYEFHQOcp1XQQ2SKyzfmrZnvpokhQ0i
# MIGdBgsqhkiG9w0BCRACDDGBjTCBijCBhzCBhAQUY7gvq2H1g5CWlQULACScUCkz
# 7HkwbDBWpFQwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYt
# c2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzICEhEh
# 1pmnZJc+8fhCfukZzFNBFDANBgkqhkiG9w0BAQEFAASCAQAFDDd4hrNAwRzlm8x/
# 98zVbvby3NtXy1bagp7Wnm9zSjpMHshs6gKoUBp/qPYwGTAGu56t6pU2WJvG7kQu
# chTIs3dn5NnpOe1BvS70miIZTwzqLy/dfbEg8E8ROGAP/oKZ9eMTeLa45L8lrsxZ
# qtffGZerrqOBpT1BWFuzzZUOKD/v8jrbB7bJ0QuqDasN5nazqNihCL2YUm36fEUX
# linEcGDwWJfEH5RquIG22Mra1nFmsCGXoXKQpWQ1le6Q0kht0YTBCPS4crbhOhV4
# jj1rnOq1Egm3IzPPpUx4qGmYYYU0BXEf0BC+7nbG1bEuPZMbMcokmI6zAQe6FWgh
# K5VX
# SIG # End signature block
|
PowerShellCorpus/PowerShellGallery/biz.dfch.PS.Appclusive.Client/5.2.1.20161201/Test-Status.ps1
|
Test-Status.ps1
|
function Test-Status {
<#
.SYNOPSIS
Test the connection to an Appclusive server.
.DESCRIPTION
Test the connection to an Appclusive server.
This Cmdlet lets you 'ping' an Appclusive server and display its response.
.INPUTS
See PARAMETERS section on possible inputs.
.OUTPUTS
default | json | json-pretty | xml | xml-pretty
.EXAMPLE
# Sends the text 'tralala' to a server and waits for its response.
# Upon successful execution the server returns the input string.
# Note: input length is limited.
PS > Test-Status tralala
tralala
.EXAMPLE
# Connects to the Appclusive 'Ping' endpoint and waits for the response.
# Upon successful execution the server returns an HTTP 204 which will be
# displayed as true.
# Note: input length is limited.
PS > Test-Status
$true
.EXAMPLE
# Connects to the Appclusive 'AuthenticatedPing' endpoint and waits for the
# response. Upon successful execution the server returns an HTTP 204 which
# will be displayed as true.
# Note: input length is limited.
PS > Test-Status -Authenticate
$true
.LINK
Online Version: http://dfch.biz/biz/dfch/PS/Appclusive/Client/Test-Status/
.NOTES
See module manifest for required software versions and dependencies.
#>
[CmdletBinding(
SupportsShouldProcess = $false
,
ConfirmImpact = 'Low'
,
HelpURI = 'http://dfch.biz/biz/dfch/PS/Appclusive/Client/Test-Status/'
,
DefaultParameterSetName = 'ping'
)]
PARAM
(
# The text that should be echoed by the server
[Parameter(Mandatory = $false, Position = 0, ParameterSetName = 'echo')]
[ValidateLength(1, 32)]
[string] $InputObject
,
# Specifies if the connection to the server will be authenticated with current credentials
[Parameter(Mandatory = $false, ParameterSetName = 'ping')]
[switch] $Authenticate = $false
,
# Service reference to Appclusive
[Parameter(Mandatory = $false)]
[Alias('Services')]
[hashtable] $svc = (Get-Variable -Name $MyInvocation.MyCommand.Module.PrivateData.MODULEVAR -ValueOnly).Services
,
# Specifies the return format of the Cmdlet
[ValidateSet('default', 'json', 'json-pretty', 'xml', 'xml-pretty')]
[Parameter(Mandatory = $false)]
[alias('ReturnFormat')]
[string] $As = 'default'
)
Begin
{
trap { Log-Exception $_; break; }
$datBegin = [datetime]::Now;
[string] $fn = $MyInvocation.MyCommand.Name;
Log-Debug -fn $fn -msg ("CALL. svc '{0}'. InputObject '{1}'." -f ($svc -is [Object]), $InputObject) -fac 1;
$EntitySetName = 'Endpoints';
# Parameter validation
Contract-Requires ($svc.Core -is [biz.dfch.CS.Appclusive.Api.Core.Core]) "Connect to the server before using the Cmdlet"
}
# Begin
Process
{
trap { Log-Exception $_; break; }
# Default test variable for checking function response codes.
[Boolean] $fReturn = $false;
# Return values are always and only returned via OutputParameter.
$OutputParameter = $null;
if($PSCmdlet.ParameterSetName -eq 'ping')
{
if($Authenticate)
{
$actionName = 'AuthenticatedPing';
}
else
{
$actionName = 'Ping';
}
try
{
$svc.Diagnostics.InvokeEntitySetActionWithVoidResult($EntitySetName, $actionName, $null);
$Response = $true;
}
catch
{
$Response = Format-ApcException;
Write-Error $Response;
$Response = $false;
}
}
else
{
try
{
$Response = $svc.Diagnostics.InvokeEntitySetActionWithSingleResult($EntitySetName, 'Echo', [string], @{'Content' = $InputObject});
}
catch
{
$Response = Format-ApcException;
Write-Error $Response;
$Response = $false;
}
}
$OutputParameter = Format-ResultAs $Response $As;
$fReturn = $true;
}
# Process
End
{
$datEnd = [datetime]::Now;
Log-Debug -fn $fn -msg ("RET. fReturn: [{0}]. Execution time: [{1}]ms. Started: [{2}]." -f $fReturn, ($datEnd - $datBegin).TotalMilliseconds, $datBegin.ToString('yyyy-MM-dd HH:mm:ss.fffzzz')) -fac 2;
# Return values are always and only returned via OutputParameter.
return $OutputParameter;
}
# End
} # function
if($MyInvocation.ScriptName) { Export-ModuleMember -Function Test-Status; }
#
# Copyright 2014-2016 d-fens GmbH
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SIG # Begin signature block
# MIIXDwYJKoZIhvcNAQcCoIIXADCCFvwCAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB
# gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR
# AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQUwJcAacSbawkTi97iyz6Pcjvp
# P+OgghHCMIIEFDCCAvygAwIBAgILBAAAAAABL07hUtcwDQYJKoZIhvcNAQEFBQAw
# VzELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNV
# BAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkdsb2JhbFNpZ24gUm9vdCBDQTAeFw0xMTA0
# MTMxMDAwMDBaFw0yODAxMjgxMjAwMDBaMFIxCzAJBgNVBAYTAkJFMRkwFwYDVQQK
# ExBHbG9iYWxTaWduIG52LXNhMSgwJgYDVQQDEx9HbG9iYWxTaWduIFRpbWVzdGFt
# cGluZyBDQSAtIEcyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAlO9l
# +LVXn6BTDTQG6wkft0cYasvwW+T/J6U00feJGr+esc0SQW5m1IGghYtkWkYvmaCN
# d7HivFzdItdqZ9C76Mp03otPDbBS5ZBb60cO8eefnAuQZT4XljBFcm05oRc2yrmg
# jBtPCBn2gTGtYRakYua0QJ7D/PuV9vu1LpWBmODvxevYAll4d/eq41JrUJEpxfz3
# zZNl0mBhIvIG+zLdFlH6Dv2KMPAXCae78wSuq5DnbN96qfTvxGInX2+ZbTh0qhGL
# 2t/HFEzphbLswn1KJo/nVrqm4M+SU4B09APsaLJgvIQgAIMboe60dAXBKY5i0Eex
# +vBTzBj5Ljv5cH60JQIDAQABo4HlMIHiMA4GA1UdDwEB/wQEAwIBBjASBgNVHRMB
# Af8ECDAGAQH/AgEAMB0GA1UdDgQWBBRG2D7/3OO+/4Pm9IWbsN1q1hSpwTBHBgNV
# HSAEQDA+MDwGBFUdIAAwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93d3cuZ2xvYmFs
# c2lnbi5jb20vcmVwb3NpdG9yeS8wMwYDVR0fBCwwKjAooCagJIYiaHR0cDovL2Ny
# bC5nbG9iYWxzaWduLm5ldC9yb290LmNybDAfBgNVHSMEGDAWgBRge2YaRQ2XyolQ
# L30EzTSo//z9SzANBgkqhkiG9w0BAQUFAAOCAQEATl5WkB5GtNlJMfO7FzkoG8IW
# 3f1B3AkFBJtvsqKa1pkuQJkAVbXqP6UgdtOGNNQXzFU6x4Lu76i6vNgGnxVQ380W
# e1I6AtcZGv2v8Hhc4EvFGN86JB7arLipWAQCBzDbsBJe/jG+8ARI9PBw+DpeVoPP
# PfsNvPTF7ZedudTbpSeE4zibi6c1hkQgpDttpGoLoYP9KOva7yj2zIhd+wo7AKvg
# IeviLzVsD440RZfroveZMzV+y5qKu0VN5z+fwtmK+mWybsd+Zf/okuEsMaL3sCc2
# SI8mbzvuTXYfecPlf5Y1vC0OzAGwjn//UYCAp5LUs0RGZIyHTxZjBzFLY7Df8zCC
# BCkwggMRoAMCAQICCwQAAAAAATGJxjfoMA0GCSqGSIb3DQEBCwUAMEwxIDAeBgNV
# BAsTF0dsb2JhbFNpZ24gUm9vdCBDQSAtIFIzMRMwEQYDVQQKEwpHbG9iYWxTaWdu
# MRMwEQYDVQQDEwpHbG9iYWxTaWduMB4XDTExMDgwMjEwMDAwMFoXDTE5MDgwMjEw
# MDAwMFowWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKPv0Z8p6djTgnY8YqDS
# SdYWHvHP8NC6SEMDLacd8gE0SaQQ6WIT9BP0FoO11VdCSIYrlViH6igEdMtyEQ9h
# JuH6HGEVxyibTQuCDyYrkDqW7aTQaymc9WGI5qRXb+70cNCNF97mZnZfdB5eDFM4
# XZD03zAtGxPReZhUGks4BPQHxCMD05LL94BdqpxWBkQtQUxItC3sNZKaxpXX9c6Q
# MeJ2s2G48XVXQqw7zivIkEnotybPuwyJy9DDo2qhydXjnFMrVyb+Vpp2/WFGomDs
# KUZH8s3ggmLGBFrn7U5AXEgGfZ1f53TJnoRlDVve3NMkHLQUEeurv8QfpLqZ0BdY
# Nc0CAwEAAaOB/TCB+jAOBgNVHQ8BAf8EBAMCAQYwEgYDVR0TAQH/BAgwBgEB/wIB
# ADAdBgNVHQ4EFgQUGUq4WuRNMaUU5V7sL6Mc+oCMMmswRwYDVR0gBEAwPjA8BgRV
# HSAAMDQwMgYIKwYBBQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3Jl
# cG9zaXRvcnkvMDYGA1UdHwQvMC0wK6ApoCeGJWh0dHA6Ly9jcmwuZ2xvYmFsc2ln
# bi5uZXQvcm9vdC1yMy5jcmwwEwYDVR0lBAwwCgYIKwYBBQUHAwMwHwYDVR0jBBgw
# FoAUj/BLf6guRSSuTVD6Y5qL3uLdG7wwDQYJKoZIhvcNAQELBQADggEBAHmwaTTi
# BYf2/tRgLC+GeTQD4LEHkwyEXPnk3GzPbrXsCly6C9BoMS4/ZL0Pgmtmd4F/ximl
# F9jwiU2DJBH2bv6d4UgKKKDieySApOzCmgDXsG1szYjVFXjPE/mIpXNNwTYr3MvO
# 23580ovvL72zT006rbtibiiTxAzL2ebK4BEClAOwvT+UKFaQHlPCJ9XJPM0aYx6C
# WRW2QMqngarDVa8z0bV16AnqRwhIIvtdG/Mseml+xddaXlYzPK1X6JMlQsPSXnE7
# ShxU7alVrCgFx8RsXdw8k/ZpPIJRzhoVPV4Bc/9Aouq0rtOO+u5dbEfHQfXUVlfy
# GDcy1tTMS/Zx4HYwggSfMIIDh6ADAgECAhIRIdaZp2SXPvH4Qn7pGcxTQRQwDQYJ
# KoZIhvcNAQEFBQAwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24g
# bnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzIw
# HhcNMTYwNTI0MDAwMDAwWhcNMjcwNjI0MDAwMDAwWjBgMQswCQYDVQQGEwJTRzEf
# MB0GA1UEChMWR01PIEdsb2JhbFNpZ24gUHRlIEx0ZDEwMC4GA1UEAxMnR2xvYmFs
# U2lnbiBUU0EgZm9yIE1TIEF1dGhlbnRpY29kZSAtIEcyMIIBIjANBgkqhkiG9w0B
# AQEFAAOCAQ8AMIIBCgKCAQEAsBeuotO2BDBWHlgPse1VpNZUy9j2czrsXV6rJf02
# pfqEw2FAxUa1WVI7QqIuXxNiEKlb5nPWkiWxfSPjBrOHOg5D8NcAiVOiETFSKG5d
# QHI88gl3p0mSl9RskKB2p/243LOd8gdgLE9YmABr0xVU4Prd/4AsXximmP/Uq+yh
# RVmyLm9iXeDZGayLV5yoJivZF6UQ0kcIGnAsM4t/aIAqtaFda92NAgIpA6p8N7u7
# KU49U5OzpvqP0liTFUy5LauAo6Ml+6/3CGSwekQPXBDXX2E3qk5r09JTJZ2Cc/os
# +XKwqRk5KlD6qdA8OsroW+/1X1H0+QrZlzXeaoXmIwRCrwIDAQABo4IBXzCCAVsw
# DgYDVR0PAQH/BAQDAgeAMEwGA1UdIARFMEMwQQYJKwYBBAGgMgEeMDQwMgYIKwYB
# BQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3JlcG9zaXRvcnkvMAkG
# A1UdEwQCMAAwFgYDVR0lAQH/BAwwCgYIKwYBBQUHAwgwQgYDVR0fBDswOTA3oDWg
# M4YxaHR0cDovL2NybC5nbG9iYWxzaWduLmNvbS9ncy9nc3RpbWVzdGFtcGluZ2cy
# LmNybDBUBggrBgEFBQcBAQRIMEYwRAYIKwYBBQUHMAKGOGh0dHA6Ly9zZWN1cmUu
# Z2xvYmFsc2lnbi5jb20vY2FjZXJ0L2dzdGltZXN0YW1waW5nZzIuY3J0MB0GA1Ud
# DgQWBBTUooRKOFoYf7pPMFC9ndV6h9YJ9zAfBgNVHSMEGDAWgBRG2D7/3OO+/4Pm
# 9IWbsN1q1hSpwTANBgkqhkiG9w0BAQUFAAOCAQEAj6kakW0EpjcgDoOW3iPTa24f
# bt1kPWghIrX4RzZpjuGlRcckoiK3KQnMVFquxrzNY46zPVBI5bTMrs2SjZ4oixNK
# Eaq9o+/Tsjb8tKFyv22XY3mMRLxwL37zvN2CU6sa9uv6HJe8tjecpBwwvKu8LUc2
# 35IgA+hxxlj2dQWaNPALWVqCRDSqgOQvhPZHXZbJtsrKnbemuuRQ09Q3uLogDtDT
# kipbxFm7oW3bPM5EncE4Kq3jjb3NCXcaEL5nCgI2ZIi5sxsm7ueeYMRGqLxhM2zP
# TrmcuWrwnzf+tT1PmtNN/94gjk6Xpv2fCbxNyhh2ybBNhVDygNIdBvVYBAexGDCC
# BNYwggO+oAMCAQICEhEhDRayW4wRltP+V8mGEea62TANBgkqhkiG9w0BAQsFADBa
# MQswCQYDVQQGEwJCRTEZMBcGA1UEChMQR2xvYmFsU2lnbiBudi1zYTEwMC4GA1UE
# AxMnR2xvYmFsU2lnbiBDb2RlU2lnbmluZyBDQSAtIFNIQTI1NiAtIEcyMB4XDTE1
# MDUwNDE2NDMyMVoXDTE4MDUwNDE2NDMyMVowVTELMAkGA1UEBhMCQ0gxDDAKBgNV
# BAgTA1p1ZzEMMAoGA1UEBxMDWnVnMRQwEgYDVQQKEwtkLWZlbnMgR21iSDEUMBIG
# A1UEAxMLZC1mZW5zIEdtYkgwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB
# AQDNPSzSNPylU9jFM78Q/GjzB7N+VNqikf/use7p8mpnBZ4cf5b4qV3rqQd62rJH
# RlAsxgouCSNQrl8xxfg6/t/I02kPvrzsR4xnDgMiVCqVRAeQsWebafWdTvWmONBS
# lxJejPP8TSgXMKFaDa+2HleTycTBYSoErAZSWpQ0NqF9zBadjsJRVatQuPkTDrwL
# eWibiyOipK9fcNoQpl5ll5H9EG668YJR3fqX9o0TQTkOmxXIL3IJ0UxdpyDpLEkt
# tBG6Y5wAdpF2dQX2phrfFNVY54JOGtuBkNGMSiLFzTkBA1fOlA6ICMYjB8xIFxVv
# rN1tYojCrqYkKMOjwWQz5X8zAgMBAAGjggGZMIIBlTAOBgNVHQ8BAf8EBAMCB4Aw
# TAYDVR0gBEUwQzBBBgkrBgEEAaAyATIwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93
# d3cuZ2xvYmFsc2lnbi5jb20vcmVwb3NpdG9yeS8wCQYDVR0TBAIwADATBgNVHSUE
# DDAKBggrBgEFBQcDAzBCBgNVHR8EOzA5MDegNaAzhjFodHRwOi8vY3JsLmdsb2Jh
# bHNpZ24uY29tL2dzL2dzY29kZXNpZ25zaGEyZzIuY3JsMIGQBggrBgEFBQcBAQSB
# gzCBgDBEBggrBgEFBQcwAoY4aHR0cDovL3NlY3VyZS5nbG9iYWxzaWduLmNvbS9j
# YWNlcnQvZ3Njb2Rlc2lnbnNoYTJnMi5jcnQwOAYIKwYBBQUHMAGGLGh0dHA6Ly9v
# Y3NwMi5nbG9iYWxzaWduLmNvbS9nc2NvZGVzaWduc2hhMmcyMB0GA1UdDgQWBBTN
# GDddiIYZy9p3Z84iSIMd27rtUDAfBgNVHSMEGDAWgBQZSrha5E0xpRTlXuwvoxz6
# gIwyazANBgkqhkiG9w0BAQsFAAOCAQEAAApsOzSX1alF00fTeijB/aIthO3UB0ks
# 1Gg3xoKQC1iEQmFG/qlFLiufs52kRPN7L0a7ClNH3iQpaH5IEaUENT9cNEXdKTBG
# 8OrJS8lrDJXImgNEgtSwz0B40h7bM2Z+0DvXDvpmfyM2NwHF/nNVj7NzmczrLRqN
# 9de3tV0pgRqnIYordVcmb24CZl3bzpwzbQQy14Iz+P5Z2cnw+QaYzAuweTZxEUcJ
# bFwpM49c1LMPFJTuOKkUgY90JJ3gVTpyQxfkc7DNBnx74PlRzjFmeGC/hxQt0hvo
# eaAiBdjo/1uuCTToigVnyRH+c0T2AezTeoFb7ne3I538hWeTdU5q9jGCBLcwggSz
# AgEBMHAwWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MgISESENFrJbjBGW0/5XyYYR5rrZMAkGBSsOAwIaBQCgeDAYBgorBgEEAYI3AgEM
# MQowCKACgAChAoAAMBkGCSqGSIb3DQEJAzEMBgorBgEEAYI3AgEEMBwGCisGAQQB
# gjcCAQsxDjAMBgorBgEEAYI3AgEVMCMGCSqGSIb3DQEJBDEWBBQi7x/jG1h/1iNJ
# nAWPL5yesbsytDANBgkqhkiG9w0BAQEFAASCAQCiKPcVoZ1j8WT61wAfdVOweae6
# x+L7c1EvHMSWa5xl3VgPx7tWiPSS/9x4YKQqp8N+egTumD+BXpEBQnuQCgi8C/kG
# v4TMsoasjTu3cp4lVydWcHZYaO4LVKaXNnbSip1tk+bIdUPg91J6TAkojrT25zOg
# xkLlpiENcllVjYW8j0u6jyPKvefyzYN4ud1GF4jVBjMXIEoYRhNr5tJHQXdDQLvW
# Qb7srb6R+meFZ32UAint33xS/lAv0fCAqS8OnHX7l1jo5Jg5umH5Cx+7eISYVSFV
# iqA2tUKsXt6Zq6aORqHAuNFUomCkkwrYmY0+Q1iOly02Zj+V6cpF1Wg+Qz1uoYIC
# ojCCAp4GCSqGSIb3DQEJBjGCAo8wggKLAgEBMGgwUjELMAkGA1UEBhMCQkUxGTAX
# BgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGlt
# ZXN0YW1waW5nIENBIC0gRzICEhEh1pmnZJc+8fhCfukZzFNBFDAJBgUrDgMCGgUA
# oIH9MBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTE2
# MDgzMTE5MTcxMFowIwYJKoZIhvcNAQkEMRYEFGNaimd36vTyqMRYZCcQgFVoGKbh
# MIGdBgsqhkiG9w0BCRACDDGBjTCBijCBhzCBhAQUY7gvq2H1g5CWlQULACScUCkz
# 7HkwbDBWpFQwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYt
# c2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzICEhEh
# 1pmnZJc+8fhCfukZzFNBFDANBgkqhkiG9w0BAQEFAASCAQCg010kEteBQmnzKCP3
# /0E4nFMabZkgiEijBTt4QJ5A1KNd51k7jGJCe4LbYgkhUuTm5R0KC8tZILfaWmW5
# y+vhhFGa9fd1NCv9Colh+CF2onXr1noGVTumeq3FjqSft10RWGnT3ildM6KV/1Z7
# khWAk8zFyza20LUBlWjRCbK+oiYsNL5hDKSVTjtPgXRlZQuOu2xpgksO5h1LNiO5
# 3DA8T7O5J8zXT1xrTpzraWg3Tbb7Mbfigk4ns3UJ/m10ek0vpZxK6esOg3F/6zzB
# O92yoeM7t1U/lWOPpcqaM78R4jaSDTPe/C3ctKGKSaEtuHVZMavkOMikVYw2jG8m
# sHSg
# SIG # End signature block
|
PowerShellCorpus/PowerShellGallery/biz.dfch.PS.Appclusive.Client/5.2.1.20161201/Push-ChangeTracker.ps1
|
Push-ChangeTracker.ps1
|
function Push-ChangeTracker {
<#
.SYNOPSIS
Pushes the contents of the DataServiceContext ChangeTracker to the DataContext stack.
.DESCRIPTION
Pushes the contents of the DataServiceContext ChangeTracker to the DataContext stack.
.INPUTS
The Cmdlet can either push a context or display the contents of the current context.
See PARAMETERS section on possible inputs.
.OUTPUTS
[System.Collections.Hashtable]
.LINK
Online Version: http://dfch.biz/biz/dfch/PS/Appclusive/Client/Push-ChangeTracker/
.NOTES
See module manifest for required software versions and dependencies.
#>
[CmdletBinding(
SupportsShouldProcess = $false
,
ConfirmImpact = 'Low'
,
HelpURI = 'http://dfch.biz/PS/Appclusive/Client/Push-ChangeTracker/'
)]
[OutputType([hashtable])]
PARAM
(
# Specifies a references to the Appclusive endpoints
[Parameter(Mandatory = $false)]
[Alias('Services')]
[hashtable] $svc = (Get-Variable -Name $MyInvocation.MyCommand.Module.PrivateData.MODULEVAR -ValueOnly).Services
,
# Specifies the service or container name of the entity to remove
[ValidateScript( { if($svc.Keys -contains $_) { $true; } else { throw('{0}: Invalid service name specified.' -f $_); } } )]
[Parameter(Mandatory = $false, Position = 0)]
[Alias("Container")]
[string] $Service = 'Core'
,
# Lists the contents of the current ChangeTracker
[Parameter(Mandatory = $false, ParameterSetName = 'ListAvailable')]
[Alias("Registered")]
[Switch] $ListAvailable = $false
)
trap { Log-Exception $_; break; }
$datBegin = [datetime]::Now;
[string] $fn = $MyInvocation.MyCommand.Name;
$ModuleVar = Get-ModuleVariable;
if(!$ModuleVar.ContainsKey('DataContext'))
{
$ModuleVar.DataContext = New-Object System.Collections.Stack;
}
Log-Debug -fn $fn -msg ("CALL. DataContext stack size '{0}'." -f $ModuleVar.DataContext.Count) -fac 1;
# Parameter validation
Contract-Requires ($svc.Core -is [biz.dfch.CS.Appclusive.Api.Core.Core]) "Connect to the server before using the Cmdlet"
$EntitySetName = 'Entities';
Contract-Requires (!!(Get-Member -InputObject $svc.$Service -MemberType Properties -Name $EntitySetName)) "'Entities' is not a valid entity set in specified Service"
$EntitySetName = 'Links';
Contract-Requires (!!(Get-Member -InputObject $svc.$Service -MemberType Properties -Name $EntitySetName)) "'Links' is not a valid entity set in specified Service"
$m = $svc.$Service;
$fReturn = $false;
$OutputParameter = $null;
$e = '';
$aE = New-Object System.Collections.ArrayList;
foreach($e in $m.Entities) { $null = $aE.Add($e.Entity); };
$l = '';
$aL = New-Object System.Collections.ArrayList;
foreach($l in $m.Links) { $null = $aL.Add($l); };
$ht = @{};
$ht.Links = $aL;
$ht.Entities = $aE;
# here we clone the hashtable twice to prevent unwanted changes to the copy on the stack
if(!$ListAvailable)
{
$ModuleVar.DataContext.Push($ht.Clone());
}
$OutputParameter = $ht.Clone();
Log-Debug $fn ("Tracked entities: Entities '{0}'. Links '{1}'." -f $OutputParameter.Entities.Count, $OutputParameter.Links.Count);
$ht.Clear();
Remove-Variable ht;
Remove-Variable aE;
Remove-Variable e;
Remove-Variable aL;
Remove-Variable l;
$datEnd = [datetime]::Now;
Log-Debug -fn $fn -msg ("RET. fReturn: [{0}]. Execution time: [{1}]ms. Started: [{2}]." -f $fReturn, ($datEnd - $datBegin).TotalMilliseconds, $datBegin.ToString('yyyy-MM-dd HH:mm:ss.fffzzz')) -fac 2;
return $OutputParameter;
}
if($MyInvocation.ScriptName) { Export-ModuleMember -Function Push-ChangeTracker; }
#
# Copyright 2014-2015 d-fens GmbH
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SIG # Begin signature block
# MIIXDwYJKoZIhvcNAQcCoIIXADCCFvwCAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB
# gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR
# AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQUKtFRtjsVZszZYBcEIfoduXaM
# 0MugghHCMIIEFDCCAvygAwIBAgILBAAAAAABL07hUtcwDQYJKoZIhvcNAQEFBQAw
# VzELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNV
# BAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkdsb2JhbFNpZ24gUm9vdCBDQTAeFw0xMTA0
# MTMxMDAwMDBaFw0yODAxMjgxMjAwMDBaMFIxCzAJBgNVBAYTAkJFMRkwFwYDVQQK
# ExBHbG9iYWxTaWduIG52LXNhMSgwJgYDVQQDEx9HbG9iYWxTaWduIFRpbWVzdGFt
# cGluZyBDQSAtIEcyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAlO9l
# +LVXn6BTDTQG6wkft0cYasvwW+T/J6U00feJGr+esc0SQW5m1IGghYtkWkYvmaCN
# d7HivFzdItdqZ9C76Mp03otPDbBS5ZBb60cO8eefnAuQZT4XljBFcm05oRc2yrmg
# jBtPCBn2gTGtYRakYua0QJ7D/PuV9vu1LpWBmODvxevYAll4d/eq41JrUJEpxfz3
# zZNl0mBhIvIG+zLdFlH6Dv2KMPAXCae78wSuq5DnbN96qfTvxGInX2+ZbTh0qhGL
# 2t/HFEzphbLswn1KJo/nVrqm4M+SU4B09APsaLJgvIQgAIMboe60dAXBKY5i0Eex
# +vBTzBj5Ljv5cH60JQIDAQABo4HlMIHiMA4GA1UdDwEB/wQEAwIBBjASBgNVHRMB
# Af8ECDAGAQH/AgEAMB0GA1UdDgQWBBRG2D7/3OO+/4Pm9IWbsN1q1hSpwTBHBgNV
# HSAEQDA+MDwGBFUdIAAwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93d3cuZ2xvYmFs
# c2lnbi5jb20vcmVwb3NpdG9yeS8wMwYDVR0fBCwwKjAooCagJIYiaHR0cDovL2Ny
# bC5nbG9iYWxzaWduLm5ldC9yb290LmNybDAfBgNVHSMEGDAWgBRge2YaRQ2XyolQ
# L30EzTSo//z9SzANBgkqhkiG9w0BAQUFAAOCAQEATl5WkB5GtNlJMfO7FzkoG8IW
# 3f1B3AkFBJtvsqKa1pkuQJkAVbXqP6UgdtOGNNQXzFU6x4Lu76i6vNgGnxVQ380W
# e1I6AtcZGv2v8Hhc4EvFGN86JB7arLipWAQCBzDbsBJe/jG+8ARI9PBw+DpeVoPP
# PfsNvPTF7ZedudTbpSeE4zibi6c1hkQgpDttpGoLoYP9KOva7yj2zIhd+wo7AKvg
# IeviLzVsD440RZfroveZMzV+y5qKu0VN5z+fwtmK+mWybsd+Zf/okuEsMaL3sCc2
# SI8mbzvuTXYfecPlf5Y1vC0OzAGwjn//UYCAp5LUs0RGZIyHTxZjBzFLY7Df8zCC
# BCkwggMRoAMCAQICCwQAAAAAATGJxjfoMA0GCSqGSIb3DQEBCwUAMEwxIDAeBgNV
# BAsTF0dsb2JhbFNpZ24gUm9vdCBDQSAtIFIzMRMwEQYDVQQKEwpHbG9iYWxTaWdu
# MRMwEQYDVQQDEwpHbG9iYWxTaWduMB4XDTExMDgwMjEwMDAwMFoXDTE5MDgwMjEw
# MDAwMFowWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKPv0Z8p6djTgnY8YqDS
# SdYWHvHP8NC6SEMDLacd8gE0SaQQ6WIT9BP0FoO11VdCSIYrlViH6igEdMtyEQ9h
# JuH6HGEVxyibTQuCDyYrkDqW7aTQaymc9WGI5qRXb+70cNCNF97mZnZfdB5eDFM4
# XZD03zAtGxPReZhUGks4BPQHxCMD05LL94BdqpxWBkQtQUxItC3sNZKaxpXX9c6Q
# MeJ2s2G48XVXQqw7zivIkEnotybPuwyJy9DDo2qhydXjnFMrVyb+Vpp2/WFGomDs
# KUZH8s3ggmLGBFrn7U5AXEgGfZ1f53TJnoRlDVve3NMkHLQUEeurv8QfpLqZ0BdY
# Nc0CAwEAAaOB/TCB+jAOBgNVHQ8BAf8EBAMCAQYwEgYDVR0TAQH/BAgwBgEB/wIB
# ADAdBgNVHQ4EFgQUGUq4WuRNMaUU5V7sL6Mc+oCMMmswRwYDVR0gBEAwPjA8BgRV
# HSAAMDQwMgYIKwYBBQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3Jl
# cG9zaXRvcnkvMDYGA1UdHwQvMC0wK6ApoCeGJWh0dHA6Ly9jcmwuZ2xvYmFsc2ln
# bi5uZXQvcm9vdC1yMy5jcmwwEwYDVR0lBAwwCgYIKwYBBQUHAwMwHwYDVR0jBBgw
# FoAUj/BLf6guRSSuTVD6Y5qL3uLdG7wwDQYJKoZIhvcNAQELBQADggEBAHmwaTTi
# BYf2/tRgLC+GeTQD4LEHkwyEXPnk3GzPbrXsCly6C9BoMS4/ZL0Pgmtmd4F/ximl
# F9jwiU2DJBH2bv6d4UgKKKDieySApOzCmgDXsG1szYjVFXjPE/mIpXNNwTYr3MvO
# 23580ovvL72zT006rbtibiiTxAzL2ebK4BEClAOwvT+UKFaQHlPCJ9XJPM0aYx6C
# WRW2QMqngarDVa8z0bV16AnqRwhIIvtdG/Mseml+xddaXlYzPK1X6JMlQsPSXnE7
# ShxU7alVrCgFx8RsXdw8k/ZpPIJRzhoVPV4Bc/9Aouq0rtOO+u5dbEfHQfXUVlfy
# GDcy1tTMS/Zx4HYwggSfMIIDh6ADAgECAhIRIdaZp2SXPvH4Qn7pGcxTQRQwDQYJ
# KoZIhvcNAQEFBQAwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24g
# bnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzIw
# HhcNMTYwNTI0MDAwMDAwWhcNMjcwNjI0MDAwMDAwWjBgMQswCQYDVQQGEwJTRzEf
# MB0GA1UEChMWR01PIEdsb2JhbFNpZ24gUHRlIEx0ZDEwMC4GA1UEAxMnR2xvYmFs
# U2lnbiBUU0EgZm9yIE1TIEF1dGhlbnRpY29kZSAtIEcyMIIBIjANBgkqhkiG9w0B
# AQEFAAOCAQ8AMIIBCgKCAQEAsBeuotO2BDBWHlgPse1VpNZUy9j2czrsXV6rJf02
# pfqEw2FAxUa1WVI7QqIuXxNiEKlb5nPWkiWxfSPjBrOHOg5D8NcAiVOiETFSKG5d
# QHI88gl3p0mSl9RskKB2p/243LOd8gdgLE9YmABr0xVU4Prd/4AsXximmP/Uq+yh
# RVmyLm9iXeDZGayLV5yoJivZF6UQ0kcIGnAsM4t/aIAqtaFda92NAgIpA6p8N7u7
# KU49U5OzpvqP0liTFUy5LauAo6Ml+6/3CGSwekQPXBDXX2E3qk5r09JTJZ2Cc/os
# +XKwqRk5KlD6qdA8OsroW+/1X1H0+QrZlzXeaoXmIwRCrwIDAQABo4IBXzCCAVsw
# DgYDVR0PAQH/BAQDAgeAMEwGA1UdIARFMEMwQQYJKwYBBAGgMgEeMDQwMgYIKwYB
# BQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3JlcG9zaXRvcnkvMAkG
# A1UdEwQCMAAwFgYDVR0lAQH/BAwwCgYIKwYBBQUHAwgwQgYDVR0fBDswOTA3oDWg
# M4YxaHR0cDovL2NybC5nbG9iYWxzaWduLmNvbS9ncy9nc3RpbWVzdGFtcGluZ2cy
# LmNybDBUBggrBgEFBQcBAQRIMEYwRAYIKwYBBQUHMAKGOGh0dHA6Ly9zZWN1cmUu
# Z2xvYmFsc2lnbi5jb20vY2FjZXJ0L2dzdGltZXN0YW1waW5nZzIuY3J0MB0GA1Ud
# DgQWBBTUooRKOFoYf7pPMFC9ndV6h9YJ9zAfBgNVHSMEGDAWgBRG2D7/3OO+/4Pm
# 9IWbsN1q1hSpwTANBgkqhkiG9w0BAQUFAAOCAQEAj6kakW0EpjcgDoOW3iPTa24f
# bt1kPWghIrX4RzZpjuGlRcckoiK3KQnMVFquxrzNY46zPVBI5bTMrs2SjZ4oixNK
# Eaq9o+/Tsjb8tKFyv22XY3mMRLxwL37zvN2CU6sa9uv6HJe8tjecpBwwvKu8LUc2
# 35IgA+hxxlj2dQWaNPALWVqCRDSqgOQvhPZHXZbJtsrKnbemuuRQ09Q3uLogDtDT
# kipbxFm7oW3bPM5EncE4Kq3jjb3NCXcaEL5nCgI2ZIi5sxsm7ueeYMRGqLxhM2zP
# TrmcuWrwnzf+tT1PmtNN/94gjk6Xpv2fCbxNyhh2ybBNhVDygNIdBvVYBAexGDCC
# BNYwggO+oAMCAQICEhEhDRayW4wRltP+V8mGEea62TANBgkqhkiG9w0BAQsFADBa
# MQswCQYDVQQGEwJCRTEZMBcGA1UEChMQR2xvYmFsU2lnbiBudi1zYTEwMC4GA1UE
# AxMnR2xvYmFsU2lnbiBDb2RlU2lnbmluZyBDQSAtIFNIQTI1NiAtIEcyMB4XDTE1
# MDUwNDE2NDMyMVoXDTE4MDUwNDE2NDMyMVowVTELMAkGA1UEBhMCQ0gxDDAKBgNV
# BAgTA1p1ZzEMMAoGA1UEBxMDWnVnMRQwEgYDVQQKEwtkLWZlbnMgR21iSDEUMBIG
# A1UEAxMLZC1mZW5zIEdtYkgwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB
# AQDNPSzSNPylU9jFM78Q/GjzB7N+VNqikf/use7p8mpnBZ4cf5b4qV3rqQd62rJH
# RlAsxgouCSNQrl8xxfg6/t/I02kPvrzsR4xnDgMiVCqVRAeQsWebafWdTvWmONBS
# lxJejPP8TSgXMKFaDa+2HleTycTBYSoErAZSWpQ0NqF9zBadjsJRVatQuPkTDrwL
# eWibiyOipK9fcNoQpl5ll5H9EG668YJR3fqX9o0TQTkOmxXIL3IJ0UxdpyDpLEkt
# tBG6Y5wAdpF2dQX2phrfFNVY54JOGtuBkNGMSiLFzTkBA1fOlA6ICMYjB8xIFxVv
# rN1tYojCrqYkKMOjwWQz5X8zAgMBAAGjggGZMIIBlTAOBgNVHQ8BAf8EBAMCB4Aw
# TAYDVR0gBEUwQzBBBgkrBgEEAaAyATIwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93
# d3cuZ2xvYmFsc2lnbi5jb20vcmVwb3NpdG9yeS8wCQYDVR0TBAIwADATBgNVHSUE
# DDAKBggrBgEFBQcDAzBCBgNVHR8EOzA5MDegNaAzhjFodHRwOi8vY3JsLmdsb2Jh
# bHNpZ24uY29tL2dzL2dzY29kZXNpZ25zaGEyZzIuY3JsMIGQBggrBgEFBQcBAQSB
# gzCBgDBEBggrBgEFBQcwAoY4aHR0cDovL3NlY3VyZS5nbG9iYWxzaWduLmNvbS9j
# YWNlcnQvZ3Njb2Rlc2lnbnNoYTJnMi5jcnQwOAYIKwYBBQUHMAGGLGh0dHA6Ly9v
# Y3NwMi5nbG9iYWxzaWduLmNvbS9nc2NvZGVzaWduc2hhMmcyMB0GA1UdDgQWBBTN
# GDddiIYZy9p3Z84iSIMd27rtUDAfBgNVHSMEGDAWgBQZSrha5E0xpRTlXuwvoxz6
# gIwyazANBgkqhkiG9w0BAQsFAAOCAQEAAApsOzSX1alF00fTeijB/aIthO3UB0ks
# 1Gg3xoKQC1iEQmFG/qlFLiufs52kRPN7L0a7ClNH3iQpaH5IEaUENT9cNEXdKTBG
# 8OrJS8lrDJXImgNEgtSwz0B40h7bM2Z+0DvXDvpmfyM2NwHF/nNVj7NzmczrLRqN
# 9de3tV0pgRqnIYordVcmb24CZl3bzpwzbQQy14Iz+P5Z2cnw+QaYzAuweTZxEUcJ
# bFwpM49c1LMPFJTuOKkUgY90JJ3gVTpyQxfkc7DNBnx74PlRzjFmeGC/hxQt0hvo
# eaAiBdjo/1uuCTToigVnyRH+c0T2AezTeoFb7ne3I538hWeTdU5q9jGCBLcwggSz
# AgEBMHAwWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MgISESENFrJbjBGW0/5XyYYR5rrZMAkGBSsOAwIaBQCgeDAYBgorBgEEAYI3AgEM
# MQowCKACgAChAoAAMBkGCSqGSIb3DQEJAzEMBgorBgEEAYI3AgEEMBwGCisGAQQB
# gjcCAQsxDjAMBgorBgEEAYI3AgEVMCMGCSqGSIb3DQEJBDEWBBRJQEpnBH1iRg//
# NJJPUmzZFQKNcDANBgkqhkiG9w0BAQEFAASCAQAyis91hHGzvSgeeS8HpER3erpm
# xe24tftQhJ1/5TtPO/jxpkj1wS5QePC3uiDwRBxNkK5z+DG1sLBuwHSYbRVMRiqh
# M2my0a5ObqAkph6NO+HUcCvYNsZIFUNzVFay+pGL7X6WzfI9ilpzVKoCP0EtTZBJ
# 35SqCXWe9ApMoo/xoQC3PckqtRhuTroSNEQ8HB2AFdXuJQc+WUKEmlQHPr/XlO84
# pIiDLPLkky3V2ZoC5gGuKsg5RzHUjAcPxrLLvkegeWa3c3BXM1KJ5/eZE23bpcIn
# r0RxYIOnjcIb0Eq2olYJSpIvKKpUGF7v0jMJ623cX+25Kf1HbSP6Cb9uqsxEoYIC
# ojCCAp4GCSqGSIb3DQEJBjGCAo8wggKLAgEBMGgwUjELMAkGA1UEBhMCQkUxGTAX
# BgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGlt
# ZXN0YW1waW5nIENBIC0gRzICEhEh1pmnZJc+8fhCfukZzFNBFDAJBgUrDgMCGgUA
# oIH9MBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTE2
# MDgzMTE5MTY1N1owIwYJKoZIhvcNAQkEMRYEFAlb64XU7bBFlh8pgvaLuF9xxRKy
# MIGdBgsqhkiG9w0BCRACDDGBjTCBijCBhzCBhAQUY7gvq2H1g5CWlQULACScUCkz
# 7HkwbDBWpFQwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYt
# c2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzICEhEh
# 1pmnZJc+8fhCfukZzFNBFDANBgkqhkiG9w0BAQEFAASCAQBt8wR3fsFYC+Cpt7i2
# Mi+h8wjCQxZKN4PxEoGr0t5fuljk7dU8lE9MhlFVHiU/rIAnfhJhWE8OAb/c8rR0
# CpFK+H1LeENwQVtlxtWzoediaQ+/Hytlhj3dPmCzo8bnBlDkeQcv7u/3nvOF/vAH
# UNWIoI9GeIFfDMZXzh5I2RDysSJUcA0MdYD7T97q9312mTfGawIE5hY0GdGgRJOZ
# 1nAZ/4xY64tYyZdPYHMKTo96E3c9Srfcp5S+bI0byqug+hyXKPawzwBIH+74lfzr
# PVtcQsna8sySYeusowvvfJ9hrKHY/R8iGmjzdmB4ht+DYVpqnquHkYfG9H9dyDrs
# rkMO
# SIG # End signature block
|
PowerShellCorpus/PowerShellGallery/biz.dfch.PS.Appclusive.Client/5.2.1.20161201/New-Folder.ps1
|
New-Folder.ps1
|
function New-Folder {
<#
.SYNOPSIS
Creates a folder entry in Appclusive.
.DESCRIPTION
Creates a folder entry in Appclusive.
You must specify parameter 'Name'. If the entry already exists no update of the existing entry is performed.
.OUTPUTS
[biz.dfch.CS.Appclusive.Api.Core.Folder]
.EXAMPLE
New-Folder -svc $svc -Name "Arbitrary Name"
EntityId :
Parameters : {}
EntityKindId : 28
ParentId : 1
Id : 79780
Tid : 11111111-1111-1111-1111-111111111111
Name : Arbitrary Name
Description :
CreatedById : 1
ModifiedById : 1
Created : 09.09.2016 13:31:36 +02:00
Modified : 09.09.2016 13:31:36 +02:00
RowVersion : {0, 0, 0, 0...}
EntityKind :
Parent :
Children : {}
IncomingAssocs : {}
OutgoingAssocs : {}
Tenant :
CreatedBy :
ModifiedBy :
Create a new Folder entry if it not already exists.
.LINK
Online Version: http://dfch.biz/biz/dfch/PS/Appclusive/Client/New-Folder/
.NOTES
See module manifest for dependencies and further requirements.
#>
[CmdletBinding(
SupportsShouldProcess = $true
,
ConfirmImpact = 'Low'
,
HelpURI = 'http://dfch.biz/biz/dfch/PS/Appclusive/Client/New-Folder/'
)]
Param
(
# Specifies the name for this entity
[Parameter(Mandatory = $true, Position = 0)]
[ValidateNotNullOrEmpty()]
[string] $Name
,
# Specifies the description for this entity
[Parameter(Mandatory = $false)]
[string] $Description
,
# Specifies the parent Id for this entity, default is the root folder
[Parameter(Mandatory = $false)]
[ValidateRange(1,[long]::MaxValue)]
[Alias("pid")]
[long] $ParentId = (Get-ApcTenant -Current -svc $svc).NodeId
,
# Specifies the parameters for this entity
[Parameter(Mandatory = $false)]
[Alias("p")]
[string] $Parameters = '{}'
,
# Service reference to Appclusive
[Parameter(Mandatory = $false)]
[Alias('Services')]
[hashtable] $svc = (Get-Variable -Name $MyInvocation.MyCommand.Module.PrivateData.MODULEVAR -ValueOnly).Services
)
Begin
{
trap { Log-Exception $_; break; }
$datBegin = [datetime]::Now;
[string] $fn = $MyInvocation.MyCommand.Name;
Log-Debug -fn $fn -msg ("CALL. svc '{0}'. Name '{1}'. ParentId '{2}'." -f ($svc -is [Object]), $Name, $ParentId) -fac 1;
# Parameter validation
Contract-Requires ($svc.Core -is [biz.dfch.CS.Appclusive.Api.Core.Core]) "Connect to the server before using the Cmdlet"
}
# Begin
Process
{
trap { Log-Exception $_; break; }
# Default test variable for checking function response codes.
[Boolean] $fReturn = $false;
# Return values are always and only returned via OutputParameter.
$OutputParameter = $null;
$FolderContents = @($Name);
if($PSCmdlet.ShouldProcess($FolderContents))
{
$r = Set-Folder @PSBoundParameters;
$OutputParameter = $r;
}
$fReturn = $true;
}
# Process
End
{
$datEnd = [datetime]::Now;
Log-Debug -fn $fn -msg ("RET. fReturn: [{0}]. Execution time: [{1}]ms. Started: [{2}]." -f $fReturn, ($datEnd - $datBegin).TotalMilliseconds, $datBegin.ToString('yyyy-MM-dd HH:mm:ss.fffzzz')) -fac 2;
# Return values are always and only returned via OutputParameter.
return $OutputParameter;
}
# End
}
if($MyInvocation.ScriptName) { Export-ModuleMember -Function New-Folder; }
#
# Copyright 2014-2015 d-fens GmbH
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
|
PowerShellCorpus/PowerShellGallery/biz.dfch.PS.Appclusive.Client/5.2.1.20161201/Get-Interface.ps1
|
Get-Interface.ps1
|
function Get-Interface {
<#
.SYNOPSIS
Retrieves Interfaces from the Appclusive server.
.DESCRIPTION
Retrieves Interfaces from the Appclusive server.
Interfaces are used to define Connectors between EntityKinds. Besides specifying a selection you can furthermore define the order, the selected columns and the return format.
If you specify 'object' as output type then all filter options such as 'Select' are ignored.
.OUTPUTS
default | json | json-pretty | xml | xml-pretty
.INPUTS
You basically specify key, name and value to be retrieved. If one or more of these parameters are omitted all entities are returned that match these criteria.
If you specify 'object' as output type then all filter options such as 'Select' are ignored.
.NOTES
See module manifest for dependencies and further requirements.
#>
[CmdletBinding(
SupportsShouldProcess = $false
,
ConfirmImpact = 'Low'
,
DefaultParameterSetName = 'list'
)]
PARAM
(
# Specifies the Key property of the entity.
[Parameter(Mandatory = $false, Position = 0, ParameterSetName = 'Id')]
[string] $Id
,
# Specifies the Name property of the entity.
[Parameter(Mandatory = $false, Position = 0, ParameterSetName = 'Name')]
[Alias('n')]
[string] $Name
,
# Specifies the order of the returned entites. You can specify more than one property (e.g. Key and Name).
[ValidateSet('Id', 'Name')]
[Parameter(Mandatory = $false, Position = 1)]
[string[]] $OrderBy = @('Id','Name')
,
# Specifies to return only values without header information.
# This parameter takes precendes over the 'Select' parameter.
[Alias('HideTableHeaders')]
[switch] $ValueOnly
,
# Specifies to deserialize JSON payloads
[ValidateSet('json')]
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[Alias('Convert')]
[string] $ConvertFrom
,
# Limits the output to the specified number of entries
[Parameter(Mandatory = $false)]
[Alias('top')]
[int] $First
,
# This value is only returned if the regular search would have returned no results
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[Alias('default')]
$DefaultValue
,
# Specifies a references to the Appclusive endpoints
[Parameter(Mandatory = $false)]
[Alias('Services')]
[hashtable] $svc = (Get-Variable -Name $MyInvocation.MyCommand.Module.PrivateData.MODULEVAR -ValueOnly).Services
,
# Specifies to return all existing entities
[Parameter(Mandatory = $false, ParameterSetName = 'list')]
[switch] $ListAvailable = $false
,
# Returns all Connectors which provide this Interface
[Parameter(Mandatory = $false)]
[Alias('Providers')]
[switch] $ListProviders = $false
,
# Returns all Connectors which require this Interface
[Parameter(Mandatory = $false)]
[Alias('Consumers')]
[switch] $ListConsumers = $false
,
# Specifies the return format of the search
[ValidateSet('default', 'json', 'json-pretty', 'xml', 'xml-pretty', 'object')]
[Parameter(Mandatory = $false)]
[alias('ReturnFormat')]
[string] $As = 'default'
)
Begin
{
trap { Log-Exception $_; break; }
$datBegin = [datetime]::Now;
[string] $fn = $MyInvocation.MyCommand.Name;
Log-Debug -fn $fn -msg ("CALL. svc '{0}'. Name '{1}'." -f ($svc -is [Object]), $Name) -fac 1;
$EntitySetName = 'Interfaces';
# Parameter validation
Contract-Requires ($svc.Core -is [biz.dfch.CS.Appclusive.Api.Core.Core]) "Connect to the server before using the Cmdlet"
$OrderBy = $OrderBy | Select -Unique;
$OrderByString = [string]::Join(',', $OrderBy);
$Select = $Select | Select -Unique;
if($ValueOnly)
{
if('object' -eq $As)
{
throw ("'ReturnFormat':'object' and 'ValueOnly' must not be specified at the same time." );
$e = New-CustomErrorRecord -m $msg -cat InvalidArgument -o $PSCmdlet;
$PSCmdlet.ThrowTerminatingError($e);
}
$Select = 'Value';
}
if($PSBoundParameters.ContainsKey('Select') -And 'object' -eq $As)
{
$msg = ("'ReturnFormat':'object' and 'Select' must not be specified at the same time." );
$e = New-CustomErrorRecord -m $msg -cat InvalidArgument -o $PSCmdlet;
$PSCmdlet.ThrowTerminatingError($e);
}
}
# Begin
Process
{
# Default test variable for checking function response codes.
[Boolean] $fReturn = $false;
# Return values are always and only returned via OutputParameter.
$OutputParameter = $null;
try
{
if($PSCmdlet.ParameterSetName -eq 'list')
{
if($Select -And 'object' -ne $As)
{
if($PSBoundParameters.ContainsKey('First'))
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$orderby','Name').AddQueryOption('$top', $First) | Select -Property $Select;
}
else
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$orderby','Name') | Select -Property $Select;
}
}
else
{
if($PSBoundParameters.ContainsKey('First'))
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$orderby','Name').AddQueryOption('$top', $First) | Select;
}
else
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$orderby','Name') | Select;
}
}
}
else
{
$Exp = @();
if($Id)
{
$Exp += ("(Id eq {0})" -f $Id);
}
if($Name)
{
$Name = $Name.ToLower();
$Exp += ("(tolower(Name) eq '{0}')" -f $Name);
}
$FilterExpression = [String]::Join(' and ', $Exp);
if($Select -And 'object' -ne $As)
{
if($PSBoundParameters.ContainsKey('First'))
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$filter', $FilterExpression).AddQueryOption('$orderby', $OrderByString).AddQueryOption('$top', $First) | Select -Property $Select;
}
else
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$filter', $FilterExpression).AddQueryOption('$orderby', $OrderByString) | Select -Property $Select;
}
}
else
{
if($PSBoundParameters.ContainsKey('First'))
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$filter', $FilterExpression).AddQueryOption('$orderby', $OrderByString).AddQueryOption('$top', $First) | Select;
}
else
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$filter', $FilterExpression).AddQueryOption('$orderby', $OrderByString) | Select;
}
}
if (!$Response)
{
if($PSBoundParameters.ContainsKey('DefaultValue'))
{
$Response = $DefaultValue;
}
}
else
{
if ($PSBoundParameters.ContainsKey('ListProviders'))
{
$Response = Get-Connector -svc $svc -InterfaceId $Response.Id -Provide;
}
elseif ($PSBoundParameters.ContainsKey('ListConsumers'))
{
$Response = Get-Connector -svc $svc -InterfaceId $Response.Id -Require;
}
}
if('Value' -eq $Select -And $ValueOnly)
{
$Response = ($Response).Value;
}
if('Value' -eq $Select -And $ConvertFrom)
{
$ResponseTemp = New-Object System.Collections.ArrayList;
foreach($item in $Response)
{
try
{
$null = $ResponseTemp.Add((ConvertFrom-Json -InputObject $item));
}
catch
{
$null = $ResponseTemp.Add($item);
}
}
$Response = $ResponseTemp.ToArray();
Remove-Variable ResponseTemp -Confirm:$false;
}
}
$OutputParameter = Format-ResultAs $Response $As
$fReturn = $true;
}
catch
{
if($gotoSuccess -eq $_.Exception.Message)
{
$fReturn = $true;
}
else
{
[string] $ErrorText = "catch [$($_.FullyQualifiedErrorId)]";
$ErrorText += (($_ | fl * -Force) | Out-String);
$ErrorText += (($_.Exception | fl * -Force) | Out-String);
$ErrorText += (Get-PSCallStack | Out-String);
if($_.Exception -is [System.Net.WebException])
{
Log-Critical $fn ("[WebException] Request FAILED with Status '{0}'. [{1}]." -f $_.Exception.Status, $_);
Log-Debug $fn $ErrorText -fac 3;
}
else
{
Log-Error $fn $ErrorText -fac 3;
if($gotoError -eq $_.Exception.Message)
{
Log-Error $fn $e.Exception.Message;
$PSCmdlet.ThrowTerminatingError($e);
}
elseif($gotoFailure -ne $_.Exception.Message)
{
Write-Verbose ("$fn`n$ErrorText");
}
else
{
# N/A
}
}
$fReturn = $false;
$OutputParameter = $null;
}
}
finally
{
# Clean up
# N/A
}
}
# Process
End
{
$datEnd = [datetime]::Now;
Log-Debug -fn $fn -msg ("RET. fReturn: [{0}]. Execution time: [{1}]ms. Started: [{2}]." -f $fReturn, ($datEnd - $datBegin).TotalMilliseconds, $datBegin.ToString('yyyy-MM-dd HH:mm:ss.fffzzz')) -fac 2;
# Return values are always and only returned via OutputParameter.
return $OutputParameter;
}
# End
}
if($MyInvocation.ScriptName) { Export-ModuleMember -Function Get-Interface; }
#
# Copyright 2016 d-fens GmbH
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SIG # Begin signature block
# MIIXDwYJKoZIhvcNAQcCoIIXADCCFvwCAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB
# gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR
# AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQUsD0I5LMa6z/ObGtpoLAGmzdx
# zhKgghHCMIIEFDCCAvygAwIBAgILBAAAAAABL07hUtcwDQYJKoZIhvcNAQEFBQAw
# VzELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNV
# BAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkdsb2JhbFNpZ24gUm9vdCBDQTAeFw0xMTA0
# MTMxMDAwMDBaFw0yODAxMjgxMjAwMDBaMFIxCzAJBgNVBAYTAkJFMRkwFwYDVQQK
# ExBHbG9iYWxTaWduIG52LXNhMSgwJgYDVQQDEx9HbG9iYWxTaWduIFRpbWVzdGFt
# cGluZyBDQSAtIEcyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAlO9l
# +LVXn6BTDTQG6wkft0cYasvwW+T/J6U00feJGr+esc0SQW5m1IGghYtkWkYvmaCN
# d7HivFzdItdqZ9C76Mp03otPDbBS5ZBb60cO8eefnAuQZT4XljBFcm05oRc2yrmg
# jBtPCBn2gTGtYRakYua0QJ7D/PuV9vu1LpWBmODvxevYAll4d/eq41JrUJEpxfz3
# zZNl0mBhIvIG+zLdFlH6Dv2KMPAXCae78wSuq5DnbN96qfTvxGInX2+ZbTh0qhGL
# 2t/HFEzphbLswn1KJo/nVrqm4M+SU4B09APsaLJgvIQgAIMboe60dAXBKY5i0Eex
# +vBTzBj5Ljv5cH60JQIDAQABo4HlMIHiMA4GA1UdDwEB/wQEAwIBBjASBgNVHRMB
# Af8ECDAGAQH/AgEAMB0GA1UdDgQWBBRG2D7/3OO+/4Pm9IWbsN1q1hSpwTBHBgNV
# HSAEQDA+MDwGBFUdIAAwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93d3cuZ2xvYmFs
# c2lnbi5jb20vcmVwb3NpdG9yeS8wMwYDVR0fBCwwKjAooCagJIYiaHR0cDovL2Ny
# bC5nbG9iYWxzaWduLm5ldC9yb290LmNybDAfBgNVHSMEGDAWgBRge2YaRQ2XyolQ
# L30EzTSo//z9SzANBgkqhkiG9w0BAQUFAAOCAQEATl5WkB5GtNlJMfO7FzkoG8IW
# 3f1B3AkFBJtvsqKa1pkuQJkAVbXqP6UgdtOGNNQXzFU6x4Lu76i6vNgGnxVQ380W
# e1I6AtcZGv2v8Hhc4EvFGN86JB7arLipWAQCBzDbsBJe/jG+8ARI9PBw+DpeVoPP
# PfsNvPTF7ZedudTbpSeE4zibi6c1hkQgpDttpGoLoYP9KOva7yj2zIhd+wo7AKvg
# IeviLzVsD440RZfroveZMzV+y5qKu0VN5z+fwtmK+mWybsd+Zf/okuEsMaL3sCc2
# SI8mbzvuTXYfecPlf5Y1vC0OzAGwjn//UYCAp5LUs0RGZIyHTxZjBzFLY7Df8zCC
# BCkwggMRoAMCAQICCwQAAAAAATGJxjfoMA0GCSqGSIb3DQEBCwUAMEwxIDAeBgNV
# BAsTF0dsb2JhbFNpZ24gUm9vdCBDQSAtIFIzMRMwEQYDVQQKEwpHbG9iYWxTaWdu
# MRMwEQYDVQQDEwpHbG9iYWxTaWduMB4XDTExMDgwMjEwMDAwMFoXDTE5MDgwMjEw
# MDAwMFowWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKPv0Z8p6djTgnY8YqDS
# SdYWHvHP8NC6SEMDLacd8gE0SaQQ6WIT9BP0FoO11VdCSIYrlViH6igEdMtyEQ9h
# JuH6HGEVxyibTQuCDyYrkDqW7aTQaymc9WGI5qRXb+70cNCNF97mZnZfdB5eDFM4
# XZD03zAtGxPReZhUGks4BPQHxCMD05LL94BdqpxWBkQtQUxItC3sNZKaxpXX9c6Q
# MeJ2s2G48XVXQqw7zivIkEnotybPuwyJy9DDo2qhydXjnFMrVyb+Vpp2/WFGomDs
# KUZH8s3ggmLGBFrn7U5AXEgGfZ1f53TJnoRlDVve3NMkHLQUEeurv8QfpLqZ0BdY
# Nc0CAwEAAaOB/TCB+jAOBgNVHQ8BAf8EBAMCAQYwEgYDVR0TAQH/BAgwBgEB/wIB
# ADAdBgNVHQ4EFgQUGUq4WuRNMaUU5V7sL6Mc+oCMMmswRwYDVR0gBEAwPjA8BgRV
# HSAAMDQwMgYIKwYBBQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3Jl
# cG9zaXRvcnkvMDYGA1UdHwQvMC0wK6ApoCeGJWh0dHA6Ly9jcmwuZ2xvYmFsc2ln
# bi5uZXQvcm9vdC1yMy5jcmwwEwYDVR0lBAwwCgYIKwYBBQUHAwMwHwYDVR0jBBgw
# FoAUj/BLf6guRSSuTVD6Y5qL3uLdG7wwDQYJKoZIhvcNAQELBQADggEBAHmwaTTi
# BYf2/tRgLC+GeTQD4LEHkwyEXPnk3GzPbrXsCly6C9BoMS4/ZL0Pgmtmd4F/ximl
# F9jwiU2DJBH2bv6d4UgKKKDieySApOzCmgDXsG1szYjVFXjPE/mIpXNNwTYr3MvO
# 23580ovvL72zT006rbtibiiTxAzL2ebK4BEClAOwvT+UKFaQHlPCJ9XJPM0aYx6C
# WRW2QMqngarDVa8z0bV16AnqRwhIIvtdG/Mseml+xddaXlYzPK1X6JMlQsPSXnE7
# ShxU7alVrCgFx8RsXdw8k/ZpPIJRzhoVPV4Bc/9Aouq0rtOO+u5dbEfHQfXUVlfy
# GDcy1tTMS/Zx4HYwggSfMIIDh6ADAgECAhIRIdaZp2SXPvH4Qn7pGcxTQRQwDQYJ
# KoZIhvcNAQEFBQAwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24g
# bnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzIw
# HhcNMTYwNTI0MDAwMDAwWhcNMjcwNjI0MDAwMDAwWjBgMQswCQYDVQQGEwJTRzEf
# MB0GA1UEChMWR01PIEdsb2JhbFNpZ24gUHRlIEx0ZDEwMC4GA1UEAxMnR2xvYmFs
# U2lnbiBUU0EgZm9yIE1TIEF1dGhlbnRpY29kZSAtIEcyMIIBIjANBgkqhkiG9w0B
# AQEFAAOCAQ8AMIIBCgKCAQEAsBeuotO2BDBWHlgPse1VpNZUy9j2czrsXV6rJf02
# pfqEw2FAxUa1WVI7QqIuXxNiEKlb5nPWkiWxfSPjBrOHOg5D8NcAiVOiETFSKG5d
# QHI88gl3p0mSl9RskKB2p/243LOd8gdgLE9YmABr0xVU4Prd/4AsXximmP/Uq+yh
# RVmyLm9iXeDZGayLV5yoJivZF6UQ0kcIGnAsM4t/aIAqtaFda92NAgIpA6p8N7u7
# KU49U5OzpvqP0liTFUy5LauAo6Ml+6/3CGSwekQPXBDXX2E3qk5r09JTJZ2Cc/os
# +XKwqRk5KlD6qdA8OsroW+/1X1H0+QrZlzXeaoXmIwRCrwIDAQABo4IBXzCCAVsw
# DgYDVR0PAQH/BAQDAgeAMEwGA1UdIARFMEMwQQYJKwYBBAGgMgEeMDQwMgYIKwYB
# BQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3JlcG9zaXRvcnkvMAkG
# A1UdEwQCMAAwFgYDVR0lAQH/BAwwCgYIKwYBBQUHAwgwQgYDVR0fBDswOTA3oDWg
# M4YxaHR0cDovL2NybC5nbG9iYWxzaWduLmNvbS9ncy9nc3RpbWVzdGFtcGluZ2cy
# LmNybDBUBggrBgEFBQcBAQRIMEYwRAYIKwYBBQUHMAKGOGh0dHA6Ly9zZWN1cmUu
# Z2xvYmFsc2lnbi5jb20vY2FjZXJ0L2dzdGltZXN0YW1waW5nZzIuY3J0MB0GA1Ud
# DgQWBBTUooRKOFoYf7pPMFC9ndV6h9YJ9zAfBgNVHSMEGDAWgBRG2D7/3OO+/4Pm
# 9IWbsN1q1hSpwTANBgkqhkiG9w0BAQUFAAOCAQEAj6kakW0EpjcgDoOW3iPTa24f
# bt1kPWghIrX4RzZpjuGlRcckoiK3KQnMVFquxrzNY46zPVBI5bTMrs2SjZ4oixNK
# Eaq9o+/Tsjb8tKFyv22XY3mMRLxwL37zvN2CU6sa9uv6HJe8tjecpBwwvKu8LUc2
# 35IgA+hxxlj2dQWaNPALWVqCRDSqgOQvhPZHXZbJtsrKnbemuuRQ09Q3uLogDtDT
# kipbxFm7oW3bPM5EncE4Kq3jjb3NCXcaEL5nCgI2ZIi5sxsm7ueeYMRGqLxhM2zP
# TrmcuWrwnzf+tT1PmtNN/94gjk6Xpv2fCbxNyhh2ybBNhVDygNIdBvVYBAexGDCC
# BNYwggO+oAMCAQICEhEhDRayW4wRltP+V8mGEea62TANBgkqhkiG9w0BAQsFADBa
# MQswCQYDVQQGEwJCRTEZMBcGA1UEChMQR2xvYmFsU2lnbiBudi1zYTEwMC4GA1UE
# AxMnR2xvYmFsU2lnbiBDb2RlU2lnbmluZyBDQSAtIFNIQTI1NiAtIEcyMB4XDTE1
# MDUwNDE2NDMyMVoXDTE4MDUwNDE2NDMyMVowVTELMAkGA1UEBhMCQ0gxDDAKBgNV
# BAgTA1p1ZzEMMAoGA1UEBxMDWnVnMRQwEgYDVQQKEwtkLWZlbnMgR21iSDEUMBIG
# A1UEAxMLZC1mZW5zIEdtYkgwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB
# AQDNPSzSNPylU9jFM78Q/GjzB7N+VNqikf/use7p8mpnBZ4cf5b4qV3rqQd62rJH
# RlAsxgouCSNQrl8xxfg6/t/I02kPvrzsR4xnDgMiVCqVRAeQsWebafWdTvWmONBS
# lxJejPP8TSgXMKFaDa+2HleTycTBYSoErAZSWpQ0NqF9zBadjsJRVatQuPkTDrwL
# eWibiyOipK9fcNoQpl5ll5H9EG668YJR3fqX9o0TQTkOmxXIL3IJ0UxdpyDpLEkt
# tBG6Y5wAdpF2dQX2phrfFNVY54JOGtuBkNGMSiLFzTkBA1fOlA6ICMYjB8xIFxVv
# rN1tYojCrqYkKMOjwWQz5X8zAgMBAAGjggGZMIIBlTAOBgNVHQ8BAf8EBAMCB4Aw
# TAYDVR0gBEUwQzBBBgkrBgEEAaAyATIwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93
# d3cuZ2xvYmFsc2lnbi5jb20vcmVwb3NpdG9yeS8wCQYDVR0TBAIwADATBgNVHSUE
# DDAKBggrBgEFBQcDAzBCBgNVHR8EOzA5MDegNaAzhjFodHRwOi8vY3JsLmdsb2Jh
# bHNpZ24uY29tL2dzL2dzY29kZXNpZ25zaGEyZzIuY3JsMIGQBggrBgEFBQcBAQSB
# gzCBgDBEBggrBgEFBQcwAoY4aHR0cDovL3NlY3VyZS5nbG9iYWxzaWduLmNvbS9j
# YWNlcnQvZ3Njb2Rlc2lnbnNoYTJnMi5jcnQwOAYIKwYBBQUHMAGGLGh0dHA6Ly9v
# Y3NwMi5nbG9iYWxzaWduLmNvbS9nc2NvZGVzaWduc2hhMmcyMB0GA1UdDgQWBBTN
# GDddiIYZy9p3Z84iSIMd27rtUDAfBgNVHSMEGDAWgBQZSrha5E0xpRTlXuwvoxz6
# gIwyazANBgkqhkiG9w0BAQsFAAOCAQEAAApsOzSX1alF00fTeijB/aIthO3UB0ks
# 1Gg3xoKQC1iEQmFG/qlFLiufs52kRPN7L0a7ClNH3iQpaH5IEaUENT9cNEXdKTBG
# 8OrJS8lrDJXImgNEgtSwz0B40h7bM2Z+0DvXDvpmfyM2NwHF/nNVj7NzmczrLRqN
# 9de3tV0pgRqnIYordVcmb24CZl3bzpwzbQQy14Iz+P5Z2cnw+QaYzAuweTZxEUcJ
# bFwpM49c1LMPFJTuOKkUgY90JJ3gVTpyQxfkc7DNBnx74PlRzjFmeGC/hxQt0hvo
# eaAiBdjo/1uuCTToigVnyRH+c0T2AezTeoFb7ne3I538hWeTdU5q9jGCBLcwggSz
# AgEBMHAwWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MgISESENFrJbjBGW0/5XyYYR5rrZMAkGBSsOAwIaBQCgeDAYBgorBgEEAYI3AgEM
# MQowCKACgAChAoAAMBkGCSqGSIb3DQEJAzEMBgorBgEEAYI3AgEEMBwGCisGAQQB
# gjcCAQsxDjAMBgorBgEEAYI3AgEVMCMGCSqGSIb3DQEJBDEWBBSIDnfuYv7RCEjo
# yIUHYhQWURxu8TANBgkqhkiG9w0BAQEFAASCAQAqF2rpx2oIXUi7EbGMDUA1q+xK
# DXuChv2KAcs+yMYWWUeU7BvxUHv4QdIJP2huIIJJfqKK15+tKYRhabaJ2QrbroIc
# 7A5n72NG4zOc6ST3iiiJlljHo0/kNHnjxBHRJ2jdsr3BX56MzuIpJJnw5OXNFdbM
# 8KU40oiL4l4YGWUc5cvwlEJ23YzzXWaWQtYAh4ka5cwEdpTlZODUr9lInCM/sTyz
# dgGvlEAlRJJqZu7ZgQ+b5MmoBfobQdfgrDCKpDaow9XDdRDoioob8IPC/1F7dZmH
# RCRcLrEufoKbRyFAQMAbo9nj/s74gHs8jAovAMnWvAFx2yzMHISLsMJMoxWIoYIC
# ojCCAp4GCSqGSIb3DQEJBjGCAo8wggKLAgEBMGgwUjELMAkGA1UEBhMCQkUxGTAX
# BgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGlt
# ZXN0YW1waW5nIENBIC0gRzICEhEh1pmnZJc+8fhCfukZzFNBFDAJBgUrDgMCGgUA
# oIH9MBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTE2
# MDgzMTE5MTY0MVowIwYJKoZIhvcNAQkEMRYEFN7oa4iGn7fLynhehuDW6jRzZTAH
# MIGdBgsqhkiG9w0BCRACDDGBjTCBijCBhzCBhAQUY7gvq2H1g5CWlQULACScUCkz
# 7HkwbDBWpFQwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYt
# c2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzICEhEh
# 1pmnZJc+8fhCfukZzFNBFDANBgkqhkiG9w0BAQEFAASCAQBwju31WC3bF6EOy8r7
# 41ZmD6qa0w25PJAB0oSGEaapqhbdHeBmBYbp7hlvykZAgR9AzOHnHiFsTt3b5dcw
# Igu0iKcXjD+bkqiZmR1/5NgzZ1rNqL4oi5f+TSL8EwT5TmaDO9vg7ElHo7We32Ho
# j8EvD/Kcf9uBMsBCeIpdHp3kaVlMwfC/WcA9s526HiaRYMWGjn8q1VVgfFi1uL7j
# YsTwQAnKZZfiVCsAPFGkNh59QlgLOtbAoqbU45PIrA7zghfFU5W4qcyfEQoauuFH
# /zJSRczLv4EIZ1Yc6UbgCSob4eDca/jHrRx6e9W/UnN8Q/NaRXyaQSU/JJReKzJK
# TG8O
# SIG # End signature block
|
PowerShellCorpus/PowerShellGallery/biz.dfch.PS.Appclusive.Client/5.2.1.20161201/Set-Folder.ps1
|
Set-Folder.ps1
|
function Set-Folder {
<#
.SYNOPSIS
Sets or creates a Folder entry in Appclusive.
.DESCRIPTION
Sets or creates a Folder entry in Appclusive.
By updating a Folder entry you can specify if you want to update the Name, Description or any combination thereof.
.OUTPUTS
default | json | json-pretty | xml | xml-pretty | PSCredential | Clear
.EXAMPLE
Set-Folder -Name ArbitraryName -CreateIfNotExist -svc $svc
EntityId :
Parameters : {}
EntityKindId : 28
ParentId : 1
Id : 79560
Tid : 11111111-1111-1111-1111-111111111111
Name : ArbitraryName
Description :
CreatedById : 1
ModifiedById : 1
Created : 08.09.2016 11:33:32 +02:00
Modified : 08.09.2016 11:33:32 +02:00
RowVersion : {0, 0, 0, 0...}
EntityKind :
Parent :
Children : {}
IncomingAssocs : {}
OutgoingAssocs : {}
Tenant :
CreatedBy :
ModifiedBy :
Create a new Folder entry if it does not exist.
.EXAMPLE
Set-Folder -Name ArbitraryName -NewName ArbitraryUpdatedName -NewDescription DescriptionUpdated -svc $svc
EntityId :
Parameters : {}
EntityKindId : 28
ParentId : 1
Id : 79560
Tid : 11111111-1111-1111-1111-111111111111
Name : ArbitraryUpdatedName
Description : DescriptionUpdated
CreatedById : 1
ModifiedById : 1
Created : 08.09.2016 11:33:32 +02:00
Modified : 08.09.2016 11:33:32 +02:00
RowVersion : {0, 0, 0, 0...}
EntityKind :
Parent :
Children : {}
IncomingAssocs : {}
OutgoingAssocs : {}
Tenant :
CreatedBy :
ModifiedBy :
Update an existing Folder with new Name and new Description.
.EXAMPLE
Set-Folder -id 79650 -NewName ArbitraryUpdatedName -NewDescription DescriptionUpdated -svc $svc
EntityId :
Parameters : {}
EntityKindId : 28
ParentId : 1
Id : 79560
Tid : 11111111-1111-1111-1111-111111111111
Name : ArbitraryUpdatedName
Description : DescriptionUpdated
CreatedById : 1
ModifiedById : 1
Created : 08.09.2016 11:33:32 +02:00
Modified : 08.09.2016 11:33:32 +02:00
RowVersion : {0, 0, 0, 0...}
EntityKind :
Parent :
Children : {}
IncomingAssocs : {}
OutgoingAssocs : {}
Tenant :
CreatedBy :
ModifiedBy :
Update an existing folder with a new name and description using its Id
.LINK
Online Version: http://dfch.biz/biz/dfch/PS/Appclusive/Client/Set-Folder/
.NOTES
See module manifest for dependencies and further requirements.
#>
[CmdletBinding(
SupportsShouldProcess = $false
,
ConfirmImpact = 'Low'
,
HelpURI = 'http://dfch.biz/biz/dfch/PS/Appclusive/Client/Set-KeyNameValue/'
)]
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseShouldProcessForStateChangingFunctions", "")]
Param
(
# Specifies the id of the entity
[Parameter(Mandatory = $true, ParameterSetName = 'id')]
[ValidateRange(1,[long]::MaxValue)]
[long] $Id
,
# Specifies the name to modify
[Parameter(Mandatory = $true, ParameterSetName = 'name')]
[ValidateNotNullOrEmpty()]
[Alias("n")]
[string] $Name
,
# Specifies the new name
[Parameter(Mandatory = $false, ParameterSetName = 'id')]
[ValidateNotNullOrEmpty()]
[string] $NewName
,
# Specifies the description to modify
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[Alias('d')]
[string] $Description
,
# Specifies the new description
[Parameter(Mandatory = $false, ParameterSetName = 'id')]
[string] $NewDescription
,
# Specifies the parent Id for this entity
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[ValidateRange(1,[long]::MaxValue)]
[Alias("pid")]
[long] $ParentId = (Get-ApcTenant -Current -svc $svc).NodeId
,
# Specifies the parameters for this entity
[Parameter(Mandatory = $false, ParameterSetName = 'name')]
[Alias("p")]
[string] $Parameters = '{}'
,
# Service reference to Appclusive
[Parameter(Mandatory = $false)]
[Alias('Services')]
[hashtable] $svc = (Get-Variable -Name $MyInvocation.MyCommand.Module.PrivateData.MODULEVAR -ValueOnly).Services
,
# Specifies the return format of the Cmdlet
[ValidateSet('default', 'json', 'json-pretty', 'xml', 'xml-pretty')]
[Parameter(Mandatory = $false)]
[alias('ReturnFormat')]
[string] $As = 'default'
)
Begin
{
trap { Log-Exception $_; break; }
$datBegin = [datetime]::Now;
[string] $fn = $MyInvocation.MyCommand.Name;
Log-Debug -fn $fn -msg ("CALL. svc '{0}'. Name '{1}'." -f ($svc -is [Object]), $Name) -fac 1;
# Parameter validation
Contract-Requires ($svc.Core -is [biz.dfch.CS.Appclusive.Api.Core.Core]) "Connect to the server before using the Cmdlet"
}
# Begin
Process
{
# Default test variable for checking function response codes.
[Boolean] $fReturn = $false;
# Return values are always and only returned via OutputParameter.
$OutputParameter = $null;
$AddedEntity = $null;
try
{
#handles creation of folder
if($PSCmdlet.ParameterSetName -eq 'name')
{
$folder = New-Object biz.dfch.CS.Appclusive.Api.Core.Folder;
$svc.Core.AddToFolders($folder);
$AddedEntity = $folder;
if($Name)
{
$folder.Name = $Name;
}
if ($Description)
{
$folder.Description = $Description;
}
$folder.EntityKindId = [biz.dfch.CS.Appclusive.Public.Constants+EntityKindId]::Folder.value__;
$folder.ParentId = $ParentId;
if ($Parameters)
{
$folder.Parameters = $Parameters;
}
}
#handles update of folder
elseif($PSCmdlet.ParameterSetName -eq 'id')
{
$folder = Get-Folder -svc $svc -id $Id;
Contract-Assert (!!$folder) 'Entity does not exist';
# new values when the folder is to be updated:
if($NewName)
{
$folder.Name = $NewName;
}
if($NewDescription)
{
$folder.Description = $NewDescription;
}
if($Parameters)
{
$folder.Parameters = $Parameters;
}
}
$name = $folder.Name;
$svc.Core.UpdateObject($folder);
$r = $svc.Core.SaveChanges();
#get folder
$folder = Get-Folder -svc $svc -Name $name;
$r = $folder;
$OutputParameter = Format-ResultAs $r $As;
$fReturn = $true;
}
catch
{
if($gotoSuccess -eq $_.Exception.Message)
{
$fReturn = $true;
}
else
{
[string] $ErrorText = "catch [$($_.FullyQualifiedErrorId)]";
$ErrorText += (($_ | fl * -Force) | Out-String);
$ErrorText += (($_.Exception | fl * -Force) | Out-String);
$ErrorText += (Get-PSCallStack | Out-String);
if($_.Exception -is [System.Net.WebException])
{
Log-Critical $fn ("[WebException] Request FAILED with Status '{0}'. [{1}]." -f $_.Exception.Status, $_);
Log-Debug $fn $ErrorText -fac 3;
}
else
{
Log-Error $fn $ErrorText -fac 3;
if($gotoError -eq $_.Exception.Message)
{
Log-Error $fn $e.Exception.Message;
$PSCmdlet.ThrowTerminatingError($e);
}
elseif($gotoFailure -ne $_.Exception.Message)
{
Write-Verbose ("$fn`n$ErrorText");
}
else
{
# N/A
}
}
$fReturn = $false;
$OutputParameter = $null;
if($AddedEntity)
{
$svc.Core.DeleteObject($AddedEntity);
$svc.Core.SaveChanges();
}
}
}
finally
{
# Clean up
# N/A
}
}
# Process
End
{
$datEnd = [datetime]::Now;
Log-Debug -fn $fn -msg ("RET. fReturn: [{0}]. Execution time: [{1}]ms. Started: [{2}]." -f $fReturn, ($datEnd - $datBegin).TotalMilliseconds, $datBegin.ToString('yyyy-MM-dd HH:mm:ss.fffzzz')) -fac 2;
# Return values are always and only returned via OutputParameter.
return $OutputParameter;
}
# End
}
if($MyInvocation.ScriptName) { Export-ModuleMember -Function Set-Folder; }
#
# Copyright 2014-2015 d-fens GmbH
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
|
PowerShellCorpus/PowerShellGallery/biz.dfch.PS.Appclusive.Client/5.2.1.20161201/Enter-Server.ps1
|
Enter-Server.ps1
|
function Enter-Server {
<#
.SYNOPSIS
Performs a login to an Appclusive server.
.DESCRIPTION
Performs a login to an Appclusive server.
This is the first Cmdlet to be executed and required for all other Cmdlets of this module. It creates service references to the routers of the application.
.OUTPUTS
This Cmdlet returns a hashtable with references to the DataServiceContexts of the application. On failure it returns $null.
.INPUTS
See PARAMETER section for a description of input parameters.
.EXAMPLE
$svc = Enter-ApcServer;
$svc
Name Value
---- -----
Diagnostics biz.dfch.CS.Appclusive.Api.Diagnostics.Diagnostics
CoreData biz.dfch.CS.Appclusive.Api.Core.Core
Perform a login to an Appclusive server with default credentials (current user) and against server defined within module configuration xml file.
.LINK
Online Version: http://dfch.biz/biz/dfch/PS/Appclusive/Client/Enter-Server/
.NOTES
See module manifest for required software versions and dependencies at:
http://dfch.biz/biz/dfch/PS/Appclusive/Client/biz.dfch.PS.Appclusive.Client.psd1/
#>
[CmdletBinding(
HelpURI = 'http://dfch.biz/biz/dfch/PS/Appclusive/Client/Enter-Server/'
)]
[OutputType([hashtable])]
Param
(
# [Optional] The ServerBaseUri such as 'https://appclusive/'. If you do not
# specify this value it is taken from the module configuration file.
[Parameter(Mandatory = $false, Position = 0)]
[Uri] $ServerBaseUri = (Get-Variable -Name $MyInvocation.MyCommand.Module.PrivateData.MODULEVAR -ValueOnly).ServerBaseUri
,
# [Optional] The BaseUrl such as '/Appclusive/'. If you do not specify this
# value it is taken from the module configuration file.
[Parameter(Mandatory = $false, Position = 1)]
[string] $BaseUrl = (Get-Variable -Name $MyInvocation.MyCommand.Module.PrivateData.MODULEVAR -ValueOnly).BaseUrl
,
# Encrypted credentials as [System.Management.Automation.PSCredential] with
# which to perform login. Default is credential as specified in the module
# configuration file.
[Parameter(Mandatory = $false, Position = 2)]
[alias("cred")]
$Credential = (Get-Variable -Name $MyInvocation.MyCommand.Module.PrivateData.MODULEVAR -ValueOnly).Credential
,
[Parameter(Mandatory = $false)]
[string] $TenantId
,
[ValidateSet('Biz-Dfch-Tenant-Id', 'Tenant-Id')]
[Parameter(Mandatory = $false)]
[string] $TenantHeaderName = 'Biz-Dfch-Tenant-Id'
)
Begin
{
trap { Log-Exception $_; break; }
$datBegin = [datetime]::Now;
[string] $fn = $MyInvocation.MyCommand.Name;
Log-Debug $fn ("CALL. ServerBaseUri '{0}'; BaseUrl '{1}'. Username '{2}'" -f $ServerBaseUri, $BaseUrl, $Credential.Username ) -fac 1;
}
# Begin
Process
{
trap { Log-Exception $_; break; }
# Default test variable for checking function response codes.
[Boolean] $fReturn = $false;
# Return values are always and only returned via OutputParameter.
$OutputParameter = $null;
# Parameter validation
# N/A
[Uri] $Uri = '{0}{1}' -f $ServerBaseUri.AbsoluteUri.TrimEnd('/'), ('{0}/' -f $BaseUrl.TrimEnd('/'));
# get all available DataServiceContexts from Api module
$endpoints = (Get-DataType 'biz.dfch.CS.Appclusive.Api.DataServiceContextBase' -Literal -CaseSensitive -BaseType -AssemblyName biz.dfch.CS.Appclusive.Api); # -cmatch '^biz.dfch.CS.Appclusive.Api.';
foreach($endpoint in $endpoints)
{
$endpointParts = $endpoint.Split('.');
if(2 -gt $endpointParts.Count)
{
continue;
}
if($endpointParts[-1] -ne $endpointParts[-2])
{
continue;
}
$endpointName = $endpointParts[-1];
[Uri] $UriService = '{0}{1}' -f $Uri.AbsoluteUri, $endpointName;
Log-Debug $fn ("Creating service '{0}': '{1}' ..." -f $endpoint, $UriService.AbsoluteUri);
# create DataServiceContext w/ credentials
$dataServiceContext = New-Object -TypeName $endpoint -ArgumentList $UriService;
$dataServiceContext.Credentials = $Credential;
# set tenant information if logging in via different tenant
if($TenantHeaderName)
{
$dataServiceContext.TenantHeaderName = $TenantHeaderName;
}
if($TenantId)
{
$dataServiceContext.TenantID = $TenantId;
}
# set JSON as MIME type if specified
if((Get-Variable -Name $MyInvocation.MyCommand.Module.PrivateData.MODULEVAR -ValueOnly).Format -ieq 'JSON')
{
$dataServiceContext.Format.UseJson();
}
# apply options for saving changes (MERGE, PUT, PATCH)
$saveChangesDefaultOptions = (Get-Variable -Name $MyInvocation.MyCommand.Module.PrivateData.MODULEVAR -ValueOnly).SaveChangesDefaultOptions;
if($saveChangesDefaultOptions)
{
$dataServiceContext.SaveChangesDefaultOptions = $saveChangesDefaultOptions;
}
# merge options for saving changes (MERGE, PUT, PATCH)
# https://msdn.microsoft.com/en-us/library/system.data.services.client.mergeoption
$mergeOption = (Get-Variable -Name $MyInvocation.MyCommand.Module.PrivateData.MODULEVAR -ValueOnly).MergeOption;
if($mergeOption)
{
$dataServiceContext.MergeOption = $mergeOption;
}
# save context into Service module variable (svc)
(Get-Variable -Name $MyInvocation.MyCommand.Module.PrivateData.MODULEVAR -ValueOnly).Services.$endpointName = $dataServiceContext;
}
$OutputParameter = (Get-Variable -Name $MyInvocation.MyCommand.Module.PrivateData.MODULEVAR -ValueOnly).Services;
$fReturn = $true;
return $OutputParameter;
}
# Process
End
{
trap { Log-Exception $_; break; }
$datEnd = [datetime]::Now;
Log-Debug -fn $fn -msg ("RET. fReturn: [{0}]. Execution time: [{1}]ms. Started: [{2}]." -f $fReturn, ($datEnd - $datBegin).TotalMilliseconds, $datBegin.ToString('yyyy-MM-dd HH:mm:ss.fffzzz')) -fac 2;
}
# End
} # function
Set-Alias -Name Connect- -Value 'Enter-Server';
Set-Alias -Name Enter- -Value 'Enter-Server';
if($MyInvocation.ScriptName) { Export-ModuleMember -Function Enter-Server -Alias Connect-, Enter-; }
#
# Copyright 2014-2015 d-fens GmbH
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SIG # Begin signature block
# MIIXDwYJKoZIhvcNAQcCoIIXADCCFvwCAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB
# gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR
# AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQUGhALLQHaDtLU/9JaNRMaL/TL
# c5SgghHCMIIEFDCCAvygAwIBAgILBAAAAAABL07hUtcwDQYJKoZIhvcNAQEFBQAw
# VzELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNV
# BAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkdsb2JhbFNpZ24gUm9vdCBDQTAeFw0xMTA0
# MTMxMDAwMDBaFw0yODAxMjgxMjAwMDBaMFIxCzAJBgNVBAYTAkJFMRkwFwYDVQQK
# ExBHbG9iYWxTaWduIG52LXNhMSgwJgYDVQQDEx9HbG9iYWxTaWduIFRpbWVzdGFt
# cGluZyBDQSAtIEcyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAlO9l
# +LVXn6BTDTQG6wkft0cYasvwW+T/J6U00feJGr+esc0SQW5m1IGghYtkWkYvmaCN
# d7HivFzdItdqZ9C76Mp03otPDbBS5ZBb60cO8eefnAuQZT4XljBFcm05oRc2yrmg
# jBtPCBn2gTGtYRakYua0QJ7D/PuV9vu1LpWBmODvxevYAll4d/eq41JrUJEpxfz3
# zZNl0mBhIvIG+zLdFlH6Dv2KMPAXCae78wSuq5DnbN96qfTvxGInX2+ZbTh0qhGL
# 2t/HFEzphbLswn1KJo/nVrqm4M+SU4B09APsaLJgvIQgAIMboe60dAXBKY5i0Eex
# +vBTzBj5Ljv5cH60JQIDAQABo4HlMIHiMA4GA1UdDwEB/wQEAwIBBjASBgNVHRMB
# Af8ECDAGAQH/AgEAMB0GA1UdDgQWBBRG2D7/3OO+/4Pm9IWbsN1q1hSpwTBHBgNV
# HSAEQDA+MDwGBFUdIAAwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93d3cuZ2xvYmFs
# c2lnbi5jb20vcmVwb3NpdG9yeS8wMwYDVR0fBCwwKjAooCagJIYiaHR0cDovL2Ny
# bC5nbG9iYWxzaWduLm5ldC9yb290LmNybDAfBgNVHSMEGDAWgBRge2YaRQ2XyolQ
# L30EzTSo//z9SzANBgkqhkiG9w0BAQUFAAOCAQEATl5WkB5GtNlJMfO7FzkoG8IW
# 3f1B3AkFBJtvsqKa1pkuQJkAVbXqP6UgdtOGNNQXzFU6x4Lu76i6vNgGnxVQ380W
# e1I6AtcZGv2v8Hhc4EvFGN86JB7arLipWAQCBzDbsBJe/jG+8ARI9PBw+DpeVoPP
# PfsNvPTF7ZedudTbpSeE4zibi6c1hkQgpDttpGoLoYP9KOva7yj2zIhd+wo7AKvg
# IeviLzVsD440RZfroveZMzV+y5qKu0VN5z+fwtmK+mWybsd+Zf/okuEsMaL3sCc2
# SI8mbzvuTXYfecPlf5Y1vC0OzAGwjn//UYCAp5LUs0RGZIyHTxZjBzFLY7Df8zCC
# BCkwggMRoAMCAQICCwQAAAAAATGJxjfoMA0GCSqGSIb3DQEBCwUAMEwxIDAeBgNV
# BAsTF0dsb2JhbFNpZ24gUm9vdCBDQSAtIFIzMRMwEQYDVQQKEwpHbG9iYWxTaWdu
# MRMwEQYDVQQDEwpHbG9iYWxTaWduMB4XDTExMDgwMjEwMDAwMFoXDTE5MDgwMjEw
# MDAwMFowWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKPv0Z8p6djTgnY8YqDS
# SdYWHvHP8NC6SEMDLacd8gE0SaQQ6WIT9BP0FoO11VdCSIYrlViH6igEdMtyEQ9h
# JuH6HGEVxyibTQuCDyYrkDqW7aTQaymc9WGI5qRXb+70cNCNF97mZnZfdB5eDFM4
# XZD03zAtGxPReZhUGks4BPQHxCMD05LL94BdqpxWBkQtQUxItC3sNZKaxpXX9c6Q
# MeJ2s2G48XVXQqw7zivIkEnotybPuwyJy9DDo2qhydXjnFMrVyb+Vpp2/WFGomDs
# KUZH8s3ggmLGBFrn7U5AXEgGfZ1f53TJnoRlDVve3NMkHLQUEeurv8QfpLqZ0BdY
# Nc0CAwEAAaOB/TCB+jAOBgNVHQ8BAf8EBAMCAQYwEgYDVR0TAQH/BAgwBgEB/wIB
# ADAdBgNVHQ4EFgQUGUq4WuRNMaUU5V7sL6Mc+oCMMmswRwYDVR0gBEAwPjA8BgRV
# HSAAMDQwMgYIKwYBBQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3Jl
# cG9zaXRvcnkvMDYGA1UdHwQvMC0wK6ApoCeGJWh0dHA6Ly9jcmwuZ2xvYmFsc2ln
# bi5uZXQvcm9vdC1yMy5jcmwwEwYDVR0lBAwwCgYIKwYBBQUHAwMwHwYDVR0jBBgw
# FoAUj/BLf6guRSSuTVD6Y5qL3uLdG7wwDQYJKoZIhvcNAQELBQADggEBAHmwaTTi
# BYf2/tRgLC+GeTQD4LEHkwyEXPnk3GzPbrXsCly6C9BoMS4/ZL0Pgmtmd4F/ximl
# F9jwiU2DJBH2bv6d4UgKKKDieySApOzCmgDXsG1szYjVFXjPE/mIpXNNwTYr3MvO
# 23580ovvL72zT006rbtibiiTxAzL2ebK4BEClAOwvT+UKFaQHlPCJ9XJPM0aYx6C
# WRW2QMqngarDVa8z0bV16AnqRwhIIvtdG/Mseml+xddaXlYzPK1X6JMlQsPSXnE7
# ShxU7alVrCgFx8RsXdw8k/ZpPIJRzhoVPV4Bc/9Aouq0rtOO+u5dbEfHQfXUVlfy
# GDcy1tTMS/Zx4HYwggSfMIIDh6ADAgECAhIRIdaZp2SXPvH4Qn7pGcxTQRQwDQYJ
# KoZIhvcNAQEFBQAwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24g
# bnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzIw
# HhcNMTYwNTI0MDAwMDAwWhcNMjcwNjI0MDAwMDAwWjBgMQswCQYDVQQGEwJTRzEf
# MB0GA1UEChMWR01PIEdsb2JhbFNpZ24gUHRlIEx0ZDEwMC4GA1UEAxMnR2xvYmFs
# U2lnbiBUU0EgZm9yIE1TIEF1dGhlbnRpY29kZSAtIEcyMIIBIjANBgkqhkiG9w0B
# AQEFAAOCAQ8AMIIBCgKCAQEAsBeuotO2BDBWHlgPse1VpNZUy9j2czrsXV6rJf02
# pfqEw2FAxUa1WVI7QqIuXxNiEKlb5nPWkiWxfSPjBrOHOg5D8NcAiVOiETFSKG5d
# QHI88gl3p0mSl9RskKB2p/243LOd8gdgLE9YmABr0xVU4Prd/4AsXximmP/Uq+yh
# RVmyLm9iXeDZGayLV5yoJivZF6UQ0kcIGnAsM4t/aIAqtaFda92NAgIpA6p8N7u7
# KU49U5OzpvqP0liTFUy5LauAo6Ml+6/3CGSwekQPXBDXX2E3qk5r09JTJZ2Cc/os
# +XKwqRk5KlD6qdA8OsroW+/1X1H0+QrZlzXeaoXmIwRCrwIDAQABo4IBXzCCAVsw
# DgYDVR0PAQH/BAQDAgeAMEwGA1UdIARFMEMwQQYJKwYBBAGgMgEeMDQwMgYIKwYB
# BQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3JlcG9zaXRvcnkvMAkG
# A1UdEwQCMAAwFgYDVR0lAQH/BAwwCgYIKwYBBQUHAwgwQgYDVR0fBDswOTA3oDWg
# M4YxaHR0cDovL2NybC5nbG9iYWxzaWduLmNvbS9ncy9nc3RpbWVzdGFtcGluZ2cy
# LmNybDBUBggrBgEFBQcBAQRIMEYwRAYIKwYBBQUHMAKGOGh0dHA6Ly9zZWN1cmUu
# Z2xvYmFsc2lnbi5jb20vY2FjZXJ0L2dzdGltZXN0YW1waW5nZzIuY3J0MB0GA1Ud
# DgQWBBTUooRKOFoYf7pPMFC9ndV6h9YJ9zAfBgNVHSMEGDAWgBRG2D7/3OO+/4Pm
# 9IWbsN1q1hSpwTANBgkqhkiG9w0BAQUFAAOCAQEAj6kakW0EpjcgDoOW3iPTa24f
# bt1kPWghIrX4RzZpjuGlRcckoiK3KQnMVFquxrzNY46zPVBI5bTMrs2SjZ4oixNK
# Eaq9o+/Tsjb8tKFyv22XY3mMRLxwL37zvN2CU6sa9uv6HJe8tjecpBwwvKu8LUc2
# 35IgA+hxxlj2dQWaNPALWVqCRDSqgOQvhPZHXZbJtsrKnbemuuRQ09Q3uLogDtDT
# kipbxFm7oW3bPM5EncE4Kq3jjb3NCXcaEL5nCgI2ZIi5sxsm7ueeYMRGqLxhM2zP
# TrmcuWrwnzf+tT1PmtNN/94gjk6Xpv2fCbxNyhh2ybBNhVDygNIdBvVYBAexGDCC
# BNYwggO+oAMCAQICEhEhDRayW4wRltP+V8mGEea62TANBgkqhkiG9w0BAQsFADBa
# MQswCQYDVQQGEwJCRTEZMBcGA1UEChMQR2xvYmFsU2lnbiBudi1zYTEwMC4GA1UE
# AxMnR2xvYmFsU2lnbiBDb2RlU2lnbmluZyBDQSAtIFNIQTI1NiAtIEcyMB4XDTE1
# MDUwNDE2NDMyMVoXDTE4MDUwNDE2NDMyMVowVTELMAkGA1UEBhMCQ0gxDDAKBgNV
# BAgTA1p1ZzEMMAoGA1UEBxMDWnVnMRQwEgYDVQQKEwtkLWZlbnMgR21iSDEUMBIG
# A1UEAxMLZC1mZW5zIEdtYkgwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB
# AQDNPSzSNPylU9jFM78Q/GjzB7N+VNqikf/use7p8mpnBZ4cf5b4qV3rqQd62rJH
# RlAsxgouCSNQrl8xxfg6/t/I02kPvrzsR4xnDgMiVCqVRAeQsWebafWdTvWmONBS
# lxJejPP8TSgXMKFaDa+2HleTycTBYSoErAZSWpQ0NqF9zBadjsJRVatQuPkTDrwL
# eWibiyOipK9fcNoQpl5ll5H9EG668YJR3fqX9o0TQTkOmxXIL3IJ0UxdpyDpLEkt
# tBG6Y5wAdpF2dQX2phrfFNVY54JOGtuBkNGMSiLFzTkBA1fOlA6ICMYjB8xIFxVv
# rN1tYojCrqYkKMOjwWQz5X8zAgMBAAGjggGZMIIBlTAOBgNVHQ8BAf8EBAMCB4Aw
# TAYDVR0gBEUwQzBBBgkrBgEEAaAyATIwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93
# d3cuZ2xvYmFsc2lnbi5jb20vcmVwb3NpdG9yeS8wCQYDVR0TBAIwADATBgNVHSUE
# DDAKBggrBgEFBQcDAzBCBgNVHR8EOzA5MDegNaAzhjFodHRwOi8vY3JsLmdsb2Jh
# bHNpZ24uY29tL2dzL2dzY29kZXNpZ25zaGEyZzIuY3JsMIGQBggrBgEFBQcBAQSB
# gzCBgDBEBggrBgEFBQcwAoY4aHR0cDovL3NlY3VyZS5nbG9iYWxzaWduLmNvbS9j
# YWNlcnQvZ3Njb2Rlc2lnbnNoYTJnMi5jcnQwOAYIKwYBBQUHMAGGLGh0dHA6Ly9v
# Y3NwMi5nbG9iYWxzaWduLmNvbS9nc2NvZGVzaWduc2hhMmcyMB0GA1UdDgQWBBTN
# GDddiIYZy9p3Z84iSIMd27rtUDAfBgNVHSMEGDAWgBQZSrha5E0xpRTlXuwvoxz6
# gIwyazANBgkqhkiG9w0BAQsFAAOCAQEAAApsOzSX1alF00fTeijB/aIthO3UB0ks
# 1Gg3xoKQC1iEQmFG/qlFLiufs52kRPN7L0a7ClNH3iQpaH5IEaUENT9cNEXdKTBG
# 8OrJS8lrDJXImgNEgtSwz0B40h7bM2Z+0DvXDvpmfyM2NwHF/nNVj7NzmczrLRqN
# 9de3tV0pgRqnIYordVcmb24CZl3bzpwzbQQy14Iz+P5Z2cnw+QaYzAuweTZxEUcJ
# bFwpM49c1LMPFJTuOKkUgY90JJ3gVTpyQxfkc7DNBnx74PlRzjFmeGC/hxQt0hvo
# eaAiBdjo/1uuCTToigVnyRH+c0T2AezTeoFb7ne3I538hWeTdU5q9jGCBLcwggSz
# AgEBMHAwWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MgISESENFrJbjBGW0/5XyYYR5rrZMAkGBSsOAwIaBQCgeDAYBgorBgEEAYI3AgEM
# MQowCKACgAChAoAAMBkGCSqGSIb3DQEJAzEMBgorBgEEAYI3AgEEMBwGCisGAQQB
# gjcCAQsxDjAMBgorBgEEAYI3AgEVMCMGCSqGSIb3DQEJBDEWBBQQ1Tu5fNc5HDdO
# Vwc6zOoCaErwtzANBgkqhkiG9w0BAQEFAASCAQCz2YF3wK90eXYFnFfamfaSxNEp
# QHt9qYhmwbWJOsC7ou/bGNp8ot64QFU3j1/RWBsumnpknKQwhf9TqUdbu0Kwjv0i
# e0ZxoeatUI5cfCGASscE/EcupieQYsuCN97QjiNTctXIVPvruYniW36ttll8vEwp
# S2TsTKhvjVk0XRMpB9w81JbrNVcS8yOjzMKgKwuAtW1KTRKpb+7heDguNZK1FBan
# A5qGd2exgBYITTdcAKG3weqN/1Kk87zd9y72QPC2w9LuNHo+z0/U8x2iBQo5YD4k
# eaC9d4pPRJfjWTu15U3tf43gRSWGrQVNxG0bViJGd6UdiSN1aUA6b6LfNooUoYIC
# ojCCAp4GCSqGSIb3DQEJBjGCAo8wggKLAgEBMGgwUjELMAkGA1UEBhMCQkUxGTAX
# BgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGlt
# ZXN0YW1waW5nIENBIC0gRzICEhEh1pmnZJc+8fhCfukZzFNBFDAJBgUrDgMCGgUA
# oIH9MBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTE2
# MDgzMTE5MTYzN1owIwYJKoZIhvcNAQkEMRYEFG37xhk/N2PJ/dNIV1b7FPZ2ltxo
# MIGdBgsqhkiG9w0BCRACDDGBjTCBijCBhzCBhAQUY7gvq2H1g5CWlQULACScUCkz
# 7HkwbDBWpFQwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYt
# c2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzICEhEh
# 1pmnZJc+8fhCfukZzFNBFDANBgkqhkiG9w0BAQEFAASCAQBW3RIDRWCBunEdz7sB
# B/licROLXEPXYPHpHmFKgng2N+qg9xW8iPJOG2dGpE7laigbwKlAkEv7DBDIX62l
# KE7oPzIbpiTGXUpAE/3XnS7q1dh+CPHuSYPHdpBWvqgGJuaoTrEUvJZApVFKARzp
# j4HhF+WT+Sq1Li1oI5742IufN1TFUbawtQ6HmyQW/aEUIl80ipT5p3rL1n+L8QCe
# AWjXSEJyhSpIVfxZWgKV9NwrjzsheHJ2uJFgnWufXy96SJ0ewT37BFDA0WF/TPqw
# uqHf8SJRBlKUR0Uo6K0WzQ0Jg9nlH1y8LpgcIj9nW0GnvVmmXb+Kf4RgbhwUtSKG
# Nbso
# SIG # End signature block
|
PowerShellCorpus/PowerShellGallery/biz.dfch.PS.Appclusive.Client/5.2.1.20161201/Remove-Connector.ps1
|
Remove-Connector.ps1
|
function Remove-Connector {
<#
.SYNOPSIS
Removes a Connector.
.DESCRIPTION
Removes a Connector.
The Cmdlet lets you remove an existing entry from the Connector.
.EXAMPLE
Remove-Connector -Id connectorId -Confirm
Removes the Connector with explicit confirmation.
#>
[CmdletBinding(
ConfirmImpact = 'High'
,
HelpURI = 'http://dfch.biz/biz/dfch/PS/Appclusive/Client/Remove-Connector/'
)]
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseShouldProcessForStateChangingFunctions", "")]
Param
(
# The key name portion of the KNV to remove
[Parameter(Mandatory = $false, Position = 0, ParameterSetName = 'Id')]
[string] $Id
,
# Service reference to Appclusive
[Parameter(Mandatory = $false)]
[Alias('Services')]
[hashtable] $svc = (Get-Variable -Name $MyInvocation.MyCommand.Module.PrivateData.MODULEVAR -ValueOnly).Services
,
# Specifies the return format of the Cnmdlet
[ValidateSet('default', 'json', 'json-pretty', 'xml', 'xml-pretty')]
[Parameter(Mandatory = $false)]
[alias('ReturnFormat')]
[string] $As = 'default'
)
Begin
{
trap { Log-Exception $_; break; }
$entitySetName = "Connectors";
$datBegin = [datetime]::Now;
[string] $fn = $MyInvocation.MyCommand.Name;
Log-Debug -fn $fn -msg ("CALL. svc '{0}'. Name '{1}'." -f ($svc -is [Object]), $Name) -fac 1;
# Parameter validation
Contract-Requires ($svc.Core -is [biz.dfch.CS.Appclusive.Api.Core.Core]) "Connect to the server before using the Cmdlet"
}
# Begin
Process
{
trap { Log-Exception $_; break; }
# Default test variable for checking function response codes.
[Boolean] $fReturn = $false;
# Return values are always and only returned via OutputParameter.
$OutputParameter = $null;
$Exp = @();
if($Id)
{
$Exp += ("(Id eq {0})" -f $Id);
}
$r = @();
$FilterExpression = [String]::Join(' and ', $Exp);
$entity = $svc.Core.$entitySetName.AddQueryOption('$filter', $FilterExpression).AddQueryOption('$top', 1) | Select;
Remove-Entity -svc $svc -Id ($entity.Id) -EntitySetName $entitySetName -Confirm:$false;
$OutputParameter = Format-ResultAs $r $As
$fReturn = $true;
}
# Process
End
{
$datEnd = [datetime]::Now;
Log-Debug -fn $fn -msg ("RET. fReturn: [{0}]. Execution time: [{1}]ms. Started: [{2}]." -f $fReturn, ($datEnd - $datBegin).TotalMilliseconds, $datBegin.ToString('yyyy-MM-dd HH:mm:ss.fffzzz')) -fac 2;
# Return values are always and only returned via OutputParameter.
return $OutputParameter;
}
# End
}
if($MyInvocation.ScriptName) { Export-ModuleMember -Function Remove-Connector; }
#
# Copyright 2016 d-fens GmbH
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SIG # Begin signature block
# MIIXDwYJKoZIhvcNAQcCoIIXADCCFvwCAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB
# gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR
# AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQU86wZBcN4Gp3/2oJCKOToenH8
# woSgghHCMIIEFDCCAvygAwIBAgILBAAAAAABL07hUtcwDQYJKoZIhvcNAQEFBQAw
# VzELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNV
# BAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkdsb2JhbFNpZ24gUm9vdCBDQTAeFw0xMTA0
# MTMxMDAwMDBaFw0yODAxMjgxMjAwMDBaMFIxCzAJBgNVBAYTAkJFMRkwFwYDVQQK
# ExBHbG9iYWxTaWduIG52LXNhMSgwJgYDVQQDEx9HbG9iYWxTaWduIFRpbWVzdGFt
# cGluZyBDQSAtIEcyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAlO9l
# +LVXn6BTDTQG6wkft0cYasvwW+T/J6U00feJGr+esc0SQW5m1IGghYtkWkYvmaCN
# d7HivFzdItdqZ9C76Mp03otPDbBS5ZBb60cO8eefnAuQZT4XljBFcm05oRc2yrmg
# jBtPCBn2gTGtYRakYua0QJ7D/PuV9vu1LpWBmODvxevYAll4d/eq41JrUJEpxfz3
# zZNl0mBhIvIG+zLdFlH6Dv2KMPAXCae78wSuq5DnbN96qfTvxGInX2+ZbTh0qhGL
# 2t/HFEzphbLswn1KJo/nVrqm4M+SU4B09APsaLJgvIQgAIMboe60dAXBKY5i0Eex
# +vBTzBj5Ljv5cH60JQIDAQABo4HlMIHiMA4GA1UdDwEB/wQEAwIBBjASBgNVHRMB
# Af8ECDAGAQH/AgEAMB0GA1UdDgQWBBRG2D7/3OO+/4Pm9IWbsN1q1hSpwTBHBgNV
# HSAEQDA+MDwGBFUdIAAwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93d3cuZ2xvYmFs
# c2lnbi5jb20vcmVwb3NpdG9yeS8wMwYDVR0fBCwwKjAooCagJIYiaHR0cDovL2Ny
# bC5nbG9iYWxzaWduLm5ldC9yb290LmNybDAfBgNVHSMEGDAWgBRge2YaRQ2XyolQ
# L30EzTSo//z9SzANBgkqhkiG9w0BAQUFAAOCAQEATl5WkB5GtNlJMfO7FzkoG8IW
# 3f1B3AkFBJtvsqKa1pkuQJkAVbXqP6UgdtOGNNQXzFU6x4Lu76i6vNgGnxVQ380W
# e1I6AtcZGv2v8Hhc4EvFGN86JB7arLipWAQCBzDbsBJe/jG+8ARI9PBw+DpeVoPP
# PfsNvPTF7ZedudTbpSeE4zibi6c1hkQgpDttpGoLoYP9KOva7yj2zIhd+wo7AKvg
# IeviLzVsD440RZfroveZMzV+y5qKu0VN5z+fwtmK+mWybsd+Zf/okuEsMaL3sCc2
# SI8mbzvuTXYfecPlf5Y1vC0OzAGwjn//UYCAp5LUs0RGZIyHTxZjBzFLY7Df8zCC
# BCkwggMRoAMCAQICCwQAAAAAATGJxjfoMA0GCSqGSIb3DQEBCwUAMEwxIDAeBgNV
# BAsTF0dsb2JhbFNpZ24gUm9vdCBDQSAtIFIzMRMwEQYDVQQKEwpHbG9iYWxTaWdu
# MRMwEQYDVQQDEwpHbG9iYWxTaWduMB4XDTExMDgwMjEwMDAwMFoXDTE5MDgwMjEw
# MDAwMFowWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKPv0Z8p6djTgnY8YqDS
# SdYWHvHP8NC6SEMDLacd8gE0SaQQ6WIT9BP0FoO11VdCSIYrlViH6igEdMtyEQ9h
# JuH6HGEVxyibTQuCDyYrkDqW7aTQaymc9WGI5qRXb+70cNCNF97mZnZfdB5eDFM4
# XZD03zAtGxPReZhUGks4BPQHxCMD05LL94BdqpxWBkQtQUxItC3sNZKaxpXX9c6Q
# MeJ2s2G48XVXQqw7zivIkEnotybPuwyJy9DDo2qhydXjnFMrVyb+Vpp2/WFGomDs
# KUZH8s3ggmLGBFrn7U5AXEgGfZ1f53TJnoRlDVve3NMkHLQUEeurv8QfpLqZ0BdY
# Nc0CAwEAAaOB/TCB+jAOBgNVHQ8BAf8EBAMCAQYwEgYDVR0TAQH/BAgwBgEB/wIB
# ADAdBgNVHQ4EFgQUGUq4WuRNMaUU5V7sL6Mc+oCMMmswRwYDVR0gBEAwPjA8BgRV
# HSAAMDQwMgYIKwYBBQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3Jl
# cG9zaXRvcnkvMDYGA1UdHwQvMC0wK6ApoCeGJWh0dHA6Ly9jcmwuZ2xvYmFsc2ln
# bi5uZXQvcm9vdC1yMy5jcmwwEwYDVR0lBAwwCgYIKwYBBQUHAwMwHwYDVR0jBBgw
# FoAUj/BLf6guRSSuTVD6Y5qL3uLdG7wwDQYJKoZIhvcNAQELBQADggEBAHmwaTTi
# BYf2/tRgLC+GeTQD4LEHkwyEXPnk3GzPbrXsCly6C9BoMS4/ZL0Pgmtmd4F/ximl
# F9jwiU2DJBH2bv6d4UgKKKDieySApOzCmgDXsG1szYjVFXjPE/mIpXNNwTYr3MvO
# 23580ovvL72zT006rbtibiiTxAzL2ebK4BEClAOwvT+UKFaQHlPCJ9XJPM0aYx6C
# WRW2QMqngarDVa8z0bV16AnqRwhIIvtdG/Mseml+xddaXlYzPK1X6JMlQsPSXnE7
# ShxU7alVrCgFx8RsXdw8k/ZpPIJRzhoVPV4Bc/9Aouq0rtOO+u5dbEfHQfXUVlfy
# GDcy1tTMS/Zx4HYwggSfMIIDh6ADAgECAhIRIdaZp2SXPvH4Qn7pGcxTQRQwDQYJ
# KoZIhvcNAQEFBQAwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24g
# bnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzIw
# HhcNMTYwNTI0MDAwMDAwWhcNMjcwNjI0MDAwMDAwWjBgMQswCQYDVQQGEwJTRzEf
# MB0GA1UEChMWR01PIEdsb2JhbFNpZ24gUHRlIEx0ZDEwMC4GA1UEAxMnR2xvYmFs
# U2lnbiBUU0EgZm9yIE1TIEF1dGhlbnRpY29kZSAtIEcyMIIBIjANBgkqhkiG9w0B
# AQEFAAOCAQ8AMIIBCgKCAQEAsBeuotO2BDBWHlgPse1VpNZUy9j2czrsXV6rJf02
# pfqEw2FAxUa1WVI7QqIuXxNiEKlb5nPWkiWxfSPjBrOHOg5D8NcAiVOiETFSKG5d
# QHI88gl3p0mSl9RskKB2p/243LOd8gdgLE9YmABr0xVU4Prd/4AsXximmP/Uq+yh
# RVmyLm9iXeDZGayLV5yoJivZF6UQ0kcIGnAsM4t/aIAqtaFda92NAgIpA6p8N7u7
# KU49U5OzpvqP0liTFUy5LauAo6Ml+6/3CGSwekQPXBDXX2E3qk5r09JTJZ2Cc/os
# +XKwqRk5KlD6qdA8OsroW+/1X1H0+QrZlzXeaoXmIwRCrwIDAQABo4IBXzCCAVsw
# DgYDVR0PAQH/BAQDAgeAMEwGA1UdIARFMEMwQQYJKwYBBAGgMgEeMDQwMgYIKwYB
# BQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3JlcG9zaXRvcnkvMAkG
# A1UdEwQCMAAwFgYDVR0lAQH/BAwwCgYIKwYBBQUHAwgwQgYDVR0fBDswOTA3oDWg
# M4YxaHR0cDovL2NybC5nbG9iYWxzaWduLmNvbS9ncy9nc3RpbWVzdGFtcGluZ2cy
# LmNybDBUBggrBgEFBQcBAQRIMEYwRAYIKwYBBQUHMAKGOGh0dHA6Ly9zZWN1cmUu
# Z2xvYmFsc2lnbi5jb20vY2FjZXJ0L2dzdGltZXN0YW1waW5nZzIuY3J0MB0GA1Ud
# DgQWBBTUooRKOFoYf7pPMFC9ndV6h9YJ9zAfBgNVHSMEGDAWgBRG2D7/3OO+/4Pm
# 9IWbsN1q1hSpwTANBgkqhkiG9w0BAQUFAAOCAQEAj6kakW0EpjcgDoOW3iPTa24f
# bt1kPWghIrX4RzZpjuGlRcckoiK3KQnMVFquxrzNY46zPVBI5bTMrs2SjZ4oixNK
# Eaq9o+/Tsjb8tKFyv22XY3mMRLxwL37zvN2CU6sa9uv6HJe8tjecpBwwvKu8LUc2
# 35IgA+hxxlj2dQWaNPALWVqCRDSqgOQvhPZHXZbJtsrKnbemuuRQ09Q3uLogDtDT
# kipbxFm7oW3bPM5EncE4Kq3jjb3NCXcaEL5nCgI2ZIi5sxsm7ueeYMRGqLxhM2zP
# TrmcuWrwnzf+tT1PmtNN/94gjk6Xpv2fCbxNyhh2ybBNhVDygNIdBvVYBAexGDCC
# BNYwggO+oAMCAQICEhEhDRayW4wRltP+V8mGEea62TANBgkqhkiG9w0BAQsFADBa
# MQswCQYDVQQGEwJCRTEZMBcGA1UEChMQR2xvYmFsU2lnbiBudi1zYTEwMC4GA1UE
# AxMnR2xvYmFsU2lnbiBDb2RlU2lnbmluZyBDQSAtIFNIQTI1NiAtIEcyMB4XDTE1
# MDUwNDE2NDMyMVoXDTE4MDUwNDE2NDMyMVowVTELMAkGA1UEBhMCQ0gxDDAKBgNV
# BAgTA1p1ZzEMMAoGA1UEBxMDWnVnMRQwEgYDVQQKEwtkLWZlbnMgR21iSDEUMBIG
# A1UEAxMLZC1mZW5zIEdtYkgwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB
# AQDNPSzSNPylU9jFM78Q/GjzB7N+VNqikf/use7p8mpnBZ4cf5b4qV3rqQd62rJH
# RlAsxgouCSNQrl8xxfg6/t/I02kPvrzsR4xnDgMiVCqVRAeQsWebafWdTvWmONBS
# lxJejPP8TSgXMKFaDa+2HleTycTBYSoErAZSWpQ0NqF9zBadjsJRVatQuPkTDrwL
# eWibiyOipK9fcNoQpl5ll5H9EG668YJR3fqX9o0TQTkOmxXIL3IJ0UxdpyDpLEkt
# tBG6Y5wAdpF2dQX2phrfFNVY54JOGtuBkNGMSiLFzTkBA1fOlA6ICMYjB8xIFxVv
# rN1tYojCrqYkKMOjwWQz5X8zAgMBAAGjggGZMIIBlTAOBgNVHQ8BAf8EBAMCB4Aw
# TAYDVR0gBEUwQzBBBgkrBgEEAaAyATIwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93
# d3cuZ2xvYmFsc2lnbi5jb20vcmVwb3NpdG9yeS8wCQYDVR0TBAIwADATBgNVHSUE
# DDAKBggrBgEFBQcDAzBCBgNVHR8EOzA5MDegNaAzhjFodHRwOi8vY3JsLmdsb2Jh
# bHNpZ24uY29tL2dzL2dzY29kZXNpZ25zaGEyZzIuY3JsMIGQBggrBgEFBQcBAQSB
# gzCBgDBEBggrBgEFBQcwAoY4aHR0cDovL3NlY3VyZS5nbG9iYWxzaWduLmNvbS9j
# YWNlcnQvZ3Njb2Rlc2lnbnNoYTJnMi5jcnQwOAYIKwYBBQUHMAGGLGh0dHA6Ly9v
# Y3NwMi5nbG9iYWxzaWduLmNvbS9nc2NvZGVzaWduc2hhMmcyMB0GA1UdDgQWBBTN
# GDddiIYZy9p3Z84iSIMd27rtUDAfBgNVHSMEGDAWgBQZSrha5E0xpRTlXuwvoxz6
# gIwyazANBgkqhkiG9w0BAQsFAAOCAQEAAApsOzSX1alF00fTeijB/aIthO3UB0ks
# 1Gg3xoKQC1iEQmFG/qlFLiufs52kRPN7L0a7ClNH3iQpaH5IEaUENT9cNEXdKTBG
# 8OrJS8lrDJXImgNEgtSwz0B40h7bM2Z+0DvXDvpmfyM2NwHF/nNVj7NzmczrLRqN
# 9de3tV0pgRqnIYordVcmb24CZl3bzpwzbQQy14Iz+P5Z2cnw+QaYzAuweTZxEUcJ
# bFwpM49c1LMPFJTuOKkUgY90JJ3gVTpyQxfkc7DNBnx74PlRzjFmeGC/hxQt0hvo
# eaAiBdjo/1uuCTToigVnyRH+c0T2AezTeoFb7ne3I538hWeTdU5q9jGCBLcwggSz
# AgEBMHAwWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MgISESENFrJbjBGW0/5XyYYR5rrZMAkGBSsOAwIaBQCgeDAYBgorBgEEAYI3AgEM
# MQowCKACgAChAoAAMBkGCSqGSIb3DQEJAzEMBgorBgEEAYI3AgEEMBwGCisGAQQB
# gjcCAQsxDjAMBgorBgEEAYI3AgEVMCMGCSqGSIb3DQEJBDEWBBQn4onZoC9Ww7FI
# ru8qGXUTdZfCijANBgkqhkiG9w0BAQEFAASCAQB2QV/x9yWLBx2SJRD0khpItnfQ
# zLpab0YCLVO+LDx2Rw1QJTttYxpalWeMO/orfl6wmcDFIJ0CMNSg1jpX+0Ld/2k0
# MYxhqH88wEwsaVi1716mI0NrVA3ycCptnFymoaqEir2vfMvNCQCw/2e/73xjdz+t
# cwWD+f8ij8PM4SfBxDZtcJOCvjexYFNP0IgLcTJNE1724XRikj89bv02rPWfbmQG
# 31pl78+12CwEwxqk9eo3QqC8Q6nPuqXxBqySuWDiIeKsn/32PL5/QxUk1CkgxUxa
# U4LfoCHfx69maENzzncCwChTlz6jg6RLLqeanOvHpUvfgmayBOHGNaZKjqt1oYIC
# ojCCAp4GCSqGSIb3DQEJBjGCAo8wggKLAgEBMGgwUjELMAkGA1UEBhMCQkUxGTAX
# BgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGlt
# ZXN0YW1waW5nIENBIC0gRzICEhEh1pmnZJc+8fhCfukZzFNBFDAJBgUrDgMCGgUA
# oIH9MBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTE2
# MDgzMTE5MTY1OFowIwYJKoZIhvcNAQkEMRYEFFiOI1awWFCGAbhvsAGQdeNlY2s1
# MIGdBgsqhkiG9w0BCRACDDGBjTCBijCBhzCBhAQUY7gvq2H1g5CWlQULACScUCkz
# 7HkwbDBWpFQwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYt
# c2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzICEhEh
# 1pmnZJc+8fhCfukZzFNBFDANBgkqhkiG9w0BAQEFAASCAQAnx6vWtVyw6O6l/QvJ
# LJjwQqSyT6ySfo79iqi5pHFbGKQDlfXRfAhi+XkZK9B7P+fmGrMGXaB4Jw/EplaV
# 6ZhT6U6eQ+XeLFZyHWEaOVkiUyCvPwO1ojdOEeWIUXJkrhxFl2GSpcd701/3ykkj
# A8qxTktE2HyxWWWsO0POcld78hSjyhBPE/9VSkTSwIYg6ituxLPIbJUJzz5e6gsz
# 0vk0keOc4i4z553WI4lyCt1oOawVQm1n1bLPsGf6n8QOMbxqK1XlHnesmjeGsAUM
# FuUgexKSDs6z9bC6sNdF9D9QRynhQmY+pi+7rv9HJsOX9WbTbRgrizHumf2gFRfd
# 5ABy
# SIG # End signature block
|
PowerShellCorpus/PowerShellGallery/biz.dfch.PS.Appclusive.Client/5.2.1.20161201/Set-Connector.ps1
|
Set-Connector.ps1
|
function Set-Connector {
<#
.SYNOPSIS
Sets or creates an Connector entry in Appclusive.
.DESCRIPTION
Sets or creates an Connector entry in Appclusive.
Can create or update an Connector, needs Name, InterfaceId and EntityKindId.
.OUTPUTS
default | json | json-pretty | xml | xml-pretty | PSCredential | Clear
.EXAMPLE
.LINK
Online Version: http://dfch.biz/biz/dfch/PS/Appclusive/Client/Set-Connector/
.NOTES
See module manifest for dependencies and further requirements.
#>
[CmdletBinding(
SupportsShouldProcess = $false
,
ConfirmImpact = 'Low'
,
HelpURI = 'http://dfch.biz/biz/dfch/PS/Appclusive/Client/Set-Connector/'
)]
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseShouldProcessForStateChangingFunctions", "")]
Param
(
# Specifies the name to modify
[Parameter(Mandatory = $false)]
[long] $Id
,
# Specifies the new name name
[Parameter(Mandatory = $false)]
[string] $Name
,
# Specifies the description
[Parameter(Mandatory = $false)]
[long] $InterfaceId = 1
,
# Specifies the description
[Parameter(Mandatory = $false)]
[long] $EntityKindId = 1
,
# Specifies the description
[Parameter(Mandatory = $true, Position=5, ParameterSetName="Provide")]
[switch] $Provide
,
# Specifies the description
[Parameter(Mandatory = $true, Position=5, ParameterSetName="Require")]
[switch] $Require
,
# Specifies the description
[Parameter(Mandatory = $false)]
[long] $Multiplicity = 1
,
# Specifies the description
[Parameter(Mandatory = $false)]
[string] $Description
,
# Specifies to create a KNV if it does not exist
[Parameter(Mandatory = $false)]
[Alias("c")]
[switch] $CreateIfNotExist = $false
,
# Service reference to Appclusive
[Parameter(Mandatory = $false)]
[Alias('Services')]
[hashtable] $svc = (Get-Variable -Name $MyInvocation.MyCommand.Module.PrivateData.MODULEVAR -ValueOnly).Services
,
# Specifies the return format of the Cmdlet
[ValidateSet('default', 'json', 'json-pretty', 'xml', 'xml-pretty')]
[Parameter(Mandatory = $false)]
[alias('ReturnFormat')]
[string] $As = 'default'
)
Begin
{
trap { Log-Exception $_; break; }
$entitySetName = "Connectors";
$datBegin = [datetime]::Now;
[string] $fn = $MyInvocation.MyCommand.Name;
Log-Debug -fn $fn -msg ("CALL. svc '{0}'. Name '{1}'." -f ($svc -is [Object]), $Name) -fac 1;
# Parameter validation
Contract-Requires ($svc.Core -is [biz.dfch.CS.Appclusive.Api.Core.Core]) "Connect to the server before using the Cmdlet"
}
# Begin
Process
{
# Default test variable for checking function response codes.
[Boolean] $fReturn = $false;
# Return values are always and only returned via OutputParameter.
$OutputParameter = $null;
$AddedEntity = $null;
$Exp = @();
if($Id)
{
$Exp += ("(Id eq {0})" -f $Id);
$entity = $svc.Core.$entitySetName.AddQueryOption('$filter', $FilterExpression).AddQueryOption('$top', 1) | Select;
}
$r = @();
if(!$CreateIfNotExist -And !$entity)
{
$msg = "{0}: Parameter validation FAILED. Entity does not exist. Use '-CreateIfNotExist' to create resource." -f $entitySetName;
$null = New-CustomErrorRecord -m $msg -cat ObjectNotFound -o $Name;
throw($gotoError);
}
if(!$entity)
{
$entity = New-Object biz.dfch.CS.Appclusive.Api.Core.Connector;
$entity.Name = $Name;
$entity.InterfaceId = $InterfaceId;
$entity.EntityKindId = $EntityKindId;
$entity.Multiplicity = $Multiplicity;
if (!!$Provide) { $entity.ConnectionType = 1; }
if (!!$Require) { $entity.ConnectionType = 2; }
$svc.Core.AddToConnectors($entity);
$AddedEntity = $entity;
$entity.Created = [System.DateTimeOffset]::Now;
$entity.Modified = [System.DateTimeOffset]::Now;
$entity.CreatedById = 0;
$entity.ModifiedById = 0;
$entity.Tid = [guid]::Empty.ToString();
}
if($Name) { $entity.Name = $Name; }
if($InterfaceId) { $entity.InterfaceId = $InterfaceId; }
if($EntityKindId) { $entity.EntityKindId = $EntityKindId; }
if($Description) { $entity.Description = $Description; }
if($Multiplicity) { $entity.Multiplicity = $Multiplicity; }
if (!!$Provide) { $entity.ConnectionType = 1; }
if (!!$Require) { $entity.ConnectionType = 2; }
$svc.Core.UpdateObject($entity);
$r = $svc.Core.SaveChanges();
$r = $entity | Select @{ Name="JobUri"; Expression={$_.Name.Replace('http://','https://').Replace('JobResponses','Jobs')} }, @{ Name="JobId"; Expression={$_.Id} };
if ( !$Async )
{
$r = Get-Job -Id $r.JobId -svc $svc -ExpandConnector;
# DFTODO retry handling
}
$OutputParameter = Format-ResultAs $r $As;
$fReturn = $true;
}
# Process
End
{
$datEnd = [datetime]::Now;
Log-Debug -fn $fn -msg ("RET. fReturn: [{0}]. Execution time: [{1}]ms. Started: [{2}]." -f $fReturn, ($datEnd - $datBegin).TotalMilliseconds, $datBegin.ToString('yyyy-MM-dd HH:mm:ss.fffzzz')) -fac 2;
# Return values are always and only returned via OutputParameter.
return $OutputParameter;
}
# End
}
if($MyInvocation.ScriptName) { Export-ModuleMember -Function Set-Connector; }
#
# Copyright 2015-2016 d-fens GmbH
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SIG # Begin signature block
# MIIXDwYJKoZIhvcNAQcCoIIXADCCFvwCAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB
# gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR
# AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQULQ1wGcmv3v52zCSXdEcKk4eN
# cc6gghHCMIIEFDCCAvygAwIBAgILBAAAAAABL07hUtcwDQYJKoZIhvcNAQEFBQAw
# VzELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNV
# BAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkdsb2JhbFNpZ24gUm9vdCBDQTAeFw0xMTA0
# MTMxMDAwMDBaFw0yODAxMjgxMjAwMDBaMFIxCzAJBgNVBAYTAkJFMRkwFwYDVQQK
# ExBHbG9iYWxTaWduIG52LXNhMSgwJgYDVQQDEx9HbG9iYWxTaWduIFRpbWVzdGFt
# cGluZyBDQSAtIEcyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAlO9l
# +LVXn6BTDTQG6wkft0cYasvwW+T/J6U00feJGr+esc0SQW5m1IGghYtkWkYvmaCN
# d7HivFzdItdqZ9C76Mp03otPDbBS5ZBb60cO8eefnAuQZT4XljBFcm05oRc2yrmg
# jBtPCBn2gTGtYRakYua0QJ7D/PuV9vu1LpWBmODvxevYAll4d/eq41JrUJEpxfz3
# zZNl0mBhIvIG+zLdFlH6Dv2KMPAXCae78wSuq5DnbN96qfTvxGInX2+ZbTh0qhGL
# 2t/HFEzphbLswn1KJo/nVrqm4M+SU4B09APsaLJgvIQgAIMboe60dAXBKY5i0Eex
# +vBTzBj5Ljv5cH60JQIDAQABo4HlMIHiMA4GA1UdDwEB/wQEAwIBBjASBgNVHRMB
# Af8ECDAGAQH/AgEAMB0GA1UdDgQWBBRG2D7/3OO+/4Pm9IWbsN1q1hSpwTBHBgNV
# HSAEQDA+MDwGBFUdIAAwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93d3cuZ2xvYmFs
# c2lnbi5jb20vcmVwb3NpdG9yeS8wMwYDVR0fBCwwKjAooCagJIYiaHR0cDovL2Ny
# bC5nbG9iYWxzaWduLm5ldC9yb290LmNybDAfBgNVHSMEGDAWgBRge2YaRQ2XyolQ
# L30EzTSo//z9SzANBgkqhkiG9w0BAQUFAAOCAQEATl5WkB5GtNlJMfO7FzkoG8IW
# 3f1B3AkFBJtvsqKa1pkuQJkAVbXqP6UgdtOGNNQXzFU6x4Lu76i6vNgGnxVQ380W
# e1I6AtcZGv2v8Hhc4EvFGN86JB7arLipWAQCBzDbsBJe/jG+8ARI9PBw+DpeVoPP
# PfsNvPTF7ZedudTbpSeE4zibi6c1hkQgpDttpGoLoYP9KOva7yj2zIhd+wo7AKvg
# IeviLzVsD440RZfroveZMzV+y5qKu0VN5z+fwtmK+mWybsd+Zf/okuEsMaL3sCc2
# SI8mbzvuTXYfecPlf5Y1vC0OzAGwjn//UYCAp5LUs0RGZIyHTxZjBzFLY7Df8zCC
# BCkwggMRoAMCAQICCwQAAAAAATGJxjfoMA0GCSqGSIb3DQEBCwUAMEwxIDAeBgNV
# BAsTF0dsb2JhbFNpZ24gUm9vdCBDQSAtIFIzMRMwEQYDVQQKEwpHbG9iYWxTaWdu
# MRMwEQYDVQQDEwpHbG9iYWxTaWduMB4XDTExMDgwMjEwMDAwMFoXDTE5MDgwMjEw
# MDAwMFowWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKPv0Z8p6djTgnY8YqDS
# SdYWHvHP8NC6SEMDLacd8gE0SaQQ6WIT9BP0FoO11VdCSIYrlViH6igEdMtyEQ9h
# JuH6HGEVxyibTQuCDyYrkDqW7aTQaymc9WGI5qRXb+70cNCNF97mZnZfdB5eDFM4
# XZD03zAtGxPReZhUGks4BPQHxCMD05LL94BdqpxWBkQtQUxItC3sNZKaxpXX9c6Q
# MeJ2s2G48XVXQqw7zivIkEnotybPuwyJy9DDo2qhydXjnFMrVyb+Vpp2/WFGomDs
# KUZH8s3ggmLGBFrn7U5AXEgGfZ1f53TJnoRlDVve3NMkHLQUEeurv8QfpLqZ0BdY
# Nc0CAwEAAaOB/TCB+jAOBgNVHQ8BAf8EBAMCAQYwEgYDVR0TAQH/BAgwBgEB/wIB
# ADAdBgNVHQ4EFgQUGUq4WuRNMaUU5V7sL6Mc+oCMMmswRwYDVR0gBEAwPjA8BgRV
# HSAAMDQwMgYIKwYBBQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3Jl
# cG9zaXRvcnkvMDYGA1UdHwQvMC0wK6ApoCeGJWh0dHA6Ly9jcmwuZ2xvYmFsc2ln
# bi5uZXQvcm9vdC1yMy5jcmwwEwYDVR0lBAwwCgYIKwYBBQUHAwMwHwYDVR0jBBgw
# FoAUj/BLf6guRSSuTVD6Y5qL3uLdG7wwDQYJKoZIhvcNAQELBQADggEBAHmwaTTi
# BYf2/tRgLC+GeTQD4LEHkwyEXPnk3GzPbrXsCly6C9BoMS4/ZL0Pgmtmd4F/ximl
# F9jwiU2DJBH2bv6d4UgKKKDieySApOzCmgDXsG1szYjVFXjPE/mIpXNNwTYr3MvO
# 23580ovvL72zT006rbtibiiTxAzL2ebK4BEClAOwvT+UKFaQHlPCJ9XJPM0aYx6C
# WRW2QMqngarDVa8z0bV16AnqRwhIIvtdG/Mseml+xddaXlYzPK1X6JMlQsPSXnE7
# ShxU7alVrCgFx8RsXdw8k/ZpPIJRzhoVPV4Bc/9Aouq0rtOO+u5dbEfHQfXUVlfy
# GDcy1tTMS/Zx4HYwggSfMIIDh6ADAgECAhIRIdaZp2SXPvH4Qn7pGcxTQRQwDQYJ
# KoZIhvcNAQEFBQAwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24g
# bnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzIw
# HhcNMTYwNTI0MDAwMDAwWhcNMjcwNjI0MDAwMDAwWjBgMQswCQYDVQQGEwJTRzEf
# MB0GA1UEChMWR01PIEdsb2JhbFNpZ24gUHRlIEx0ZDEwMC4GA1UEAxMnR2xvYmFs
# U2lnbiBUU0EgZm9yIE1TIEF1dGhlbnRpY29kZSAtIEcyMIIBIjANBgkqhkiG9w0B
# AQEFAAOCAQ8AMIIBCgKCAQEAsBeuotO2BDBWHlgPse1VpNZUy9j2czrsXV6rJf02
# pfqEw2FAxUa1WVI7QqIuXxNiEKlb5nPWkiWxfSPjBrOHOg5D8NcAiVOiETFSKG5d
# QHI88gl3p0mSl9RskKB2p/243LOd8gdgLE9YmABr0xVU4Prd/4AsXximmP/Uq+yh
# RVmyLm9iXeDZGayLV5yoJivZF6UQ0kcIGnAsM4t/aIAqtaFda92NAgIpA6p8N7u7
# KU49U5OzpvqP0liTFUy5LauAo6Ml+6/3CGSwekQPXBDXX2E3qk5r09JTJZ2Cc/os
# +XKwqRk5KlD6qdA8OsroW+/1X1H0+QrZlzXeaoXmIwRCrwIDAQABo4IBXzCCAVsw
# DgYDVR0PAQH/BAQDAgeAMEwGA1UdIARFMEMwQQYJKwYBBAGgMgEeMDQwMgYIKwYB
# BQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3JlcG9zaXRvcnkvMAkG
# A1UdEwQCMAAwFgYDVR0lAQH/BAwwCgYIKwYBBQUHAwgwQgYDVR0fBDswOTA3oDWg
# M4YxaHR0cDovL2NybC5nbG9iYWxzaWduLmNvbS9ncy9nc3RpbWVzdGFtcGluZ2cy
# LmNybDBUBggrBgEFBQcBAQRIMEYwRAYIKwYBBQUHMAKGOGh0dHA6Ly9zZWN1cmUu
# Z2xvYmFsc2lnbi5jb20vY2FjZXJ0L2dzdGltZXN0YW1waW5nZzIuY3J0MB0GA1Ud
# DgQWBBTUooRKOFoYf7pPMFC9ndV6h9YJ9zAfBgNVHSMEGDAWgBRG2D7/3OO+/4Pm
# 9IWbsN1q1hSpwTANBgkqhkiG9w0BAQUFAAOCAQEAj6kakW0EpjcgDoOW3iPTa24f
# bt1kPWghIrX4RzZpjuGlRcckoiK3KQnMVFquxrzNY46zPVBI5bTMrs2SjZ4oixNK
# Eaq9o+/Tsjb8tKFyv22XY3mMRLxwL37zvN2CU6sa9uv6HJe8tjecpBwwvKu8LUc2
# 35IgA+hxxlj2dQWaNPALWVqCRDSqgOQvhPZHXZbJtsrKnbemuuRQ09Q3uLogDtDT
# kipbxFm7oW3bPM5EncE4Kq3jjb3NCXcaEL5nCgI2ZIi5sxsm7ueeYMRGqLxhM2zP
# TrmcuWrwnzf+tT1PmtNN/94gjk6Xpv2fCbxNyhh2ybBNhVDygNIdBvVYBAexGDCC
# BNYwggO+oAMCAQICEhEhDRayW4wRltP+V8mGEea62TANBgkqhkiG9w0BAQsFADBa
# MQswCQYDVQQGEwJCRTEZMBcGA1UEChMQR2xvYmFsU2lnbiBudi1zYTEwMC4GA1UE
# AxMnR2xvYmFsU2lnbiBDb2RlU2lnbmluZyBDQSAtIFNIQTI1NiAtIEcyMB4XDTE1
# MDUwNDE2NDMyMVoXDTE4MDUwNDE2NDMyMVowVTELMAkGA1UEBhMCQ0gxDDAKBgNV
# BAgTA1p1ZzEMMAoGA1UEBxMDWnVnMRQwEgYDVQQKEwtkLWZlbnMgR21iSDEUMBIG
# A1UEAxMLZC1mZW5zIEdtYkgwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB
# AQDNPSzSNPylU9jFM78Q/GjzB7N+VNqikf/use7p8mpnBZ4cf5b4qV3rqQd62rJH
# RlAsxgouCSNQrl8xxfg6/t/I02kPvrzsR4xnDgMiVCqVRAeQsWebafWdTvWmONBS
# lxJejPP8TSgXMKFaDa+2HleTycTBYSoErAZSWpQ0NqF9zBadjsJRVatQuPkTDrwL
# eWibiyOipK9fcNoQpl5ll5H9EG668YJR3fqX9o0TQTkOmxXIL3IJ0UxdpyDpLEkt
# tBG6Y5wAdpF2dQX2phrfFNVY54JOGtuBkNGMSiLFzTkBA1fOlA6ICMYjB8xIFxVv
# rN1tYojCrqYkKMOjwWQz5X8zAgMBAAGjggGZMIIBlTAOBgNVHQ8BAf8EBAMCB4Aw
# TAYDVR0gBEUwQzBBBgkrBgEEAaAyATIwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93
# d3cuZ2xvYmFsc2lnbi5jb20vcmVwb3NpdG9yeS8wCQYDVR0TBAIwADATBgNVHSUE
# DDAKBggrBgEFBQcDAzBCBgNVHR8EOzA5MDegNaAzhjFodHRwOi8vY3JsLmdsb2Jh
# bHNpZ24uY29tL2dzL2dzY29kZXNpZ25zaGEyZzIuY3JsMIGQBggrBgEFBQcBAQSB
# gzCBgDBEBggrBgEFBQcwAoY4aHR0cDovL3NlY3VyZS5nbG9iYWxzaWduLmNvbS9j
# YWNlcnQvZ3Njb2Rlc2lnbnNoYTJnMi5jcnQwOAYIKwYBBQUHMAGGLGh0dHA6Ly9v
# Y3NwMi5nbG9iYWxzaWduLmNvbS9nc2NvZGVzaWduc2hhMmcyMB0GA1UdDgQWBBTN
# GDddiIYZy9p3Z84iSIMd27rtUDAfBgNVHSMEGDAWgBQZSrha5E0xpRTlXuwvoxz6
# gIwyazANBgkqhkiG9w0BAQsFAAOCAQEAAApsOzSX1alF00fTeijB/aIthO3UB0ks
# 1Gg3xoKQC1iEQmFG/qlFLiufs52kRPN7L0a7ClNH3iQpaH5IEaUENT9cNEXdKTBG
# 8OrJS8lrDJXImgNEgtSwz0B40h7bM2Z+0DvXDvpmfyM2NwHF/nNVj7NzmczrLRqN
# 9de3tV0pgRqnIYordVcmb24CZl3bzpwzbQQy14Iz+P5Z2cnw+QaYzAuweTZxEUcJ
# bFwpM49c1LMPFJTuOKkUgY90JJ3gVTpyQxfkc7DNBnx74PlRzjFmeGC/hxQt0hvo
# eaAiBdjo/1uuCTToigVnyRH+c0T2AezTeoFb7ne3I538hWeTdU5q9jGCBLcwggSz
# AgEBMHAwWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MgISESENFrJbjBGW0/5XyYYR5rrZMAkGBSsOAwIaBQCgeDAYBgorBgEEAYI3AgEM
# MQowCKACgAChAoAAMBkGCSqGSIb3DQEJAzEMBgorBgEEAYI3AgEEMBwGCisGAQQB
# gjcCAQsxDjAMBgorBgEEAYI3AgEVMCMGCSqGSIb3DQEJBDEWBBQsdSeF9yVCurIW
# hnNpfyyCu2N0kjANBgkqhkiG9w0BAQEFAASCAQAgg9NPXSy1c/Z9a05UUWGAB8fc
# P0N6V9dTlrLg9u+MYugFrttHZeLgxX5HUjUo8vh2gSfQLuI5soZkgGsJeJ64Iq8n
# qF9gXuJDZZRwam+boft2q09fjoIxlr/vtZJkA4vREp+uDUT7ZDzMrTlKbe8KMVj/
# 18ff0C1bnI+F8GM8MPs0mushYhPNom8becmScU6gWRzYALUFx/Y/hQhlRYeEg91N
# 7Cefu9qCSTtfd6HXzXUdtJzYc1KhmMaq7AIq+Tba79YjdgpeUwx6BfBcESAs3YHP
# cbR7Prow8WOUnv0KYekm+9vd2EDGu3limsTwJ8s7i0WruNZc7hjMVOorhTtDoYIC
# ojCCAp4GCSqGSIb3DQEJBjGCAo8wggKLAgEBMGgwUjELMAkGA1UEBhMCQkUxGTAX
# BgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGlt
# ZXN0YW1waW5nIENBIC0gRzICEhEh1pmnZJc+8fhCfukZzFNBFDAJBgUrDgMCGgUA
# oIH9MBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTE2
# MDgzMTE5MTcwMlowIwYJKoZIhvcNAQkEMRYEFHWGt6bFTBZRQ096rwaKpVHnFZ6S
# MIGdBgsqhkiG9w0BCRACDDGBjTCBijCBhzCBhAQUY7gvq2H1g5CWlQULACScUCkz
# 7HkwbDBWpFQwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYt
# c2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzICEhEh
# 1pmnZJc+8fhCfukZzFNBFDANBgkqhkiG9w0BAQEFAASCAQAkeO+5BRgsPz2P8L6P
# Ba5WGBpVa//zDyMyDcGcNmujqoR6cA3NpMcTV4d+6Qqt+XKnrdZ6SK9rsdWPbZ62
# 70AtwkoTbWMiSZsamlZu32htBLHrOXq5gUwgzoK0qo0gnFv65GPdYd9Pa/nhEgeb
# 1cfS5g/0TLsxTdq675wEFkXGOsF4X8GJSjnVYk4yAqE4IEGOKX9AnGys2xgFouGo
# X6ilcQRgt2XkYva0BZDI9sQKfXfX7QfksTKfbe/6a79u+gxeJEuCLgpJsawJWKS2
# G+oWkNVqMMyVZjQEwcrQ634eEsT1UWyFWuBpMpADMdanpe2wvS3AOl0cxZL2bl0+
# Aqu8
# SIG # End signature block
|
PowerShellCorpus/PowerShellGallery/biz.dfch.PS.Appclusive.Client/5.2.1.20161201/Get-Folder.ps1
|
Get-Folder.ps1
|
function Get-Folder {
<#
.SYNOPSIS
Retrieves one or more entities from the Folder entity set.
.DESCRIPTION
Retrieves one or more entities from the Folder entity set.
You can retrieve one ore more entities from the entity set by specifying
Id, Name or other properties.
.INPUTS
The Cmdlet can either return all available entities or filter entities on
specified conditions.
See PARAMETERS section on possible inputs.
.OUTPUTS
default | json | json-pretty | xml | xml-pretty
In addition output can be filtered on specified properties.
.EXAMPLE
Get-Folder -ListAvailable -Select Id, Name
Id Name
-- ----
42 arbitrary folder
100 another folder
101 folder 2
666 folder 3
Retrieves the id and name of all Folders.
.EXAMPLE
Get-Folder -Id 34253 -svc $svc
EntityId :
Parameters : {}
EntityKindId : 28
ParentId : 1680
Id : 34253
Tid : abcd1234-abcd-1234-abcd-12345abcdefg
Name : Arbitrary Folder
Description :
CreatedById : 653
ModifiedById : 653
Created : 09.06.2016 14:28:56 +02:00
Modified : 09.06.2016 14:28:56 +02:00
RowVersion : {0, 0, 0, 0...}
EntityKind :
Parent :
Children : {}
IncomingAssocs : {}
OutgoingAssocs : {}
Tenant :
CreatedBy :
ModifiedBy :
Retrieves the Folder object with Id 34253 and returns all properties of it.
.EXAMPLE
Get-Folder -ParentId 42 -Select Name -ValueOnly -svc $svc
arbitrary folder
another folder
some folder
Returns the names (just the value) of the folders that have parentId with id 42.
.EXAMPLE
Get-Folder -ListAvailable -Select Id -First 3 -svc $svc
Id
--
42
100
101
Retrieves the id of the first 3 Folders.
.EXAMPLE
Get-Folder -ModifiedBy TestUser -Select Id, Name -svc $svc
Id Name
-- ----
42 arbitrary folder
100 another folder
101 folder 2
666 folder 3
Retrieves id and name of all Folders that have been modified by user
with name 'TestUser' (case insensitive substring match).
.LINK
Online Version: http://dfch.biz/biz/dfch/PS/Appclusive/Client/Get-Folder/
.NOTES
See module manifest for required software versions and dependencies.
#>
[CmdletBinding(
SupportsShouldProcess = $true
,
ConfirmImpact = 'Low'
,
HelpURI = 'http://dfch.biz/biz/dfch/PS/Appclusive/Client/Get-Folder/'
,
DefaultParameterSetName = 'list'
)]
PARAM
(
# Specifies the id of the entity
[Parameter(Mandatory = $false, Position = 0, ParameterSetName = 'id')]
[ValidateRange(1,[long]::MaxValue)]
[long] $Id
,
# Specifies the name of the entity
[Parameter(Mandatory = $true, ParameterSetName = 'name')]
[ValidateNotNullOrEmpty()]
[Alias('n')]
[string] $Name
,
# Filter by creator
[Parameter(Mandatory = $false, ParameterSetName = 'createdBy')]
[string] $CreatedBy
,
# Filter by modifier
[Parameter(Mandatory = $false, ParameterSetName = 'modifiedBy')]
[string] $ModifiedBy
,
# Specifies the Parent id for this entity
[Parameter(Mandatory = $false, ParameterSetName = 'parentId')]
[ValidateRange(1,[long]::MaxValue)]
[long] $ParentId
,
# Specify the attributes of the entity to return
[Parameter(Mandatory = $false)]
[string[]] $Select = @()
,
# Specifies to return only values without header information.
# This parameter takes precendes over the 'Select' parameter.
[ValidateScript( { if(1 -eq $Select.Count -And $_) { $true; } else { throw("You must specify exactly one 'Select' property when using 'ValueOnly'."); } } )]
[Alias('HideTableHeaders')]
[switch] $ValueOnly
,
# Limits the output to the specified number of entries
[Parameter(Mandatory = $false)]
[Alias('top')]
[int] $First
,
# Service reference to Appclusive
[Parameter(Mandatory = $false)]
[Alias('Services')]
[hashtable] $svc = (Get-Variable -Name $MyInvocation.MyCommand.Module.PrivateData.MODULEVAR -ValueOnly).Services
,
# Indicates to return all file information
[Parameter(Mandatory = $false, ParameterSetName = 'list')]
[switch] $ListAvailable = $false
,
# Specifies the return format of the Cmdlet
[ValidateSet('default', 'json', 'json-pretty', 'xml', 'xml-pretty')]
[Parameter(Mandatory = $false)]
[alias('ReturnFormat')]
[string] $As = 'default'
)
Begin
{
trap { Log-Exception $_; break; }
$datBegin = [datetime]::Now;
[string] $fn = $MyInvocation.MyCommand.Name;
Log-Debug -fn $fn -msg ("CALL. svc '{0}'. Name '{1}'." -f ($svc -is [Object]), $Name) -fac 1;
$EntitySetName = 'Folders';
# Parameter validation
Contract-Requires ($svc.Core -is [biz.dfch.CS.Appclusive.Api.Core.Core]) "Connect to the server before using the Cmdlet";
Contract-Requires (1 -ge ($PSBoundParameters.GetEnumerator() | Where { $_.Key -match 'Expand' -and $_.Value -eq $true}).Count) "You can specify only one 'Expand...' param.";
if($Select)
{
$Select = $Select | Select -Unique;
}
elseif ($ValueOnly)
{
$Select = 'Value';
}
}
# Begin
Process
{
trap { Log-Exception $_; break; }
# Default test variable for checking function response codes.
[Boolean] $fReturn = $false;
# Return values are always and only returned via OutputParameter.
$OutputParameter = $null;
Contract-Assert ($PSCmdlet.ShouldProcess(($PSBoundParameters | Out-String)))
if($PSCmdlet.ParameterSetName -eq 'list')
{
if($PSBoundParameters.ContainsKey('First'))
{
$Response = $svc.Core.$EntitySetName.AddQueryOption('$top', $First) | Select;
}
else
{
$Response = $svc.Core.$EntitySetName | Select;
}
if($Select)
{
$Response = $Response | Select -Property $Select;
}
}
else
{
$Exp = @();
if($PSCmdlet.ParameterSetName -eq 'id')
{
$Exp += ("Id eq {0}" -f $Id);
}
elseif($PSCmdlet.ParameterSetName -eq 'name')
{
$Exp += ("tolower(Name) eq '{0}'" -f $Name.ToLower());
}
elseif($PSCmdlet.ParameterSetName -eq 'parentId')
{
$Exp += ("ParentId eq {0}" -f $ParentId);
}
elseif($PSCmdlet.ParameterSetName -eq 'createdBy')
{
$createdById = Get-User -svc $svc $createdBy -Select Id -ValueOnly;
Contract-Assert ( !!$createdById ) 'User not found';
$Exp += ("CreatedById eq {0}" -f $createdById);
}
elseif($PSCmdlet.ParameterSetName -eq 'modifiedBy')
{
$modifiedById = Get-User -svc $svc $modifiedBy -Select Id -ValueOnly;
Contract-Assert ( !!$modifiedById ) 'User not found';
$Exp += ("(ModifiedById eq {0})" -f $modifiedById);
}
$FilterExpression = [String]::Join(' and ', $Exp);
$Response = $svc.Core.$EntitySetName.AddQueryOption('$filter', $FilterExpression) | Select;
if($Select)
{
$Response = $Response | Select -Property $Select;
}
if(1 -eq $Select.Count -And $ValueOnly)
{
$Response = $Response.$Select;
}
if($First)
{
$Response = $Response | Select -First 1;
}
}
$OutputParameter = Format-ResultAs $Response $As;
$fReturn = $true;
}
# Process
End
{
$datEnd = [datetime]::Now;
Log-Debug -fn $fn -msg ("RET. fReturn: [{0}]. Execution time: [{1}]ms. Started: [{2}]." -f $fReturn, ($datEnd - $datBegin).TotalMilliseconds, $datBegin.ToString('yyyy-MM-dd HH:mm:ss.fffzzz')) -fac 2;
# Return values are always and only returned via OutputParameter.
return $OutputParameter;
}
# End
} # function
if($MyInvocation.ScriptName) { Export-ModuleMember -Function Get-Folder; }
#
# Copyright 2016 d-fens GmbH
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
|
PowerShellCorpus/PowerShellGallery/biz.dfch.PS.Appclusive.Client/5.2.1.20161201/Set-Job.ps1
|
Set-Job.ps1
|
function Set-Job {
<#
.SYNOPSIS
Sets or creates a Job entry in Appclusive.
.DESCRIPTION
Sets or creates a Job entry in Appclusive.
By updating a Job entry you can specify if you want to update the Status.
.OUTPUTS
default
.EXAMPLE
Set-Job
Create a new Job entry if it does not exists.
.LINK
Online Version: http://dfch.biz/biz/dfch/PS/Appclusive/Client/New-Job/
Set-Job: http://dfch.biz/biz/dfch/PS/Appclusive/Client/Set-Job/
.NOTES
See module manifest for dependencies and further requirements.
#>
[CmdletBinding(
SupportsShouldProcess = $false
,
ConfirmImpact = 'Low'
,
HelpURI = 'http://dfch.biz/biz/dfch/PS/Appclusive/Client/Set-Job/'
)]
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseShouldProcessForStateChangingFunctions", "")]
Param
(
# Specifies the id
[Parameter(Mandatory = $true, Position = 0, ParameterSetName = 'id')]
[long] $Id
,
# Specifies the name
[Parameter(Mandatory = $true, Position = 0, ParameterSetName = 'name')]
[Alias('n')]
[string] $Name
,
# Specifies the status
[Parameter(Mandatory = $false)]
[string] $Status
,
# Specifies the new status
[Parameter(Mandatory = $false)]
[string] $NewStatus
,
# Specifies the Parent id for this entity
[Parameter(Mandatory = $false)]
[long] $ParentId
,
# Specifies the description
[Parameter(Mandatory = $false)]
[Alias("d")]
[string] $Description
,
# Specifies the EntityKind id for this entity
[Parameter(Mandatory = $false)]
[long] $EntityKindId
,
# Specifies the EntityKind name for this entity
[Parameter(Mandatory = $false)]
[string] $EntityKindName
,
# Specifies the parameters for this entity
[Parameter(Mandatory = $false)]
[hashtable] $Parameters = @{}
,
# Specifies to create a entity if it does not exist
[Parameter(Mandatory = $false)]
[Alias("c")]
[switch] $CreateIfNotExist = $false
,
# Service reference to Appclusive
[Parameter(Mandatory = $false)]
[Alias('Services')]
[hashtable] $svc = (Get-Variable -Name $MyInvocation.MyCommand.Module.PrivateData.MODULEVAR -ValueOnly).Services
,
# Specifies the return format of the Cmdlet
[ValidateSet('default', 'json', 'json-pretty', 'xml', 'xml-pretty')]
[Parameter(Mandatory = $false)]
[alias('ReturnFormat')]
[string] $As = 'default'
)
Begin
{
trap { Log-Exception $_; break; }
$datBegin = [datetime]::Now;
[string] $fn = $MyInvocation.MyCommand.Name;
Log-Debug -fn $fn -msg ("CALL. svc '{0}'. Name '{1}'." -f ($svc -is [Object]), $Name) -fac 1;
# Parameter validation
Contract-Requires ($svc.Core -is [biz.dfch.CS.Appclusive.Api.Core.Core]) "Connect to the server before using the Cmdlet"
$EntitySetName = 'Jobs';
}
# Begin
Process
{
# Default test variable for checking function response codes.
[Boolean] $fReturn = $false;
# Return values are always and only returned via OutputParameter.
$OutputParameter = $null;
$AddedEntity = $null;
try
{
if($PSCmdlet.ParameterSetName -eq 'id')
{
$FilterExpression = "(Id eq {0})" -f $Id;
$entity = $svc.Core.$EntitySetName.AddQueryOption('$filter', $FilterExpression).AddQueryOption('$top',1) | Select;
}
if(!$CreateIfNotExist -And !$entity)
{
$msg = "Name: Parameter validation FAILED. Entity does not exist. Use '-CreateIfNotExist' to create resource: '{0}'" -f $Name;
$e = New-CustomErrorRecord -m $msg -cat ObjectNotFound -o $Name;
throw($gotoError);
}
if(!$entity)
{
if($PSBoundParameters.ContainsKey('EntityKindId'))
{
$entityKind = Get-EntityKind -Id $EntityKindId -svc $svc;
$entityKey = "Id '{0}'" -f $EntityKindId;
}
else
{
Contract-Assert (!!$EntityKindName);
$entityKind = Get-EntityKind -Name $EntityKindName -svc $svc;
$entityKey = "Name '{0}'" -f $EntityKindName;
}
if(!$entityKind)
{
$msg = "Name: Parameter validation FAILED. EntityKind does not exist: {0} " -f $entityKey;
$e = New-CustomErrorRecord -m $msg -cat ObjectNotFound -o $entityKey;
throw($gotoError);
}
$entity = New-Object biz.dfch.CS.Appclusive.Api.Core.Job;
$svc.Core.AddToJobs($entity);
$AddedEntity = $entity;
$entity.ParentId = $ParentId;
$entity.Name = $Name;
$entity.Status = $Status;
$entity.Created = [System.DateTimeOffset]::Now;
$entity.Modified = $entity.Created;
$entity.CreatedById = 0;
$entity.ModifiedById = 0;
$entity.Tid = [guid]::Empty.ToString();
$entity.EntityKindId = $entityKind.Id;
}
if($PSBoundParameters.ContainsKey('Description'))
{
$entity.Description = $Description;
}
if($PSBoundParameters.ContainsKey('Parameters'))
{
$entity.Parameters = $Parameters | ConvertTo-Json -Compress;
}
if($NewName)
{
$entity.Name = $NewName;
}
if($NewStatus)
{
$entity.Status = $NewStatus;
}
$svc.Core.UpdateObject($entity);
$null = $svc.Core.SaveChanges();
$OutputParameter = Format-ResultAs $entity $As;
$fReturn = $true;
}
catch
{
if($gotoSuccess -eq $_.Exception.Message)
{
$fReturn = $true;
}
else
{
[string] $ErrorText = "catch [$($_.FullyQualifiedErrorId)]";
$ErrorText += (($_ | fl * -Force) | Out-String);
$ErrorText += (($_.Exception | fl * -Force) | Out-String);
$ErrorText += (Get-PSCallStack | Out-String);
if($_.Exception -is [System.Net.WebException])
{
Log-Critical $fn ("[WebException] Request FAILED with Status '{0}'. [{1}]." -f $_.Exception.Status, $_);
Log-Debug $fn $ErrorText -fac 3;
}
else
{
Log-Error $fn $ErrorText -fac 3;
if($gotoError -eq $_.Exception.Message)
{
Log-Error $fn $e.Exception.Message;
$PSCmdlet.ThrowTerminatingError($e);
}
elseif($gotoFailure -ne $_.Exception.Message)
{
Write-Verbose ("$fn`n$ErrorText");
}
else
{
# N/A
}
}
$fReturn = $false;
$OutputParameter = $null;
if($AddedEntity)
{
$svc.Core.DeleteObject($AddedEntity);
}
}
}
finally
{
# Clean up
# N/A
}
}
# Process
End
{
$datEnd = [datetime]::Now;
Log-Debug -fn $fn -msg ("RET. fReturn: [{0}]. Execution time: [{1}]ms. Started: [{2}]." -f $fReturn, ($datEnd - $datBegin).TotalMilliseconds, $datBegin.ToString('yyyy-MM-dd HH:mm:ss.fffzzz')) -fac 2;
# Return values are always and only returned via OutputParameter.
return $OutputParameter;
}
# End
}
if($MyInvocation.ScriptName) { Export-ModuleMember -Function Set-Job; }
#
# Copyright 2014-2015 d-fens GmbH
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SIG # Begin signature block
# MIIXDwYJKoZIhvcNAQcCoIIXADCCFvwCAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB
# gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR
# AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQU357WkoVvDXpzFzxy1Bx2Xvvv
# 45mgghHCMIIEFDCCAvygAwIBAgILBAAAAAABL07hUtcwDQYJKoZIhvcNAQEFBQAw
# VzELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNV
# BAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkdsb2JhbFNpZ24gUm9vdCBDQTAeFw0xMTA0
# MTMxMDAwMDBaFw0yODAxMjgxMjAwMDBaMFIxCzAJBgNVBAYTAkJFMRkwFwYDVQQK
# ExBHbG9iYWxTaWduIG52LXNhMSgwJgYDVQQDEx9HbG9iYWxTaWduIFRpbWVzdGFt
# cGluZyBDQSAtIEcyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAlO9l
# +LVXn6BTDTQG6wkft0cYasvwW+T/J6U00feJGr+esc0SQW5m1IGghYtkWkYvmaCN
# d7HivFzdItdqZ9C76Mp03otPDbBS5ZBb60cO8eefnAuQZT4XljBFcm05oRc2yrmg
# jBtPCBn2gTGtYRakYua0QJ7D/PuV9vu1LpWBmODvxevYAll4d/eq41JrUJEpxfz3
# zZNl0mBhIvIG+zLdFlH6Dv2KMPAXCae78wSuq5DnbN96qfTvxGInX2+ZbTh0qhGL
# 2t/HFEzphbLswn1KJo/nVrqm4M+SU4B09APsaLJgvIQgAIMboe60dAXBKY5i0Eex
# +vBTzBj5Ljv5cH60JQIDAQABo4HlMIHiMA4GA1UdDwEB/wQEAwIBBjASBgNVHRMB
# Af8ECDAGAQH/AgEAMB0GA1UdDgQWBBRG2D7/3OO+/4Pm9IWbsN1q1hSpwTBHBgNV
# HSAEQDA+MDwGBFUdIAAwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93d3cuZ2xvYmFs
# c2lnbi5jb20vcmVwb3NpdG9yeS8wMwYDVR0fBCwwKjAooCagJIYiaHR0cDovL2Ny
# bC5nbG9iYWxzaWduLm5ldC9yb290LmNybDAfBgNVHSMEGDAWgBRge2YaRQ2XyolQ
# L30EzTSo//z9SzANBgkqhkiG9w0BAQUFAAOCAQEATl5WkB5GtNlJMfO7FzkoG8IW
# 3f1B3AkFBJtvsqKa1pkuQJkAVbXqP6UgdtOGNNQXzFU6x4Lu76i6vNgGnxVQ380W
# e1I6AtcZGv2v8Hhc4EvFGN86JB7arLipWAQCBzDbsBJe/jG+8ARI9PBw+DpeVoPP
# PfsNvPTF7ZedudTbpSeE4zibi6c1hkQgpDttpGoLoYP9KOva7yj2zIhd+wo7AKvg
# IeviLzVsD440RZfroveZMzV+y5qKu0VN5z+fwtmK+mWybsd+Zf/okuEsMaL3sCc2
# SI8mbzvuTXYfecPlf5Y1vC0OzAGwjn//UYCAp5LUs0RGZIyHTxZjBzFLY7Df8zCC
# BCkwggMRoAMCAQICCwQAAAAAATGJxjfoMA0GCSqGSIb3DQEBCwUAMEwxIDAeBgNV
# BAsTF0dsb2JhbFNpZ24gUm9vdCBDQSAtIFIzMRMwEQYDVQQKEwpHbG9iYWxTaWdu
# MRMwEQYDVQQDEwpHbG9iYWxTaWduMB4XDTExMDgwMjEwMDAwMFoXDTE5MDgwMjEw
# MDAwMFowWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKPv0Z8p6djTgnY8YqDS
# SdYWHvHP8NC6SEMDLacd8gE0SaQQ6WIT9BP0FoO11VdCSIYrlViH6igEdMtyEQ9h
# JuH6HGEVxyibTQuCDyYrkDqW7aTQaymc9WGI5qRXb+70cNCNF97mZnZfdB5eDFM4
# XZD03zAtGxPReZhUGks4BPQHxCMD05LL94BdqpxWBkQtQUxItC3sNZKaxpXX9c6Q
# MeJ2s2G48XVXQqw7zivIkEnotybPuwyJy9DDo2qhydXjnFMrVyb+Vpp2/WFGomDs
# KUZH8s3ggmLGBFrn7U5AXEgGfZ1f53TJnoRlDVve3NMkHLQUEeurv8QfpLqZ0BdY
# Nc0CAwEAAaOB/TCB+jAOBgNVHQ8BAf8EBAMCAQYwEgYDVR0TAQH/BAgwBgEB/wIB
# ADAdBgNVHQ4EFgQUGUq4WuRNMaUU5V7sL6Mc+oCMMmswRwYDVR0gBEAwPjA8BgRV
# HSAAMDQwMgYIKwYBBQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3Jl
# cG9zaXRvcnkvMDYGA1UdHwQvMC0wK6ApoCeGJWh0dHA6Ly9jcmwuZ2xvYmFsc2ln
# bi5uZXQvcm9vdC1yMy5jcmwwEwYDVR0lBAwwCgYIKwYBBQUHAwMwHwYDVR0jBBgw
# FoAUj/BLf6guRSSuTVD6Y5qL3uLdG7wwDQYJKoZIhvcNAQELBQADggEBAHmwaTTi
# BYf2/tRgLC+GeTQD4LEHkwyEXPnk3GzPbrXsCly6C9BoMS4/ZL0Pgmtmd4F/ximl
# F9jwiU2DJBH2bv6d4UgKKKDieySApOzCmgDXsG1szYjVFXjPE/mIpXNNwTYr3MvO
# 23580ovvL72zT006rbtibiiTxAzL2ebK4BEClAOwvT+UKFaQHlPCJ9XJPM0aYx6C
# WRW2QMqngarDVa8z0bV16AnqRwhIIvtdG/Mseml+xddaXlYzPK1X6JMlQsPSXnE7
# ShxU7alVrCgFx8RsXdw8k/ZpPIJRzhoVPV4Bc/9Aouq0rtOO+u5dbEfHQfXUVlfy
# GDcy1tTMS/Zx4HYwggSfMIIDh6ADAgECAhIRIdaZp2SXPvH4Qn7pGcxTQRQwDQYJ
# KoZIhvcNAQEFBQAwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24g
# bnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzIw
# HhcNMTYwNTI0MDAwMDAwWhcNMjcwNjI0MDAwMDAwWjBgMQswCQYDVQQGEwJTRzEf
# MB0GA1UEChMWR01PIEdsb2JhbFNpZ24gUHRlIEx0ZDEwMC4GA1UEAxMnR2xvYmFs
# U2lnbiBUU0EgZm9yIE1TIEF1dGhlbnRpY29kZSAtIEcyMIIBIjANBgkqhkiG9w0B
# AQEFAAOCAQ8AMIIBCgKCAQEAsBeuotO2BDBWHlgPse1VpNZUy9j2czrsXV6rJf02
# pfqEw2FAxUa1WVI7QqIuXxNiEKlb5nPWkiWxfSPjBrOHOg5D8NcAiVOiETFSKG5d
# QHI88gl3p0mSl9RskKB2p/243LOd8gdgLE9YmABr0xVU4Prd/4AsXximmP/Uq+yh
# RVmyLm9iXeDZGayLV5yoJivZF6UQ0kcIGnAsM4t/aIAqtaFda92NAgIpA6p8N7u7
# KU49U5OzpvqP0liTFUy5LauAo6Ml+6/3CGSwekQPXBDXX2E3qk5r09JTJZ2Cc/os
# +XKwqRk5KlD6qdA8OsroW+/1X1H0+QrZlzXeaoXmIwRCrwIDAQABo4IBXzCCAVsw
# DgYDVR0PAQH/BAQDAgeAMEwGA1UdIARFMEMwQQYJKwYBBAGgMgEeMDQwMgYIKwYB
# BQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3JlcG9zaXRvcnkvMAkG
# A1UdEwQCMAAwFgYDVR0lAQH/BAwwCgYIKwYBBQUHAwgwQgYDVR0fBDswOTA3oDWg
# M4YxaHR0cDovL2NybC5nbG9iYWxzaWduLmNvbS9ncy9nc3RpbWVzdGFtcGluZ2cy
# LmNybDBUBggrBgEFBQcBAQRIMEYwRAYIKwYBBQUHMAKGOGh0dHA6Ly9zZWN1cmUu
# Z2xvYmFsc2lnbi5jb20vY2FjZXJ0L2dzdGltZXN0YW1waW5nZzIuY3J0MB0GA1Ud
# DgQWBBTUooRKOFoYf7pPMFC9ndV6h9YJ9zAfBgNVHSMEGDAWgBRG2D7/3OO+/4Pm
# 9IWbsN1q1hSpwTANBgkqhkiG9w0BAQUFAAOCAQEAj6kakW0EpjcgDoOW3iPTa24f
# bt1kPWghIrX4RzZpjuGlRcckoiK3KQnMVFquxrzNY46zPVBI5bTMrs2SjZ4oixNK
# Eaq9o+/Tsjb8tKFyv22XY3mMRLxwL37zvN2CU6sa9uv6HJe8tjecpBwwvKu8LUc2
# 35IgA+hxxlj2dQWaNPALWVqCRDSqgOQvhPZHXZbJtsrKnbemuuRQ09Q3uLogDtDT
# kipbxFm7oW3bPM5EncE4Kq3jjb3NCXcaEL5nCgI2ZIi5sxsm7ueeYMRGqLxhM2zP
# TrmcuWrwnzf+tT1PmtNN/94gjk6Xpv2fCbxNyhh2ybBNhVDygNIdBvVYBAexGDCC
# BNYwggO+oAMCAQICEhEhDRayW4wRltP+V8mGEea62TANBgkqhkiG9w0BAQsFADBa
# MQswCQYDVQQGEwJCRTEZMBcGA1UEChMQR2xvYmFsU2lnbiBudi1zYTEwMC4GA1UE
# AxMnR2xvYmFsU2lnbiBDb2RlU2lnbmluZyBDQSAtIFNIQTI1NiAtIEcyMB4XDTE1
# MDUwNDE2NDMyMVoXDTE4MDUwNDE2NDMyMVowVTELMAkGA1UEBhMCQ0gxDDAKBgNV
# BAgTA1p1ZzEMMAoGA1UEBxMDWnVnMRQwEgYDVQQKEwtkLWZlbnMgR21iSDEUMBIG
# A1UEAxMLZC1mZW5zIEdtYkgwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB
# AQDNPSzSNPylU9jFM78Q/GjzB7N+VNqikf/use7p8mpnBZ4cf5b4qV3rqQd62rJH
# RlAsxgouCSNQrl8xxfg6/t/I02kPvrzsR4xnDgMiVCqVRAeQsWebafWdTvWmONBS
# lxJejPP8TSgXMKFaDa+2HleTycTBYSoErAZSWpQ0NqF9zBadjsJRVatQuPkTDrwL
# eWibiyOipK9fcNoQpl5ll5H9EG668YJR3fqX9o0TQTkOmxXIL3IJ0UxdpyDpLEkt
# tBG6Y5wAdpF2dQX2phrfFNVY54JOGtuBkNGMSiLFzTkBA1fOlA6ICMYjB8xIFxVv
# rN1tYojCrqYkKMOjwWQz5X8zAgMBAAGjggGZMIIBlTAOBgNVHQ8BAf8EBAMCB4Aw
# TAYDVR0gBEUwQzBBBgkrBgEEAaAyATIwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93
# d3cuZ2xvYmFsc2lnbi5jb20vcmVwb3NpdG9yeS8wCQYDVR0TBAIwADATBgNVHSUE
# DDAKBggrBgEFBQcDAzBCBgNVHR8EOzA5MDegNaAzhjFodHRwOi8vY3JsLmdsb2Jh
# bHNpZ24uY29tL2dzL2dzY29kZXNpZ25zaGEyZzIuY3JsMIGQBggrBgEFBQcBAQSB
# gzCBgDBEBggrBgEFBQcwAoY4aHR0cDovL3NlY3VyZS5nbG9iYWxzaWduLmNvbS9j
# YWNlcnQvZ3Njb2Rlc2lnbnNoYTJnMi5jcnQwOAYIKwYBBQUHMAGGLGh0dHA6Ly9v
# Y3NwMi5nbG9iYWxzaWduLmNvbS9nc2NvZGVzaWduc2hhMmcyMB0GA1UdDgQWBBTN
# GDddiIYZy9p3Z84iSIMd27rtUDAfBgNVHSMEGDAWgBQZSrha5E0xpRTlXuwvoxz6
# gIwyazANBgkqhkiG9w0BAQsFAAOCAQEAAApsOzSX1alF00fTeijB/aIthO3UB0ks
# 1Gg3xoKQC1iEQmFG/qlFLiufs52kRPN7L0a7ClNH3iQpaH5IEaUENT9cNEXdKTBG
# 8OrJS8lrDJXImgNEgtSwz0B40h7bM2Z+0DvXDvpmfyM2NwHF/nNVj7NzmczrLRqN
# 9de3tV0pgRqnIYordVcmb24CZl3bzpwzbQQy14Iz+P5Z2cnw+QaYzAuweTZxEUcJ
# bFwpM49c1LMPFJTuOKkUgY90JJ3gVTpyQxfkc7DNBnx74PlRzjFmeGC/hxQt0hvo
# eaAiBdjo/1uuCTToigVnyRH+c0T2AezTeoFb7ne3I538hWeTdU5q9jGCBLcwggSz
# AgEBMHAwWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MgISESENFrJbjBGW0/5XyYYR5rrZMAkGBSsOAwIaBQCgeDAYBgorBgEEAYI3AgEM
# MQowCKACgAChAoAAMBkGCSqGSIb3DQEJAzEMBgorBgEEAYI3AgEEMBwGCisGAQQB
# gjcCAQsxDjAMBgorBgEEAYI3AgEVMCMGCSqGSIb3DQEJBDEWBBRpBGmX0dyjfK7a
# xuQBCH4qyEhx8TANBgkqhkiG9w0BAQEFAASCAQCW2dRD/5YO4S3EuOvQT+6Nf0sX
# 8Z9daggGN8gsqiqNtOfNED8rGxGw5jPz7Ky4RN7pkV5+Yk9yX5QH5+gx4KT2GLWl
# RXz1I7+DkK3vyQQo82j8dc+XZJ445RRQe01A7Xx/2fMHj11BzJrtQDrVTWqPzLMz
# 4o/xNLceEiDTS6eno+zNdmhD23/BIWhSlFh6/N/PH5pah6peOEI4gbTpmu+PDM6u
# QIOC8GbVPMk9T2yTEWpK0B9N9rDNEVN5BOBcUZM5yRcUbQYAOsgLNYPiLteHL8FR
# ij9SMDSxyS+1Hfo4zAXg80HyxukmgjHwrp0Bp/LiEMc1a8MhH1vqmR3wg2iooYIC
# ojCCAp4GCSqGSIb3DQEJBjGCAo8wggKLAgEBMGgwUjELMAkGA1UEBhMCQkUxGTAX
# BgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGlt
# ZXN0YW1waW5nIENBIC0gRzICEhEh1pmnZJc+8fhCfukZzFNBFDAJBgUrDgMCGgUA
# oIH9MBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTE2
# MDgzMTE5MTcwNVowIwYJKoZIhvcNAQkEMRYEFCpP6j+tuVFwoMdCboDz9vMqZDHd
# MIGdBgsqhkiG9w0BCRACDDGBjTCBijCBhzCBhAQUY7gvq2H1g5CWlQULACScUCkz
# 7HkwbDBWpFQwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYt
# c2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzICEhEh
# 1pmnZJc+8fhCfukZzFNBFDANBgkqhkiG9w0BAQEFAASCAQBP/vKO4WxcOsDqxTx7
# qMsnrY82trxkcMpGhVHn2T52fjc8o+9v7a9mvvo/hWZNDHbnydK4w7NmyzMPP0Ws
# ChqB3TH8+s6Lcv6MR5H0rXrnOHzfOhmIARM9L8nUs90+x+QFbP0sARvvASL9ivTa
# 4QWZ5zbz83rNhQa8M60FHSl8cT5mL/PMx8mJnqi1Kkk6vjgp2ZDIWFjeXlHI6yP0
# WL0GrftOf7s0UYlJKtySQaW+xD4VsZv9pPvKbP9VVjy7JnTY1QMKsCX5B7F4hAX2
# 8cWvqUqx5kyN96oqBoEU3pSYvqrWhiS07yimfYvviFWyYq5upnbbqwHECC4RHG3e
# u9VK
# SIG # End signature block
|
PowerShellCorpus/PowerShellGallery/biz.dfch.PS.Appclusive.Client/5.2.1.20161201/Set-Node.ps1
|
Set-Node.ps1
|
function Set-Node {
<#
.SYNOPSIS
Sets or creates a Node entry in Appclusive.
.DESCRIPTION
Sets or creates a Node entry in Appclusive.
By updating a Node entry you can specify if you want to update the Name.
.OUTPUTS
default
.EXAMPLE
Set-Node Srv01 -EntityKindName com.swisscom.cms.rhel7 -CreateIfNotExist
Parameters : {}
EntityKindId : 29
ParentId : 1
Id : 1442
Tid : 22222222-2222-2222-2222-222222222222
Name : Srv01
Description :
CreatedById : 60
ModifiedById : 60
Created : 05.01.2016 15:35:06 +01:00
Modified : 05.01.2016 15:35:06 +01:00
RowVersion : {0, 0, 0, 0...}
Parent :
EntityKind :
Children : {}
IncomingAssocs : {}
OutgoingAssocs : {}
Tenant :
CreatedBy :
ModifiedBy :
Create a new Node entry if it does not exists.
.EXAMPLE
Set-Node -Name Srv01 -NewName Srv02
Parameters : {}
EntityKindId : 29
ParentId : 1
Id : 1442
Tid : 22222222-2222-2222-2222-222222222222
Name : Srv02
Description :
CreatedById : 60
ModifiedById : 60
Created : 05.01.2016 15:35:06 +01:00
Modified : 05.01.2016 15:35:06 +01:00
RowVersion : {0, 0, 0, 0...}
Parent :
EntityKind :
Children : {}
IncomingAssocs : {}
OutgoingAssocs : {}
Tenant :
CreatedBy :
ModifiedBy :
Update an existing Node with new name.
.LINK
Online Version: http://dfch.biz/biz/dfch/PS/Appclusive/Client/New-Node/
Set-Node: http://dfch.biz/biz/dfch/PS/Appclusive/Client/Set-Node/
.NOTES
See module manifest for dependencies and further requirements.
#>
[CmdletBinding(
SupportsShouldProcess = $false
,
ConfirmImpact = 'Low'
,
HelpURI = 'http://dfch.biz/biz/dfch/PS/Appclusive/Client/Set-Node/'
)]
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseShouldProcessForStateChangingFunctions", "")]
Param
(
# Specifies the name to modify
[Parameter(Mandatory = $true, Position = 0)]
[Alias('n')]
[string] $Name
,
# Specifies the new name
[Parameter(Mandatory = $false)]
[string] $NewName
,
# Specifies the Parent id for this entity
[Parameter(Mandatory = $false)]
[long] $ParentId = 1
,
# Specifies the description
[Parameter(Mandatory = $false)]
[Alias("d")]
[string] $Description
,
# Specifies the EntityKind id for this entity
[Parameter(Mandatory = $true, ParameterSetName = 'id')]
[long] $EntityKindId
,
# Specifies the EntityKind name for this entity
[Parameter(Mandatory = $true, ParameterSetName = 'name')]
[string] $EntityKindName
,
# Specifies the parameters for this entity
[Parameter(Mandatory = $false)]
[hashtable] $Parameters = @{}
,
# Specifies to create a entity if it does not exist
[Parameter(Mandatory = $false)]
[Alias("c")]
[switch] $CreateIfNotExist = $false
,
# Service reference to Appclusive
[Parameter(Mandatory = $false)]
[Alias('Services')]
[hashtable] $svc = (Get-Variable -Name $MyInvocation.MyCommand.Module.PrivateData.MODULEVAR -ValueOnly).Services
,
# Specifies the return format of the Cmdlet
[ValidateSet('default', 'json', 'json-pretty', 'xml', 'xml-pretty')]
[Parameter(Mandatory = $false)]
[alias('ReturnFormat')]
[string] $As = 'default'
,
# Specifies the return method
[Parameter(Mandatory = $false)]
[switch] $Async = $false
)
Begin
{
trap { Log-Exception $_; break; }
$datBegin = [datetime]::Now;
[string] $fn = $MyInvocation.MyCommand.Name;
Log-Debug -fn $fn -msg ("CALL. svc '{0}'. Name '{1}'." -f ($svc -is [Object]), $Name) -fac 1;
# Parameter validation
Contract-Requires ($svc.Core -is [biz.dfch.CS.Appclusive.Api.Core.Core]) "Connect to the server before using the Cmdlet"
$EntitySetName = 'Nodes';
}
# Begin
Process
{
# Default test variable for checking function response codes.
[Boolean] $fReturn = $false;
# Return values are always and only returned via OutputParameter.
$OutputParameter = $null;
$AddedEntity = $null;
try
{
$FilterExpression = "(tolower(Name) eq '{0}')" -f $Name.toLower();
$entity = $svc.Core.$EntitySetName.AddQueryOption('$filter', $FilterExpression).AddQueryOption('$top',1) | Select;
if(!$CreateIfNotExist -And !$entity)
{
$msg = "Name: Parameter validation FAILED. Entity does not exist. Use '-CreateIfNotExist' to create resource: '{0}'" -f $Name;
$e = New-CustomErrorRecord -m $msg -cat ObjectNotFound -o $Name;
throw($gotoError);
}
if(!$entity)
{
if($PSCmdlet.ParameterSetName -eq 'id')
{
$entityKind = Get-EntityKind -Id $EntityKindId -svc $svc;
$entityKey = "Id '{0}'" -f $EntityKindId;
}
else
{
$entityKind = Get-EntityKind -Name $EntityKindName -svc $svc;
$entityKey = "Name '{0}'" -f $EntityKindName;
}
if(!$entityKind)
{
$msg = "Name: Parameter validation FAILED. EntityKind does not exist: {0} " -f $entityKey;
$e = New-CustomErrorRecord -m $msg -cat ObjectNotFound -o $entityKey;
throw($gotoError);
}
$entity = New-Object biz.dfch.CS.Appclusive.Api.Core.Node;
$svc.Core.AddToNodes($entity);
$AddedEntity = $entity;
$entity.Name = $Name;
$entity.Created = [System.DateTimeOffset]::Now;
$entity.Modified = $entity.Created;
$entity.CreatedById = 0;
$entity.ModifiedById = 0;
$entity.Tid = [guid]::Empty.ToString();
$entity.Parameters = $Parameters | ConvertTo-Json -Compress;
$entity.EntityKindId = $entityKind.Id;
$entity.ParentId = $ParentId;
}
if($PSBoundParameters.ContainsKey('Description'))
{
$entity.Description = $Description;
}
if($PSBoundParameters.ContainsKey('Parameters'))
{
$entity.Parameters = $Parameters | ConvertTo-Json -Compress;
}
if($NewName)
{
$entity.Name = $NewName;
}
$svc.Core.UpdateObject($entity);
$r = $svc.Core.SaveChanges();
$r = $entity | Select @{ Name="JobUri"; Expression={$_.Name.Replace('http://','https://').Replace('JobResponses','Jobs')} }, @{ Name="JobId"; Expression={$_.Id} };
if ( !$Async )
{
$r = Get-Job -Id $r.JobId -svc $svc -ExpandNode;
# DFTODO retry handling
}
$OutputParameter = Format-ResultAs $r $As;
$fReturn = $true;
}
catch
{
if($gotoSuccess -eq $_.Exception.Message)
{
$fReturn = $true;
}
else
{
[string] $ErrorText = "catch [$($_.FullyQualifiedErrorId)]";
$ErrorText += (($_ | fl * -Force) | Out-String);
$ErrorText += (($_.Exception | fl * -Force) | Out-String);
$ErrorText += (Get-PSCallStack | Out-String);
if($_.Exception -is [System.Net.WebException])
{
Log-Critical $fn ("[WebException] Request FAILED with Status '{0}'. [{1}]." -f $_.Exception.Status, $_);
Log-Debug $fn $ErrorText -fac 3;
}
else
{
Log-Error $fn $ErrorText -fac 3;
if($gotoError -eq $_.Exception.Message)
{
Log-Error $fn $e.Exception.Message;
$PSCmdlet.ThrowTerminatingError($e);
}
elseif($gotoFailure -ne $_.Exception.Message)
{
Write-Verbose ("$fn`n$ErrorText");
}
else
{
# N/A
}
}
$fReturn = $false;
$OutputParameter = $null;
if($AddedEntity)
{
$svc.Core.DeleteObject($AddedEntity);
}
}
}
finally
{
# Clean up
# N/A
}
}
# Process
End
{
$datEnd = [datetime]::Now;
Log-Debug -fn $fn -msg ("RET. fReturn: [{0}]. Execution time: [{1}]ms. Started: [{2}]." -f $fReturn, ($datEnd - $datBegin).TotalMilliseconds, $datBegin.ToString('yyyy-MM-dd HH:mm:ss.fffzzz')) -fac 2;
# Return values are always and only returned via OutputParameter.
return $OutputParameter;
}
# End
}
if($MyInvocation.ScriptName) { Export-ModuleMember -Function Set-Node; }
#
# Copyright 2014-2015 d-fens GmbH
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SIG # Begin signature block
# MIIXDwYJKoZIhvcNAQcCoIIXADCCFvwCAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB
# gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR
# AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQU4JQyr7qSoL9NZS20Va8BJurW
# OwCgghHCMIIEFDCCAvygAwIBAgILBAAAAAABL07hUtcwDQYJKoZIhvcNAQEFBQAw
# VzELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNV
# BAsTB1Jvb3QgQ0ExGzAZBgNVBAMTEkdsb2JhbFNpZ24gUm9vdCBDQTAeFw0xMTA0
# MTMxMDAwMDBaFw0yODAxMjgxMjAwMDBaMFIxCzAJBgNVBAYTAkJFMRkwFwYDVQQK
# ExBHbG9iYWxTaWduIG52LXNhMSgwJgYDVQQDEx9HbG9iYWxTaWduIFRpbWVzdGFt
# cGluZyBDQSAtIEcyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAlO9l
# +LVXn6BTDTQG6wkft0cYasvwW+T/J6U00feJGr+esc0SQW5m1IGghYtkWkYvmaCN
# d7HivFzdItdqZ9C76Mp03otPDbBS5ZBb60cO8eefnAuQZT4XljBFcm05oRc2yrmg
# jBtPCBn2gTGtYRakYua0QJ7D/PuV9vu1LpWBmODvxevYAll4d/eq41JrUJEpxfz3
# zZNl0mBhIvIG+zLdFlH6Dv2KMPAXCae78wSuq5DnbN96qfTvxGInX2+ZbTh0qhGL
# 2t/HFEzphbLswn1KJo/nVrqm4M+SU4B09APsaLJgvIQgAIMboe60dAXBKY5i0Eex
# +vBTzBj5Ljv5cH60JQIDAQABo4HlMIHiMA4GA1UdDwEB/wQEAwIBBjASBgNVHRMB
# Af8ECDAGAQH/AgEAMB0GA1UdDgQWBBRG2D7/3OO+/4Pm9IWbsN1q1hSpwTBHBgNV
# HSAEQDA+MDwGBFUdIAAwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93d3cuZ2xvYmFs
# c2lnbi5jb20vcmVwb3NpdG9yeS8wMwYDVR0fBCwwKjAooCagJIYiaHR0cDovL2Ny
# bC5nbG9iYWxzaWduLm5ldC9yb290LmNybDAfBgNVHSMEGDAWgBRge2YaRQ2XyolQ
# L30EzTSo//z9SzANBgkqhkiG9w0BAQUFAAOCAQEATl5WkB5GtNlJMfO7FzkoG8IW
# 3f1B3AkFBJtvsqKa1pkuQJkAVbXqP6UgdtOGNNQXzFU6x4Lu76i6vNgGnxVQ380W
# e1I6AtcZGv2v8Hhc4EvFGN86JB7arLipWAQCBzDbsBJe/jG+8ARI9PBw+DpeVoPP
# PfsNvPTF7ZedudTbpSeE4zibi6c1hkQgpDttpGoLoYP9KOva7yj2zIhd+wo7AKvg
# IeviLzVsD440RZfroveZMzV+y5qKu0VN5z+fwtmK+mWybsd+Zf/okuEsMaL3sCc2
# SI8mbzvuTXYfecPlf5Y1vC0OzAGwjn//UYCAp5LUs0RGZIyHTxZjBzFLY7Df8zCC
# BCkwggMRoAMCAQICCwQAAAAAATGJxjfoMA0GCSqGSIb3DQEBCwUAMEwxIDAeBgNV
# BAsTF0dsb2JhbFNpZ24gUm9vdCBDQSAtIFIzMRMwEQYDVQQKEwpHbG9iYWxTaWdu
# MRMwEQYDVQQDEwpHbG9iYWxTaWduMB4XDTExMDgwMjEwMDAwMFoXDTE5MDgwMjEw
# MDAwMFowWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKPv0Z8p6djTgnY8YqDS
# SdYWHvHP8NC6SEMDLacd8gE0SaQQ6WIT9BP0FoO11VdCSIYrlViH6igEdMtyEQ9h
# JuH6HGEVxyibTQuCDyYrkDqW7aTQaymc9WGI5qRXb+70cNCNF97mZnZfdB5eDFM4
# XZD03zAtGxPReZhUGks4BPQHxCMD05LL94BdqpxWBkQtQUxItC3sNZKaxpXX9c6Q
# MeJ2s2G48XVXQqw7zivIkEnotybPuwyJy9DDo2qhydXjnFMrVyb+Vpp2/WFGomDs
# KUZH8s3ggmLGBFrn7U5AXEgGfZ1f53TJnoRlDVve3NMkHLQUEeurv8QfpLqZ0BdY
# Nc0CAwEAAaOB/TCB+jAOBgNVHQ8BAf8EBAMCAQYwEgYDVR0TAQH/BAgwBgEB/wIB
# ADAdBgNVHQ4EFgQUGUq4WuRNMaUU5V7sL6Mc+oCMMmswRwYDVR0gBEAwPjA8BgRV
# HSAAMDQwMgYIKwYBBQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3Jl
# cG9zaXRvcnkvMDYGA1UdHwQvMC0wK6ApoCeGJWh0dHA6Ly9jcmwuZ2xvYmFsc2ln
# bi5uZXQvcm9vdC1yMy5jcmwwEwYDVR0lBAwwCgYIKwYBBQUHAwMwHwYDVR0jBBgw
# FoAUj/BLf6guRSSuTVD6Y5qL3uLdG7wwDQYJKoZIhvcNAQELBQADggEBAHmwaTTi
# BYf2/tRgLC+GeTQD4LEHkwyEXPnk3GzPbrXsCly6C9BoMS4/ZL0Pgmtmd4F/ximl
# F9jwiU2DJBH2bv6d4UgKKKDieySApOzCmgDXsG1szYjVFXjPE/mIpXNNwTYr3MvO
# 23580ovvL72zT006rbtibiiTxAzL2ebK4BEClAOwvT+UKFaQHlPCJ9XJPM0aYx6C
# WRW2QMqngarDVa8z0bV16AnqRwhIIvtdG/Mseml+xddaXlYzPK1X6JMlQsPSXnE7
# ShxU7alVrCgFx8RsXdw8k/ZpPIJRzhoVPV4Bc/9Aouq0rtOO+u5dbEfHQfXUVlfy
# GDcy1tTMS/Zx4HYwggSfMIIDh6ADAgECAhIRIdaZp2SXPvH4Qn7pGcxTQRQwDQYJ
# KoZIhvcNAQEFBQAwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24g
# bnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzIw
# HhcNMTYwNTI0MDAwMDAwWhcNMjcwNjI0MDAwMDAwWjBgMQswCQYDVQQGEwJTRzEf
# MB0GA1UEChMWR01PIEdsb2JhbFNpZ24gUHRlIEx0ZDEwMC4GA1UEAxMnR2xvYmFs
# U2lnbiBUU0EgZm9yIE1TIEF1dGhlbnRpY29kZSAtIEcyMIIBIjANBgkqhkiG9w0B
# AQEFAAOCAQ8AMIIBCgKCAQEAsBeuotO2BDBWHlgPse1VpNZUy9j2czrsXV6rJf02
# pfqEw2FAxUa1WVI7QqIuXxNiEKlb5nPWkiWxfSPjBrOHOg5D8NcAiVOiETFSKG5d
# QHI88gl3p0mSl9RskKB2p/243LOd8gdgLE9YmABr0xVU4Prd/4AsXximmP/Uq+yh
# RVmyLm9iXeDZGayLV5yoJivZF6UQ0kcIGnAsM4t/aIAqtaFda92NAgIpA6p8N7u7
# KU49U5OzpvqP0liTFUy5LauAo6Ml+6/3CGSwekQPXBDXX2E3qk5r09JTJZ2Cc/os
# +XKwqRk5KlD6qdA8OsroW+/1X1H0+QrZlzXeaoXmIwRCrwIDAQABo4IBXzCCAVsw
# DgYDVR0PAQH/BAQDAgeAMEwGA1UdIARFMEMwQQYJKwYBBAGgMgEeMDQwMgYIKwYB
# BQUHAgEWJmh0dHBzOi8vd3d3Lmdsb2JhbHNpZ24uY29tL3JlcG9zaXRvcnkvMAkG
# A1UdEwQCMAAwFgYDVR0lAQH/BAwwCgYIKwYBBQUHAwgwQgYDVR0fBDswOTA3oDWg
# M4YxaHR0cDovL2NybC5nbG9iYWxzaWduLmNvbS9ncy9nc3RpbWVzdGFtcGluZ2cy
# LmNybDBUBggrBgEFBQcBAQRIMEYwRAYIKwYBBQUHMAKGOGh0dHA6Ly9zZWN1cmUu
# Z2xvYmFsc2lnbi5jb20vY2FjZXJ0L2dzdGltZXN0YW1waW5nZzIuY3J0MB0GA1Ud
# DgQWBBTUooRKOFoYf7pPMFC9ndV6h9YJ9zAfBgNVHSMEGDAWgBRG2D7/3OO+/4Pm
# 9IWbsN1q1hSpwTANBgkqhkiG9w0BAQUFAAOCAQEAj6kakW0EpjcgDoOW3iPTa24f
# bt1kPWghIrX4RzZpjuGlRcckoiK3KQnMVFquxrzNY46zPVBI5bTMrs2SjZ4oixNK
# Eaq9o+/Tsjb8tKFyv22XY3mMRLxwL37zvN2CU6sa9uv6HJe8tjecpBwwvKu8LUc2
# 35IgA+hxxlj2dQWaNPALWVqCRDSqgOQvhPZHXZbJtsrKnbemuuRQ09Q3uLogDtDT
# kipbxFm7oW3bPM5EncE4Kq3jjb3NCXcaEL5nCgI2ZIi5sxsm7ueeYMRGqLxhM2zP
# TrmcuWrwnzf+tT1PmtNN/94gjk6Xpv2fCbxNyhh2ybBNhVDygNIdBvVYBAexGDCC
# BNYwggO+oAMCAQICEhEhDRayW4wRltP+V8mGEea62TANBgkqhkiG9w0BAQsFADBa
# MQswCQYDVQQGEwJCRTEZMBcGA1UEChMQR2xvYmFsU2lnbiBudi1zYTEwMC4GA1UE
# AxMnR2xvYmFsU2lnbiBDb2RlU2lnbmluZyBDQSAtIFNIQTI1NiAtIEcyMB4XDTE1
# MDUwNDE2NDMyMVoXDTE4MDUwNDE2NDMyMVowVTELMAkGA1UEBhMCQ0gxDDAKBgNV
# BAgTA1p1ZzEMMAoGA1UEBxMDWnVnMRQwEgYDVQQKEwtkLWZlbnMgR21iSDEUMBIG
# A1UEAxMLZC1mZW5zIEdtYkgwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB
# AQDNPSzSNPylU9jFM78Q/GjzB7N+VNqikf/use7p8mpnBZ4cf5b4qV3rqQd62rJH
# RlAsxgouCSNQrl8xxfg6/t/I02kPvrzsR4xnDgMiVCqVRAeQsWebafWdTvWmONBS
# lxJejPP8TSgXMKFaDa+2HleTycTBYSoErAZSWpQ0NqF9zBadjsJRVatQuPkTDrwL
# eWibiyOipK9fcNoQpl5ll5H9EG668YJR3fqX9o0TQTkOmxXIL3IJ0UxdpyDpLEkt
# tBG6Y5wAdpF2dQX2phrfFNVY54JOGtuBkNGMSiLFzTkBA1fOlA6ICMYjB8xIFxVv
# rN1tYojCrqYkKMOjwWQz5X8zAgMBAAGjggGZMIIBlTAOBgNVHQ8BAf8EBAMCB4Aw
# TAYDVR0gBEUwQzBBBgkrBgEEAaAyATIwNDAyBggrBgEFBQcCARYmaHR0cHM6Ly93
# d3cuZ2xvYmFsc2lnbi5jb20vcmVwb3NpdG9yeS8wCQYDVR0TBAIwADATBgNVHSUE
# DDAKBggrBgEFBQcDAzBCBgNVHR8EOzA5MDegNaAzhjFodHRwOi8vY3JsLmdsb2Jh
# bHNpZ24uY29tL2dzL2dzY29kZXNpZ25zaGEyZzIuY3JsMIGQBggrBgEFBQcBAQSB
# gzCBgDBEBggrBgEFBQcwAoY4aHR0cDovL3NlY3VyZS5nbG9iYWxzaWduLmNvbS9j
# YWNlcnQvZ3Njb2Rlc2lnbnNoYTJnMi5jcnQwOAYIKwYBBQUHMAGGLGh0dHA6Ly9v
# Y3NwMi5nbG9iYWxzaWduLmNvbS9nc2NvZGVzaWduc2hhMmcyMB0GA1UdDgQWBBTN
# GDddiIYZy9p3Z84iSIMd27rtUDAfBgNVHSMEGDAWgBQZSrha5E0xpRTlXuwvoxz6
# gIwyazANBgkqhkiG9w0BAQsFAAOCAQEAAApsOzSX1alF00fTeijB/aIthO3UB0ks
# 1Gg3xoKQC1iEQmFG/qlFLiufs52kRPN7L0a7ClNH3iQpaH5IEaUENT9cNEXdKTBG
# 8OrJS8lrDJXImgNEgtSwz0B40h7bM2Z+0DvXDvpmfyM2NwHF/nNVj7NzmczrLRqN
# 9de3tV0pgRqnIYordVcmb24CZl3bzpwzbQQy14Iz+P5Z2cnw+QaYzAuweTZxEUcJ
# bFwpM49c1LMPFJTuOKkUgY90JJ3gVTpyQxfkc7DNBnx74PlRzjFmeGC/hxQt0hvo
# eaAiBdjo/1uuCTToigVnyRH+c0T2AezTeoFb7ne3I538hWeTdU5q9jGCBLcwggSz
# AgEBMHAwWjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2Ex
# MDAuBgNVBAMTJ0dsb2JhbFNpZ24gQ29kZVNpZ25pbmcgQ0EgLSBTSEEyNTYgLSBH
# MgISESENFrJbjBGW0/5XyYYR5rrZMAkGBSsOAwIaBQCgeDAYBgorBgEEAYI3AgEM
# MQowCKACgAChAoAAMBkGCSqGSIb3DQEJAzEMBgorBgEEAYI3AgEEMBwGCisGAQQB
# gjcCAQsxDjAMBgorBgEEAYI3AgEVMCMGCSqGSIb3DQEJBDEWBBSP+C1WlyMAjlmb
# dhFJDM4ogCljAzANBgkqhkiG9w0BAQEFAASCAQBX5p5ptfkA6p0cWXzIQSp/ngYo
# X+etdlfIyMFppoQLXbYVXlYrzKGp3SHWEqvf/TzTJDp9hXP2qx3BDn+ioTlEko5X
# WUmq8qTH2npeOzf6k/jygX92oPqdFOeq0aj0+7Uc94LoAKEIkh4dkIbAYgNckPg1
# fpPyZPG5aaTsT1QmxFpj53DY+9zTxWdpweU3oh+pHL4UvJ0dh+F6CtIQGftCNSs7
# ngCPToQXQOLZVBjiKCat6iPXiXHvMT42uFwOboLaaD5x9zyoR4TcRNlSE4feWORe
# nS3bquofSbhPIJAKeuC+hcbjsfBf4SC0pNRFJqUu4GUyxyS1IylcmCCl2RZKoYIC
# ojCCAp4GCSqGSIb3DQEJBjGCAo8wggKLAgEBMGgwUjELMAkGA1UEBhMCQkUxGTAX
# BgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGlt
# ZXN0YW1waW5nIENBIC0gRzICEhEh1pmnZJc+8fhCfukZzFNBFDAJBgUrDgMCGgUA
# oIH9MBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEwHAYJKoZIhvcNAQkFMQ8XDTE2
# MDgzMTE5MTcwN1owIwYJKoZIhvcNAQkEMRYEFH10Km52OuXZyYhmR0MpzWbdE2b4
# MIGdBgsqhkiG9w0BCRACDDGBjTCBijCBhzCBhAQUY7gvq2H1g5CWlQULACScUCkz
# 7HkwbDBWpFQwUjELMAkGA1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYt
# c2ExKDAmBgNVBAMTH0dsb2JhbFNpZ24gVGltZXN0YW1waW5nIENBIC0gRzICEhEh
# 1pmnZJc+8fhCfukZzFNBFDANBgkqhkiG9w0BAQEFAASCAQAUCe/UMABNNfhw9Lnq
# 3jvWR5RYs2d+Q42VG/ASWAP7TX17ork9CcT8OgDZQ5igVctNPc33b4WLHjxjef1k
# 5IiTUy19GAYOqJ9ei4hs2NUibAeT6Shg1wiYH1U6mXyh3ya8vk5P24XPhz5eqopj
# kIPmml9t6OlrXyf/H4Mxv3banB8AWYPNvW6MIjLxYz+ldzLBiNlRujFJIBtFyvP5
# sYSGOdaj7G4Fk1Mj+rVzRyd4gj6snCqvPMswUTSPdLbt3FhzkSw0oj88hlKtWB12
# peKr2iyedePcX2YGnfGBXw4W0sFIQizGwkG6m8yBygWND9Fr8VrQIswFd1KgzvlU
# jRPM
# SIG # End signature block
|
PowerShellCorpus/PowerShellGallery/HttpListener/1.0.2/HTTPListener_Tests.ps1
|
HTTPListener_Tests.ps1
|
# Copyright (c) 2014 Microsoft Corp.
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
# This script requires Pester (https://github.com/pester) module imported
$currentDir = Split-Path -Parent $MyInvocation.MyCommand.Path
if ($null -ne (Get-Module HttpListener)) {
Remove-Module HttpListener
}
Import-Module $currentDir\HttpListener.psd1 -Force
# start the httplistener, requires elevation
$command = "ipmo $pwd\httplistener.psd1;start-httplistener -url test -verbose"
$process = Start-Process powershell -ArgumentList $command -Verb RunAs -PassThru
Function Invoke-WebPowerShell([string] $command, [string] $format = [string]::Empty) {
$url = "http://localhost:8888/test"
$httpArgs = @{UseDefaultCredentials=$true}
$url += "`?command=$command"
if ($format -ne [string]::Empty) {
$url += "&format=$format"
}
$response = Invoke-WebRequest -Uri $url @httpArgs
[System.Text.Encoding]::UTF8.GetString($response.Content)
}
Describe "Invoking commandline" {
It "returns single object" {
$json = Invoke-WebPowerShell -command "get-ciminstance win32_bios" -format "JSON"
$bios = Get-CimInstance win32_bios | ConvertTo-Json
Compare-Object $json $bios | Should BeNullOrEmpty
}
It "returns multiple objects" {
$json = Invoke-WebPowerShell -command "get-verb" -format "JSON"
$verb = Get-Verb | ConvertTo-Json
Compare-Object $json $verb | Should BeNullOrEmpty
}
It "returns nothing" {
$json = Invoke-WebPowerShell -command "get-help > `$null" -format "JSON" | Should Be ([string]::Empty)
}
}
Describe -Tags "Negative" "Exception Handling" {
It "returns PowerShell exception" {
try {
Invoke-WebPowerShell -command "get-invalidcmdlet" -format "json" | Should BeNullOrEmpty
} catch {
($_.ErrorDetails.Message | ConvertFrom-Json).FullyQualifiedErrorId | Should Be "CommandNotFoundException"
}
}
It "returns cmdlet exception" {
try {
Invoke-WebPowerShell -command "get-process foo" -format "json" | Should BeNullOrEmpty
} Catch {
($_.ErrorDetails.Message | ConvertFrom-Json).FullyQualifiedErrorId | Should Be "NoProcessFoundForGivenName,Microsoft.PowerShell.Commands.GetProcessCommand"
}
}
}
$command = "stop-process -id $($process.Id)"
Start-Process powershell -ArgumentList $command -Verb RunAs
|
PowerShellCorpus/PowerShellGallery/HttpListener/1.0.2/Content/Deployment/Module References/HttpListener/HTTPListener_Tests.ps1
|
HTTPListener_Tests.ps1
|
# Copyright (c) 2014 Microsoft Corp.
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
# This script requires Pester (https://github.com/pester) module imported
$currentDir = Split-Path -Parent $MyInvocation.MyCommand.Path
if ((Get-Module HttpListener) -ne $null) {
Remove-Module HttpListener
}
Import-Module $currentDir\HttpListener.psd1 -Force
# start the httplistener, requires elevation
$command = "ipmo $pwd\httplistener.psd1;start-httplistener -url test -verbose"
$process = Start-Process powershell -ArgumentList $command -Verb RunAs -PassThru
Function Invoke-WebPowerShell([string] $command, [string] $format = [string]::Empty) {
$url = "http://localhost:8888/test"
$httpArgs = @{UseDefaultCredentials=$true}
$url += "`?command=$command"
if ($format -ne [string]::Empty) {
$url += "&format=$format"
}
$response = Invoke-WebRequest -Uri $url @httpArgs
[System.Text.Encoding]::UTF8.GetString($response.Content)
}
Describe "Invoking commandline" {
It "returns single object" {
$json = Invoke-WebPowerShell -command "get-ciminstance win32_bios" -format "JSON"
$bios = Get-CimInstance win32_bios | ConvertTo-Json
Compare-Object $json $bios | Should BeNullOrEmpty
}
It "returns multiple objects" {
$json = Invoke-WebPowerShell -command "get-verb" -format "JSON"
$verb = Get-Verb | ConvertTo-Json
Compare-Object $json $verb | Should BeNullOrEmpty
}
It "returns nothing" {
$json = Invoke-WebPowerShell -command "get-help > `$null" -format "JSON" | Should Be ([string]::Empty)
}
}
Describe -Tags "Negative" "Exception Handling" {
It "returns PowerShell exception" {
try {
Invoke-WebPowerShell -command "get-invalidcmdlet" -format "json" | Should BeNullOrEmpty
} catch {
($_.ErrorDetails.Message | ConvertFrom-Json).FullyQualifiedErrorId | Should Be "CommandNotFoundException"
}
}
It "returns cmdlet exception" {
try {
Invoke-WebPowerShell -command "get-process foo" -format "json" | Should BeNullOrEmpty
} Catch {
($_.ErrorDetails.Message | ConvertFrom-Json).FullyQualifiedErrorId | Should Be "NoProcessFoundForGivenName,Microsoft.PowerShell.Commands.GetProcessCommand"
}
}
}
$command = "stop-process -id $($process.Id)"
Start-Process powershell -ArgumentList $command -Verb RunAs
|
PowerShellCorpus/PowerShellGallery/fxdemo/0.0.3/Public/Get-ADSIComputerSite.ps1
|
Get-ADSIComputerSite.ps1
|
function Get-ADSIComputerSite
{
<#
.SYNOPSIS
Function to retrieve the AD Site of a Computer
.DESCRIPTION
Function to retrieve the AD Site of a Computer
This function does not rely on the .NET Framework to retrieve the information
http://www.pinvoke.net/default.aspx/netapi32.dsgetsitename
There is .NET method to get this information but only works on the local machine.
[System.DirectoryServices.ActiveDirectory.ActiveDirectorySite]::GetComputerSite()
.PARAMETER ComputerName
Specifies the computer name(s) that you want to know the site.
.EXAMPLE
Get-ADSIComputerName -ComputerName TestServer01
This will retrieve the Site of the Computer TestServer01
.EXAMPLE
Get-ADSIComputerName -ComputerName TestServer01,TestServer02
This will retrieve the Site of the Computers TestServer01 and TestServer02
.NOTES
Francois-Xavier Cat
lazywinadmin.com
@lazywinadm
github.com/lazywinadmin/FXDemo
Thanks to the Reddit folks for their help! :-)
https://www.reddit.com/r/PowerShell/comments/4cjdk8/get_the_ad_site_name_of_a_computer/
#>
[CmdletBinding()]
[OutputType('System.Management.Automation.PSCustomObject')]
param
(
[parameter()]
[String[]]$ComputerName=$env:computername
)
BEGIN
{
$code = @"
using System;
using System.Collections.Generic;
using System.Runtime.InteropServices;
public static class NetApi32 {
private class unmanaged {
[DllImport("NetApi32.dll", CharSet=CharSet.Auto, SetLastError=true)]
internal static extern UInt32 DsGetSiteName([MarshalAs(UnmanagedType.LPTStr)]string ComputerName, out IntPtr SiteNameBuffer);
[DllImport("Netapi32.dll", SetLastError=true)]
internal static extern int NetApiBufferFree(IntPtr Buffer);
}
public static string DsGetSiteName(string ComputerName) {
IntPtr siteNameBuffer = IntPtr.Zero;
UInt32 hResult = unmanaged.DsGetSiteName(ComputerName, out siteNameBuffer);
string siteName = Marshal.PtrToStringAuto(siteNameBuffer);
unmanaged.NetApiBufferFree(siteNameBuffer);
if(hResult == 0x6ba) { throw new Exception("ComputerName not found"); }
return siteName;
}
}
"@
Add-Type -TypeDefinition $code
}
PROCESS
{
FOREACH ($Computer in $ComputerName)
{
TRY
{
[PSCustomObject][ordered]@{
ComputerName = $Computer
SiteName = [NetApi32]::DsGetSiteName($Computer)
}
}
CATCH
{
Write-Error -Message "[Get-ADSIComputerSite][PROCESS] Something wrong happened when quering $Computer"
$Error[0].Exception.Message
}
}
}
}
|
PowerShellCorpus/PowerShellGallery/fxdemo/0.0.3/Public/Get-ADSIComputer.ps1
|
Get-ADSIComputer.ps1
|
function Get-ADSIComputer
{
<#
.SYNOPSIS
Function to retrieve a Computer in Active Directory
.DESCRIPTION
Function to retrieve a Computer in Active Directory
.PARAMETER Identity
Specifies the Identity of the computer
You can provide one of the following:
DistinguishedName
Guid
Name
SamAccountName
Sid
System.DirectoryService.AccountManagement.IdentityType
https://msdn.microsoft.com/en-us/library/bb356425(v=vs.110).aspx
.PARAMETER Credential
Specifies alternative credential
By default it will use the current user windows credentials.
.PARAMETER DomainName
Specifies the alternative Domain.
By default it will use the current domain.
.EXAMPLE
Get-ADSIComputer -Identity 'SERVER01'
This command will retrieve the computer account SERVER01
.EXAMPLE
Get-ADSIComputer -Identity 'SERVER01' -Credential (Get-Credential)
This command will retrieve the computer account SERVER01 with the specified credential
.EXAMPLE
Get-ADSIComputer TESTSERVER01 -credential (Get-Credential) -domain LazyWinAdmin.local
This command will retrieve the account TESTSERVER01 using the alternative credential specified in the domain lazywinadmin.local
.EXAMPLE
$Comp = Get-ADSIComputer -Identity 'SERVER01'
$Comp.GetUnderlyingObject()| select-object *
Help you find all the extra properties
.NOTES
Francois-Xavier Cat
lazywinadmin.com
@lazywinadm
github.com/lazywinadmin/FXDemo
.LINK
https://msdn.microsoft.com/en-us/library/system.directoryservices.accountmanagement.computerprincipal(v=vs.110).aspx
#>
[CmdletBinding(DefaultParameterSetName="All")]
param ([Parameter(Mandatory=$true,ParameterSetName="Identity")]
[string]$Identity,
[Alias("RunAs")]
[System.Management.Automation.PSCredential]
[System.Management.Automation.Credential()]
$Credential = [System.Management.Automation.PSCredential]::Empty,
[String]$DomainName
)
BEGIN
{
Add-Type -AssemblyName System.DirectoryServices.AccountManagement
# Create Context splatting
$ContextSplatting = @{ ContextType = "Domain" }
IF ($PSBoundParameters['Credential']) { $ContextSplatting.Credential = $Credential }
IF ($PSBoundParameters['DomainName']) { $ContextSplatting.DomainName = $DomainName }
$Context = New-ADSIPrincipalContext @ContextSplatting
}
PROCESS
{
TRY{
IF($Identity)
{
[System.DirectoryServices.AccountManagement.ComputerPrincipal]::FindByIdentity($Context, $Identity)
}
ELSE{
$ComputerPrincipal = New-object -TypeName System.DirectoryServices.AccountManagement.ComputerPrincipal -ArgumentList $Context
$Searcher = new-object System.DirectoryServices.AccountManagement.PrincipalSearcher
$Searcher.QueryFilter = $ComputerPrincipal
$Searcher.FindAll()
}
}
CATCH
{
$Error[0]
}
}
}
|
PowerShellCorpus/PowerShellGallery/fxdemo/0.0.3/Public/New-ADSIPrincipalContext.ps1
|
New-ADSIPrincipalContext.ps1
|
function New-ADSIPrincipalContext
{
<#
.SYNOPSIS
Function to create an Active Directory PrincipalContext object
.DESCRIPTION
Function to create an Active Directory PrincipalContext object
.PARAMETER Credential
Specifies the alternative credentials to use.
It will use the current credential if not specified.
.PARAMETER ContextType
Specifies which type of Context to use. Domain, Machine or ApplicationDirectory.
.PARAMETER DomainName
Specifies the domain to query. Default is the current domain.
Should only be used with the Domain ContextType.
.PARAMETER Container
Specifies the scope. Example: "OU=MyOU"
.PARAMETER ContextOptions
Specifies the ContextOptions.
Negotiate
Sealing
SecureSocketLayer
ServerBind
Signing
SimpleBind
.EXAMPLE
New-ADSIPrincipalContext -ContextType 'Domain'
.EXAMPLE
New-ADSIPrincipalContext -ContextType 'Domain' -DomainName "Contoso.com" -Cred (Get-Credential)
.NOTES
Francois-Xavier.Cat
LazyWinAdmin.com
@lazywinadm
github.com/lazywinadmin/FXDemo
https://msdn.microsoft.com/en-us/library/system.directoryservices.accountmanagement.principalcontext(v=vs.110).aspx
#>
[CmdletBinding()]
[OutputType('System.DirectoryServices.AccountManagement.PrincipalContext')]
PARAM
(
[Alias("RunAs")]
[System.Management.Automation.PSCredential]
[System.Management.Automation.Credential()]
$Credential = [System.Management.Automation.PSCredential]::Empty,
[Parameter(Mandatory = $true)]
[System.DirectoryServices.AccountManagement.ContextType]$ContextType,
$DomainName = [System.DirectoryServices.ActiveDirectory.Domain]::Getcurrentdomain(),
$Container,
[System.DirectoryServices.AccountManagement.ContextOptions[]]$ContextOptions
)
BEGIN
{
$ScriptName = (Get-Variable -name MyInvocation -Scope 0 -ValueOnly).MyCommand
Write-Verbose -Message "[$ScriptName] Add Type System.DirectoryServices.AccountManagement"
Add-Type -AssemblyName System.DirectoryServices.AccountManagement
}
PROCESS
{
TRY
{
switch ($ContextType)
{
"Domain" { $ArgumentList = $ContextType, $DomainName }
"Machine" { $ArgumentList = $ContextType, $ComputerName }
"ApplicationDirectory" { $ArgumentList = $ContextType }
}
IF ($PSBoundParameters['Container'])
{
$ArgumentList += $Container
}
IF ($PSBoundParameters['ContextOptions'])
{
$ArgumentList += $($ContextOptions)
}
IF ($PSBoundParameters['Credential'])
{
# Query the specified domain or current if not entered, with the specified credentials
$ArgumentList += $($Credential.UserName), $($Credential.GetNetworkCredential().password)
}
# Query
New-Object -TypeName System.DirectoryServices.AccountManagement.PrincipalContext -ArgumentList $ArgumentList
} #TRY
CATCH
{
$PSCmdlet.ThrowTerminatingError($_)
}
} #PROCESS
}
|
PowerShellCorpus/PowerShellGallery/OVF.ShareFile/1.0.0/Diagnostics/Simple/SZC_Website.Tests.ps1
|
SZC_Website.Tests.ps1
|
[CmdletBinding()]
param(
[ValidateSet('http','https')]
$Protocol = 'http'
)
Function ConvertFrom-HtmlTable
{
param(
[Parameter(Mandatory = $true)]
$WebRequest,
[Parameter(Mandatory = $true)]
[int] $TableNumber
)
if($WebRequest -is [Microsoft.PowerShell.Commands.HtmlWebResponseObject])
{
$tables = @($WebRequest.ParsedHtml.getElementsByTagName("TABLE"))
}
else
{
$tables = @($WebRequest.getElementsByTagName("TABLE"))
}
## Extract the tables out of the web request
$table = $tables[$TableNumber]
$titles = @()
$rows = @($table.Rows)
## Go through all of the rows in the table
foreach($row in $rows)
{
$cells = @($row.Cells)
## If we’ve found a table header, remember its titles
if($cells[0].tagName -eq "TH")
{
$titles = @($cells | Foreach-Object { ("" + $_.InnerText).Trim() })
continue
}
## If we haven’t found any table headers, make up names "P1", "P2", etc.
if(-not $titles)
{
$titles = @(1..($cells.Count + 2) | Foreach-Object { "P$_" })
}
## Now go through the cells in the the row. For each, try to find the
## title that represents that column and create a hashtable mapping those
## titles to content
$resultObject = [Ordered] @{}
for($counter = 0; $counter -lt $cells.Count; $counter++)
{
$title = $titles[$counter]
if(-not $title) { continue }
$resultObject[$title] = ("" + $cells[$counter].InnerText).Trim()
}
## And finally cast that hashtable to a PSCustomObject
[PSCustomObject] $resultObject
}
}
Describe 'ShareFile Health Check' {
BeforeAll {
<# Doesn't work in scheduled task :(
$WebRequest = Invoke-WebRequest -Uri 'http://localhost/configservice/PreFlightCheck.aspx'
if($WebRequest.StatusCode -ne 200)
{
throw "Error retrieving ShareFile Monitoring status"
}
#>
try {
# Accept self-signed certs
[System.Net.ServicePointManager]::ServerCertificateValidationCallback = {$true}
# Query website
$Url = '{0}://localhost/configservice/PreFlightCheck.aspx' -f $Protocol
Write-Verbose -Message "Querying url $Url"
$websiteContent = (New-Object System.Net.WebClient).DownloadString($Url)
# Parse html code
$html = New-Object -ComObject "HTMLFile"
$src = [System.Text.Encoding]::Unicode.GetBytes($websiteContent)
$html.write($src)
# Extract table and convert to object collection
$Table = ConvertFrom-HtmlTable -WebRequest $html -TableNumber 0
}
catch {
}
$testCases = @(
@{
Setting = 'Registry Permissions Access'
Expected = 'Permissions OK'
}
@{
Setting = 'Storage Location Access'
Expected = 'Permissions OK'
}
@{
Setting = 'IIS User Account Configuration'
Expected = 'OK'
}
@{
Setting = 'File Cleanup Service Status'
Expected = 'Running'
}
@{
Setting = 'File Copy Service Status'
Expected = 'Running'
}
@{
Setting = 'File Upload Service Status'
Expected = 'Running'
}
@{
Setting = 'ShareFile Connectivity from Management Service'
Expected = 'OK*'
}
@{
Setting = 'ShareFile Connectivity from StorageZones Controller Website'
Expected = 'OK*'
}
@{
Setting = 'ShareFile Connectivity from File Cleanup Service'
Expected = 'OK*'
}
@{
Setting = 'ShareFile Connectivity from File Copy Service'
Expected = 'OK*'
}
@{
Setting = 'Queue SDK Connectivity'
Expected = 'OK*'
}
@{
Setting = 'Proxy Configuration'
Expected = 'Proxy Not Configured'
}
@{
Setting = 'Citrix Cloud Storage Uploader Service'
Expected = 'Cloud based object Storage Not Configured*'
}
)
}
It 'ShareFile SZC Website is up and running' {
#$WebRequest.StatusCode | Should Be 200
$websiteContent | Should Not BeNullOrEmpty
}
Context 'ShareFile SZC monitoring page' {
It '<Setting> is OK' -TestCases $testCases {
param ($Setting, $Expected)
$Actual = $Table | Where-Object {$_."Config Name" -eq $Setting} | Select-Object -ExpandProperty Details
$Actual | Should BeLike $Expected
}
}
}
|
PowerShellCorpus/PowerShellGallery/xCertificate/2.7.0.0/Examples/Resources/xCertificateImport/1-MinimalUsage.ps1
|
1-MinimalUsage.ps1
|
<#
.EXAMPLE
Import public key certificate into Trusted Root store.
#>
Configuration Example
{
param
(
[Parameter()]
[string[]]
$NodeName = 'localhost'
)
Import-DscResource -ModuleName xCertificate
Node $AllNodes.NodeName
{
xCertificateImport MyTrustedRoot
{
Thumbprint = 'c81b94933420221a7ac004a90242d8b1d3e5070d'
Location = 'LocalMachine'
Store = 'Root'
Path = '\\Server\Share\Certificates\MyTrustedRoot.cer'
}
}
}
|
PowerShellCorpus/PowerShellGallery/xCertificate/2.7.0.0/Examples/Resources/xPfxImport/2-MinimalUsage.ps1
|
2-MinimalUsage.ps1
|
<#
.EXAMPLE
Import a PFX into the My store.
#>
Configuration Example
{
param
(
[Parameter()]
[string[]]
$NodeName = 'localhost',
[Parameter(Mandatory = $true)]
[ValidateNotNullorEmpty()]
[PSCredential]
$Credential
)
Import-DscResource -ModuleName xCertificate
Node $AllNodes.NodeName
{
xPfxImport CompanyCert
{
Thumbprint = 'c81b94933420221a7ac004a90242d8b1d3e5070d'
Path = '\\Server\Share\Certificates\CompanyCert.pfx'
Store = 'My'
Location = 'LocalMachine'
Credential = $Credential
}
}
}
|
PowerShellCorpus/PowerShellGallery/xCertificate/2.7.0.0/Examples/Resources/xPfxImport/1-IIS_WebSite.ps1
|
1-IIS_WebSite.ps1
|
<#
.EXAMPLE
Import a PFX into the WebHosting store and bind it to an IIS Web Site.
#>
Configuration Example
{
param
(
[Parameter()]
[string[]]
$NodeName = 'localhost',
[Parameter(Mandatory = $true)]
[ValidateNotNullorEmpty()]
[PSCredential]
$Credential
)
Import-DscResource -ModuleName xCertificate
Import-DscResource -ModuleName xWebAdministration
Node $AllNodes.NodeName
{
WindowsFeature IIS
{
Ensure = 'Present'
Name = 'Web-Server'
}
xPfxImport CompanyCert
{
Thumbprint = 'c81b94933420221a7ac004a90242d8b1d3e5070d'
Path = '\\Server\Share\Certificates\CompanyCert.pfx'
Store = 'WebHosting'
Credential = $Credential
DependsOn = '[WindowsFeature]IIS'
}
xWebsite CompanySite
{
Ensure = 'Present'
Name = 'CompanySite'
State = 'Started'
PhysicalPath = "B:\Web\CompanySite"
ApplicationPool = "CompanyPool"
BindingInfo =
MSFT_xWebBindingInformation {
Protocol = 'HTTPS'
Port = 443
CertificateThumbprint = 'c81b94933420221a7ac004a90242d8b1d3e5070d'
CertificateStoreName = 'WebHosting'
HostName = "www.example.com"
}
DependsOn = '[WindowsFeature]Web-Server','[xPfxImport]CompanyCert'
}
}
}
|
PowerShellCorpus/PowerShellGallery/xCertificate/2.7.0.0/Examples/Resources/xCertificateExport/2-PfxByFriendlyName.ps1
|
2-PfxByFriendlyName.ps1
|
<#
.EXAMPLE
Exports a certificate as a PFX using the friendly name to identify it.
#>
Configuration Example
{
param
(
[Parameter()]
[string[]]
$NodeName = 'localhost',
[Parameter(Mandatory = $true)]
[ValidateNotNullorEmpty()]
[PSCredential]
$Credential
)
Import-DscResource -ModuleName xCertificate
Node $AllNodes.NodeName
{
xCertificateExport SSLCert
{
Type = 'PFX'
FriendlyName = 'Web Site SSL Certificate for www.contoso.com'
Path = 'c:\sslcert.cer'
Password = $Credential
}
}
}
|
PowerShellCorpus/PowerShellGallery/xCertificate/2.7.0.0/Examples/Resources/xCertificateExport/1-CertByFriendlyName.ps1
|
1-CertByFriendlyName.ps1
|
<#
.EXAMPLE
Exports a certificate as a CERT using the friendly name to identify it.
#>
Configuration Example
{
param
(
[Parameter()]
[string[]]
$NodeName = 'localhost'
)
Import-DscResource -ModuleName xCertificate
Node $AllNodes.NodeName
{
xCertificateExport SSLCert
{
Type = 'CERT'
FriendlyName = 'Web Site SSL Certificate for www.contoso.com'
Path = 'c:\sslcert.cer'
}
}
}
|
PowerShellCorpus/PowerShellGallery/xCertificate/2.7.0.0/Examples/Resources/xCertReq/2-RequestSSLCert.ps1
|
2-RequestSSLCert.ps1
|
<#
.EXAMPLE
Request and Accept a certificate from an Active Directory Root Certificate Authority.
This example is allowing storage of credentials in plain text by setting PSDscAllowPlainTextPassword to $true.
Storing passwords in plain text is not a good practice and is presented only for simplicity and demonstration purposes.
To learn how to securely store credentials through the use of certificates,
please refer to the following TechNet topic: https://technet.microsoft.com/en-us/library/dn781430.aspx
#>
configuration Example
{
param
(
[Parameter()]
[string[]]
$NodeName = 'localhost',
[Parameter(Mandatory = $true)]
[ValidateNotNullorEmpty()]
[PSCredential]
$Credential
)
Import-DscResource -ModuleName xCertificate
Node 'localhost'
{
xCertReq SSLCert
{
CARootName = 'test-dc01-ca'
CAServerFQDN = 'dc01.test.pha'
Subject = 'foodomain.test.net'
KeyLength = '1024'
Exportable = $true
ProviderName = '"Microsoft RSA SChannel Cryptographic Provider"'
OID = '1.3.6.1.5.5.7.3.1'
KeyUsage = '0xa0'
CertificateTemplate = 'WebServer'
AutoRenew = $true
Credential = $Credential
}
}
}
|
PowerShellCorpus/PowerShellGallery/xCertificate/2.7.0.0/Examples/Resources/xCertReq/1-RequestAltSSLCert.ps1
|
1-RequestAltSSLCert.ps1
|
<#
.EXAMPLE
Request and Accept a certificate from an Active Directory Root Certificate Authority. This certificate
is issued using an subject alternate name with multiple DNS addresses.
This example is allowing storage of credentials in plain text by setting PSDscAllowPlainTextPassword to $true.
Storing passwords in plain text is not a good practice and is presented only for simplicity and demonstration purposes.
To learn how to securely store credentials through the use of certificates,
please refer to the following TechNet topic: https://technet.microsoft.com/en-us/library/dn781430.aspx
#>
configuration Example
{
param
(
[Parameter()]
[string[]]
$NodeName = 'localhost',
[Parameter(Mandatory = $true)]
[ValidateNotNullorEmpty()]
[PSCredential]
$Credential
)
Import-DscResource -ModuleName xCertificate
Node 'localhost'
{
xCertReq SSLCert
{
CARootName = 'test-dc01-ca'
CAServerFQDN = 'dc01.test.pha'
Subject = 'contoso.com'
KeyLength = '1024'
Exportable = $true
ProviderName = '"Microsoft RSA SChannel Cryptographic Provider"'
OID = '1.3.6.1.5.5.7.3.1'
KeyUsage = '0xa0'
CertificateTemplate = 'WebServer'
SubjectAltName = 'dns=fabrikam.com&dns=contoso.com'
AutoRenew = $true
Credential = $Credential
}
}
}
|
PowerShellCorpus/PowerShellGallery/xCertificate/2.7.0.0/Tests/Unit/MSFT_xCertificateExport.Tests.ps1
|
MSFT_xCertificateExport.Tests.ps1
|
$script:DSCModuleName = 'xCertificate'
$script:DSCResourceName = 'MSFT_xCertificateExport'
#region HEADER
# Integration Test Template Version: 1.1.0
[String] $script:moduleRoot = Split-Path -Parent (Split-Path -Parent $PSScriptRoot)
if ( (-not (Test-Path -Path (Join-Path -Path $script:moduleRoot -ChildPath 'DSCResource.Tests'))) -or `
(-not (Test-Path -Path (Join-Path -Path $script:moduleRoot -ChildPath 'DSCResource.Tests\TestHelper.psm1'))) )
{
& git @('clone','https://github.com/PowerShell/DscResource.Tests.git',(Join-Path -Path $script:moduleRoot -ChildPath '\DSCResource.Tests\'))
}
Import-Module (Join-Path -Path $script:moduleRoot -ChildPath 'DSCResource.Tests\TestHelper.psm1') -Force
$TestEnvironment = Initialize-TestEnvironment `
-DSCModuleName $script:DSCModuleName `
-DSCResourceName $script:DSCResourceName `
-TestType Unit
#endregion
# Begin Testing
try
{
InModuleScope $script:DSCResourceName {
$DSCResourceName = 'MSFT_xCertificateExport'
$certificatePath = Join-Path -Path $env:Temp -ChildPath 'xCertificateExportTestCert.cer'
$pfxPath = Join-Path -Path $env:Temp -ChildPath 'xCertificateExportTestCert.pfx'
$certificateDNSNames = @('www.fabrikam.com', 'www.contoso.com')
$certificateKeyUsage = @('DigitalSignature','DataEncipherment')
$certificateEKU = @('Server Authentication','Client authentication')
$certificateSubject = 'CN=contoso, DC=com'
$certificateFriendlyName = 'Contoso Test Cert'
$certificateThumbprint = '1111111111111111111111111111111111111111'
$certificateNotFoundThumbprint = '2222222222222222222222222222222222222222'
$certificateStore = 'My'
$validCertificate = New-Object -TypeName PSObject -Property @{
Thumbprint = $certificateThumbprint
Subject = "CN=$certificateSubject"
Issuer = "CN=$certificateSubject"
FriendlyName = $certificateFriendlyName
DnsNameList = @(
@{ Unicode = $certificateDNSNames[0] }
@{ Unicode = $certificateDNSNames[1] }
)
Extensions = @(
@{ EnhancedKeyUsages = ($certificateKeyUsage -join ', ') }
)
EnhancedKeyUsages = @(
@{ FriendlyName = $certificateEKU[0] }
@{ FriendlyName = $certificateEKU[1] }
)
NotBefore = (Get-Date).AddDays(-30) # Issued on
NotAfter = (Get-Date).AddDays(31) # Expires after
}
$validCertificateParameters = @{
Path = $certificatePath
Thumbprint = $certificateThumbprint
FriendlyName = $certificateFriendlyName
Subject = $certificateSubject
DNSName = $certificateDNSNames
Issuer = $certificateSubject
KeyUsage = $certificateKeyUsage
EnhancedKeyUsage = $certificateEKU
Store = $certificateStore
AllowExpired = $false
MatchSource = $false
Type = 'Cert'
}
$validCertificateNotFoundParameters = @{} + $validCertificateParameters
$validCertificateNotFoundParameters.Thumbprint = $certificateNotFoundThumbprint
$validCertificateMatchSourceParameters = @{} + $validCertificateParameters
$validCertificateMatchSourceParameters.MatchSource = $true
$pfxPlainTextPassword = 'P@ssword!1'
$pfxPassword = ConvertTo-SecureString -String $pfxPlainTextPassword -AsPlainText -Force
$pfxCredential = New-Object -TypeName System.Management.Automation.PSCredential `
-ArgumentList ('Dummy',$pfxPassword)
$validPfxParameters = @{
Path = $PfxPath
Thumbprint = $certificateThumbprint
FriendlyName = $certificateFriendlyName
Subject = $certificateSubject
DNSName = $certificateDNSNames
Issuer = $certificateSubject
KeyUsage = $certificateKeyUsage
EnhancedKeyUsage = $certificateEKU
Store = $certificateStore
AllowExpired = $false
MatchSource = $false
Password = $pfxCredential
ProtectTo = 'Administrators'
Type = 'PFX'
}
$validPfxMatchSourceParameters = @{} + $validPfxParameters
$validPfxMatchSourceParameters.MatchSource = $true
# This is so we can mock the Import method in Set-TargetResource
class X509Certificate2CollectionDummyMatch:System.Object
{
[String] $Thumbprint = '1111111111111111111111111111111111111111'
X509Certificate2CollectionDummyMatch()
{
}
Import($Path)
{
}
Import($Path,$Password,$Flags)
{
}
}
class X509Certificate2CollectionDummyNoMatch:System.Object
{
[String] $Thumbprint = '2222222222222222222222222222222222222222'
X509Certificate2CollectionDummyNoMatch()
{
}
Import($Path)
{
}
Import($Path,$Password,$Flags)
{
}
}
$importedCertificateMatch = New-Object -Type X509Certificate2CollectionDummyMatch
$importedCertificateNoMatch = New-Object -Type X509Certificate2CollectionDummyNoMatch
# MockWith content for Export-Certificate
$mockExportCertificate = {
if ($FilePath -ne $certificatePath)
{
throw 'Expected mock to be called with {0}, but was {1}' -f $certificatePath,$FilePath
}
}
# MockWith content for Export-PfxCertificate
$mockExportPfxCertificate = {
if ($FilePath -ne $pfxPath)
{
throw 'Expected mock to be called with {0}, but was {1}' -f $pfxPath,$FilePath
}
}
# MockWith content for Find-Certifciate
$mockFindCertificate = {
if ($Thumbprint -eq $certificateThumbprint)
{
$validCertificate
}
}
Describe "$DSCResourceName\Get-TargetResource" {
Context 'Certificate has been exported' {
Mock `
-CommandName Test-Path `
-MockWith { $true } `
-ParameterFilter { $Path -eq $certificatePath }
It 'should return IsExported true' {
$Result = Get-TargetResource -Path $certificatePath -Verbose
$Result.IsExported | Should Be $true
}
It 'should call the expected mocks' {
Assert-MockCalled -CommandName Test-Path -Exactly -Times 1
}
}
Context 'Certificate has not been exported' {
Mock `
-CommandName Test-Path `
-MockWith { $false } `
-ParameterFilter { $Path -eq $certificatePath }
It 'should return IsExported false' {
$Result = Get-TargetResource -Path $certificatePath -Verbose
$Result.IsExported | Should Be $false
}
It 'should call the expected mocks' {
Assert-MockCalled -CommandName Test-Path -Exactly -Times 1
}
}
}
Describe "$DSCResourceName\Set-TargetResource" {
BeforeEach {
Mock `
-CommandName Find-Certificate `
-MockWith $mockFindCertificate
}
Context 'Certificate is not found' {
Mock `
-CommandName Export-Certificate
Mock `
-CommandName Export-PfxCertificate
It 'should not throw exception' {
{ Set-TargetResource @validCertificateNotFoundParameters -Verbose } | Should Not Throw
}
It 'should call the expected mocks' {
Assert-MockCalled -CommandName Find-Certificate -Exactly -Times 1
Assert-MockCalled -CommandName Export-Certificate -Exactly -Times 0
Assert-MockCalled -CommandName Export-PfxCertificate -Exactly -Times 0
}
}
Context 'Certificate is found and needs to be exported as Cert' {
# Needs to be done because real Export-Certificate $cert parameter requires an actual [X509Certificate2] object
function Export-Certificate
{
[CmdletBinding()]
param
(
$FilePath,
$Cert,
$Force,
$Type
)
}
Mock `
-CommandName Export-Certificate `
-MockWith $mockExportCertificate
Mock `
-CommandName Export-PfxCertificate
It 'should not throw exception' {
{ Set-TargetResource @validCertificateParameters -Verbose } | Should Not Throw
}
It 'should call the expected mocks' {
Assert-MockCalled -CommandName Find-Certificate -Exactly -Times 1
Assert-MockCalled -CommandName Export-Certificate -Exactly -Times 1
Assert-MockCalled -CommandName Export-PfxCertificate -Exactly -Times 0
}
}
Context 'Certificate is found and needs to be exported as PFX' {
# Needs to be done because real Export-PfxCertificate $cert parameter requires an actual [X509Certificate2] object
function Export-PfxCertificate
{
[CmdletBinding()]
param
(
$FilePath,
$Cert,
$Force,
$Type,
$Password,
$ChainOption,
$ProtectTo
)
}
Mock `
-CommandName Export-Certificate
Mock `
-CommandName Export-PfxCertificate `
-MockWith $mockExportPfxCertificate
It 'should not throw exception' {
{ Set-TargetResource @validPfxParameters -Verbose } | Should Not Throw
}
It 'should call the expected mocks' {
Assert-MockCalled -CommandName Find-Certificate -Exactly -Times 1
Assert-MockCalled -CommandName Export-Certificate -Exactly -Times 0
Assert-MockCalled -CommandName Export-PfxCertificate -Exactly -Times 1
}
}
}
Describe "$DSCResourceName\Test-TargetResource" {
BeforeEach {
Mock `
-CommandName Find-Certificate `
-MockWith $mockFindCertificate
}
Context 'Certificate is not found' {
Mock `
-CommandName Test-Path
Mock `
-CommandName New-Object
It 'should return true' {
Test-TargetResource @validCertificateNotFoundParameters -Verbose | Should Be $true
}
It 'should call the expected mocks' {
Assert-MockCalled -CommandName Find-Certificate -Exactly -Times 1
Assert-MockCalled -CommandName Test-Path -Exactly -Times 0
Assert-MockCalled -CommandName New-Object -Exactly -Times 0
}
}
Context 'Certificate is found and needs to be exported as Cert and has not been exported' {
Mock `
-CommandName Test-Path `
-MockWith { $false }
Mock `
-CommandName New-Object
It 'should return false' {
Test-TargetResource @validCertificateParameters -Verbose | Should Be $false
}
It 'should call the expected mocks' {
Assert-MockCalled -CommandName Find-Certificate -Exactly -Times 1
Assert-MockCalled -CommandName Test-Path -Exactly -Times 1
Assert-MockCalled -CommandName New-Object -Exactly -Times 0
}
}
Context 'Certificate is found and needs to be exported as Cert but already exported and MatchSource False' {
Mock `
-CommandName Test-Path `
-MockWith { $true }
Mock `
-CommandName New-Object
It 'should return true' {
Test-TargetResource @validCertificateParameters -Verbose | Should Be $true
}
It 'should call the expected mocks' {
Assert-MockCalled -CommandName Find-Certificate -Exactly -Times 1
Assert-MockCalled -CommandName Test-Path -Exactly -Times 1
Assert-MockCalled -CommandName New-Object -Exactly -Times 0
}
}
Context 'Certificate is found and needs to be exported as Cert but already exported and MatchSource True and matches' {
Mock `
-CommandName Test-Path `
-MockWith { $true }
Mock `
-CommandName New-Object `
-MockWith { $importedCertificateMatch }
It 'should return true' {
Test-TargetResource @validCertificateMatchSourceParameters -Verbose | Should Be $true
}
It 'should call the expected mocks' {
Assert-MockCalled -CommandName Find-Certificate -Exactly -Times 1
Assert-MockCalled -CommandName Test-Path -Exactly -Times 1
Assert-MockCalled -CommandName New-Object -Exactly -Times 1
}
}
Context 'Certificate is found and needs to be exported as Cert but already exported and MatchSource True but no match' {
Mock `
-CommandName Test-Path `
-MockWith { $true }
Mock `
-CommandName New-Object `
-MockWith { $importedCertificateNoMatch }
It 'should return false' {
Test-TargetResource @validCertificateMatchSourceParameters -Verbose | Should Be $false
}
It 'should call the expected mocks' {
Assert-MockCalled -CommandName Find-Certificate -Exactly -Times 1
Assert-MockCalled -CommandName Test-Path -Exactly -Times 1
Assert-MockCalled -CommandName New-Object -Exactly -Times 1
}
}
Context 'Certificate is found and needs to be exported as Pfx but already exported and MatchSource True and matches' {
Mock `
-CommandName Test-Path `
-MockWith { $true }
Mock `
-CommandName New-Object `
-MockWith { $importedCertificateMatch }
It 'should return true' {
Test-TargetResource @validPfxMatchSourceParameters -Verbose | Should Be $true
}
It 'should call the expected mocks' {
Assert-MockCalled -CommandName Find-Certificate -Exactly -Times 1
Assert-MockCalled -CommandName Test-Path -Exactly -Times 1
Assert-MockCalled -CommandName New-Object -Exactly -Times 1
}
}
Context 'Certificate is found and needs to be exported as Pfx but already exported and MatchSource True but no match' {
Mock `
-CommandName Test-Path `
-MockWith { $true }
Mock `
-CommandName New-Object `
-MockWith { $importedCertificateNoMatch }
It 'should return false' {
Test-TargetResource @validPfxMatchSourceParameters -Verbose | Should Be $false
}
It 'should call the expected mocks' {
Assert-MockCalled -CommandName Find-Certificate -Exactly -Times 1
Assert-MockCalled -CommandName Test-Path -Exactly -Times 1
Assert-MockCalled -CommandName New-Object -Exactly -Times 1
}
}
}
}
}
finally
{
#region FOOTER
Restore-TestEnvironment -TestEnvironment $TestEnvironment
#endregion
}
|
PowerShellCorpus/PowerShellGallery/xCertificate/2.7.0.0/Tests/Unit/MSFT_xCertificateImport.Tests.ps1
|
MSFT_xCertificateImport.Tests.ps1
|
$script:DSCModuleName = 'xCertificate'
$script:DSCResourceName = 'MSFT_xCertificateImport'
#region HEADER
# Integration Test Template Version: 1.1.0
[String] $script:moduleRoot = Split-Path -Parent (Split-Path -Parent $PSScriptRoot)
if ( (-not (Test-Path -Path (Join-Path -Path $script:moduleRoot -ChildPath 'DSCResource.Tests'))) -or `
(-not (Test-Path -Path (Join-Path -Path $script:moduleRoot -ChildPath 'DSCResource.Tests\TestHelper.psm1'))) )
{
& git @('clone','https://github.com/PowerShell/DscResource.Tests.git',(Join-Path -Path $script:moduleRoot -ChildPath '\DSCResource.Tests\'))
}
Import-Module (Join-Path -Path $script:moduleRoot -ChildPath 'DSCResource.Tests\TestHelper.psm1') -Force
$TestEnvironment = Initialize-TestEnvironment `
-DSCModuleName $script:DSCModuleName `
-DSCResourceName $script:DSCResourceName `
-TestType Unit
#endregion
# Begin Testing
try
{
InModuleScope $script:DSCResourceName {
$DSCResourceName = 'MSFT_xCertificateImport'
$validThumbprint = (
[System.AppDomain]::CurrentDomain.GetAssemblies().GetTypes() | Where-Object {
$_.BaseType.BaseType -eq [System.Security.Cryptography.HashAlgorithm] -and
($_.Name -cmatch 'Managed$' -or $_.Name -cmatch 'Provider$')
} | Select-Object -First 1 | ForEach-Object {
(New-Object $_).ComputeHash([String]::Empty) | ForEach-Object {
'{0:x2}' -f $_
}
}
) -join ''
$testFile = 'test.cer'
$validPath = "TestDrive:\$testFile"
$validCertPath = "Cert:\LocalMachine\My"
$PresentParams = @{
Thumbprint = $validThumbprint
Path = $validPath
Ensure = 'Present'
Location = 'LocalMachine'
Store = 'My'
}
$AbsentParams = @{
Thumbprint = $validThumbprint
Path = $validPath
Ensure = 'Absent'
Location = 'LocalMachine'
Store = 'My'
}
Describe "$DSCResourceName\Get-TargetResource" {
$null | Set-Content -Path $validPath
$result = Get-TargetResource @PresentParams
It 'should return a hashtable' {
($result -is [hashtable]) | Should Be $true
}
It 'should contain the input values' {
$result.Thumbprint | Should BeExactly $validThumbprint
$result.Path | Should BeExactly $validPath
}
}
Describe "$DSCResourceName\Test-TargetResource" {
$null | Set-Content -Path $validPath
It 'should return a bool' {
Test-TargetResource @PresentParams | Should BeOfType Boolean
}
It 'returns false when valid path + thumbprint and certificate is not in store but should be' {
Mock Get-TargetResource {
return @{
Thumbprint = $validThumbprint
Path = $validPath
Ensure = 'Absent'
}
}
Test-TargetResource @PresentParams | Should Be $false
}
It 'returns true when valid path + thumbprint and certificate is not in store and should not be' {
Mock Get-TargetResource {
return @{
Thumbprint = $validThumbprint
Path = $validPath
Ensure = 'Absent'
}
}
Test-TargetResource @AbsentParams | Should Be $true
}
It 'returns true when valid path + thumbprint and certificate is in store and should be' {
Mock Get-TargetResource {
return @{
Thumbprint = $validThumbprint
Path = $validPath
Ensure = 'Present'
}
}
Test-TargetResource @PresentParams | Should Be $true
}
It 'returns false when valid path + thumbprint and certificate is in store but should not be' {
Mock Get-TargetResource {
return @{
Thumbprint = $validThumbprint
Path = $validPath
Ensure = 'Present'
}
}
Test-TargetResource @AbsentParams | Should Be $false
}
}
Describe "$DSCResourceName\Set-TargetResource" {
$null | Set-Content -Path $validPath
Mock Import-Certificate
Mock Get-ChildItem
Mock Remove-Item
Context "Valid path + thumbprint and Ensure is Present" {
Set-TargetResource @PresentParams
It 'calls Import-Certificate with the parameters supplied' {
Assert-MockCalled Import-Certificate -Exactly 1 -ParameterFilter {
$CertStoreLocation -eq $validCertPath -and `
$FilePath -eq $validPath
}
}
It 'does not call Get-ChildItem' {
Assert-MockCalled Get-ChildItem -Exactly 0
}
It 'does not call Remove-Item' {
Assert-MockCalled Remove-Item -Exactly 0
}
}
Mock Get-ChildItem -MockWith { Get-Item -Path $validPath }
Mock Where-Object -MockWith { Get-Item -Path $validPath }
Mock Remove-Item
Context "Valid path + thumbprint and Ensure is Absent" {
Set-TargetResource @AbsentParams
It 'does not call Import-Certificate' {
Assert-MockCalled Import-Certificate -Exactly 0
}
It 'calls Get-ChildItem' {
Assert-MockCalled Get-ChildItem -Exactly 1
}
It 'calls Remove-Item' {
Assert-MockCalled Remove-Item -Exactly 1
}
}
}
}
}
finally
{
#region FOOTER
Restore-TestEnvironment -TestEnvironment $TestEnvironment
#endregion
}
|
PowerShellCorpus/PowerShellGallery/xCertificate/2.7.0.0/Tests/Unit/CertificateDsc.Common.Tests.ps1
|
CertificateDsc.Common.Tests.ps1
|
$script:ModuleName = 'CertificateDsc.Common'
#region HEADER
# Unit Test Template Version: 1.1.0
[string] $script:moduleRoot = Split-Path -Parent (Split-Path -Parent (Split-Path -Parent $Script:MyInvocation.MyCommand.Path))
if ( (-not (Test-Path -Path (Join-Path -Path $script:moduleRoot -ChildPath 'DSCResource.Tests'))) -or `
(-not (Test-Path -Path (Join-Path -Path $script:moduleRoot -ChildPath 'DSCResource.Tests\TestHelper.psm1'))) )
{
& git @('clone','https://github.com/PowerShell/DscResource.Tests.git',(Join-Path -Path $script:moduleRoot -ChildPath '\DSCResource.Tests\'))
}
Import-Module -Name (Join-Path -Path $script:moduleRoot -ChildPath 'DSCResource.Tests\TestHelper.psm1') -Force
Import-Module -Name (Join-Path -Path (Join-Path -Path $script:moduleRoot -ChildPath (Join-Path -Path 'Modules' -ChildPath $script:ModuleName)) -ChildPath "$script:ModuleName.psm1") -Force
Import-Module -Name (Join-Path -Path (Join-Path -Path (Split-Path $PSScriptRoot -Parent) -ChildPath 'TestHelpers') -ChildPath 'CommonTestHelper.psm1') -Global
#endregion HEADER
# Begin Testing
try
{
InModuleScope $script:ModuleName {
$DSCResourceName = 'CertificateDsc.Common'
$invalidThumbprint = 'Zebra'
$validThumbprint = (
[System.AppDomain]::CurrentDomain.GetAssemblies().GetTypes() | Where-Object {
$_.BaseType.BaseType -eq [System.Security.Cryptography.HashAlgorithm] -and
($_.Name -cmatch 'Managed$' -or $_.Name -cmatch 'Provider$')
} | Select-Object -First 1 | ForEach-Object {
(New-Object $_).ComputeHash([String]::Empty) | ForEach-Object {
'{0:x2}' -f $_
}
}
) -join ''
$testFile = 'test.pfx'
$invalidPath = 'TestDrive:'
$validPath = "TestDrive:\$testFile"
$cerFileWithSan = "
-----BEGIN CERTIFICATE-----
MIIGJDCCBAygAwIBAgITewAAAAqQ+bxgiZZPtgAAAAAACjANBgkqhkiG9w0BAQsF
ADBDMRMwEQYKCZImiZPyLGQBGRYDY29tMRcwFQYKCZImiZPyLGQBGRYHY29udG9z
bzETMBEGA1UEAwwKTGFiUm9vdENBMTAeFw0xNzA1MDkxNTM5NTJaFw0xOTA1MDkx
NTM5NTJaMBYxFDASBgNVBAMMC3NvbWVtYWNoaW5lMIIBIjANBgkqhkiG9w0BAQEF
AAOCAQ8AMIIBCgKCAQEA0Id9FC2vq90HPWraZnAouit8MZI/p/DeucFiCb6mieuP
017DPCiQKuMQFQmx5VWvv82mpddxmTPtV6zfda0E5R12a11KHJ2mJrK5oR2iuI/I
P2SJBlNAkLTsvd96zUqQcWCCE/Q2nSrK7nx3oBq4Dd5+wLfUvAMKR45RXK58J4z5
h3mLxF+ryKnQzQHKXDC4x92hMIPJVwvPym8C3067Ry6kLHhFOk5IoJjiRmS6P1TT
48aHipWeiK9G/aLgKTS4UEbUMooAPfeHQXGRfS4fIEQmaaeY0wqQAVYGau2oDn6m
31SiNEA+NmAmHZFvM2kXf63L58lJASFqRnXquVCw9QIDAQABo4ICPDCCAjgwIQYJ
KwYBBAGCNxQCBBQeEgBXAGUAYgBTAGUAcgB2AGUAcjATBgNVHSUEDDAKBggrBgEF
BQcDATAOBgNVHQ8BAf8EBAMCBaAwHQYDVR0OBBYEFGFGkDLulJ3m1Bx3DIa1BosB
WpOXMCgGA1UdEQQhMB+CCGZpcnN0c2FugglzZWNvbmRzYW6CCHRoaXJkc2FuMB8G
A1UdIwQYMBaAFN75yc566Q03FdJ4ZQ/6Kn8dohYVMIHEBgNVHR8Egbwwgbkwgbag
gbOggbCGga1sZGFwOi8vL0NOPUxhYlJvb3RDQTEsQ049Q0ExLENOPUNEUCxDTj1Q
dWJsaWMlMjBLZXklMjBTZXJ2aWNlcyxDTj1TZXJ2aWNlcyxDTj1Db25maWd1cmF0
aW9uLERDPWNvbnRvc28sREM9Y29tP2NlcnRpZmljYXRlUmV2b2NhdGlvbkxpc3Q/
YmFzZT9vYmplY3RDbGFzcz1jUkxEaXN0cmlidXRpb25Qb2ludDCBvAYIKwYBBQUH
AQEEga8wgawwgakGCCsGAQUFBzAChoGcbGRhcDovLy9DTj1MYWJSb290Q0ExLENO
PUFJQSxDTj1QdWJsaWMlMjBLZXklMjBTZXJ2aWNlcyxDTj1TZXJ2aWNlcyxDTj1D
b25maWd1cmF0aW9uLERDPWNvbnRvc28sREM9Y29tP2NBQ2VydGlmaWNhdGU/YmFz
ZT9vYmplY3RDbGFzcz1jZXJ0aWZpY2F0aW9uQXV0aG9yaXR5MA0GCSqGSIb3DQEB
CwUAA4ICAQBUkvBdMgZsUHDEaVyBuHzALExcEflkvCq1AmJ1U2nixnfcqc5Wb3df
W+gauW+YbOA9EfQrwPqMXvo0dhsjLn3H5tTWe0VVT5H8pgsdcXS/5cYDjoC6N3pd
NZGCDN/oHAm8BgcNPPYyG8VDMxR+atp8Iv12nCDGQlpPkANK+nUHR8Nu66l/wDqF
G8ftnQ7C3mSu4/baAFOAx91rXDbrs1ewrqfcBWxRQn4CZbZs9LMg+NQjrAM8WtQX
DZd96IMY6m8DeVbIQQiHytpjpQr8aJs6s5Cd5XzRWPXb4lDMOe/4KwpyQAHjtFPY
mYhUfaInXtna/li9MKLK+j641FnBJv6bjWhw1Jp++wHdjef+1RTtG1hslHQXsH48
+n+jHZ5A5DKgOYUJWq3NhYvQwtQmDlBNe5aJbTmAFz7qpsPFWjoOqX8RXCE3Mt+R
EhwMvEGNZHdsgMVXeJsqVssG2FfM7cqcslaUL/vULRWJ6LmJerjmSBRXcEHL6uTe
IJPSLdUdPx7uvm+P4qpuIuzZ2bdHXqiFbL6yPyWi8lTaApzT/K7Y0Q3oRWYOuThK
P2l4M+F7l346gaIDDZOXdrSsrPghSgkS4Xp3QtE6NnKq+V0pX2YHnns+JO97hEXt
2EvKX3TnKnUPPrsl/CffTBpJEsD7xugu6OAn4KnEzzVTNYqzDbYx6g==
-----END CERTIFICATE-----
"
$cerFileWithoutSan = "
-----BEGIN CERTIFICATE-----
MIIDBjCCAe6gAwIBAgIQRQyErZRGrolI5DfZCJDaTTANBgkqhkiG9w0BAQsFADAW
MRQwEgYDVQQDDAtTb21lU2VydmVyMjAeFw0xNzA1MDkxNjI0MTZaFw0xODA1MDkx
NjQ0MTZaMBYxFDASBgNVBAMMC1NvbWVTZXJ2ZXIyMIIBIjANBgkqhkiG9w0BAQEF
AAOCAQ8AMIIBCgKCAQEA2x7gR/yQYSiqszd0+e3ZMX2b/mK3XwwEHhoXARoC/Jv/
rmOmESB6AYabIheGmDv2qUESx6r8KtO4afunVEyoxeThQ8LffgduSo0YIUVgqyg9
o+HUOaV4MX5cGutgov62MCs+HO2AYcl2QvmbJ9CF/nyGOigoLNOX1pLPHHM1vIFQ
euBCX8KGK02kgl629QVckiUKrn5bCjboxx7JvSsb2UTcCDjR7x1FcGkxwj069koq
VdtmwzC3ibYSxQ2UQo1rShol8FPTMkpf8NIZmApY3RGddnAl+r0fznbqqdwzRPjp
1zXuNwYiG/cL/OOt50TQqCKA7CrD9m8Y3yWKK1ilOQIDAQABo1AwTjAOBgNVHQ8B
Af8EBAMCBaAwHQYDVR0lBBYwFAYIKwYBBQUHAwIGCCsGAQUFBwMBMB0GA1UdDgQW
BBSfthQiQydgIs0dXquThRhnkj78HTANBgkqhkiG9w0BAQsFAAOCAQEAuaACrNbE
clIxVjSsJA4kT7z+ajTD7EmT3iX+h1sOABTuiSjR+fBCF/7AgViK24+xdLzuptCH
MnoLW7epdP1tRXjs0vb5xwXRsTruwlIzCbvkH8/xkrc6YGw5LzdvxtFPYV+vSsx3
uUmNlrD7ElllzRVzyGBd2VBm8hCAI0297Ls9zJlWDPYTMpedleO2D9vZBAxg3iY7
yiMbficleMbVEE3LTNjK6iYuENZ4KOBkOJU936+lqfcVnOFTvWhLJKxTEMZ7XW4k
pP3LiEhYnnxMfm7OyNHL+MnQhq8OV7tY3pZofPdImEeG13qcV8EBYhefFgsSxQRe
JqptPVHBXySjMg==
-----END CERTIFICATE-----
"
$cerBytes = [System.Text.Encoding]::ASCII.GetBytes($cerFileWithSan)
$cerBytesWithoutSan = [System.Text.Encoding]::ASCII.GetBytes($cerFileWithoutSan)
$testCertificate = [System.Security.Cryptography.X509Certificates.X509Certificate2]::new($cerBytes)
$testCertificateWithoutSan = [System.Security.Cryptography.X509Certificates.X509Certificate2]::new($cerBytesWithoutSan)
Describe "$DSCResourceName\Test-CertificatePath" {
$null | Set-Content -Path $validPath
Context 'a single existing file by parameter' {
$result = Test-CertificatePath -Path $validPath
It 'should return true' {
($result -is [bool]) | Should Be $true
$result | Should Be $true
}
}
Context 'a single missing file by parameter' {
It 'should throw an exception' {
# directories are not valid
{ Test-CertificatePath -Path $invalidPath } | Should Throw
}
}
Context 'a single missing file by parameter with -Quiet' {
$result = Test-CertificatePath -Path $invalidPath -Quiet
It 'should return false' {
($result -is [bool]) | Should Be $true
$result | Should Be $false
}
}
Context 'a single existing file by pipeline' {
$result = $validPath | Test-CertificatePath
It 'should return true' {
($result -is [bool]) | Should Be $true
$result | Should Be $true
}
}
Context 'a single missing file by pipeline' {
It 'should throw an exception' {
# directories are not valid
{ $invalidPath | Test-CertificatePath } | Should Throw
}
}
Context 'a single missing file by pipeline with -Quiet' {
$result = $invalidPath | Test-CertificatePath -Quiet
It 'should return false' {
($result -is [bool]) | Should Be $true
$result | Should Be $false
}
}
}
Describe "$DSCResourceName\Test-Thumbprint" {
Context 'a single valid thumbrpint by parameter' {
$result = Test-Thumbprint -Thumbprint $validThumbprint
It 'should return true' {
($result -is [bool]) | Should Be $true
$result | Should Be $true
}
}
Context 'a single invalid thumbprint by parameter' {
It 'should throw an exception' {
# directories are not valid
{ Test-Thumbprint -Thumbprint $invalidThumbprint } | Should Throw
}
}
Context 'a single invalid thumbprint by parameter with -Quiet' {
$result = Test-Thumbprint $invalidThumbprint -Quiet
It 'should return false' {
($result -is [bool]) | Should Be $true
$result | Should Be $false
}
}
Context 'a single valid thumbprint by pipeline' {
$result = $validThumbprint | Test-Thumbprint
It 'should return true' {
($result -is [bool]) | Should Be $true
$result | Should Be $true
}
}
Context 'a single invalid thumborint by pipeline' {
It 'should throw an exception' {
# directories are not valid
{ $invalidThumbprint | Test-Thumbprint } | Should Throw
}
}
Context 'a single invalid thumbprint by pipeline with -Quiet' {
$result = $invalidThumbprint | Test-Thumbprint -Quiet
It 'should return false' {
($result -is [bool]) | Should Be $true
$result | Should Be $false
}
}
}
Describe "$DSCResourceName\Find-Certificate" {
# Download and dot source the New-SelfSignedCertificateEx script
. (Install-NewSelfSignedCertificateExScript)
# Generate the Valid certificate for testing but remove it from the store straight away
$certDNSNames = @('www.fabrikam.com', 'www.contoso.com')
$certDNSNamesReverse = @('www.contoso.com', 'www.fabrikam.com')
$certDNSNamesNoMatch = $certDNSNames + @('www.nothere.com')
$certKeyUsage = @('DigitalSignature','DataEncipherment')
$certKeyUsageReverse = @('DataEncipherment','DigitalSignature')
$certKeyUsageNoMatch = $certKeyUsage + @('KeyEncipherment')
$certEKU = @('Server Authentication','Client authentication')
$certEKUReverse = @('Client authentication','Server Authentication')
$certEKUNoMatch = $certEKU + @('Encrypting File System')
$certSubject = 'CN=contoso, DC=com'
$certFriendlyName = 'Contoso Test Cert'
$validCert = New-SelfSignedCertificateEx `
-Subject $certSubject `
-KeyUsage $certKeyUsage `
-KeySpec 'Exchange' `
-EKU $certEKU `
-SubjectAlternativeName $certDNSNames `
-FriendlyName $certFriendlyName `
-StoreLocation 'CurrentUser' `
-Exportable
# Pull the generated certificate from the store so we have the friendlyname
$validThumbprint = $validCert.Thumbprint
$validCert = Get-Item -Path "cert:\CurrentUser\My\$validThumbprint"
Remove-Item -Path $validCert.PSPath -Force
# Generate the Expired certificate for testing but remove it from the store straight away
$expiredCert = New-SelfSignedCertificateEx `
-Subject $certSubject `
-KeyUsage $certKeyUsage `
-KeySpec 'Exchange' `
-EKU $certEKU `
-SubjectAlternativeName $certDNSNames `
-FriendlyName $certFriendlyName `
-NotBefore ((Get-Date) - (New-TimeSpan -Days 2)) `
-NotAfter ((Get-Date) - (New-TimeSpan -Days 1)) `
-StoreLocation 'CurrentUser' `
-Exportable
# Pull the generated certificate from the store so we have the friendlyname
$expiredThumbprint = $expiredCert.Thumbprint
$expiredCert = Get-Item -Path "cert:\CurrentUser\My\$expiredThumbprint"
Remove-Item -Path $expiredCert.PSPath -Force
$nocertThumbprint = '1111111111111111111111111111111111111111'
# Dynamic mock content for Get-ChildItem
$mockGetChildItem = {
switch ( $Path )
{
'cert:\LocalMachine\My'
{
return @( $validCert )
}
'cert:\LocalMachine\NoCert'
{
return @()
}
'cert:\LocalMachine\TwoCerts'
{
return @( $expiredCert, $validCert )
}
'cert:\LocalMachine\Expired'
{
return @( $expiredCert )
}
default
{
throw 'mock called with unexpected value {0}' -f $Path
}
}
}
BeforeEach {
Mock `
-CommandName Test-Path `
-MockWith { $true }
Mock `
-CommandName Get-ChildItem `
-MockWith $mockGetChildItem
}
Context 'Thumbprint only is passed and matching certificate exists' {
It 'should not throw exception' {
{ $script:result = Find-Certificate -Thumbprint $validThumbprint } | Should Not Throw
}
It 'should return expected certificate' {
$script:result.Thumbprint | Should Be $validThumbprint
}
It 'should call expected mocks' {
Assert-MockCalled -CommandName Test-Path -Exactly -Times 1
Assert-MockCalled -CommandName Get-ChildItem -Exactly -Times 1
}
}
Context 'Thumbprint only is passed and matching certificate does not exist' {
It 'should not throw exception' {
{ $script:result = Find-Certificate -Thumbprint $nocertThumbprint } | Should Not Throw
}
It 'should return null' {
$script:result | Should BeNullOrEmpty
}
It 'should call expected mocks' {
Assert-MockCalled -CommandName Test-Path -Exactly -Times 1
Assert-MockCalled -CommandName Get-ChildItem -Exactly -Times 1
}
}
Context 'FriendlyName only is passed and matching certificate exists' {
It 'should not throw exception' {
{ $script:result = Find-Certificate -FriendlyName $certFriendlyName } | Should Not Throw
}
It 'should return expected certificate' {
$script:result.Thumbprint | Should Be $validThumbprint
}
It 'should call expected mocks' {
Assert-MockCalled -CommandName Test-Path -Exactly -Times 1
Assert-MockCalled -CommandName Get-ChildItem -Exactly -Times 1
}
}
Context 'FriendlyName only is passed and matching certificate does not exist' {
It 'should not throw exception' {
{ $script:result = Find-Certificate -FriendlyName 'Does Not Exist' } | Should Not Throw
}
It 'should return null' {
$script:result | Should BeNullOrEmpty
}
It 'should call expected mocks' {
Assert-MockCalled -CommandName Test-Path -Exactly -Times 1
Assert-MockCalled -CommandName Get-ChildItem -Exactly -Times 1
}
}
Context 'Subject only is passed and matching certificate exists' {
It 'should not throw exception' {
{ $script:result = Find-Certificate -Subject $certSubject } | Should Not Throw
}
It 'should return expected certificate' {
$script:result.Thumbprint | Should Be $validThumbprint
}
It 'should call expected mocks' {
Assert-MockCalled -CommandName Test-Path -Exactly -Times 1
Assert-MockCalled -CommandName Get-ChildItem -Exactly -Times 1
}
}
Context 'Subject only is passed and matching certificate does not exist' {
It 'should not throw exception' {
{ $script:result = Find-Certificate -Subject 'CN=Does Not Exist' } | Should Not Throw
}
It 'should return null' {
$script:result | Should BeNullOrEmpty
}
It 'should call expected mocks' {
Assert-MockCalled -CommandName Test-Path -Exactly -Times 1
Assert-MockCalled -CommandName Get-ChildItem -Exactly -Times 1
}
}
Context 'Issuer only is passed and matching certificate exists' {
It 'should not throw exception' {
{ $script:result = Find-Certificate -Issuer $certSubject } | Should Not Throw
}
It 'should return expected certificate' {
$script:result.Thumbprint | Should Be $validThumbprint
}
It 'should call expected mocks' {
Assert-MockCalled -CommandName Test-Path -Exactly -Times 1
Assert-MockCalled -CommandName Get-ChildItem -Exactly -Times 1
}
}
Context 'Issuer only is passed and matching certificate does not exist' {
It 'should not throw exception' {
{ $script:result = Find-Certificate -Issuer 'CN=Does Not Exist' } | Should Not Throw
}
It 'should return null' {
$script:result | Should BeNullOrEmpty
}
It 'should call expected mocks' {
Assert-MockCalled -CommandName Test-Path -Exactly -Times 1
Assert-MockCalled -CommandName Get-ChildItem -Exactly -Times 1
}
}
Context 'DNSName only is passed and matching certificate exists' {
It 'should not throw exception' {
{ $script:result = Find-Certificate -DnsName $certDNSNames } | Should Not Throw
}
It 'should return expected certificate' {
$script:result.Thumbprint | Should Be $validThumbprint
}
It 'should call expected mocks' {
Assert-MockCalled -CommandName Test-Path -Exactly -Times 1
Assert-MockCalled -CommandName Get-ChildItem -Exactly -Times 1
}
}
Context 'DNSName only is passed in reversed order and matching certificate exists' {
It 'should not throw exception' {
{ $script:result = Find-Certificate -DnsName $certDNSNamesReverse } | Should Not Throw
}
It 'should return expected certificate' {
$script:result.Thumbprint | Should Be $validThumbprint
}
It 'should call expected mocks' {
Assert-MockCalled -CommandName Test-Path -Exactly -Times 1
Assert-MockCalled -CommandName Get-ChildItem -Exactly -Times 1
}
}
Context 'DNSName only is passed with only one matching DNS name and matching certificate exists' {
It 'should not throw exception' {
{ $script:result = Find-Certificate -DnsName $certDNSNames[0] } | Should Not Throw
}
It 'should return expected certificate' {
$script:result.Thumbprint | Should Be $validThumbprint
}
It 'should call expected mocks' {
Assert-MockCalled -CommandName Test-Path -Exactly -Times 1
Assert-MockCalled -CommandName Get-ChildItem -Exactly -Times 1
}
}
Context 'DNSName only is passed but an entry is missing and matching certificate does not exist' {
It 'should not throw exception' {
{ $script:result = Find-Certificate -DnsName $certDNSNamesNoMatch } | Should Not Throw
}
It 'should return null' {
$script:result | Should BeNullOrEmpty
}
It 'should call expected mocks' {
Assert-MockCalled -CommandName Test-Path -Exactly -Times 1
Assert-MockCalled -CommandName Get-ChildItem -Exactly -Times 1
}
}
Context 'KeyUsage only is passed and matching certificate exists' {
It 'should not throw exception' {
{ $script:result = Find-Certificate -KeyUsage $certKeyUsage } | Should Not Throw
}
It 'should return expected certificate' {
$script:result.Thumbprint | Should Be $validThumbprint
}
It 'should call expected mocks' {
Assert-MockCalled -CommandName Test-Path -Exactly -Times 1
Assert-MockCalled -CommandName Get-ChildItem -Exactly -Times 1
}
}
Context 'KeyUsage only is passed in reversed order and matching certificate exists' {
It 'should not throw exception' {
{ $script:result = Find-Certificate -KeyUsage $certKeyUsageReverse } | Should Not Throw
}
It 'should return expected certificate' {
$script:result.Thumbprint | Should Be $validThumbprint
}
It 'should call expected mocks' {
Assert-MockCalled -CommandName Test-Path -Exactly -Times 1
Assert-MockCalled -CommandName Get-ChildItem -Exactly -Times 1
}
}
Context 'KeyUsage only is passed with only one matching DNS name and matching certificate exists' {
It 'should not throw exception' {
{ $script:result = Find-Certificate -KeyUsage $certKeyUsage[0] } | Should Not Throw
}
It 'should return expected certificate' {
$script:result.Thumbprint | Should Be $validThumbprint
}
It 'should call expected mocks' {
Assert-MockCalled -CommandName Test-Path -Exactly -Times 1
Assert-MockCalled -CommandName Get-ChildItem -Exactly -Times 1
}
}
Context 'KeyUsage only is passed but an entry is missing and matching certificate does not exist' {
It 'should not throw exception' {
{ $script:result = Find-Certificate -KeyUsage $certKeyUsageNoMatch } | Should Not Throw
}
It 'should return null' {
$script:result | Should BeNullOrEmpty
}
It 'should call expected mocks' {
Assert-MockCalled -CommandName Test-Path -Exactly -Times 1
Assert-MockCalled -CommandName Get-ChildItem -Exactly -Times 1
}
}
Context 'EnhancedKeyUsage only is passed and matching certificate exists' {
It 'should not throw exception' {
{ $script:result = Find-Certificate -EnhancedKeyUsage $certEKU } | Should Not Throw
}
It 'should return expected certificate' {
$script:result.Thumbprint | Should Be $validThumbprint
}
It 'should call expected mocks' {
Assert-MockCalled -CommandName Test-Path -Exactly -Times 1
Assert-MockCalled -CommandName Get-ChildItem -Exactly -Times 1
}
}
Context 'EnhancedKeyUsage only is passed in reversed order and matching certificate exists' {
It 'should not throw exception' {
{ $script:result = Find-Certificate -EnhancedKeyUsage $certEKUReverse } | Should Not Throw
}
It 'should return expected certificate' {
$script:result.Thumbprint | Should Be $validThumbprint
}
It 'should call expected mocks' {
Assert-MockCalled -CommandName Test-Path -Exactly -Times 1
Assert-MockCalled -CommandName Get-ChildItem -Exactly -Times 1
}
}
Context 'EnhancedKeyUsage only is passed with only one matching DNS name and matching certificate exists' {
It 'should not throw exception' {
{ $script:result = Find-Certificate -EnhancedKeyUsage $certEKU[0] } | Should Not Throw
}
It 'should return expected certificate' {
$script:result.Thumbprint | Should Be $validThumbprint
}
It 'should call expected mocks' {
Assert-MockCalled -CommandName Test-Path -Exactly -Times 1
Assert-MockCalled -CommandName Get-ChildItem -Exactly -Times 1
}
}
Context 'EnhancedKeyUsage only is passed but an entry is missing and matching certificate does not exist' {
It 'should not throw exception' {
{ $script:result = Find-Certificate -EnhancedKeyUsage $certEKUNoMatch } | Should Not Throw
}
It 'should return null' {
$script:result | Should BeNullOrEmpty
}
It 'should call expected mocks' {
Assert-MockCalled -CommandName Test-Path -Exactly -Times 1
Assert-MockCalled -CommandName Get-ChildItem -Exactly -Times 1
}
}
Context 'Thumbprint only is passed and matching certificate does not exist in the store' {
It 'should not throw exception' {
{ $script:result = Find-Certificate -Thumbprint $validThumbprint -Store 'NoCert'} | Should Not Throw
}
It 'should return null' {
$script:result | Should BeNullOrEmpty
}
It 'should call expected mocks' {
Assert-MockCalled -CommandName Test-Path -Exactly -Times 1
Assert-MockCalled -CommandName Get-ChildItem -Exactly -Times 1
}
}
Context 'FriendlyName only is passed and both valid and expired certificates exist' {
It 'should not throw exception' {
{ $script:result = Find-Certificate -FriendlyName $certFriendlyName -Store 'TwoCerts' } | Should Not Throw
}
It 'should return expected certificate' {
$script:result.Thumbprint | Should Be $validThumbprint
}
It 'should call expected mocks' {
Assert-MockCalled -CommandName Test-Path -Exactly -Times 1
Assert-MockCalled -CommandName Get-ChildItem -Exactly -Times 1
}
}
Context 'FriendlyName only is passed and only expired certificates exist' {
It 'should not throw exception' {
{ $script:result = Find-Certificate -FriendlyName $certFriendlyName -Store 'Expired' } | Should Not Throw
}
It 'should return expected certificate' {
$script:result | Should BeNullOrEmpty
}
It 'should call expected mocks' {
Assert-MockCalled -CommandName Test-Path -Exactly -Times 1
Assert-MockCalled -CommandName Get-ChildItem -Exactly -Times 1
}
}
Context 'FriendlyName only is passed and only expired certificates exist but allowexpired passed' {
It 'should not throw exception' {
{ $script:result = Find-Certificate -FriendlyName $certFriendlyName -Store 'Expired' -AllowExpired:$true } | Should Not Throw
}
It 'should return expected certificate' {
$script:result.Thumbprint | Should Be $expiredThumbprint
}
It 'should call expected mocks' {
Assert-MockCalled -CommandName Test-Path -Exactly -Times 1
Assert-MockCalled -CommandName Get-ChildItem -Exactly -Times 1
}
}
}
Describe "$DSCResourceName\Find-CertificateAuthority" {
Mock -CommandName Get-CdpContainer -MockWith {
[CmdletBinding()]
param
(
$DomainName
)
return New-Object -TypeName psobject -Property @{
Children = @(
@{
distinguishedName = 'CN=CA1,CN=CDP,CN=Public Key Services,CN=Services,CN=Configuration,DC=contoso,DC=com'
Children = @{
distinguishedName = 'CN=LabRootCA1,CN=CA1,CN=CDP,CN=Public Key Services,CN=Services,CN=Configuration,DC=contoso,DC=com'
}
}
)
}
}
Mock -CommandName New-Object -ParameterFilter {$TypeName -eq 'System.Diagnostics.Process'} -MockWith {
$retObj = New-Object -TypeName psobject -Property @{
StartInfo = $null
ExitCode = 0
StandardOutput = New-Object psobject | Add-Member -MemberType ScriptMethod -Name ReadToEnd -Value {} -PassThru
}
$retObj | Add-Member -MemberType ScriptMethod -Name Start -Value {} -PassThru |
Add-Member -MemberType ScriptMethod -Name WaitForExit -Value {}
return $retObj
}
Context 'Function is executed with domain connectivity' {
It 'Should return the CA name' {
(Find-CertificateAuthority -DomainName contoso.com).CARootName | Should Be 'LabRootCA1'
}
It 'Should return the CA server fqdn' {
(Find-CertificateAuthority -DomainName contoso.com).CAServerFQDN | Should Be 'CA1'
}
It 'Should call Get-CdpContainer twice' {
Assert-MockCalled -CommandName Get-CdpContainer -Exactly -Times 2
}
}
Context 'Function is executed without domain connectivity' {
It 'Should throw' {
{ Find-CertificateAuthority -DomainName somewhere.overtherainbow -ErrorAction Stop -Verbose } | Should Throw
}
}
}
Describe "$DSCResourceName\Get-CertificateTemplateName" {
Context 'A certificate with a valid template name is used' {
It 'Should return the template name' {
Get-CertificateTemplateName -Certificate $testCertificate | Should Be 'WebServer'
}
}
Context 'A certificate with no template name is used' {
It 'Should return null' {
Get-CertificateTemplateName -Certificate $testCertificateWithoutSan | Should Be $null
}
}
}
Describe "$DSCResourceName\Get-CertificateSan" {
Context 'A certificate with a SAN is used' {
It 'Should return the SAN' {
Get-CertificateSan -Certificate $testCertificate | Should Be 'firstsan'
}
}
Context 'A certificate without SAN is used' {
It 'Should return null' {
Get-CertificateSan -Certificate $testCertificateWithoutSan | Should Be $null
}
}
}
}
}
finally
{
#region FOOTER
#endregion
}
|
PowerShellCorpus/PowerShellGallery/xCertificate/2.7.0.0/Tests/Unit/MSFT_xCertReq.Tests.ps1
|
MSFT_xCertReq.Tests.ps1
|
[System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidUsingConvertToSecureStringWithPlainText', '')]
param ()
$script:DSCModuleName = 'xCertificate'
$script:DSCResourceName = 'MSFT_xCertReq'
#region HEADER
# Integration Test Template Version: 1.1.0
[String] $script:moduleRoot = Split-Path -Parent (Split-Path -Parent $PSScriptRoot)
if ( (-not (Test-Path -Path (Join-Path -Path $script:moduleRoot -ChildPath 'DSCResource.Tests'))) -or `
(-not (Test-Path -Path (Join-Path -Path $script:moduleRoot -ChildPath 'DSCResource.Tests\TestHelper.psm1'))) )
{
& git @('clone','https://github.com/PowerShell/DscResource.Tests.git',(Join-Path -Path $script:moduleRoot -ChildPath '\DSCResource.Tests\'))
}
Import-Module (Join-Path -Path $script:moduleRoot -ChildPath 'DSCResource.Tests\TestHelper.psm1') -Force
$TestEnvironment = Initialize-TestEnvironment `
-DSCModuleName $script:DSCModuleName `
-DSCResourceName $script:DSCResourceName `
-TestType Unit
#endregion
# Begin Testing
try
{
InModuleScope $script:DSCResourceName {
$DSCResourceName = 'MSFT_xCertReq'
function Get-InvalidOperationError
{
[CmdletBinding()]
param
(
[Parameter(Mandatory)]
[ValidateNotNullOrEmpty()]
[System.String]
$ErrorId,
[Parameter(Mandatory)]
[ValidateNotNullOrEmpty()]
[System.String]
$ErrorMessage
)
$exception = New-Object -TypeName System.InvalidOperationException `
-ArgumentList $ErrorMessage
$errorCategory = [System.Management.Automation.ErrorCategory]::InvalidOperation
$errorRecord = New-Object -TypeName System.Management.Automation.ErrorRecord `
-ArgumentList $exception, $ErrorId, $errorCategory, $null
return $errorRecord
} # end function Get-InvalidOperationError
function Get-InvalidArgumentError
{
[CmdletBinding()]
param
(
[Parameter(Mandatory)]
[ValidateNotNullOrEmpty()]
[System.String]
$ErrorId,
[Parameter(Mandatory)]
[ValidateNotNullOrEmpty()]
[System.String]
$ErrorMessage
)
$exception = New-Object -TypeName System.ArgumentException `
-ArgumentList $ErrorMessage
$errorCategory = [System.Management.Automation.ErrorCategory]::InvalidArgument
$errorRecord = New-Object -TypeName System.Management.Automation.ErrorRecord `
-ArgumentList $exception, $ErrorId, $errorCategory, $null
return $errorRecord
} # end function Get-InvalidArgumentError
$validThumbprint = (
[System.AppDomain]::CurrentDomain.GetAssemblies().GetTypes() | Where-Object {
$_.BaseType.BaseType -eq [System.Security.Cryptography.HashAlgorithm] -and
($_.Name -cmatch 'Managed$' -or $_.Name -cmatch 'Provider$')
} | Select-Object -First 1 | ForEach-Object {
(New-Object $_).ComputeHash([String]::Empty) | ForEach-Object {
'{0:x2}' -f $_
}
}
) -join ''
$CAServerFQDN = 'rootca.contoso.com'
$CARootName = 'contoso-CA'
$validSubject = 'Test Subject'
$validIssuer = "CN=$CARootName, DC=contoso, DC=com"
$KeyLength = '1024'
$Exportable = $true
$ProviderName = '"Microsoft RSA SChannel Cryptographic Provider"'
$OID = '1.3.6.1.5.5.7.3.1'
$KeyUsage = '0xa0'
$CertificateTemplate = 'WebServer'
$SubjectAltUrl = 'contoso.com'
$SubjectAltName = "dns=$SubjectAltUrl"
$validCert = New-Object -TypeName PSObject -Property @{
Thumbprint = $validThumbprint
Subject = "CN=$validSubject"
Issuer = $validIssuer
NotBefore = (Get-Date).AddDays(-30) # Issued on
NotAfter = (Get-Date).AddDays(31) # Expires after
}
Add-Member -InputObject $validCert -MemberType ScriptMethod -Name Verify -Value {
return $true
}
$expiringCert = New-Object -TypeName PSObject -Property @{
Thumbprint = $validThumbprint
Subject = "CN=$validSubject"
Issuer = $validIssuer
NotBefore = (Get-Date).AddDays(-30) # Issued on
NotAfter = (Get-Date).AddDays(30) # Expires after
}
Add-Member -InputObject $expiringCert -MemberType ScriptMethod -Name Verify -Value {
return $true
}
$expiredCert = New-Object -TypeName PSObject -Property @{
Thumbprint = $validThumbprint
Subject = "CN=$validSubject"
Issuer = $validIssuer
NotBefore = (Get-Date).AddDays(-30) # Issued on
NotAfter = (Get-Date).AddDays(-1) # Expires after
}
Add-Member -InputObject $expiredCert -MemberType ScriptMethod -Name Verify -Value {
return $true
}
$sanOid = New-Object -TypeName System.Security.Cryptography.Oid -Property @{FriendlyName = 'Subject Alternative Name'}
$sanExt = @{
oid = $(,$sanOid)
Critical = $false
}
Add-Member -InputObject $sanExt -MemberType ScriptMethod -Name Format -Force -Value {
return "DNS Name=$SubjectAltUrl"
}
$validSANCert = New-Object -TypeName PSObject -Property @{
Thumbprint = $validThumbprint
Subject = "CN=$validSubject"
Issuer = $validIssuer
NotBefore = (Get-Date).AddDays(-30) # Issued on
NotAfter = (Get-Date).AddDays(31) # Expires after
Extensions = $sanExt
}
Add-Member -InputObject $validSANCert -MemberType ScriptMethod -Name Verify -Value {
return $true
}
$incorrectSanExt = @{
oid = $(,$sanOid)
Critical = $false
}
Add-Member -InputObject $incorrectSanExt -MemberType ScriptMethod -Name Format -Force -Value {
return "DNS Name=incorrect.com"
}
$incorrectSANCert = New-Object -TypeName PSObject -Property @{
Thumbprint = $validThumbprint
Subject = "CN=$validSubject"
Issuer = $validIssuer
NotBefore = (Get-Date).AddDays(-30) # Issued on
NotAfter = (Get-Date).AddDays(31) # Expires after
Extensions = $incorrectSanExt
}
Add-Member -InputObject $incorrectSANCert -MemberType ScriptMethod -Name Verify -Value {
return $true
}
$emptySANCert = New-Object -TypeName PSObject -Property @{
Thumbprint = $validThumbprint
Subject = "CN=$validSubject"
Issuer = $validIssuer
NotBefore = (Get-Date).AddDays(-30) # Issued on
NotAfter = (Get-Date).AddDays(31) # Expires after
Extensions = @()
}
Add-Member -InputObject $emptySANCert -MemberType ScriptMethod -Name Verify -Value {
return $true
}
$CAType = 'Enterprise'
$CepURL = 'DummyURL'
$CesURL = 'DummyURL'
$testUsername = 'DummyUsername'
$testPassword = 'DummyPassword'
$testCredential = New-Object System.Management.Automation.PSCredential $testUsername, (ConvertTo-SecureString $testPassword -AsPlainText -Force)
$Params = @{
Subject = $validSubject
CAServerFQDN = $CAServerFQDN
CARootName = $CARootName
KeyLength = $KeyLength
Exportable = $Exportable
ProviderName = $ProviderName
OID = $OID
KeyUsage = $KeyUsage
CertificateTemplate = $CertificateTemplate
Credential = $testCredential
AutoRenew = $False
}
$ParamsAutoDiscovery = @{
Subject = $validSubject
KeyLength = $KeyLength
Exportable = $Exportable
ProviderName = $ProviderName
OID = $OID
KeyUsage = $KeyUsage
CertificateTemplate = $CertificateTemplate
Credential = $testCredential
AutoRenew = $False
}
$ParamsAutoRenew = @{
Subject = $validSubject
CAServerFQDN = $CAServerFQDN
CARootName = $CARootName
KeyLength = $KeyLength
Exportable = $Exportable
ProviderName = $ProviderName
OID = $OID
KeyUsage = $KeyUsage
CertificateTemplate = $CertificateTemplate
Credential = $testCredential
AutoRenew = $True
}
$ParamsNoCred = @{
Subject = $validSubject
CAServerFQDN = $CAServerFQDN
CARootName = $CARootName
KeyLength = $KeyLength
Exportable = $Exportable
ProviderName = $ProviderName
OID = $OID
KeyUsage = $KeyUsage
CertificateTemplate = $CertificateTemplate
Credential = $null
AutoRenew = $False
}
$ParamsAutoRenewNoCred = @{
Subject = $validSubject
CAServerFQDN = $CAServerFQDN
CARootName = $CARootName
KeyLength = $KeyLength
Exportable = $Exportable
ProviderName = $ProviderName
OID = $OID
KeyUsage = $KeyUsage
CertificateTemplate = $CertificateTemplate
Credential = $null
AutoRenew = $True
}
$ParamsKeyLength4096NoCred = @{
Subject = $validSubject
CAServerFQDN = $CAServerFQDN
CARootName = $CARootName
KeyLength = '4096'
Exportable = $Exportable
ProviderName = $ProviderName
OID = $OID
KeyUsage = $KeyUsage
CertificateTemplate = $CertificateTemplate
Credential = $null
AutoRenew = $False
}
$ParamsKeyLength4096AutoRenewNoCred = @{
Subject = $validSubject
CAServerFQDN = $CAServerFQDN
CARootName = $CARootName
KeyLength = '4096'
Exportable = $Exportable
ProviderName = $ProviderName
OID = $OID
KeyUsage = $KeyUsage
CertificateTemplate = $CertificateTemplate
Credential = $null
AutoRenew = $True
}
$ParamsSubjectAltName = @{
Subject = $validSubject
CAServerFQDN = $CAServerFQDN
CARootName = $CARootName
KeyLength = $KeyLength
Exportable = $Exportable
ProviderName = $ProviderName
OID = $OID
KeyUsage = $KeyUsage
CertificateTemplate = $CertificateTemplate
Credential = $testCredential
SubjectAltName = $SubjectAltName
AutoRenew = $False
}
$ParamsSubjectAltNameNoCred = @{
Subject = $validSubject
CAServerFQDN = $CAServerFQDN
CARootName = $CARootName
KeyLength = $KeyLength
Exportable = $Exportable
ProviderName = $ProviderName
OID = $OID
KeyUsage = $KeyUsage
CertificateTemplate = $CertificateTemplate
Credential = $null
SubjectAltName = $SubjectAltName
AutoRenew = $False
}
$ParamsStandaloneWebEnrollment = @{
Subject = $validSubject
CAServerFQDN = $CAServerFQDN
CARootName = $CARootName
KeyLength = $KeyLength
Exportable = $Exportable
ProviderName = $ProviderName
OID = $OID
KeyUsage = $KeyUsage
CertificateTemplate = $CertificateTemplate
Credential = $testCredential
AutoRenew = $False
CAType = 'Standalone'
CepURL = $CepURL
CesURL = $CesURL
}
$ParamsEnterpriseWebEnrollment = @{
Subject = $validSubject
CAServerFQDN = $CAServerFQDN
CARootName = $CARootName
KeyLength = $KeyLength
Exportable = $Exportable
ProviderName = $ProviderName
OID = $OID
KeyUsage = $KeyUsage
CertificateTemplate = $CertificateTemplate
Credential = $testCredential
AutoRenew = $False
CAType = $CAType
CepURL = $CepURL
CesURL = $CesURL
}
$CertInf = @"
[NewRequest]
Subject = "CN=$validSubject"
KeySpec = 1
KeyLength = $KeyLength
Exportable = $($Exportable.ToString().ToUpper())
MachineKeySet = TRUE
SMIME = FALSE
PrivateKeyArchive = FALSE
UserProtected = FALSE
UseExistingKeySet = FALSE
ProviderName = $ProviderName
ProviderType = 12
RequestType = CMC
KeyUsage = $KeyUsage
[RequestAttributes]
CertificateTemplate = $CertificateTemplate
[EnhancedKeyUsageExtension]
OID = $OID
"@
$CertInfNoTemplate = $CertInf.Replace(@"
[RequestAttributes]
CertificateTemplate = $CertificateTemplate
[EnhancedKeyUsageExtension]
"@, '[EnhancedKeyUsageExtension]')
$CertInfKey = $CertInf -Replace 'KeyLength = ([0-z]*)', 'KeyLength = 4096'
$CertInfRenew = $Certinf
$CertInfRenew += @"
RenewalCert = $validThumbprint
"@
$CertInfKeyRenew = $CertInfRenew -Replace 'KeyLength = ([0-z]*)', 'KeyLength = 4096'
$CertInfSubjectAltName = $Certinf
$CertInfSubjectAltName += @"
[Extensions]
2.5.29.17 = "{text}$SubjectAltName"
"@
Describe "$DSCResourceName\Get-TargetResource" {
Mock Get-ChildItem -ParameterFilter { $Path -eq 'Cert:\LocalMachine\My' } `
-Mockwith { $validCert }
Mock Get-CertificateTemplateName -MockWith { $CertificateTemplate }
Mock Get-CertificateSan -MockWith { $SubjectAltName }
Mock -CommandName Find-CertificateAuthority -MockWith {
return New-Object -TypeName psobject -Property @{
CAServerFQDN = 'rootca.contoso.com'
CARootName = 'contoso-CA'
}
}
$result = Get-TargetResource @Params
$resultAutoDiscovery = Get-TargetResource @ParamsAutoDiscovery
It 'should return a hashtable' {
($result -is [hashtable]) | Should Be $true
}
It 'should contain the input values' {
$result.Subject | Should BeExactly $validSubject
$result.CAServerFQDN | Should BeNullOrEmpty
$result.CARootName | Should BeExactly $CARootName
$result.KeyLength | Should BeNullOrEmpty
$result.Exportable | Should BeNullOrEmpty
$result.ProviderName | Should BeNullOrEmpty
$result.OID | Should BeNullOrEmpty
$result.KeyUsage | Should BeNullOrEmpty
$result.CertificateTemplate | Should BeExactly $CertificateTemplate
$result.SubjectAltName | Should BeNullOrEmpty
}
It 'should return a hashtable' {
($resultAutoDiscovery -is [hashtable]) | Should Be $true
}
It 'should contain the input values and the CA should be auto-discovered' {
$resultAutoDiscovery.Subject | Should BeExactly $validSubject
$resultAutoDiscovery.CAServerFQDN | Should BeExactly $CAServerFQDN
$resultAutoDiscovery.CARootName | Should BeExactly $CARootName
$resultAutoDiscovery.KeyLength | Should BeNullOrEmpty
$resultAutoDiscovery.Exportable | Should BeNullOrEmpty
$resultAutoDiscovery.ProviderName | Should BeNullOrEmpty
$resultAutoDiscovery.OID | Should BeNullOrEmpty
$resultAutoDiscovery.KeyUsage | Should BeNullOrEmpty
$resultAutoDiscovery.CertificateTemplate | Should BeExactly $CertificateTemplate
$resultAutoDiscovery.SubjectAltName | Should BeNullOrEmpty
}
It 'Should call the mocked function Find-CertificateAuthority once' {
Assert-MockCalled -CommandName Find-CertificateAuthority -Exactly -Times 1
}
}
#endregion
#region Set-TargetResource
Describe "$DSCResourceName\Set-TargetResource" {
Mock -CommandName Join-Path -MockWith { 'xCertReq-Test' } `
-ParameterFilter { $Path -eq $env:Temp }
Mock -CommandName Test-Path -MockWith { $true } `
-ParameterFilter { $Path -eq 'xCertReq-Test.req' }
Mock -CommandName Test-Path -MockWith { $true } `
-ParameterFilter { $Path -eq 'xCertReq-Test.cer' }
Mock -CommandName CertReq.exe
Mock -CommandName Set-Content `
-ParameterFilter {
$Path -eq 'xCertReq-Test.inf' -and `
$Value -eq $CertInf
}
Context 'autorenew is false, credentials not passed' {
Mock -CommandName Get-ChildItem -Mockwith { } `
-ParameterFilter { $Path -eq 'Cert:\LocalMachine\My' }
It 'should not throw' {
{ Set-TargetResource @ParamsNoCred } | Should Not Throw
}
It 'should call expected mocks' {
Assert-MockCalled -CommandName Join-Path -Exactly 1
Assert-MockCalled -CommandName Test-Path -Exactly 1 `
-ParameterFilter { $Path -eq 'xCertReq-Test.req' }
Assert-MockCalled -CommandName Test-Path -Exactly 1 `
-ParameterFilter { $Path -eq 'xCertReq-Test.cer' }
Assert-MockCalled -CommandName Set-Content -Exactly 1 `
-ParameterFilter {
$Path -eq 'xCertReq-Test.inf' -and `
$Value -eq $CertInf
}
Assert-MockCalled -CommandName CertReq.exe -Exactly 3
}
}
Context 'autorenew is true, credentials not passed and certificate does not exist' {
Mock -CommandName Get-ChildItem -Mockwith { } `
-ParameterFilter { $Path -eq 'Cert:\LocalMachine\My' }
It 'should not throw' {
{ Set-TargetResource @ParamsAutoRenewNoCred } | Should Not Throw
}
It 'should call expected mocks' {
Assert-MockCalled -CommandName Join-Path -Exactly 1
Assert-MockCalled -CommandName Test-Path -Exactly 1 `
-ParameterFilter { $Path -eq 'xCertReq-Test.req' }
Assert-MockCalled -CommandName Test-Path -Exactly 1 `
-ParameterFilter { $Path -eq 'xCertReq-Test.cer' }
Assert-MockCalled -CommandName Get-ChildItem -Exactly 1 `
-ParameterFilter { $Path -eq 'Cert:\LocalMachine\My' }
Assert-MockCalled -CommandName Set-Content -Exactly 1 `
-ParameterFilter {
$Path -eq 'xCertReq-Test.inf' -and `
$Value -eq $CertInf
}
Assert-MockCalled -CommandName CertReq.exe -Exactly 3
}
}
Context 'autorenew is true, credentials not passed and valid certificate exists' {
Mock -CommandName Get-ChildItem -Mockwith { $validCert } `
-ParameterFilter { $Path -eq 'Cert:\LocalMachine\My' }
It 'should not throw' {
{ Set-TargetResource @ParamsAutoRenewNoCred } | Should Not Throw
}
It 'should call expected mocks' {
Assert-MockCalled -CommandName Join-Path -Exactly 1
Assert-MockCalled -CommandName Test-Path -Exactly 1 `
-ParameterFilter { $Path -eq 'xCertReq-Test.req' }
Assert-MockCalled -CommandName Test-Path -Exactly 1 `
-ParameterFilter { $Path -eq 'xCertReq-Test.cer' }
Assert-MockCalled -CommandName Get-ChildItem -Exactly 1 `
-ParameterFilter { $Path -eq 'Cert:\LocalMachine\My' }
Assert-MockCalled -CommandName Set-Content -Exactly 1 `
-ParameterFilter {
$Path -eq 'xCertReq-Test.inf' -and `
$Value -eq $CertInf
}
Assert-MockCalled -CommandName CertReq.exe -Exactly 3
}
}
Mock -CommandName Set-Content `
-ParameterFilter {
$Path -eq 'xCertReq-Test.inf' -and `
$Value -eq $CertInfRenew
}
Context 'autorenew is true, credentials not passed and expiring certificate exists' {
Mock -CommandName Get-ChildItem -Mockwith { $expiringCert } `
-ParameterFilter { $Path -eq 'Cert:\LocalMachine\My' }
It 'should not throw' {
{ Set-TargetResource @ParamsAutoRenewNoCred } | Should Not Throw
}
It 'should call expected mocks' {
Assert-MockCalled -CommandName Join-Path -Exactly 1
Assert-MockCalled -CommandName Test-Path -Exactly 1 `
-ParameterFilter { $Path -eq 'xCertReq-Test.req' }
Assert-MockCalled -CommandName Test-Path -Exactly 1 `
-ParameterFilter { $Path -eq 'xCertReq-Test.cer' }
Assert-MockCalled -CommandName Get-ChildItem -Exactly 1 `
-ParameterFilter { $Path -eq 'Cert:\LocalMachine\My' }
Assert-MockCalled -CommandName Set-Content -Exactly 1 `
-ParameterFilter {
$Path -eq 'xCertReq-Test.inf' -and `
$Value -eq $CertInfRenew
}
Assert-MockCalled -CommandName CertReq.exe -Exactly 3
}
}
Context 'autorenew is true, credentials not passed and expired certificate exists' {
Mock -CommandName Get-ChildItem -Mockwith { $expiredCert } `
-ParameterFilter { $Path -eq 'Cert:\LocalMachine\My' }
It 'should not throw' {
{ Set-TargetResource @ParamsAutoRenewNoCred } | Should Not Throw
}
It 'should call expected mocks' {
Assert-MockCalled -CommandName Join-Path -Exactly 1
Assert-MockCalled -CommandName Test-Path -Exactly 1 `
-ParameterFilter { $Path -eq 'xCertReq-Test.req' }
Assert-MockCalled -CommandName Test-Path -Exactly 1 `
-ParameterFilter { $Path -eq 'xCertReq-Test.cer' }
Assert-MockCalled -CommandName Get-ChildItem -Exactly 1 `
-ParameterFilter { $Path -eq 'Cert:\LocalMachine\My' }
Assert-MockCalled -CommandName Set-Content -Exactly 1 `
-ParameterFilter {
$Path -eq 'xCertReq-Test.inf' -and `
$Value -eq $CertInfRenew
}
Assert-MockCalled -CommandName CertReq.exe -Exactly 3
}
}
Mock -CommandName Set-Content `
-ParameterFilter {
$Path -eq 'xCertReq-Test.inf' -and `
$Value -eq $CertInfKeyRenew
}
Context 'autorenew is true, credentials not passed, keylength passed and expired certificate exists' {
Mock -CommandName Get-ChildItem -Mockwith { $expiredCert } `
-ParameterFilter { $Path -eq 'Cert:\LocalMachine\My' }
It 'should not throw' {
{ Set-TargetResource @ParamsKeyLength4096AutoRenewNoCred } | Should Not Throw
}
It 'should call expected mocks' {
Assert-MockCalled -CommandName Join-Path -Exactly 1
Assert-MockCalled -CommandName Test-Path -Exactly 1 `
-ParameterFilter { $Path -eq 'xCertReq-Test.req' }
Assert-MockCalled -CommandName Test-Path -Exactly 1 `
-ParameterFilter { $Path -eq 'xCertReq-Test.cer' }
Assert-MockCalled -CommandName Get-ChildItem -Exactly 1 `
-ParameterFilter { $Path -eq 'Cert:\LocalMachine\My' }
Assert-MockCalled -CommandName Set-Content -Exactly 1 `
-ParameterFilter { $Path -eq 'xCertReq-Test.inf' }
Assert-MockCalled -CommandName CertReq.exe -Exactly 3
Assert-MockCalled -CommandName Set-Content -Exactly 1 `
-ParameterFilter {
$Path -eq 'xCertReq-Test.inf' -and `
$Value -eq $CertInfKeyRenew
}
}
}
Mock -CommandName Test-Path -MockWith { $false } `
-ParameterFilter { $Path -eq 'xCertReq-Test.req' }
Mock -CommandName Set-Content `
-ParameterFilter {
$Path -eq 'xCertReq-Test.inf' -and `
$Value -eq $CertInf
}
Context 'autorenew is false, credentials not passed, certificate request creation failed' {
Mock -CommandName Get-ChildItem -Mockwith { } `
-ParameterFilter { $Path -eq 'Cert:\LocalMachine\My' }
$errorRecord = Get-InvalidArgumentError `
-ErrorId 'CertificateReqNotFoundError' `
-ErrorMessage ($LocalizedData.CertificateReqNotFoundError -f 'xCertReq-Test.req')
It 'should throw CertificateReqNotFoundError exception' {
{ Set-TargetResource @ParamsNoCred } | Should Throw $errorRecord
}
It 'should call expected mocks' {
Assert-MockCalled -CommandName Join-Path -Exactly 1
Assert-MockCalled -CommandName Test-Path -Exactly 1 `
-ParameterFilter { $Path -eq 'xCertReq-Test.req' }
Assert-MockCalled -CommandName Test-Path -Exactly 0 `
-ParameterFilter { $Path -eq 'xCertReq-Test.cer' }
Assert-MockCalled -CommandName Set-Content -Exactly 1 `
-ParameterFilter {
$Path -eq 'xCertReq-Test.inf' -and `
$Value -eq $CertInf
}
Assert-MockCalled -CommandName CertReq.exe -Exactly 1
}
}
Mock -CommandName Test-Path -MockWith { $true } `
-ParameterFilter { $Path -eq 'xCertReq-Test.req' }
Mock -CommandName Test-Path -MockWith { $false } `
-ParameterFilter { $Path -eq 'xCertReq-Test.cer' }
Context 'autorenew is false, credentials not passed, certificate creation failed' {
Mock -CommandName Get-ChildItem -Mockwith { } `
-ParameterFilter { $Path -eq 'Cert:\LocalMachine\My' }
$errorRecord = Get-InvalidArgumentError `
-ErrorId 'CertificateCerNotFoundError' `
-ErrorMessage ($LocalizedData.CertificateCerNotFoundError -f 'xCertReq-Test.cer')
It 'should throw CertificateCerNotFoundError exception' {
{ Set-TargetResource @ParamsNoCred } | Should Throw $errorRecord
}
It 'should call expected mocks' {
Assert-MockCalled -CommandName Join-Path -Exactly 1
Assert-MockCalled -CommandName Test-Path -Exactly 1 `
-ParameterFilter { $Path -eq 'xCertReq-Test.req' }
Assert-MockCalled -CommandName Test-Path -Exactly 1 `
-ParameterFilter { $Path -eq 'xCertReq-Test.cer' }
Assert-MockCalled -CommandName Set-Content -Exactly 1 `
-ParameterFilter {
$Path -eq 'xCertReq-Test.inf' -and `
$Value -eq $CertInf
}
Assert-MockCalled -CommandName CertReq.exe -Exactly 2
}
}
Mock -CommandName Test-Path -MockWith { $true } `
-ParameterFilter { $Path -eq 'xCertReq-Test.req' }
Mock -CommandName Test-Path -MockWith { $true } `
-ParameterFilter { $Path -eq 'xCertReq-Test.cer' }
Mock -CommandName Test-Path -MockWith { $true } `
-ParameterFilter { $Path -eq 'xCertReq-Test.out' }
Context 'autorenew is false, credentials passed' {
Mock -CommandName Get-ChildItem -Mockwith { } `
-ParameterFilter { $Path -eq 'Cert:\LocalMachine\My' }
Mock -CommandName Get-Content -Mockwith { 'Output' } `
-ParameterFilter { $Path -eq 'xCertReq-Test.out' }
Mock -CommandName Remove-Item `
-ParameterFilter { $Path -eq 'xCertReq-Test.out' }
Mock -CommandName Import-Module
function Start-Win32Process { param ( $Path,$Arguments,$Credential ) }
function Wait-Win32ProcessStop { param ( $Path,$Arguments,$Credential ) }
Mock -CommandName Start-Win32Process -ModuleName MSFT_xCertReq
Mock -CommandName Wait-Win32ProcessStop -ModuleName MSFT_xCertReq
It 'should not throw' {
{ Set-TargetResource @Params } | Should Not Throw
}
It 'should call expected mocks' {
Assert-MockCalled -CommandName Join-Path -Exactly 1
Assert-MockCalled -CommandName Test-Path -Exactly 1 `
-ParameterFilter { $Path -eq 'xCertReq-Test.req' }
Assert-MockCalled -CommandName Test-Path -Exactly 1 `
-ParameterFilter { $Path -eq 'xCertReq-Test.cer' }
Assert-MockCalled -CommandName Set-Content -Exactly 1 `
-ParameterFilter {
$Path -eq 'xCertReq-Test.inf' -and `
$Value -eq $CertInf
}
Assert-MockCalled -CommandName CertReq.exe -Exactly 2
Assert-MockCalled -CommandName Start-Win32Process -ModuleName MSFT_xCertReq -Exactly 1
Assert-MockCalled -CommandName Wait-Win32ProcessStop -ModuleName MSFT_xCertReq -Exactly 1
Assert-MockCalled -CommandName Test-Path -Exactly 1 `
-ParameterFilter { $Path -eq 'xCertReq-Test.out' }
Assert-MockCalled -CommandName Get-Content -Exactly 1 `
-ParameterFilter { $Path -eq 'xCertReq-Test.out' }
Assert-MockCalled -CommandName Remove-Item -Exactly 1 `
-ParameterFilter { $Path -eq 'xCertReq-Test.out' }
}
}
Mock -CommandName Set-Content `
-ParameterFilter {
$Path -eq 'xCertReq-Test.inf' -and `
$Value -eq $CertInfSubjectAltName
}
Context 'autorenew is false, subject alt name passed, credentials not passed' {
Mock -CommandName Get-ChildItem -Mockwith { } `
-ParameterFilter { $Path -eq 'Cert:\LocalMachine\My' }
It 'should not throw' {
{ Set-TargetResource @ParamsSubjectAltNameNoCred } | Should Not Throw
}
It 'should call expected mocks' {
Assert-MockCalled -CommandName Join-Path -Exactly 1
Assert-MockCalled -CommandName Test-Path -Exactly 1 `
-ParameterFilter { $Path -eq 'xCertReq-Test.req' }
Assert-MockCalled -CommandName Test-Path -Exactly 1 `
-ParameterFilter { $Path -eq 'xCertReq-Test.cer' }
Assert-MockCalled -CommandName Set-Content -Exactly 1 `
-ParameterFilter {
$Path -eq 'xCertReq-Test.inf' -and `
$Value -eq $CertInfSubjectAltName
}
Assert-MockCalled -CommandName CertReq.exe -Exactly 3
}
}
Context 'standalone CA, URL for CEP and CES passed, credentials passed, inf not containing template' {
Mock -CommandName Set-Content -ParameterFilter {
$Path -eq 'xCertReq-Test.inf' -and `
$Value -eq $CertInfNoTemplate
}
Mock -CommandName Get-ChildItem -Mockwith { } `
-ParameterFilter { $Path -eq 'Cert:\LocalMachine\My' }
It 'should not throw' {
{ Set-TargetResource @ParamsStandaloneWebEnrollment } | Should Not Throw
}
It 'should call expected mocks' {
Assert-MockCalled -CommandName Join-Path -Exactly 1
Assert-MockCalled -CommandName Test-Path -Exactly 1 `
-ParameterFilter { $Path -eq 'xCertReq-Test.req' }
Assert-MockCalled -CommandName Test-Path -Exactly 1 `
-ParameterFilter { $Path -eq 'xCertReq-Test.cer' }
Assert-MockCalled -CommandName Set-Content -Exactly 1 `
-ParameterFilter {
$Path -eq 'xCertReq-Test.inf' -and `
$Value -eq $CertInfNoTemplate
}
Assert-MockCalled -CommandName CertReq.exe -Exactly 3
}
}
Context 'enterprise CA, URL for CEP and CES passed, credentials passed' {
Mock -CommandName Set-Content -ParameterFilter {
$Path -eq 'xCertReq-Test.inf' -and `
$Value -eq $CertInf
}
Mock -CommandName Get-ChildItem -Mockwith { } `
-ParameterFilter { $Path -eq 'Cert:\LocalMachine\My' }
It 'should not throw' {
{ Set-TargetResource @ParamsEnterpriseWebEnrollment } | Should Not Throw
}
It 'should call expected mocks' {
Assert-MockCalled -CommandName Join-Path -Exactly 1
Assert-MockCalled -CommandName Test-Path -Exactly 1 `
-ParameterFilter { $Path -eq 'xCertReq-Test.req' }
Assert-MockCalled -CommandName Test-Path -Exactly 1 `
-ParameterFilter { $Path -eq 'xCertReq-Test.cer' }
Assert-MockCalled -CommandName Set-Content -Exactly 1 `
-ParameterFilter {
$Path -eq 'xCertReq-Test.inf' -and `
$Value -eq $CertInf
}
Assert-MockCalled -CommandName CertReq.exe -Exactly 3
}
}
Context 'Auto-discovered CA, autorenew is false, credentials passed' {
Mock -CommandName Get-ChildItem -Mockwith { } `
-ParameterFilter { $Path -eq 'Cert:\LocalMachine\My' }
Mock -CommandName Get-Content -Mockwith { 'Output' } `
-ParameterFilter { $Path -eq 'xCertReq-Test.out' }
Mock -CommandName Remove-Item `
-ParameterFilter { $Path -eq 'xCertReq-Test.out' }
Mock -CommandName Import-Module
Mock -CommandName Start-Win32Process
Mock -CommandName Wait-Win32ProcessStop
Mock -CommandName Find-CertificateAuthority -MockWith {
return New-Object -TypeName psobject -Property @{
CARootName = "ContosoCA"
CAServerFQDN = "ContosoVm.contoso.com"
}
}
It 'should not throw' {
{ Set-TargetResource @ParamsAutoDiscovery } | Should Not Throw
}
It 'should call expected mocks' {
Assert-MockCalled -CommandName Join-Path -Exactly 1
Assert-MockCalled -CommandName Test-Path -Exactly 1 `
-ParameterFilter { $Path -eq 'xCertReq-Test.req' }
Assert-MockCalled -CommandName Test-Path -Exactly 1 `
-ParameterFilter { $Path -eq 'xCertReq-Test.cer' }
Assert-MockCalled -CommandName Set-Content -Exactly 1 `
-ParameterFilter {
$Path -eq 'xCertReq-Test.inf' -and `
$Value -eq $CertInf
}
Assert-MockCalled -CommandName CertReq.exe -Exactly 2
Assert-MockCalled -CommandName Start-Win32Process -ModuleName MSFT_xCertReq -Exactly 1
Assert-MockCalled -CommandName Wait-Win32ProcessStop -ModuleName MSFT_xCertReq -Exactly 1
Assert-MockCalled -CommandName Test-Path -Exactly 1 `
-ParameterFilter { $Path -eq 'xCertReq-Test.out' }
Assert-MockCalled -CommandName Get-Content -Exactly 1 `
-ParameterFilter { $Path -eq 'xCertReq-Test.out' }
Assert-MockCalled -CommandName Remove-Item -Exactly 1 `
-ParameterFilter { $Path -eq 'xCertReq-Test.out' }
Assert-MockCalled -CommandName Find-CertificateAuthority -Exactly -Times 1
}
}
}
#endregion
Describe "$DSCResourceName\Test-TargetResource" {
Mock -CommandName Find-CertificateAuthority -MockWith {
return New-Object -TypeName psobject -Property @{
CARootName = "ContosoCA"
CAServerFQDN = "ContosoVm.contoso.com"
}
}
It 'should return a bool' {
Test-TargetResource @Params | Should BeOfType Boolean
}
It 'should return false when a valid certificate does not exist' {
Mock Get-ChildItem -ParameterFilter { $Path -eq 'Cert:\LocalMachine\My' } `
-Mockwith { }
Test-TargetResource @Params | Should Be $false
}
It 'should return true when a valid certificate already exists and is not about to expire' {
Mock Get-ChildItem -ParameterFilter { $Path -eq 'Cert:\LocalMachine\My' } `
-Mockwith { $validCert }
Mock Get-CertificateTemplateName -MockWith { $CertificateTemplate }
Mock Get-CertificateSan -MockWith { $SubjectAltName }
Test-TargetResource @Params | Should Be $true
}
It 'should return true when a valid certificate already exists and is about to expire and autorenew set' {
Mock Get-ChildItem -ParameterFilter { $Path -eq 'Cert:\LocalMachine\My' } `
-Mockwith { $expiringCert }
Mock Get-CertificateTemplateName -MockWith { $CertificateTemplate }
Mock Get-CertificateSan -MockWith { $SubjectAltName }
Test-TargetResource @ParamsAutoRenew | Should Be $true
}
It 'should return true when a valid certificate already exists and DNS SANs match' {
Mock Get-ChildItem -ParameterFilter { $Path -eq 'Cert:\LocalMachine\My' } `
-Mockwith { $validSANCert }
Test-TargetResource @ParamsSubjectAltName | Should Be $true
}
It 'should return false when a certificate exists but contains incorrect DNS SANs' {
Mock Get-ChildItem -ParameterFilter { $Path -eq 'Cert:\LocalMachine\My' } `
-Mockwith { $incorrectSANCert }
Test-TargetResource @ParamsSubjectAltName | Should Be $false
}
It 'should return false when a certificate exists but does not contain specified DNS SANs' {
Mock Get-ChildItem -ParameterFilter { $Path -eq 'Cert:\LocalMachine\My' } `
-Mockwith { $emptySANCert }
Test-TargetResource @ParamsSubjectAltName | Should Be $false
}
It 'Should auto-discover the CA and return false' {
Test-TargetResource @ParamsAutoDiscovery | Should Be $false
}
It 'Should execute the auto-discovery function' {
Assert-MockCalled -CommandName Find-CertificateAuthority -Exactly -Times 1
}
}
}
}
finally
{
#region FOOTER
Restore-TestEnvironment -TestEnvironment $TestEnvironment
#endregion
}
|
PowerShellCorpus/PowerShellGallery/xCertificate/2.7.0.0/Tests/Unit/MSFT_xPfxImport.Tests.ps1
|
MSFT_xPfxImport.Tests.ps1
|
[System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidUsingConvertToSecureStringWithPlainText', '')]
param ()
$script:DSCModuleName = 'xCertificate'
$script:DSCResourceName = 'MSFT_xPfxImport'
#region HEADER
# Integration Test Template Version: 1.1.0
[String] $script:moduleRoot = Split-Path -Parent (Split-Path -Parent $PSScriptRoot)
if ( (-not (Test-Path -Path (Join-Path -Path $script:moduleRoot -ChildPath 'DSCResource.Tests'))) -or `
(-not (Test-Path -Path (Join-Path -Path $script:moduleRoot -ChildPath 'DSCResource.Tests\TestHelper.psm1'))) )
{
& git @('clone','https://github.com/PowerShell/DscResource.Tests.git',(Join-Path -Path $script:moduleRoot -ChildPath '\DSCResource.Tests\'))
}
Import-Module (Join-Path -Path $script:moduleRoot -ChildPath 'DSCResource.Tests\TestHelper.psm1') -Force
$TestEnvironment = Initialize-TestEnvironment `
-DSCModuleName $script:DSCModuleName `
-DSCResourceName $script:DSCResourceName `
-TestType Unit
#endregion
# Begin Testing
try
{
InModuleScope $script:DSCResourceName {
$DSCResourceName = 'MSFT_xPfxImport'
$validThumbprint = (
[System.AppDomain]::CurrentDomain.GetAssemblies().GetTypes() | Where-Object {
$_.BaseType.BaseType -eq [System.Security.Cryptography.HashAlgorithm] -and
($_.Name -cmatch 'Managed$' -or $_.Name -cmatch 'Provider$')
} | Select-Object -First 1 | ForEach-Object {
(New-Object $_).ComputeHash([String]::Empty) | ForEach-Object {
'{0:x2}' -f $_
}
}
) -join ''
$testFile = 'test.pfx'
$testUsername = 'DummyUsername'
$testPassword = 'DummyPassword'
$testCredential = New-Object System.Management.Automation.PSCredential $testUsername, (ConvertTo-SecureString $testPassword -AsPlainText -Force)
$validPath = "TestDrive:\$testFile"
$validCertPath = "Cert:\LocalMachine\My"
$PresentParams = @{
Thumbprint = $validThumbprint
Path = $validPath
Ensure = 'Present'
Location = 'LocalMachine'
Store = 'My'
Exportable = $True
Credential = $testCredential
}
$AbsentParams = @{
Thumbprint = $validThumbprint
Path = $validPath
Ensure = 'Absent'
Location = 'LocalMachine'
Store = 'My'
}
Describe "$DSCResourceName\Get-TargetResource" {
$null | Set-Content -Path $validPath
$result = Get-TargetResource @PresentParams
It 'should return a hashtable' {
($result -is [hashtable]) | Should Be $true
}
It 'should contain the input values' {
$result.Thumbprint | Should BeExactly $validThumbprint
$result.Path | Should BeExactly $validPath
}
}
Describe "$DSCResourceName\Test-TargetResource" {
$null | Set-Content -Path $validPath
It 'should return a bool' {
Test-TargetResource @PresentParams | Should BeOfType Boolean
}
It 'returns false when valid path + thumbprint and certificate is not in store but should be' {
Mock Get-TargetResource {
return @{
Thumbprint = $validThumbprint
Path = $validPath
Ensure = 'Absent'
}
}
Test-TargetResource @PresentParams | Should Be $false
}
It 'returns true when valid path + thumbprint and PFX is not in store and should not be' {
Mock Get-TargetResource {
return @{
Thumbprint = $validThumbprint
Path = $validPath
Ensure = 'Absent'
}
}
Test-TargetResource @AbsentParams | Should Be $true
}
It 'returns true when valid path + thumbprint and PFX is in store and should be' {
Mock Get-TargetResource {
return @{
Thumbprint = $validThumbprint
Path = $validPath
Ensure = 'Present'
}
}
Test-TargetResource @PresentParams | Should Be $true
}
It 'returns false when valid path + thumbprint and PFX is in store but should not be' {
Mock Get-TargetResource {
return @{
Thumbprint = $validThumbprint
Path = $validPath
Ensure = 'Present'
}
}
Test-TargetResource @AbsentParams | Should Be $false
}
}
Describe "$DSCResourceName\Set-TargetResource" {
$null | Set-Content -Path $validPath
Mock Import-PfxCertificate
Mock Get-ChildItem
Mock Remove-Item
Context "Valid path + thumbprint and Ensure is Present" {
Set-TargetResource @PresentParams
It 'calls Import-PfxCertificate with the parameters supplied' {
Assert-MockCalled Import-PfxCertificate -Exactly 1 -ParameterFilter {
$CertStoreLocation -eq $validCertPath -and `
$FilePath -eq $validPath -and `
$Exportable -eq $True -and `
$Password -eq $testCredential.Password
}
}
It 'does not call Get-ChildItem' {
Assert-MockCalled Get-ChildItem -Exactly 0
}
It 'does not call Remove-Item' {
Assert-MockCalled Remove-Item -Exactly 0
}
}
Mock Get-ChildItem -MockWith { Get-Item -Path $validPath }
Mock Where-Object -MockWith { Get-Item -Path $validPath }
Mock Remove-Item
Context "Valid path + thumbprint and Ensure is Absent" {
Set-TargetResource @AbsentParams
It 'does not call Import-PfxCertificate' {
Assert-MockCalled Import-PfxCertificate -Exactly 0
}
It 'calls Get-ChildItem' {
Assert-MockCalled Get-ChildItem -Exactly 1
}
It 'calls Remove-Item' {
Assert-MockCalled Remove-Item -Exactly 1
}
}
}
}
}
finally
{
#region FOOTER
Restore-TestEnvironment -TestEnvironment $TestEnvironment
#endregion
}
|
PowerShellCorpus/PowerShellGallery/xCertificate/2.7.0.0/Tests/Integration/MSFT_xPfxImport.Integration.Tests.ps1
|
MSFT_xPfxImport.Integration.Tests.ps1
|
[System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidUsingConvertToSecureStringWithPlainText', '')]
param ()
$script:DSCModuleName = 'xCertificate'
$script:DSCResourceName = 'MSFT_xPfxImport'
#region HEADER
# Integration Test Template Version: 1.1.0
[String] $script:moduleRoot = Split-Path -Parent (Split-Path -Parent $PSScriptRoot)
if ( (-not (Test-Path -Path (Join-Path -Path $script:moduleRoot -ChildPath 'DSCResource.Tests'))) -or `
(-not (Test-Path -Path (Join-Path -Path $script:moduleRoot -ChildPath 'DSCResource.Tests\TestHelper.psm1'))) )
{
& git @('clone','https://github.com/PowerShell/DscResource.Tests.git',(Join-Path -Path $script:moduleRoot -ChildPath '\DSCResource.Tests\'))
}
Import-Module (Join-Path -Path $script:moduleRoot -ChildPath 'DSCResource.Tests\TestHelper.psm1') -Force
$TestEnvironment = Initialize-TestEnvironment `
-DSCModuleName $script:DSCModuleName `
-DSCResourceName $script:DSCResourceName `
-TestType Integration
#endregion
# Using try/finally to always cleanup even if something awful happens.
try
{
# Generate a self-signed certificate, export it and remove it from the store
# to use for testing.
# Don't use CurrentUser certificates for this test because they won't be found because
# DSC LCM runs under a different context (Local System).
$Certificate = New-SelfSignedCertificate `
-DnsName $env:ComputerName `
-CertStoreLocation Cert:\LocalMachine\My
$CertificatePath = Join-Path `
-Path $env:Temp `
-ChildPath "xPfxImport-$($Certificate.Thumbprint).pfx"
$testUsername = 'DummyUsername'
$testPassword = 'DummyPassword'
$testCredential = New-Object System.Management.Automation.PSCredential $testUsername, (ConvertTo-SecureString $testPassword -AsPlainText -Force)
$null = Export-PfxCertificate `
-Cert $Certificate `
-FilePath $CertificatePath `
-Password $testCredential.Password
$null = Remove-Item `
-Path $Certificate.PSPath `
-Force
#region Integration Tests
$ConfigFile = Join-Path -Path $PSScriptRoot -ChildPath "$($script:DSCResourceName)_Add.config.ps1"
. $ConfigFile
Describe "$($script:DSCResourceName)_Add_Integration" {
#region DEFAULT TESTS
It 'Should compile and apply the MOF without throwing' {
{
$configData = @{
AllNodes = @(
@{
NodeName = 'localhost';
PSDscAllowPlainTextPassword = $true
}
)
}
& "$($script:DSCResourceName)_Add_Config" `
-OutputPath $TestDrive `
-ConfigurationData $configData `
-Path $CertificatePath `
-Thumbprint $Certificate.Thumbprint `
-Credential $testCredential
Start-DscConfiguration -Path $TestDrive -ComputerName localhost -Wait -Verbose -Force
} | Should Not Throw
}
It 'Should be able to call Get-DscConfiguration without throwing' {
{ Get-DscConfiguration -Verbose -ErrorAction Stop } | Should Not Throw
}
#endregion
It 'Should have set the resource and all the parameters should match' {
# Get the Certificate details
$CertificateNew = Get-Item `
-Path "Cert:\LocalMachine\My\$($Certificate.Thumbprint)"
$CertificateNew | Should BeOfType System.Security.Cryptography.X509Certificates.X509Certificate2
$CertificateNew.Thumbprint | Should Be $Certificate.Thumbprint
$CertificateNew.Subject | Should Be $Certificate.Subject
}
}
#endregion
#region Integration Tests
$ConfigFile = Join-Path -Path $PSScriptRoot -ChildPath "$($script:DSCResourceName)_Remove.config.ps1"
. $ConfigFile
Describe "$($script:DSCResourceName)_Remove_Integration" {
#region DEFAULT TESTS
It 'Should compile without throwing' {
{
& "$($script:DSCResourceName)_Remove_Config" `
-OutputPath $TestDrive `
-Path $CertificatePath `
-Thumbprint $Certificate.Thumbprint
Start-DscConfiguration -Path $TestDrive -ComputerName localhost -Wait -Verbose -Force
} | Should Not Throw
}
It 'Should be able to call Get-DscConfiguration without throwing' {
{ Get-DscConfiguration -Verbose -ErrorAction Stop } | Should Not Throw
}
#endregion
It 'Should have set the resource and all the parameters should match' {
# Get the Certificate details
$CertificateNew = Get-Item `
-Path "Cert:\LocalMachine\My\$($Certificate.Thumbprint)" `
-ErrorAction SilentlyContinue
$CertificateNew | Should BeNullOrEmpty
}
}
#endregion
}
finally
{
# Clean up
$null = Remove-Item `
-Path $CertificatePath `
-Force `
-ErrorAction SilentlyContinue
$null = Remove-Item `
-Path $Certificate.PSPath `
-Force `
-ErrorAction SilentlyContinue
#region FOOTER
Restore-TestEnvironment -TestEnvironment $TestEnvironment
#endregion
}
|
PowerShellCorpus/PowerShellGallery/xCertificate/2.7.0.0/Tests/Integration/MSFT_xCertificateImport.Integration.Tests.ps1
|
MSFT_xCertificateImport.Integration.Tests.ps1
|
$script:DSCModuleName = 'xCertificate'
$script:DSCResourceName = 'MSFT_xCertificateImport'
#region HEADER
# Integration Test Template Version: 1.1.0
[String] $script:moduleRoot = Split-Path -Parent (Split-Path -Parent $PSScriptRoot)
if ( (-not (Test-Path -Path (Join-Path -Path $script:moduleRoot -ChildPath 'DSCResource.Tests'))) -or `
(-not (Test-Path -Path (Join-Path -Path $script:moduleRoot -ChildPath 'DSCResource.Tests\TestHelper.psm1'))) )
{
& git @('clone','https://github.com/PowerShell/DscResource.Tests.git',(Join-Path -Path $script:moduleRoot -ChildPath '\DSCResource.Tests\'))
}
Import-Module (Join-Path -Path $script:moduleRoot -ChildPath 'DSCResource.Tests\TestHelper.psm1') -Force
$TestEnvironment = Initialize-TestEnvironment `
-DSCModuleName $script:DSCModuleName `
-DSCResourceName $script:DSCResourceName `
-TestType Integration
#endregion
# Using try/finally to always cleanup even if something awful happens.
try
{
# Generate a self-signed certificate, export it and remove it from the store
# to use for testing.
# Don't use CurrentUser certificates for this test because they won't be found because
# DSC LCM runs under a different context (Local System).
$Certificate = New-SelfSignedCertificate `
-DnsName $env:ComputerName `
-CertStoreLocation Cert:\LocalMachine\My
$CertificatePath = Join-Path `
-Path $env:Temp `
-ChildPath "xCertificateImport-$($Certificate.Thumbprint).cer"
$null = Export-Certificate `
-Cert $Certificate `
-Type CERT `
-FilePath $CertificatePath
$null = Remove-Item `
-Path $Certificate.PSPath `
-Force
#region Integration Tests
$ConfigFile = Join-Path -Path $PSScriptRoot -ChildPath "$($script:DSCResourceName)_Add.config.ps1"
. $ConfigFile
Describe "$($script:DSCResourceName)_Add_Integration" {
#region DEFAULT TESTS
It 'Should compile and apply the MOF without throwing' {
{
& "$($script:DSCResourceName)_Add_Config" `
-OutputPath $TestDrive `
-Path $CertificatePath `
-Thumbprint $Certificate.Thumbprint
Start-DscConfiguration -Path $TestDrive -ComputerName localhost -Wait -Verbose -Force
} | Should Not Throw
}
It 'Should be able to call Get-DscConfiguration without throwing' {
{ Get-DscConfiguration -Verbose -ErrorAction Stop } | Should Not Throw
}
#endregion
It 'Should have set the resource and all the parameters should match' {
# Get the Certificate details
$CertificateNew = Get-Item `
-Path "Cert:\LocalMachine\My\$($Certificate.Thumbprint)"
$CertificateNew | Should BeOfType System.Security.Cryptography.X509Certificates.X509Certificate2
$CertificateNew.Thumbprint | Should Be $Certificate.Thumbprint
$CertificateNew.Subject | Should Be $Certificate.Subject
}
}
#endregion
#region Integration Tests
$ConfigFile = Join-Path -Path $PSScriptRoot -ChildPath "$($script:DSCResourceName)_Remove.config.ps1"
. $ConfigFile
Describe "$($script:DSCResourceName)_Remove_Integration" {
#region DEFAULT TESTS
It 'Should compile without throwing' {
{
& "$($script:DSCResourceName)_Remove_Config" `
-OutputPath $TestDrive `
-Path $CertificatePath `
-Thumbprint $Certificate.Thumbprint
Start-DscConfiguration -Path $TestDrive -ComputerName localhost -Wait -Verbose -Force
} | Should not throw
}
It 'should be able to call Get-DscConfiguration without throwing' {
{ Get-DscConfiguration -Verbose -ErrorAction Stop } | Should Not throw
}
#endregion
It 'Should have set the resource and all the parameters should match' {
# Get the Certificate details
$CertificateNew = Get-Item `
-Path "Cert:\LocalMachine\My\$($Certificate.Thumbprint)" `
-ErrorAction SilentlyContinue
$CertificateNew | Should BeNullOrEmpty
}
}
#endregion
}
finally
{
# Clean up
$null = Remove-Item `
-Path $CertificatePath `
-Force `
-ErrorAction SilentlyContinue
$null = Remove-Item `
-Path $Certificate.PSPath `
-Force `
-ErrorAction SilentlyContinue
#region FOOTER
Restore-TestEnvironment -TestEnvironment $TestEnvironment
#endregion
}
|
PowerShellCorpus/PowerShellGallery/xCertificate/2.7.0.0/Tests/Integration/MSFT_xCertReq.config.ps1
|
MSFT_xCertReq.config.ps1
|
# This will fail if the machine does not have a CA Configured.
$CertUtilResult = & "$env:SystemRoot\system32\certutil.exe" @('-dump')
$CAServerFQDN = ([regex]::matches($CertUtilResult,'Server:[ \t]+`([A-Za-z0-9._-]+)''','IgnoreCase')).Groups[1].Value
$CARootName = ([regex]::matches($CertUtilResult,'Name:[ \t]+`([\sA-Za-z0-9._-]+)''','IgnoreCase')).Groups[1].Value
$KeyLength = '1024'
$Exportable = $true
$ProviderName = '"Microsoft RSA SChannel Cryptographic Provider"'
$OID = '1.3.6.1.5.5.7.3.1'
$KeyUsage = '0xa0'
$CertificateTemplate = 'WebServer'
$SubjectAltName = 'dns=contoso.com&dns=fabrikam.com'
# If automated testing with a real CA can be performed then the credentials should be
# obtained non-interactively way - do not do this in a production environment.
$Credential = Get-Credential
$TestCertReq = [PSObject]@{
Subject = 'CertReq Test'
CAServerFQDN = $CAServerFQDN
CARootName = $CARootName
Credential = $Credential
KeyLength = $KeyLength
Exportable = $Exportable
ProviderName = $ProviderName
OID = $OID
KeyUsage = $KeyUsage
CertificateTemplate = $CertificateTemplate
SubjectAltName = $SubjectAltName
}
Configuration MSFT_xCertReq_Config {
Import-DscResource -ModuleName xCertificate
node localhost {
xCertReq Integration_Test {
Subject = $TestCertReq.Subject
CAServerFQDN = $TestCertReq.CAServerFQDN
CARootName = $TestCertReq.CARootName
Credential = $TestCertReq.Credential
KeyLength = $TestCertReq.KeyLength
Exportable = $TestCertReq.Exportable
ProviderName = $TestCertReq.ProviderName
OID = $TestCertReq.OID
KeyUsage = $TestCertReq.KeyUsage
CertificateTemplate = $TestCertReq.CertificateTemplate
SubjectAltName = $TestCertReq.SubjectAltName
}
}
}
|
PowerShellCorpus/PowerShellGallery/xCertificate/2.7.0.0/Tests/Integration/MSFT_xCertificateExport.Integration.Tests.ps1
|
MSFT_xCertificateExport.Integration.Tests.ps1
|
$script:DSCModuleName = 'xCertificate'
$script:DSCResourceName = 'MSFT_xCertificateExport'
#region HEADER
# Integration Test Template Version: 1.1.0
[String] $script:moduleRoot = Split-Path -Parent (Split-Path -Parent $PSScriptRoot)
if ( (-not (Test-Path -Path (Join-Path -Path $script:moduleRoot -ChildPath 'DSCResource.Tests'))) -or `
(-not (Test-Path -Path (Join-Path -Path $script:moduleRoot -ChildPath 'DSCResource.Tests\TestHelper.psm1'))) )
{
& git @('clone','https://github.com/PowerShell/DscResource.Tests.git',(Join-Path -Path $script:moduleRoot -ChildPath '\DSCResource.Tests\'))
}
Import-Module (Join-Path -Path $script:moduleRoot -ChildPath 'DSCResource.Tests\TestHelper.psm1') -Force
$TestEnvironment = Initialize-TestEnvironment `
-DSCModuleName $script:DSCModuleName `
-DSCResourceName $script:DSCResourceName `
-TestType Integration
#endregion
Import-Module -Name (Join-Path -Path (Join-Path -Path (Split-Path $PSScriptRoot -Parent) -ChildPath 'TestHelpers') -ChildPath 'CommonTestHelper.psm1') -Global
# Using try/finally to always cleanup even if something awful happens.
try
{
#region Integration Tests
$ConfigFile = Join-Path -Path $PSScriptRoot -ChildPath "$($script:DSCResourceName).config.ps1"
. $ConfigFile
Describe "$($script:DSCResourceName)_Integration" {
# Download and dot source the New-SelfSignedCertificateEx script
. (Install-NewSelfSignedCertificateExScript)
# Prepare CER certificate properties
$script:certificatePath = Join-Path -Path $env:Temp -ChildPath 'xCertificateExportTestCert.cer'
$null = Remove-Item -Path $script:certificatePath -Force -ErrorAction SilentlyContinue
# Prepare PFX certificate properties
$script:pfxPath = Join-Path -Path $env:Temp -ChildPath 'xCertificateExportTestCert.pfx'
$null = Remove-Item -Path $script:pfxPath -Force -ErrorAction SilentlyContinue
$pfxPlainTextPassword = 'P@ssword!1'
$pfxPassword = ConvertTo-SecureString -String $pfxPlainTextPassword -AsPlainText -Force
$pfxCredential = New-Object -TypeName System.Management.Automation.PSCredential `
-ArgumentList ('Dummy',$pfxPassword)
# Generate the Valid certificate for testing
$certificateDNSNames = @('www.fabrikam.com', 'www.contoso.com')
$certificateKeyUsage = @('DigitalSignature','DataEncipherment')
$certificateEKU = @('Server Authentication','Client authentication')
$certificateSubject = 'CN=contoso, DC=com'
$certFriendlyName = 'Contoso Test Cert'
$validCertificate = New-SelfSignedCertificateEx `
-Subject $certificateSubject `
-KeyUsage $certificateKeyUsage `
-KeySpec 'Exchange' `
-EKU $certificateEKU `
-SubjectAlternativeName $certificateDNSNames `
-FriendlyName $certFriendlyName `
-StoreLocation 'LocalMachine' `
-Exportable
$script:validCertificateThumbprint = $validCertificate.Thumbprint
Context 'Export CERT' {
#region DEFAULT TESTS
It 'Should compile and apply the MOF without throwing' {
{
# This is to allow the testing of certreq with domain credentials
$ConfigData = @{
AllNodes = @(
@{
NodeName = 'localhost'
Path = $script:certificatePath
FriendlyName = $certFriendlyName
Subject = $certificateSubject
DNSName = $certificateDNSNames
Issuer = $certificateSubject
KeyUsage = $certificateKeyUsage
EnhancedKeyUsage = $certificateEKU
MatchSource = $true
Type = 'CERT'
}
)
}
& "$($script:DSCResourceName)_Config" `
-OutputPath $TestDrive `
-ConfigurationData $ConfigData
Start-DscConfiguration -Path $TestDrive -ComputerName localhost -Wait -Verbose -Force
} | Should Not Throw
}
It 'Should be able to call Get-DscConfiguration without throwing' {
{ $script:currentCertificate = Get-DscConfiguration -Verbose -ErrorAction Stop } | Should Not Throw
}
#endregion
It 'Should have exported a Cert certificate' {
$script:currentCertificate.IsExported | Should Be $true
}
It 'Should have set the resource and the thumbprint of the exported certificate should match' {
$exportedCertificate = New-Object -TypeName 'System.Security.Cryptography.X509Certificates.X509Certificate2Collection'
$exportedCertificate.Import($script:certificatePath)
$exportedCertificate[0].Thumbprint | Should Be $script:validCertificateThumbprint
}
}
Context 'Export PFX' {
#region DEFAULT TESTS
It 'Should compile and apply the MOF without throwing' {
{
# This is to allow the testing of certreq with domain credentials
$ConfigData = @{
AllNodes = @(
@{
NodeName = 'localhost'
Path = $script:pfxPath
FriendlyName = $certFriendlyName
Subject = $certificateSubject
DNSName = $certificateDNSNames
Issuer = $certificateSubject
KeyUsage = $certificateKeyUsage
EnhancedKeyUsage = $certificateEKU
MatchSource = $true
Type = 'PFX'
ChainOption = 'BuildChain'
Password = $pfxCredential
PsDscAllowPlainTextPassword = $true
}
)
}
& "$($script:DSCResourceName)_Config" `
-OutputPath $TestDrive `
-ConfigurationData $ConfigData
Start-DscConfiguration -Path $TestDrive -ComputerName localhost -Wait -Verbose -Force
} | Should Not Throw
}
It 'Should be able to call Get-DscConfiguration without throwing' {
{ $script:currentPFX = Get-DscConfiguration -Verbose -ErrorAction Stop } | Should Not Throw
}
#endregion
It 'Should have exported a PFX certificate' {
$script:currentPFX.IsExported | Should Be $true
}
It 'Should have set the resource and the thumbprint of the exported certificate should match' {
$exportedCertificate = New-Object -TypeName 'System.Security.Cryptography.X509Certificates.X509Certificate2Collection'
$exportedCertificate.Import($script:certificatePath,$pfxPassword,[System.Security.Cryptography.X509Certificates.X509KeyStorageFlags]::PersistKeySet)
$exportedCertificate[0].Thumbprint | Should Be $script:validCertificateThumbprint
}
}
AfterAll {
# Cleanup
$validCertificate = Get-Item -Path "cert:\LocalMachine\My\$($script:validCertificateThumbprint)"
$null = Remove-Item -Path $validCertificate.PSPath -Force -ErrorAction SilentlyContinue
$null = Remove-Item -Path $script:pfxPath -Force -ErrorAction SilentlyContinue
$null = Remove-Item -Path $script:certificatePath -Force -ErrorAction SilentlyContinue
}
}
#endregion
}
finally
{
#region FOOTER
Restore-TestEnvironment -TestEnvironment $TestEnvironment
#endregion
}
|
PowerShellCorpus/PowerShellGallery/xCertificate/2.7.0.0/Tests/Integration/MSFT_xPfxImport_add.config.ps1
|
MSFT_xPfxImport_add.config.ps1
|
Configuration MSFT_xPfxImport_Add_Config {
param
(
$Thumbprint,
$Path,
$Credential
)
Import-DscResource -ModuleName xCertificate
node localhost {
xPfxImport Integration_Test {
Thumbprint = $Thumbprint
Path = $Path
Location = 'LocalMachine'
Store = 'My'
Ensure = 'Present'
Credential = $Credential
}
}
}
|
PowerShellCorpus/PowerShellGallery/xCertificate/2.7.0.0/Tests/Integration/MSFT_xCertificateImport_add.config.ps1
|
MSFT_xCertificateImport_add.config.ps1
|
Configuration MSFT_xCertificateImport_Add_Config {
param
(
$Thumbprint,
$Path
)
Import-DscResource -ModuleName xCertificate
node localhost {
xCertificateImport Integration_Test {
Thumbprint = $Thumbprint
Path = $Path
Location = 'LocalMachine'
Store = 'My'
Ensure = 'Present'
}
}
}
|
PowerShellCorpus/PowerShellGallery/xCertificate/2.7.0.0/Tests/Integration/ModuleConflict.Tests.ps1
|
ModuleConflict.Tests.ps1
|
$script:DSCModuleName = 'xCertificate'
<#
These integration tests ensure that exported cmdlets names do not conflict
with any other names that are exposed by other common resource kit modules.
#>
$script:ModulesToTest = @( 'xNetworking','xComputerManagement','xDFS' )
#region HEADER
# Integration Test Template Version: 1.1.0
[String] $script:moduleRoot = Split-Path -Parent (Split-Path -Parent $PSScriptRoot)
if ( (-not (Test-Path -Path (Join-Path -Path $script:moduleRoot -ChildPath 'DSCResource.Tests'))) -or `
(-not (Test-Path -Path (Join-Path -Path $script:moduleRoot -ChildPath 'DSCResource.Tests\TestHelper.psm1'))) )
{
& git @('clone','https://github.com/PowerShell/DscResource.Tests.git',(Join-Path -Path $script:moduleRoot -ChildPath '\DSCResource.Tests\'))
}
Import-Module (Join-Path -Path $script:moduleRoot -ChildPath 'DSCResource.Tests\TestHelper.psm1') -Force
Import-Module (Join-Path -Path $script:moduleRoot -ChildPath "$($script:DSCModuleName).psd1") -Force
$TestEnvironment = Initialize-TestEnvironment `
-DSCModuleName $script:DSCModuleName `
-DSCResourceName 'All' `
-TestType Integration
#endregion
# Using try/finally to always cleanup even if something awful happens.
try
{
Describe "$($script:DSCModuleName)_CommonModuleConflict" {
foreach ($moduleToTest in $script:ModulesToTest)
{
It "Should be able to install DSC Resource module '$moduleToTest'" {
{
Install-Module -Name $moduleToTest -ErrorAction Stop
} | Should Not Throw
}
}
}
}
finally
{
#region FOOTER
Restore-TestEnvironment -TestEnvironment $TestEnvironment
#endregion
}
|
PowerShellCorpus/PowerShellGallery/xCertificate/2.7.0.0/Tests/Integration/MSFT_xCertificateExport.config.ps1
|
MSFT_xCertificateExport.config.ps1
|
Configuration MSFT_xCertificateExport_Config {
Import-DscResource -ModuleName xCertificate
node localhost {
if ($Node.Type -in @('Cert','P7B','SST'))
{
xCertificateExport Integration_Test {
Path = $Node.Path
FriendlyName = $Node.FriendlyName
Subject = $Node.Subject
DNSName = $node.DNSName
Issuer = $Node.Issuer
KeyUsage = $Node.KeyUsage
EnhancedKeyUsage = $Node.EnhancedKeyUsage
Type = $Node.Type
MatchSource = $Node.MatchSource
}
}
elseif ($Node.Type -eq 'PFX')
{
xCertificateExport Integration_Test {
Path = $Node.Path
FriendlyName = $Node.FriendlyName
Subject = $Node.Subject
DNSName = $node.DNSName
Issuer = $Node.Issuer
KeyUsage = $Node.KeyUsage
EnhancedKeyUsage = $Node.EnhancedKeyUsage
Type = $Node.Type
MatchSource = $Node.MatchSource
ChainOption = 'BuildChain'
Password = $Node.Password
}
}
}
}
|
PowerShellCorpus/PowerShellGallery/xCertificate/2.7.0.0/Tests/Integration/MSFT_xCertReq.Integration.Tests.ps1
|
MSFT_xCertReq.Integration.Tests.ps1
|
<#
IMPORTANT INFORMATION:
Running these tests requires access to a AD CS Certificate Authority.
These integration tests are configured to use credentials to connect to the CA.
Therefore, automation of these tests shouldn't be performed using a production CA.
#>
$script:DSCModuleName = 'xCertificate'
$script:DSCResourceName = 'MSFT_xCertReq'
<#
These tests can only be run if a CA is available and configured to be used on the
computer running these tests. This is usually required to be a domain joined computer.
#>
$CertUtilResult = & "$env:SystemRoot\system32\certutil.exe" @('-dump')
$Result = ([regex]::matches($CertUtilResult,'Name:[ \t]+`([\sA-Za-z0-9._-]+)''','IgnoreCase'))
if ([String]::IsNullOrEmpty($Result))
{
Describe "$($script:DSCResourceName)_Integration" {
It 'should complete integration tests' {
} -Skip
}
return
} # if
#region HEADER
# Integration Test Template Version: 1.1.0
[String] $script:moduleRoot = Split-Path -Parent (Split-Path -Parent $PSScriptRoot)
if ( (-not (Test-Path -Path (Join-Path -Path $script:moduleRoot -ChildPath 'DSCResource.Tests'))) -or `
(-not (Test-Path -Path (Join-Path -Path $script:moduleRoot -ChildPath 'DSCResource.Tests\TestHelper.psm1'))) )
{
& git @('clone','https://github.com/PowerShell/DscResource.Tests.git',(Join-Path -Path $script:moduleRoot -ChildPath '\DSCResource.Tests\'))
}
Import-Module (Join-Path -Path $script:moduleRoot -ChildPath 'DSCResource.Tests\TestHelper.psm1') -Force
$TestEnvironment = Initialize-TestEnvironment `
-DSCModuleName $script:DSCModuleName `
-DSCResourceName $script:DSCResourceName `
-TestType Integration
#endregion
# Using try/finally to always cleanup even if something awful happens.
try
{
#region Integration Tests
$ConfigFile = Join-Path -Path $PSScriptRoot -ChildPath "$($script:DSCResourceName).config.ps1"
. $ConfigFile
Describe "$($script:DSCResourceName)_Integration" {
#region DEFAULT TESTS
It 'Should compile and apply the MOF without throwing' {
{
# This is to allow the testing of certreq with domain credentials
$ConfigData = @{
AllNodes = @(
@{
NodeName = 'localhost'
PsDscAllowDomainUser = $true
PsDscAllowPlainTextPassword = $true
}
)
}
& "$($script:DSCResourceName)_Config" `
-OutputPath $TestDrive `
-ConfigurationData $ConfigData
Start-DscConfiguration -Path $TestDrive -ComputerName localhost -Wait -Verbose -Force
} | Should Not Throw
}
It 'Should be able to call Get-DscConfiguration without throwing' {
{ Get-DscConfiguration -Verbose -ErrorAction Stop } | Should Not Throw
}
#endregion
It 'Should have set the resource and all the parameters should match' {
# Get the Certificate details
$CertificateNew = Get-Childitem -Path Cert:\LocalMachine\My |
Where-Object -FilterScript {
$_.Subject -eq "CN=$($TestCertReq.Subject)" -and `
$_.Issuer.split(',')[0] -eq "CN=$($TestCertReq.CARootName)"
}
$CertificateNew.Subject | Should Be "CN=$($TestCertReq.Subject)"
$CertificateNew.Issuer.split(',')[0] | Should Be "CN=$($TestCertReq.CARootName)"
$CertificateNew.Publickey.Key.KeySize | Should Be $TestCertReq.KeyLength
}
AfterAll {
# Cleanup
$CertificateNew = Get-Childitem -Path Cert:\LocalMachine\My |
Where-Object -FilterScript {
$_.Subject -eq "CN=$($TestCertReq.Subject)" -and `
$_.Issuer.split(',')[0] -eq "CN=$($TestCertReq.CARootName)"
}
Remove-Item `
-Path $CertificateNew.PSPath `
-Force `
-ErrorAction SilentlyContinue
}
}
#endregion
}
finally
{
#region FOOTER
Restore-TestEnvironment -TestEnvironment $TestEnvironment
#endregion
}
|
PowerShellCorpus/PowerShellGallery/xCertificate/2.7.0.0/Tests/Integration/MSFT_xPfxImport_remove.config.ps1
|
MSFT_xPfxImport_remove.config.ps1
|
Configuration MSFT_xPfxImport_Remove_Config {
param
(
$Thumbprint,
$Path
)
Import-DscResource -ModuleName xCertificate
node localhost {
xPfxImport Integration_Test {
Thumbprint = $Thumbprint
Path = $Path
Location = 'LocalMachine'
Store = 'My'
Ensure = 'Absent'
}
}
}
|
PowerShellCorpus/PowerShellGallery/xCertificate/2.7.0.0/Tests/Integration/MSFT_xCertificateImport_remove.config.ps1
|
MSFT_xCertificateImport_remove.config.ps1
|
Configuration MSFT_xCertificateImport_Remove_Config {
param
(
$Thumbprint,
$Path
)
Import-DscResource -ModuleName xCertificate
node localhost {
xCertificateImport Integration_Test {
Thumbprint = $Thumbprint
Path = $Path
Location = 'LocalMachine'
Store = 'My'
Ensure = 'Absent'
}
}
}
|
PowerShellCorpus/PowerShellGallery/xUtility/1.0.15/Main/Test-AdminRights.ps1
|
Test-AdminRights.ps1
|
<#
.SYNOPSIS
Test current process for administrative rights
.DESCRIPTION
Test current process for administrative rights
.EXAMPLE
PS> Test-AdminRights
Returns $true when current session has administrative rights and false otherwise
#>
function Test-AdminRights {
[CmdletBinding()]
param()
$userPrincipal = [Security.Principal.WindowsPrincipal] [Security.Principal.WindowsIdentity]::GetCurrent()
Write-Output $userPrincipal.IsInRole([Security.Principal.WindowsBuiltInRole]::Administrator)
}
Set-Alias IsAdmin Test-AdminRights
|
PowerShellCorpus/PowerShellGallery/xUtility/1.0.15/Main/Set-Title.ps1
|
Set-Title.ps1
|
<#
.SYNOPSIS
Sets the PowerShell window Title
.DESCRIPTION
Sets the PowerShell window Title to the given message. Use -Persist to make this title
a default for all consoles that load xUtility
.EXAMPLE
PS> Set-Title -Message "Hello World"
Sets the console title to "Hello World"
.EXAMPLE
PS> Set-Title -Message "Hello World" -Persist
Sets the console title to "Hello World" and make it as default for all sessions that load
xUtility module
.EXAMPLE
PS> Set-Title -Clear
Removes the default console title that is set when xUtility is loaded
#>
function Set-Title {
[CmdletBinding(DefaultParameterSetName = "Title")]
param(
[Parameter(Mandatory, Position = 0, ParameterSetName = "Title")]
[ValidateNotNullOrEmpty()]
# Message to set the window title to
[string] $Message,
[Parameter(ParameterSetName = "Title")]
# Switch to persist the title to other sessions
[switch] $Persist = $false,
[Parameter(ParameterSetName = "Clear")]
# Removes the default title
[switch] $Clear = $false
)
if ($Clear) {
if ((Test-Path $script:localSetTitleMessage)) {
Invoke-ScriptBlockWithRetry -Context { Remove-Item $script:localSetTitleMessage } -RetryPolicy $script:setTitleRetryPolicy
}
$host.UI.RawUI.WindowTitle = "PowerShell"
return
}
$host.UI.RawUI.WindowTitle = $Message
if ($Persist) {
Invoke-ScriptBlockWithRetry -Context { $Message | Out-File $script:localSetTitleMessage } -RetryPolicy $script:setTitleRetryPolicy
}
}
# Script initialization
$script:localSetTitlePath = Join-Path -Path $script:moduleWorkPath -ChildPath "Set-Title"
$script:setTitleRetryPolicy = New-RetryPolicy -Policy $script:setTitlePolicyName -Milliseconds $script:setTitleWaitTime -Retries $script:setTitleRetries
if (-not (Test-Path $script:localSetTitlePath)) {
New-Item -ItemType 'Directory' -Path $script:localSetTitlePath | Write-Verbose
}
$script:localSetTitleMessage = Join-Path -Path $script:localSetTitlePath -ChildPath "title.txt"
if ((Test-Path $script:localSetTitleMessage)) {
$fileRetrieval = {
Get-Content $script:localSetTitleMessage
}
$host.UI.RawUI.WindowTitle = Invoke-ScriptBlockWithRetry -Context $fileRetrieval -RetryPolicy $script:setTitleRetryPolicy
}
|
PowerShellCorpus/PowerShellGallery/xUtility/1.0.15/Main/Get-ExpiringCacheItem.ps1
|
Get-ExpiringCacheItem.ps1
|
<#
.SYNOPSIS
Retrives a value from the local expiring cache
.DESCRIPTION
Retrieves either the cached value, or call the invocation
definition to get a new value, which after being cached is
returned to the caller
.EXAMPLE
PS> Get-ExpiringCacheItem -Key 'SomeKey'
Retrieves the cached item for the given key, if the cache is expired the cache
is updated with the new definition and returned to the caller
#>
function Get-ExpiringCacheItem {
[CmdletBinding()]
param(
[Parameter(Mandatory)]
[ValidateNotNullOrEmpty()]
# The key to access the cached item
[string] $Key = ""
)
$ErrorActionPreference = "Stop"
if (-not $script:expiringCacheObjects.Contains($Key)) {
Write-Error "Item with key '$Key' was not found in the cache"
}
$cachedItem = $script:expiringCacheObjects[$Key]
$now = Get-Date
$refreshTime = $cachedItem.LastRefresh + $cachedItem.Expiration
if ($refreshTime -lt $now) {
# Need to refresh cache
$cachedItem.Item = . $cachedItem.ItemDefinition
$cachedItem.LastRefresh = $now
$script:expiringCacheObjects[$Key] = $cachedItem
}
# Return cached object
Write-Output $cachedItem.Item
}
|
PowerShellCorpus/PowerShellGallery/xUtility/1.0.15/Main/Get-WindowSize.ps1
|
Get-WindowSize.ps1
|
<#
.SYNOPSIS
Gets the size and buffer size for the current console
.DESCRIPTION
Returns an object that reflects the size of the current console window
and the current buffer size
#>
function Get-WindowSize {
[CmdletBinding()]
param()
$currentBuffer = $Host.UI.RawUI.BufferSize
$currentWindow = $Host.UI.RawUI.WindowSize
Write-Output ([PSCustomObject] @{
Window = $currentWindow
Buffer = $currentBuffer
})
}
|
PowerShellCorpus/PowerShellGallery/xUtility/1.0.15/Main/Set-SymbolicLinkBehavior.ps1
|
Set-SymbolicLinkBehavior.ps1
|
<#
.SYNOPSIS
Sets symbolic link behavior
.DESCRIPTION
Enables or disable specific symbolic link behavior
.EXAMPLE
PS> Set-SymbolicLinkBehavior -Enable -L2L
Enables symbolic link behavior for the provided behaviors
.EXAMPLE
PS> Set-SymbolicLinkBehavior -Enable -L2L -R2R -L2R -R2L
Enables symbolic link behavior for the provided behaviors
.EXAMPLE
PS> Set-SymbolicLinkBehavior -Disable -L2L -R2R -L2R -R2L
Disables symbolic link behavior for the provided behaviors
.NOTES
These operations require administrative rights, you can use
Invoke-PSCommand to attemt to run this cmdlet with the right
set of permissions
#>
function Set-SymbolicLinkBehavior {
[CmdletBinding()]
param(
[Parameter(Mandatory, ParameterSetName = "Enable")]
# Enables symbolic link behavior
[switch] $Enable = $false,
[Parameter(Mandatory, ParameterSetName = "Disable")]
# Disables symbolic link behavior
[switch] $Disable = $false,
[Parameter(ParameterSetName = "Enable")]
[Parameter(ParameterSetName = "Disable")]
# Left-To-Left follow behavior
[switch] $L2L = $false,
[Parameter(ParameterSetName = "Enable")]
[Parameter(ParameterSetName = "Disable")]
# Right-To-Right follow behavior
[switch] $R2R = $false,
[Parameter(ParameterSetName = "Enable")]
[Parameter(ParameterSetName = "Disable")]
# Left-To-Right follow behavior
[switch] $L2R = $false,
[Parameter(ParameterSetName = "Enable")]
[Parameter(ParameterSetName = "Disable")]
# Right-To-Left follow behavior
[switch] $R2L = $false
)
$ErrorActionPreference = "Stop"
if (-not (Test-AdminRights)) {
Write-Error "Administrative privileges are required to perform this operation"
}
if ($L2L -and $Enable) {
fsutil behavior set SymLinkEvaluation L2L:1
}
else {
fsutil behavior set SymLinkEvaluation L2L:0
}
if ($R2R -and $Enable) {
fsutil behavior set SymLinkEvaluation R2R:1
}
else {
fsutil behavior set SymLinkEvaluation R2R:0
}
if ($L2R -and $Enable) {
fsutil behavior set SymLinkEvaluation L2R:1
}
else {
fsutil behavior set SymLinkEvaluation L2R:0
}
if ($R2L -and $Enable) {
fsutil behavior set SymLinkEvaluation R2L:1
}
else {
fsutil behavior set SymLinkEvaluation R2L:0
}
}
|
PowerShellCorpus/PowerShellGallery/xUtility/1.0.15/Main/Start-SublimeText.ps1
|
Start-SublimeText.ps1
|
<#
.SYNOPSIS
Opens a given target (file or directory) in Sublime Text
.DESCRIPTION
Opens a given target (file or directory) in Sublime Text.
If Sublime Text installation folder is not found in the system it opens Sublme Text Home Page
.EXAMPLE
PS> sublime 'C:\user\myUserName\Documents'
Opens the specified folder in Sublime Text editor if installed
.EXAMPLE
PS> sublime
Opens Sublime Text editor if installed
.EXAMPLE
PS> sublime 'C:\user\myUserName\Documents\myFile.txt'
Opens the specified file in Sublime Text editor if installed
#>
function Start-SublimeText
{
[CmdletBinding()]
param(
[Parameter()]
[ValidateNotNullOrEmpty()]
[string] $Target = ""
)
$ErrorActionPreference = 'Stop'
$sublimePath = Join-Path -Path $env:ProgramFiles -ChildPath "Sublime Text 3"
if (-not (Test-Path $sublimePath)) {
Start-Process 'http://www.sublimetext.com/3'
Write-Error '[Start-SublimeText] Sublime Text 3 is not installed on the system'
}
$sublimeExe = [System.IO.FileInfo] (Join-Path -Path $sublimePath -ChildPath 'subl.exe')
. $sublimeExe $Target
}
Set-Alias sublime Start-SublimeText
|
PowerShellCorpus/PowerShellGallery/xUtility/1.0.15/Main/Invoke-PSCommand.ps1
|
Invoke-PSCommand.ps1
|
<#
.SYNOPSIS
Invokes a PowerShell command
.DESCRIPTION
Invokes a PowerShell command with the option to
elevate to an admin process to execute.
.EXAMPLE
PS> Invoke-PSCommand -Command 'dir C:\'
Attempts to execute the given command in the current session
.EXAMPLE
PS> Invoke-PSCommand -Command 'dir C:\' -ElevateIfNeeded
Checks if current user has admin rights, if not will attempt to elevate and execute the command in a
new session with admin rights
.EXAMPLE
PS> Invoke-PSCommand -Command 'dir C:\' -ElevateIfNeeded -NoExit
Checks if current user has admin rights, if not will attempt to elevate and execute the command in a
new session with admin rights. After finishing the command the session will be kept open
.EXAMPLE
PS> Invoke-PSCommand -Command 'dir C:\' -ElevateIfNeeded -NoProfile
Checks if current user has admin rights, if not will attempt to elevate and execute the command in a
new session with admin rights. The new session will not process the contents of the $Profile variable
.NOTES
If command is executed in the current context, it will be wrapped
in a ScripBlock object and then executed
#>
function Invoke-PSCommand {
[CmdletBinding()]
param(
[Parameter(Mandatory)]
[ValidateNotNullOrEmpty()]
# Command to executed
[string] $Command = "",
[Parameter()]
# Attempt to elevate to a session with admin rights if current one is not admin
[switch] $ElevateIfNeeded = $false,
[Parameter()]
# Keep the session open when attempting to open a new one with admin rights
[switch] $NoExit = $false,
[Parameter()]
# When launching a new session will not process $Profile
[switch] $NoProfile = $false
)
$isAdminProcess = Test-AdminRights
if (-not $ElevateIfNeeded -or $isAdminProcess) {
. ([ScriptBlock]::Create($Command))
return
}
# If we reach this line:
# Process is not running as admin and used -ElevateIfNeeded
# So we need to elevate
Write-Warning "Attempting to elevate."
$noExitCommand = ""
if ($NoExit) {
$noExitCommand = "-NoExit"
}
$noProfileCommand = ""
if ($NoProfile) {
$noProfileCommand = "-NoProfile"
}
$commandToRun = " $noProfileCommand $noExitCommand -c $Command"
$powerShellProcess = New-Object -TypeName System.Diagnostics.ProcessStartInfo -ArgumentList "PowerShell"
$powerShellProcess.Arguments = $commandToRun
$powerShellProcess.Verb = "runas"
[System.Diagnostics.Process]::Start($powerShellProcess)
if (-not $?) {
Write-Warning "This script requires administrative privileges. Retry using administrative privileges."
Write-Error $_
}
}
|
PowerShellCorpus/PowerShellGallery/xUtility/1.0.15/Main/Remove-ExpiringCacheItem.ps1
|
Remove-ExpiringCacheItem.ps1
|
<#
.SYNOPSIS
Removes an item from the expiring cache
.DESCRIPTION
Removes an item from the expiring cache
.EXAMPLE
PS> Remove-ExpiringCacheItem -Key "CachedItem"
Removes the item with the given key from the cache
#>
function Remove-ExpiringCacheItem {
[CmdletBinding()]
param(
[Parameter(Mandatory)]
[ValidateNotNullOrEmpty()]
# Key of the item to remove
[string] $Key = ""
)
$ErrorActionPreference = "Stop"
if (-not $script:expiringCacheObjects.Contains($Key)) {
Write-Error "An item with key '$Key' does not exist in the cache"
}
$script:expiringCacheObjects.Remove($Key)
}
|
PowerShellCorpus/PowerShellGallery/xUtility/1.0.15/Main/Set-Prompt.ps1
|
Set-Prompt.ps1
|
<#
.SYNOPSIS
Creates a custom PowerShell prompt
.DESCRIPTION
Creates a custom PowerShell prompt with the following features:
- Separates the Current Path $PWD into its own line
- Allows for quick select of the path
- Path segments are apart by hightlighted separators
- Red/Green prompt shows whether the previous operation succeeded or not
This function allows the arbitrary execution of any script block as an extension mechanism.
Callbacks can now be persisted so that succeeding session can take advantage of this.
.EXAMPLE
PS> Set-Prompt -Callback { Write-Host "[ x ]" -NoNewLine }
Causes the prompt to execute the given Script Block every time the prompt is updated, producing something like:
[ x ][ C:\Some\User\Directory ]
PS>
.EXAMPLE
PS> Set-Prompt -ClearCallback
Causes the prompt to return to its original state. This operation also removes any persisted callback
[ C:\Some\User\Directory ]
PS>
.EXAMPLE
PS> Set-Prompt -Callback { Write-Host "[ x ]" -NoNewLine } -Persist
Updates the prompt to include the callback code and also saves the callback to disk. When the module is loaded in
new sessions, their prompt will also include this definition
.NOTES
Callback code, when persisted, is loaded during Import-Module. If the callback code that is persisted changes
internally (i.e. other session updated it). Current sessions either have to be restarted or this module would have
to be Removed (Remove-Module -Name xUtility) and Re-Imported (Import-Module xUtility) for the changes to take effect.
Create an issue if this behavior is not enough for your needs.
When clearing callback an attempt to delete callback file is also made. To clear the callback from the current session
but not deleting the callback file simply use:
Set-Prompt -Callback {}
Create an issue if this behavior is not enough for your needs.
#>
function Set-Prompt {
[CmdletBinding(DefaultParameterSetName = "None")]
param(
[Parameter(ParameterSetName = "Extended")]
[ValidateNotNullOrEmpty()]
# Callback to execute every time the prompt is executed
[ScriptBlock] $Callback = $null,
[Parameter(ParameterSetName = "Extended")]
# Persist the callback to a file so that it can be used in multiple sessions
[switch] $Persist = $false,
[Parameter(ParameterSetName = "Clear")]
# Switch to clear the call of any additional execution context
[switch] $ClearCallback = $false
)
$lastOperationSucceeded = $?
if ($Callback -ne $null) {
$script:extendedPrompt = $Callback
if ($Persist) {
# Write Callback to disk
Invoke-ScriptBlockWithRetry -Context { $Callback.ToString() | Out-File $script:localSetPromptCallback } -RetryPolicy $script:setPromptRetryPolicy
}
return
}
if ($ClearCallback) {
$script:extendedPrompt = $null
if ((Test-Path -Path $script:localSetPromptCallback)) {
Invoke-ScriptBlockWithRetry -Context { Remove-Item $script:localSetPromptCallback } -RetryPolicy $script:setPromptRetryPolicy
}
return
}
if ($script:extendedPrompt -ne $null) {
. $script:extendedPrompt
}
Write-Host "[ " -ForegroundColor Cyan -NoNewLine
$PWD.Path.Split('\') | Where-Object { $_ -ne '' } | ForEach-Object {
Write-Host $_ -NoNewLine -ForegroundColor DarkGray
Write-Host "\" -NoNewLine -ForegroundColor White
}
Write-Host " ]" -ForegroundColor Cyan
if ($lastOperationSucceeded) {
Write-Host "PS" -ForegroundColor Green -NoNewLine
}
else {
Write-Host "PS" -ForegroundColor Red -NoNewLine
}
"> "
}
Set-Alias Prompt Set-Prompt
# Initialization code
$script:extendedPrompt = $null
$script:localSetPromptPath = Join-Path -Path $script:moduleWorkPath -ChildPath "Set-Prompt"
$script:setPromptRetryPolicy = New-RetryPolicy -Policy $script:setPromptPolicyName -Milliseconds $script:setPromptWaitTime -Retries $script:setPromptRetries
if (-not (Test-Path $script:localSetPromptPath)) {
New-Item -ItemType 'Directory' -Path $script:localSetPromptPath | Write-Verbose
}
$script:localSetPromptCallback = Join-Path -Path $script:localSetPromptPath -ChildPath "callback.txt"
if ((Test-Path $script:localSetPromptCallback)) {
$fileRetrieval = {
Get-Content $script:localSetPromptCallback
}
$callbackFile = Invoke-ScriptBlockWithRetry -Context $fileRetrieval -RetryPolicy $script:setPromptRetryPolicy
$callbackFile = Get-Content $script:localSetPromptCallback
$script:extendedPrompt = [ScriptBlock]::Create($callbackFile)
}
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.