Work with Discovery Service
Effective November 2020:
- Common Data Service has been renamed to Microsoft Dataverse. Learn more
- Some terminology in Microsoft Dataverse has been updated. For example, entity is now table and field is now column. Learn more
This article will be updated soon to reflect the latest terminology.
This sample code shows how to use the discovery service with SDK assemblies. You can download the sample from here.
How to run this sample
This sample will not open dialog to prompt you for connection information.
You must first set the
password variables in the
SampleProgram.Main method before building this sample.
What this sample does
This sample uses the SDK Assembly
DiscoveryServiceProxy to query the discovery service with a user's credentials to determine which environments they can connect with.
If one or more environments are returned, the sample will prompt the user to choose one, and then use a
WhoAmIRequest to return the
SystemUser.UserId for that environment.
How this sample works
In order to simulate the scenario described in What this sample does, the sample will do the following:
This sample requires no special setup except that there are valid user credential username and password to use.
If you know the regional data center that your environments are in, the sample will run faster if you set this value at line 40 of the SampleProgram.cs file.
In SampleMethods.cs there is a
DataCenter enumeration for each of the known data centers. Each enumeration member is decorated with a
Description notation. All of these members except
Unknown have the URL for the regional discovery service set as the description.
Using the user credentials and the
dataCentervalue, the program uses the
GetAllOrganizationsstatic method to retrieve all known environments for the user.
GetAllOrganizationsmethod detects whether the
dataCentervalue is set to
DataCenter.Unknown. If it is set to this member, this method will loop through all the other members in the
DataCenterenum and retrieve any environments that are found using the
If a specific data center is set,
GetAllOrganizationswill simply call
GetOrganizationsForDataCenterwith those values.
GetOrganizationsForDataCentermethod extracts the data center discovery service Url from the member
Descriptiondecoration and uses it together with the user credentials to execute the
RetrieveOrganizationsRequestdiscovery service message.
System.ServiceModel.Security.SecurityAccessDeniedExceptionis expected when the user has no environments in a specific data center.
If any environments are returned by the
GetAllOrganizationsmethod, they will be listed in the console and you will be prompted to choose one by typing a number. If your choice is valid, the selected environment data is used to execute a
WhoAmIRequestand return the
SystemUser.UserIdfor the user in that environment.
This sample creates no records. No cleanup is required.