Skip to content
This repository was archived by the owner on Jan 29, 2022. It is now read-only.

Commit f09a9d6

Browse files
AMSoftwareNLAMSoftwareNL
committed
EventHub & Webhook
#30 Webhook Endpoint support EventHub support Combined Register and Set for Webhook and ServiceEndpoint Update Serviceendpoint and WebHook docs
1 parent 3b20280 commit f09a9d6

16 files changed

+539
-320
lines changed

‎AMSoftware.Crm.PowerShell.Commands/AMSoftware.Crm.PowerShell.Commands.csproj

+1-1
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@
167167
<Compile Include="Content\RemoveContentCommand.cs" />
168168
<Compile Include="Content\SetContentCommand.cs" />
169169
<Compile Include="Administration\StartProcessCommand.cs" />
170-
<Compile Include="Plugins\SetServiceEndpointCommand.cs" />
170+
<Compile Include="Plugins\RegisterWebhookCommand.cs" />
171171
<Compile Include="Plugins\RegisterServiceEndpointCommand.cs" />
172172
<Compile Include="Plugins\UnregisterPluginCommand.cs" />
173173
<Compile Include="Plugins\SetPluginStepStateCommand.cs" />

‎AMSoftware.Crm.PowerShell.Commands/HelpUrlConstants.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ internal static class HelpUrlConstants
133133
public const string RegisterPluginHelpUrl = "https://github.com/AMSoftwareNL/crmpowershell/blob/master/docs/Register-CrmPlugin.md";
134134
public const string SetPluginHelpUrl = "https://github.com/AMSoftwareNL/crmpowershell/blob/master/docs/Set-CrmPlugin.md";
135135
public const string RegisterServiceEndpointHelpUrl = "https://github.com/AMSoftwareNL/crmpowershell/blob/master/docs/Register-CrmServiceEndpoint.md";
136-
public const string SetServiceEndpointHelpUrl = "https://github.com/AMSoftwareNL/crmpowershell/blob/master/docs/Set-CrmServiceEndpoint.md";
136+
public const string RegisterWebhookHelpUrl = "https://github.com/AMSoftwareNL/crmpowershell/blob/master/docs/Register-CrmWebhook.md";
137137
public const string RegisterPluginStepHelpUrl = "https://github.com/AMSoftwareNL/crmpowershell/blob/master/docs/Register-CrmPluginStep.md";
138138
public const string SetPluginStepHelpUrl = "https://github.com/AMSoftwareNL/crmpowershell/blob/master/docs/Set-CrmPluginStep.md";
139139
public const string RegisterPluginStepImageHelpUrl = "https://github.com/AMSoftwareNL/crmpowershell/blob/master/docs/Register-CrmPluginStepImage.md";

‎AMSoftware.Crm.PowerShell.Commands/Plugins/GetServiceEndpointCommand.cs

