|
1 |
| ---- |
2 |
| -external help file: Microsoft.Rtc.Management.dll-Help.xml |
3 |
| -applicable: Skype for Business Server 2019 |
4 |
| -title: Set-CsCloudCallDataConnector |
5 |
| -online version: |
6 |
| -schema: 2.0.0 |
7 |
| ---- |
8 |
| - |
9 |
| -# Set-CsCloudCallDataConnector |
10 |
| - |
11 |
| -## SYNOPSIS |
12 |
| -Saves an on-premises copy of the connection information created by the New-CsCloudCallDataConnection cmdlet. |
13 |
| - |
14 |
| -## SYNTAX |
15 |
| - |
16 |
| -### Instance |
17 |
| -``` |
18 |
| -Set-CsCloudCallDataConnector [-Token <String>] [-TenantId <String>] [-Instance <PSObject>] [-Force] [-WhatIf] |
19 |
| - [-Confirm] [<CommonParameters>] |
20 |
| -``` |
21 |
| - |
22 |
| -## DESCRIPTION |
23 |
| -Call Data Connector provides a single view in a hybrid environment where you can view the on-premises and online call quality data in one place. |
24 |
| - |
25 |
| -The Set-CsCloudCallDataConnector cmdlet provides a way for you to store an on-premise copy of the cloud connection information created by the New-CsCloudCallDataConnection cmdlet. |
26 |
| - |
27 |
| -## EXAMPLES |
28 |
| - |
29 |
| -### Example 1 |
30 |
| -```powershell |
31 |
| -PS C:\> New-CsCloudCallDataConnection | Set-CsCloudCallDataConnector -TenantId <tenant_id> |
32 |
| -``` |
33 |
| - |
34 |
| -If you're logged in to Skype for Business Online Powershell within the Skype for Business Server Management Shell 2019, this command in example 1 takes the output of the New-CsCloudCallDataConnection online cmdlet and passes it to the Set-CsCloudCallDataConnector cmdlet via pipeline so that the Token can be stored on premises. Along with the Token, the TenantId of your O365 tenant will get stored on premises as well. |
35 |
| - |
36 |
| -### Example 2 |
37 |
| -Example showing the scenario when we aren't piping the output from online cmdlet. |
38 |
| - |
39 |
| -## PARAMETERS |
40 |
| - |
41 |
| -### -Confirm |
42 |
| -Prompts you for confirmation before running the cmdlet. |
43 |
| - |
44 |
| -```yaml |
45 |
| -Type: SwitchParameter |
46 |
| -Parameter Sets: (All) |
47 |
| -Aliases: cf |
48 |
| -applicable: Skype for Business Server 2019 |
49 |
| -Required: False |
50 |
| -Position: Named |
51 |
| -Default value: None |
52 |
| -Accept pipeline input: False |
53 |
| -Accept wildcard characters: False |
54 |
| -``` |
55 |
| -
|
56 |
| -### -Force |
57 |
| -Suppresses the display of any non-fatal error message that might occur when running the command. |
58 |
| -
|
59 |
| -```yaml |
60 |
| -Type: SwitchParameter |
61 |
| -Parameter Sets: (All) |
62 |
| -Aliases: |
63 |
| -applicable: Skype for Business Server 2019 |
64 |
| -Required: False |
65 |
| -Position: Named |
66 |
| -Default value: None |
67 |
| -Accept pipeline input: False |
68 |
| -Accept wildcard characters: False |
69 |
| -``` |
70 |
| -
|
71 |
| -### -Instance |
72 |
| -Allows you to pass a reference to an object to the cmdlet, rather than set individual parameter values. |
73 |
| -
|
74 |
| -```yaml |
75 |
| -Type: PSObject |
76 |
| -Parameter Sets: Instance |
77 |
| -Aliases: |
78 |
| -applicable: Skype for Business Server 2019 |
79 |
| -Required: False |
80 |
| -Position: Named |
81 |
| -Default value: None |
82 |
| -Accept pipeline input: True (ByValue) |
83 |
| -Accept wildcard characters: False |
84 |
| -``` |
85 |
| -
|
86 |
| -### -TenantId |
87 |
| -Office 365 TenantID of your tenant. |
88 |
| -
|
89 |
| -```yaml |
90 |
| -Type: String |
91 |
| -Parameter Sets: (All) |
92 |
| -Aliases: |
93 |
| -applicable: Skype for Business Server 2019 |
94 |
| -Required: False |
95 |
| -Position: Named |
96 |
| -Default value: None |
97 |
| -Accept pipeline input: False |
98 |
| -Accept wildcard characters: False |
99 |
| -``` |
100 |
| -
|
101 |
| -### -Token |
102 |
| -Data ingestion token for CloudCallDataConnector telemetry endpoint. |
103 |
| -
|
104 |
| -```yaml |
105 |
| -Type: String |
106 |
| -Parameter Sets: (All) |
107 |
| -Aliases: |
108 |
| -applicable: Skype for Business Server 2019 |
109 |
| -Required: False |
110 |
| -Position: Named |
111 |
| -Default value: None |
112 |
| -Accept pipeline input: True (ByPropertyName, ByValue) |
113 |
| -Accept wildcard characters: False |
114 |
| -``` |
115 |
| -
|
116 |
| -### -WhatIf |
117 |
| -Shows what would happen if the cmdlet runs. |
118 |
| -The cmdlet is not run. |
119 |
| -
|
120 |
| -```yaml |
121 |
| -Type: SwitchParameter |
122 |
| -Parameter Sets: (All) |
123 |
| -Aliases: wi |
124 |
| -applicable: Skype for Business Server 2019 |
125 |
| -Required: False |
126 |
| -Position: Named |
127 |
| -Default value: None |
128 |
| -Accept pipeline input: False |
129 |
| -Accept wildcard characters: False |
130 |
| -``` |
131 |
| -
|
132 |
| -### CommonParameters |
133 |
| -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. |
134 |
| -For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). |
135 |
| -
|
136 |
| -## INPUTS |
137 |
| -
|
138 |
| -### System.String |
139 |
| -Microsoft.Rtc.Management.WritableConfig.Settings.CloudCallDataConnection. The \`Set-CsCloudCallDataConnector\` cmdlet accepts pipelined input of CloudCallDataConnection. |
140 |
| -
|
141 |
| -
|
142 |
| -## OUTPUTS |
143 |
| -
|
144 |
| -### The `Set-CsCloudCallDataConnector` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Settings.CloudCallDataConnection object. |
145 |
| - |
146 |
| -## NOTES |
147 |
| - |
148 |
| -## RELATED LINKS |
| 1 | +--- |
| 2 | +external help file: Microsoft.Rtc.Management.dll-Help.xml |
| 3 | +applicable: Skype for Business Server 2019 |
| 4 | +title: Set-CsCloudCallDataConnector |
| 5 | +online version: |
| 6 | +schema: 2.0.0 |
| 7 | +--- |
| 8 | + |
| 9 | +# Set-CsCloudCallDataConnector |
| 10 | + |
| 11 | +## SYNOPSIS |
| 12 | +Saves an on-premises copy of the connection information created by the New-CsCloudCallDataConnection cmdlet. |
| 13 | + |
| 14 | +## SYNTAX |
| 15 | + |
| 16 | +### Instance |
| 17 | +``` |
| 18 | +Set-CsCloudCallDataConnector [-Token <String>] [-TenantId <String>] [-Instance <PSObject>] [-Force] [-WhatIf] |
| 19 | + [-Confirm] [<CommonParameters>] |
| 20 | +``` |
| 21 | + |
| 22 | +## DESCRIPTION |
| 23 | +Call Data Connector provides a single view in a hybrid environment where you can view the on-premises and online call quality data in one place. |
| 24 | + |
| 25 | +The Set-CsCloudCallDataConnector cmdlet provides a way for you to store an on-premise copy of the cloud connection information created by the New-CsCloudCallDataConnection cmdlet. |
| 26 | + |
| 27 | +## EXAMPLES |
| 28 | + |
| 29 | +### Example 1 |
| 30 | +```powershell |
| 31 | +PS C:\> New-CsCloudCallDataConnection | Set-CsCloudCallDataConnector -TenantId <tenant_id> |
| 32 | +``` |
| 33 | + |
| 34 | +If you're logged in to Skype for Business Online Powershell within the Skype for Business Server Management Shell 2019, this command in example 1 takes the output of the New-CsCloudCallDataConnection online cmdlet and passes it to the Set-CsCloudCallDataConnector cmdlet via pipeline so that the Token can be stored on premises. Along with the Token, the TenantId of your O365 tenant will get stored on premises as well. |
| 35 | + |
| 36 | +### Example 2 |
| 37 | +Example showing the scenario when we aren't piping the output from online cmdlet. |
| 38 | + |
| 39 | +## PARAMETERS |
| 40 | + |
| 41 | +### -Confirm |
| 42 | +Prompts you for confirmation before running the cmdlet. |
| 43 | + |
| 44 | +```yaml |
| 45 | +Type: SwitchParameter |
| 46 | +Parameter Sets: (All) |
| 47 | +Aliases: cf |
| 48 | +applicable: Skype for Business Server 2019 |
| 49 | +Required: False |
| 50 | +Position: Named |
| 51 | +Default value: None |
| 52 | +Accept pipeline input: False |
| 53 | +Accept wildcard characters: False |
| 54 | +``` |
| 55 | +
|
| 56 | +### -Force |
| 57 | +Suppresses the display of any non-fatal error message that might occur when running the command. |
| 58 | +
|
| 59 | +```yaml |
| 60 | +Type: SwitchParameter |
| 61 | +Parameter Sets: (All) |
| 62 | +Aliases: |
| 63 | +applicable: Skype for Business Server 2019 |
| 64 | +Required: False |
| 65 | +Position: Named |
| 66 | +Default value: None |
| 67 | +Accept pipeline input: False |
| 68 | +Accept wildcard characters: False |
| 69 | +``` |
| 70 | +
|
| 71 | +### -Instance |
| 72 | +Allows you to pass a reference to an object to the cmdlet, rather than set individual parameter values. |
| 73 | +
|
| 74 | +```yaml |
| 75 | +Type: PSObject |
| 76 | +Parameter Sets: Instance |
| 77 | +Aliases: |
| 78 | +applicable: Skype for Business Server 2019 |
| 79 | +Required: False |
| 80 | +Position: Named |
| 81 | +Default value: None |
| 82 | +Accept pipeline input: True (ByValue) |
| 83 | +Accept wildcard characters: False |
| 84 | +``` |
| 85 | +
|
| 86 | +### -TenantId |
| 87 | +Office 365 TenantID of your tenant. |
| 88 | +
|
| 89 | +```yaml |
| 90 | +Type: String |
| 91 | +Parameter Sets: (All) |
| 92 | +Aliases: |
| 93 | +applicable: Skype for Business Server 2019 |
| 94 | +Required: False |
| 95 | +Position: Named |
| 96 | +Default value: None |
| 97 | +Accept pipeline input: False |
| 98 | +Accept wildcard characters: False |
| 99 | +``` |
| 100 | +
|
| 101 | +### -Token |
| 102 | +Data ingestion token for CloudCallDataConnector telemetry endpoint. |
| 103 | +
|
| 104 | +```yaml |
| 105 | +Type: String |
| 106 | +Parameter Sets: (All) |
| 107 | +Aliases: |
| 108 | +applicable: Skype for Business Server 2019 |
| 109 | +Required: False |
| 110 | +Position: Named |
| 111 | +Default value: None |
| 112 | +Accept pipeline input: True (ByPropertyName, ByValue) |
| 113 | +Accept wildcard characters: False |
| 114 | +``` |
| 115 | +
|
| 116 | +### -WhatIf |
| 117 | +Shows what would happen if the cmdlet runs. |
| 118 | +The cmdlet is not run. |
| 119 | +
|
| 120 | +```yaml |
| 121 | +Type: SwitchParameter |
| 122 | +Parameter Sets: (All) |
| 123 | +Aliases: wi |
| 124 | +applicable: Skype for Business Server 2019 |
| 125 | +Required: False |
| 126 | +Position: Named |
| 127 | +Default value: None |
| 128 | +Accept pipeline input: False |
| 129 | +Accept wildcard characters: False |
| 130 | +``` |
| 131 | +
|
| 132 | +### CommonParameters |
| 133 | +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. |
| 134 | +For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). |
| 135 | +
|
| 136 | +## INPUTS |
| 137 | +
|
| 138 | +### System.String |
| 139 | +Microsoft.Rtc.Management.WritableConfig.Settings.CloudCallDataConnection. The \`Set-CsCloudCallDataConnector\` cmdlet accepts pipelined input of CloudCallDataConnection. |
| 140 | +
|
| 141 | +
|
| 142 | +## OUTPUTS |
| 143 | +
|
| 144 | +### The `Set-CsCloudCallDataConnector` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Settings.CloudCallDataConnection object. |
| 145 | + |
| 146 | +## NOTES |
| 147 | + |
| 148 | +## RELATED LINKS |
0 commit comments