From acd801dd5609dd3ca3e15efdf4bf27b6ba225bad Mon Sep 17 00:00:00 2001 From: Vasanth Reddy Aleti Date: Wed, 18 Dec 2024 16:59:38 +0530 Subject: [PATCH 01/49] Update Microsoft.EnhancedRestore.json --- changelog/Microsoft.EnhancedRestore.json | 50 ++++++++++++++++++++++++ 1 file changed, 50 insertions(+) diff --git a/changelog/Microsoft.EnhancedRestore.json b/changelog/Microsoft.EnhancedRestore.json index f94c0ece441..4d4daaa1359 100644 --- a/changelog/Microsoft.EnhancedRestore.json +++ b/changelog/Microsoft.EnhancedRestore.json @@ -1,5 +1,55 @@ { "changelog": [ + { + "ChangeList": [ + { + "Id": "d8cc23ce-af12-4580-997f-262b1423e250", + "ApiChange": "Member", + "ChangedApiName": "unknown", + "ChangeType": "Addition", + "Description": "Added the `unknown` member to the **mailboxType** enumeration.", + "Target": "mailboxType" + }, + { + "Id": "d8cc23ce-af12-4580-997f-262b1423e250", + "ApiChange": "Member", + "ChangedApiName": "userMailbox", + "ChangeType": "Deletion", + "Description": "Removed the `userMailbox` member from the **mailboxType** enumeration.", + "Target": "mailboxType" + }, + { + "Id": "d8cc23ce-af12-4580-997f-262b1423e250", + "ApiChange": "Member", + "ChangedApiName": "user", + "ChangeType": "Addition", + "Description": "Added the `user` member to the **mailboxType** enumeration.", + "Target": "mailboxType" + }, + { + "Id": "d8cc23ce-af12-4580-997f-262b1423e250", + "ApiChange": "Member", + "ChangedApiName": "sharedMailbox", + "ChangeType": "Deletion", + "Description": "Removed the `sharedMailbox` member from the **mailboxType** enumeration.", + "Target": "mailboxType" + }, + { + "Id": "d8cc23ce-af12-4580-997f-262b1423e250", + "ApiChange": "Member", + "ChangedApiName": "shared", + "ChangeType": "Addition", + "Description": "Added the `shared` member to the **mailboxType** enumeration.", + "Target": "mailboxType" + } + ], + "Id": "d8cc23ce-af12-4580-997f-262b1423e250", + "Cloud": "Review", + "Version": "beta", + "CreatedDateTime": "2024-12-10T22:24:28.9370222Z", + "WorkloadArea": "EnhancedRestore", + "SubArea": "Backup and Restore" + }, { "ChangeList": [ { From fb439aa08e9fce81c2764b9341af454d8657a70a Mon Sep 17 00:00:00 2001 From: Vasanth Reddy Aleti Date: Thu, 19 Dec 2024 11:57:34 +0530 Subject: [PATCH 02/49] Update Microsoft.EnhancedRestore.json --- changelog/Microsoft.EnhancedRestore.json | 26 ++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/changelog/Microsoft.EnhancedRestore.json b/changelog/Microsoft.EnhancedRestore.json index 4d4daaa1359..a12f48d3377 100644 --- a/changelog/Microsoft.EnhancedRestore.json +++ b/changelog/Microsoft.EnhancedRestore.json @@ -49,6 +49,32 @@ "CreatedDateTime": "2024-12-10T22:24:28.9370222Z", "WorkloadArea": "EnhancedRestore", "SubArea": "Backup and Restore" + }, + { + "ChangeList": [ + { + "Id": "9ddaec40-375d-4557-9c2c-b31b99520210", + "ApiChange": "Enumeration", + "ChangedApiName": "mailboxType", + "ChangeType": "Addition", + "Description": "Added the **mailboxType** enumeration type.", + "Target": "mailboxType" + }, + { + "Id": "9ddaec40-375d-4557-9c2c-b31b99520210", + "ApiChange": "Member", + "ChangedApiName": "unknownFutureValue", + "ChangeType": "Addition", + "Description": "Added the `unknownFutureValue` member to the **mailboxType** enumeration.", + "Target": "mailboxType" + } + ], + "Id": "9ddaec40-375d-4557-9c2c-b31b99520210", + "Cloud": "Review", + "Version": "beta", + "CreatedDateTime": "2024-11-13T06:06:47.9890636Z", + "WorkloadArea": "EnhancedRestore", + "SubArea": "Backup and Restore" }, { "ChangeList": [ From 5af08b17792b71d9f035afb37d7b4556a38fc41d Mon Sep 17 00:00:00 2001 From: mnorman-ms Date: Mon, 23 Dec 2024 15:36:30 +0700 Subject: [PATCH 03/49] Added Remarks->None sections. Lots of manual cleanup. --- .../resources/aaduserconversationmember.md | 3 + .../aaduserconversationmemberresult.md | 3 + .../beta/resources/acceptjoinresponse.md | 3 + api-reference/beta/resources/accessaction.md | 3 + .../resources/accessreviewhistoryinstance.md | 3 + .../accessreviewinstancedecisionitemtarget.md | 3 + .../accessreviewrecurrencesettings.md | 3 + .../beta/resources/accessreviewsettings.md | 3 + api-reference/beta/resources/addin.md | 3 + .../beta/resources/adminreportsettings.md | 3 + api-reference/beta/resources/album.md | 3 + .../beta/resources/alerthistorystate.md | 3 + api-reference/beta/resources/alerttrigger.md | 3 + .../beta/resources/alternativesecurityid.md | 3 + .../beta/resources/apiapplication.md | 3 + .../beta/resources/apphostedmediaconfig.md | 3 + .../resources/applemanagedidentityprovider.md | 3 + .../appliedconditionalaccesspolicy.md | 3 + api-reference/beta/resources/approle.md | 3 + .../beta/resources/approleassignment.md | 3 + api-reference/beta/resources/assignedlabel.md | 3 + .../beta/resources/assignedlicense.md | 3 + api-reference/beta/resources/assignedplan.md | 3 + .../beta/resources/associatedteaminfo.md | 3 + .../beta/resources/asyncjobstatus.md | 17 +- .../beta/resources/attendanceinterval.md | 3 + .../beta/resources/attendancerecord.md | 3 + api-reference/beta/resources/attendee.md | 3 + .../beta/resources/attendeeavailability.md | 14 +- api-reference/beta/resources/attendeebase.md | 14 +- api-reference/beta/resources/audio.md | 49 ++--- .../beta/resources/audioconferencing.md | 3 + .../beta/resources/auditactivityinitiator.md | 3 + .../resources/automaticrepliesmailtips.md | 3 + .../beta/resources/automaticrepliessetting.md | 3 + .../beta/resources/autoreviewsettings.md | 3 + .../beta/resources/averagecomparativescore.md | 3 + .../azurecommunicationservicesuseridentity.md | 3 + api-reference/beta/resources/baseitem.md | 33 ++-- .../beta/resources/baseitemversion.md | 3 + api-reference/beta/resources/booleancolumn.md | 3 + .../broadcastmeetingcaptionsettings.md | 3 + .../resources/broadcastmeetingsettings.md | 3 + .../beta/resources/builtinidentityprovider.md | 3 + api-reference/beta/resources/bundle.md | 3 + .../resources/callendedeventmessagedetail.md | 3 + .../beta/resources/callmediastate.md | 3 + api-reference/beta/resources/calloptions.md | 3 + .../beta/resources/callparticipantinfo.md | 3 + api-reference/beta/resources/callrecording.md | 3 + .../callrecordingeventmessagedetail.md | 3 + .../callrecords-administrativeunitinfo.md | 3 + .../beta/resources/callrecords-organizer.md | 3 + .../beta/resources/callrecords-participant.md | 3 + .../resources/callrecords-participantbase.md | 3 + api-reference/beta/resources/callroute.md | 3 + .../callstartedeventmessagedetail.md | 3 + .../beta/resources/calltranscript.md | 3 + .../calltranscripteventmessagedetail.md | 3 + .../beta/resources/calltranscriptioninfo.md | 3 + api-reference/beta/resources/certification.md | 3 + .../beta/resources/certificationcontrol.md | 3 + .../changenotificationencryptedcontent.md | 3 + .../channeladdedeventmessagedetail.md | 3 + .../channeldeletedeventmessagedetail.md | 3 + ...neldescriptionupdatedeventmessagedetail.md | 3 + .../beta/resources/channelidentity.md | 3 + .../resources/channelmoderationsettings.md | 3 + .../channelrenamedeventmessagedetail.md | 3 + ...etasfavoritebydefaulteventmessagedetail.md | 3 + ...channelsharingupdatedeventmessagedetail.md | 3 + .../beta/resources/channelsummary.md | 3 + ...etasfavoritebydefaulteventmessagedetail.md | 3 + api-reference/beta/resources/chatinfo.md | 3 + .../beta/resources/chatmessageattachment.md | 3 + .../beta/resources/chatmessagemention.md | 3 + .../resources/chatmessagepolicyviolation.md | 3 + .../chatmessagepolicyviolationpolicytip.md | 3 + .../beta/resources/chatmessagereaction.md | 3 + .../chatrenamedeventmessagedetail.md | 3 + .../beta/resources/chatrestrictions.md | 3 + api-reference/beta/resources/choicecolumn.md | 3 + .../chunkeduploadsessiondescriptor.md | 3 + .../clientcertificateauthentication.md | 3 + .../beta/resources/cloudappsecuritystate.md | 3 + .../cloudrealtimecommunicationinfo.md | 3 + .../beta/resources/coachmarklocation.md | 3 + api-reference/beta/resources/columnLink.md | 3 + .../beta/resources/columnvalidation.md | 3 + api-reference/beta/resources/commentaction.md | 20 +- .../beta/resources/commsnotification.md | 3 + .../beta/resources/commsnotifications.md | 3 + .../communicationsapplicationidentity.md | 3 + ...mmunicationsapplicationinstanceidentity.md | 3 + .../communicationsencryptedidentity.md | 3 + .../resources/communicationsguestidentity.md | 3 + .../resources/communicationsidentityset.md | 3 + .../resources/communicationsphoneidentity.md | 3 + .../resources/communicationsuseridentity.md | 3 + .../beta/resources/complianceinformation.md | 3 + .../resources/conditionalaccessaudience.md | 3 + .../resources/conditionalaccesslocations.md | 3 + .../conditionalaccessrulesatisfied.md | 3 + .../resources/contentapprovalstatuscolumn.md | 3 + .../beta/resources/contentsharingsession.md | 8 + .../beta/resources/contenttypeinfo.md | 3 + .../beta/resources/contenttypeorder.md | 3 + api-reference/beta/resources/controlscore.md | 3 + .../beta/resources/conversationmember.md | 3 + ...tionmemberroleupdatedeventmessagedetail.md | 3 + .../beta/resources/conversionuserdetails.md | 3 + .../beta/resources/convertidresult.md | 3 + api-reference/beta/resources/createaction.md | 3 + .../beta/resources/currencycolumn.md | 8 + .../customappscopeattributesdictionary.md | 3 + .../beta/resources/customquestionanswer.md | 3 + .../beta/resources/customtimezone.md | 3 + .../beta/resources/datetimecolumn.md | 31 ++-- .../beta/resources/daylighttimezoneoffset.md | 3 + .../beta/resources/defaultcolumnvalue.md | 3 + .../delegatedpermissionclassification.md | 3 + api-reference/beta/resources/deleteaction.md | 17 +- api-reference/beta/resources/deleted.md | 16 +- api-reference/beta/resources/devicedetail.md | 3 + .../directoryobjectpartnerreference.md | 3 + .../beta/resources/directorysizequota.md | 3 + .../beta/resources/documentsetcontent.md | 3 + api-reference/beta/resources/domainstate.md | 3 + .../beta/resources/driveitemsource.md | 3 + .../beta/resources/driverecipient.md | 3 + .../beta/resources/dynamics-dimension.md | 3 + .../beta/resources/dynamics-dimensionvalue.md | 3 + .../beta/resources/dynamics-journal.md | 17 +- api-reference/beta/resources/editaction.md | 12 +- .../beta/resources/educationcategory.md | 3 + .../beta/resources/educationcourse.md | 3 + .../resources/educationgradingcategory.md | 3 + .../beta/resources/educationonpremisesinfo.md | 3 + .../beta/resources/educationstudent.md | 3 + .../educationsynchronizationprofilestatus.md | 3 + .../beta/resources/educationteacher.md | 3 + api-reference/beta/resources/educationterm.md | 3 + api-reference/beta/resources/emailaddress.md | 3 + .../beta/resources/employeeorgdata.md | 3 + .../resources/engagementasyncoperation.md | 3 + api-reference/beta/resources/eventmessage.md | 3 + .../beta/resources/eventmessagedetail.md | 3 +- .../beta/resources/eventmessagerequest.md | 174 +++++++++--------- api-reference/beta/resources/extension.md | 26 ++- .../beta/resources/extensionschemaproperty.md | 3 + .../resources/externalmeetingregistrant.md | 3 + .../extractsensitivitylabelsresult.md | 3 + api-reference/beta/resources/fieldvalueset.md | 37 ++-- api-reference/beta/resources/file.md | 17 +- api-reference/beta/resources/filehash.md | 3 + .../beta/resources/filesecuritystate.md | 3 + .../beta/resources/filesysteminfo.md | 3 + api-reference/beta/resources/folder.md | 19 +- api-reference/beta/resources/folderview.md | 27 +-- api-reference/beta/resources/followupflag.md | 3 + api-reference/beta/resources/freebusyerror.md | 3 + api-reference/beta/resources/genericerror.md | 3 + .../beta/resources/geolocationcolumn.md | 3 + .../beta/resources/governancepermission.md | 3 + .../governanceroleassignmentrequeststatus.md | 3 + .../beta/resources/governancerulesetting.md | 3 + .../beta/resources/governanceschedule.md | 3 + api-reference/beta/resources/hashes.md | 3 + .../beta/resources/hostsecuritystate.md | 3 + .../resources/hyperlinkorpicturecolumn.md | 3 + .../beta/resources/identityprovider.md | 3 + .../beta/resources/identityproviderbase.md | 3 + .../resources/identityuserflowattribute.md | 3 + .../beta/resources/idlesessionsignout.md | 3 + api-reference/beta/resources/image.md | 23 ++- .../beta/resources/implicitgrantsettings.md | 3 + .../beta/resources/incomingcalloptions.md | 3 + .../beta/resources/incomingcontext.md | 3 + .../beta/resources/incompletedata.md | 18 +- .../beta/resources/informationalurl.md | 3 + .../resources/insights-insightidentity.md | 19 +- .../resources/insights-resourcereference.md | 19 +- .../insights-resourcevisualization.md | 3 + .../beta/resources/insights-sharingdetail.md | 3 + .../beta/resources/insights-usagedetails.md | 3 + .../beta/resources/insightssettings.md | 3 + .../beta/resources/internetmessageheader.md | 3 + .../resources/invitationparticipantinfo.md | 3 + .../beta/resources/invitedusermessageinfo.md | 3 + .../beta/resources/invitenewbotresponse.md | 3 + .../resources/inviteparticipantsoperation.md | 3 + api-reference/beta/resources/iprange.md | 3 + api-reference/beta/resources/ipv4cidrrange.md | 3 + api-reference/beta/resources/ipv6cidrrange.md | 3 + api-reference/beta/resources/itemactionset.md | 55 +++--- .../beta/resources/itemactionstat.md | 17 +- api-reference/beta/resources/itemactivity.md | 54 +++--- .../beta/resources/itemactivitystat.md | 48 ++--- .../beta/resources/itemactivitytimeset.md | 27 +-- api-reference/beta/resources/itemanalytics.md | 28 +-- .../beta/resources/itempreviewinfo.md | 23 ++- api-reference/beta/resources/itemreference.md | 3 + .../beta/resources/itemretentionlabel.md | 3 + .../resources/joinmeetingidmeetinginfo.md | 3 + .../beta/resources/joinmeetingidsettings.md | 4 + .../beta/resources/licenseAssignmentState.md | 3 + .../beta/resources/licenseunitsdetail.md | 3 + api-reference/beta/resources/listinfo.md | 21 ++- .../beta/resources/listitemversion.md | 34 ++-- .../beta/resources/lobbybypasssettings.md | 3 + api-reference/beta/resources/localeinfo.md | 3 + .../beta/resources/locationconstraint.md | 16 +- .../beta/resources/locationconstraintitem.md | 3 + api-reference/beta/resources/logonuser.md | 3 + .../beta/resources/longrunningoperation.md | 3 + api-reference/beta/resources/lookupColumn.md | 23 ++- .../resources/m365appsinstallationoptions.md | 3 + .../beta/resources/mailboxsettings.md | 3 + .../beta/resources/mailsearchfolder.md | 3 + api-reference/beta/resources/mailtips.md | 3 + api-reference/beta/resources/mailtipserror.md | 3 + api-reference/beta/resources/malware.md | 3 + api-reference/beta/resources/malwarestate.md | 3 + api-reference/beta/resources/media.md | 3 + api-reference/beta/resources/mediaconfig.md | 3 + api-reference/beta/resources/mediainfo.md | 3 + api-reference/beta/resources/mediaprompt.md | 3 + api-reference/beta/resources/mediastream.md | 3 + .../beta/resources/meetingcapability.md | 3 + api-reference/beta/resources/meetinginfo.md | 3 + .../beta/resources/meetingparticipantinfo.md | 3 + .../beta/resources/meetingparticipants.md | 3 + .../meetingpolicyupdatedeventmessagedetail.md | 3 + .../beta/resources/meetingregistrant.md | 3 + .../beta/resources/meetingregistrantbase.md | 3 + .../resources/meetingregistrationquestion.md | 3 + .../beta/resources/meetingspeaker.md | 3 + .../beta/resources/meetingtimesuggestion.md | 3 + .../resources/meetingtimesuggestionsresult.md | 14 +- .../membersaddedeventmessagedetail.md | 3 + .../membersdeletedeventmessagedetail.md | 3 + .../membersjoinedeventmessagedetail.md | 3 + .../memberslefteventmessagedetail.md | 3 + api-reference/beta/resources/mentionaction.md | 19 +- .../beta/resources/mentionspreview.md | 3 + .../messagepinnedeventmessagedetail.md | 3 + api-reference/beta/resources/messagerule.md | 3 + .../beta/resources/messageruleactions.md | 3 + .../beta/resources/messagerulepredicates.md | 3 + .../messageunpinnedeventmessagedetail.md | 3 + api-reference/beta/resources/mfadetail.md | 3 + .../beta/resources/modifiedproperty.md | 3 + api-reference/beta/resources/moveaction.md | 17 +- .../beta/resources/networkconnection.md | 3 + .../beta/resources/networkinterface.md | 3 + api-reference/beta/resources/nomediaconfig.md | 3 + api-reference/beta/resources/notebook.md | 72 ++++---- api-reference/beta/resources/numberColumn.md | 33 ++-- .../beta/resources/objectidentity.md | 3 + .../beta/resources/onenoteidentity.md | 14 +- .../beta/resources/onenoteoperation.md | 42 ++--- .../onpremisesextensionattributes.md | 4 + .../resources/onpremisesprovisioningerror.md | 3 + .../openidconnectidentityprovider.md | 3 + .../beta/resources/openidconnectprovider.md | 3 + .../beta/resources/operationerror.md | 5 +- .../beta/resources/optionalclaims.md | 3 + .../beta/resources/organizermeetinginfo.md | 3 + .../beta/resources/outgoingcalloptions.md | 3 + .../beta/resources/outlookcategory.md | 3 + .../beta/resources/outofofficesettings.md | 3 + api-reference/beta/resources/package.md | 16 +- .../beta/resources/parentalcontrolsettings.md | 3 + .../beta/resources/participantinfo.md | 3 + .../participantjoiningnotification.md | 3 + .../resources/participantjoiningresponse.md | 8 +- .../resources/participantleftnotification.md | 3 + ...rtner-security-additionaldatadictionary.md | 3 + .../beta/resources/passwordprofile.md | 3 + .../beta/resources/patchcontentcommand.md | 19 +- api-reference/beta/resources/permission.md | 107 ++++++----- .../resources/permissiongrantconditionset.md | 3 + .../beta/resources/permissionscope.md | 3 + .../beta/resources/personOrGroupColumn.md | 34 ++-- .../beta/resources/persondatasource.md | 12 +- .../beta/resources/physicalofficeaddress.md | 3 + .../resources/pkcs12CertificateInformation.md | 3 + .../beta/resources/pkcs12certificate.md | 3 + .../resources/preauthorizedapplication.md | 3 + .../beta/resources/presencestatusmessage.md | 3 + .../beta/resources/printconnector.md | 3 + api-reference/beta/resources/printdocument.md | 3 + .../beta/resources/printercreateoperation.md | 3 + api-reference/beta/resources/printidentity.md | 3 + .../beta/resources/printoperation.md | 3 + .../beta/resources/printpagerange.md | 3 + .../beta/resources/printserviceendpoint.md | 3 + .../beta/resources/printusagebyprinter.md | 3 + .../beta/resources/printusagebyuser.md | 3 + .../beta/resources/printuseridentity.md | 3 + .../beta/resources/privacyprofile.md | 3 + api-reference/beta/resources/process.md | 3 + .../beta/resources/profilesourceannotation.md | 3 + .../beta/resources/programresource.md | 3 + .../beta/resources/projectrome-imageinfo.md | 3 + .../beta/resources/projectrome-visualinfo.md | 3 + api-reference/beta/resources/prompt.md | 3 + .../beta/resources/provisionedplan.md | 3 + .../beta/resources/publicationfacet.md | 21 ++- .../beta/resources/publicclientapplication.md | 3 + api-reference/beta/resources/quota.md | 45 ++--- .../beta/resources/rankedemailaddress.md | 3 + .../beta/resources/recentnotebook.md | 3 + api-reference/beta/resources/recipient.md | 3 + api-reference/beta/resources/recordinginfo.md | 3 + .../beta/resources/recyclebinitem.md | 3 + .../beta/resources/redirecturisettings.md | 3 + .../resources/regionalandlanguagesettings.md | 3 + .../beta/resources/regionalformatoverrides.md | 3 + .../beta/resources/registrykeystate.md | 3 + .../beta/resources/rejectjoinresponse.md | 3 + api-reference/beta/resources/reminder.md | 3 + api-reference/beta/resources/remoteitem.md | 50 ++--- api-reference/beta/resources/removedstate.md | 3 + api-reference/beta/resources/renameaction.md | 17 +- .../beta/resources/requiredresourceaccess.md | 3 + .../beta/resources/resourceaccess.md | 3 + .../resourcespecificpermissiongrant.md | 3 + .../beta/resources/responsestatus.md | 3 + api-reference/beta/resources/restoreaction.md | 19 +- .../resources/restoresessionartifactcount.md | 3 + api-reference/beta/resources/resultinfo.md | 3 + .../beta/resources/retentionlabelsettings.md | 3 + api-reference/beta/resources/riskdetection.md | 3 + .../resources/riskserviceprincipalactivity.md | 3 + .../beta/resources/riskuseractivity.md | 3 + .../riskyserviceprincipalhistoryitem.md | 3 + api-reference/beta/resources/root.md | 11 +- .../resources/samlsinglesignonsettings.md | 3 + .../beta/resources/scheduleinformation.md | 3 + api-reference/beta/resources/scheduleitem.md | 3 + .../beta/resources/schedulinggroup.md | 3 + .../beta/resources/schemaextension.md | 3 + api-reference/beta/resources/searchresult.md | 15 +- api-reference/beta/resources/sectiongroup.md | 61 +++--- .../security-ediscoveryexportfilemetadata.md | 3 + .../resources/security-huntingqueryresults.md | 3 + .../resources/security-huntingrowresult.md | 5 + .../security-singlepropertyschema.md | 3 + .../beta/resources/securityactionstate.md | 3 + .../beta/resources/securityresource.md | 3 + .../resources/securityvendorinformation.md | 3 + .../beta/resources/selfsignedcertificate.md | 3 + .../resources/servicehostedmediaconfig.md | 3 + .../beta/resources/serviceplaninfo.md | 3 + .../serviceprincipallockconfiguration.md | 3 + .../resources/serviceprovisioningerror.md | 3 + .../resources/serviceprovisioningxmlerror.md | 3 + .../beta/resources/settingtemplatevalue.md | 3 + api-reference/beta/resources/settingvalue.md | 3 + api-reference/beta/resources/shareaction.md | 19 +- api-reference/beta/resources/shared.md | 3 + .../beta/resources/sharepointidentity.md | 3 + .../beta/resources/sharepointidentityset.md | 3 + api-reference/beta/resources/sharepointids.md | 27 +-- .../beta/resources/sharinginvitation.md | 19 +- api-reference/beta/resources/sharinglink.md | 45 ++--- api-reference/beta/resources/shift.md | 3 + .../beta/resources/signinlocation.md | 3 + api-reference/beta/resources/signinstatus.md | 3 + .../beta/resources/sitearchivaldetails.md | 5 +- .../beta/resources/sitecollection.md | 3 + api-reference/beta/resources/sitepagedata.md | 10 +- api-reference/beta/resources/sizerange.md | 3 + .../beta/resources/socialidentityprovider.md | 3 + .../beta/resources/spaapplication.md | 3 + api-reference/beta/resources/specialfolder.md | 4 + .../beta/resources/standardtimezoneoffset.md | 3 + .../beta/resources/startholdmusicoperation.md | 3 + .../beta/resources/stopholdmusicoperation.md | 3 + .../synchronization-attributedefinition.md | 3 + ...zation-attributedefinitionmetadataentry.md | 3 + .../synchronization-attributemapping.md | 3 + ...nization-attributemappingfunctionschema.md | 3 + ...ization-attributemappingparameterschema.md | 3 + .../synchronization-attributemappingsource.md | 3 + .../synchronization-directorydefinition.md | 3 + .../synchronization-expressioninputobject.md | 3 + .../beta/resources/synchronization-filter.md | 3 + .../resources/synchronization-filterclause.md | 3 + .../resources/synchronization-filtergroup.md | 3 + .../synchronization-filteroperand.md | 3 + .../synchronization-filteroperatorschema.md | 3 + .../synchronization-objectdefinition.md | 3 + ...onization-objectdefinitionmetadataentry.md | 3 + .../synchronization-objectmapping.md | 3 + ...chronization-objectmappingmetadataentry.md | 3 + ...synchronization-parseexpressionresponse.md | 3 + .../synchronization-referencedobject.md | 3 + ...tringkeyattributemappingsourcevaluepair.md | 3 + .../synchronization-stringkeylongvaluepair.md | 3 + ...ynchronization-stringkeyobjectvaluepair.md | 3 + ...ynchronization-stringkeystringvaluepair.md | 3 + .../synchronization-synchronizationerror.md | 3 + ...ation-synchronizationjobrestartcriteria.md | 3 + ...ronization-synchronizationmetadataentry.md | 3 + ...synchronization-synchronizationprogress.md | 3 + ...nchronization-synchronizationquarantine.md | 3 + .../synchronization-synchronizationrule.md | 3 + ...synchronization-synchronizationschedule.md | 3 + ...synchronizationsecretkeystringvaluepair.md | 3 + .../synchronization-synchronizationstatus.md | 3 + ...ronization-synchronizationtaskexecution.md | 3 + api-reference/beta/resources/systemfacet.md | 11 +- .../resources/tabupdatedeventmessagedetail.md | 3 + .../beta/resources/targetresource.md | 3 + .../teamarchivedeventmessagedetail.md | 3 + .../beta/resources/teamclasssettings.md | 3 + .../teamcreatedeventmessagedetail.md | 3 + ...eamdescriptionupdatedeventmessagedetail.md | 3 + .../beta/resources/teamdiscoverysettings.md | 3 + .../beta/resources/teamfunsettings.md | 3 + .../beta/resources/teamguestsettings.md | 3 + api-reference/beta/resources/teaminfo.md | 3 + .../teamjoiningdisabledeventmessagedetail.md | 4 + .../teamjoiningenabledeventmessagedetail.md | 3 + .../beta/resources/teammembersettings.md | 3 + .../beta/resources/teammessagingsettings.md | 3 + .../teamrenamedeventmessagedetail.md | 3 + .../teamsappinstalledeventmessagedetail.md | 3 + .../teamsappremovedeventmessagedetail.md | 3 + .../teamsappupgradedeventmessagedetail.md | 3 + .../beta/resources/teamsasyncoperation.md | 3 + .../beta/resources/teamstabconfiguration.md | 3 + api-reference/beta/resources/teamstemplate.md | 3 + api-reference/beta/resources/teamsummary.md | 3 + .../teamunarchivedeventmessagedetail.md | 3 + .../beta/resources/teamworkconnection.md | 3 + .../beta/resources/teamworkdeviceactivity.md | 3 + .../resources/teamworkdeviceconfiguration.md | 3 + .../beta/resources/teamworkdevicehealth.md | 3 + .../beta/resources/teamworkdeviceoperation.md | 3 + .../teamworkdevicesoftwareversions.md | 3 + .../resources/teamworkdisplayconfiguration.md | 3 + .../teamworkfeaturesconfiguration.md | 3 + .../beta/resources/teamworkhardwaredetail.md | 3 + .../beta/resources/teamworkhardwarehealth.md | 3 + .../beta/resources/teamworkloginstatus.md | 3 + .../resources/teamworknetworkconfiguration.md | 3 + ...workonpremisescalendarsyncconfiguration.md | 3 + .../beta/resources/teamworkperipheral.md | 3 + .../resources/teamworkperipheralshealth.md | 3 + .../resources/teamworksoftwareupdatehealth.md | 3 + .../resources/teamworksoftwareupdatestatus.md | 3 + .../resources/teamworksystemconfiguration.md | 3 + .../teamworkteamsclientconfiguration.md | 3 + api-reference/beta/resources/textColumn.md | 23 ++- api-reference/beta/resources/thumbnail.md | 3 + .../beta/resources/thumbnailcolumn.md | 3 + api-reference/beta/resources/thumbnailset.md | 3 + .../beta/resources/timeconstraint.md | 15 +- api-reference/beta/resources/timeoff.md | 3 + api-reference/beta/resources/timeoffreason.md | 3 + api-reference/beta/resources/timestamp.md | 3 + api-reference/beta/resources/timezonebase.md | 3 + .../beta/resources/timezoneinformation.md | 3 + .../beta/resources/tokenmeetinginfo.md | 3 + api-reference/beta/resources/toneinfo.md | 3 + .../resources/translationlanguageoverride.md | 3 + .../beta/resources/translationpreferences.md | 3 + .../beta/resources/trustframeworkpolicy.md | 3 + .../beta/resources/typedemailaddress.md | 3 + .../beta/resources/userinsightssettings.md | 3 + .../beta/resources/usersecuritystate.md | 3 + .../beta/resources/verifieddomain.md | 3 + .../beta/resources/verifiedpublisher.md | 3 + api-reference/beta/resources/versionaction.md | 15 +- api-reference/beta/resources/video.md | 37 ++-- .../virtualeventexternalinformation.md | 3 + ...ualeventexternalregistrationinformation.md | 3 + .../beta/resources/virtualeventpresenter.md | 3 + .../resources/virtualeventpresenterdetails.md | 3 + .../resources/virtualeventregistration.md | 3 + .../virtualeventregistrationcustomquestion.md | 3 + ...tualeventregistrationpredefinedquestion.md | 3 + .../virtualeventregistrationquestionanswer.md | 3 + .../virtualeventregistrationquestionbase.md | 3 + .../beta/resources/vulnerabilitystate.md | 3 + .../resources/watermarkprotectionvalues.md | 3 + .../beta/resources/webapplication.md | 3 + api-reference/beta/resources/website.md | 3 + .../beta/resources/windowsapplication.md | 3 + .../beta/resources/workbookfiltercriteria.md | 3 + .../beta/resources/workbooksessioninfo.md | 17 +- .../beta/resources/workbooksortfield.md | 3 + .../workbookworksheetprotectionoptions.md | 3 + api-reference/beta/resources/workinghours.md | 3 + .../resources/workplacesensoreventvalue.md | 4 + 498 files changed, 2334 insertions(+), 838 deletions(-) diff --git a/api-reference/beta/resources/aaduserconversationmember.md b/api-reference/beta/resources/aaduserconversationmember.md index ab31fdb4c73..e758a07fa5a 100644 --- a/api-reference/beta/resources/aaduserconversationmember.md +++ b/api-reference/beta/resources/aaduserconversationmember.md @@ -51,6 +51,9 @@ Inherits from [conversationMember](conversationmember.md). |userId| String | The GUID of the user. | |visibleHistoryStartDateTime| DateTimeOffset | The timestamp that denotes how far back the history of a conversation is shared with the conversation member. This property is settable only for members of a chat.| +## Relationships +None. + ## JSON representation The following JSON representation shows the resource type. diff --git a/api-reference/beta/resources/aaduserconversationmemberresult.md b/api-reference/beta/resources/aaduserconversationmemberresult.md index d74aa5320f8..9d8f80b024a 100644 --- a/api-reference/beta/resources/aaduserconversationmemberresult.md +++ b/api-reference/beta/resources/aaduserconversationmemberresult.md @@ -25,6 +25,9 @@ Inherits from [actionResultPart](actionresultpart.md). |error|[publicError](publicerror.md) |The error that occurred, if any, during the course of the bulk operation.| |userId|String|The user object ID of the Microsoft Entra user that was being added as part of the bulk operation.| +## Relationships +None. + ## JSON representation The following JSON representation shows the resource type. diff --git a/api-reference/beta/resources/acceptjoinresponse.md b/api-reference/beta/resources/acceptjoinresponse.md index 8852763138f..605edf79fd7 100644 --- a/api-reference/beta/resources/acceptjoinresponse.md +++ b/api-reference/beta/resources/acceptjoinresponse.md @@ -20,6 +20,9 @@ Represents a response to accept a participant who tries to join the meeting. None. +## Relationships +None. + ## JSON representation The following JSON representation shows the resource type. diff --git a/api-reference/beta/resources/accessaction.md b/api-reference/beta/resources/accessaction.md index 525ee62898c..c67a66d1cc3 100644 --- a/api-reference/beta/resources/accessaction.md +++ b/api-reference/beta/resources/accessaction.md @@ -23,6 +23,9 @@ The presence of the **accessAction** resource on an [**itemActivity**][activity] This resource type has no properties. +## Relationships +None. + ## JSON representation diff --git a/api-reference/beta/resources/alerthistorystate.md b/api-reference/beta/resources/alerthistorystate.md index 44d64d165d0..4ded33b0494 100644 --- a/api-reference/beta/resources/alerthistorystate.md +++ b/api-reference/beta/resources/alerthistorystate.md @@ -28,6 +28,9 @@ Stores changes made to alerts. |updatedDateTime|DateTimeOffset| Date and time of the alert update. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`| |user|String| UPN of the signed-in user that updated the alert (taken from the bearer token - if in user/delegated auth mode). | +## Relationships +None. + ## JSON representation The following JSON representation shows the resource type. diff --git a/api-reference/beta/resources/alerttrigger.md b/api-reference/beta/resources/alerttrigger.md index cbc265f4073..6f4244d9299 100644 --- a/api-reference/beta/resources/alerttrigger.md +++ b/api-reference/beta/resources/alerttrigger.md @@ -24,6 +24,9 @@ Contains information about the properties that triggered a detection (properties |type|String|Type of the property in the key:value pair for interpretation. For example, String, Boolean etc.| |value|String|Value of the property serving as a detection trigger.| +## Relationships +None. + ## JSON representation The following JSON representation shows the resource type. diff --git a/api-reference/beta/resources/alternativesecurityid.md b/api-reference/beta/resources/alternativesecurityid.md index 68a53bf7218..f429c0fc622 100644 --- a/api-reference/beta/resources/alternativesecurityid.md +++ b/api-reference/beta/resources/alternativesecurityid.md @@ -22,6 +22,9 @@ For internal use only. This complex type will be deprecated in the future. | key | Edm.Binary | For internal use only.| | type | Int32 | For internal use only.| +## Relationships +None. + ## JSON representation The following JSON representation shows the resource type. diff --git a/api-reference/beta/resources/apiapplication.md b/api-reference/beta/resources/apiapplication.md index 15f572b467c..ba27436cd50 100644 --- a/api-reference/beta/resources/apiapplication.md +++ b/api-reference/beta/resources/apiapplication.md @@ -26,6 +26,9 @@ Specifies settings for an [application](application.md) that implements a web AP |preAuthorizedApplications| [preAuthorizedApplication](preauthorizedapplication.md) collection | Lists the client applications that are preauthorized with the specified delegated permissions to access this application's APIs. Users aren't required to consent to any preauthorized application (for the permissions specified). However, any other permissions not listed in preAuthorizedApplications (requested through incremental consent for example) will require user consent. | |requestedAccessTokenVersion| Int32 | Specifies the access token version expected by this resource. This changes the version and format of the JWT produced independent of the endpoint or client used to request the access token.

The endpoint used, v1.0 or v2.0, is chosen by the client and only impacts the version of id_tokens. Resources need to explicitly configure **requestedAccessTokenVersion** to indicate the supported access token format.

Possible values for **requestedAccessTokenVersion** are `1`, `2`, or `null`. If the value is `null`, this defaults to `1`, which corresponds to the v1.0 endpoint.

If **signInAudience** on the application is configured as `AzureADandPersonalMicrosoftAccount` or `PersonalMicrosoftAccount`, the value for this property must be `2`. | +## Relationships +None. + ## JSON representation The following JSON representation shows the resource type. diff --git a/api-reference/beta/resources/apphostedmediaconfig.md b/api-reference/beta/resources/apphostedmediaconfig.md index 5939b96130b..6702c8cb999 100644 --- a/api-reference/beta/resources/apphostedmediaconfig.md +++ b/api-reference/beta/resources/apphostedmediaconfig.md @@ -23,6 +23,9 @@ Media stack hosted by the application. | blob | String | The media configuration blob generated by smart media agent. | | removeFromDefaultAudioGroup | Boolean | Remove audio from the default audio group | +## Relationships +None. + ## JSON representation The following JSON representation shows the resource type. diff --git a/api-reference/beta/resources/applemanagedidentityprovider.md b/api-reference/beta/resources/applemanagedidentityprovider.md index 4d9f7898115..0be651548c9 100644 --- a/api-reference/beta/resources/applemanagedidentityprovider.md +++ b/api-reference/beta/resources/applemanagedidentityprovider.md @@ -36,6 +36,9 @@ For the list of API operations for managing Apple-managed identity providers, se Retrieve the **developerId**, **serviceId**, **keyId**, and the **certificateData** from the Apple developer portal. For more information, follow the guide to [create an Apple ID application](/azure/active-directory-b2c/identity-provider-apple-id?pivots=b2c-user-flow#create-an-apple-id-application). +## Relationships +None. + ## JSON representation The following JSON representation shows the resource type. diff --git a/api-reference/beta/resources/appliedconditionalaccesspolicy.md b/api-reference/beta/resources/appliedconditionalaccesspolicy.md index f9fdd7d2053..5037b2bff54 100644 --- a/api-reference/beta/resources/appliedconditionalaccesspolicy.md +++ b/api-reference/beta/resources/appliedconditionalaccesspolicy.md @@ -37,6 +37,9 @@ The data in this object is returned only for callers with privileges to read con +## Relationships +None. + ## JSON representation The following JSON representation shows the resource type. diff --git a/api-reference/beta/resources/approle.md b/api-reference/beta/resources/approle.md index b19d2c81f50..1d98c331337 100644 --- a/api-reference/beta/resources/approle.md +++ b/api-reference/beta/resources/approle.md @@ -32,6 +32,9 @@ With [appRoleAssignments](approleassignment.md), app roles can be assigned to us |origin|String| Specifies if the app role is defined on the [application](application.md) object or on the [servicePrincipal](serviceprincipal.md) entity. Must _not_ be included in any POST or PATCH requests. Read-only. | |value|String|Specifies the value to include in the `roles` claim in ID tokens and access tokens authenticating an assigned user or service principal. Must not exceed 120 characters in length. Allowed characters are `:` `!` `#` `$` `%` `&` `'` `(` `)` `*` `+` `,` `-` `.` `/` `:` `;` < `=` > `?` `@` `[` `]` `^` `+` `_` ` `{` | `}` `~`, and characters in the ranges `0-9`, `A-Z` and `a-z`. Any other character, including the space character, aren't allowed. May not begin with `.`. | +## Relationships +None. + ## JSON representation The following JSON representation shows the resource type. diff --git a/api-reference/beta/resources/approleassignment.md b/api-reference/beta/resources/approleassignment.md index 7603291d366..1eb6c10c9e6 100644 --- a/api-reference/beta/resources/approleassignment.md +++ b/api-reference/beta/resources/approleassignment.md @@ -54,6 +54,9 @@ An app role assignment where the assigned principal is a service principal is an | resourceDisplayName | String | The display name of the resource app's service principal to which the assignment is made. Maximum length is 256 characters. | | appRoleId | Guid | The identifier (**id**) for the [app role](approle.md) that is assigned to the principal. This app role must be exposed in the **appRoles** property on the resource application's service principal (**resourceId**). If the resource application hasn't declared any app roles, a default app role ID of `00000000-0000-0000-0000-000000000000` can be specified to signal that the principal is assigned to the resource app without any specific app roles. Required on create. | +## Relationships +None. + ## JSON representation The following JSON representation shows the resource type. diff --git a/api-reference/beta/resources/assignedlabel.md b/api-reference/beta/resources/assignedlabel.md index 152a5f0b9ec..f8df649adfd 100644 --- a/api-reference/beta/resources/assignedlabel.md +++ b/api-reference/beta/resources/assignedlabel.md @@ -24,6 +24,9 @@ Represents a sensitivity label assigned to a Microsoft 365 group. Sensitivity la | labelId | String | The unique identifier of the label. | | displayName | String | The display name of the label. Read-only. | +## Relationships +None. + ## JSON representation The following JSON representation shows the resource type. diff --git a/api-reference/beta/resources/assignedlicense.md b/api-reference/beta/resources/assignedlicense.md index 845fef90503..a3fda05c6ce 100644 --- a/api-reference/beta/resources/assignedlicense.md +++ b/api-reference/beta/resources/assignedlicense.md @@ -22,6 +22,9 @@ Represents a license assigned to a user or group. The **assignedLicenses** prope |disabledPlans|Guid collection|A collection of the unique identifiers for plans that have been disabled. IDs are available in **servicePlans** > **servicePlanId** in the tenant's [subscribedSkus](../resources/subscribedsku.md) or **serviceStatus** > **servicePlanId** in the tenant's [companySubscription](../resources/subscribedsku.md). | |skuId|Guid|The unique identifier for the SKU. Corresponds to the **skuId** from [subscribedSkus](../resources/subscribedsku.md) or [companySubscription](../resources/companysubscription.md).| +## Relationships +None. + ## JSON representation The following JSON representation shows the resource type. diff --git a/api-reference/beta/resources/assignedplan.md b/api-reference/beta/resources/assignedplan.md index a2f164d040d..366e26ab5b3 100644 --- a/api-reference/beta/resources/assignedplan.md +++ b/api-reference/beta/resources/assignedplan.md @@ -39,6 +39,9 @@ The following table describes the possible statuses for the **capabilityStatus** | LockedOut | Unavailable for all administrators and users for assignment but any data associated with the capability must be preserved. This is the state after `Suspended` and if the license isn't renewed, it is the final state before the plan is `Deleted`. | | Deleted | Unavailable and any data associated with the capability may be deleted. | +## Relationships +None. + ## JSON representation The following JSON representation shows the resource type. diff --git a/api-reference/beta/resources/associatedteaminfo.md b/api-reference/beta/resources/associatedteaminfo.md index 488ed99746f..99de630fea8 100644 --- a/api-reference/beta/resources/associatedteaminfo.md +++ b/api-reference/beta/resources/associatedteaminfo.md @@ -37,6 +37,9 @@ Inherits from [teamInfo](../resources/teaminfo.md). |tenantId|String|The ID of the Microsoft Entra tenant. Inherited from [teamInfo](../resources/teaminfo.md).| +## Relationships +None. + ## JSON representation The following JSON representation shows the resource type. @@ -31,13 +41,6 @@ The following API calls return **asyncJobStatus** resources: } ``` -## Properties - -| Property name | Type | Description | -|:-----------------------|:-------|:-------------------------------------------------------------------------------------------| -| **percentageComplete** | Double | A value between 0 and 100 that indicates the percentage complete. | -| **status** | String | A string value that maps to an enumeration of possible values about the status of the job. | - diff --git a/api-reference/beta/resources/attendeebase.md b/api-reference/beta/resources/attendeebase.md index 14467a0e8b2..7a385db8090 100644 --- a/api-reference/beta/resources/attendeebase.md +++ b/api-reference/beta/resources/attendeebase.md @@ -18,6 +18,15 @@ The type of attendee. Derived from [recipient](recipient.md). +## Properties +| Property | Type |Description| +|:---------------|:--------|:----------| +|type|String| The type of attendee. Possible values are: `required`, `optional`, `resource`. Currently if the attendee is a person, [findMeetingTimes](../api/user-findmeetingtimes.md) always considers the person is of the `Required` type.| +|emailAddress|[emailAddress](emailaddress.md)|Includes the name and SMTP address of the attendee.| + +## Relationships +None. + ## JSON representation The following JSON representation shows the resource type. @@ -37,11 +46,6 @@ The following JSON representation shows the resource type. } ``` -## Properties -| Property | Type |Description| -|:---------------|:--------|:----------| -|type|String| The type of attendee. Possible values are: `required`, `optional`, `resource`. Currently if the attendee is a person, [findMeetingTimes](../api/user-findmeetingtimes.md) always considers the person is of the `Required` type.| -|emailAddress|[emailAddress](emailaddress.md)|Includes the name and SMTP address of the attendee.| diff --git a/api-reference/beta/resources/audio.md b/api-reference/beta/resources/audio.md index 95fcc3f58c8..e2f31fa9265 100644 --- a/api-reference/beta/resources/audio.md +++ b/api-reference/beta/resources/audio.md @@ -21,6 +21,32 @@ The properties of the **Audio** resource are populated by extracting metadata fr The **Audio** resource is only supported on OneDrive Personal. +## Properties + +| Property | Type | Description | +| :-------------------- | :------ | :------------------------------------------------------------------- | +| **album** | string | The title of the album for this audio file. | +| **albumArtist** | string | The artist named on the album for the audio file. | +| **artist** | string | The performing artist for the audio file. | +| **bitrate** | Int32 | Bitrate expressed in kbps. | +| **composers** | string | The name of the composer of the audio file. | +| **copyright** | string | Copyright information for the audio file. | +| **disc** | Int32 | The number of the disc this audio file came from. | +| **discCount** | Int32 | The total number of discs in this album. | +| **duration** | Int64 | Duration of the audio file, expressed in milliseconds | +| **genre** | string | The genre of this audio file. | +| **hasDrm** | Boolean | Indicates if the file is protected with digital rights management. | +| **isVariableBitrate** | Boolean | Indicates if the file is encoded with a variable bitrate. | +| **title** | string | The title of the audio file. | +| **track** | Int32 | The number of the track on the original disc for this audio file. | +| **trackCount** | Int32 | The total number of tracks on the original disc for this audio file. | +| **year** | Int32 | The year the audio file was recorded. | + +[item-resource]: ../resources/driveitem.md + +## Relationships +None. + ## JSON representation @@ -46,29 +72,6 @@ The **Audio** resource is only supported on OneDrive Personal. } ``` -## Properties - -| Property | Type | Description | -| :-------------------- | :------ | :------------------------------------------------------------------- | -| **album** | string | The title of the album for this audio file. | -| **albumArtist** | string | The artist named on the album for the audio file. | -| **artist** | string | The performing artist for the audio file. | -| **bitrate** | Int32 | Bitrate expressed in kbps. | -| **composers** | string | The name of the composer of the audio file. | -| **copyright** | string | Copyright information for the audio file. | -| **disc** | Int32 | The number of the disc this audio file came from. | -| **discCount** | Int32 | The total number of discs in this album. | -| **duration** | Int64 | Duration of the audio file, expressed in milliseconds | -| **genre** | string | The genre of this audio file. | -| **hasDrm** | Boolean | Indicates if the file is protected with digital rights management. | -| **isVariableBitrate** | Boolean | Indicates if the file is encoded with a variable bitrate. | -| **title** | string | The title of the audio file. | -| **track** | Int32 | The number of the track on the original disc for this audio file. | -| **trackCount** | Int32 | The total number of tracks on the original disc for this audio file. | -| **year** | Int32 | The year the audio file was recorded. | - -[item-resource]: ../resources/driveitem.md - ## Remarks For more information about the facets on a DriveItem, see [DriveItem](driveitem.md). diff --git a/api-reference/beta/resources/audioconferencing.md b/api-reference/beta/resources/audioconferencing.md index 75de3d864a4..efaa25c9f19 100644 --- a/api-reference/beta/resources/audioconferencing.md +++ b/api-reference/beta/resources/audioconferencing.md @@ -32,6 +32,9 @@ Represents phone access information for an [onlineMeeting](onlinemeeting.md). >- The **tollFreeNumber** and **tollNumber** properties are deprecated. Use the **tollFreeNumbers** and **tollNumbers** properties instead. >- For backward compatibility, the original **tollFreeNumber** is added to the new **tollFreeNumbers** collection and the original **tollNumber** is added to the new **tollNumbers** collection. +## Relationships +None. + ## JSON representation The following JSON representation shows the resource type. diff --git a/api-reference/beta/resources/auditactivityinitiator.md b/api-reference/beta/resources/auditactivityinitiator.md index d8c56134ba7..8aa00b1b349 100644 --- a/api-reference/beta/resources/auditactivityinitiator.md +++ b/api-reference/beta/resources/auditactivityinitiator.md @@ -21,6 +21,9 @@ Identity the resource object that initiates the activity. The initiator can be a |app|[appIdentity](appidentity.md)|If the actor initiating the activity is an app, this property indicates all its identification information including appId, displayName, servicePrincipalId, and servicePrincipalName.| |user|[auditUserIdentity](auditUserIdentity.md)|If the actor initiating the activity is a user, this property indicates their identification information including their id, displayName, and userPrincipalName.| +## Relationships +None. + ## JSON representation The following JSON representation shows the resource type. diff --git a/api-reference/beta/resources/automaticrepliesmailtips.md b/api-reference/beta/resources/automaticrepliesmailtips.md index 276d7d94e2b..2a7a7d1b135 100644 --- a/api-reference/beta/resources/automaticrepliesmailtips.md +++ b/api-reference/beta/resources/automaticrepliesmailtips.md @@ -24,6 +24,9 @@ Namespace: microsoft.graph | scheduledEndTime | [dateTimeTimeZone](../resources/datetimetimezone.md) | The date and time that automatic replies are set to end. | | scheduledStartTime | [dateTimeTimeZone](../resources/datetimetimezone.md) | The date and time that automatic replies are set to begin. | +## Relationships +None. + ## JSON representation The following JSON representation shows the resource type. diff --git a/api-reference/beta/resources/automaticrepliessetting.md b/api-reference/beta/resources/automaticrepliessetting.md index a79e1b7577f..713207ffdf4 100644 --- a/api-reference/beta/resources/automaticrepliessetting.md +++ b/api-reference/beta/resources/automaticrepliessetting.md @@ -29,6 +29,9 @@ respond to emails. |scheduledStartDateTime|[dateTimeTimeZone](datetimetimezone.md)|The date and time that automatic replies are set to begin, if **Status** is set to `Scheduled`.| |status|automaticRepliesStatus|Configurations status for automatic replies. Possible values are: `disabled`, `alwaysEnabled`, `scheduled`.| +## Relationships +None. + ## JSON representation The following JSON representation shows the resource type. diff --git a/api-reference/beta/resources/autoreviewsettings.md b/api-reference/beta/resources/autoreviewsettings.md index f81f84413ca..a5966984a3e 100644 --- a/api-reference/beta/resources/autoreviewsettings.md +++ b/api-reference/beta/resources/autoreviewsettings.md @@ -24,6 +24,9 @@ The **autoReviewSettings** resource type is used in the [accessReviewSettings](a | :------- | :--- | :---------- | | notReviewedResult | String | Possible values: `Approve`, `Deny`, or `Recommendation`. If `Recommendation`, then **accessRecommendationsEnabled** in the **accessReviewSettings** resource should also be set to `true`. If you want to have the system provide a decision even if the reviewer does not make a choice, set the **autoReviewEnabled** property in the **accessReviewSettings** resource to `true` and include an **autoReviewSettings** object with the **notReviewedResult** property. Then, when a review completes, based on the **notReviewedResult** property, the decision is recorded as either `Approve` or `Deny`.| +## Relationships +None. + ## JSON representation diff --git a/api-reference/beta/resources/callendedeventmessagedetail.md b/api-reference/beta/resources/callendedeventmessagedetail.md index 3d30a5bb70e..22931fd7a5a 100644 --- a/api-reference/beta/resources/callendedeventmessagedetail.md +++ b/api-reference/beta/resources/callendedeventmessagedetail.md @@ -29,6 +29,9 @@ Inherits from [eventMessageDetail](../resources/eventmessagedetail.md). |callParticipants|[callParticipantInfo](../resources/callparticipantinfo.md) collection|List of call participants.| |initiator|[identitySet](../resources/identityset.md)|Initiator of the event.| +## Relationships +None. + ## JSON representation The following JSON representation shows the resource type. - -```json -{ - "displayAs": "default | friendly | standard", - "format": "dateOnly | dateTime" -} -``` - ## Properties | Property | Type | Description | @@ -36,7 +23,7 @@ Here's a JSON representation of a **dateTimeColumn** resource. | **displayAs** | string | How the value should be presented in the UX. Must be one of `default`, `friendly`, or `standard`. See below for more details. If unspecified, treated as `default`. | | **format** | string | Indicates whether the value should be presented as a date only or a date and time. Must be one of `dateOnly` or `dateTime` | -## DisplayAs values +### DisplayAs values | Value | Description | | :----------- | :------------------------------------------------------------------ | @@ -44,6 +31,22 @@ Here's a JSON representation of a **dateTimeColumn** resource. | **friendly** | Uses a friendly relative representation (for example "today at 3:00 PM") | | **standard** | Uses the standard absolute representation (for example "5/10/2017 3:20 PM") | +## Relationships +None. + +## JSON representation + +Here's a JSON representation of a **dateTimeColumn** resource. + + + +```json +{ + "displayAs": "default | friendly | standard", + "format": "dateOnly | dateTime" +} +``` + - -```json -{ - "Author": "Brad Cleaver", - "AuthorLookupId": "13", - "Name": "Kangaroos and Wallabies: A Deep Dive", - "Color": "Red", - "Quantity": 350, -} -``` - ## Properties Each user-visible field in the **listItem** is returned as a name-value pair in the **fieldValueSet**. @@ -50,6 +34,27 @@ GET https://graph.microsoft.com/beta/sites/{site-id}/lists/{list-id}/items?expan You may request up to 12 lookup fields in a single query, plus any number of regular fields. +## Relationships +None. + +## JSON representation + +Here's a JSON representation of a **fieldValueSet** resource. + + +```json +{ + "Author": "Brad Cleaver", + "AuthorLookupId": "13", + "Name": "Kangaroos and Wallabies: A Deep Dive", + "Color": "Red", + "Quantity": 350, +} +``` + + + - -```json -{ - "sortBy": "default | name | type | size | takenOrCreatedDateTime | lastModifiedDateTime | sequence", - "viewType": "default | icons | details | thumbnails", - "sortOrder": "string" -} -``` - ## Properties | Property | Type | Description | @@ -77,6 +65,21 @@ The following values are defined for the **viewType** property. [item-resource]: driveitem.md [folder-facet]: folder.md +## Relationships +None. + +## JSON representation + + + +```json +{ + "sortBy": "default | name | type | size | takenOrCreatedDateTime | lastModifiedDateTime | sequence", + "viewType": "default | icons | details | thumbnails", + "sortOrder": "string" +} +``` + diff --git a/api-reference/beta/resources/followupflag.md b/api-reference/beta/resources/followupflag.md index 9a196d8248a..b0b999e35d5 100644 --- a/api-reference/beta/resources/followupflag.md +++ b/api-reference/beta/resources/followupflag.md @@ -24,6 +24,9 @@ Allows setting a flag for the user to follow up on an item later. Supported item |flagStatus|String|The status for follow-up for an item. Possible values are `notFlagged`, `complete`, and `flagged`.| |startDateTime|**dateTimeTimeZone**|The date and time that the follow-up is to begin.| +## Relationships +None. + ## JSON representation The following JSON representation shows the resource type. diff --git a/api-reference/beta/resources/freebusyerror.md b/api-reference/beta/resources/freebusyerror.md index 1c4b5f4dd7c..09a2fcef3d8 100644 --- a/api-reference/beta/resources/freebusyerror.md +++ b/api-reference/beta/resources/freebusyerror.md @@ -23,6 +23,9 @@ Represents error information from attempting to get the availability of a user, |responseCode |String |The response code from querying for the availability of the user, distribution list, or resource. | +## Relationships +None. + ## JSON representation The following JSON representation shows the resource type. diff --git a/api-reference/beta/resources/genericerror.md b/api-reference/beta/resources/genericerror.md index 7218b118d50..0f4647be6af 100644 --- a/api-reference/beta/resources/genericerror.md +++ b/api-reference/beta/resources/genericerror.md @@ -23,6 +23,9 @@ A general-purpose error. | message | String | The error message. | | code | String | The error code. | +## Relationships +None. + ## JSON representation The following JSON representation shows the resource type. diff --git a/api-reference/beta/resources/geolocationcolumn.md b/api-reference/beta/resources/geolocationcolumn.md index 7f4e2c9b06e..dfb244e6bd7 100644 --- a/api-reference/beta/resources/geolocationcolumn.md +++ b/api-reference/beta/resources/geolocationcolumn.md @@ -15,6 +15,9 @@ Namespace: microsoft.graph The **geolocationColumn** on a [columnDefinition](columndefinition.md) resource indicates that the column holds a geolocation. +## Relationships +None. + ## JSON representation Here is a JSON representation of a **geolocationColumn** resource. diff --git a/api-reference/beta/resources/governancepermission.md b/api-reference/beta/resources/governancepermission.md index b354e86edeb..1bea6e8eebe 100644 --- a/api-reference/beta/resources/governancepermission.md +++ b/api-reference/beta/resources/governancepermission.md @@ -27,6 +27,9 @@ Represents the access permission that a [governanceSubject](../resources/governa |isActive|Boolean|Indicate if the requestor has any active role assignment for the access level.| |isEligible|Boolean|Indicate if the requestor has any eligible role assignment for the access level.| +## Relationships +None. + ## JSON representation The following JSON representation shows the resource type. diff --git a/api-reference/beta/resources/governanceroleassignmentrequeststatus.md b/api-reference/beta/resources/governanceroleassignmentrequeststatus.md index da10e0d4459..2014901e02f 100644 --- a/api-reference/beta/resources/governanceroleassignmentrequeststatus.md +++ b/api-reference/beta/resources/governanceroleassignmentrequeststatus.md @@ -24,6 +24,9 @@ Represents the status of the [governanceRoleAssignmentRequest](../resources/gove | subStatus | String | The sub status of the role assignment request. The values can be `Accepted`, `PendingEvaluation`, `Granted`, `Denied`, `PendingProvisioning`, `Provisioned`, `PendingRevocation`, `Revoked`, `Canceled`, `Failed`, `PendingApprovalProvisioning`, `PendingApproval`, `FailedAsResourceIsLocked`, `PendingAdminDecision`, `AdminApproved`, `AdminDenied`, `TimedOut`, and `ProvisioningStarted`. | | statusDetails | [keyValue](../resources/keyvalue.md) collection | The details of the status of the role assignment request. It represents the evaluation results of different rules. | +## Relationships +None. + ## JSON representation The following JSON representation shows the resource type. diff --git a/api-reference/beta/resources/governancerulesetting.md b/api-reference/beta/resources/governancerulesetting.md index 30c7effdbec..5c0fa9b0748 100644 --- a/api-reference/beta/resources/governancerulesetting.md +++ b/api-reference/beta/resources/governancerulesetting.md @@ -26,6 +26,9 @@ Represents the rules that the role settings are composed of. |ruleIdentifier|String |The id of the rule. For example, ``ExpirationRule`` and ``MfaRule``.| |setting |String |The settings of the rule. The value is a JSON string with a list of pairs in the format of Parameter_Name:Parameter_Value. For example, `{"permanentAssignment":false,"maximumGrantPeriodInMinutes":129600}`| +## Relationships +None. + ## JSON representation The following JSON representation shows the resource type. diff --git a/api-reference/beta/resources/governanceschedule.md b/api-reference/beta/resources/governanceschedule.md index 7471b925332..cc9ee9a7224 100644 --- a/api-reference/beta/resources/governanceschedule.md +++ b/api-reference/beta/resources/governanceschedule.md @@ -29,6 +29,9 @@ Represents the schedule for a [governanceRoleAssignmentRequest](../resources/gov |type|String|The role assignment schedule type. Only `Once` is supported for now. |duration|Duration|The duration of a role assignment. It is in format of a TimeSpan.| +## Relationships +None. + ## JSON representation The following JSON representation shows the resource type. diff --git a/api-reference/beta/resources/hashes.md b/api-reference/beta/resources/hashes.md index a15404e97e3..11de3f90386 100644 --- a/api-reference/beta/resources/hashes.md +++ b/api-reference/beta/resources/hashes.md @@ -29,6 +29,9 @@ Groups available hashes into a single structure for an item. > **Note:** In cases where the hash values are not available, the hash values on an item will be updated after the item is downloaded. +## Relationships +None. + ## JSON representation The following JSON representation shows the resource type. diff --git a/api-reference/beta/resources/hostsecuritystate.md b/api-reference/beta/resources/hostsecuritystate.md index 09fbba592d2..b0e4cc357a2 100644 --- a/api-reference/beta/resources/hostsecuritystate.md +++ b/api-reference/beta/resources/hostsecuritystate.md @@ -30,6 +30,9 @@ Contains stateful information about the host (including devices, computers, and |publicIpAddress|String|Publicly routable IPv4 or IPv6 address (see [RFC 1918](https://tools.ietf.org/html/rfc1918)) at time of the alert.| |riskScore|String|Provider-generated/calculated risk score of the host. Recommended value range of 0-1, which equates to a percentage.| +## Relationships +None. + ## JSON representation The following JSON representation shows the resource type. diff --git a/api-reference/beta/resources/hyperlinkorpicturecolumn.md b/api-reference/beta/resources/hyperlinkorpicturecolumn.md index 552dc80d83c..161a50e18c7 100644 --- a/api-reference/beta/resources/hyperlinkorpicturecolumn.md +++ b/api-reference/beta/resources/hyperlinkorpicturecolumn.md @@ -21,6 +21,9 @@ Indicates that the column contains URL data that can be an achortag or an image | :-------- | :------ | :------------------------------------------------------------------------------------ | | isPicture | Boolean | Specifies whether the display format used for URL columns is an image or a hyperlink. | +## Relationships +None. + ## JSON representation Here's a JSON representation of a **hyperlinkOrPictureColumn** resource. diff --git a/api-reference/beta/resources/identityprovider.md b/api-reference/beta/resources/identityprovider.md index 80978a8bd0e..6309d6818ae 100644 --- a/api-reference/beta/resources/identityprovider.md +++ b/api-reference/beta/resources/identityprovider.md @@ -53,6 +53,9 @@ If it's a custom OpenID Connect identity provider with `OpenIDConnect` as **type Each identity provider has a process for creating an app registration. For example, users create an app registration with Facebook at [developers.facebook.com](https://developers.facebook.com/). The resulting client ID and client secret can be passed to [create identityProvider](../api/identityprovider-post-identityproviders.md). Then, each user object in the directory can be federated to any of the tenant's identity providers for authentication. This enables the user to sign in by entering credentials on the identity provider's sign in page. Microsoft Entra ID validates the token from the identity provider before the tenant issues a token to the application. +## Relationships +None. + ## JSON representation The following JSON representation shows the resource type. The following JSON representation shows the resource type. diff --git a/api-reference/beta/resources/identityproviderbase.md b/api-reference/beta/resources/identityproviderbase.md index de296af1fa0..70cd85dd91f 100644 --- a/api-reference/beta/resources/identityproviderbase.md +++ b/api-reference/beta/resources/identityproviderbase.md @@ -47,6 +47,9 @@ Configuring an identity provider in your external or Azure AD B2C tenant enables |id|String|The identifier of the identity provider.| |displayName|String|The display name of the identity provider.| +## Relationships +None. + ## JSON representation The following JSON representation shows the resource type. diff --git a/api-reference/beta/resources/identityuserflowattribute.md b/api-reference/beta/resources/identityuserflowattribute.md index 889064ffc15..a9935818fa3 100644 --- a/api-reference/beta/resources/identityuserflowattribute.md +++ b/api-reference/beta/resources/identityuserflowattribute.md @@ -40,6 +40,9 @@ Configuring user flow attributes in your Microsoft Entra ID or Azure AD B2C tena |id|String|The identifier of the user flow attribute. Read-only.

Supports `$filter` (`eq`, `ne`). | |userFlowAttributeType|identityUserFlowAttributeType|The type of the user flow attribute. Read-only. Depending on the type of attribute, the values for this property are `builtIn`, `custom`, `required`, `unknownFutureValue`.

Supports `$filter` (`eq`, `ne`). | +## Relationships +None. + ## JSON representation The following JSON representation shows the resource type. diff --git a/api-reference/beta/resources/idlesessionsignout.md b/api-reference/beta/resources/idlesessionsignout.md index 4f7e3fefeb3..1d842bf93f5 100644 --- a/api-reference/beta/resources/idlesessionsignout.md +++ b/api-reference/beta/resources/idlesessionsignout.md @@ -24,6 +24,9 @@ Represents the idle session sign-out policy settings for SharePoint. | signOutAfterInSeconds | Int64 | Number of seconds of inactivity after which a user is signed out. | | warnAfterInSeconds | Int64 | Number of seconds of inactivity after which a user is notified that they'll be signed out.| +## Relationships +None. + ## JSON representation The following JSON representation shows the resource type. diff --git a/api-reference/beta/resources/image.md b/api-reference/beta/resources/image.md index 9bc511404a3..9d381e79d15 100644 --- a/api-reference/beta/resources/image.md +++ b/api-reference/beta/resources/image.md @@ -18,16 +18,6 @@ If a [**DriveItem**](driveitem.md) has a non-null **image** facet, the item repr **Note:** If the service is unable to determine the width and height of the image, the **Image** resource may be empty. -## JSON representation - - -```json -{ - "width": 100, - "height": 200 -} -``` - ## Properties | Property | Type | Description | @@ -41,6 +31,19 @@ In OneDrive for Business, this resource is returned on items that are expected t For more information about the facets on a DriveItem, see [DriveItem](driveitem.md). +## Relationships +None. + +## JSON representation + + +```json +{ + "width": 100, + "height": 200 +} +``` + @@ -26,14 +36,6 @@ The properties within may provide information about why there's incomplete data. "wasThrottled": false } ``` - -## Properties - -| Property | Type | Description -|:--------------------------|:---------------|:-------------------------------- -| missingDataBeforeDateTime | DateTimeOffset | The service doesn't have source data before the specified time. -| wasThrottled | Boolean | Some data wasn't recorded due to excessive activity. - - -```json -{ - "comment": {"@odata.type": "microsoft.graph.commentAction"}, - "create": {"@odata.type": "microsoft.graph.createAction"}, - "delete": {"@odata.type": "microsoft.graph.deleteAction"}, - "edit": {"@odata.type": "microsoft.graph.editAction"}, - "mention": {"@odata.type": "microsoft.graph.mentionAction"}, - "move": {"@odata.type": "microsoft.graph.moveAction"}, - "rename": {"@odata.type": "microsoft.graph.renameAction"}, - "restore": {"@odata.type": "microsoft.graph.restoreAction"}, - "share": {"@odata.type": "microsoft.graph.shareAction"}, - "version": {"@odata.type": "microsoft.graph.versionAction"}, - -} -``` - ## Properties Below are the actions that are available today. @@ -73,6 +47,35 @@ New actions may get logged in the future, so make sure your app is tolerant of h [shareAction]: shareaction.md [versionAction]: versionaction.md +## Relationships +None. + +## JSON representation + + + +```json +{ + "comment": {"@odata.type": "microsoft.graph.commentAction"}, + "create": {"@odata.type": "microsoft.graph.createAction"}, + "delete": {"@odata.type": "microsoft.graph.deleteAction"}, + "edit": {"@odata.type": "microsoft.graph.editAction"}, + "mention": {"@odata.type": "microsoft.graph.mentionAction"}, + "move": {"@odata.type": "microsoft.graph.moveAction"}, + "rename": {"@odata.type": "microsoft.graph.renameAction"}, + "restore": {"@odata.type": "microsoft.graph.restoreAction"}, + "share": {"@odata.type": "microsoft.graph.shareAction"}, + "version": {"@odata.type": "microsoft.graph.versionAction"}, + +} +``` + ## Remarks Item activity records are currently only available on SharePoint and OneDrive for Business. diff --git a/api-reference/beta/resources/itemactionstat.md b/api-reference/beta/resources/itemactionstat.md index d494879c870..188cac41661 100644 --- a/api-reference/beta/resources/itemactionstat.md +++ b/api-reference/beta/resources/itemactionstat.md @@ -15,6 +15,16 @@ Namespace: microsoft.graph The **itemActionStat** resource provides aggregate details about an action over a period of time. +## Properties + +| Property | Type | Description | +|:------------|:------|:-------------------------------------------------------| +| actionCount | Int32 | The number of times the action took place. Read-only. | +| actorCount | Int32 | The number of distinct actors that performed the action. Read-only. | + +## Relationships +None. + ## JSON representation - -```json -{ - "id": "string (identifier)", - "access": "microsoft.graph.accessAction", - "action": {"@odata.type": "microsoft.graph.itemActionSet"}, - "actor": {"@odata.type": "microsoft.graph.identitySet"}, - "driveItem": {"@odata.type": "microsoft.graph.driveItem"}, - "listItem": {"@odata.type": "microsoft.graph.listItem"}, - "location": {"@odata.type": "microsoft.graph.location"}, - "times": {"@odata.type": "microsoft.graph.itemActivityTimeSet"} -} -``` - ## Properties | Property | Type | Description | @@ -65,7 +42,32 @@ Currently only available on SharePoint and OneDrive for Business. [driveItem]: driveitem.md [listItem]: listitem.md -## Actions +## JSON representation + + + +```json +{ + "id": "string (identifier)", + "access": "microsoft.graph.accessAction", + "action": {"@odata.type": "microsoft.graph.itemActionSet"}, + "actor": {"@odata.type": "microsoft.graph.identitySet"}, + "driveItem": {"@odata.type": "microsoft.graph.driveItem"}, + "listItem": {"@odata.type": "microsoft.graph.listItem"}, + "location": {"@odata.type": "microsoft.graph.location"}, + "times": {"@odata.type": "microsoft.graph.itemActivityTimeSet"} +} +``` + +## Remarks + +**ItemActivity** is currently only available on SharePoint and OneDrive for Business. The actions that took place within an activity are detailed in the **action** property. Below are the actions that are available today. @@ -97,10 +99,6 @@ New actions may get logged in the future, so make sure your app is tolerant of h [shareAction]: shareaction.md [versionAction]: versionaction.md -## Remarks - -**ItemActivity** is currently only available on SharePoint and OneDrive for Business. - - -```json -{ - "activities": [{"@odata.type": "microsoft.graph.itemActivity"}], - "incompleteData": {"@odata.type": "microsoft.graph.incompleteData"}, - "isTrending": true, - "startDateTime": "String (timestamp)", - "endDateTime": "String (timestamp)", - "create": {"@odata.type": "microsoft.graph.itemActionStat"}, - "delete": {"@odata.type": "microsoft.graph.itemActionStat"}, - "edit": {"@odata.type": "microsoft.graph.itemActionStat"}, - "move": {"@odata.type": "microsoft.graph.itemActionStat"}, - "access": {"@odata.type": "microsoft.graph.itemActionStat"} -} -``` - ## Properties | Property | Type | Description | @@ -65,6 +41,30 @@ The **itemActivityStat** resource provides information about activities that too [itemActivity]: itemactivity.md +## JSON representation + + + +```json +{ + "activities": [{"@odata.type": "microsoft.graph.itemActivity"}], + "incompleteData": {"@odata.type": "microsoft.graph.incompleteData"}, + "isTrending": true, + "startDateTime": "String (timestamp)", + "endDateTime": "String (timestamp)", + "create": {"@odata.type": "microsoft.graph.itemActionStat"}, + "delete": {"@odata.type": "microsoft.graph.itemActionStat"}, + "edit": {"@odata.type": "microsoft.graph.itemActionStat"}, + "move": {"@odata.type": "microsoft.graph.itemActionStat"}, + "access": {"@odata.type": "microsoft.graph.itemActionStat"} +} +``` + ## Remarks diff --git a/api-reference/beta/resources/locationconstraintitem.md b/api-reference/beta/resources/locationconstraintitem.md index df7df67b7ed..532f65b2818 100644 --- a/api-reference/beta/resources/locationconstraintitem.md +++ b/api-reference/beta/resources/locationconstraintitem.md @@ -18,6 +18,9 @@ The conditions stated by a client for the location of a meeting. Derived from [location](location.md). +## Relationships +None. + ## JSON representation The following JSON representation shows the resource type. diff --git a/api-reference/beta/resources/logonuser.md b/api-reference/beta/resources/logonuser.md index fc0742a443a..d994a24340a 100644 --- a/api-reference/beta/resources/logonuser.md +++ b/api-reference/beta/resources/logonuser.md @@ -26,6 +26,9 @@ Contains stateful information about the logged on user on this host |logonId|String|User logon ID.| |logonTypes|String collection|Collection of the logon types observed for the logged on user from when first to last seen. Possible values are: `unknown`, `interactive`, `remoteInteractive`, `network`, `batch`, `service`.| +## Relationships +None. + ## JSON representation The following JSON representation shows the resource type. diff --git a/api-reference/beta/resources/longrunningoperation.md b/api-reference/beta/resources/longrunningoperation.md index e7f444f4114..dc18bf88ece 100644 --- a/api-reference/beta/resources/longrunningoperation.md +++ b/api-reference/beta/resources/longrunningoperation.md @@ -39,6 +39,9 @@ The following types derive from this object: |status|longRunningOperationStatus|The status of the operation. The possible values are: `notStarted`, `running`, `succeeded`, `failed`, `skipped`, `unknownFutureValue`.| |statusDetail|String|Details about the status of the operation.| +## Relationships +None. + ## JSON representation The following JSON representation shows the resource type. diff --git a/api-reference/beta/resources/lookupColumn.md b/api-reference/beta/resources/lookupColumn.md index ba8d566f58f..a70e95d6c94 100644 --- a/api-reference/beta/resources/lookupColumn.md +++ b/api-reference/beta/resources/lookupColumn.md @@ -16,6 +16,19 @@ Namespace: microsoft.graph The **lookupColumn** on a [columnDefinition](columndefinition.md) resource indicates that the column's values are looked up from another source in the site. +## Properties + +| Property | Type | Description | +| :------------------------ | :------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **allowMultipleValues** | Boolean | Indicates whether multiple values can be selected from the source. | +| **allowUnlimitedLength** | Boolean | Indicates whether values in the column should be able to exceed the standard limit of 255 characters. | +| **columnName** | string | The name of the lookup source column. | +| **listId** | string | The unique identifier of the lookup source list. | +| **primaryLookupColumnId** | string | If specified, this column is a *secondary lookup*, pulling an additional field from the list item looked up by the *primary lookup*. Use the list item looked up by the *primary* as the source for the column named here. | + +## Relationships +None. + ## JSON representation Here is a JSON representation of a **lookupColumn** resource. @@ -32,16 +45,6 @@ Here is a JSON representation of a **lookupColumn** resource. } ``` -## Properties - -| Property | Type | Description | -| :------------------------ | :------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **allowMultipleValues** | Boolean | Indicates whether multiple values can be selected from the source. | -| **allowUnlimitedLength** | Boolean | Indicates whether values in the column should be able to exceed the standard limit of 255 characters. | -| **columnName** | string | The name of the lookup source column. | -| **listId** | string | The unique identifier of the lookup source list. | -| **primaryLookupColumnId** | string | If specified, this column is a *secondary lookup*, pulling an additional field from the list item looked up by the *primary lookup*. Use the list item looked up by the *primary* as the source for the column named here. | - diff --git a/api-reference/beta/resources/membersaddedeventmessagedetail.md b/api-reference/beta/resources/membersaddedeventmessagedetail.md index 1973ecb309b..334763ab2e0 100644 --- a/api-reference/beta/resources/membersaddedeventmessagedetail.md +++ b/api-reference/beta/resources/membersaddedeventmessagedetail.md @@ -31,6 +31,9 @@ Inherits from [eventMessageDetail](../resources/eventmessagedetail.md). |members|[teamworkUserIdentity](../resources/teamworkuseridentity.md) collection|List of members added.| |visibleHistoryStartDateTime|DateTimeOffset|The timestamp denoting how far back a conversation's history is shared with the conversation members.| +## Relationships +None. + ## JSON representation The following JSON representation shows the resource type. diff --git a/api-reference/beta/resources/numberColumn.md b/api-reference/beta/resources/numberColumn.md index 5136c8d43e6..e0026355440 100644 --- a/api-reference/beta/resources/numberColumn.md +++ b/api-reference/beta/resources/numberColumn.md @@ -16,21 +16,6 @@ Namespace: microsoft.graph The **numberColumn** on a [columnDefinition](columndefinition.md) resource indicates that the column's values are numbers. -## JSON representation - -Here is a JSON representation of a **numberColumn** resource. - - - -```json -{ - "decimalPlaces": "automatic | none | one | two | three | four | five", - "displayAs": "number | percentage", - "maximum": 10.551, - "minimum": 99.993 -} -``` - ## Properties | Property | Type | Description | @@ -55,6 +40,24 @@ Here is a JSON representation of a **numberColumn** resource. Note: **decimalPlaces** and **displayAs** apply to how numbers are rendered, not stored. These properties may be updated. +## Relationships +None. + +## JSON representation + +Here is a JSON representation of a **numberColumn** resource. + + + +```json +{ + "decimalPlaces": "automatic | none | one | two | three | four | five", + "displayAs": "number | percentage", + "maximum": 10.551, + "minimum": 99.993 +} +``` + diff --git a/api-reference/beta/resources/onenoteoperation.md b/api-reference/beta/resources/onenoteoperation.md index bc6b2cb6005..a9ffba848e3 100644 --- a/api-reference/beta/resources/onenoteoperation.md +++ b/api-reference/beta/resources/onenoteoperation.md @@ -15,6 +15,26 @@ Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] The status of certain long-running OneNote operations. +## Methods + +| Method | Return Type |Description| +|:---------------|:--------|:----------| +|[Get operation](../api/onenoteoperation-get.md) | [onenoteOperation](onenoteoperation.md) |Get the status of the operation. | + +## Properties +| Property | Type |Description| +|:---------------|:--------|:----------| +|createdDateTime| DateTimeOffset |The start time of the operation.| +|error|[onenoteOperationError](onenoteoperationerror.md)|The error returned by the operation.| +|id|string|The operation id. Read-only.| +|lastActionDateTime| DateTimeOffset |The time of the last action of the operation.| +|resourceId|string|The resource id.| +|resourceLocation|string|The resource URI for the object. For example, the resource URI for a copied page or section. | +|status|operationStatus|The current status of the operation: `NotStarted`, `Running`, `Completed`, `Failed`. | +|percentComplete|string|The operation percent complete if the operation is still in `running` status.| + +## Relationships +None ## JSON representation @@ -41,28 +61,6 @@ The following JSON representation shows the resource type. } ``` -## Properties -| Property | Type |Description| -|:---------------|:--------|:----------| -|createdDateTime| DateTimeOffset |The start time of the operation.| -|error|[onenoteOperationError](onenoteoperationerror.md)|The error returned by the operation.| -|id|string|The operation id. Read-only.| -|lastActionDateTime| DateTimeOffset |The time of the last action of the operation.| -|resourceId|string|The resource id.| -|resourceLocation|string|The resource URI for the object. For example, the resource URI for a copied page or section. | -|status|operationStatus|The current status of the operation: `NotStarted`, `Running`, `Completed`, `Failed`. | -|percentComplete|string|The operation percent complete if the operation is still in `running` status.| - -## Relationships -None - - -## Methods - -| Method | Return Type |Description| -|:---------------|:--------|:----------| -|[Get operation](../api/onenoteoperation-get.md) | [onenoteOperation](onenoteoperation.md) |Get the status of the operation. | - @@ -28,13 +37,6 @@ DriveItems with the **package** facet do not include a **folder** or **file** fa "type": "oneNote" } ``` - -## Properties - -| Property Name | Type | Description | -|:--------------|:-------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **type** | string | An string indicating the type of package. While `oneNote` is the only currently defined value, you should expect other package types to be returned and handle them accordingly. | - ## Remarks For more information about the facets on a DriveItem, see [DriveItem](driveitem.md). diff --git a/api-reference/beta/resources/parentalcontrolsettings.md b/api-reference/beta/resources/parentalcontrolsettings.md index 5617a455110..a29551a4fa5 100644 --- a/api-reference/beta/resources/parentalcontrolsettings.md +++ b/api-reference/beta/resources/parentalcontrolsettings.md @@ -23,6 +23,9 @@ Specifies parental control settings for an application. These settings control t |countriesBlockedForMinors|String collection| Specifies the [two-letter ISO country codes](https://www.iso.org/iso-3166-country-codes.html). Access to the application will be blocked for minors from the countries specified in this list.| |legalAgeGroupRule| String | Specifies the legal age group rule that applies to users of the app. Can be set to one of the following values:
ValueDescription
AllowDefault. Enforces the legal minimum. This means parental consent is required for minors in the European Union and Korea.
RequireConsentForPrivacyServicesEnforces the user to specify date of birth to comply with COPPA rules.
RequireConsentForMinorsRequires parental consent for ages below 18, regardless of country minor rules.
RequireConsentForKidsRequires parental consent for ages below 14, regardless of country minor rules.
BlockMinorsBlocks minors from using the app.
| +## Relationships +None. + ## JSON representation The following JSON representation shows the resource type. diff --git a/api-reference/beta/resources/participantinfo.md b/api-reference/beta/resources/participantinfo.md index 3f227a8cd2e..a8b343c29a1 100644 --- a/api-reference/beta/resources/participantinfo.md +++ b/api-reference/beta/resources/participantinfo.md @@ -29,6 +29,9 @@ Contains additional properties about the participant identity | participantId | String | The participant ID of the participant. Read-only. | +## Relationships +None. + ## JSON representation The following JSON representation shows the resource type. diff --git a/api-reference/beta/resources/participantjoiningnotification.md b/api-reference/beta/resources/participantjoiningnotification.md index cd35103a000..4bb48230b67 100644 --- a/api-reference/beta/resources/participantjoiningnotification.md +++ b/api-reference/beta/resources/participantjoiningnotification.md @@ -25,6 +25,9 @@ A [participantJoiningResponse](participantjoiningResponse.md) in the response pa | -------------- | -------------- | ------------------------------------------- | | call | [call](call.md) | The call object that contains details about the participant joining event. | +## Relationships +None. + ## JSON representation The following JSON representation shows the resource type. diff --git a/api-reference/beta/resources/participantjoiningresponse.md b/api-reference/beta/resources/participantjoiningresponse.md index 8f6244b6415..924f5d56d27 100644 --- a/api-reference/beta/resources/participantjoiningresponse.md +++ b/api-reference/beta/resources/participantjoiningresponse.md @@ -16,7 +16,7 @@ Namespace: microsoft.graph An abstract base class that contains the response to a participant joining notification. -## Derived types +The following table shows the types that inherit from this type. | Type | Description | | :----------------------------------------------------- | :-------------------------------------------------------------------- | @@ -24,6 +24,12 @@ An abstract base class that contains the response to a participant joining notif | [rejectJoinResponse](./rejectjoinresponse.md) | Response to reject participant to the call. | | [inviteNewBotResponse](./invitenewbotresponse.md) | Response to request participant joining notification sent out again as an incoming call notification. | +## Properties +None. + +## Relationships +None. + ## JSON representation The following JSON representation shows the resource type. diff --git a/api-reference/beta/resources/participantleftnotification.md b/api-reference/beta/resources/participantleftnotification.md index beeb61d7fe1..87677058489 100644 --- a/api-reference/beta/resources/participantleftnotification.md +++ b/api-reference/beta/resources/participantleftnotification.md @@ -24,6 +24,9 @@ Under the [Policy-based recording](/microsoftteams/teams-recording-policy) scena | call | [call](call.md) | The call object that contains details about the participant joining event. | | participantId | String | ID of the participant under the policy who has left the meeting. | +## Relationships +None. + ## JSON representation The following JSON representation shows the resource type. diff --git a/api-reference/beta/resources/partner-security-additionaldatadictionary.md b/api-reference/beta/resources/partner-security-additionaldatadictionary.md index e1177c517b3..11445a97b69 100644 --- a/api-reference/beta/resources/partner-security-additionaldatadictionary.md +++ b/api-reference/beta/resources/partner-security-additionaldatadictionary.md @@ -19,6 +19,9 @@ Represents a bag of name-value pairs that contain additional details about an al ## Properties None. +## Relationships +None. + ## JSON representation The following JSON representation shows the resource type. - -```json -{ - "allowMultipleSelection": true, - "displayAs": "account | contentType | created | department | ...", - "chooseFromType": "peopleAndGroups | peopleOnly" -} -``` - ## Properties | Property | Type | Description | @@ -38,7 +24,7 @@ Here is a JSON representation of a **personOrGroupColumn** resource. | **displayAs** | string | How to display the information about the person or group chosen. See below. | | **chooseFromType** | string | Whether to allow selection of people only, or people and groups. Must be one of `peopleAndGroups` or `peopleOnly`. | -## displayAs values +### displayAs values | Value | Description | | :---------------------------- | :---------------------------------------------------------------------------------------------------------- | @@ -63,6 +49,24 @@ Here is a JSON representation of a **personOrGroupColumn** resource. Note: Additional DisplayAs types may be returned. +## Relationships +None. + +## JSON representation + +Here is a JSON representation of a **personOrGroupColumn** resource. + + + +```json +{ + "allowMultipleSelection": true, + "displayAs": "account | contentType | created | department | ...", + "chooseFromType": "peopleAndGroups | peopleOnly" +} +``` + + diff --git a/api-reference/beta/resources/physicalofficeaddress.md b/api-reference/beta/resources/physicalofficeaddress.md index ac671064db9..70029e3e551 100644 --- a/api-reference/beta/resources/physicalofficeaddress.md +++ b/api-reference/beta/resources/physicalofficeaddress.md @@ -25,6 +25,9 @@ Represents the business address of a resource such as an organizational contact. |state|String|The state.| |street|String|The street.| +## Relationships +None. + ## JSON representation The following JSON representation shows the resource type. diff --git a/api-reference/beta/resources/pkcs12CertificateInformation.md b/api-reference/beta/resources/pkcs12CertificateInformation.md index 47c0b83d8c7..8075048de92 100644 --- a/api-reference/beta/resources/pkcs12CertificateInformation.md +++ b/api-reference/beta/resources/pkcs12CertificateInformation.md @@ -25,6 +25,9 @@ Represents the public information of a Pkcs12 certificate. |notAfter|Integer| The certificate's expiry. This value is a NumericDate as defined in RFC 7519 (A JSON numeric value representing the number of seconds from 1970-01-01T00:00:00Z UTC until the specified UTC date/time, ignoring leap seconds.)| |notBefore|Integer| The certificate's issue time (not before). This value is a NumericDate as defined in RFC 7519 (A JSON numeric value representing the number of seconds from 1970-01-01T00:00:00Z UTC until the specified UTC date/time, ignoring leap seconds.)| +## Relationships +None. + ## JSON representation The following JSON representation shows the resource type. diff --git a/api-reference/beta/resources/pkcs12certificate.md b/api-reference/beta/resources/pkcs12certificate.md index 0eadd59946c..0af0ee65573 100644 --- a/api-reference/beta/resources/pkcs12certificate.md +++ b/api-reference/beta/resources/pkcs12certificate.md @@ -25,6 +25,9 @@ Inherits from [apiAuthenticationConfigurationBase](../resources/apiauthenticatio |pkcs12Value|String| Specifies the field for sending pfx content. The value should be a base-64 encoded version of the actual certificate content. Required.| |password|String| Specifies the password for the pfx file. Required. If no password is used, must still provide a value of `""`.| +## Relationships +None. + ## JSON representation The following JSON representation shows the resource type. diff --git a/api-reference/beta/resources/preauthorizedapplication.md b/api-reference/beta/resources/preauthorizedapplication.md index 7f5f58e6150..6d07f94648c 100644 --- a/api-reference/beta/resources/preauthorizedapplication.md +++ b/api-reference/beta/resources/preauthorizedapplication.md @@ -25,6 +25,9 @@ In some rare cases, an identifier listed in the `permissionIds` property may ref |appId|String| The unique identifier for the client application. | |permissionIds|String collection| The unique identifier for the [scopes](permissionscope.md) the client application is granted. | +## Relationships +None. + ## JSON representation The following JSON representation shows the resource type. diff --git a/api-reference/beta/resources/presencestatusmessage.md b/api-reference/beta/resources/presencestatusmessage.md index 3cf82b0cd5c..afc51fbd0b6 100644 --- a/api-reference/beta/resources/presencestatusmessage.md +++ b/api-reference/beta/resources/presencestatusmessage.md @@ -24,6 +24,9 @@ Represents a presence status message related to the [presence](presence.md) of a | message | [itemBody](itembody.md) | Status message item.

The only supported format currently is `message.contentType = 'text'`. | | publishedDateTime | DateTimeOffset |Time in which the status message was published.
Read-only.

**publishedDateTime** isn't available when you request the presence of another user. | +## Relationships +None. + ## JSON representation The following JSON representation shows the resource type. diff --git a/api-reference/beta/resources/printconnector.md b/api-reference/beta/resources/printconnector.md index fc3a824dc98..c7ad8ea984c 100644 --- a/api-reference/beta/resources/printconnector.md +++ b/api-reference/beta/resources/printconnector.md @@ -38,6 +38,9 @@ Represents a print connector that has been registered by using a Universal Print |registeredDateTime|DateTimeOffset|The DateTimeOffset when the connector was registered.| |registeredBy|[userIdentity](useridentity.md)|The user who registered the connector.| +## Relationships +None. + ## JSON representation The following JSON representation shows the resource type. diff --git a/api-reference/beta/resources/printdocument.md b/api-reference/beta/resources/printdocument.md index 64d18c2a626..b6f0f837d2f 100644 --- a/api-reference/beta/resources/printdocument.md +++ b/api-reference/beta/resources/printdocument.md @@ -31,6 +31,9 @@ Represents a document being printed. |contentType|String|The document's content (MIME) type. Read-only.| |size|Int64|The document's size in bytes. Read-only.| +## Relationships +None. + ## JSON representation The following JSON representation shows the resource type. diff --git a/api-reference/beta/resources/printercreateoperation.md b/api-reference/beta/resources/printercreateoperation.md index 7ddc488eef5..f602ce05f79 100644 --- a/api-reference/beta/resources/printercreateoperation.md +++ b/api-reference/beta/resources/printercreateoperation.md @@ -31,6 +31,9 @@ Represents a long-running printer registration operation. Derived from [printOpe |certificate|String|The signed certificate created during the registration process. Read-only.| |printer|[printer](printer.md)|The created printer entity. Read-only.| +## Relationships +None. + ## JSON representation The following JSON representation shows the resource type. diff --git a/api-reference/beta/resources/printidentity.md b/api-reference/beta/resources/printidentity.md index dedb606c1b4..ab60cf72a83 100644 --- a/api-reference/beta/resources/printidentity.md +++ b/api-reference/beta/resources/printidentity.md @@ -22,6 +22,9 @@ Represents an identity within the Universal Print service. Maps to an [Microsoft |id|String|The printIdentity's identifier. Read-only.| |displayName|String|The printIdentity's display name.| +## Relationships +None. + ## JSON representation The following JSON representation shows the resource type. diff --git a/api-reference/beta/resources/printoperation.md b/api-reference/beta/resources/printoperation.md index aff0ab4100f..43053f7227c 100644 --- a/api-reference/beta/resources/printoperation.md +++ b/api-reference/beta/resources/printoperation.md @@ -29,6 +29,9 @@ Represents a long-running Universal Print operation. Base class for operation ty |status|[printOperationStatus](printoperationstatus.md)|The status of the operation. Read-only.| |createdDateTime|DateTimeOffset|The DateTimeOffset when the operation was created. Read-only.| +## Relationships +None. + ## JSON representation The following JSON representation shows the resource type. diff --git a/api-reference/beta/resources/printpagerange.md b/api-reference/beta/resources/printpagerange.md index 9d8be3bb805..98b34fdac43 100644 --- a/api-reference/beta/resources/printpagerange.md +++ b/api-reference/beta/resources/printpagerange.md @@ -22,6 +22,9 @@ Specifies the range of pages to be printed. |startPage|Int32|The start page (inclusive) for the range. Read-only.| |endPage|Int32|The end page (inclusive) for the range. Read-only.| +## Relationships +None. + ## JSON representation The following JSON representation shows the resource type. diff --git a/api-reference/beta/resources/printserviceendpoint.md b/api-reference/beta/resources/printserviceendpoint.md index a644a555ba9..6b5564898cc 100644 --- a/api-reference/beta/resources/printserviceendpoint.md +++ b/api-reference/beta/resources/printserviceendpoint.md @@ -29,6 +29,9 @@ Represents URI and identifying information for a print service instance. |id|String|A unique name that identifies the service that the endpoint provides. Possible values are: `discovery` (Discovery Service), `notification` (Notification Service), `ipp` (IPP Service), and `registration` (Registration Service). Read-only.| |uri|String|The URI that can be used to access the service.| +## Relationships +None. + ## JSON representation The following JSON representation shows the resource type. diff --git a/api-reference/beta/resources/printusagebyprinter.md b/api-reference/beta/resources/printusagebyprinter.md index a9b93efa1b1..b6cbfcf9891 100644 --- a/api-reference/beta/resources/printusagebyprinter.md +++ b/api-reference/beta/resources/printusagebyprinter.md @@ -42,6 +42,9 @@ Describes print activity for a printer during a specified time period (usageDate |singleSidedSheetCount|Int64|The estimated number of single-sided media sheets printed based on reporting by the printer.| |usageDate|Date|The date associated with these statistics.| +## Relationships +None. + ## JSON representation The following JSON representation shows the resource type. diff --git a/api-reference/beta/resources/printusagebyuser.md b/api-reference/beta/resources/printusagebyuser.md index 358e7a4c5c1..4a2b148363a 100644 --- a/api-reference/beta/resources/printusagebyuser.md +++ b/api-reference/beta/resources/printusagebyuser.md @@ -41,6 +41,9 @@ Describes print activity for a user during a specified time period (usageDate). |usageDate|Date|The date associated with these statistics.| |userPrincipalName|String|The UPN of the user represented by these statistics.| +## Relationships +None. + ## JSON representation The following JSON representation shows the resource type. diff --git a/api-reference/beta/resources/printuseridentity.md b/api-reference/beta/resources/printuseridentity.md index 5bc62ec04a3..a7d416c5072 100644 --- a/api-reference/beta/resources/printuseridentity.md +++ b/api-reference/beta/resources/printuseridentity.md @@ -24,6 +24,9 @@ Represents a user identity within the Universal Print service. Maps to an [Micro |ipAddress|String|The printUserIdentity' IP address. Not populated.| |userPrincipalName|String|The printUserIdentity's user principal name (UPN).| +## Relationships +None. + ## JSON representation The following JSON representation shows the resource type. diff --git a/api-reference/beta/resources/privacyprofile.md b/api-reference/beta/resources/privacyprofile.md index e2512f46ca9..8d71446a0be 100644 --- a/api-reference/beta/resources/privacyprofile.md +++ b/api-reference/beta/resources/privacyprofile.md @@ -22,6 +22,9 @@ Represents a [company's](organization.md) privacy profile, which includes a priv |contactEmail|String| A valid smtp email address for the privacy statement contact. Not required.| |statementUrl|String| A valid URL format that begins with http:// or https://. Maximum length is 255 characters. The URL that directs to the company's privacy statement. Not required.| +## Relationships +None. + ## JSON representation The following JSON representation shows the resource type. diff --git a/api-reference/beta/resources/process.md b/api-reference/beta/resources/process.md index 86f779e70f8..b7083240b8f 100644 --- a/api-reference/beta/resources/process.md +++ b/api-reference/beta/resources/process.md @@ -33,6 +33,9 @@ Contains stateful information about the process related to the alert. |path|String|Full path, including filename.| |processId|Int32|The Process ID (PID) of the process.| +## Relationships +None. + ## JSON representation The following JSON representation shows the resource type. diff --git a/api-reference/beta/resources/profilesourceannotation.md b/api-reference/beta/resources/profilesourceannotation.md index daaf9814364..bdc2143cea8 100644 --- a/api-reference/beta/resources/profilesourceannotation.md +++ b/api-reference/beta/resources/profilesourceannotation.md @@ -43,6 +43,9 @@ The following table shows the mapping between the **id** value and the source sy For more information about how to set the values of properties in the **profileSourceAnnotation** resource, see [Where do property values come from](https://support.microsoft.com/office/export-data-from-your-profile-card-d809f83f-c077-4a95-9b6c-4f093305163d#ID0EBF=About_Microsoft_365_User_Profile_Data). +## Relationships +None. + ## JSON representation The following JSON representation shows the resource type. diff --git a/api-reference/beta/resources/programresource.md b/api-reference/beta/resources/programresource.md index 30bc14bba93..533a8ae416f 100644 --- a/api-reference/beta/resources/programresource.md +++ b/api-reference/beta/resources/programresource.md @@ -26,6 +26,9 @@ This type inherits from [identity](identity.md). |:-------- |:---- |:----------- | | type | String | Type of the resource, indicating whether it is a group or an app. | +## Relationships +None. + ## JSON representation @@ -28,10 +35,6 @@ A null (or missing) value indicates the object is not the root. } ``` -## Properties - -The **Root** resource has no properties. - diff --git a/api-reference/beta/resources/security-ediscoveryexportfilemetadata.md b/api-reference/beta/resources/security-ediscoveryexportfilemetadata.md index 45634741aaa..25773c44d87 100644 --- a/api-reference/beta/resources/security-ediscoveryexportfilemetadata.md +++ b/api-reference/beta/resources/security-ediscoveryexportfilemetadata.md @@ -24,6 +24,9 @@ Represents the file metadata for an export in eDiscovery. |fileName | String | The name of the file. | |size| Int64 | The size of the file. | +## Relationships +None. + ## JSON representation The following JSON representation shows the resource type. diff --git a/api-reference/beta/resources/security-huntingqueryresults.md b/api-reference/beta/resources/security-huntingqueryresults.md index 962ca63a857..a9db3bacc7e 100644 --- a/api-reference/beta/resources/security-huntingqueryresults.md +++ b/api-reference/beta/resources/security-huntingqueryresults.md @@ -22,6 +22,9 @@ The results of running a [query for advanced hunting](../api/security-security-r |schema|[microsoft.graph.security.singlePropertySchema](../resources/security-singlepropertyschema.md) collection|The schema for the response.| |results|[microsoft.graph.security.huntingRowResult](../resources/security-huntingrowresult.md) collection|The results of the hunting query.| +## Relationships +None. + ## JSON representation The following JSON representation shows the resource type. - -```json -{ - "application": { "@odata.type": "microsoft.graph.identity" }, - "preventsDownload": false, - "type": "view | edit | embed", - "scope": "anonymous | organization", - "webHtml": "string", - "webUrl": "url" -} -``` - ## Properties | Property | Type | Description @@ -72,6 +51,30 @@ The following table defines the possible values for the **scope** property. | `existingAccess` | Only people who have already been granted access to the item through other means can access the item using this link. Only available in OneDrive for Business and SharePoint. | `users` | The link grants access only to a specific list of people. Only available in OneDrive for Business and SharePoint. +## Relationships +None. + +## JSON representation + +The following JSON representation shows the resource type. + + + +```json +{ + "application": { "@odata.type": "microsoft.graph.identity" }, + "preventsDownload": false, + "type": "view | edit | embed", + "scope": "anonymous | organization", + "webHtml": "string", + "webUrl": "url" +} +``` + +## Relationships +None. + ## JSON representation The following JSON representation shows the resource type. @@ -27,10 +34,6 @@ Most apps should ignore items that have a System facet. } ``` -## Properties - -None. This facet is a null or not-null value and contains no properties. - From 590772ad1d44442f82d01d6d08ed1a7e40f25f55 Mon Sep 17 00:00:00 2001 From: Daniela Bonilla Montero <92937694+Danielabom@users.noreply.github.com> Date: Thu, 26 Dec 2024 09:37:17 -0600 Subject: [PATCH 26/49] Apply suggestions from code review --- api-reference/beta/resources/datetimecolumn.md | 4 ++-- api-reference/beta/resources/fieldvalueset.md | 2 +- api-reference/beta/resources/folder.md | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/api-reference/beta/resources/datetimecolumn.md b/api-reference/beta/resources/datetimecolumn.md index 99194094933..b40970cdd4c 100644 --- a/api-reference/beta/resources/datetimecolumn.md +++ b/api-reference/beta/resources/datetimecolumn.md @@ -28,8 +28,8 @@ The dateTimeColumn on a [columnDefinition](columndefinition.md) resource indicat | Value | Description | | :----------- | :------------------------------------------------------------------ | | default | Uses the default rendering in the UX. | -| friendly | Uses a friendly relative representation (for example "today at 3:00 PM") | -| standard | Uses the standard absolute representation (for example "5/10/2017 3:20 PM") | +| friendly | Uses a friendly relative representation (for example "today at 3:00 PM"). | +| standard | Uses the standard absolute representation (for example "5/10/2017 3:20 PM"). | ## Relationships None. diff --git a/api-reference/beta/resources/fieldvalueset.md b/api-reference/beta/resources/fieldvalueset.md index 2b3ddb15b1a..f8eba99bf50 100644 --- a/api-reference/beta/resources/fieldvalueset.md +++ b/api-reference/beta/resources/fieldvalueset.md @@ -39,7 +39,7 @@ None. ## JSON representation -Here's a JSON representation of a **fieldValueSet** resource. +The following JSON representation shows the resource type. diff --git a/api-reference/beta/resources/folder.md b/api-reference/beta/resources/folder.md index c113891cead..5656e19284e 100644 --- a/api-reference/beta/resources/folder.md +++ b/api-reference/beta/resources/folder.md @@ -20,8 +20,8 @@ The **Folder** resource groups folder-related data on an item into a single stru | Property | Type | Description |:---------------|:---------------|:------------------------------------------- -| **childCount** | Int64 | Number of children contained immediately within this container. -| **view** | [folderView][] | A collection of properties defining the recommended view for the folder. +| childCount | Int64 | Number of children contained immediately within this container. +| view | [folderView][] | A collection of properties defining the recommended view for the folder. ## Relationships None. From 62f6e89abc946d7a1724f92f06217b06a65c2817 Mon Sep 17 00:00:00 2001 From: Daniela Bonilla Montero <92937694+Danielabom@users.noreply.github.com> Date: Thu, 26 Dec 2024 09:42:01 -0600 Subject: [PATCH 27/49] Update folderview.md descriptions and JSON section --- api-reference/beta/resources/folderview.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/api-reference/beta/resources/folderview.md b/api-reference/beta/resources/folderview.md index 67ed36fa7cd..1697631fd81 100644 --- a/api-reference/beta/resources/folderview.md +++ b/api-reference/beta/resources/folderview.md @@ -1,6 +1,6 @@ --- author: spgraph-docs-team -description: The FolderView resource provides or sets recommendations on the user-experience of a folder. +description: Provides or sets recommendations on the user-experience of a folder. ms.date: 09/10/2017 title: FolderView ms.localizationpriority: medium @@ -14,7 +14,7 @@ Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -The **FolderView** resource provides or sets recommendations on the user-experience of a folder. +Provides or sets recommendations on the user-experience of a folder. It is available from the [folder][folder-facet] property of [driveItem][item-resource] resources. @@ -22,9 +22,9 @@ It is available from the [folder][folder-facet] property of [driveItem][item-res | Property | Type | Description | | :------------ | :----- | :--------------------------------------------------------------------------------------------------------------- | -| **sortBy** | string | The method by which the folder should be sorted. | -| **sortOrder** | string | If true, indicates that items should be sorted in descending order. Otherwise, items should be sorted ascending. | -| **viewType** | string | The type of view that should be used to represent the folder. | +| sortBy | string | The method by which the folder should be sorted. | +| sortOrder | string | If true, indicates that items should be sorted in descending order. Otherwise, items should be sorted ascending. | +| viewType | string | The type of view that should be used to represent the folder. | You can use the _sortBy_ property to control the sort order of the items in applications that respect the **viewType** facet. @@ -70,6 +70,8 @@ None. ## JSON representation +The following JSON representation shows the resource type. + ```json From c834d194465be2f1e9c3797ec49cf6a711cec9a0 Mon Sep 17 00:00:00 2001 From: Daniela Bonilla Montero <92937694+Danielabom@users.noreply.github.com> Date: Thu, 26 Dec 2024 09:48:29 -0600 Subject: [PATCH 28/49] Update image resource description and JSON example --- api-reference/beta/resources/image.md | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/api-reference/beta/resources/image.md b/api-reference/beta/resources/image.md index 9d381e79d15..01b93d3426c 100644 --- a/api-reference/beta/resources/image.md +++ b/api-reference/beta/resources/image.md @@ -1,6 +1,6 @@ --- author: spgraph-docs-team -description: "The Image resource groups image-related properties into a single structure." +description: "Groups image-related properties into a single structure." ms.date: 09/10/2017 title: Image ms.localizationpriority: medium @@ -13,7 +13,7 @@ Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -The **Image** resource groups image-related properties into a single structure. +Groups image-related properties into a single structure. If a [**DriveItem**](driveitem.md) has a non-null **image** facet, the item represents a bitmap image. **Note:** If the service is unable to determine the width and height of the image, the **Image** resource may be empty. @@ -22,8 +22,8 @@ If a [**DriveItem**](driveitem.md) has a non-null **image** facet, the item repr | Property | Type | Description | |:-----------|:------|:-------------------------------------------| -| **height** | Int32 | Optional. Height of the image, in pixels. Read-only. | -| **width** | Int32 | Optional. Width of the image, in pixels. Read-only. | +| height | Int32 | Optional. Height of the image, in pixels. Read-only. | +| width | Int32 | Optional. Width of the image, in pixels. Read-only. | ## Remarks @@ -36,6 +36,15 @@ None. ## JSON representation +The following JSON representation shows the resource type. + +```json +{ + "height": 1024, + "width": 768 +} +``` + ```json { From eaabb3008668f0d1d3db44bd64124e36d4385ff8 Mon Sep 17 00:00:00 2001 From: Daniela Bonilla Montero <92937694+Danielabom@users.noreply.github.com> Date: Thu, 26 Dec 2024 09:58:25 -0600 Subject: [PATCH 29/49] Update description and add JSON representation note --- api-reference/beta/resources/itemactionset.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/api-reference/beta/resources/itemactionset.md b/api-reference/beta/resources/itemactionset.md index c7dfbc4afbe..0bc1b03c75b 100644 --- a/api-reference/beta/resources/itemactionset.md +++ b/api-reference/beta/resources/itemactionset.md @@ -1,6 +1,6 @@ --- author: daspek -description: The ItemActionSet resource provides information about the actions that made up an [activity][itemActivity] on an item. +description: Provides information about the actions that made up an [activity][itemActivity] on an item. ms.date: 09/14/2017 title: ItemActionSet ms.localizationpriority: medium @@ -14,7 +14,7 @@ Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -The **ItemActionSet** resource provides information about the actions that made up an [activity][itemActivity] on an item. +Provides information about the actions that made up an [activity][itemActivity] on an item. [itemActivity]: itemactivity.md @@ -52,6 +52,8 @@ None. ## JSON representation +The following JSON representation shows the resource type. + diff --git a/api-reference/beta/resources/package.md b/api-reference/beta/resources/package.md index 02439a2e866..0806c5bff47 100644 --- a/api-reference/beta/resources/package.md +++ b/api-reference/beta/resources/package.md @@ -24,7 +24,7 @@ DriveItems with the **package** facet do not include a **folder** or **file** fa | Property Name | Type | Description | |:--------------|:-------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **type** | string | An string indicating the type of package. While `oneNote` is the only currently defined value, you should expect other package types to be returned and handle them accordingly. | +| type | string | Indicates the type of package. While `oneNote` is the only currently defined value, you should expect other package types to be returned and handle them accordingly. | ## Relationships None. diff --git a/api-reference/beta/resources/personOrGroupColumn.md b/api-reference/beta/resources/personOrGroupColumn.md index 001fa5db88f..2b9a58e3a89 100644 --- a/api-reference/beta/resources/personOrGroupColumn.md +++ b/api-reference/beta/resources/personOrGroupColumn.md @@ -54,7 +54,7 @@ None. ## JSON representation -Here is a JSON representation of a **personOrGroupColumn** resource. +The following JSON representation shows the resource type. diff --git a/api-reference/beta/resources/workbooksessioninfo.md b/api-reference/beta/resources/workbooksessioninfo.md index 4dca7873f3b..3e91e728118 100644 --- a/api-reference/beta/resources/workbooksessioninfo.md +++ b/api-reference/beta/resources/workbooksessioninfo.md @@ -21,7 +21,7 @@ Provides information about workbook session. | Property | Type | Description | |:---------|:------|:------------------------------------------| | id | string | ID of the workbook session. | -| persistChanges | string | `true` for persistent session. `false` for non-persistent session (view mode) | +| persistChanges | string |Set to `true` for persistent session. Set to `false` for non-persistent session (view mode). | ## Relationships From e09c4051562aa073c5c9def51a58d3fcc185e145 Mon Sep 17 00:00:00 2001 From: Daniela Bonilla Montero <92937694+Danielabom@users.noreply.github.com> Date: Thu, 26 Dec 2024 11:14:17 -0600 Subject: [PATCH 33/49] Update video.md description and formatting --- api-reference/beta/resources/video.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/api-reference/beta/resources/video.md b/api-reference/beta/resources/video.md index 5bd322e1820..e3e5452ab60 100644 --- a/api-reference/beta/resources/video.md +++ b/api-reference/beta/resources/video.md @@ -1,6 +1,6 @@ --- author: spgraph-docs-team -description: The Video resource groups video-related data items into a single structure. +description: Groups video-related data items into a single structure. ms.date: 09/10/2017 title: Video ms.localizationpriority: medium @@ -14,7 +14,7 @@ Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -The **Video** resource groups video-related data items into a single structure. +Groups video-related data items into a single structure. If a [**DriveItem**](driveitem.md) has a non-null **video** facet, the item represents a video file. The properties of the **Video** resource are populated by extracting metadata from the file. @@ -23,16 +23,16 @@ The properties of the **Video** resource are populated by extracting metadata fr | Property | Type | Description | | :------------------------ | :----- | :---------------------------------------------- | -| **audioBitsPerSample** | Int32 | Number of audio bits per sample. | -| **audioChannels** | Int32 | Number of audio channels. | -| **audioFormat** | string | Name of the audio format (AAC, MP3, etc.). | -| **audioSamplesPerSecond** | Int32 | Number of audio samples per second. | -| **bitrate** | Int32 | Bit rate of the video in bits per second. | -| **duration** | Int64 | Duration of the file in milliseconds. | -| **fourCC** | string | "Four character code" name of the video format. | -| **framerate** | double | Frame rate of the video. | -| **height** | Int32 | Height of the video, in pixels. | -| **width** | Int32 | Width of the video, in pixels. | +| audioBitsPerSample | Int32 | Number of audio bits per sample. | +| audioChannels | Int32 | Number of audio channels. | +| audioFormat | string | Name of the audio format (AAC, MP3, etc.). | +| audioSamplesPerSecond | Int32 | Number of audio samples per second. | +| bitrate | Int32 | Bit rate of the video in bits per second. | +| duration | Int64 | Duration of the file in milliseconds. | +| fourCC | string | "Four character code" name of the video format. | +| framerate | double | Frame rate of the video. | +| height | Int32 | Height of the video, in pixels. | +| width | Int32 | Width of the video, in pixels. | [item-resource]: ../resources/driveitem.md @@ -66,7 +66,7 @@ The following JSON representation shows the resource type. ## Remarks -For more information about the facets on a DriveItem, see [DriveItem](driveitem.md). +For more information, see [DriveItem](driveitem.md). From aa07e6b330531d0eab089fd59627d0ba05b68b6c Mon Sep 17 00:00:00 2001 From: Daniela Bonilla Montero <92937694+Danielabom@users.noreply.github.com> Date: Thu, 26 Dec 2024 11:20:44 -0600 Subject: [PATCH 34/49] Fix formatting and update JSON representation description --- api-reference/beta/resources/textColumn.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/api-reference/beta/resources/textColumn.md b/api-reference/beta/resources/textColumn.md index 2a343a1d511..e93c7953520 100644 --- a/api-reference/beta/resources/textColumn.md +++ b/api-reference/beta/resources/textColumn.md @@ -20,18 +20,18 @@ The **textColumn** on a [columnDefinition](columndefinition.md) resource indicat | Property | Type | Description | | :------------------------------ | :----- | :---------------------------------------------------------------------------- | -| **allowMultipleLines** | string | Whether to allow multiple lines of text. | -| **appendChangesToExistingText** | string | Whether updates to this column should replace existing text, or append to it. | -| **linesForEditing** | int | The size of the text box. | -| **maxLength** | int | The maximum number of characters for the value. | -| **textType** | string | The type of text being stored. Must be one of `plain` or `richText` | +| allowMultipleLines | string | Whether to allow multiple lines of text. | +| appendChangesToExistingText | string | Whether updates to this column should replace existing text, or append to it. | +| linesForEditing | int | The size of the text box. | +| maxLength | int | The maximum number of characters for the value. | +| textType | string | The type of text being stored. Must be one of `plain` or `richText`. | ## Relationships None. ## JSON representation -Here is a JSON representation of a **textColumn** resource. +The following JSON representation shows the resource type. From 08227cad86c81455d2b405276dc30bf416f9cfec Mon Sep 17 00:00:00 2001 From: Daniela Bonilla Montero <92937694+Danielabom@users.noreply.github.com> Date: Thu, 26 Dec 2024 11:52:23 -0600 Subject: [PATCH 35/49] Apply suggestions from code review --- api-reference/beta/resources/publicationfacet.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/api-reference/beta/resources/publicationfacet.md b/api-reference/beta/resources/publicationfacet.md index 2b6a613a45a..d68bf3c10db 100644 --- a/api-reference/beta/resources/publicationfacet.md +++ b/api-reference/beta/resources/publicationfacet.md @@ -19,9 +19,9 @@ The **publicationFacet** resource provides details on the published status of a | Property | Type | Description | | :------------ | :----- | :---------- | -| **level** | String | The state of publication for this document. Either `published` or `checkout`. Read-only. | -| **versionId** | String | The unique identifier for the version that is visible to the current caller. Read-only. | -| **checkedOutBy** | microsoft.graph.identitySet | The user who checked out the file. | +| level | String | The state of publication for this document. Either `published` or `checkout`. Read-only. | +| versionId | String | The unique identifier for the version that is visible to the current caller. Read-only. | +| checkedOutBy | microsoft.graph.identitySet | The user who checked out the file. | ## Relationships From 25278b5a6907b892895b8157f5b3012921fbe056 Mon Sep 17 00:00:00 2001 From: Daniela Bonilla Montero <92937694+Danielabom@users.noreply.github.com> Date: Thu, 26 Dec 2024 12:25:50 -0600 Subject: [PATCH 36/49] Update remoteitem.md description and properties formatting --- api-reference/beta/resources/remoteitem.md | 45 +++++++++++----------- 1 file changed, 23 insertions(+), 22 deletions(-) diff --git a/api-reference/beta/resources/remoteitem.md b/api-reference/beta/resources/remoteitem.md index 7934c191102..739599efc63 100644 --- a/api-reference/beta/resources/remoteitem.md +++ b/api-reference/beta/resources/remoteitem.md @@ -1,6 +1,6 @@ --- author: spgraph-docs-team -description: The remoteItem resource indicates that a driveItem references an item that exists in another drive. +description: Indicates that a driveItem references an item that exists in another drive. ms.date: 09/10/2017 title: RemoteItem ms.localizationpriority: medium @@ -14,7 +14,7 @@ Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -The **remoteItem** resource indicates that a [**driveItem**](driveitem.md) references an item that exists in another drive. +Indicates that a [**driveItem**](driveitem.md) references an item that exists in another drive. This resource provides the unique IDs of the source drive and target item. [**DriveItems**](driveitem.md) with a non-null **remoteItem** facet are resources that are shared, added to the user's OneDrive, or on items returned from heterogenous collections of items (like search results). @@ -23,31 +23,32 @@ This resource provides the unique IDs of the source drive and target item. ## Properties -| Property | Type | Description | -| :------------------- | :---------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| createdBy | [IdentitySet](identityset.md) | Identity of the user, device, and application which created the item. Read-only. | -| createdDateTime | Timestamp | Date and time of item creation. Read-only. | -| file | [File](file.md) | Indicates that the remote item is a file. Read-only. | -| fileSystemInfo | [FileSystemInfo](filesysteminfo.md) | Information about the remote item from the local file system. Read-only. | -| folder | [Folder](folder.md) | Indicates that the remote item is a folder. Read-only. | -| id | String | Unique identifier for the remote item in its drive. Read-only. | -| image | [Image](image.md) | Image metadata, if the item is an image. Read-only. | -| lastModifiedBy | [IdentitySet](identityset.md) | Identity of the user, device, and application which last modified the item. Read-only. | -| lastModifiedDateTime | Timestamp | Date and time the item was last modified. Read-only. | -| name | String | Optional. Filename of the remote item. Read-only. | +| Property | Type | Description | +| :------------------- | :---------------------------------- | :-------------- | +| createdBy | [IdentitySet](identityset.md) | Identity of the user, device, and application which created the item. Read-only.| +| createdDateTime | Timestamp | Date and time of item creation. Read-only. | +| file | [File](file.md) | Indicates that the remote item is a file. Read-only.| +| fileSystemInfo | [FileSystemInfo](filesysteminfo.md) | Information about the remote item from the local file system. Read-only.| +| folder | [Folder](folder.md) | Indicates that the remote item is a folder. Read-only.| +| id | String | Unique identifier for the remote item in its drive. Read-only.| +| image | [Image](image.md) | Image metadata, if the item is an image. Read-only. | +| lastModifiedBy | [IdentitySet](identityset.md) | Identity of the user, device, and application which last modified the item. Read-only.| +| lastModifiedDateTime | Timestamp | Date and time the item was last modified. Read-only. | +| name | String | Optional. Filename of the remote item. Read-only. | | package | [Package](package.md) | If present, indicates that this item is a package instead of a folder or file. Packages are treated like files in some contexts and folders in others. Read-only. | -| parentReference | [ItemReference](itemreference.md) | Properties of the parent of the remote item. Read-only. | -| shared | [shared](shared.md) | Indicates that the item has been shared with others and provides information about the shared state of the item. Read-only. | -| sharepointIds | [SharepointIds](sharepointids.md) | Provides interop between items in OneDrive for Business and SharePoint with the full set of item identifiers. Read-only. | -| size | Int64 | Size of the remote item. Read-only. | -| video | [Video](video.md) | Video metadata, if the item is a video. Read-only. | -| webDavUrl | Url | DAV compatible URL for the item. | -| webUrl | Url | URL that displays the resource in the browser. Read-only. | +| parentReference | [ItemReference](itemreference.md) | Properties of the parent of the remote item. Read-only. | +| shared | [shared](shared.md) | Indicates that the item has been shared with others and provides information about the shared state of the item. Read-only.| +| sharepointIds | [SharepointIds](sharepointids.md) | Provides interop between items in OneDrive for Business and SharePoint with the full set of item identifiers. Read-only. | +| size | Int64 | Size of the remote item. Read-only. | +| video | [Video](video.md) | Video metadata, if the item is a video. Read-only. | +| webDavUrl | Url | DAV compatible URL for the item.| +| webUrl | Url | URL that displays the resource in the browser. Read-only. | ## Relationships None. ## JSON representation + The following JSON representation shows the resource type. |Property|Type|Description| |:---|:---|:---| |exclusive | Boolean | Indicates whether the object is an [exclusive scope](/exchange/understanding-exclusive-scopes-exchange-2013-help). | From 0a4eae499f2af372f4784f8eb66e1349df51ec6d Mon Sep 17 00:00:00 2001 From: Daniela Bonilla Montero <92937694+Danielabom@users.noreply.github.com> Date: Thu, 26 Dec 2024 15:55:28 -0600 Subject: [PATCH 44/49] Add methods and properties to eventMessage documentation --- api-reference/beta/resources/eventmessage.md | 176 +++++++++---------- 1 file changed, 87 insertions(+), 89 deletions(-) diff --git a/api-reference/beta/resources/eventmessage.md b/api-reference/beta/resources/eventmessage.md index 08e23e3e9d1..d8bde503f1b 100644 --- a/api-reference/beta/resources/eventmessage.md +++ b/api-reference/beta/resources/eventmessage.md @@ -26,8 +26,94 @@ this [get event message example](../api/eventmessage-get.md#example-2). The app Aside from a meeting request, an **eventMessage** instance can be found in an invitee's mailbox as the result of an event organizer cancelling a meeting, or in the organizer's mailbox as a result of an invitee responding to the meeting request. An app can act on event messages in the same way as on messages with minor differences. +## Methods + +| Method | Return Type |Description| +|:---------------|:--------|:----------| +|[Get](../api/eventmessage-get.md) | [eventMessage](eventmessage.md) |Read properties and relationships of eventMessage object.| +|[Update](../api/eventmessage-update.md) | [eventMessage](eventmessage.md) |Update eventMessage object.| +|[Delete](../api/eventmessage-delete.md) | None |Delete eventMessage object.| +|[Copy message](../api/message-copy.md)|[message](message.md)|Copy a message to a folder.| +|[Create draft to forward message](../api/message-createforward.md)|[message](message.md)|Create a draft of the Forward message. You can then [update](../api/message-update.md) or [send](../api/message-send.md) the draft.| +|[Create draft to reply](../api/message-createreply.md)|[message](message.md)|Create a draft of the Reply message. You can then [update](../api/message-update.md) or [send](../api/message-send.md) the draft.| +|[Create draft to reply-all](../api/message-createreplyall.md)|[message](message.md)|Create a draft of the Reply All message. You can then [update](../api/message-update.md) or [send](../api/message-send.md) the draft.| +|[Forward message](../api/message-forward.md)|None|Forward a message. The message is then saved in the Sent Items folder.| +|[Move message](../api/message-move.md)|[message](message.md)|Move a message to a folder. This creates a new copy of the message in the destination folder.| +|[Reply to message](../api/message-reply.md)|None|Reply to the sender of a message. The message is then saved in the Sent Items folder.| +|[Reply-all to message](../api/message-replyall.md)|None|Reply to all recipients of a message. The message is then saved in the Sent Items folder.| +|[Send draft message](../api/message-send.md)|None|Sends a previously created message draft. The message is then saved in the Sent Items folder.| +|[Recall message](../api/message-recall.md)|[message](message.md)|Recall a message in the specified user's mailbox Sent Items folder.| +|[Unsubscribe](../api/message-unsubscribe.md)|None|Send a message using the data and address specified in the first mailto command in the List-Unsubscribe header.| +|[Permanently delete](../api/eventmessage-permanentdelete.md)|None|Permanently delete an event message and place it in the Purges folder in the Recoverable Items folder in the user's mailbox.| +|**Attachments**| | | +|[List attachments](../api/eventmessage-list-attachments.md) |[attachment](attachment.md) collection| Get all attachments on an eventMessage.| +|[Add attachment](../api/eventmessage-post-attachments.md) |[attachment](attachment.md)| Add a new attachment to an eventMessage by posting to the attachments collection.| +|**Open extensions**| | | +|[Create open extension](../api/opentypeextension-post-opentypeextension.md) |[openTypeExtension](opentypeextension.md)| Create an open extension and add custom properties in a new or existing instance of a resource.| +|[Get open extension](../api/opentypeextension-get.md) |[openTypeExtension](opentypeextension.md) collection| Get an open extension identified by name.| +|**Extended properties**| | | +|[Create single-value property](../api/singlevaluelegacyextendedproperty-post-singlevalueextendedproperties.md) |[eventMessage](eventmessage.md) |Create one or more single-value extended properties in a new or existing eventMessage. | +|[Get single-value property](../api/singlevaluelegacyextendedproperty-get.md) | [eventMessage](eventmessage.md) | Get eventMessages that contain a single-value extended property by using `$expand` or `$filter`. | +|[Create multi-value property](../api/multivaluelegacyextendedproperty-post-multivalueextendedproperties.md) | [eventMessage](eventmessage.md) | Create one or more multi-value extended properties in a new or existing eventMessage. | +|[Get multi-value property](../api/multivaluelegacyextendedproperty-get.md) | [eventMessage](eventmessage.md) | Get an eventMessage that contains a multi-value extended property by using `$expand`. | + +## Properties +| Property | Type |Description| +|:---------------|:--------|:----------| +|bccRecipients|[recipient](recipient.md) collection|The Bcc: recipients for the message.| +|body|[itemBody](itembody.md)|The body of the message. It can be in HTML or text format.| +|bodyPreview|String|The first 255 characters of the message body. It is in text format. | +|categories|String collection|The categories associated with the message.| +|ccRecipients|[recipient](recipient.md) collection|The Cc: recipients for the message.| +|changeKey|String|The version of the message.| +|conversationId|String|The ID of the conversation the email belongs to.| +|conversationIndex|Edm.Binary|Indicates the position of the message within the conversation.| +|createdDateTime|DateTimeOffset|The date and time the message was created.| +|endDateTime|[dateTimeTimeZone](datetimetimezone.md)|The end time of the requested meeting.| +|flag|[followupFlag](followupflag.md)|The flag value that indicates the status, start date, due date, or completion date for the message.| +|from|[recipient](recipient.md)|The owner of the mailbox from which the message is sent. In most cases, this value is the same as the **sender** property, except for sharing or delegation scenarios. The value must correspond to the actual mailbox used. Find out more about [setting the from and sender properties](/graph/outlook-create-send-messages#setting-the-from-and-sender-properties) of a message.| +|hasAttachments|Boolean|Indicates whether the message has attachments.| +|id|String| Unique identifier for the message. [!INCLUDE [outlook-beta-id](../../includes/outlook-immutable-id.md)] Read-only. | +|importance|String| The importance of the message: `low`, `normal`, `high`.| +|inferenceClassification|String| Possible values are: `focused`, `other`.| +|internetMessageHeaders | [internetMessageHeader](internetmessageheader.md) collection | The collection of message headers, defined by [RFC5322](https://www.ietf.org/rfc/rfc5322.txt), that provide details of the network path taken by a message from the sender to the recipient. Read-only.| +|internetMessageId |String |The message ID in the format specified by [RFC5322](https://www.ietf.org/rfc/rfc5322.txt). | +|isAllDay |Boolean|Indicates whether the event lasts the entire day. Adjusting this property requires adjusting the **startDateTime** and **endDateTime** properties of the event as well.| +|isDelegated|Boolean|True if this meeting request is accessible to a delegate, false otherwise. Default is false.| +|isDeliveryReceiptRequested|Boolean|Indicates whether a read receipt is requested for the message.| +|isDraft|Boolean|Indicates whether the message is a draft. A message is a draft if it hasn't been sent yet.| +|isOutOfDate|Boolean|Indicates whether this meeting request has been made out-of-date by a more recent request.| +|isRead|Boolean|Indicates whether the message has been read.| +|isReadReceiptRequested|Boolean|Indicates whether a read receipt is requested for the message.| +|lastModifiedDateTime|DateTimeOffset|The date and time the message was last changed.| +|location|[location](location.md)|The location of the requested meeting.| +|meetingMessageType|String| The type of event message: `none`, `meetingRequest`, `meetingCancelled`, `meetingAccepted`, `meetingTentativelyAccepted`, `meetingDeclined`.| +|mentionsPreview|[mentionsPreview](mentionspreview.md)|Information about mentions in the message. When processing a `GET` /messages request, the server sets this property and includes it in the response by default. The server returns null if there are no mentions in the message. Optional. | +|parentFolderId|String|The unique identifier for the message's parent mailFolder.| +|receivedDateTime|DateTimeOffset|The date and time the message was received.| +|recurrence|[patternedRecurrence](patternedrecurrence.md)|The recurrence pattern of the requested meeting.| +|replyTo|[recipient](recipient.md) collection|The email addresses to use when replying.| +|sender|[recipient](recipient.md)|The account that is used to generate the message. In most cases, this value is the same as the **from** property. You can set this property to a different value when sending a message from a [shared mailbox](/exchange/collaboration/shared-mailboxes/shared-mailboxes), [for a shared calendar, or as a delegate](/graph/outlook-share-or-delegate-calendar). In any case, the value must correspond to the actual mailbox used. For more information, see [setting the from and sender properties](/graph/outlook-create-send-messages#setting-the-from-and-sender-properties).| +|sentDateTime|DateTimeOffset|The date and time the message was sent.| +|startDateTime|[dateTimeTimeZone](datetimetimezone.md)|The start time of the requested meeting.| +|subject|String|The subject of the message.| +|toRecipients|[recipient](recipient.md) collection|The To: recipients for the message.| +|type|String|The type of requested meeting: `singleInstance`, `occurence`, `exception`, `seriesMaster`.| +|uniqueBody|[itemBody](itembody.md)|The part of the body of the message that is unique to the current message.| +|UnsubscribeData|String|The valid entries parsed from the List-Unsubscribe header. This is the data for the mail command in the List-Unsubscribe header if UnsubscribeEnabled property is true.| +|UnsubscribeEnabled|Boolean|Indicates whether the message is enabled for unsubscribe. Its valueTrue if the list-Unsubscribe header conforms to rfc-2369.| +|webLink|String|The URL to open the message in Outlook on the web.

You can append an ispopout argument to the end of the URL to change how the message is displayed. If ispopout isn't present or if it's set to 1, then the message is shown in a popout window. If ispopout is set to 0, then the browser shows the message in the Outlook on the web review pane.

The message opens in the browser if you're logged in to your mailbox via Outlook on the web. You are prompted to login if you aren't already logged in with the browser.

This URL can't be accessed from within an iFrame.| + ## Relationships -None. +| Relationship | Type |Description| +|:---------------|:--------|:----------| +|attachments|[attachment](attachment.md) collection|The collection of [fileAttachment](fileattachment.md), [itemAttachment](itemattachment.md), and [referenceAttachment](referenceattachment.md) attachments for the message. Read-only. Nullable.| +|event|[event](event.md)| The event associated with the event message. The assumption for attendees or room resources is that the Calendar Attendant is set to automatically update the calendar with an event when meeting request event messages arrive. Navigation property. Read-only.| +|extensions|[extension](extension.md) collection| The collection of open extensions defined for the eventMessage. Read-only. Nullable.| +|mentions|[mention](mention.md) collection | A collection of mentions in the message, ordered by the **createdDateTime** from the newest to the oldest. By default, a `GET` /messages doesn't return this property unless you apply `$expand` on the property.| +|multiValueExtendedProperties|[multiValueLegacyExtendedProperty](multivaluelegacyextendedproperty.md) collection| The collection of multi-value extended properties defined for the eventMessage. Read-only. Nullable.| +|singleValueExtendedProperties|[singleValueLegacyExtendedProperty](singlevaluelegacyextendedproperty.md) collection| The collection of single-value extended properties defined for the eventMessage. Read-only. Nullable.| + ## JSON representation @@ -97,94 +183,6 @@ The following JSON representation shows the resource type. ``` -## Properties -| Property | Type |Description| -|:---------------|:--------|:----------| -|bccRecipients|[recipient](recipient.md) collection|The Bcc: recipients for the message.| -|body|[itemBody](itembody.md)|The body of the message. It can be in HTML or text format.| -|bodyPreview|String|The first 255 characters of the message body. It is in text format. | -|categories|String collection|The categories associated with the message.| -|ccRecipients|[recipient](recipient.md) collection|The Cc: recipients for the message.| -|changeKey|String|The version of the message.| -|conversationId|String|The ID of the conversation the email belongs to.| -|conversationIndex|Edm.Binary|Indicates the position of the message within the conversation.| -|createdDateTime|DateTimeOffset|The date and time the message was created.| -|endDateTime|[dateTimeTimeZone](datetimetimezone.md)|The end time of the requested meeting.| -|flag|[followupFlag](followupflag.md)|The flag value that indicates the status, start date, due date, or completion date for the message.| -|from|[recipient](recipient.md)|The owner of the mailbox from which the message is sent. In most cases, this value is the same as the **sender** property, except for sharing or delegation scenarios. The value must correspond to the actual mailbox used. Find out more about [setting the from and sender properties](/graph/outlook-create-send-messages#setting-the-from-and-sender-properties) of a message.| -|hasAttachments|Boolean|Indicates whether the message has attachments.| -|id|String| Unique identifier for the message. [!INCLUDE [outlook-beta-id](../../includes/outlook-immutable-id.md)] Read-only. | -|importance|String| The importance of the message: `low`, `normal`, `high`.| -|inferenceClassification|String| Possible values are: `focused`, `other`.| -|internetMessageHeaders | [internetMessageHeader](internetmessageheader.md) collection | The collection of message headers, defined by [RFC5322](https://www.ietf.org/rfc/rfc5322.txt), that provide details of the network path taken by a message from the sender to the recipient. Read-only.| -|internetMessageId |String |The message ID in the format specified by [RFC5322](https://www.ietf.org/rfc/rfc5322.txt). | -|isAllDay |Boolean|Indicates whether the event lasts the entire day. Adjusting this property requires adjusting the **startDateTime** and **endDateTime** properties of the event as well.| -|isDelegated|Boolean|True if this meeting request is accessible to a delegate, false otherwise. Default is false.| -|isDeliveryReceiptRequested|Boolean|Indicates whether a read receipt is requested for the message.| -|isDraft|Boolean|Indicates whether the message is a draft. A message is a draft if it hasn't been sent yet.| -|isOutOfDate|Boolean|Indicates whether this meeting request has been made out-of-date by a more recent request.| -|isRead|Boolean|Indicates whether the message has been read.| -|isReadReceiptRequested|Boolean|Indicates whether a read receipt is requested for the message.| -|lastModifiedDateTime|DateTimeOffset|The date and time the message was last changed.| -|location|[location](location.md)|The location of the requested meeting.| -|meetingMessageType|String| The type of event message: `none`, `meetingRequest`, `meetingCancelled`, `meetingAccepted`, `meetingTentativelyAccepted`, `meetingDeclined`.| -|mentionsPreview|[mentionsPreview](mentionspreview.md)|Information about mentions in the message. When processing a `GET` /messages request, the server sets this property and includes it in the response by default. The server returns null if there are no mentions in the message. Optional. | -|parentFolderId|String|The unique identifier for the message's parent mailFolder.| -|receivedDateTime|DateTimeOffset|The date and time the message was received.| -|recurrence|[patternedRecurrence](patternedrecurrence.md)|The recurrence pattern of the requested meeting.| -|replyTo|[recipient](recipient.md) collection|The email addresses to use when replying.| -|sender|[recipient](recipient.md)|The account that is used to generate the message. In most cases, this value is the same as the **from** property. You can set this property to a different value when sending a message from a [shared mailbox](/exchange/collaboration/shared-mailboxes/shared-mailboxes), [for a shared calendar, or as a delegate](/graph/outlook-share-or-delegate-calendar). In any case, the value must correspond to the actual mailbox used. For more information, see [setting the from and sender properties](/graph/outlook-create-send-messages#setting-the-from-and-sender-properties).| -|sentDateTime|DateTimeOffset|The date and time the message was sent.| -|startDateTime|[dateTimeTimeZone](datetimetimezone.md)|The start time of the requested meeting.| -|subject|String|The subject of the message.| -|toRecipients|[recipient](recipient.md) collection|The To: recipients for the message.| -|type|String|The type of requested meeting: `singleInstance`, `occurence`, `exception`, `seriesMaster`.| -|uniqueBody|[itemBody](itembody.md)|The part of the body of the message that is unique to the current message.| -|UnsubscribeData|String|The valid entries parsed from the List-Unsubscribe header. This is the data for the mail command in the List-Unsubscribe header if UnsubscribeEnabled property is true.| -|UnsubscribeEnabled|Boolean|Indicates whether the message is enabled for unsubscribe. Its valueTrue if the list-Unsubscribe header conforms to rfc-2369.| -|webLink|String|The URL to open the message in Outlook on the web.

You can append an ispopout argument to the end of the URL to change how the message is displayed. If ispopout isn't present or if it's set to 1, then the message is shown in a popout window. If ispopout is set to 0, then the browser shows the message in the Outlook on the web review pane.

The message opens in the browser if you're logged in to your mailbox via Outlook on the web. You are prompted to login if you aren't already logged in with the browser.

This URL can't be accessed from within an iFrame.| - -## Relationships -| Relationship | Type |Description| -|:---------------|:--------|:----------| -|attachments|[attachment](attachment.md) collection|The collection of [fileAttachment](fileattachment.md), [itemAttachment](itemattachment.md), and [referenceAttachment](referenceattachment.md) attachments for the message. Read-only. Nullable.| -|event|[event](event.md)| The event associated with the event message. The assumption for attendees or room resources is that the Calendar Attendant is set to automatically update the calendar with an event when meeting request event messages arrive. Navigation property. Read-only.| -|extensions|[extension](extension.md) collection| The collection of open extensions defined for the eventMessage. Read-only. Nullable.| -|mentions|[mention](mention.md) collection | A collection of mentions in the message, ordered by the **createdDateTime** from the newest to the oldest. By default, a `GET` /messages doesn't return this property unless you apply `$expand` on the property.| -|multiValueExtendedProperties|[multiValueLegacyExtendedProperty](multivaluelegacyextendedproperty.md) collection| The collection of multi-value extended properties defined for the eventMessage. Read-only. Nullable.| -|singleValueExtendedProperties|[singleValueLegacyExtendedProperty](singlevaluelegacyextendedproperty.md) collection| The collection of single-value extended properties defined for the eventMessage. Read-only. Nullable.| - -## Methods - -| Method | Return Type |Description| -|:---------------|:--------|:----------| -|[Get](../api/eventmessage-get.md) | [eventMessage](eventmessage.md) |Read properties and relationships of eventMessage object.| -|[Update](../api/eventmessage-update.md) | [eventMessage](eventmessage.md) |Update eventMessage object.| -|[Delete](../api/eventmessage-delete.md) | None |Delete eventMessage object.| -|[Copy message](../api/message-copy.md)|[message](message.md)|Copy a message to a folder.| -|[Create draft to forward message](../api/message-createforward.md)|[message](message.md)|Create a draft of the Forward message. You can then [update](../api/message-update.md) or [send](../api/message-send.md) the draft.| -|[Create draft to reply](../api/message-createreply.md)|[message](message.md)|Create a draft of the Reply message. You can then [update](../api/message-update.md) or [send](../api/message-send.md) the draft.| -|[Create draft to reply-all](../api/message-createreplyall.md)|[message](message.md)|Create a draft of the Reply All message. You can then [update](../api/message-update.md) or [send](../api/message-send.md) the draft.| -|[Forward message](../api/message-forward.md)|None|Forward a message. The message is then saved in the Sent Items folder.| -|[Move message](../api/message-move.md)|[message](message.md)|Move a message to a folder. This creates a new copy of the message in the destination folder.| -|[Reply to message](../api/message-reply.md)|None|Reply to the sender of a message. The message is then saved in the Sent Items folder.| -|[Reply-all to message](../api/message-replyall.md)|None|Reply to all recipients of a message. The message is then saved in the Sent Items folder.| -|[Send draft message](../api/message-send.md)|None|Sends a previously created message draft. The message is then saved in the Sent Items folder.| -|[Recall message](../api/message-recall.md)|[message](message.md)|Recall a message in the specified user's mailbox Sent Items folder.| -|[Unsubscribe](../api/message-unsubscribe.md)|None|Send a message using the data and address specified in the first mailto command in the List-Unsubscribe header.| -|[Permanently delete](../api/eventmessage-permanentdelete.md)|None|Permanently delete an event message and place it in the Purges folder in the Recoverable Items folder in the user's mailbox.| -|**Attachments**| | | -|[List attachments](../api/eventmessage-list-attachments.md) |[attachment](attachment.md) collection| Get all attachments on an eventMessage.| -|[Add attachment](../api/eventmessage-post-attachments.md) |[attachment](attachment.md)| Add a new attachment to an eventMessage by posting to the attachments collection.| -|**Open extensions**| | | -|[Create open extension](../api/opentypeextension-post-opentypeextension.md) |[openTypeExtension](opentypeextension.md)| Create an open extension and add custom properties in a new or existing instance of a resource.| -|[Get open extension](../api/opentypeextension-get.md) |[openTypeExtension](opentypeextension.md) collection| Get an open extension identified by name.| -|**Extended properties**| | | -|[Create single-value property](../api/singlevaluelegacyextendedproperty-post-singlevalueextendedproperties.md) |[eventMessage](eventmessage.md) |Create one or more single-value extended properties in a new or existing eventMessage. | -|[Get single-value property](../api/singlevaluelegacyextendedproperty-get.md) | [eventMessage](eventmessage.md) | Get eventMessages that contain a single-value extended property by using `$expand` or `$filter`. | -|[Create multi-value property](../api/multivaluelegacyextendedproperty-post-multivalueextendedproperties.md) | [eventMessage](eventmessage.md) | Create one or more multi-value extended properties in a new or existing eventMessage. | -|[Get multi-value property](../api/multivaluelegacyextendedproperty-get.md) | [eventMessage](eventmessage.md) | Get an eventMessage that contains a multi-value extended property by using `$expand`. | - @@ -36,12 +38,6 @@ Here is a JSON representation of a **currencyColumn** resource. } ``` -## Properties - -| Property | Type | Description | -| :--------- | :----- | :------------------------------------------------------------ | -| **locale** | string | Specifies the locale from which to infer the currency symbol. | -