Share via

Update-MgBetaOnPremisePublishingProfileAgentGroup

  • Reference
Module:
Microsoft.Graph.Beta.Applications

Update the navigation property agentGroups in onPremisesPublishingProfiles

Syntax

Update-MgBetaOnPremisePublishingProfileAgentGroup
      -OnPremisesAgentGroupId <String>
      -OnPremisesPublishingProfileId <String>
      [-ResponseHeadersVariable <String>]
      [-AdditionalProperties <Hashtable>]
      [-Agents <IMicrosoftGraphOnPremisesAgent[]>]
      [-DisplayName <String>]
      [-Id <String>]
      [-IsDefault]
      [-PublishedResources <IMicrosoftGraphPublishedResource[]>]
      [-PublishingType <String>]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-MgBetaOnPremisePublishingProfileAgentGroup
      -OnPremisesAgentGroupId <String>
      -OnPremisesPublishingProfileId <String>
      -BodyParameter <IMicrosoftGraphOnPremisesAgentGroup>
      [-ResponseHeadersVariable <String>]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-MgBetaOnPremisePublishingProfileAgentGroup
      -InputObject <IApplicationsIdentity>
      [-ResponseHeadersVariable <String>]
      [-AdditionalProperties <Hashtable>]
      [-Agents <IMicrosoftGraphOnPremisesAgent[]>]
      [-DisplayName <String>]
      [-Id <String>]
      [-IsDefault]
      [-PublishedResources <IMicrosoftGraphPublishedResource[]>]
      [-PublishingType <String>]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-MgBetaOnPremisePublishingProfileAgentGroup
      -InputObject <IApplicationsIdentity>
      -BodyParameter <IMicrosoftGraphOnPremisesAgentGroup>
      [-ResponseHeadersVariable <String>]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Update the navigation property agentGroups in onPremisesPublishingProfiles

Examples

Example 1: Using the Update-MgBetaOnPremisePublishingProfileAgentGroup Cmdlet

Import-Module Microsoft.Graph.Beta.Applications
$params = @{
	DisplayName = "Group New Name"
}
Update-MgBetaOnPremisePublishingProfileAgentGroup -OnPremisesPublishingProfileId $onPremisesPublishingProfileId -OnPremisesAgentGroupId $onPremisesAgentGroupId -BodyParameter $params

This example shows how to use the Update-MgBetaOnPremisePublishingProfileAgentGroup Cmdlet. To learn about permissions for this resource, see the permissions reference.

Parameters

-AdditionalProperties

Additional Parameters

Type:Hashtable
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Agents

List of onPremisesAgent that are assigned to an onPremisesAgentGroup. Read-only. Nullable. To construct, see NOTES section for AGENTS properties and create a hash table.

