Update-AzPurviewAccount
Updates an account
Syntax
Update-AzPurviewAccount
-Name <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
[-ManagedResourceGroupName <String>]
[-PublicNetworkAccess <PublicNetworkAccess>]
[-Tag <Hashtable>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Update-AzPurviewAccount
-InputObject <IPurviewIdentity>
[-ManagedResourceGroupName <String>]
[-PublicNetworkAccess <PublicNetworkAccess>]
[-Tag <Hashtable>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Updates an account
Examples
Example 1: Update a purview account
Update-AzPurviewAccount -Name test-pa -ResourceGroupName test-rg -Tag @{"k"="v"} | Format-List
CloudConnectorAwsExternalId : xxxxxxxxxx-d074-4f8f-9d7f-10811b250738
CreatedAt : 8/17/2021 6:18:57 AM
CreatedBy : xxxxx.xxxxx@microsoft.com
CreatedByObjectId : xxxxxxx-5be9-4f43-abd2-04561777c8b0
EndpointCatalog : https://test-pa.catalog.purview.azure.com
EndpointGuardian : https://test-pa.guardian.purview.azure.com
EndpointScan : https://test-pa.scan.purview.azure.com
FriendlyName : test-pa
Id : /subscriptions/xxxxxxxx-1bf0-4dda-aec3-cb9272f09590/resourceGroups/test-rg/providers/Microsoft.Purview/a
ccounts/test-pa
Identity : {
"principalId": "aaaaaaaa-bbbb-cccc-1111-222222222222",
"tenantId": "aaaabbbb-0000-cccc-1111-dddd2222eeee",
"type": "SystemAssigned"
}
IdentityPrincipalId : aaaaaaaa-bbbb-cccc-1111-222222222222
IdentityTenantId : aaaabbbb-0000-cccc-1111-dddd2222eeee
IdentityType : SystemAssigned
Location : eastus
ManagedResourceEventHubNamespace : /subscriptions/xxxxxxxx-1bf0-4dda-aec3-cb9272f09590/resourceGroups/managed-rg-bbcpgdj/providers/Microso
ft.EventHub/namespaces/Atlas-2bb7cf0b-5348-4811-a336-759242a25d37
ManagedResourceGroup : /subscriptions/xxxxxxxx-1bf0-4dda-aec3-cb9272f09590/resourceGroups/managed-rg-bbcpgdj
ManagedResourceGroupName : managed-rg-bbcpgdj
ManagedResourceStorageAccount : /subscriptions/xxxxxxxx-1bf0-4dda-aec3-cb9272f09590/resourceGroups/managed-rg-bbcpgdj/providers/Microso
ft.Storage/storageAccounts/scaneastusnkcccgc
Name : test-pa
PrivateEndpointConnection : {}
ProvisioningState : Succeeded
PublicNetworkAccess : Enabled
ResourceGroupName : test-rg
SkuCapacity : 1
SkuName : Standard
SystemData : {
"createdAt": "2021-08-17T06:18:57.7274115Z",
"createdBy": "xxxxx.xxxxx@microsoft.com",
"createdByType": "User",
"lastModifiedAt": "xxxxxx-08-17T06:18:57.7274115Z",
"lastModifiedBy": "xxxxx.xxxxx@microsoft.com",
"lastModifiedByType": "User"
}
SystemDataCreatedAt : 8/17/2021 6:18:57 AM
SystemDataCreatedBy : xxxxx.xxxxx@microsoft.com
SystemDataCreatedByType : User
SystemDataLastModifiedAt : 8/17/2021 6:18:57 AM
SystemDataLastModifiedBy : xxxxxx.xxxxx@microsoft.com
SystemDataLastModifiedByType : User
Tag : {
"k": "v"
}
Type : Microsoft.Purview/account
Update the tag of a purview account named 'test-pa'
Example 2: Update a purview account by InputObject
$get = Get-AzPurviewAccount -Name test-pa -ResourceGroupName test-rg
Update-AzPurviewAccount -InputObject $get -Tag @{"k"="v"}
CloudConnectorAwsExternalId : xxxxxxxxxx-d074-4f8f-9d7f-10811b250738
CreatedAt : 8/17/2021 6:18:57 AM
CreatedBy : xxxxx.xxxxx@microsoft.com
CreatedByObjectId : xxxxxxx-5be9-4f43-abd2-04561777c8b0
EndpointCatalog : https://test-pa.catalog.purview.azure.com
EndpointGuardian : https://test-pa.guardian.purview.azure.com
EndpointScan : https://test-pa.scan.purview.azure.com
FriendlyName : test-pa
Id : /subscriptions/xxxxxxxx-1bf0-4dda-aec3-cb9272f09590/resourceGroups/test-rg/providers/Microsoft.Purview/a
ccounts/test-pa
Identity : {
"principalId": "aaaaaaaa-bbbb-cccc-1111-222222222222",
"tenantId": "aaaabbbb-0000-cccc-1111-dddd2222eeee",
"type": "SystemAssigned"
}
IdentityPrincipalId : aaaaaaaa-bbbb-cccc-1111-222222222222
IdentityTenantId : aaaabbbb-0000-cccc-1111-dddd2222eeee
IdentityType : SystemAssigned
Location : eastus
ManagedResourceEventHubNamespace : /subscriptions/xxxxxxxx-1bf0-4dda-aec3-cb9272f09590/resourceGroups/managed-rg-bbcpgdj/providers/Microso
ft.EventHub/namespaces/Atlas-2bb7cf0b-5348-4811-a336-759242a25d37
ManagedResourceGroup : /subscriptions/xxxxxxxx-1bf0-4dda-aec3-cb9272f09590/resourceGroups/managed-rg-bbcpgdj
ManagedResourceGroupName : managed-rg-bbcpgdj
ManagedResourceStorageAccount : /subscriptions/xxxxxxxx-1bf0-4dda-aec3-cb9272f09590/resourceGroups/managed-rg-bbcpgdj/providers/Microso
ft.Storage/storageAccounts/scaneastusnkcccgc
Name : test-pa
PrivateEndpointConnection : {}
ProvisioningState : Succeeded
PublicNetworkAccess : Enabled
ResourceGroupName : test-rg
SkuCapacity : 1
SkuName : Standard
SystemData : {
"createdAt": "2021-08-17T06:18:57.7274115Z",
"createdBy": "xxxxx.xxxxx@microsoft.com",
"createdByType": "User",
"lastModifiedAt": "xxxxxx-08-17T06:18:57.7274115Z",
"lastModifiedBy": "xxxxx.xxxxx@microsoft.com",
"lastModifiedByType": "User"
}
SystemDataCreatedAt : 8/17/2021 6:18:57 AM
SystemDataCreatedBy : xxxxx.xxxxx@microsoft.com
SystemDataCreatedByType : User
SystemDataLastModifiedAt : 8/17/2021 6:18:57 AM
SystemDataLastModifiedBy : xxxxxx.xxxxx@microsoft.com
SystemDataLastModifiedByType : User
Tag : {
"k": "v"
}
Type : Microsoft.Purview/account
Update the tag of a purview account named 'test-pa' by InputObject
Parameters
-AsJob
Run the command as a job
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 DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.
Type: | PSObject |
Aliases: | AzureRMContext, AzureCredential |
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: | IPurviewIdentity |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ManagedResourceGroupName
Gets or sets the managed resource group name
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Name
The name of the account.
Type: | String |
Aliases: | AccountName |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-NoWait
Run the command asynchronously
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PublicNetworkAccess
Gets or sets the public network access.
Type: | PublicNetworkAccess |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ResourceGroupName
The resource group name.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SubscriptionId
The subscription identifier
Type: | String |
Position: | Named |
Default value: | (Get-AzContext).Subscription.Id |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Tag
Tags on the azure resource.
Type: | Hashtable |
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 |