external help file | Module Name | online version | schema |
---|---|---|---|
Microsoft.Graph.Beta.DeviceManagement.Administration-help.xml |
Microsoft.Graph.Beta.DeviceManagement.Administration |
2.0.0 |
Create a new cloudPcOnPremisesConnection object for provisioning Cloud PCs.
Note
To view the v1.0 release of this cmdlet, view New-MgDeviceManagementVirtualEndpointOnPremiseConnection
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>]
Create a new cloudPcOnPremisesConnection object for provisioning Cloud PCs.
Additional Parameters
Type: Hashtable
Parameter Sets: CreateExpanded
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
The fully qualified domain name (FQDN) of the Active Directory domain you want to join. Optional.
Type: String
Parameter Sets: CreateExpanded
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
The password associated with adDomainUsername.
Type: String
Parameter Sets: CreateExpanded
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
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
Parameter Sets: CreateExpanded
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
The interface URL of the partner service's resource that links to this Azure network connection. Returned only on $select.
Type: String
Parameter Sets: CreateExpanded
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
cloudPcOnPremisesConnection To construct, see NOTES section for BODYPARAMETER properties and create a hash table.
Type: IMicrosoftGraphCloudPcOnPremisesConnection
Parameter Sets: Create
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
cloudPcOnPremisesConnectionType
Type: String
Parameter Sets: CreateExpanded
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
The display name for the Azure network connection.
Type: String
Parameter Sets: CreateExpanded
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Optional headers that will be added to the request.
Type: IDictionary
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
cloudPcOnPremisesConnectionStatus
Type: String
Parameter Sets: CreateExpanded
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
cloudPcOnPremisesConnectionStatusDetail To construct, see NOTES section for HEALTHCHECKSTATUSDETAIL properties and create a hash table.
Type: IMicrosoftGraphCloudPcOnPremisesConnectionStatusDetail
Parameter Sets: CreateExpanded
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
cloudPcOnPremisesConnectionStatusDetails To construct, see NOTES section for HEALTHCHECKSTATUSDETAILS properties and create a hash table.
Type: IMicrosoftGraphCloudPcOnPremisesConnectionStatusDetails
Parameter Sets: CreateExpanded
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
The unique identifier for an entity. Read-only.
Type: String
Parameter Sets: CreateExpanded
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
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
Parameter Sets: CreateExpanded
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
cloudPcManagementService
Type: String
Parameter Sets: CreateExpanded
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
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
Parameter Sets: CreateExpanded
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
{{ Fill ProgressAction Description }}
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
The ID of the target resource group. Required format: /subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}.
Type: String
Parameter Sets: CreateExpanded
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Optional Response Headers Variable.
Type: String
Parameter Sets: (All)
Aliases: RHV
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
.
Type: String[]
Parameter Sets: CreateExpanded
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
The ID of the target subnet. Required format: /subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkId}/subnets/{subnetName}.
Type: String
Parameter Sets: CreateExpanded
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
The ID of the target Azure subscription associated with your tenant.
Type: String
Parameter Sets: CreateExpanded
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
The name of the target Azure subscription. Read-only.
Type: String
Parameter Sets: CreateExpanded
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
cloudPcOnPremisesConnectionType
Type: String
Parameter Sets: CreateExpanded
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
The ID of the target virtual network. Required format: /subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}.
Type: String
Parameter Sets: CreateExpanded
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Indicates the resource location of the virtual target network. Read-only, computed value.
Type: String
Parameter Sets: CreateExpanded
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
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.
https://learn.microsoft.com/graph/api/virtualendpoint-post-onpremisesconnections?view=graph-rest-1.0