Skip to content

Commit 2ddeda8

Browse files
authored
Merge pull request MicrosoftDocs#1163 from dariomws306/patch-3
Patch 3
2 parents 4b166da + d9239a3 commit 2ddeda8

9 files changed

+323
-178
lines changed

skype/skype-ps/skype/Get-CsExternalUserCommunicationPolicy.md

Lines changed: 50 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,24 +9,46 @@ schema: 2.0.0
99

1010
## SYNOPSIS
1111

12+
Returns information about one or more external user communication policies configured for your organization.
13+
1214
## SYNTAX
1315

1416
```
15-
Get-CsExternalUserCommunicationPolicy [[-Identity] <Object>] [-BypassDualWrite <Object>] [-Filter <Object>]
16-
[-LocalStore] [-Tenant <Object>] [-AsJob] [<CommonParameters>]
17+
Get-CsExternalUserCommunicationPolicy [[-Identity] <Object>] [-BypassDualWrite <Object>] [-Filter <Object>] [-LocalStore] [-Tenant <Object>] [-AsJob] [<CommonParameters>]
1718
```
1819

1920
## DESCRIPTION
20-
{{Fill in the Description}}
21+
This cmdlet retrieves external user communication policy information. External user communication policies are used to block P2P file transfer with Federated partners.
2122

2223
## EXAMPLES
2324

24-
### Example 1 (Skype for Business Online)
25+
### -------------------------- Example 1 ------------------------
26+
```
27+
PS C:\> Get-CsExternalUserCommunicationPolicy
28+
```
29+
30+
This example displays all the external user communication policies that have been defined for an organization along with the settings for each.
31+
32+
### -------------------------- Example 2 ------------------------
2533
```
26-
{{ Add example code here }}
34+
PS C:\> Get-CsExternalUserCommunicationPolicy -Identity BlockExternalP2PFileTransfer
2735
```
2836

29-
{{ Add example description here }}
37+
This example uses the Identity parameter to retrieve the external user communication policy settings for the policy named BlockExternalP2PFileTransfer.
38+
39+
### -------------------------- Example 3 ------------------------
40+
```
41+
PS C:\> Get-CsExternalUserCommunicationPolicy -Filter tag*
42+
```
43+
44+
This example uses the Filter parameter to retrieve all the external user communication policies along with the settings for each. All per-user external user communication policies have an Identity in the format tag:<ExternalUserCommunicationPolicy>.
45+
46+
### -------------------------- Example 4 ------------------------
47+
```
48+
PS C:\> Get-CsExternalUserCommunicationPolicy -Filter Block*
49+
```
50+
51+
This example uses the Filter parameter to retrieve all the external user communication policies which their name begins with the string "Block" along with the configuration for each one.
3052

3153
## PARAMETERS
3254

