Add-ITGlueBaseURI
SYNOPSIS
Sets the base URI for the ITGlue API connection
SYNTAX
Add-ITGlueBaseURI [[-BaseUri] <String>] [[-DataCenter] <String>] [<CommonParameters>]
DESCRIPTION
The Add-ITGlueBaseURI cmdlet sets the base URI which is used to construct the full URI for all API calls
EXAMPLES
EXAMPLE 1
Add-ITGlueBaseURI
The base URI will use https://api.itglue.com
EXAMPLE 2
Add-ITGlueBaseURI -BaseUri 'https://my.gateway.com'
The base URI will use https://my.gateway.com
EXAMPLE 3
'https://my.gateway.com' | Add-ITGlueBaseURI
The base URI will use https://my.gateway.com
EXAMPLE 4
Add-ITGlueBaseURI -DataCenter EU
The base URI will use https://api.eu.itglue.com
PARAMETERS
-BaseUri
Sets the base URI for the ITGlue API connection. Helpful if using a custom API gateway
The default value is ‘https://api.itglue.com’
Type: String
Parameter Sets: (All)
Aliases: base_uri
Required: False
Position: 1
Default value: Https://api.itglue.com
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-DataCenter
Defines the data center to use which in turn defines which base API URL is used
Allowed values: ‘US’, ‘EU’, ‘AU’
'US' = 'https://api.itglue.com'
'EU' = 'https://api.eu.itglue.com'
'AU' = 'https://api.au.itglue.com'
Type: String
Parameter Sets: (All)
Aliases: locale, dc, data_center
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
INPUTS
OUTPUTS
NOTES
N/A
RELATED LINKS
https://celerium.github.io/ITGlue-PowerShellWrapper/site/Internal/Add-ITGlueBaseURI.html