Type:IMicrosoftGraphOnPremisesAgent[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-BodyParameter

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

Type:IMicrosoftGraphOnPremisesAgentGroup
Position:Named
Default value:None
Required:True
Accept pipeline input:True
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

-DisplayName

Display name of the onPremisesAgentGroup.

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

-InputObject

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

Type:IApplicationsIdentity
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-IsDefault

Indicates if the onPremisesAgentGroup is the default agent group. Only a single agent group can be the default onPremisesAgentGroup and is set by the system.

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-OnPremisesAgentGroupId

The unique identifier of onPremisesAgentGroup

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-OnPremisesPublishingProfileId

The unique identifier of onPremisesPublishingProfile

Type:String
Position:Named
Default value:None
Required:True
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

-PublishedResources

List of publishedResource that are assigned to an onPremisesAgentGroup. Read-only. Nullable. To construct, see NOTES section for PUBLISHEDRESOURCES properties and create a hash table.

Type:IMicrosoftGraphPublishedResource[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PublishingType

onPremisesPublishingType

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

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

Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphOnPremisesAgentGroup

System.Collections.IDictionary

Outputs

Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphOnPremisesAgentGroup

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.

AGENTS <IMicrosoftGraphOnPremisesAgent- []>: List of onPremisesAgent that are assigned to an onPremisesAgentGroup. Read-only. Nullable.

  • [Id <String>]: The unique identifier for an entity. Read-only.
  • [AgentGroups <IMicrosoftGraphOnPremisesAgentGroup- []>]: List of onPremisesAgentGroups that an onPremisesAgent is assigned to. Read-only. Nullable.
    • [Id <String>]: The unique identifier for an entity. Read-only.
    • [Agents <IMicrosoftGraphOnPremisesAgent- []>]: List of onPremisesAgent that are assigned to an onPremisesAgentGroup. Read-only. Nullable.
    • [DisplayName <String>]: Display name of the onPremisesAgentGroup.
    • [IsDefault <Boolean?>]: Indicates if the onPremisesAgentGroup is the default agent group. Only a single agent group can be the default onPremisesAgentGroup and is set by the system.
    • [PublishedResources <IMicrosoftGraphPublishedResource- []>]: List of publishedResource that are assigned to an onPremisesAgentGroup. Read-only. Nullable.
      • [Id <String>]: The unique identifier for an entity. Read-only.
      • [AgentGroups <IMicrosoftGraphOnPremisesAgentGroup- []>]: List of onPremisesAgentGroups that a publishedResource is assigned to. Read-only. Nullable.
      • [DisplayName <String>]: Display Name of the publishedResource.
      • [PublishingType <String>]: onPremisesPublishingType
      • [ResourceName <String>]: Name of the publishedResource.
    • [PublishingType <String>]: onPremisesPublishingType
  • [ExternalIP <String>]: The external IP address as detected by the service for the agent machine. Read-only
  • [MachineName <String>]: The name of the machine that the agent is running on. Read-only
  • [Status <String>]: agentStatus
  • [SupportedPublishingTypes <String- []>]: Possible values are: applicationProxy, exchangeOnline, authentication, provisioning, adAdministration.

BODYPARAMETER <IMicrosoftGraphOnPremisesAgentGroup>: onPremisesAgentGroup

  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [Id <String>]: The unique identifier for an entity. Read-only.
  • [Agents <IMicrosoftGraphOnPremisesAgent- []>]: List of onPremisesAgent that are assigned to an onPremisesAgentGroup. Read-only. Nullable.
    • [Id <String>]: The unique identifier for an entity. Read-only.
    • [AgentGroups <IMicrosoftGraphOnPremisesAgentGroup- []>]: List of onPremisesAgentGroups that an onPremisesAgent is assigned to. Read-only. Nullable.
    • [ExternalIP <String>]: The external IP address as detected by the service for the agent machine. Read-only
    • [MachineName <String>]: The name of the machine that the agent is running on. Read-only
    • [Status <String>]: agentStatus
    • [SupportedPublishingTypes <String- []>]: Possible values are: applicationProxy, exchangeOnline, authentication, provisioning, adAdministration.
  • [DisplayName <String>]: Display name of the onPremisesAgentGroup.
  • [IsDefault <Boolean?>]: Indicates if the onPremisesAgentGroup is the default agent group. Only a single agent group can be the default onPremisesAgentGroup and is set by the system.
  • [PublishedResources <IMicrosoftGraphPublishedResource- []>]: List of publishedResource that are assigned to an onPremisesAgentGroup. Read-only. Nullable.
    • [Id <String>]: The unique identifier for an entity. Read-only.
    • [AgentGroups <IMicrosoftGraphOnPremisesAgentGroup- []>]: List of onPremisesAgentGroups that a publishedResource is assigned to. Read-only. Nullable.
    • [DisplayName <String>]: Display Name of the publishedResource.
    • [PublishingType <String>]: onPremisesPublishingType
    • [ResourceName <String>]: Name of the publishedResource.
  • [PublishingType <String>]: onPremisesPublishingType

INPUTOBJECT <IApplicationsIdentity>: Identity Parameter

  • [AppId <String>]: Alternate key of application
  • [AppManagementPolicyId <String>]: The unique identifier of appManagementPolicy
  • [AppRoleAssignmentId <String>]: The unique identifier of appRoleAssignment
  • [ApplicationId <String>]: The unique identifier of application
  • [ApplicationTemplateId <String>]: The unique identifier of applicationTemplate
  • [ClaimsMappingPolicyId <String>]: The unique identifier of claimsMappingPolicy
  • [ConnectorGroupId <String>]: The unique identifier of connectorGroup
  • [ConnectorId <String>]: The unique identifier of connector
  • [DelegatedPermissionClassificationId <String>]: The unique identifier of delegatedPermissionClassification
  • [DirectoryDefinitionId <String>]: The unique identifier of directoryDefinition
  • [DirectoryObjectId <String>]: The unique identifier of directoryObject
  • [EndpointId <String>]: The unique identifier of endpoint
  • [ExtensionPropertyId <String>]: The unique identifier of extensionProperty
  • [FederatedIdentityCredentialId <String>]: The unique identifier of federatedIdentityCredential
  • [GroupId <String>]: The unique identifier of group
  • [HomeRealmDiscoveryPolicyId <String>]: The unique identifier of homeRealmDiscoveryPolicy
  • [IPApplicationSegmentId <String>]: The unique identifier of ipApplicationSegment
  • [LicenseDetailsId <String>]: The unique identifier of licenseDetails
  • [Name <String>]: Alternate key of federatedIdentityCredential
  • [OAuth2PermissionGrantId <String>]: The unique identifier of oAuth2PermissionGrant
  • [OnPremisesAgentGroupId <String>]: The unique identifier of onPremisesAgentGroup
  • [OnPremisesAgentGroupId1 <String>]: The unique identifier of onPremisesAgentGroup
  • [OnPremisesAgentId <String>]: The unique identifier of onPremisesAgent
  • [OnPremisesPublishingProfileId <String>]: The unique identifier of onPremisesPublishingProfile
  • [PermissionGrantPreApprovalPolicyId <String>]: The unique identifier of permissionGrantPreApprovalPolicy
  • [PublishedResourceId <String>]: The unique identifier of publishedResource
  • [ServicePrincipalId <String>]: The unique identifier of servicePrincipal
  • [SynchronizationJobId <String>]: The unique identifier of synchronizationJob
  • [SynchronizationTemplateId <String>]: The unique identifier of synchronizationTemplate
  • [TargetDeviceGroupId <String>]: The unique identifier of targetDeviceGroup
  • [TokenIssuancePolicyId <String>]: The unique identifier of tokenIssuancePolicy
  • [TokenLifetimePolicyId <String>]: The unique identifier of tokenLifetimePolicy
  • [UniqueName <String>]: Alternate key of application
  • [UserId <String>]: The unique identifier of user

PUBLISHEDRESOURCES <IMicrosoftGraphPublishedResource- []>: List of publishedResource that are assigned to an onPremisesAgentGroup. Read-only. Nullable.

  • [Id <String>]: The unique identifier for an entity. Read-only.
  • [AgentGroups <IMicrosoftGraphOnPremisesAgentGroup- []>]: List of onPremisesAgentGroups that a publishedResource is assigned to. Read-only. Nullable.
    • [Id <String>]: The unique identifier for an entity. Read-only.
    • [Agents <IMicrosoftGraphOnPremisesAgent- []>]: List of onPremisesAgent that are assigned to an onPremisesAgentGroup. Read-only. Nullable.
      • [Id <String>]: The unique identifier for an entity. Read-only.
      • [AgentGroups <IMicrosoftGraphOnPremisesAgentGroup- []>]: List of onPremisesAgentGroups that an onPremisesAgent is assigned to. Read-only. Nullable.
      • [ExternalIP <String>]: The external IP address as detected by the service for the agent machine. Read-only
      • [MachineName <String>]: The name of the machine that the agent is running on. Read-only
      • [Status <String>]: agentStatus
      • [SupportedPublishingTypes <String- []>]: Possible values are: applicationProxy, exchangeOnline, authentication, provisioning, adAdministration.
    • [DisplayName <String>]: Display name of the onPremisesAgentGroup.
    • [IsDefault <Boolean?>]: Indicates if the onPremisesAgentGroup is the default agent group. Only a single agent group can be the default onPremisesAgentGroup and is set by the system.
    • [PublishedResources <IMicrosoftGraphPublishedResource- []>]: List of publishedResource that are assigned to an onPremisesAgentGroup. Read-only. Nullable.
    • [PublishingType <String>]: onPremisesPublishingType
  • [DisplayName <String>]: Display Name of the publishedResource.
  • [PublishingType <String>]: onPremisesPublishingType
  • [ResourceName <String>]: Name of the publishedResource.