Update-MgBetaExternalConnection
Update the properties of an externalConnection.
Note
To view the v1.0 release of this cmdlet, view Update-MgExternalConnection
Syntax
Update-MgBetaExternalConnection
-ExternalConnectionId <String>
[-ResponseHeadersVariable <String>]
[-ActivitySettings <IMicrosoftGraphExternalConnectorsActivitySettings>]
[-AdditionalProperties <Hashtable>]
[-ComplianceSettings <IMicrosoftGraphExternalConnectorsComplianceSettings>]
[-Configuration <IMicrosoftGraphExternalConnectorsConfiguration>]
[-ConnectorId <String>]
[-Description <String>]
[-EnabledContentExperiences <String>]
[-Groups <IMicrosoftGraphExternalConnectorsExternalGroup[]>]
[-Id <String>]
[-IngestedItemsCount <Int64>]
[-Items <IMicrosoftGraphExternalConnectorsExternalItem[]>]
[-Name <String>]
[-Operations <IMicrosoftGraphExternalConnectorsConnectionOperation[]>]
[-Quota <IMicrosoftGraphExternalConnectorsConnectionQuota>]
[-Schema <IMicrosoftGraphExternalConnectorsSchema>]
[-SearchSettings <IMicrosoftGraphExternalConnectorsSearchSettings>]
[-State <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Update-MgBetaExternalConnection
-ExternalConnectionId <String>
-BodyParameter <IMicrosoftGraphExternalConnectorsExternalConnection>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Update-MgBetaExternalConnection
-InputObject <ISearchIdentity>
[-ResponseHeadersVariable <String>]
[-ActivitySettings <IMicrosoftGraphExternalConnectorsActivitySettings>]
[-AdditionalProperties <Hashtable>]
[-ComplianceSettings <IMicrosoftGraphExternalConnectorsComplianceSettings>]
[-Configuration <IMicrosoftGraphExternalConnectorsConfiguration>]
[-ConnectorId <String>]
[-Description <String>]
[-EnabledContentExperiences <String>]
[-Groups <IMicrosoftGraphExternalConnectorsExternalGroup[]>]
[-Id <String>]
[-IngestedItemsCount <Int64>]
[-Items <IMicrosoftGraphExternalConnectorsExternalItem[]>]
[-Name <String>]
[-Operations <IMicrosoftGraphExternalConnectorsConnectionOperation[]>]
[-Quota <IMicrosoftGraphExternalConnectorsConnectionQuota>]
[-Schema <IMicrosoftGraphExternalConnectorsSchema>]
[-SearchSettings <IMicrosoftGraphExternalConnectorsSearchSettings>]
[-State <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Update-MgBetaExternalConnection
-InputObject <ISearchIdentity>
-BodyParameter <IMicrosoftGraphExternalConnectorsExternalConnection>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
Update the properties of an externalConnection.
Permissions
| Permission type | Least privileged permissions | Higher privileged permissions |
|---|---|---|
| Delegated (work or school account) | ExternalConnection.ReadWrite.OwnedBy | ExternalConnection.ReadWrite.All |
| Delegated (personal Microsoft account) | Not supported. | Not supported. |
| Application | ExternalConnection.ReadWrite.OwnedBy | ExternalConnection.ReadWrite.All |
Examples
Example 1: Code snippet
Import-Module Microsoft.Graph.Beta.Search
$params = @{
name = "Contoso HR Service Tickets"
description = "Connection to index HR service tickets"
}
Update-MgBetaExternalConnection -ExternalConnectionId $externalConnectionId -BodyParameter $paramsThis example shows how to use the Update-MgBetaExternalConnection Cmdlet.
Parameters
-ActivitySettings
activitySettings To construct, see NOTES section for ACTIVITYSETTINGS properties and create a hash table.
| Type: | IMicrosoftGraphExternalConnectorsActivitySettings |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AdditionalProperties
Additional Parameters
| Type: | Hashtable |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-BodyParameter
externalConnection To construct, see NOTES section for BODYPARAMETER properties and create a hash table.
| Type: | IMicrosoftGraphExternalConnectorsExternalConnection |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ComplianceSettings
complianceSettings To construct, see NOTES section for COMPLIANCESETTINGS properties and create a hash table.
| Type: | IMicrosoftGraphExternalConnectorsComplianceSettings |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Configuration
configuration To construct, see NOTES section for CONFIGURATION properties and create a hash table.
| Type: | IMicrosoftGraphExternalConnectorsConfiguration |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ConnectorId
The Teams App ID. Optional.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Description
Description of the connection displayed in the Microsoft 365 admin center. Optional.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-EnabledContentExperiences
contentExperienceType
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ExternalConnectionId
The unique identifier of externalConnection
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Groups
. To construct, see NOTES section for GROUPS properties and create a hash table.
| Type: | IMicrosoftGraphExternalConnectorsExternalGroup[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Headers
Optional headers that will be added to the request.
| Type: | IDictionary |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Id
The unique identifier for an entity. Read-only.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-IngestedItemsCount
The number of items ingested into a connection. This value is refreshed every 15 minutes. If the connection state is draft, then ingestedItemsCount will be null.
| Type: | Int64 |
| Position: | Named |
| Default value: | 0 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
| Type: | ISearchIdentity |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Items
. To construct, see NOTES section for ITEMS properties and create a hash table.
| Type: | IMicrosoftGraphExternalConnectorsExternalItem[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
The display name of the connection to be displayed in the Microsoft 365 admin center. Maximum length of 128 characters. Required.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Operations
. To construct, see NOTES section for OPERATIONS properties and create a hash table.
| Type: | IMicrosoftGraphExternalConnectorsConnectionOperation[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ProgressAction
{{ Fill ProgressAction Description }}
| Type: | ActionPreference |
| Aliases: | proga |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Quota
connectionQuota To construct, see NOTES section for QUOTA properties and create a hash table.
| Type: | IMicrosoftGraphExternalConnectorsConnectionQuota |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResponseHeadersVariable
Optional Response Headers Variable.
| Type: | String |
| Aliases: | RHV |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Schema
schema To construct, see NOTES section for SCHEMA properties and create a hash table.
| Type: | IMicrosoftGraphExternalConnectorsSchema |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SearchSettings
searchSettings To construct, see NOTES section for SEARCHSETTINGS properties and create a hash table.
| Type: | IMicrosoftGraphExternalConnectorsSearchSettings |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-State
connectionState
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphExternalConnectorsExternalConnection
Microsoft.Graph.Beta.PowerShell.Models.ISearchIdentity
System.Collections.IDictionary
Outputs
Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphExternalConnectorsExternalConnection
Notes
COMPLEX PARAMETER PROPERTIES
To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.
ACTIVITYSETTINGS <IMicrosoftGraphExternalConnectorsActivitySettings>: activitySettings
[(Any) <Object>]: This indicates any property can be added to this object.[UrlToItemResolvers <IMicrosoftGraphExternalConnectorsUrlToItemResolverBase-[]>]: Specifies configurations to identify an externalItem based on a shared URL.[Priority <Int32?>]: The priority which defines the sequence in which the urlToItemResolverBase instances are evaluated.
BODYPARAMETER <IMicrosoftGraphExternalConnectorsExternalConnection>: externalConnection
[(Any) <Object>]: This indicates any property can be added to this object.[Id <String>]: The unique identifier for an entity. Read-only.[ActivitySettings <IMicrosoftGraphExternalConnectorsActivitySettings>]: activitySettings[(Any) <Object>]: This indicates any property can be added to this object.[UrlToItemResolvers <IMicrosoftGraphExternalConnectorsUrlToItemResolverBase-[]>]: Specifies configurations to identify an externalItem based on a shared URL.[Priority <Int32?>]: The priority which defines the sequence in which the urlToItemResolverBase instances are evaluated.
[ComplianceSettings <IMicrosoftGraphExternalConnectorsComplianceSettings>]: complianceSettings[(Any) <Object>]: This indicates any property can be added to this object.[EDiscoveryResultTemplates <IMicrosoftGraphExternalConnectorsDisplayTemplate-[]>]:[Id <String>]: The text identifier for the display template; for example, contosoTickets. Maximum 16 characters. Only alphanumeric characters allowed.[Layout <IMicrosoftGraphJson>]: Json[(Any) <Object>]: This indicates any property can be added to this object.
[Priority <Int32?>]: Defines the priority of a display template. A display template with priority 1 is evaluated before a template with priority 4. Gaps in priority values are supported. Must be positive value.[Rules <IMicrosoftGraphExternalConnectorsPropertyRule-[]>]: Specifies additional rules for selecting this display template based on the item schema. Optional.[Operation <String>]: ruleOperation[Property <String>]: The property from the externalItem schema. Required.[Values <String-[]>]: A collection with one or many strings. One or more specified strings are matched with the specified property using the specified operation. Required.[ValuesJoinedBy <String>]: binaryOperator
[Configuration <IMicrosoftGraphExternalConnectorsConfiguration>]: configuration[(Any) <Object>]: This indicates any property can be added to this object.[AuthorizedAppIds <String-[]>]: A collection of application IDs for registered Microsoft Entra apps that are allowed to manage the externalConnection and to index content in the externalConnection.
[ConnectorId <String>]: The Teams App ID. Optional.[Description <String>]: Description of the connection displayed in the Microsoft 365 admin center. Optional.[EnabledContentExperiences <String>]: contentExperienceType[Groups <IMicrosoftGraphExternalConnectorsExternalGroup-[]>]:[Id <String>]: The unique identifier for an entity. Read-only.[Description <String>]: The description of the external group. Optional.[DisplayName <String>]: The friendly name of the external group. Optional.[Members <IMicrosoftGraphExternalConnectorsIdentity-[]>]: A member added to an externalGroup. You can add Microsoft Entra users, Microsoft Entra groups, or other externalGroups as members.[Id <String>]: The unique identifier for an entity. Read-only.[Type <String>]: identityType
[IngestedItemsCount <Int64?>]: The number of items ingested into a connection. This value is refreshed every 15 minutes. If the connection state is draft, then ingestedItemsCount will be null.[Items <IMicrosoftGraphExternalConnectorsExternalItem-[]>]:[Id <String>]: The unique identifier for an entity. Read-only.[Acl <IMicrosoftGraphExternalConnectorsAcl-[]>]: An array of access control entries. Each entry specifies the access granted to a user or group. Required.[AccessType <String>]: accessType[IdentitySource <String>]: identitySourceType[Type <String>]: aclType[Value <String>]: The unique identifer of the identity. For Microsoft Entra identities, value is set to the object identifier of the user, group or tenant for types user, group and everyone (and everyoneExceptGuests) respectively. For external groups, value is set to the ID of the externalGroup.
[Activities <IMicrosoftGraphExternalConnectorsExternalActivity-[]>]: Returns a list of activities performed on the item. Write-only.[Id <String>]: The unique identifier for an entity. Read-only.[PerformedBy <IMicrosoftGraphExternalConnectorsIdentity>]: identity[StartDateTime <DateTime?>]: The date and time when the particular activity occurred. The DateTimeOffset 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.[Type <String>]: externalActivityType
[Content <IMicrosoftGraphExternalConnectorsExternalItemContent>]: externalItemContent[(Any) <Object>]: This indicates any property can be added to this object.[Type <String>]: externalItemContentType[Value <String>]: The content for the externalItem. Required.
[Properties <IMicrosoftGraphExternalConnectorsProperties>]: properties[(Any) <Object>]: This indicates any property can be added to this object.
[Name <String>]: The display name of the connection to be displayed in the Microsoft 365 admin center. Maximum length of 128 characters. Required.[Operations <IMicrosoftGraphExternalConnectorsConnectionOperation-[]>]:[Id <String>]: The unique identifier for an entity. Read-only.[Error <IMicrosoftGraphPublicError>]: publicError[(Any) <Object>]: This indicates any property can be added to this object.[Code <String>]: Represents the error code.[Details <IMicrosoftGraphPublicErrorDetail-[]>]: Details of the error.[Code <String>]: The error code.[Message <String>]: The error message.[Target <String>]: The target of the error.
[InnerError <IMicrosoftGraphPublicInnerError>]: publicInnerError[(Any) <Object>]: This indicates any property can be added to this object.[Code <String>]: The error code.[Details <IMicrosoftGraphPublicErrorDetail-[]>]: A collection of error details.[Message <String>]: The error message.[Target <String>]: The target of the error.
[Message <String>]: A non-localized message for the developer.[Target <String>]: The target of the error.
[Status <String>]: connectionOperationStatus
[Quota <IMicrosoftGraphExternalConnectorsConnectionQuota>]: connectionQuota[(Any) <Object>]: This indicates any property can be added to this object.[Id <String>]: The unique identifier for an entity. Read-only.[ItemsRemaining <Int64?>]: The minimum of two values, one representing the items remaining in the connection and the other remaining items at tenant-level. The following equation represents the formula used to calculate the minimum number: min ({max capacity in the connection} - {number of items in the connection}, {tenant quota} - {number of items indexed in all connections}). If the connection is not monetized, such as in a preview connector or preview content experience, then this property is simply the number of remaining items in the connection.
[Schema <IMicrosoftGraphExternalConnectorsSchema>]: schema[(Any) <Object>]: This indicates any property can be added to this object.[Id <String>]: The unique identifier for an entity. Read-only.[BaseType <String>]: Must be set to microsoft.graph.externalItem. Required.[Properties <IMicrosoftGraphExternalConnectorsProperty-[]>]: The properties defined for the items in the connection. The minimum number of properties is one, the maximum is 128.[Aliases <String-[]>]: A set of aliases or friendly names for the property. Maximum 32 characters. Only alphanumeric characters allowed. For example, each string might not contain control characters, whitespace, or any of the following: :, ;, ,, (, ), -[, ], {, }, %, $, +, !, *, =, &, ?, @, #, /, ~, ', ', <, >, `, ^. Optional.[IsExactMatchRequired <Boolean?>]: Specifies if the property will be matched exactly for queries. Exact matching can only be set to true for non-searchable properties of type string or stringCollection. Optional.[IsQueryable <Boolean?>]: Specifies if the property is queryable. Queryable properties can be used in Keyword Query Language (KQL) queries. Optional.[IsRefinable <Boolean?>]: Specifies if the property is refinable. Refinable properties can be used to filter search results in the Search API and add a refiner control in the Microsoft Search user experience. Optional.[IsRetrievable <Boolean?>]: Specifies if the property is retrievable. Retrievable properties are returned in the result set when items are returned by the search API. Retrievable properties are also available to add to the display template used to render search results. Optional.[IsSearchable <Boolean?>]: Specifies if the property is searchable. Only properties of type string or stringCollection can be searchable. Non-searchable properties aren't added to the search index. Optional.[Labels <String-[]>]: Specifies one or more well-known tags added against a property. Labels help Microsoft Search understand the semantics of the data in the connection. Adding appropriate labels would result in an enhanced search experience (for example, better relevance). Optional.The possible values are: title, url, createdBy, lastModifiedBy, authors, createdDateTime, lastModifiedDateTime, fileName, fileExtension, unknownFutureValue, containerName, containerUrl, iconUrl. You must use the Prefer: include-unknown-enum-members request header to get the following values in this evolvable enum: containerName, containerUrl, iconUrl.[Name <String>]: The name of the property. Maximum 32 characters. Only alphanumeric characters allowed. For example, the property name may not contain control characters, whitespace, or any of the following: :, ;, ,, (, ), -[, ], {, }, %, $, +, !, *, =, &, ?, @, #, /, ~, ', ', <, >, `, ^. Required.[RankingHint <IMicrosoftGraphExternalConnectorsRankingHint>]: rankingHint[(Any) <Object>]: This indicates any property can be added to this object.[ImportanceScore <String>]: importanceScore
[Type <String>]: propertyType
[SearchSettings <IMicrosoftGraphExternalConnectorsSearchSettings>]: searchSettings[(Any) <Object>]: This indicates any property can be added to this object.[SearchResultTemplates <IMicrosoftGraphExternalConnectorsDisplayTemplate-[]>]: Enables the developer to define the appearance of the content and configure conditions that dictate when the template should be displayed. Maximum of 2 search result templates per connection.
[State <String>]: connectionState
COMPLIANCESETTINGS <IMicrosoftGraphExternalConnectorsComplianceSettings>: complianceSettings
[(Any) <Object>]: This indicates any property can be added to this object.[EDiscoveryResultTemplates <IMicrosoftGraphExternalConnectorsDisplayTemplate-[]>]:[Id <String>]: The text identifier for the display template; for example, contosoTickets. Maximum 16 characters. Only alphanumeric characters allowed.[Layout <IMicrosoftGraphJson>]: Json[(Any) <Object>]: This indicates any property can be added to this object.
[Priority <Int32?>]: Defines the priority of a display template. A display template with priority 1 is evaluated before a template with priority 4. Gaps in priority values are supported. Must be positive value.[Rules <IMicrosoftGraphExternalConnectorsPropertyRule-[]>]: Specifies additional rules for selecting this display template based on the item schema. Optional.[Operation <String>]: ruleOperation[Property <String>]: The property from the externalItem schema. Required.[Values <String-[]>]: A collection with one or many strings. One or more specified strings are matched with the specified property using the specified operation. Required.[ValuesJoinedBy <String>]: binaryOperator
CONFIGURATION <IMicrosoftGraphExternalConnectorsConfiguration>: configuration
[(Any) <Object>]: This indicates any property can be added to this object.[AuthorizedAppIds <String-[]>]: A collection of application IDs for registered Microsoft Entra apps that are allowed to manage the externalConnection and to index content in the externalConnection.
GROUPS <IMicrosoftGraphExternalConnectorsExternalGroup- []>: .
[Id <String>]: The unique identifier for an entity. Read-only.[Description <String>]: The description of the external group. Optional.[DisplayName <String>]: The friendly name of the external group. Optional.[Members <IMicrosoftGraphExternalConnectorsIdentity-[]>]: A member added to an externalGroup. You can add Microsoft Entra users, Microsoft Entra groups, or other externalGroups as members.[Id <String>]: The unique identifier for an entity. Read-only.[Type <String>]: identityType
INPUTOBJECT <ISearchIdentity>: Identity Parameter
[AcronymId <String>]: The unique identifier of acronym[AuthorizationSystemId <String>]: The unique identifier of authorizationSystem[BookmarkId <String>]: The unique identifier of bookmark[ConnectionOperationId <String>]: The unique identifier of connectionOperation[ExternalActivityId <String>]: The unique identifier of externalActivity[ExternalConnectionId <String>]: The unique identifier of externalConnection[ExternalGroupId <String>]: The unique identifier of externalGroup[ExternalItemId <String>]: The unique identifier of externalItem[IdentityId <String>]: The unique identifier of identity[InboundFlowId <String>]: The unique identifier of inboundFlow[IndustryDataConnectorId <String>]: The unique identifier of industryDataConnector[IndustryDataRunActivityId <String>]: The unique identifier of industryDataRunActivity[IndustryDataRunId <String>]: The unique identifier of industryDataRun[LongRunningOperationId <String>]: The unique identifier of longRunningOperation[OutboundProvisioningFlowSetId <String>]: The unique identifier of outboundProvisioningFlowSet[ProvisioningFlowId <String>]: The unique identifier of provisioningFlow[QnaId <String>]: The unique identifier of qna[ReferenceDefinitionId <String>]: The unique identifier of referenceDefinition[RoleGroupId <String>]: The unique identifier of roleGroup[SourceSystemDefinitionId <String>]: The unique identifier of sourceSystemDefinition[YearTimePeriodDefinitionId <String>]: The unique identifier of yearTimePeriodDefinition
ITEMS <IMicrosoftGraphExternalConnectorsExternalItem- []>: .
[Id <String>]: The unique identifier for an entity. Read-only.[Acl <IMicrosoftGraphExternalConnectorsAcl-[]>]: An array of access control entries. Each entry specifies the access granted to a user or group. Required.[AccessType <String>]: accessType[IdentitySource <String>]: identitySourceType[Type <String>]: aclType[Value <String>]: The unique identifer of the identity. For Microsoft Entra identities, value is set to the object identifier of the user, group or tenant for types user, group and everyone (and everyoneExceptGuests) respectively. For external groups, value is set to the ID of the externalGroup.
[Activities <IMicrosoftGraphExternalConnectorsExternalActivity-[]>]: Returns a list of activities performed on the item. Write-only.[Id <String>]: The unique identifier for an entity. Read-only.[PerformedBy <IMicrosoftGraphExternalConnectorsIdentity>]: identity[(Any) <Object>]: This indicates any property can be added to this object.[Id <String>]: The unique identifier for an entity. Read-only.[Type <String>]: identityType
[StartDateTime <DateTime?>]: The date and time when the particular activity occurred. The DateTimeOffset 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.[Type <String>]: externalActivityType
[Content <IMicrosoftGraphExternalConnectorsExternalItemContent>]: externalItemContent[(Any) <Object>]: This indicates any property can be added to this object.[Type <String>]: externalItemContentType[Value <String>]: The content for the externalItem. Required.
[Properties <IMicrosoftGraphExternalConnectorsProperties>]: properties[(Any) <Object>]: This indicates any property can be added to this object.
OPERATIONS <IMicrosoftGraphExternalConnectorsConnectionOperation- []>: .
[Id <String>]: The unique identifier for an entity. Read-only.[Error <IMicrosoftGraphPublicError>]: publicError[(Any) <Object>]: This indicates any property can be added to this object.[Code <String>]: Represents the error code.[Details <IMicrosoftGraphPublicErrorDetail-[]>]: Details of the error.[Code <String>]: The error code.[Message <String>]: The error message.[Target <String>]: The target of the error.
[InnerError <IMicrosoftGraphPublicInnerError>]: publicInnerError[(Any) <Object>]: This indicates any property can be added to this object.[Code <String>]: The error code.[Details <IMicrosoftGraphPublicErrorDetail-[]>]: A collection of error details.[Message <String>]: The error message.[Target <String>]: The target of the error.
[Message <String>]: A non-localized message for the developer.[Target <String>]: The target of the error.
[Status <String>]: connectionOperationStatus
QUOTA <IMicrosoftGraphExternalConnectorsConnectionQuota>: connectionQuota
[(Any) <Object>]: This indicates any property can be added to this object.[Id <String>]: The unique identifier for an entity. Read-only.[ItemsRemaining <Int64?>]: The minimum of two values, one representing the items remaining in the connection and the other remaining items at tenant-level. The following equation represents the formula used to calculate the minimum number: min ({max capacity in the connection} - {number of items in the connection}, {tenant quota} - {number of items indexed in all connections}). If the connection is not monetized, such as in a preview connector or preview content experience, then this property is simply the number of remaining items in the connection.
SCHEMA <IMicrosoftGraphExternalConnectorsSchema>: schema
[(Any) <Object>]: This indicates any property can be added to this object.[Id <String>]: The unique identifier for an entity. Read-only.[BaseType <String>]: Must be set to microsoft.graph.externalItem. Required.[Properties <IMicrosoftGraphExternalConnectorsProperty-[]>]: The properties defined for the items in the connection. The minimum number of properties is one, the maximum is 128.[Aliases <String-[]>]: A set of aliases or friendly names for the property. Maximum 32 characters. Only alphanumeric characters allowed. For example, each string might not contain control characters, whitespace, or any of the following: :, ;, ,, (, ), -[, ], {, }, %, $, +, !, *, =, &, ?, @, #, /, ~, ', ', <, >, `, ^. Optional.[IsExactMatchRequired <Boolean?>]: Specifies if the property will be matched exactly for queries. Exact matching can only be set to true for non-searchable properties of type string or stringCollection. Optional.[IsQueryable <Boolean?>]: Specifies if the property is queryable. Queryable properties can be used in Keyword Query Language (KQL) queries. Optional.[IsRefinable <Boolean?>]: Specifies if the property is refinable. Refinable properties can be used to filter search results in the Search API and add a refiner control in the Microsoft Search user experience. Optional.[IsRetrievable <Boolean?>]: Specifies if the property is retrievable. Retrievable properties are returned in the result set when items are returned by the search API. Retrievable properties are also available to add to the display template used to render search results. Optional.[IsSearchable <Boolean?>]: Specifies if the property is searchable. Only properties of type string or stringCollection can be searchable. Non-searchable properties aren't added to the search index. Optional.[Labels <String-[]>]: Specifies one or more well-known tags added against a property. Labels help Microsoft Search understand the semantics of the data in the connection. Adding appropriate labels would result in an enhanced search experience (for example, better relevance). Optional.The possible values are: title, url, createdBy, lastModifiedBy, authors, createdDateTime, lastModifiedDateTime, fileName, fileExtension, unknownFutureValue, containerName, containerUrl, iconUrl. You must use the Prefer: include-unknown-enum-members request header to get the following values in this evolvable enum: containerName, containerUrl, iconUrl.[Name <String>]: The name of the property. Maximum 32 characters. Only alphanumeric characters allowed. For example, the property name may not contain control characters, whitespace, or any of the following: :, ;, ,, (, ), -[, ], {, }, %, $, +, !, *, =, &, ?, @, #, /, ~, ', ', <, >, `, ^. Required.[RankingHint <IMicrosoftGraphExternalConnectorsRankingHint>]: rankingHint[(Any) <Object>]: This indicates any property can be added to this object.[ImportanceScore <String>]: importanceScore
[Type <String>]: propertyType
SEARCHSETTINGS <IMicrosoftGraphExternalConnectorsSearchSettings>: searchSettings
[(Any) <Object>]: This indicates any property can be added to this object.[SearchResultTemplates <IMicrosoftGraphExternalConnectorsDisplayTemplate-[]>]: Enables the developer to define the appearance of the content and configure conditions that dictate when the template should be displayed. Maximum of 2 search result templates per connection.[Id <String>]: The text identifier for the display template; for example, contosoTickets. Maximum 16 characters. Only alphanumeric characters allowed.[Layout <IMicrosoftGraphJson>]: Json[(Any) <Object>]: This indicates any property can be added to this object.
[Priority <Int32?>]: Defines the priority of a display template. A display template with priority 1 is evaluated before a template with priority 4. Gaps in priority values are supported. Must be positive value.[Rules <IMicrosoftGraphExternalConnectorsPropertyRule-[]>]: Specifies additional rules for selecting this display template based on the item schema. Optional.[Operation <String>]: ruleOperation[Property <String>]: The property from the externalItem schema. Required.[Values <String-[]>]: A collection with one or many strings. One or more specified strings are matched with the specified property using the specified operation. Required.[ValuesJoinedBy <String>]: binaryOperator