NetboxPS/Functions/Tenancy/ContactAssignment/Get-NetboxContactAssignment.ps1

108 lines
2.9 KiB
PowerShell
Raw Normal View History

2023-02-24 15:14:04 -05:00

2023-02-16 09:46:27 -05:00
function Get-NetboxContactAssignment {
<#
.SYNOPSIS
Get a contact Assignment from Netbox
2023-02-24 15:14:04 -05:00
2023-02-16 09:46:27 -05:00
.DESCRIPTION
A detailed description of the Get-NetboxContactAssignment function.
2023-02-24 15:14:04 -05:00
2023-02-16 09:46:27 -05:00
.PARAMETER Name
The specific name of the contact Assignment. Must match exactly as is defined in Netbox
2023-02-24 15:14:04 -05:00
2023-02-16 09:46:27 -05:00
.PARAMETER Id
The database ID of the contact Assignment
2023-02-24 15:14:04 -05:00
2023-02-16 09:46:27 -05:00
.PARAMETER Content_Type_Id
A description of the Content_Type_Id parameter.
2023-02-24 15:14:04 -05:00
2023-02-16 09:46:27 -05:00
.PARAMETER Content_Type
A description of the Content_Type parameter.
2023-02-24 15:14:04 -05:00
2023-02-16 09:46:27 -05:00
.PARAMETER Object_Id
A description of the Object_Id parameter.
2023-02-24 15:14:04 -05:00
2023-02-16 09:46:27 -05:00
.PARAMETER Contact_Id
A description of the Contact_Id parameter.
2023-02-24 15:14:04 -05:00
2023-02-16 09:46:27 -05:00
.PARAMETER Role_Id
A description of the Role_Id parameter.
2023-02-24 15:14:04 -05:00
2023-02-16 09:46:27 -05:00
.PARAMETER Limit
Limit the number of results to this number
2023-02-24 15:14:04 -05:00
2023-02-16 09:46:27 -05:00
.PARAMETER Offset
Start the search at this index in results
2023-02-24 15:14:04 -05:00
2023-02-16 09:46:27 -05:00
.PARAMETER Raw
Return the unparsed data from the HTTP request
2023-02-24 15:14:04 -05:00
2023-02-16 09:46:27 -05:00
.EXAMPLE
PS C:\> Get-NetboxContactAssignment
2023-02-24 15:14:04 -05:00
2023-02-16 09:46:27 -05:00
.NOTES
Additional information about the function.
#>
2023-02-24 15:14:04 -05:00
2023-02-16 09:46:27 -05:00
[CmdletBinding(DefaultParameterSetName = 'Query')]
param
(
[Parameter(ParameterSetName = 'Query',
Position = 0)]
[string]$Name,
2023-02-24 15:14:04 -05:00
2023-02-16 09:46:27 -05:00
[Parameter(ParameterSetName = 'ByID')]
v1.8.4 (#50) * Fixing Interface Type parameter (#42) * Fixing #41 * Update `deploy.ps1` to remove trailing whitespaces from psd1 * Increase version to 1.7.3 * Fix location of whitespace cleanup in `deploy.ps1` * Device port support (#44) * Fixing #41 * Correct for OTBS * Start work on Front and Rear ports * Revert "Start work on Front and Rear ports" This reverts commit 257709fe2af5af5fbe4496b2d5b68481d80bf101. * Fixing #41 * Add-NetboxDCIMRearPort function * Revert "Revert "Start work on Front and Rear ports"" This reverts commit 4f6625af2dd95a5797da0efcff40774095ad2e95. * Fix incorrect parameter variable types * Parameter type adjustments * Create function to get tag information * Added Mark_Connected parameter * Add Set-NetboxDCIMRearPort function * Added Remove-NetboxDCIMRearPort function * Added validate pattern for Color parameter * Added Add-NetboxDCIMFrontPort function * Fixed param list missing Force parameter * Added Set-NetboxDCIMFrontPort function * Added Remove-NetboxDCIMFrontPort function * Init. functions for cables and cable terminations * Reformatting using OTBS Also working on defining tags by slug as an extra parameter, which appears only in Add-NetboxDCIMRearPort currently * Remove Tags_Slug parameter In hindsight implementing would create extra work that could be hard to maintain. Can be easily achieved outside of the function. * Update psproj * Fix braces * Update Postman for Netbox v3.4.5 * Update vscode settings * Update version 1.8.0 * Update psproj * Update `uint16` to `uint64` where applicable for #49 * dev v1.8.1 * More `uint64` updates for #49 * `[uint64]` updates * Add IPAMAddressRange functions * Move limit/offset parameters to end of list * Update psproj with IPAMAddressRange files * Remove whitespaces * Update version to 1.8.3 * Add Set-NetboxIPAMAddressRange * Remove incorrect parameter * Update version to 1.8.4 --------- Co-authored-by: SheffSix <jbeck1867@gmail.com> Co-authored-by: James Beck <jim@beck81.co.uk>
2023-11-07 10:30:05 -05:00
[uint64[]]$Id,
2023-02-24 15:14:04 -05:00
2023-02-16 09:46:27 -05:00
[Parameter(ParameterSetName = 'Query')]
v1.8.4 (#50) * Fixing Interface Type parameter (#42) * Fixing #41 * Update `deploy.ps1` to remove trailing whitespaces from psd1 * Increase version to 1.7.3 * Fix location of whitespace cleanup in `deploy.ps1` * Device port support (#44) * Fixing #41 * Correct for OTBS * Start work on Front and Rear ports * Revert "Start work on Front and Rear ports" This reverts commit 257709fe2af5af5fbe4496b2d5b68481d80bf101. * Fixing #41 * Add-NetboxDCIMRearPort function * Revert "Revert "Start work on Front and Rear ports"" This reverts commit 4f6625af2dd95a5797da0efcff40774095ad2e95. * Fix incorrect parameter variable types * Parameter type adjustments * Create function to get tag information * Added Mark_Connected parameter * Add Set-NetboxDCIMRearPort function * Added Remove-NetboxDCIMRearPort function * Added validate pattern for Color parameter * Added Add-NetboxDCIMFrontPort function * Fixed param list missing Force parameter * Added Set-NetboxDCIMFrontPort function * Added Remove-NetboxDCIMFrontPort function * Init. functions for cables and cable terminations * Reformatting using OTBS Also working on defining tags by slug as an extra parameter, which appears only in Add-NetboxDCIMRearPort currently * Remove Tags_Slug parameter In hindsight implementing would create extra work that could be hard to maintain. Can be easily achieved outside of the function. * Update psproj * Fix braces * Update Postman for Netbox v3.4.5 * Update vscode settings * Update version 1.8.0 * Update psproj * Update `uint16` to `uint64` where applicable for #49 * dev v1.8.1 * More `uint64` updates for #49 * `[uint64]` updates * Add IPAMAddressRange functions * Move limit/offset parameters to end of list * Update psproj with IPAMAddressRange files * Remove whitespaces * Update version to 1.8.3 * Add Set-NetboxIPAMAddressRange * Remove incorrect parameter * Update version to 1.8.4 --------- Co-authored-by: SheffSix <jbeck1867@gmail.com> Co-authored-by: James Beck <jim@beck81.co.uk>
2023-11-07 10:30:05 -05:00
[uint64]$Content_Type_Id,
2023-02-24 15:14:04 -05:00
2023-02-16 09:46:27 -05:00
[Parameter(ParameterSetName = 'Query')]
[string]$Content_Type,
2023-02-24 15:14:04 -05:00
2023-02-16 09:46:27 -05:00
[Parameter(ParameterSetName = 'Query')]
v1.8.4 (#50) * Fixing Interface Type parameter (#42) * Fixing #41 * Update `deploy.ps1` to remove trailing whitespaces from psd1 * Increase version to 1.7.3 * Fix location of whitespace cleanup in `deploy.ps1` * Device port support (#44) * Fixing #41 * Correct for OTBS * Start work on Front and Rear ports * Revert "Start work on Front and Rear ports" This reverts commit 257709fe2af5af5fbe4496b2d5b68481d80bf101. * Fixing #41 * Add-NetboxDCIMRearPort function * Revert "Revert "Start work on Front and Rear ports"" This reverts commit 4f6625af2dd95a5797da0efcff40774095ad2e95. * Fix incorrect parameter variable types * Parameter type adjustments * Create function to get tag information * Added Mark_Connected parameter * Add Set-NetboxDCIMRearPort function * Added Remove-NetboxDCIMRearPort function * Added validate pattern for Color parameter * Added Add-NetboxDCIMFrontPort function * Fixed param list missing Force parameter * Added Set-NetboxDCIMFrontPort function * Added Remove-NetboxDCIMFrontPort function * Init. functions for cables and cable terminations * Reformatting using OTBS Also working on defining tags by slug as an extra parameter, which appears only in Add-NetboxDCIMRearPort currently * Remove Tags_Slug parameter In hindsight implementing would create extra work that could be hard to maintain. Can be easily achieved outside of the function. * Update psproj * Fix braces * Update Postman for Netbox v3.4.5 * Update vscode settings * Update version 1.8.0 * Update psproj * Update `uint16` to `uint64` where applicable for #49 * dev v1.8.1 * More `uint64` updates for #49 * `[uint64]` updates * Add IPAMAddressRange functions * Move limit/offset parameters to end of list * Update psproj with IPAMAddressRange files * Remove whitespaces * Update version to 1.8.3 * Add Set-NetboxIPAMAddressRange * Remove incorrect parameter * Update version to 1.8.4 --------- Co-authored-by: SheffSix <jbeck1867@gmail.com> Co-authored-by: James Beck <jim@beck81.co.uk>
2023-11-07 10:30:05 -05:00
[uint64]$Object_Id,
2023-02-24 15:14:04 -05:00
2023-02-16 09:46:27 -05:00
[Parameter(ParameterSetName = 'Query')]
v1.8.4 (#50) * Fixing Interface Type parameter (#42) * Fixing #41 * Update `deploy.ps1` to remove trailing whitespaces from psd1 * Increase version to 1.7.3 * Fix location of whitespace cleanup in `deploy.ps1` * Device port support (#44) * Fixing #41 * Correct for OTBS * Start work on Front and Rear ports * Revert "Start work on Front and Rear ports" This reverts commit 257709fe2af5af5fbe4496b2d5b68481d80bf101. * Fixing #41 * Add-NetboxDCIMRearPort function * Revert "Revert "Start work on Front and Rear ports"" This reverts commit 4f6625af2dd95a5797da0efcff40774095ad2e95. * Fix incorrect parameter variable types * Parameter type adjustments * Create function to get tag information * Added Mark_Connected parameter * Add Set-NetboxDCIMRearPort function * Added Remove-NetboxDCIMRearPort function * Added validate pattern for Color parameter * Added Add-NetboxDCIMFrontPort function * Fixed param list missing Force parameter * Added Set-NetboxDCIMFrontPort function * Added Remove-NetboxDCIMFrontPort function * Init. functions for cables and cable terminations * Reformatting using OTBS Also working on defining tags by slug as an extra parameter, which appears only in Add-NetboxDCIMRearPort currently * Remove Tags_Slug parameter In hindsight implementing would create extra work that could be hard to maintain. Can be easily achieved outside of the function. * Update psproj * Fix braces * Update Postman for Netbox v3.4.5 * Update vscode settings * Update version 1.8.0 * Update psproj * Update `uint16` to `uint64` where applicable for #49 * dev v1.8.1 * More `uint64` updates for #49 * `[uint64]` updates * Add IPAMAddressRange functions * Move limit/offset parameters to end of list * Update psproj with IPAMAddressRange files * Remove whitespaces * Update version to 1.8.3 * Add Set-NetboxIPAMAddressRange * Remove incorrect parameter * Update version to 1.8.4 --------- Co-authored-by: SheffSix <jbeck1867@gmail.com> Co-authored-by: James Beck <jim@beck81.co.uk>
2023-11-07 10:30:05 -05:00
[uint64]$Contact_Id,
2023-02-24 15:14:04 -05:00
2023-02-16 09:46:27 -05:00
[Parameter(ParameterSetName = 'Query')]
v1.8.4 (#50) * Fixing Interface Type parameter (#42) * Fixing #41 * Update `deploy.ps1` to remove trailing whitespaces from psd1 * Increase version to 1.7.3 * Fix location of whitespace cleanup in `deploy.ps1` * Device port support (#44) * Fixing #41 * Correct for OTBS * Start work on Front and Rear ports * Revert "Start work on Front and Rear ports" This reverts commit 257709fe2af5af5fbe4496b2d5b68481d80bf101. * Fixing #41 * Add-NetboxDCIMRearPort function * Revert "Revert "Start work on Front and Rear ports"" This reverts commit 4f6625af2dd95a5797da0efcff40774095ad2e95. * Fix incorrect parameter variable types * Parameter type adjustments * Create function to get tag information * Added Mark_Connected parameter * Add Set-NetboxDCIMRearPort function * Added Remove-NetboxDCIMRearPort function * Added validate pattern for Color parameter * Added Add-NetboxDCIMFrontPort function * Fixed param list missing Force parameter * Added Set-NetboxDCIMFrontPort function * Added Remove-NetboxDCIMFrontPort function * Init. functions for cables and cable terminations * Reformatting using OTBS Also working on defining tags by slug as an extra parameter, which appears only in Add-NetboxDCIMRearPort currently * Remove Tags_Slug parameter In hindsight implementing would create extra work that could be hard to maintain. Can be easily achieved outside of the function. * Update psproj * Fix braces * Update Postman for Netbox v3.4.5 * Update vscode settings * Update version 1.8.0 * Update psproj * Update `uint16` to `uint64` where applicable for #49 * dev v1.8.1 * More `uint64` updates for #49 * `[uint64]` updates * Add IPAMAddressRange functions * Move limit/offset parameters to end of list * Update psproj with IPAMAddressRange files * Remove whitespaces * Update version to 1.8.3 * Add Set-NetboxIPAMAddressRange * Remove incorrect parameter * Update version to 1.8.4 --------- Co-authored-by: SheffSix <jbeck1867@gmail.com> Co-authored-by: James Beck <jim@beck81.co.uk>
2023-11-07 10:30:05 -05:00
[uint64]$Role_Id,
2023-02-24 15:14:04 -05:00
2023-02-16 09:46:27 -05:00
[Parameter(ParameterSetName = 'Query')]
[uint16]$Limit,
2023-02-24 15:14:04 -05:00
2023-02-16 09:46:27 -05:00
[Parameter(ParameterSetName = 'Query')]
[uint16]$Offset,
2023-02-24 15:14:04 -05:00
2023-02-16 09:46:27 -05:00
[switch]$Raw
)
2023-02-24 15:14:04 -05:00
2023-02-16 09:46:27 -05:00
switch ($PSCmdlet.ParameterSetName) {
'ById' {
foreach ($ContactAssignment_ID in $Id) {
$Segments = [System.Collections.ArrayList]::new(@('tenancy', 'contact-assignments', $ContactAssignment_ID))
2023-02-24 15:14:04 -05:00
2023-02-16 09:46:27 -05:00
$URIComponents = BuildURIComponents -URISegments $Segments -ParametersDictionary $PSBoundParameters -SkipParameterByName 'Id'
2023-02-24 15:14:04 -05:00
2023-02-16 09:46:27 -05:00
$uri = BuildNewURI -Segments $URIComponents.Segments -Parameters $URIComponents.Parameters
2023-02-24 15:14:04 -05:00
2023-02-16 09:46:27 -05:00
InvokeNetboxRequest -URI $uri -Raw:$Raw
}
2023-02-24 15:14:04 -05:00
2023-02-16 09:46:27 -05:00
break
}
2023-02-24 15:14:04 -05:00
2023-02-16 09:46:27 -05:00
default {
$Segments = [System.Collections.ArrayList]::new(@('tenancy', 'contact-assignments'))
2023-02-24 15:14:04 -05:00
2023-02-16 09:46:27 -05:00
$URIComponents = BuildURIComponents -URISegments $Segments -ParametersDictionary $PSBoundParameters
2023-02-24 15:14:04 -05:00
2023-02-16 09:46:27 -05:00
$uri = BuildNewURI -Segments $URIComponents.Segments -Parameters $URIComponents.Parameters
2023-02-24 15:14:04 -05:00
2023-02-16 09:46:27 -05:00
InvokeNetboxRequest -URI $uri -Raw:$Raw
2023-02-24 15:14:04 -05:00
2023-02-16 09:46:27 -05:00
break
}
}
}