+1
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ You should have received a copy of the GNU Affero General Public License
2525
namespace AMSoftware.Crm.PowerShell.Commands.Plugins
2626
{
2727
[Cmdlet(VerbsCommon.Get, "CrmServiceEndpoint", HelpUri = HelpUrlConstants.GetServiceEndpointHelpUrl, SupportsPaging = true, DefaultParameterSetName = GetServiceEndpointByFilterParameterSet)]
28+
[Alias("Get-CrmWebhook")]
2829
[OutputType(typeof(Entity))]
2930
public sealed class GetServiceEndpointCommand : CrmOrganizationCmdlet
3031
{

‎AMSoftware.Crm.PowerShell.Commands/Plugins/RegisterServiceEndpointCommand.cs

+148-43
Original file line numberDiff line numberDiff line change
@@ -15,50 +15,88 @@ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
1515
You should have received a copy of the GNU Affero General Public License
1616
along with this program. If not, see <http://www.gnu.org/licenses/>.
1717
*/
18-
using System;
19-
using System.Collections;
20-
using System.Collections.Generic;
21-
using System.Linq;
22-
using System.Management.Automation;
2318
using AMSoftware.Crm.PowerShell.Common;
2419
using AMSoftware.Crm.PowerShell.Common.Repositories;
2520
using Microsoft.Xrm.Sdk;
2621
using Microsoft.Xrm.Sdk.Query;
22+
using System;
23+
using System.Collections.Generic;
24+
using System.Linq;
25+
using System.Management.Automation;
2726

2827
namespace AMSoftware.Crm.PowerShell.Commands.Plugins
2928
{
3029
[Cmdlet(VerbsLifecycle.Register, "CrmServiceEndpoint", HelpUri = HelpUrlConstants.RegisterServiceEndpointHelpUrl)]
3130
[OutputType(typeof(Entity))]
3231
public sealed class RegisterServiceEndpointCommand : CrmOrganizationCmdlet
3332
{
33+
private const string RelayEndpointWithTokenParameterSet = "RelayEndpointWithToken";
34+
private const string QueueEndpointWithTokenParameterSet = "QueueuEndpointWithToken";
35+
private const string RelayEndpointWithKeyParameterSet = "RelayEndpointWithKey";
36+
private const string QueueEndpointWithKeyParameterSet = "QueueuEndpointWithKey";
37+
3438
private readonly ContentRepository _repository = new ContentRepository();
3539

36-
[Parameter(Mandatory = true)]
40+
[Parameter(Mandatory = false, ValueFromPipeline = true, ValueFromPipelineByPropertyName = true)]
41+
[ValidateNotNullOrEmpty]
42+
public Guid Id { get; set; }
43+
44+
[Parameter(Mandatory = true, Position = 1)]
3745
[ValidateNotNullOrEmpty]
3846
public string Name { get; set; }
3947

40-
[Parameter]
48+
[Parameter(Mandatory = true, Position = 2)]
4149
[ValidateNotNullOrEmpty]
42-
public string Description { get; set; }
50+
[Alias("NamespaceAddress", "Namespace")]
51+
public string Endpoint { get; set; }
4352

44-
[Parameter(Mandatory = true)]
53+
[Parameter(Mandatory = true, Position = 3)]
4554
[ValidateNotNullOrEmpty]
46-
public string Namespace { get; set; }
55+
public string EndpointPathOrName { get; set; }
4756

48-
[Parameter(Mandatory = true)]
57+
[Parameter(Mandatory = false)]
4958
[ValidateNotNullOrEmpty]
50-
public string Path { get; set; }
59+
public string Description { get; set; }
5160

52-
[Parameter(Mandatory = true)]
61+
[Parameter(Mandatory = true, ParameterSetName = RelayEndpointWithTokenParameterSet)]
62+
[Parameter(Mandatory = true, ParameterSetName = RelayEndpointWithKeyParameterSet)]
5363
[ValidateNotNull]
54-
public CrmServiceEndpointContract Contract { get; set; }
64+
[ValidateSet("Oneway", "Twoway", "Rest", IgnoreCase = true)]
65+
public CrmServiceEndpointContract RelayContract { get; set; }
5566

56-
[Parameter]
67+
[Parameter(Mandatory = true, ParameterSetName = QueueEndpointWithTokenParameterSet)]
68+
[Parameter(Mandatory = true, ParameterSetName = QueueEndpointWithKeyParameterSet)]
5769
[ValidateNotNull]
58-
public CrmServiceEndpointUserClaim Claim { get; set; }
70+
[ValidateSet("Queue", "Topic", "Eventhub", IgnoreCase = true)]
71+
public CrmServiceEndpointContract QueueContract { get; set; }
5972

60-
[Parameter]
61-
public SwitchParameter Federated {get;set;}
73+
[Parameter(Mandatory = false, ParameterSetName = QueueEndpointWithTokenParameterSet)]
74+
[Parameter(Mandatory = false, ParameterSetName = QueueEndpointWithKeyParameterSet)]
75+
[ValidateNotNullOrEmpty]
76+
[PSDefaultValue(Value = CrmServiceEndpointMessageFormat.DOTNETBinary)]
77+
public CrmServiceEndpointMessageFormat MessageFormat { get; set; }
78+
79+
[Parameter(Mandatory = true, ParameterSetName = QueueEndpointWithTokenParameterSet)]
80+
[Parameter(Mandatory = true, ParameterSetName = RelayEndpointWithTokenParameterSet)]
81+
[ValidateNotNullOrEmpty]
82+
public string SASToken { get; set; }
83+
84+
[Parameter(Mandatory = true, ParameterSetName = QueueEndpointWithKeyParameterSet)]
85+
[Parameter(Mandatory = true, ParameterSetName = RelayEndpointWithKeyParameterSet)]
86+
[ValidateNotNullOrEmpty]
87+
public string SASKeyName { get; set; }
88+
89+
[Parameter(Mandatory = true, ParameterSetName = QueueEndpointWithTokenParameterSet)]
90+
[Parameter(Mandatory = true, ParameterSetName = RelayEndpointWithTokenParameterSet)]
91+
[ValidateNotNullOrEmpty]
92+
[ValidateLength(44, 44)]
93+
public string SASKey { get; set; }
94+
95+
[Parameter(Mandatory = false)]
96+
[ValidateNotNull]
97+
[Alias("UserInformation")]
98+
[PSDefaultValue(Value = CrmServiceEndpointUserClaim.None)]
99+
public CrmServiceEndpointUserClaim Claim { get; set; }
62100

63101
[Parameter]
64102
public SwitchParameter PassThru { get; set; }
@@ -68,28 +106,25 @@ protected override void ExecuteCmdlet()
68106
base.ExecuteCmdlet();
69107

70108
if ((int)Claim == 0) Claim = CrmServiceEndpointUserClaim.None;
71-
if (Contract == CrmServiceEndpointContract.Rest && Federated.ToBool() == true)
72-
{
73-
throw new Exception("Federated mode not suppored for REST contract.");
74-
}
75-
ValidateNameUnique(_repository, Name);
109+
if ((int)MessageFormat == 0) MessageFormat = CrmServiceEndpointMessageFormat.DOTNETBinary;
76110

77-
Guid newId = _repository.Add(GenerateCrmEntity());
78-
if (PassThru)
79-
{
80-
WriteObject(_repository.Get("serviceendpoint", newId));
81-
}
82-
}
111+
ValidateNameUnique(_repository, Name, Id);
112+
ValidateEndpoint(Endpoint, QueueContract != 0 ? QueueContract : RelayContract);
113+
ValidateMessageFormat(QueueContract != 0 ? QueueContract : RelayContract, MessageFormat);
83114

84-
private static void ValidateNameUnique(ContentRepository repostiory, string name)
85-
{
86-
QueryExpression query = new QueryExpression("serviceendpoint");
87-
query.Criteria.AddCondition("name", ConditionOperator.Equal, name);
115+
Entity serviceEndpointEntity = GenerateCrmEntity();
116+
if (Id != Guid.Empty)
117+
{
118+
serviceEndpointEntity.Id = Id;
119+
_repository.Update(serviceEndpointEntity);
88120

89-
IEnumerable<Entity> existing = repostiory.Get(query);
90-
if (existing.Any())
121+
if (PassThru) WriteObject(_repository.Get("serviceendpoint", Id));
122+
}
123+
else
91124
{
92-
throw new Exception("Service Endpoint Name Should be Unique");
125+
Guid newId = _repository.Add(serviceEndpointEntity);
126+
127+
if (PassThru) WriteObject(_repository.Get("serviceendpoint", newId));
93128
}
94129
}
95130

@@ -99,25 +134,95 @@ private Entity GenerateCrmEntity()
99134
{
100135
Attributes = new AttributeCollection()
101136
};
137+
138+
crmServiceEndpoint.Attributes.Add("namespaceformat", new OptionSetValue(2)); //CrmServiceEndpointNamespaceFormat.Address
102139
crmServiceEndpoint.Attributes.Add("name", Name);
103-
crmServiceEndpoint.Attributes.Add("solutionnamespace", Namespace);
104-
crmServiceEndpoint.Attributes.Add("path", Path);
105-
crmServiceEndpoint.Attributes.Add("contract", new OptionSetValue((int)Contract));
106-
crmServiceEndpoint.Attributes.Add("userclaim", new OptionSetValue((int)Claim));
107140
if (!string.IsNullOrWhiteSpace(Description))
108141
{
109142
crmServiceEndpoint.Attributes.Add("description", Description);
110143
}
111-
if (Federated.ToBool() == true)
144+
crmServiceEndpoint.Attributes.Add("connectionmode", new OptionSetValue((int)CrmServiceEndpointConnectionMode.Normal));
145+
146+
crmServiceEndpoint.Attributes.Add("solutionnamespace",
147+
Endpoint.Split(
148+
new char[1] { '.' }, 2).GetValue(0).ToString().Split('/').GetValue(2).ToString());
149+
crmServiceEndpoint.Attributes.Add("namespaceaddress", Endpoint);
150+
crmServiceEndpoint.Attributes.Add("path", EndpointPathOrName);
151+
152+
if (ParameterSetName == RelayEndpointWithKeyParameterSet || ParameterSetName == RelayEndpointWithTokenParameterSet)
112153
{
113-
crmServiceEndpoint.Attributes.Add("connectionmode", new OptionSetValue((int)CrmServiceEndpointConnectionMode.Federated));
154+
crmServiceEndpoint.Attributes.Add("contract", new OptionSetValue((int)RelayContract));
114155
}
115156
else
116157
{
117-
crmServiceEndpoint.Attributes.Add("connectionmode", new OptionSetValue((int)CrmServiceEndpointConnectionMode.Normal));
158+
crmServiceEndpoint.Attributes.Add("contract", new OptionSetValue((int)QueueContract));
159+
}
160+
161+
crmServiceEndpoint.Attributes.Add("messageformat", new OptionSetValue((int)MessageFormat));
162+
crmServiceEndpoint.Attributes.Add("userclaim", new OptionSetValue((int)Claim));
163+
164+
switch (ParameterSetName)
165+
{
166+
case RelayEndpointWithTokenParameterSet:
167+
case QueueEndpointWithTokenParameterSet:
168+
crmServiceEndpoint.Attributes.Add("authtype", new OptionSetValue((int)CrmServiceEndpointAuthType.SASToken));
169+
crmServiceEndpoint.Attributes.Add("sastoken", SASToken);
170+
break;
171+
case RelayEndpointWithKeyParameterSet:
172+
case QueueEndpointWithKeyParameterSet:
173+
crmServiceEndpoint.Attributes.Add("userclaim", new OptionSetValue((int)CrmServiceEndpointAuthType.SASKey));
174+
crmServiceEndpoint.Attributes.Add("saskeyname", SASKeyName);
175+
crmServiceEndpoint.Attributes.Add("saskey", SASKey);
176+
break;
177+
default:
178+
break;
118179
}
119180

120181
return crmServiceEndpoint;
121182
}
183+
184+
private static void ValidateEndpoint(string endpoint, CrmServiceEndpointContract contract)
185+
{
186+
if (!Uri.IsWellFormedUriString(endpoint, UriKind.Absolute))
187+
{
188+
throw new PSArgumentException("Endpoint is not a valid URI.", nameof(Endpoint));
189+
}
190+
191+
if ((
192+
contract == CrmServiceEndpointContract.Rest ||
193+
contract == CrmServiceEndpointContract.OneWay ||
194+
contract == CrmServiceEndpointContract.TwoWay) && !endpoint.StartsWith("https://"))
195+
{
196+
throw new PSArgumentException("Invalid Endpoint URI.", nameof(Endpoint));
197+
}
198+
199+
if ((
200+
contract == CrmServiceEndpointContract.Queue ||
201+
contract == CrmServiceEndpointContract.Topic ||
202+
contract == CrmServiceEndpointContract.EventHub) && !endpoint.StartsWith("sb://"))
203+
{
204+
throw new PSArgumentException("Invalid Endpoint URI.", nameof(Endpoint));
205+
}
206+
}
207+
208+
private static void ValidateNameUnique(ContentRepository repostiory, string name, Guid? id)
209+
{
210+
QueryExpression query = new QueryExpression("serviceendpoint");
211+
query.Criteria.AddCondition("name", ConditionOperator.Equal, name);
212+
213+
IEnumerable<Entity> existing = repostiory.Get(query);
214+
if (existing.Where(e => e.Id != id).Any())
215+
{
216+
throw new PSArgumentException("Service Endpoint Name must be Unique", nameof(Name));
217+
}
218+
}
219+
220+
private static void ValidateMessageFormat(CrmServiceEndpointContract contract, CrmServiceEndpointMessageFormat messageFormat)
221+
{
222+
if (contract == CrmServiceEndpointContract.EventHub && messageFormat == CrmServiceEndpointMessageFormat.DOTNETBinary)
223+
{
224+
throw new PSArgumentException("Invalid MessageFormat. EventHub Contract requires JSON or XML.", nameof(MessageFormat));
225+
}
226+
}
122227
}
123228
}

0 commit comments

Comments
 (0)