OrganizationServiceProxy Class

Reference

Definition

Namespace:: Microsoft.Xrm.Sdk.Client

Assembly:: Microsoft.Xrm.Sdk.dll

Package:: Microsoft.PowerPlatform.Dataverse.Client v1.1.17

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Implements IOrganizationService and provides an authenticated WCF channel to the organization service.

public ref class OrganizationServiceProxy : Microsoft::Xrm::Sdk::Client::ServiceProxy<Microsoft::Xrm::Sdk::IOrganizationService ^>, Microsoft::Xrm::Sdk::IOrganizationService

public class OrganizationServiceProxy : Microsoft.Xrm.Sdk.Client.ServiceProxy<Microsoft.Xrm.Sdk.IOrganizationService>, Microsoft.Xrm.Sdk.IOrganizationService

type OrganizationServiceProxy = class
    inherit ServiceProxy<IOrganizationService>
    interface IOrganizationService

Public Class OrganizationServiceProxy
Inherits ServiceProxy(Of IOrganizationService)
Implements IOrganizationService

Inheritance: Object

ServiceProxy<IOrganizationService>
OrganizationServiceProxy

Implements: IOrganizationService

Remarks

To call the Microsoft Dynamics 365 web service using the IOrganizationService interface, cast the proxy instance to an IOrganizationService type.

This class is not thread safe. Dataverse authentication using the Microsoft Online Services environment identity provider, including Microsoft Office 365, is supported.

Constructors

OrganizationServiceProxy(IServiceConfiguration<IOrganizationService>, ClientCredentials)	Initializes a new instance of the OrganizationServiceProxy class using a service configuration and client credentials.
OrganizationServiceProxy(IServiceConfiguration<IOrganizationService>, SecurityTokenResponse)	Initializes a new instance of the OrganizationServiceProxy class using a service configuration and a security token response.
OrganizationServiceProxy(IServiceManagement<IOrganizationService>, ClientCredentials)	Initializes a new instance of the OrganizationServiceProxy class using a service configuration and client credentials.
OrganizationServiceProxy(IServiceManagement<IOrganizationService>, SecurityTokenResponse)	Initializes a new instance of the OrganizationServiceProxy class using a service management and a security token response.
OrganizationServiceProxy(Uri, Uri, ClientCredentials, ClientCredentials)	Initializes a new instance of the OrganizationServiceProxy class using a organization service URI, home realm URI, and client and device credentials.

Properties

CallerId	Gets or sets the ID of the user for whom SDK calls are made on behalf of.
CallerRegardingObjectId
ChannelFactory	Gets a WCF channel factory that manages a single channel instance. (Inherited from ServiceProxy<TService>)
ClientCredentials	Gets the login credentials of the client. (Inherited from ServiceProxy<TService>)
DeviceCredentials	Gets the Windows Live credentials of a registered device. (Inherited from ServiceProxy<TService>)
EndpointAutoSwitchEnabled	Gets or sets a value that enables automatic switching from the organization’s current endpoint to an alternate endpoint. (Inherited from ServiceProxy<TService>)
EndpointSwitch	Gets the endpoint switch information from the web service configuration. (Inherited from ServiceProxy<TService>)
HomeRealmSecurityTokenResponse	Gets the security token response of the home realm. (Inherited from ServiceProxy<TService>)
HomeRealmUri	Gets the home realm URI. (Inherited from ServiceProxy<TService>)
IsAuthenticated	Gets a value indicating if the WCF channel has been authenticated. (Inherited from ServiceProxy<TService>)
SdkClientVersion	Gets or sets the version of the client.
SecurityTokenResponse	Gets the security token response. (Inherited from ServiceProxy<TService>)
ServiceChannel	Gets the communication channel used to access a Microsoft Dynamics 365 service. (Inherited from ServiceProxy<TService>)
ServiceConfiguration	Gets a service configuration. (Inherited from ServiceProxy<TService>)
ServiceManagement	Gets a service management. (Inherited from ServiceProxy<TService>)
SyncOperationType
Timeout	Gets or sets the maximum amount of time a single channel operation has to complete before a timeout fault is raised on a service channel binding. (Inherited from ServiceProxy<TService>)
UserPrincipalName	Gets or sets the UPN that is an Internet-style login name for a user based on the Internet standard RFC 822. (Inherited from ServiceProxy<TService>)
UserType

