Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
The azure notification hub entity of Omnichannel.
Messages
The following table lists the messages for the Azure notification hub (msdyn_azurenotificationhub) table. Messages represent operations that can be performed on the table. They may also be events.
| Name Is Event? |
Web API Operation | SDK for .NET |
|---|---|---|
AssignEvent: True |
PATCH /msdyn_azurenotificationhubs(msdyn_azurenotificationhubid)Update the ownerid property. |
AssignRequest |
AssociateEvent: True |
Associate records | Associate records |
BulkRetainEvent: True |
BulkRetain | Learn to use messages with the SDK for .NET |
CreateEvent: True |
POST /msdyn_azurenotificationhubsSee Create |
Create records |
CreateMultipleEvent: True |
CreateMultiple | CreateMultipleRequest |
DeleteEvent: True |
DELETE /msdyn_azurenotificationhubs(msdyn_azurenotificationhubid)See Delete |
Delete records |
DisassociateEvent: True |
Disassociate records | Disassociate records |
GrantAccessEvent: True |
GrantAccess | GrantAccessRequest |
IsValidStateTransitionEvent: False |
IsValidStateTransition | IsValidStateTransitionRequest |
ModifyAccessEvent: True |
ModifyAccess | ModifyAccessRequest |
PurgeRetainedContentEvent: True |
PurgeRetainedContent | Learn to use messages with the SDK for .NET |
RetainEvent: True |
Retain | Learn to use messages with the SDK for .NET |
RetrieveEvent: True |
GET /msdyn_azurenotificationhubs(msdyn_azurenotificationhubid)See Retrieve |
Retrieve records |
RetrieveMultipleEvent: True |
GET /msdyn_azurenotificationhubsSee Query data |
Query data |
RetrievePrincipalAccessEvent: True |
RetrievePrincipalAccess | RetrievePrincipalAccessRequest |
RetrieveSharedPrincipalsAndAccessEvent: True |
RetrieveSharedPrincipalsAndAccess | RetrieveSharedPrincipalsAndAccessRequest |
RevokeAccessEvent: True |
RevokeAccess | RevokeAccessRequest |
RollbackRetainEvent: True |
RollbackRetain | Learn to use messages with the SDK for .NET |
SetStateEvent: True |
PATCH /msdyn_azurenotificationhubs(msdyn_azurenotificationhubid)Update the statecode and statuscode properties. |
SetStateRequest |
UpdateEvent: True |
PATCH /msdyn_azurenotificationhubs(msdyn_azurenotificationhubid)See Update |
Update records |
UpdateMultipleEvent: True |
UpdateMultiple | UpdateMultipleRequest |
UpsertEvent: False |
PATCH /msdyn_azurenotificationhubs(msdyn_azurenotificationhubid)See Upsert a table row |
UpsertRequest |
UpsertMultipleEvent: False |
UpsertMultiple | UpsertMultipleRequest |
ValidateRetentionConfigEvent: True |
ValidateRetentionConfig | Learn to use messages with the SDK for .NET |
Properties
The following table lists selected properties for the Azure notification hub (msdyn_azurenotificationhub) table.
| Property | Value |
|---|---|
| DisplayName | Azure notification hub |
| DisplayCollectionName | Azure notification hubs |
| SchemaName | msdyn_azurenotificationhub |
| CollectionSchemaName | msdyn_azurenotificationhubs |
| EntitySetName | msdyn_azurenotificationhubs |
| LogicalName | msdyn_azurenotificationhub |
| LogicalCollectionName | msdyn_azurenotificationhubs |
| PrimaryIdAttribute | msdyn_azurenotificationhubid |
| PrimaryNameAttribute | msdyn_azurenotificationhubname |
| TableType | Standard |
| OwnershipType | UserOwned |
Writable columns/attributes
These columns/attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.
- ImportSequenceNumber
- IsCustomizable
- msdyn_azurenotificationhubId
- msdyn_azurenotificationhubname
- msdyn_connectionstringid
- msdyn_defaultnotificationbody
- msdyn_notificationtitle
- msdyn_showmessagepreview
- msdyn_shownotificationtitle
- OverriddenCreatedOn
- OwnerId
- OwnerIdType
- statecode
- statuscode
- TimeZoneRuleVersionNumber
- UTCConversionTimeZoneCode
ImportSequenceNumber
| Property | Value |
|---|---|
| Description | Sequence number of the import that created this record. |
| DisplayName | Import Sequence Number |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | importsequencenumber |
| RequiredLevel | None |
| Type | Integer |
| MaxValue | 2147483647 |
| MinValue | -2147483648 |
IsCustomizable
| Property | Value |
|---|---|
| Description | For internal use only. |
| DisplayName | Is Customizable |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | iscustomizable |
| RequiredLevel | SystemRequired |
| Type | ManagedProperty |
msdyn_azurenotificationhubId
| Property | Value |
|---|---|
| Description | Unique identifier for entity instances |
| DisplayName | Azure notification hub |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | msdyn_azurenotificationhubid |
| RequiredLevel | SystemRequired |
| Type | Uniqueidentifier |
msdyn_azurenotificationhubname
| Property | Value |
|---|---|
| Description | |
| DisplayName | Azure notification hub name |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | msdyn_azurenotificationhubname |
| RequiredLevel | ApplicationRequired |
| Type | String |
| Format | Text |
| FormatName | Text |
| ImeMode | Auto |
| IsLocalizable | False |
| MaxLength | 850 |
msdyn_connectionstringid
| Property | Value |
|---|---|
| Description | The connection string of azure notification hub |
| DisplayName | Connection string |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | msdyn_connectionstringid |
| RequiredLevel | None |
| Type | Lookup |
| Targets | msdyn_channelinstancesecret |
msdyn_defaultnotificationbody
| Property | Value |
|---|---|
| Description | The default notification body for the azure notification hub |
| DisplayName | Default notification body |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | msdyn_defaultnotificationbody |
| RequiredLevel | ApplicationRequired |
| Type | String |
| Format | Text |
| FormatName | Text |
| ImeMode | Auto |
| IsLocalizable | False |
| MaxLength | 4000 |
msdyn_notificationtitle
| Property | Value |
|---|---|
| Description | The notification title of the azure notification hub |
| DisplayName | Notification title |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | msdyn_notificationtitle |
| RequiredLevel | ApplicationRequired |
| Type | String |
| Format | Text |
| FormatName | Text |
| ImeMode | Auto |
| IsLocalizable | False |
| MaxLength | 4000 |
msdyn_showmessagepreview
| Property | Value |
|---|---|
| Description | Flag to indicate if message preview should be shown. |
| DisplayName | Show message preview |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | msdyn_showmessagepreview |
| RequiredLevel | ApplicationRequired |
| Type | Boolean |
| GlobalChoiceName | msdyn_azurenotificationhub_msdyn_showmessagepreview |
| DefaultValue | True |
| True Label | Yes |
| False Label | No |
msdyn_shownotificationtitle
| Property | Value |
|---|---|
| Description | The flag to indicate if the notification title should be shown |
| DisplayName | Show notification title |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | msdyn_shownotificationtitle |
| RequiredLevel | ApplicationRequired |
| Type | Boolean |
| GlobalChoiceName | msdyn_azurenotificationhub_msdyn_shownotificationtitle |
| DefaultValue | False |
| True Label | Yes |
| False Label | No |
OverriddenCreatedOn
| Property | Value |
|---|---|
| Description | Date and time that the record was migrated. |
| DisplayName | Record Created On |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | overriddencreatedon |
| RequiredLevel | None |
| Type | DateTime |
| CanChangeDateTimeBehavior | False |
| DateTimeBehavior | UserLocal |
| Format | DateOnly |
| ImeMode | Inactive |
| SourceTypeMask | 0 |
OwnerId
| Property | Value |
|---|---|
| Description | Owner Id |
| DisplayName | Owner |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | ownerid |
| RequiredLevel | SystemRequired |
| Type | Owner |
| Targets | systemuser, team |
OwnerIdType
| Property | Value |
|---|---|
| Description | Owner Id Type |
| DisplayName | |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | owneridtype |
| RequiredLevel | SystemRequired |
| Type | EntityName |
statecode
| Property | Value |
|---|---|
| Description | Status of the Azure notification hub |
| DisplayName | Status |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | statecode |
| RequiredLevel | SystemRequired |
| Type | State |
| DefaultFormValue | |
| GlobalChoiceName | msdyn_azurenotificationhub_statecode |
statecode Choices/Options
| Value | Details |
|---|---|
| 0 | Label: Active DefaultStatus: 1 InvariantName: Active |
| 1 | Label: Inactive DefaultStatus: 2 InvariantName: Inactive |
statuscode
| Property | Value |
|---|---|
| Description | Reason for the status of the Azure notification hub |
| DisplayName | Status Reason |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | statuscode |
| RequiredLevel | None |
| Type | Status |
| DefaultFormValue | |
| GlobalChoiceName | msdyn_azurenotificationhub_statuscode |
statuscode Choices/Options
| Value | Details |
|---|---|
| 1 | Label: Active State:0 TransitionData: None |
| 2 | Label: Inactive State:1 TransitionData: None |
TimeZoneRuleVersionNumber
| Property | Value |
|---|---|
| Description | For internal use only. |
| DisplayName | Time Zone Rule Version Number |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | timezoneruleversionnumber |
| RequiredLevel | None |
| Type | Integer |
| MaxValue | 2147483647 |
| MinValue | -1 |
UTCConversionTimeZoneCode
| Property | Value |
|---|---|
| Description | Time zone code that was in use when the record was created. |
| DisplayName | UTC Conversion Time Zone Code |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | utcconversiontimezonecode |
| RequiredLevel | None |
| Type | Integer |
| MaxValue | 2147483647 |
| MinValue | -1 |
Read-only columns/attributes
These columns/attributes return false for both IsValidForCreate and IsValidForUpdate. Listed by SchemaName.
- ComponentIdUnique
- ComponentState
- CreatedBy
- CreatedOn
- CreatedOnBehalfBy
- IsManaged
- ModifiedBy
- ModifiedOn
- ModifiedOnBehalfBy
- OverwriteTime
- OwnerIdName
- OwnerIdYomiName
- OwningBusinessUnit
- OwningTeam
- OwningUser
- SolutionId
- SupportingSolutionId
- VersionNumber
ComponentIdUnique
| Property | Value |
|---|---|
| Description | For internal use only. |
| DisplayName | Row id unique |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | componentidunique |
| RequiredLevel | SystemRequired |
| Type | Uniqueidentifier |
ComponentState
| Property | Value |
|---|---|
| Description | For internal use only. |
| DisplayName | Component State |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | componentstate |
| RequiredLevel | SystemRequired |
| Type | Picklist |
| DefaultFormValue | |
| GlobalChoiceName | componentstate |
ComponentState Choices/Options
| Value | Label |
|---|---|
| 0 | Published |
| 1 | Unpublished |
| 2 | Deleted |
| 3 | Deleted Unpublished |
CreatedBy
| Property | Value |
|---|---|
| Description | Unique identifier of the user who created the record. |
| DisplayName | Created By |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | createdby |
| RequiredLevel | None |
| Type | Lookup |
| Targets | systemuser |
CreatedOn
| Property | Value |
|---|---|
| Description | Date and time when the record was created. |
| DisplayName | Created On |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | createdon |
| RequiredLevel | None |
| Type | DateTime |
| CanChangeDateTimeBehavior | False |
| DateTimeBehavior | UserLocal |
| Format | DateAndTime |
| ImeMode | Inactive |
| SourceTypeMask | 0 |
CreatedOnBehalfBy
| Property | Value |
|---|---|
| Description | Unique identifier of the delegate user who created the record. |
| DisplayName | Created By (Delegate) |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | createdonbehalfby |
| RequiredLevel | None |
| Type | Lookup |
| Targets | systemuser |
IsManaged
| Property | Value |
|---|---|
| Description | Indicates whether the solution component is part of a managed solution. |
| DisplayName | Is Managed |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | ismanaged |
| RequiredLevel | SystemRequired |
| Type | Boolean |
| GlobalChoiceName | ismanaged |
| DefaultValue | False |
| True Label | Managed |
| False Label | Unmanaged |
ModifiedBy
| Property | Value |
|---|---|
| Description | Unique identifier of the user who modified the record. |
| DisplayName | Modified By |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | modifiedby |
| RequiredLevel | None |
| Type | Lookup |
| Targets | systemuser |
ModifiedOn
| Property | Value |
|---|---|
| Description | Date and time when the record was modified. |
| DisplayName | Modified On |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | modifiedon |
| RequiredLevel | None |
| Type | DateTime |
| CanChangeDateTimeBehavior | False |
| DateTimeBehavior | UserLocal |
| Format | DateAndTime |
| ImeMode | Inactive |
| SourceTypeMask | 0 |
ModifiedOnBehalfBy
| Property | Value |
|---|---|
| Description | Unique identifier of the delegate user who modified the record. |
| DisplayName | Modified By (Delegate) |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | modifiedonbehalfby |
| RequiredLevel | None |
| Type | Lookup |
| Targets | systemuser |
OverwriteTime
| Property | Value |
|---|---|
| Description | For internal use only. |
| DisplayName | Record Overwrite Time |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | overwritetime |
| RequiredLevel | SystemRequired |
| Type | DateTime |
| CanChangeDateTimeBehavior | False |
| DateTimeBehavior | UserLocal |
| Format | DateAndTime |
| ImeMode | Inactive |
| SourceTypeMask | 0 |
OwnerIdName
| Property | Value |
|---|---|
| Description | Name of the owner |
| DisplayName | |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | owneridname |
| RequiredLevel | SystemRequired |
| Type | String |
| Format | Text |
| FormatName | Text |
| ImeMode | Auto |
| IsLocalizable | False |
| MaxLength | 100 |
OwnerIdYomiName
| Property | Value |
|---|---|
| Description | Yomi name of the owner |
| DisplayName | |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | owneridyominame |
| RequiredLevel | SystemRequired |
| Type | String |
| Format | Text |
| FormatName | Text |
| ImeMode | Auto |
| IsLocalizable | False |
| MaxLength | 100 |
OwningBusinessUnit
| Property | Value |
|---|---|
| Description | Unique identifier for the business unit that owns the record |
| DisplayName | Owning Business Unit |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | owningbusinessunit |
| RequiredLevel | SystemRequired |
| Type | Lookup |
| Targets | businessunit |
OwningTeam
| Property | Value |
|---|---|
| Description | Unique identifier for the team that owns the record. |
| DisplayName | Owning Team |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | owningteam |
| RequiredLevel | None |
| Type | Lookup |
| Targets | team |
OwningUser
| Property | Value |
|---|---|
| Description | Unique identifier for the user that owns the record. |
| DisplayName | Owning User |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | owninguser |
| RequiredLevel | None |
| Type | Lookup |
| Targets | systemuser |
SolutionId
| Property | Value |
|---|---|
| Description | Unique identifier of the associated solution. |
| DisplayName | Solution |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | solutionid |
| RequiredLevel | SystemRequired |
| Type | Uniqueidentifier |
SupportingSolutionId
| Property | Value |
|---|---|
| Description | For internal use only. |
| DisplayName | Solution |
| IsValidForForm | False |
| IsValidForRead | False |
| LogicalName | supportingsolutionid |
| RequiredLevel | None |
| Type | Uniqueidentifier |
VersionNumber
| Property | Value |
|---|---|
| Description | Version Number |
| DisplayName | Version Number |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | versionnumber |
| RequiredLevel | None |
| Type | BigInt |
| MaxValue | 9223372036854775807 |
| MinValue | -9223372036854775808 |
Many-to-One relationships
These relationships are many-to-one. Listed by SchemaName.
msdyn_msdyn_channelinstancesecret_msdyn_msdyn_azurenotificationhub_connectionstring
One-To-Many Relationship: msdyn_channelinstancesecret msdyn_msdyn_channelinstancesecret_msdyn_msdyn_azurenotificationhub_connectionstring
| Property | Value |
|---|---|
| ReferencedEntity | msdyn_channelinstancesecret |
| ReferencedAttribute | msdyn_channelinstancesecretid |
| ReferencingAttribute | msdyn_connectionstringid |
| ReferencingEntityNavigationPropertyName | msdyn_connectionstringid |
| IsHierarchical | |
| CascadeConfiguration | Archive: RemoveLinkAssign: NoCascadeDelete: RestrictMerge: NoCascadeReparent: NoCascadeRollupView: NoCascadeShare: NoCascadeUnshare: NoCascade |
One-to-Many relationships
These relationships are one-to-many. Listed by SchemaName.
msdyn_msdyn_azurenotificationhub_msdyn_livechatconfig_azurenotificationhubid
Many-To-One Relationship: msdyn_livechatconfig msdyn_msdyn_azurenotificationhub_msdyn_livechatconfig_azurenotificationhubid
| Property | Value |
|---|---|
| ReferencingEntity | msdyn_livechatconfig |
| ReferencingAttribute | msdyn_azurenotificationhubid |
| ReferencedEntityNavigationPropertyName | msdyn_msdyn_azurenotificationhub_msdyn_livechatconfig_azurenotificationhubid |
| IsCustomizable | True |
| AssociatedMenuConfiguration | AvailableOffline: True Behavior: UseCollectionNameGroup: DetailsLabel: MenuId: null Order: 10000 QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
See also
Dataverse table/entity reference
Dataverse Web API Reference