Skip to content

Commit 9b1cf92

Browse files
chrisdachrisda
committed
Merge branch 'master' into chrisda
2 parents 204c0e8 + baba2cb commit 9b1cf92

13 files changed

+2157
-6
lines changed

‎skype/skype-ps/skype/Get-CsOnlinePstnUsage.md

Lines changed: 125 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,125 @@
1+
---
2+
external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml
3+
applicable: Skype for Business Online
4+
title: Get-CsOnlineUser
5+
schema: 2.0.0
6+
---
7+
8+
# Get-CsOnlinePstnUsage
9+
10+
## SYNOPSIS
11+
Returns information about online public switched telephone network (PSTN) usage records used in your tenant.
12+
13+
## SYNTAX
14+
15+
### Identity (Default)
16+
```
17+
Get-CsOnlinePstnUsage [-Tenant <Guid>] [[-Identity] <XdsIdentity>] [-LocalStore] [<CommonParameters>]
18+
```
19+
20+
### Filter
21+
```
22+
Get-CsOnlinePstnUsage [-Tenant <Guid>] [-Filter <String>] [-LocalStore] [<CommonParameters>]
23+
```
24+
25+
## DESCRIPTION
26+
Online PSTN usages are string values that are used for call authorization. An online PSTN usage links an online voice policy to a route. The `Get-CsOnlinePstnUsage` cmdlet retrieves the list of all online PSTN usages available within a tenant.
27+
28+
This cmdlet is used when configuring Microsoft Phone System Direct Routing.
29+
30+
## EXAMPLES
31+
32+
### -------------------------- Example 1 --------------------------
33+
```
34+
PS C:\> Get-CSOnlinePSTNUsage
35+
```
36+
37+
This command returns the list of global PSTN usages available within the tenant.
38+
39+
## PARAMETERS
40+
41+
### -Filter
42+
The Filter parameter allows you to retrieve only those PSTN usages with an Identity matching a particular wildcard string. However, the only Identity available to PSTN usages is Global, so this parameter is not useful for this cmdlet.
43+
44+
```yaml
45+
Type: String
46+
Parameter Sets: Filter
47+
Aliases:
48+
49+
Required: False
50+
Position: Named
51+
Default value: None
52+
Accept pipeline input: False
53+
Accept wildcard characters: False
54+
```
55+
56+
### -Identity
57+
The level at which these settings are applied. The only identity that can be applied to PSTN usages is Global.
58+
59+
```yaml
60+
Type: XdsIdentity
61+
Parameter Sets: Identity
62+
Aliases:
63+
64+
Required: False
65+
Position: 1
66+
Default value: None
67+
Accept pipeline input: False
68+
Accept wildcard characters: False
69+
```
70+
71+
### -LocalStore
72+
This parameter is reserved for internal Microsoft use.
73+
74+
```yaml
75+
Type: SwitchParameter
76+
Parameter Sets: (All)
77+
Aliases:
78+
79+
Required: False
80+
Position: Named
81+
Default value: None
82+
Accept pipeline input: False
83+
Accept wildcard characters: False
84+
```
85+
86+
### -Tenant
87+
Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example:
88+
89+
-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"
90+
91+
You can return your tenant ID by running this command:
92+
93+
Get-CsTenant | Select-Object DisplayName, TenantID
94+
95+
If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. Instead, the tenant ID will automatically be filled in for you based on your connection information. The Tenant parameter is primarily for use in a hybrid deployment.
96+
97+
```yaml
98+
Type: System.Guid
99+
Parameter Sets: (All)
100+
Aliases:
101+
102+
Required: False
103+
Position: Named
104+
Default value: None
105+
Accept pipeline input: False
106+
Accept wildcard characters: False
107+
```
108+
109+
### CommonParameters
110+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.
111+
For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
112+
113+
## INPUTS
114+
115+
### None
116+
117+
118+
## OUTPUTS
119+
120+
### System.Object
121+
122+
## NOTES
123+
124+
## RELATED LINKS
125+
[Set-CsOnlinePstnUsage](https://docs.microsoft.com/en-us/powershell/module/skype/set-csonlinepstnusage?view=skype-ps)

‎skype/skype-ps/skype/Get-CsOnlineUser.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -144,11 +144,9 @@ Accept wildcard characters: False
144144
```
145145

146146
### -Identity
147-
Indicates the Identity of the user account to be retrieved.
148-
User Identities can be specified using one of the following formats: 1) the user's SIP address; 2) the user's user principal name (UPN); or, 3) the user's Active Directory display name (for example, Ken Myer).
147+
Indicates the Identity of the user account to be assigned the per-user online voice routing policy. User Identities can be specified using one of the following formats: 1) the user's SIP address; 2) the user's user principal name (UPN); or, 3) the user's Active Directory display name (for example, Ken Myer).
149148

150-
You can use the asterisk (*) wildcard character when using the Display Name as the user Identity.
151-
For example, the Identity "* Smith" returns all the users who have a display name that ends with the string value " Smith".
149+
You can use the asterisk (\*) wildcard character when using the Display Name as the user Identity. For example, the Identity "\*Smith" returns all the users who have a display name that ends with the string value "Smith".
152150

153151
```yaml
154152
Type: Object

‎skype/skype-ps/skype/Get-CsOnlineVoiceRoute.md

Lines changed: 153 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,153 @@
1+
---
2+
external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml
3+
applicable: Skype for Business Online
4+
title: Get-CsOnlineUser
5+
schema: 2.0.0
6+
---
7+
8+
# Get-CsOnlineVoiceRoute
9+
10+
## SYNOPSIS
11+
Returns information about the online voice routes configured for use in your tenant. Online voice routes contain instructions that tell Skype for Business Online how to route calls from Office 365 users to phone numbers on the public switched telephone network (PSTN) or a private branch exchange (PBX).
12+
13+
## SYNTAX
14+
15+
### Identity (Default)
16+
```
17+
Get-CsOnlineVoiceRoute [-Tenant <Guid>] [[-Identity] <XdsGlobalRelativeIdentity>] [-LocalStore]
18+
[<CommonParameters>]
19+
```
20+
21+
### Filter
22+
```
23+
Get-CsOnlineVoiceRoute [-Tenant <Guid>] [-Filter <String>] [-LocalStore] [<CommonParameters>]
24+
```
25+
26+
## DESCRIPTION
27+
Use this cmdlet to retrieve one or more existing online voice routes in your tenant. Online voice routes contain instructions that tell Skype for Business Online how to route calls from Office 365 users to phone numbers on the public switched telephone network (PSTN) or a private branch exchange (PBX).
28+
29+
This cmdlet can be used to retrieve voice route information such as which online PSTN gateways the route is associated with (if any), which online PSTN usages are associated with the route, the pattern (in the form of a regular expression) that identifies the phone numbers to which the route applies, and caller ID settings. The PSTN usage associates the voice route to a online voice policy.
30+
31+
This cmdlet is used when configuring Microsoft Phone System Direct Routing.
32+
33+
## EXAMPLES
34+
35+
### -------------------------- Example 1 --------------------------
36+
```
37+
PS C:\> Get-CsOnlineVoiceRoute
38+
```
39+
40+
Retrieves the properties for all voice routes defined within the tenant.
41+
42+
### -------------------------- Example 2 --------------------------
43+
```
44+
PS C:\> Get-CsOnlineVoiceRoute -Identity Route1
45+
```
46+
47+
Retrieves the properties for the Route1 voice route.
48+
49+
### -------------------------- Example 3 --------------------------
50+
```
51+
PS C:\> Get-CsOnlineVoiceRoute -Filter *test*
52+
```
53+
54+
This command displays voice route settings where the Identity contains the string "test" anywhere within the value. To find the string test only at the end of the Identity, use the value \*test. Similarly, to find the string test only if it occurs at the beginning of the Identity, specify the value test\*.
55+
56+
### -------------------------- Example 4 --------------------------
57+
```
58+
PS C:\> Get-CsOnlineVoiceRoute | Where-Object {$_.OnlinePstnGatewayList.Count -eq 0}
59+
```
60+
61+
This command retrieves all voice routes that have not had any PSTN gateways assigned. First all voice routes are retrieved using the Get-CsOnlineVoiceRoute cmdlet. These voice routes are then piped to the Where-Object cmdlet. The Where-Object cmdlet narrows down the results of the Get operation. In this case we look at each voice route (that's what the $_ represents) and check the Count property of the PstnGatewayList property. If the count of PSTN gateways is 0, the list is empty and no gateways have been defined for the route.
62+
63+
## PARAMETERS
64+
65+
### -Filter
66+
This parameter filters the results of the Get operation based on the wildcard value passed to this parameter.
67+
68+
```yaml
69+
Type: String
70+
Parameter Sets: Filter
71+
Aliases:
72+
73+
Required: False
74+
Position: Named
75+
Default value: None
76+
Accept pipeline input: False
77+
Accept wildcard characters: False
78+
```
79+
80+
### -Identity
81+
A string that uniquely identifies the voice route. If no identity is provided, all voice routes for the organization are returned.
82+
83+
```yaml
84+
Type: XdsGlobalRelativeIdentity
85+
Parameter Sets: Identity
86+
Aliases:
87+
88+
Required: False
89+
Position: 1
90+
Default value: None
91+
Accept pipeline input: False
92+
Accept wildcard characters: False
93+
```
94+
95+
### -LocalStore
96+
This parameter is reserved for internal Microsoft use
97+
98+
```yaml
99+
Type: SwitchParameter
100+
Parameter Sets: (All)
101+
Aliases:
102+
103+
Required: False
104+
Position: Named
105+
Default value: None
106+
Accept pipeline input: False
107+
Accept wildcard characters: False
108+
```
109+
110+
### -Tenant
111+
Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example:
112+
113+
-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"
114+
115+
You can return your tenant ID by running this command:
116+
117+
Get-CsTenant | Select-Object DisplayName, TenantID
118+
119+
If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. Instead, the tenant ID will automatically be filled in for you based on your connection information. The Tenant parameter is primarily for use in a hybrid deployment.
120+
121+
```yaml
122+
Type: Guid
123+
Parameter Sets: (All)
124+
Aliases:
125+
126+
Required: False
127+
Position: Named
128+
Default value: None
129+
Accept pipeline input: False
130+
Accept wildcard characters: False
131+
```
132+
133+
### CommonParameters
134+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.
135+
For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
136+
137+
## INPUTS
138+
139+
### None
140+
141+
142+
## OUTPUTS
143+
144+
### System.Object
145+
146+
## NOTES
147+
148+
## RELATED LINKS
149+
[New-CsOnlineVoiceRoute](https://docs.microsoft.com/en-us/powershell/module/skype/new-csonlinevoiceroute?view=skype-ps)
150+
151+
[Set-CsOnlineVoiceRoute](https://docs.microsoft.com/en-us/powershell/module/skype/set-csonlinevoiceroute?view=skype-ps)
152+
153+
[Remove-CsOnlineVoiceRoute](https://docs.microsoft.com/en-us/powershell/module/skype/remove-csonlinevoiceroute?view=skype-ps)

0 commit comments

Comments
 (0)