Methods

Associate(String, Guid, Relationship, EntityReferenceCollection)	Creates a link between records.
AssociateCore(String, Guid, Relationship, EntityReferenceCollection)	For internal use only.
Authenticate()	Closes the service channel and channel factory if they are open, and then invokes AuthenticateCore(). (Inherited from ServiceProxy<TService>)
AuthenticateCore()	Authenticates the client with a service. (Inherited from ServiceProxy<TService>)
AuthenticateCrossRealm()	Invokes AuthenticateCrossRealmCore(). (Inherited from ServiceProxy<TService>)
AuthenticateCrossRealmCore()	Authenticates a user in a realm other than the realm that the Microsoft Dynamics 365 server is located in. (Inherited from ServiceProxy<TService>)
AuthenticateDevice()	Invokes AuthenticateDeviceCore(). (Inherited from ServiceProxy<TService>)
AuthenticateDeviceCore()	Authenticates a device with Windows Live. (Inherited from ServiceProxy<TService>)
CloseChannel(Boolean)	Closes a validated service channel. (Inherited from ServiceProxy<TService>)
Create(Entity)	Creates a record.
CreateCore(Entity)	For internal use only.
Delete(String, Guid)	Deletes a record.
DeleteCore(String, Guid)	For internal use only.
Disassociate(String, Guid, Relationship, EntityReferenceCollection)	Deletes a link between records.
DisassociateCore(String, Guid, Relationship, EntityReferenceCollection)	For internal use only.
Dispose()	Custom implementation of `Dispose` that disposes the service channel and channel factory. (Inherited from ServiceProxy<TService>)
Dispose(Boolean)	Custom implementation of `Dispose` that disposes the service channel and channel factory. (Inherited from ServiceProxy<TService>)
EnableProxyTypes()	Enables support for the early-bound entity types.
EnableProxyTypes(Assembly)	Enables support for the early-bound entity types exposed in a specified assembly.
Execute(OrganizationRequest)	Executes a message in the form of a request, and returns a response.
ExecuteCore(OrganizationRequest)	For internal use only.
HandleFailover(BaseServiceFault, Nullable<Boolean>)	For internal use only. (Inherited from ServiceProxy<TService>)
HandleFailover(Nullable<Boolean>)	For internal use only. (Inherited from ServiceProxy<TService>)
OnFactoryClosed(ChannelEventArgs)	Event handler virtual method for a channel factory that is in a closed state. (Inherited from ServiceProxy<TService>)
OnFactoryFaulted(ChannelFaultedEventArgs)	Event handler virtual method for a channel factory that is in a faulted state. (Inherited from ServiceProxy<TService>)
OnFactoryOpened(ChannelEventArgs)	Event handler virtual method for a channel factory that is in an opened state. (Inherited from ServiceProxy<TService>)
Retrieve(String, Guid, ColumnSet)	Retrieves a record.
RetrieveCore(String, Guid, ColumnSet)	For internal use only.
RetrieveMultiple(QueryBase)	Retrieves a collection of records.
RetrieveMultipleCore(QueryBase)	For internal use only.
ShouldRetry(MessageSecurityException, Nullable<Boolean>)	Checks a message security exception to determine if a service call should be attempted again. (Inherited from ServiceProxy<TService>)
SwitchToAlternateEndpoint()	Switches the organization’s current endpoint to an alternate endpoint, if one is available. (Inherited from ServiceProxy<TService>)
Update(Entity)	Updates an existing record.
UpdateCore(Entity)	For internal use only.
ValidateAuthentication()	Authenticates the client and creates a new service channel. (Inherited from ServiceProxy<TService>)

Events

EndpointSwitched	Occurs when a failover recovery has completed and the organization’s current endpoint has been switched to an alternate endpoint. (Inherited from ServiceProxy<TService>)
EndpointSwitchRequired	Occurs when a failover has occurred and a switch from the organization’s current endpoint to an alternate endpoint is required. (Inherited from ServiceProxy<TService>)
FactoryClosed	Occurs when a channel factory is closed. (Inherited from ServiceProxy<TService>)
FactoryFaulted	Occurs when a channel factory is faulted. (Inherited from ServiceProxy<TService>)
FactoryOpened	Occurs when a channel factory is opened. (Inherited from ServiceProxy<TService>)

Applies to