Share via


Update-MgBetaExternalIndustryDataInboundFlow

Update the properties of an inboundApiFlow object.

Syntax

UpdateExpanded (Default)

Update-MgBetaExternalIndustryDataInboundFlow
    -InboundFlowId <string>
    [-ResponseHeadersVariable <string>]
    [-AdditionalProperties <hashtable>]
    [-DataConnector <IMicrosoftGraphIndustryDataConnector>]
    [-DataDomain <string>]
    [-DisplayName <string>]
    [-EffectiveDateTime <datetime>]
    [-ExpirationDateTime <datetime>]
    [-Id <string>]
    [-ReadinessStatus <string>]
    [-Year <IMicrosoftGraphIndustryDataYearTimePeriodDefinition>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Update

Update-MgBetaExternalIndustryDataInboundFlow
    -InboundFlowId <string>
    -BodyParameter <IMicrosoftGraphIndustryDataInboundFlow>
    [-ResponseHeadersVariable <string>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

UpdateViaIdentityExpanded

Update-MgBetaExternalIndustryDataInboundFlow
    -InputObject <ISearchIdentity>
    [-ResponseHeadersVariable <string>]
    [-AdditionalProperties <hashtable>]
    [-DataConnector <IMicrosoftGraphIndustryDataConnector>]
    [-DataDomain <string>]
    [-DisplayName <string>]
    [-EffectiveDateTime <datetime>]
    [-ExpirationDateTime <datetime>]
    [-Id <string>]
    [-ReadinessStatus <string>]
    [-Year <IMicrosoftGraphIndustryDataYearTimePeriodDefinition>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

UpdateViaIdentity

Update-MgBetaExternalIndustryDataInboundFlow
    -InputObject <ISearchIdentity>
    -BodyParameter <IMicrosoftGraphIndustryDataInboundFlow>
    [-ResponseHeadersVariable <string>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Update the properties of an inboundApiFlow object.

Permissions

Permission type Permissions (from least to most privileged)
Delegated (work or school account) IndustryData-InboundFlow.ReadWrite.All,
Delegated (personal Microsoft account) Not supported
Application IndustryData-InboundFlow.ReadWrite.All,

Examples

Example 1: Code snippet


Import-Module Microsoft.Graph.Beta.Search

$params = @{
	"@odata.type" = "#microsoft.graph.industryData.inboundFileFlow"
	displayName = "Updated flow name"
}

Update-MgBetaExternalIndustryDataInboundFlow -InboundFlowId $inboundFlowId -BodyParameter $params

This example shows how to use the Update-MgBetaExternalIndustryDataInboundFlow Cmdlet.

Parameters

-AdditionalProperties

Additional Parameters

Parameter properties

Type:System.Collections.Hashtable
Supports wildcards:False
DontShow:False

Parameter sets

UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-BodyParameter

inboundFlow To construct, see NOTES section for BODYPARAMETER properties and create a hash table.

Parameter properties

Type:Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphIndustryDataInboundFlow
Supports wildcards:False
DontShow:False

Parameter sets

UpdateViaIdentity
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False
Update
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Break

Wait for .NET debugger to attach

Parameter properties

Type:System.Management.Automation.SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:System.Management.Automation.SwitchParameter
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DataConnector

industryDataConnector To construct, see NOTES section for DATACONNECTOR properties and create a hash table.

Parameter properties

Type:Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphIndustryDataConnector
Supports wildcards:False
DontShow:False

Parameter sets

UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DataDomain

inboundDomain

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False

Parameter sets

UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DisplayName

The name of the activity. Maximum supported length is 100 characters.

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False

Parameter sets

UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-EffectiveDateTime

The start of the time window when the flow is allowed to run. 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.

Parameter properties

Type:System.DateTime
Supports wildcards:False
DontShow:False

Parameter sets

UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ExpirationDateTime

The end of the time window when the flow is allowed to run. 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.

Parameter properties

Type:System.DateTime
Supports wildcards:False
DontShow:False

Parameter sets

UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Headers

Optional headers that will be added to the request.

Parameter properties

Type:System.Collections.IDictionary
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-HttpPipelineAppend

SendAsync Pipeline Steps to be appended to the front of the pipeline

Parameter properties

Type:

Microsoft.Graph.Beta.PowerShell.Runtime.SendAsyncStep[]

Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-HttpPipelinePrepend

SendAsync Pipeline Steps to be prepended to the front of the pipeline

Parameter properties

Type:

Microsoft.Graph.Beta.PowerShell.Runtime.SendAsyncStep[]

Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Id

The unique identifier for an entity. Read-only.

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False

Parameter sets

UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InboundFlowId

The unique identifier of inboundFlow

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Update
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Parameter properties

Type:Microsoft.Graph.Beta.PowerShell.Models.ISearchIdentity
Supports wildcards:False
DontShow:False

Parameter sets

UpdateViaIdentityExpanded
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentity
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Proxy

The URI for the proxy server to use

Parameter properties

Type:System.Uri
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ProxyCredential

Credentials for a proxy server to use for the remote call

Parameter properties

Type:System.Management.Automation.PSCredential
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ProxyUseDefaultCredentials

Use the default credentials for the proxy

Parameter properties

Type:System.Management.Automation.SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ReadinessStatus

readinessStatus

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False

Parameter sets

UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResponseHeadersVariable

Optional Response Headers Variable.

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False
Aliases:RHV

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Runs the command in a mode that only reports what would happen without performing the actions.

Parameter properties

Type:System.Management.Automation.SwitchParameter
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Year

yearTimePeriodDefinition To construct, see NOTES section for YEAR properties and create a hash table.

Parameter properties

Type:Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphIndustryDataYearTimePeriodDefinition
Supports wildcards:False
DontShow:False

Parameter sets

UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphIndustryDataInboundFlow

{{ Fill in the Description }}

Microsoft.Graph.Beta.PowerShell.Models.ISearchIdentity

{{ Fill in the Description }}

System.Collections.IDictionary

{{ Fill in the Description }}

Outputs

Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphIndustryDataInboundFlow

{{ Fill in the Description }}

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.

BODYPARAMETER <IMicrosoftGraphIndustryDataInboundFlow>: inboundFlow [(Any) <Object>]: This indicates any property can be added to this object. [DisplayName <String>]: The name of the activity. Maximum supported length is 100 characters. [ReadinessStatus <String>]: readinessStatus [Id <String>]: The unique identifier for an entity. Read-only. [DataConnector <IMicrosoftGraphIndustryDataConnector>]: industryDataConnector [(Any) <Object>]: This indicates any property can be added to this object. [Id <String>]: The unique identifier for an entity. Read-only. [DisplayName <String>]: The name of the data connector. Maximum supported length is 100 characters. [SourceSystem <IMicrosoftGraphIndustryDataSourceSystemDefinition>]: sourceSystemDefinition [(Any) <Object>]: This indicates any property can be added to this object. [Id <String>]: The unique identifier for an entity. Read-only. [DisplayName <String>]: The name of the source system. Maximum supported length is 100 characters. [UserMatchingSettings <IMicrosoftGraphIndustryDataUserMatchingSetting[]>]: A collection of user matching settings by roleGroup. [MatchTarget <IMicrosoftGraphIndustryDataUserMatchTargetReferenceValue>]: userMatchTargetReferenceValue [(Any) <Object>]: This indicates any property can be added to this object. [Code <String>]: The code of the desired referenceDefinition entry. [Value <IMicrosoftGraphIndustryDataReferenceDefinition>]: referenceDefinition [(Any) <Object>]: This indicates any property can be added to this object. [Id <String>]: The unique identifier for an entity. Read-only. [Code <String>]: The code value for the definition that must be unique within the referenceType. [DisplayName <String>]: A human-readable representation of the reference code value for display in a user interface. [IsDisabled <Boolean?>]: Indicates whether the definition is disabled. [ReferenceType <String>]: The categorical type for a collection of enumerated values. [SortIndex <Int32?>]: The index that specifies the order in which to present the definition to the user. Must be unique within the referenceType. [PriorityOrder <Int32?>]: The priority order to apply when a user has multiple RefRole codes assigned. [RoleGroup <IMicrosoftGraphIndustryDataRoleGroup>]: roleGroup [(Any) <Object>]: This indicates any property can be added to this object. [Id <String>]: The unique identifier for an entity. Read-only. [DisplayName <String>]: The name of the role group. [Roles <IMicrosoftGraphIndustryDataRoleReferenceValue[]>]: The set of roles included in the role group. [Code <String>]: The code of the desired referenceDefinition entry. [Value <IMicrosoftGraphIndustryDataReferenceDefinition>]: referenceDefinition [SourceIdentifier <IMicrosoftGraphIndustryDataIdentifierTypeReferenceValue>]: identifierTypeReferenceValue [(Any) <Object>]: This indicates any property can be added to this object. [Code <String>]: The code of the desired referenceDefinition entry. [Value <IMicrosoftGraphIndustryDataReferenceDefinition>]: referenceDefinition [Vendor <String>]: The name of the vendor who supplies the source system. Maximum supported length is 100 characters. [DataDomain <String>]: inboundDomain [EffectiveDateTime <DateTime?>]: The start of the time window when the flow is allowed to run. 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. [ExpirationDateTime <DateTime?>]: The end of the time window when the flow is allowed to run. 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. [Year <IMicrosoftGraphIndustryDataYearTimePeriodDefinition>]: yearTimePeriodDefinition [(Any) <Object>]: This indicates any property can be added to this object. [Id <String>]: The unique identifier for an entity. Read-only. [DisplayName <String>]: The name of the year. Maximum supported length is 100 characters. [EndDate <DateTime?>]: The last day of the year using ISO 8601 format for date. [StartDate <DateTime?>]: The first day of the year using ISO 8601 format for date. [Year <IMicrosoftGraphIndustryDataYearReferenceValue>]: yearReferenceValue [(Any) <Object>]: This indicates any property can be added to this object. [Code <String>]: The code of the desired referenceDefinition entry. [Value <IMicrosoftGraphIndustryDataReferenceDefinition>]: referenceDefinition

DATACONNECTOR <IMicrosoftGraphIndustryDataConnector>: industryDataConnector [(Any) <Object>]: This indicates any property can be added to this object. [Id <String>]: The unique identifier for an entity. Read-only. [DisplayName <String>]: The name of the data connector. Maximum supported length is 100 characters. [SourceSystem <IMicrosoftGraphIndustryDataSourceSystemDefinition>]: sourceSystemDefinition [(Any) <Object>]: This indicates any property can be added to this object. [Id <String>]: The unique identifier for an entity. Read-only. [DisplayName <String>]: The name of the source system. Maximum supported length is 100 characters. [UserMatchingSettings <IMicrosoftGraphIndustryDataUserMatchingSetting[]>]: A collection of user matching settings by roleGroup. [MatchTarget <IMicrosoftGraphIndustryDataUserMatchTargetReferenceValue>]: userMatchTargetReferenceValue [(Any) <Object>]: This indicates any property can be added to this object. [Code <String>]: The code of the desired referenceDefinition entry. [Value <IMicrosoftGraphIndustryDataReferenceDefinition>]: referenceDefinition [(Any) <Object>]: This indicates any property can be added to this object. [Id <String>]: The unique identifier for an entity. Read-only. [Code <String>]: The code value for the definition that must be unique within the referenceType. [DisplayName <String>]: A human-readable representation of the reference code value for display in a user interface. [IsDisabled <Boolean?>]: Indicates whether the definition is disabled. [ReferenceType <String>]: The categorical type for a collection of enumerated values. [SortIndex <Int32?>]: The index that specifies the order in which to present the definition to the user. Must be unique within the referenceType. [PriorityOrder <Int32?>]: The priority order to apply when a user has multiple RefRole codes assigned. [RoleGroup <IMicrosoftGraphIndustryDataRoleGroup>]: roleGroup [(Any) <Object>]: This indicates any property can be added to this object. [Id <String>]: The unique identifier for an entity. Read-only. [DisplayName <String>]: The name of the role group. [Roles <IMicrosoftGraphIndustryDataRoleReferenceValue[]>]: The set of roles included in the role group. [Code <String>]: The code of the desired referenceDefinition entry. [Value <IMicrosoftGraphIndustryDataReferenceDefinition>]: referenceDefinition [SourceIdentifier <IMicrosoftGraphIndustryDataIdentifierTypeReferenceValue>]: identifierTypeReferenceValue [(Any) <Object>]: This indicates any property can be added to this object. [Code <String>]: The code of the desired referenceDefinition entry. [Value <IMicrosoftGraphIndustryDataReferenceDefinition>]: referenceDefinition [Vendor <String>]: The name of the vendor who supplies the source system. Maximum supported length is 100 characters.

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

YEAR <IMicrosoftGraphIndustryDataYearTimePeriodDefinition>: yearTimePeriodDefinition [(Any) <Object>]: This indicates any property can be added to this object. [Id <String>]: The unique identifier for an entity. Read-only. [DisplayName <String>]: The name of the year. Maximum supported length is 100 characters. [EndDate <DateTime?>]: The last day of the year using ISO 8601 format for date. [StartDate <DateTime?>]: The first day of the year using ISO 8601 format for date. [Year <IMicrosoftGraphIndustryDataYearReferenceValue>]: yearReferenceValue [(Any) <Object>]: This indicates any property can be added to this object. [Code <String>]: The code of the desired referenceDefinition entry. [Value <IMicrosoftGraphIndustryDataReferenceDefinition>]: referenceDefinition [(Any) <Object>]: This indicates any property can be added to this object. [Id <String>]: The unique identifier for an entity. Read-only. [Code <String>]: The code value for the definition that must be unique within the referenceType. [DisplayName <String>]: A human-readable representation of the reference code value for display in a user interface. [IsDisabled <Boolean?>]: Indicates whether the definition is disabled. [ReferenceType <String>]: The categorical type for a collection of enumerated values. [SortIndex <Int32?>]: The index that specifies the order in which to present the definition to the user. Must be unique within the referenceType.