Share via

New-MgBetaDeviceManagementVirtualEndpointOnPremiseConnection

  • Reference
Module:
Microsoft.Graph.Beta.DeviceManagement.Administration

Create a new cloudPcOnPremisesConnection object for provisioning Cloud PCs.

Note

To view the v1.0 release of this cmdlet, view New-MgDeviceManagementVirtualEndpointOnPremiseConnection

Syntax

New-MgBetaDeviceManagementVirtualEndpointOnPremiseConnection
   [-ResponseHeadersVariable <String>]
   [-AdDomainName <String>]
   [-AdDomainPassword <String>]
   [-AdDomainUsername <String>]
   [-AdditionalProperties <Hashtable>]
   [-AlternateResourceUrl <String>]
   [-ConnectionType <String>]
   [-DisplayName <String>]
   [-HealthCheckStatus <String>]
   [-HealthCheckStatusDetail <IMicrosoftGraphCloudPcOnPremisesConnectionStatusDetail>]
   [-HealthCheckStatusDetails <IMicrosoftGraphCloudPcOnPremisesConnectionStatusDetails>]
   [-Id <String>]
   [-InUse]
   [-ManagedBy <String>]
   [-OrganizationalUnit <String>]
   [-ResourceGroupId <String>]
   [-ScopeIds <String[]>]
   [-SubnetId <String>]
   [-SubscriptionId <String>]
   [-SubscriptionName <String>]
   [-Type <String>]
   [-VirtualNetworkId <String>]
   [-VirtualNetworkLocation <String>]
   [-Headers <IDictionary>]
   [-ProgressAction <ActionPreference>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-MgBetaDeviceManagementVirtualEndpointOnPremiseConnection
   -BodyParameter <IMicrosoftGraphCloudPcOnPremisesConnection>
   [-ResponseHeadersVariable <String>]
   [-Headers <IDictionary>]
   [-ProgressAction <ActionPreference>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Create a new cloudPcOnPremisesConnection object for provisioning Cloud PCs.

Parameters

-AdditionalProperties

Additional Parameters

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

-AdDomainName

The fully qualified domain name (FQDN) of the Active Directory domain you want to join. Optional.

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

-AdDomainPassword

The password associated with adDomainUsername.

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

-AdDomainUsername

The username of an Active Directory account (user or service account) that has permissions to create computer objects in Active Directory. Required format: admin@contoso.com. Optional.

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

-AlternateResourceUrl

The interface URL of the partner service's resource that links to this Azure network connection. Returned only on $select.

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

-BodyParameter

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

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

-ConnectionType

cloudPcOnPremisesConnectionType

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

-DisplayName

The display name for the Azure network connection.

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

-HealthCheckStatus

cloudPcOnPremisesConnectionStatus

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

-HealthCheckStatusDetail

cloudPcOnPremisesConnectionStatusDetail To construct, see NOTES section for HEALTHCHECKSTATUSDETAIL properties and create a hash table.

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

-HealthCheckStatusDetails

cloudPcOnPremisesConnectionStatusDetails To construct, see NOTES section for HEALTHCHECKSTATUSDETAILS properties and create a hash table.

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

-InUse

When true, the Azure network connection is in use. When false, the connection isn't in use. You can't delete a connection that's in use. Returned only on $select. For an example that shows how to get the inUse property, see Example 2: Get the selected properties of an Azure network connection, including healthCheckStatusDetails. Read-only.

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

-ManagedBy

cloudPcManagementService

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

-OrganizationalUnit

The organizational unit (OU) in which the computer account is created. If left null, the OU that's configured as the default (a well-known computer object container) in your Active Directory domain (OU) is used. Optional.

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

-ResourceGroupId

The ID of the target resource group. Required format: /subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}.

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

-ScopeIds

.

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

-SubnetId

The ID of the target subnet. Required format: /subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkId}/subnets/{subnetName}.

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

-SubscriptionId

The ID of the target Azure subscription associated with your tenant.

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

-SubscriptionName

The name of the target Azure subscription. Read-only.

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

-Type

cloudPcOnPremisesConnectionType

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

-VirtualNetworkId

The ID of the target virtual network. Required format: /subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}.

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

-VirtualNetworkLocation

Indicates the resource location of the virtual target network. Read-only, computed value.

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

System.Collections.IDictionary

