Share via

New-MgBetaOnPremisePublishingProfileAgentGroupAgent

Module:
Microsoft.Graph.Beta.Applications Module

Create new navigation property to agents for onPremisesPublishingProfiles

Syntax

CreateExpanded (Default) 

New-MgBetaOnPremisePublishingProfileAgentGroupAgent
    -OnPremisesAgentGroupId <String>
    -OnPremisesPublishingProfileId <String>
    [-ResponseHeadersVariable <String>]
    [-AdditionalProperties <Hashtable>]
    [-AgentGroups <IMicrosoftGraphOnPremisesAgentGroup[]>]
    [-ExternalIP <String>]
    [-Id <String>]
    [-MachineName <String>]
    [-Status <String>]
    [-SupportedPublishingTypes <String[]>]
    [-Headers <IDictionary>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Create 

New-MgBetaOnPremisePublishingProfileAgentGroupAgent
    -OnPremisesAgentGroupId <String>
    -OnPremisesPublishingProfileId <String>
    -BodyParameter <IMicrosoftGraphOnPremisesAgent>
    [-ResponseHeadersVariable <String>]
    [-Headers <IDictionary>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

CreateViaIdentityExpanded 

New-MgBetaOnPremisePublishingProfileAgentGroupAgent
    -InputObject <IApplicationsIdentity>
    [-ResponseHeadersVariable <String>]
    [-AdditionalProperties <Hashtable>]
    [-AgentGroups <IMicrosoftGraphOnPremisesAgentGroup[]>]
    [-ExternalIP <String>]
    [-Id <String>]
    [-MachineName <String>]
    [-Status <String>]
    [-SupportedPublishingTypes <String[]>]
    [-Headers <IDictionary>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

CreateViaIdentity 

New-MgBetaOnPremisePublishingProfileAgentGroupAgent
    -InputObject <IApplicationsIdentity>
    -BodyParameter <IMicrosoftGraphOnPremisesAgent>
    [-ResponseHeadersVariable <String>]
    [-Headers <IDictionary>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Create new navigation property to agents for onPremisesPublishingProfiles

Permissions

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

Parameters

-AdditionalProperties

Additional Parameters

Parameter properties

Type:Hashtable
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

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

-AgentGroups

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

Parameter properties

Type:

IMicrosoftGraphOnPremisesAgentGroup[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

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

-BodyParameter

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

Parameter properties

Type:IMicrosoftGraphOnPremisesAgent
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Create
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False
CreateViaIdentity
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:None
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

-ExternalIP

The external IP address as detected by the service for the agent machine. Read-only

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
CreateViaIdentityExpanded
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:IDictionary
Default value:None
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

-Id

The unique identifier for an entity. Read-only.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
CreateViaIdentityExpanded
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:IApplicationsIdentity
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CreateViaIdentityExpanded
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False
CreateViaIdentity
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-MachineName

The name of the machine that the agent is running on. Read-only

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

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

-OnPremisesAgentGroupId

The unique identifier of onPremisesAgentGroup

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Create
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-OnPremisesPublishingProfileId

The unique identifier of onPremisesPublishingProfile

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Create
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResponseHeadersVariable

Optional Response Headers Variable.

Parameter properties

Type:String
Default value:None
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

-Status

agentStatus

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

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

-SupportedPublishingTypes

Possible values are: applicationProxy, exchangeOnline, authentication, provisioning, adAdministration.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:SwitchParameter
Default value:None
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.Beta.PowerShell.Models.IApplicationsIdentity

Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphOnPremisesAgent

System.Collections.IDictionary

Outputs

Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphOnPremisesAgent

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.

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

BODYPARAMETER <IMicrosoftGraphOnPremisesAgent>: onPremisesAgent

  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [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.

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