New-AzNetworkManagerScopeConnection
Creates a scope connection.
Syntax
New-AzNetworkManagerScopeConnection
-Name <String>
-NetworkManagerName <String>
-ResourceGroupName <String>
-TenantId <String>
-ResourceId <String>
[-Description <String>]
[-AsJob]
[-Force]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The New-AzNetworkManagerScopeConnection cmdlet creates a scope connection.
Examples
Example 1
New-AzNetworkManagerScopeConnection -ResourceGroupName psResourceGroup -NetworkManagerName psNetworkManager -Name "subConnection" -TenantId "aaaabbbb-0000-cccc-1111-dddd2222eeee" -ResourceId "/subscriptions/a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1" -Description "SampleDescription"
TenantId : aaaabbbb-0000-cccc-1111-dddd2222eeee
ResourceId : /subscriptions/a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1
ConnectionState : Pending
DisplayName :
Description : SampleDescription
Type : Microsoft.Network/networkManagers/scopeConnections
ProvisioningState :
SystemData : Microsoft.Azure.Commands.Network.Models.NetworkManager.PSSystemData
SystemDataText : {
"CreatedBy": "jaredgorthy@microsoft.com",
"CreatedByType": "User",
"CreatedAt": "2022-08-07T23:53:52.6942092Z",
"LastModifiedBy": "jaredgorthy@microsoft.com",
"LastModifiedByType": "User",
"LastModifiedAt": "2022-08-07T23:53:52.6942092Z"
}
Name : subConnection
Etag :
Id : /subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager/scopeConnections/subConnection
Creates a scope connection to a cross-tenant subscription.
Example 2
New-AzNetworkManagerScopeConnection -ResourceGroupName psResourceGroup -NetworkManagerName psNetworkManager -Name "mgConnection" -TenantId "aaaabbbb-0000-cccc-1111-dddd2222eeee" -ResourceId "/providers/Microsoft.Management/managementGroups/newMG" -Description "SampleDescription"
TenantId : aaaabbbb-0000-cccc-1111-dddd2222eeee
ResourceId : /providers/Microsoft.Management/managementGroups/newMG
ConnectionState : Pending
DisplayName :
Description : SampleDescription
Type : Microsoft.Network/networkManagers/scopeConnections
ProvisioningState :
SystemData : Microsoft.Azure.Commands.Network.Models.NetworkManager.PSSystemData
SystemDataText : {
"CreatedBy": "jaredgorthy@microsoft.com",
"CreatedByType": "User",
"CreatedAt": "2022-08-07T23:55:14.7516201Z",
"LastModifiedBy": "jaredgorthy@microsoft.com",
"LastModifiedByType": "User",
"LastModifiedAt": "2022-08-07T23:55:14.7516201Z"
}
Name : mgConnection
Etag :
Id : /subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager/scopeConnections/mgConnection
Creates a scope connection to a cross-tenant management group.
Parameters
-AsJob
Run cmdlet in the background.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
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 |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Type: | IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Description
Description.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Force
Do not ask for confirmation if you want to overwrite a resource.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Name
The resource name.
Type: | String |
Aliases: | ResourceName |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-NetworkManagerName
The network manager name.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | True |
-ResourceGroupName
The resource group name.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ResourceId
Resource Id of the subscription or management group to be managed. Resource IDs should be in the form '/subscriptions/{subscriptionId}' or '/providers/Microsoft.Management/managementGroups/{managementGroupId}'.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-TenantId
Tenant Id of the resource you'd like to manage.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
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
Outputs
PSNetworkManagerScopeConnection
Related Links
Azure PowerShell