Update-MgEntitlementManagementSubjectByObjectId

Module:
Microsoft.Graph.Identity.Governance Module

Update an external directory user represented by an existing accessPackageSubject object to change the subject lifecycle.

Note

To view the beta release of this cmdlet, view Update-MgBetaEntitlementManagementSubjectByObjectId

Syntax

UpdateExpanded (Default) 

Update-MgEntitlementManagementSubjectByObjectId
    -ObjectId <string>
    [-ResponseHeadersVariable <string>]
    [-AdditionalProperties <hashtable>]
    [-ConnectedOrganization <IMicrosoftGraphConnectedOrganization>]
    [-DisplayName <string>]
    [-Email <string>]
    [-Id <string>]
    [-ObjectId1 <string>]
    [-OnPremisesSecurityIdentifier <string>]
    [-PrincipalName <string>]
    [-SubjectLifecycle <string>]
    [-SubjectType <string>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

UpdateViaIdentityExpanded 

Update-MgEntitlementManagementSubjectByObjectId
    -InputObject <IIdentityGovernanceIdentity>
    [-ObjectId <string>]
    [-ResponseHeadersVariable <string>]
    [-AdditionalProperties <hashtable>]
    [-ConnectedOrganization <IMicrosoftGraphConnectedOrganization>]
    [-DisplayName <string>]
    [-Email <string>]
    [-Id <string>]
    [-OnPremisesSecurityIdentifier <string>]
    [-PrincipalName <string>]
    [-SubjectLifecycle <string>]
    [-SubjectType <string>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Update 

Update-MgEntitlementManagementSubjectByObjectId
    -ObjectId <string>
    -BodyParameter <IMicrosoftGraphAccessPackageSubject>
    [-ResponseHeadersVariable <string>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

UpdateViaIdentity 

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

Description

Update an external directory user represented by an existing accessPackageSubject object to change the subject lifecycle.

Examples

Example 1: Code snippet


Import-Module Microsoft.Graph.Identity.Governance

$params = @{
	subjectLifecycle = "governed"
}

Update-MgEntitlementManagementSubjectByObjectId -BodyParameter $params -ObjectId $objectIdId

This example shows how to use the Update-MgEntitlementManagementSubjectByObjectId 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

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

Parameter properties

Type:Microsoft.Graph.PowerShell.Models.IMicrosoftGraphAccessPackageSubject
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

-ConnectedOrganization

connectedOrganization To construct, see NOTES section for CONNECTEDORGANIZATION properties and create a hash table.

Parameter properties

Type:Microsoft.Graph.PowerShell.Models.IMicrosoftGraphConnectedOrganization
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 display name of the subject.

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

-Email

The email address of the subject.

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

-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.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.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

-InputObject

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

Parameter properties

Type:Microsoft.Graph.PowerShell.Models.IIdentityGovernanceIdentity
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

-ObjectId

Alternate key of accessPackageSubject

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: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

-ObjectId1

The object identifier of the subject. null if the subject isn't yet a user in the tenant.

Parameter properties

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

Parameter sets

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

-OnPremisesSecurityIdentifier

A string representation of the principal's security identifier, if known, or null if the subject doesn't have a security identifier.

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

-PrincipalName

The principal name, if known, of the subject.

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

-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

-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

-SubjectLifecycle

accessPackageSubjectLifecycle

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

-SubjectType

accessPackageSubjectType

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

-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

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.PowerShell.Models.IIdentityGovernanceIdentity

{{ Fill in the Description }}

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphAccessPackageSubject

{{ Fill in the Description }}

System.Collections.IDictionary

{{ Fill in the Description }}

Outputs

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphAccessPackageSubject

{{ 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 <IMicrosoftGraphAccessPackageSubject>: accessPackageSubject [(Any) <Object>]: This indicates any property can be added to this object. [Id <String>]: The unique identifier for an entity. Read-only. [ConnectedOrganization <IMicrosoftGraphConnectedOrganization>]: connectedOrganization [(Any) <Object>]: This indicates any property can be added to this object. [Id <String>]: The unique identifier for an entity. Read-only. [CreatedDateTime <DateTime?>]: 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. Read-only. [Description <String>]: The description of the connected organization. [DisplayName <String>]: The display name of the connected organization. Supports $filter (eq). [ExternalSponsors <IMicrosoftGraphDirectoryObject[]>]: [Id <String>]: The unique identifier for an entity. Read-only. [DeletedDateTime <DateTime?>]: Date and time when this object was deleted. Always null when the object hasn't been deleted. [IdentitySources <IMicrosoftGraphIdentitySource[]>]: The identity sources in this connected organization, one of azureActiveDirectoryTenant, crossCloudAzureActiveDirectoryTenant, domainIdentitySource, externalDomainFederation, or socialIdentitySource. Nullable. [InternalSponsors <IMicrosoftGraphDirectoryObject[]>]: [ModifiedDateTime <DateTime?>]: 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. Read-only. [State <String>]: connectedOrganizationState [DisplayName <String>]: The display name of the subject. [Email <String>]: The email address of the subject. [ObjectId <String>]: The object identifier of the subject. null if the subject isn't yet a user in the tenant. [OnPremisesSecurityIdentifier <String>]: A string representation of the principal's security identifier, if known, or null if the subject doesn't have a security identifier. [PrincipalName <String>]: The principal name, if known, of the subject. [SubjectLifecycle <String>]: accessPackageSubjectLifecycle [SubjectType <String>]: accessPackageSubjectType

CONNECTEDORGANIZATION <IMicrosoftGraphConnectedOrganization>: connectedOrganization [(Any) <Object>]: This indicates any property can be added to this object. [Id <String>]: The unique identifier for an entity. Read-only. [CreatedDateTime <DateTime?>]: 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. Read-only. [Description <String>]: The description of the connected organization. [DisplayName <String>]: The display name of the connected organization. Supports $filter (eq). [ExternalSponsors <IMicrosoftGraphDirectoryObject[]>]: [Id <String>]: The unique identifier for an entity. Read-only. [DeletedDateTime <DateTime?>]: Date and time when this object was deleted. Always null when the object hasn't been deleted. [IdentitySources <IMicrosoftGraphIdentitySource[]>]: The identity sources in this connected organization, one of azureActiveDirectoryTenant, crossCloudAzureActiveDirectoryTenant, domainIdentitySource, externalDomainFederation, or socialIdentitySource. Nullable. [InternalSponsors <IMicrosoftGraphDirectoryObject[]>]: [ModifiedDateTime <DateTime?>]: 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. Read-only. [State <String>]: connectedOrganizationState

INPUTOBJECT <IIdentityGovernanceIdentity>: Identity Parameter [AccessPackageAssignmentId <String>]: The unique identifier of accessPackageAssignment [AccessPackageAssignmentPolicyId <String>]: The unique identifier of accessPackageAssignmentPolicy [AccessPackageAssignmentRequestId <String>]: The unique identifier of accessPackageAssignmentRequest [AccessPackageCatalogId <String>]: The unique identifier of accessPackageCatalog [AccessPackageId <String>]: The unique identifier of accessPackage [AccessPackageId1 <String>]: The unique identifier of accessPackage [AccessPackageQuestionId <String>]: The unique identifier of accessPackageQuestion [AccessPackageResourceEnvironmentId <String>]: The unique identifier of accessPackageResourceEnvironment [AccessPackageResourceId <String>]: The unique identifier of accessPackageResource [AccessPackageResourceRequestId <String>]: The unique identifier of accessPackageResourceRequest [AccessPackageResourceRoleId <String>]: The unique identifier of accessPackageResourceRole [AccessPackageResourceRoleId1 <String>]: The unique identifier of accessPackageResourceRole [AccessPackageResourceRoleScopeId <String>]: The unique identifier of accessPackageResourceRoleScope [AccessPackageResourceScopeId <String>]: The unique identifier of accessPackageResourceScope [AccessPackageResourceScopeId1 <String>]: The unique identifier of accessPackageResourceScope [AccessPackageSubjectId <String>]: The unique identifier of accessPackageSubject [AccessPackageSuggestionId <String>]: The unique identifier of accessPackageSuggestion [AccessReviewHistoryDefinitionId <String>]: The unique identifier of accessReviewHistoryDefinition [AccessReviewHistoryInstanceId <String>]: The unique identifier of accessReviewHistoryInstance [AccessReviewInstanceDecisionItemId <String>]: The unique identifier of accessReviewInstanceDecisionItem [AccessReviewInstanceId <String>]: The unique identifier of accessReviewInstance [AccessReviewReviewerId <String>]: The unique identifier of accessReviewReviewer [AccessReviewScheduleDefinitionId <String>]: The unique identifier of accessReviewScheduleDefinition [AccessReviewStageId <String>]: The unique identifier of accessReviewStage [AgreementAcceptanceId <String>]: The unique identifier of agreementAcceptance [AgreementFileLocalizationId <String>]: The unique identifier of agreementFileLocalization [AgreementFileVersionId <String>]: The unique identifier of agreementFileVersion [AgreementId <String>]: The unique identifier of agreement [AppConsentRequestId <String>]: The unique identifier of appConsentRequest [ApprovalId <String>]: The unique identifier of approval [ApprovalStageId <String>]: The unique identifier of approvalStage [AvailableAccessPackageId <String>]: The unique identifier of availableAccessPackage [ConnectedOrganizationId <String>]: The unique identifier of connectedOrganization [ControlConfigurationId <String>]: The unique identifier of controlConfiguration [CustomCalloutExtensionId <String>]: The unique identifier of customCalloutExtension [CustomDataProvidedResourceFileId <String>]: The unique identifier of customDataProvidedResourceFile [CustomDataProvidedResourceUploadSessionId <String>]: The unique identifier of customDataProvidedResourceUploadSession [CustomExtensionStageSettingId <String>]: The unique identifier of customExtensionStageSetting [CustomTaskExtensionId <String>]: The unique identifier of customTaskExtension [DirectoryObjectId <String>]: The unique identifier of directoryObject [EndDateTime <DateTime?>]: Usage: endDateTime={endDateTime} [ExternalOriginResourceConnectorId <String>]: The unique identifier of externalOriginResourceConnector [GovernanceInsightId <String>]: The unique identifier of governanceInsight [GroupResourceId <String>]: The unique identifier of groupResource [IncompatibleAccessPackageId <String>]: Usage: incompatibleAccessPackageId='{incompatibleAccessPackageId}' [ObjectId <String>]: Alternate key of accessPackageSubject [On <String>]: Usage: on='{on}' [PrivilegedAccessGroupAssignmentScheduleId <String>]: The unique identifier of privilegedAccessGroupAssignmentSchedule [PrivilegedAccessGroupAssignmentScheduleInstanceId <String>]: The unique identifier of privilegedAccessGroupAssignmentScheduleInstance [PrivilegedAccessGroupAssignmentScheduleRequestId <String>]: The unique identifier of privilegedAccessGroupAssignmentScheduleRequest [PrivilegedAccessGroupEligibilityScheduleId <String>]: The unique identifier of privilegedAccessGroupEligibilitySchedule [PrivilegedAccessGroupEligibilityScheduleInstanceId <String>]: The unique identifier of privilegedAccessGroupEligibilityScheduleInstance [PrivilegedAccessGroupEligibilityScheduleRequestId <String>]: The unique identifier of privilegedAccessGroupEligibilityScheduleRequest [RunId <String>]: The unique identifier of run [RunId1 <String>]: The unique identifier of run [StartDateTime <DateTime?>]: Usage: startDateTime={startDateTime} [SubjectProcessingResultId <String>]: The unique identifier of subjectProcessingResult [TaskDefinitionId <String>]: The unique identifier of taskDefinition [TaskId <String>]: The unique identifier of task [TaskProcessingResultId <String>]: The unique identifier of taskProcessingResult [TaskReportId <String>]: The unique identifier of taskReport [UnifiedRbacResourceActionId <String>]: The unique identifier of unifiedRbacResourceAction [UnifiedRbacResourceNamespaceId <String>]: The unique identifier of unifiedRbacResourceNamespace [UnifiedRoleAssignmentId <String>]: The unique identifier of unifiedRoleAssignment [UnifiedRoleAssignmentScheduleId <String>]: The unique identifier of unifiedRoleAssignmentSchedule [UnifiedRoleAssignmentScheduleInstanceId <String>]: The unique identifier of unifiedRoleAssignmentScheduleInstance [UnifiedRoleAssignmentScheduleRequestId <String>]: The unique identifier of unifiedRoleAssignmentScheduleRequest [UnifiedRoleDefinitionId <String>]: The unique identifier of unifiedRoleDefinition [UnifiedRoleDefinitionId1 <String>]: The unique identifier of unifiedRoleDefinition [UnifiedRoleEligibilityScheduleId <String>]: The unique identifier of unifiedRoleEligibilitySchedule [UnifiedRoleEligibilityScheduleInstanceId <String>]: The unique identifier of unifiedRoleEligibilityScheduleInstance [UnifiedRoleEligibilityScheduleRequestId <String>]: The unique identifier of unifiedRoleEligibilityScheduleRequest [UserConsentRequestId <String>]: The unique identifier of userConsentRequest [UserId <String>]: The unique identifier of user [UserProcessingResultId <String>]: The unique identifier of userProcessingResult [WorkflowId <String>]: The unique identifier of workflow [WorkflowTemplateId <String>]: The unique identifier of workflowTemplate [WorkflowVersionNumber <Int32?>]: The unique identifier of workflowVersion