@@ -47,7 +69,7 @@ Accept wildcard characters: False
4769
```
4870
4971
### -Filter
50-
{{Fill Filter Description}}
72+
This parameter accepts a wildcard string and returns all external user communication policies with identities matching that string. For example, a Filter value of tag:* will return all external user communication policies excluding Global policy.
5173
5274
```yaml
5375
Type: Object
@@ -63,7 +85,7 @@ Accept wildcard characters: False
6385
```
6486
6587
### -Identity
66-
{{Fill Identity Description}}
88+
Unique identifier for the external user communication policy to be created.
6789
6890
```yaml
6991
Type: Object
@@ -77,7 +99,6 @@ Default value: None
7799
Accept pipeline input: False
78100
Accept wildcard characters: False
79101
```
80-
81102
### -LocalStore
82103
{{Fill LocalStore Description}}
83104
@@ -95,7 +116,15 @@ Accept wildcard characters: False
95116
```
96117
97118
### -Tenant
98-
{{Fill Tenant Description}}
119+
Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example:
120+
121+
-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"
122+
123+
You can return your tenant ID by running this command:
124+
125+
Get-CsTenant | Select-Object DisplayName, TenantID
126+
127+
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.
99128
100129
```yaml
101130
Type: Object
@@ -111,7 +140,11 @@ Accept wildcard characters: False
111140
```
112141
113142
### -AsJob
114-
{{Fill AsJob Description}}
143+
Indicates that this cmdlet runs as a background job.
144+
145+
When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet.
146+
147+
For more information about Windows PowerShell background jobs, see [about_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-6) and [about_Remote_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_jobs?view=powershell-6).
115148
116149
```yaml
117150
Type: SwitchParameter
@@ -140,4 +173,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
140173
## NOTES
141174
142175
## RELATED LINKS
176+
[New-CsExternalUserCommunicationPolicy](https://docs.microsoft.com/en-us/powershell/module/skype/new-csexternalusercommunicationpolicy?view=skype-ps)
177+
178+
[Set-CsExternalUserCommunicationPolicy](https://docs.microsoft.com/en-us/powershell/module/skype/set-csexternalusercommunicationpolicy?view=skype-ps)
179+
180+
[Remove-CsExternalUserCommunicationPolicy](https://docs.microsoft.com/en-us/powershell/module/skype/remove-csexternalusercommunicationpolicy?view=skype-ps)
143181
182+
[Grant-CsExternalUserCommunicationPolicy](https://docs.microsoft.com/en-us/powershell/module/skype/grant-csexternalusercommunicationpolicy?view=skype-ps)

skype/skype-ps/skype/Get-CsHybridApplicationEndpoint.md

Lines changed: 57 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,64 @@
11
---
22
external help file:Microsoft.Rtc.Management.dll-help.xml
3-
applicable: Skype for Business Server 2015, Skype for Business Server 2019
3+
applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
44
title: Get-CsHybridApplicationEndpoint
55
schema: 2.0.0
66
---
77

88
# Get-CsHybridApplicationEndpoint
99

1010
## SYNOPSIS
11-
{{Fill in the Synopsis}}
11+
Returns information about one or more hybrid application endpoints in your organization along with their settings.
1212

13-
## SYNTAX
13+
This cmdlet was introduced in the July 2017 cumulative update for the Lync Server 2013 and May 2017 cumulative update for Skype Business Server 2015.
1414

15+
## SYNTAX
1516
```
1617
Get-CsHybridApplicationEndpoint [-Filter <String>] [-LdapFilter <String>] [-OU <OUIdParameter>]
1718
[-DomainController <Fqdn>] [-Credential <PSCredential>] [[-Identity] <UserIdParameter>]
1819
[-ResultSize <Microsoft.Rtc.Management.ADConnect.Core.Unlimited`1[System.UInt32]>] [<CommonParameters>]
1920
```
2021

2122
## DESCRIPTION
22-
{{Fill in the Description}}
23+
This cmdlet returns information about one or more hybrid application endpoints in your organization along with their settings. Some of this settings are SipAddress, DisplayName and LineURI.
24+
25+
The `Get-CsHybridApplicationEndpoint` cmdlet provides numerous ways for you to filter the collection of endpoints actually returned when you run the cmdlet. For example, if you don't want to return all your Skype for Business Server endpoints you can apply the optional parameters Filter or LdapFilter. (These parameters are mutually exclusive: if you use Filter in a command you cannot use LdapFilter in that same command, and vice-versa.) The Filter parameter enables you to limit the returned data to endpoints who meet the specified Skype for Business Server criteria; for example, you might decide to return only enabled endpoints, or only endpoints with a LineURI assigned. The LdapFilter parameter enables you to limit the returned data to users who fit other Active Directory-based criteria.
2326

2427
## EXAMPLES
2528

26-
### Example 1
27-
```powershell
28-
PS C:\> {{ Add example code here }}
29+
### -------------------------- Example 1 --------------------------
30+
```
31+
PS C:\> Get-CsHybridApplicationEndpoint
32+
```
33+
34+
This example displays all the hybrid application endpoints that have been defined for an organization along with the settings for each.
35+
36+
### -------------------------- Example 2 --------------------------
37+
```
38+
PS C:\> Get-CsHybridApplicationEndpoint -Identity "CN={4f6c99fe-7999-4088-ac4d-e88e0b3d3820},OU=Redmond,DC=litwareinc,DC=com"
39+
```
40+
41+
This example uses the Identity parameter to retrieve the hybrid application endpoint settings for a specific endpoint.
42+
43+
### -------------------------- Example 3 --------------------------
44+
```
45+
PS C:\> Get-CsHybridApplicationEndpoint -Filter {DisplayName -like "*bot*"}
2946
```
3047

31-
{{ Add example description here }}
48+
This example uses the Filter parameter to retrieve all the hybrid application endpoints with the word "bot" in their DisplayName attribute along with the configuration for each one.
3249

3350
## PARAMETERS
3451

3552
### -Credential
36-
{{Fill Credential Description}}
53+
Enables you to run the Get-CsHybridApplicationEndpoint cmdlet under alternate credentials. This might be required if the account you used to log on to the Windows does not have the necessary privileges required to work with user objects.
54+
55+
To use the Credential parameter you must first create a PSCredential object by using the [Get-Credential](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.security/get-credential?view=powershell-6) cmdlet. For details, see the Get-Credential cmdlet help topic.
3756

3857
```yaml
3958
Type: PSCredential
4059
Parameter Sets: (All)
4160
Aliases:
42-
Applicable: Skype for Business Server 2015, Skype for Business Server 2019
61+
Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
4362

4463
Required: False
4564
Position: Named
@@ -49,13 +68,13 @@ Accept wildcard characters: False
4968
```
5069
5170
### -DomainController
52-
{{Fill DomainController Description}}
71+
Enables you to connect to the specified domain controller in order to retrieve user information. To connect to a particular domain controller, include the DomainController parameter followed by the fully qualified domain name (FQDN) (for example, atl-cs-001.litwareinc.com).
5372
5473
```yaml
5574
Type: Fqdn
5675
Parameter Sets: (All)
5776
Aliases:
58-
Applicable: Skype for Business Server 2015, Skype for Business Server 2019
77+
Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
5978

6079
Required: False
6180
Position: Named
@@ -65,13 +84,17 @@ Accept wildcard characters: False
6584
```
6685
6786
### -Filter
68-
{{Fill Filter Description}}
87+
Enables you to limit the returned data by filtering on Skype for Business Server 2015-specific attributes. For example, you can limit returned data to endpoints with specific word in their DisplayName attribute.
88+
89+
The Filter parameter uses the same Windows PowerShell filtering syntax that is used by the Where-Object cmdlet. For example, a filter that returns only endpoints with a value in their LineURI attribute would look like this, with LineURI representing the Active Directory attribute, -ne representing the comparison operator (not equal to), and $null (a built-in Windows PowerShell variable) representing the filter value:
90+
91+
{LineURI -ne $null}
6992
7093
```yaml
7194
Type: String
7295
Parameter Sets: (All)
7396
Aliases:
74-
Applicable: Skype for Business Server 2015, Skype for Business Server 2019
97+
Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
7598

7699
Required: False
77100
Position: Named
@@ -81,13 +104,13 @@ Accept wildcard characters: False
81104
```
82105
83106
### -Identity
84-
{{Fill Identity Description}}
107+
Unique application Id for the endpoint you want to get.
85108
86109
```yaml
87110
Type: UserIdParameter
88111
Parameter Sets: (All)
89112
Aliases:
90-
Applicable: Skype for Business Server 2015, Skype for Business Server 2019
113+
Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
91114

92115
Required: False
93116
Position: 0
@@ -97,13 +120,15 @@ Accept wildcard characters: False
97120
```
98121
99122
### -LdapFilter
100-
{{Fill LdapFilter Description}}
123+
Enables you to limit the returned data by filtering on generic Active Directory attributes (that is, attributes that are not specific to Skype for Business Server 2015). For example, you can limit returned data to endpoints which work in a specific department, or endpoints which have a specified manager or job title.
124+
125+
The LdapFilter parameter uses the LDAP query language when creating filters. For example, a filter that returns only endpoints which belongs in the city of Redmond would look like this: "l=Redmond", with "l" (a lowercase L) representing the Active Directory attribute (locality); "=" representing the comparison operator (equal to); and "Redmond" representing the filter value.
101126
102127
```yaml
103128
Type: String
104129
Parameter Sets: (All)
105130
Aliases:
106-
Applicable: Skype for Business Server 2015, Skype for Business Server 2019
131+
Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
107132

108133
Required: False
109134
Position: Named
@@ -113,13 +138,17 @@ Accept wildcard characters: False
113138
```
114139
115140
### -OU
116-
{{Fill OU Description}}
141+
Enables you to return information about endpoints in a specific organizational unit (OU) or container. The OU parameter returns data from both the specified OU and any of its child OUs. For example, if the Finance OU has two child OUs--AccountsPayable and AccountsReceivable--endpoints will be returned from each of these three OUs.
142+
143+
When specifying an OU, use the distinguished name (DN) of that container; for example: -OU "OU=Finance,dc=litwareinc,dc=com". To return endpoints accounts from the Users container, use this syntax:
144+
145+
-OU "cn=Users,dc=litwareinc,dc=com"
117146
118147
```yaml
119148
Type: OUIdParameter
120149
Parameter Sets: (All)
121150
Aliases:
122-
Applicable: Skype for Business Server 2015, Skype for Business Server 2019
151+
Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
123152

124153
Required: False
125154
Position: Named
@@ -129,13 +158,15 @@ Accept wildcard characters: False
129158
```
130159
131160
### -ResultSize
132-
{{Fill ResultSize Description}}
161+
Enables you to limit the number of records returned by the cmdlet. For example, to return seven endpoints (regardless of the number of endpoints that are in your forest) include the ResultSize parameter and set the parameter value to 7. Note that there is no way to guarantee which seven endpoints will be returned.
162+
163+
The result size can be set to any whole number between 0 and 2147483647, inclusive. If set to 0 the command will run, but no data will be returned. If you set the ResultSize to 7 but you have only three endpoints in your forest, the command will return those three endpoints, and then complete without error.
133164
134165
```yaml
135166
Type: Microsoft.Rtc.Management.ADConnect.Core.Unlimited`1[System.UInt32]
136167
Parameter Sets: (All)
137168
Aliases:
138-
Applicable: Skype for Business Server 2015, Skype for Business Server 2019
169+
Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
139170

140171
Required: False
141172
Position: Named
@@ -160,4 +191,8 @@ For more information, see about_CommonParameters (http://go.microsoft.com/fwlink
160191
## NOTES
161192
162193
## RELATED LINKS
194+
[New-CsHybridApplicationEndpoint](https://docs.microsoft.com/en-us/powershell/module/skype/new-cshybridapplicationendpoint?view=skype-ps)
195+
196+
[Set-CsHybridApplicationEndpoint](https://docs.microsoft.com/en-us/powershell/module/skype/set-cshybridapplicationendpoint?view=skype-ps)
163197
198+
[Remove-CsHybridApplicationEndpoint](https://docs.microsoft.com/en-us/powershell/module/skype/remove-cshybridapplicationendpoint?view=skype-ps)

skype/skype-ps/skype/Get-CsIPPhonePolicy.md

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,26 +8,25 @@ schema: 2.0.0
88
# Get-CsIPPhonePolicy
99

1010
## SYNOPSIS
11-
{{Fill in the Synopsis}}
11+
Use the Get-CsIPPhonePolicy cmdlet to get all the settings of the Skype for Business Online global IP phone policy. IP phone policies define the Skype for Business Online features that are available to users.
1212

1313
## SYNTAX
1414

1515
```
16-
Get-CsIPPhonePolicy [[-Identity] <Object>] [-BypassDualWrite <Object>] [-Filter <Object>] [-LocalStore]
17-
[-Tenant <Object>] [-AsJob] [<CommonParameters>]
16+
Get-CsIPPhonePolicy [[-Identity] <Object>] [-BypassDualWrite <Object>] [-Filter <Object>] [-LocalStore] [-Tenant <Object>] [-AsJob] [<CommonParameters>]
1817
```
1918

2019
## DESCRIPTION
21-
{{Fill in the Description}}
20+
IP phone policies are applied each time a user accesses the system via an IP phone device. The Get-CsIPPhonePolicy cmdlet retrieves the global IP phone policy that has been configured in your organization along with all their settings.
2221

2322
## EXAMPLES
2423

25-
### Example 1
24+
### -------------------------- Example 1 ------------------------
2625
```
27-
{{ Add example code here }}
26+
PS C:\> Get-CsIPPhonePolicy
2827
```
2928

30-
{{ Add example description here }}
29+
This example returns the global IP phone policy along with all their settings..
3130

3231
## PARAMETERS
3332

@@ -64,7 +63,9 @@ Accept wildcard characters: False
6463
```
6564
6665
### -Identity
67-
{{Fill Identity Description}}
66+
Microsoft.Rtc.Management.Xds.XdsIdentity
67+
68+
This parameter is reserved for internal Microsoft use.
6869
6970
```yaml
7071
Type: Object
@@ -96,7 +97,9 @@ Accept wildcard characters: False
9697
```
9798
9899
### -Tenant
99-
{{Fill Tenant Description}}
100+
System.Guid
101+
102+
This parameter is reserved for internal Microsoft use.
100103
101104
```yaml
102105
Type: Object
@@ -112,7 +115,11 @@ Accept wildcard characters: False
112115
```
113116
114117
### -AsJob
115-
{{Fill AsJob Description}}
118+
Indicates that this cmdlet runs as a background job.
119+
120+
When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet.
121+
122+
For more information about Windows PowerShell background jobs, see [about_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-6) and [about_Remote_Jobs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_remote_jobs?view=powershell-6).
116123
117124
```yaml
118125
Type: SwitchParameter
@@ -144,4 +151,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
144151
145152
146153
## RELATED LINKS
154+
[Grant-CsIPPhonePolicy](https://docs.microsoft.com/en-us/powershell/module/skype/grant-csipphonepolicy?view=skype-ps)
147155
156+
[Set-CsIPPhonePolicy](https://docs.microsoft.com/en-us/powershell/module/skype/set-csipphonepolicy?view=skype-ps)

0 commit comments

Comments
 (0)