Update-AzDataCollectionEndpoint
update a data collection endpoint.
Syntax
Update-AzDataCollectionEndpoint
-Name <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
[-Description <String>]
[-EnableSystemAssignedIdentity <Boolean>]
[-ImmutableId <String>]
[-Kind <String>]
[-NetworkAclsPublicNetworkAccess <String>]
[-Tag <Hashtable>]
[-UserAssignedIdentity <String[]>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Update-AzDataCollectionEndpoint
-InputObject <IDataCollectionRuleIdentity>
[-Description <String>]
[-EnableSystemAssignedIdentity <Boolean>]
[-ImmutableId <String>]
[-Kind <String>]
[-NetworkAclsPublicNetworkAccess <String>]
[-Tag <Hashtable>]
[-UserAssignedIdentity <String[]>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
update a data collection endpoint.
Examples
Example 1: Update tag for data collection endpoint
Update-AzDataCollectionEndpoint -Name myCollectionEndpoint -ResourceGroupName AMCS-TEST -Tag @{"123"="abc"}
ConfigurationAccessEndpoint : https://mycollectionendpoint-yz4d.eastus-1.handler.control.monitor.azure.com
Description :
Etag : "22014545-0000-0100-0000-65115a540000"
FailoverConfigurationActiveLocation :
FailoverConfigurationLocation :
Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/AMCS-TEST/providers/Microsoft.Insights/dataCollectionEndpoints/myCollectionEndpoint
IdentityPrincipalId :
IdentityTenantId :
IdentityType :
IdentityUserAssignedIdentity : {
}
ImmutableId : dce-8011fcc7985844938c3809e497420638
Kind :
Location : eastus
LogIngestionEndpoint : https://mycollectionendpoint-yz4d.eastus-1.ingest.monitor.azure.com
MetadataProvisionedBy :
MetadataProvisionedByResourceId :
MetricIngestionEndpoint : https://mycollectionendpoint-yz4d.eastus-1.metrics.ingest.monitor.azure.com
Name : myCollectionEndpoint
NetworkAclsPublicNetworkAccess : Enabled
PrivateLinkScopedResource :
ProvisioningState : Succeeded
ResourceGroupName : AMCS-TEST
SystemDataCreatedAt : 9/18/2023 2:37:19 AM
SystemDataCreatedBy : v-jiaji@microsoft.com
SystemDataCreatedByType : User
SystemDataLastModifiedAt : 9/25/2023 10:00:51 AM
SystemDataLastModifiedBy : v-jiaji@microsoft.com
SystemDataLastModifiedByType : User
Tag : {
"123": "abc"
}
Type : Microsoft.Insights/dataCollectionEndpointsThis command updates data collection endpoint.
Parameters
-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 |
-Description
Description of the data collection endpoint.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-EnableSystemAssignedIdentity
Determines whether to enable a system-assigned identity for the resource.
| Type: | Nullable<T>[Boolean] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ImmutableId
The immutable ID of this data collection endpoint resource. This property is READ-ONLY.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
Identity Parameter
| Type: | IDataCollectionRuleIdentity |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Kind
The kind of the resource.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
The name of the data collection endpoint. The name is case insensitive.
| Type: | String |
| Aliases: | DataCollectionEndpointName |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-NetworkAclsPublicNetworkAccess
The configuration to set whether network access from public internet to the endpoints are allowed.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResourceGroupName
The name of the resource group. The name is case insensitive.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SubscriptionId
The ID of the target subscription.
| Type: | String |
| Position: | Named |
| Default value: | (Get-AzContext).Subscription.Id |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Tag
Resource tags.
| Type: | Hashtable |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UserAssignedIdentity
The array of user assigned identities associated with the resource. The elements in array will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.'
| 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 |
