13 Microsoft Teams SBA
13.1 Get-anynodeMsTeamsSba
Returns the current Microsoft Teams SBA configuration
Required Permissions
-
API
-
Administration
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
Return Value Structure
The response body is structured as MsTeamsSbaOptions JSON object. A description for its fields is at section 29.19.1. For the JSON schema refer to section 29.19.2.
13.2 Set-anynodeMsTeamsSba
Modifies the Microsoft Teams SBA configuration.
Required Permissions
-
API
-
Administration
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
-
Fingerprint
The trusted certificate fingerprint source. This needs to be the fingerprint of the Teams node, that is using the SBA service.
Type: MsTeamsSbaFingerprint
-
Identity
The identity / FQDN of the SBA
Type: String
-
TenantId
Directory (tenant) ID
Type: String
-
Application
Application (client) ID
Type: String
-
Secret
Application (client) secrect
Type: String
-
Log
Settings for the SBA log.
Type: MsTeamsSbaLog section 29.21
-
Certificate
The certificate for the SBA service
Type: CryCertificate section 29.22
-
IpAddress
The IP address for the SBA service. It is recommended to choose a local IP address.
Type: String
-
PrivateKey
The private key for the SBA service
Type: CryPrivateKey section 29.23
Return Value Structure
The response body is structured as MsTeamsSbaOptions JSON object. A description for its fields is at section 29.19.1. For the JSON schema refer to section 29.19.2.
13.3 Enable-anynodeMsTeamsSba
Enables the Microsoft Teams SBA services.
Required Permissions
-
API
-
Administration
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
13.4 Disable-anynodeMsTeamsSba
Disables the Microsoft Teams SBA services.
Required Permissions
-
API
-
Administration
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
13.5 Get-anynodeMsTeamsSbaStatus
Returns the status of the Micosoft Teams SBA service
Required Permissions
-
API
-
Administration
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 1
This parameter states which version of the request should be used.
Type: Integer
Return Value Structure
The response body is structured as MsTeamsSbaStatus JSON object. A description for its fields is at section 29.24.1. For the JSON schema refer to section 29.24.2.
13.6 Get-anynodeMsTeamsSbaPrivateKey
Returns the private key of the SBA service.
Required Permissions
-
API
-
Administration
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
13.7 Set-anynodeMsTeamsSbaPrivateKey
Sets a new private key to the SBA services.
Required Permissions
-
API
-
Administration
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
-
string: PrivateKeyPassword
The password of the private key file.
-
string: Filepath
The path to the file that will be imported.
13.8 Get-anynodeMsTeamsSbaCertificate
Returns the certificate of the SBA service.
Required Permissions
-
API
-
Administration
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
13.9 Set-anynodeMsTeamsSbaCertificate
Sets a new certificate to the SBA services.
Required Permissions
-
API
-
Administration
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
-
string: CertificatePassword
The password of the certificate file.
-
string: Filepath
The path to the file that will be imported.
13.10 Get-anynodeMsTeamsSbaFingerprint
Returns the currently configured fingerprint of the SBA service.
Required Permissions
-
API
-
Administration
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
Return Value Structure
The response body is structured as MsTeamsSbaFingerprint JSON object. A description for its fields is at section 29.20.1. For the JSON schema refer to section 29.20.2.
13.11 Set-anynodeMsTeamsSbaFingerprint
Sets a new fingerprint to the SBA service.
Required Permissions
-
API
-
Administration
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
-
Source
Determines the source of the fingerprint.
Type: FingerprintSource
Possible values:
-
NONE
-
CUSTOM
-
MS_TEAMS_NODE
-
-
Value
The fingerprint for "source"="CUSTOM"
Type: String
-
MsTeamsNodeId
Only for "source"="MS_TEAMS_NODE". The id of the Teams node, that uses the certificate. The fingerprint will be extracted automatically.
Type: String
Return Value Structure
The response body is structured as MsTeamsSbaFingerprint JSON object. A description for its fields is at section 29.20.1. For the JSON schema refer to section 29.20.2.
13.12 Get-anynodeMsTeamsSbaIpAddress
Returns the IP address of the SBA service.
Required Permissions
-
API
-
Administration
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
13.13 Set-anynodeMsTeamsSbaIpAddress
Sets the IP address of the SBA service.
Required Permissions
-
API
-
Administration
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
-
string: IpAddress
The IP address of the SBA service.
13.14 Get-anynodeMsTeamsSbaIdentity
Returns the identity / FQDN of the SBA.
Required Permissions
-
API
-
Administration
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
13.15 Set-anynodeMsTeamsSbaIdentity
Sets the identity / FQDN of the SBA.
Required Permissions
-
API
-
Administration
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
-
string: Identity
The new Identity for the SBA service.
13.16 Get-anynodeMsTeamsSbaTenantId
Returns the tenant id of the SBA service.
Required Permissions
-
API
-
Administration
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
13.17 Set-anynodeMsTeamsSbaTenantId
Sets the tenant id of the SBA service.
Required Permissions
-
API
-
Administration
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
-
string: TenantId
The new tenant id for the SBA service.
13.18 Get-anynodeMsTeamsSbaApplication
Returns the application / client id of the SBA service.
Required Permissions
-
API
-
Administration
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
13.19 Set-anynodeMsTeamsSbaApplication
Sets the application / client id of the SBA service.
Required Permissions
-
API
-
Administration
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
-
string: Application
The application / client id for the SBA service.
13.20 Set-anynodeMsTeamsSbaSecret
Sets the application / client secret of the SBA service.
Required Permissions
-
API
-
Administration
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
-
string: Secret
The application / client secret for the SBA service.
13.21 Get-anynodeMsTeamsSbaLog
Returns the logging options of the SBA service.
Required Permissions
-
API
-
Administration
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
Return Value Structure
The response body is structured as MsTeamsSbaLog JSON object. A description for its fields is at section 29.21.1. For the JSON schema refer to section 29.21.2.
13.22 Set-anynodeMsTeamsSbaLog
Sets the logging options of the SBA service.
Required Permissions
-
API
-
Administration
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
-
Directory
The directory where log files should be stored.
Type: String
-
Level
The log level
Type: MsTeamsSbaLogLevel
Possible values:
-
TRACE
-
DEBUG
-
INFO
-
WARN
-
ERROR
-
FATAL
-
-
MaxArchiveFiles
The maximum amount of log files that will be stored.
Type: Integer
Return Value Structure
The response body is structured as MsTeamsSbaLog JSON object. A description for its fields is at section 29.21.1. For the JSON schema refer to section 29.21.2.
13.23 Get-anynodeMsTeamsSbaUsers
Returns a list of the Teams SBA users.
Required Permissions
-
API
-
Administration
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
Return Value Structure
The response body is strutured as an array. The array consists of MsTeamsSbaUser JSON objects. A description for its fields is at section 29.75.1. For the JSON schema refer to section 29.75.2.
13.24 Update-anynodeMsTeamsSbaUsers
Refreshes and returns the list of the Teams SBA users.
Required Permissions
-
API
-
Administration
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
Return Value Structure
The response body is strutured as an array. The array consists of MsTeamsSbaUser JSON objects. A description for its fields is at section 29.75.1. For the JSON schema refer to section 29.75.2.