Microsoft.Xrm.Sdk Namespace
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.
Contains Dataverse general types.
Classes
| ActionLink | |
| AddComponentToSolutionParameters | |
| AddComponentToSolutionParametersCollection | |
| AliasedValue |
Used to return aggregate, group by, and aliased values from a query. |
| AnalyticsStoreDetails |
Contains information about the analytics storage container. |
| AttributeCollection |
Provides a collection of attributes for an entity. |
| AttributeLogicalNameAttribute |
Used by the code generation tool to create classes based on entities. |
| AttributeMapping |
For internal use only. For the Web API the corresponding type is AttributeMapping ComplexType. |
| AttributeMappingCollection |
This type doesn’t have any extensibility scenarios in this release. |
| AttributePrivilege |
Specifies the field level security privileges allowed for an attribute. For the Web API the corresponding type is AttributePrivilege ComplexType. |
| AttributePrivilegeCollection |
Specifies a collection of field level security privileges allowed for the specified attributes. |
| AuditStorageDetails | |
| AuditStorageDetailsResult | |
| BaseServiceFault |
Represents a service fault. |
| BooleanManagedProperty |
Defines a managed property that stores a Boolean value. For the Web API the corresponding type is BooleanManagedProperty ComplexType. |
| BulkRemoveActiveCustomizationsParameters | |
| BusinessEntityChanges |
Represents the business entity changes. |
| BusinessEntityChangesCollection |
Represents the business entity changes collection. |
| CallerImpersonationScope |
Identifies a user as the owner of all data changes made by calls to a Web service. |
| ClaimTypes |
Identifies the types of claims that are supported or may be supported in a future product release. |
| ComponentPrincipalAccess | |
| DataCollection<T> |
Represents a strongly typed list of objects that can be accessed by index. Provides methods to search, sort, and manipulate lists. Extends Collection. |
| DataCollection<TKey,TValue> |
Represents a collection of keys and values. |
| DataProcessingModuleExecuteRequest | |
| DataProcessingModuleExecutionResponse | |
| DateTimeBehaviorConversionRule |
Represents a conversion rule for converting date and time value from UTC to DateOnly in the database. |
| DeletedData | |
| DeletedEntitiesData | |
| DependencySummary |
Contains data from the dependent entity. |
| DirectDeviceSyncMetadataScript | |
| DirectDeviceSyncMetadataScripts | |
| DirectDeviceSyncRecordInfo | |
| DirectEntryContext | |
| DiscoveryServiceFault |
Represents a discovery service fault. |
| DistinctMobileOfflineRelatedEntitiesResponse | |
| ElasticEntitiesFilePointer | |
| EmailEngagementAggregate | |
| EntitiesWithRejectedBackgroundSync | |
| Entity |
Represents an instance of an entity (a record). |
| EntityAttributeCollection |
Represents the entity attribute collection. |
| EntityCollection |
Contains a collection of entity instances. |
| EntityFilePointersRequest |
Contains the data to reconcile entity file pointers. |
| EntityFilePointersResponse |
Contains the response from processing EntityFilePointersRequest. |
| EntityImageCollection |
Contains a collection of Entity image objects. |
| EntityRecordCountCollection | |
| EntityReference |
Identifies a record. |
| EntityReferenceCollection |
Contains a collection of entity references. |
| EntitySetting | |
| ErrorDetailCollection |
Contains a collection of objects that provide details on an error. |
| ExecuteMultipleResponseItem |
Contains the response from execution of a message request. |
| ExecuteMultipleResponseItemCollection |
Contains a collection of ExecuteMultipleResponseItem instances. |
| ExecuteMultipleSettings |
Defines the execution behavior of ExecuteMultipleRequest. |
| ExecuteTransactionFault |
Represents a fault that occurs when a message request fails execution during a single database transaction. |
| ExportComponentDetails | |
| ExportComponentsParams | |
| FieldPermissionType |
Defines the possible field permission types. |
| FieldPermissionTypeCanReadUnMasked | |
| FileSasUrlResponse |
Contains the details of the result from the GetFileSasUrlResponse.Result property |
| FormattedValueCollection |
Contains a collection of formatted values for the attributes for an entity. |
| GlobalSearchConfigurationCollection |
Contains a collection of GlobalSearchConfigurations instances. |
| GlobalSearchConfigurationResponseCollection | |
| GlobalSearchConfigurations |
Contains information about a search provider and results web page. |
| ImportFileUploadResponse | |
| InvalidPluginExecutionException |
Represents an exception that occurred during plug-in execution. |
| IPluginExecutionContextExtensions |
Contains data that describes additional information about a plug-in's execution. |
| KeyAttributeCollection |
Represents the key attribute collection. |
| KeyVaultAlgorithm | |
| KnownTypesResolver |
Resolves known organization message request and response types for the SDK contracts. |
| Label |
Contains a collection of translations for a label. For the Web API the corresponding type is Label ComplexType. |
| LayerDesiredOrder |
Holds data for a single hint. |
| LocalizedLabel |
Contains a localized label, including the label string and the language code. For the Web API the corresponding type is LocalizedLabel ComplexType. |
| LocalizedLabelCollection |
Defines a collection of LocalizedLabel. |
| MailboxTrackingFolderMapping |
Represents an individual folder-level tracking rule item in the collection (MailboxTrackingFolderMappingCollection). For the Web API the corresponding type is MailboxTrackingFolderMapping ComplexType. |
| MailboxTrackingFolderMappingCollection |
Represents a collection of folder-level tracking rules. |
| ManagedProperty<T> |
Represents a strongly typed managed property. |
| MissingDependency |
Provides information about a missing dependent solution component. |
| ModuleEndpointOutputPathInfo | |
| ModuleRunIncrementalSettings | |
| ModuleRunOutputInfo | |
| Money |
Contains the value for a money attribute. |
| NewOrUpdatedItem |
Represents the new or updated item. |
| OfflineAppModuleProfileMap | |
| OfflineAppModuleProfileMapping | |
| OfflineSchemaScript | |
| OfflineSchemaScripts | |
| OptionSetValue |
Represents a value for an attribute that has an option set. |
| OptionSetValueCollection |
Contains a collection of OptionSetValue instances. |
| OrganizationRequest |
Contains the data needed to execute a request and the base class for all organization requests. |
| OrganizationRequestCollection |
Contains a collection of organization requests. |
| OrganizationResponse |
Contains the response from a request and the base class for all organization responses. |
| OrganizationResponseCollection |
Contains a collection of organization responses. |
| OrganizationServiceFault |
Represents an organization service fault. |
| ParameterCollection |
Provides a collection of parameters for a request. |
| PreferredSolution | |
| PreferredSolutionDetails | |
| ProvisionLanguageForUserResult | |
| PSqlConnectionContext | |
| QuickFindConfiguration |
For internal use only. |
| QuickFindConfigurationCollection |
For internal use only. |
| QuickFindResult |
For internal use only. |
| QuickFindResultCollection |
For internal use only. |
| RelatedEntityCollection |
Contains a collection of related entities. |
| Relationship |
Represents a relationship between two entities. |
| RelationshipQueryCollection |
Provides a collection of relationship queries. |
| RelationshipSchemaNameAttribute |
Used by the code generation tool to create classes based on entities. |
| RemoteExecutionContext |
Defines the contextual information sent to a remote service endpoint at run-time. |
| RemoveDependencyResult | |
| RemovedOrDeletedItem |
Represents the removed or deleted item. |
| SaveChangesException |
Represents an exception that occurred when saving changes to the OrganizationServiceContext. |
| SaveChangesResult |
Contains the result of the save changes operation returned from the organization web service. |
| SaveChangesResultCollection |
Provides a collection of results for a save changes operation. |
| ScalarInputParameter | |
| SdkExceptionBase |
Base class for SDK specific exceptions. |
| SelectColumn | |
| SelectColumnCollection | |
| ServiceEndpointFault |
Represents a fault at a service endpoint in the cloud. |
| ServicePlan |
Represents a service plan assigned to a system user. |
| SolutionComponentDetails |
Contains detailed information about a solution component. |
| SolutionComponentOperationResult | |
| SolutionComponentOption | |
| SolutionComponentReference | |
| SolutionDetails |
Provides detailed information about a solution. |
| SolutionInfo |
Contains information about the details of the solution. |
| SolutionOperationResult | |
| SolutionParameters |
Additional solution parameters. |
| SolutionValidationResult |
The result returned from validating the solution. |
| StageSolutionResults |
Contains detailed information from staging a solution. |
| SubscriptionData |
Provides the collection of updated or deleted entites as the result of a subscription synchronization. |
| SubscriptionDeletedEntitiesData |
A collection of SubscriptionDeletedEntityData. |
| SubscriptionDeletedEntityData |
A collection of identifiers for entites deleted after a subscription synchronization. |
| SubscriptionEntitiesMetadata |
A collection of SubscriptionEntityMetadata. |
| SubscriptionEntityMetadata |
A collection of entity metadata definitions. |
| SubscriptionUpdatedEntitiesData |
A collection of SubscriptionUpdatedEntityData. |
| SubscriptionUpdatedEntityData |
A collection of entity data updated by a subscription synchonization. |
| SyncOfflineDataResponse | |
| SyncOfflineDataSchemaResponse | |
| SyncSubscriptionDataResponse | |
| SyncSubscriptionMetadataResponse | |
| TdsPowerBISqlRequest | |
| TriggerDefinition | |
| TriggerDefinitionEventType | |
| TriggerDefinitions | |
| UpdatedData | |
| UpdatedEntitiesData | |
| UpdatePointersRequest | |
| UpgradeCurrencyTypeStatus | |
| UpgradeCurrencyTypeTable | |
| UpstreamEntityInputVersionInfo | |
| UpstreamIncrementalEntityInfo | |
| UpstreamIncrementalEntityTimestampInfo | |
| UpstreamIncrementalEntityVersionInfo | |
| UpstreamResultInput | |
| UserLicenseInfo |
Represents license information for a user that defines the service plans that the user has access to. |
| UserName | |
| UserSearchFacet | |
| UserSearchFacetCollection | |
| UserSearchFacetResponseCollection | |
| ValidateSolutionPrerequisitesResult | |
Interfaces
| IAssemblyAuthenticationContext | |
| IAssemblyAuthenticationContext2 | |
| IChangedItem |
Represents the interface for the changed item. |
| IClientHeaderService | |
| IEntityDataSourceRetrieverService | |
| IEnvironmentService | |
| IEnvironmentVariableService |
Internal use only. |
| IExecutionContext |
Base interface that defines the contextual information passed to a plug-in or custom workflow activity at run-time. |
| IFeatureControlService | |
| IKeyVaultClient | |
| ILocalConfigStore | |
| IManagedIdentityService | |
| IOnBehalfOfTokenService | |
| IOrganizationService |
Provides programmatic access to the metadata and business data in an organization (environment). |
| IOrganizationServiceFactory |
Represents a factory for creating IOrganizationService instances. |
| IPlugin |
Base interface for a plug-in. |
| IPluginExceptionProvider | |
| IPluginExecutionContext |
Defines the contextual information passed to a plug-in at run-time. Contains information that describes the run-time environment that the plug-in is executing in, information related to the execution pipeline, and entity business information. |
| IPluginExecutionContext2 |
Provides a plug-in execution context with additional details related to use with operations that originate from portals. |
| IPluginExecutionContext3 | |
| IPluginExecutionContext4 | |
| IPluginExecutionContext5 |
Extends IPluginExecutionContext4 adding support for the initiating user agent property. |
| IPluginExecutionContext6 |
Extends IPluginExecutionContext5 adding support for the environment and tenant ID properties. |
| IPluginExecutionContext7 |
Extends IPluginExecutionContext6 adding support for the IsApplicationUser property. |
| IProxyTypesAssemblyProvider |
Provides the early-bound entity types assembly that was created using the CrmSvcUtil utility. |
| IPSqlTdsResponsePipe | |
| IServiceEndpointNotificationService |
Posts the plug-in execution context to the Microsoft Azure Service Bus. |
| IServiceEndpointPlugin |
Defines a plug-in that implements the service behavior of a Microsoft Azure Service Bus listener. |
| ITokenService | |
| ITracingService |
Provides a method of logging run-time trace information for plug-ins. |
| ITwoWayServiceEndpointPlugin |
Defines a plug-in that implements the service behavior of a Microsoft Azure Service Bus listener. |
| IVariantConfigEnvironmentConstraintProvider | |
| IWebHttpServiceEndpointPlugin |
Defines a plug-in that implements the service behavior of a Microsoft Azure Service Bus listener. |
Enums
| AuthenticationType | |
| ChangeType |
Represents the enumeration for the change type. |
| ClientHeader | |
| ComponentPrincipalAccessRequestType | |
| ConcurrencyBehavior |
Contains values to indicate the optimistic concurrency behavior that should be applied when performing entity update and delete operations. |
| EntityKeyIndexStatus |
Represents the enumerator for the entity key status when the index creation job is in progress. For the Web API use the EntityKeyIndexStatus EnumType. |
| EntityRole |
Contains values to indicate the role the entity plays in a relationship. |
| EntityState |
Indicates the state of an entity as tracked by the OrganizationServiceContext and indicates to the server the operation that should be performed for a related entity. |
| ImportDecision | |
| LayerDesiredOrderType |
The type of the hint. |
| OperationStatus |
Represents the current state of an operation. |
| PluginHttpStatusCode | |
| PresentInOrg | |
| ProvisionLanguageForUserStatusType | |
| RemoveDependencyStatus | |
| ResultCode | |
| ShareAccessRights | |
| SolutionOperationMessageType | |
| SolutionOperationStatus | |
| SolutionOperationType | |
| SolutionValidationResultType |
The type of result returned from validating a solution. |
| SqlNameMappingOptions | |
| StageSolutionStatus |
The status of the solution staging request. |
| ValidateSolutionStatus | |