Outputs

Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphCloudPcOnPremisesConnection

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

  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [Id <String>]: The unique identifier for an entity. Read-only.
  • [AdDomainName <String>]: The fully qualified domain name (FQDN) of the Active Directory domain you want to join. Optional.
  • [AdDomainPassword <String>]: The password associated with adDomainUsername.
  • [AdDomainUsername <String>]: The username of an Active Directory account (user or service account) that has permissions to create computer objects in Active Directory. Required format: admin@contoso.com. Optional.
  • [AlternateResourceUrl <String>]: The interface URL of the partner service's resource that links to this Azure network connection. Returned only on $select.
  • [ConnectionType <String>]: cloudPcOnPremisesConnectionType
  • [DisplayName <String>]: The display name for the Azure network connection.
  • [HealthCheckStatus <String>]: cloudPcOnPremisesConnectionStatus
  • [HealthCheckStatusDetail <IMicrosoftGraphCloudPcOnPremisesConnectionStatusDetail>]: cloudPcOnPremisesConnectionStatusDetail
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [EndDateTime <DateTime?>]: The end time of the connection health check. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
    • [HealthChecks <IMicrosoftGraphCloudPcOnPremisesConnectionHealthCheck- []>]: All checks that are done on the connection.
      • [AdditionalDetail <String>]: More details about the health check or the recommended action. Read-only.
      • [AdditionalDetails <String>]:
      • [CorrelationId <String>]: The unique identifier of the health check item-related activities. This identifier can be useful in troubleshooting.
      • [DisplayName <String>]: The display name for this health check item.
      • [EndDateTime <DateTime?>]: The end time of the health check item. Read-only.
      • [ErrorType <String>]: cloudPcOnPremisesConnectionHealthCheckErrorType
      • [RecommendedAction <String>]: The recommended action to fix the corresponding error.
      • [StartDateTime <DateTime?>]: The start time of the health check item. Read-only.
      • [Status <String>]: cloudPcOnPremisesConnectionStatus
    • [StartDateTime <DateTime?>]: The start time of the connection health check. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
  • [HealthCheckStatusDetails <IMicrosoftGraphCloudPcOnPremisesConnectionStatusDetails>]: cloudPcOnPremisesConnectionStatusDetails
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [EndDateTime <DateTime?>]: The end time of the connection health check. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
    • [HealthChecks <IMicrosoftGraphCloudPcOnPremisesConnectionHealthCheck- []>]: All checks that are done on the connection.
    • [StartDateTime <DateTime?>]: The start time of the connection health check. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
  • [InUse <Boolean?>]: When true, the Azure network connection is in use. When false, the connection isn't in use. You can't delete a connection that's in use. Returned only on $select. For an example that shows how to get the inUse property, see Example 2: Get the selected properties of an Azure network connection, including healthCheckStatusDetails. Read-only.
  • [ManagedBy <String>]: cloudPcManagementService
  • [OrganizationalUnit <String>]: The organizational unit (OU) in which the computer account is created. If left null, the OU that's configured as the default (a well-known computer object container) in your Active Directory domain (OU) is used. Optional.
  • [ResourceGroupId <String>]: The ID of the target resource group. Required format: /subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}.
  • [ScopeIds <String- []>]:
  • [SubnetId <String>]: The ID of the target subnet. Required format: /subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkId}/subnets/{subnetName}.
  • [SubscriptionId <String>]: The ID of the target Azure subscription associated with your tenant.
  • [SubscriptionName <String>]: The name of the target Azure subscription. Read-only.
  • [Type <String>]: cloudPcOnPremisesConnectionType
  • [VirtualNetworkId <String>]: The ID of the target virtual network. Required format: /subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}.
  • [VirtualNetworkLocation <String>]: Indicates the resource location of the virtual target network. Read-only, computed value.

HEALTHCHECKSTATUSDETAIL <IMicrosoftGraphCloudPcOnPremisesConnectionStatusDetail>: cloudPcOnPremisesConnectionStatusDetail

  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [EndDateTime <DateTime?>]: The end time of the connection health check. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
  • [HealthChecks <IMicrosoftGraphCloudPcOnPremisesConnectionHealthCheck- []>]: All checks that are done on the connection.
    • [AdditionalDetail <String>]: More details about the health check or the recommended action. Read-only.
    • [AdditionalDetails <String>]:
    • [CorrelationId <String>]: The unique identifier of the health check item-related activities. This identifier can be useful in troubleshooting.
    • [DisplayName <String>]: The display name for this health check item.
    • [EndDateTime <DateTime?>]: The end time of the health check item. Read-only.
    • [ErrorType <String>]: cloudPcOnPremisesConnectionHealthCheckErrorType
    • [RecommendedAction <String>]: The recommended action to fix the corresponding error.
    • [StartDateTime <DateTime?>]: The start time of the health check item. Read-only.
    • [Status <String>]: cloudPcOnPremisesConnectionStatus
  • [StartDateTime <DateTime?>]: The start time of the connection health check. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.

HEALTHCHECKSTATUSDETAILS <IMicrosoftGraphCloudPcOnPremisesConnectionStatusDetails>: cloudPcOnPremisesConnectionStatusDetails

  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [EndDateTime <DateTime?>]: The end time of the connection health check. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
  • [HealthChecks <IMicrosoftGraphCloudPcOnPremisesConnectionHealthCheck- []>]: All checks that are done on the connection.
    • [AdditionalDetail <String>]: More details about the health check or the recommended action. Read-only.
    • [AdditionalDetails <String>]:
    • [CorrelationId <String>]: The unique identifier of the health check item-related activities. This identifier can be useful in troubleshooting.
    • [DisplayName <String>]: The display name for this health check item.
    • [EndDateTime <DateTime?>]: The end time of the health check item. Read-only.
    • [ErrorType <String>]: cloudPcOnPremisesConnectionHealthCheckErrorType
    • [RecommendedAction <String>]: The recommended action to fix the corresponding error.
    • [StartDateTime <DateTime?>]: The start time of the health check item. Read-only.
    • [Status <String>]: cloudPcOnPremisesConnectionStatus
  • [StartDateTime <DateTime?>]: The start time of the connection health check. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.