Get-AzDataCollectionEndpoint

  • Reference
Module:
Az.Monitor

Returns the specified data collection endpoint.

Syntax

Get-AzDataCollectionEndpoint
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzDataCollectionEndpoint
   -Name <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzDataCollectionEndpoint
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzDataCollectionEndpoint
   -InputObject <IDataCollectionRuleIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

Returns the specified data collection endpoint.

Examples

Example 1: Get data collection endpoints by subscription ID

Get-AzDataCollectionEndpoint

Etag                                   Kind Location Name                  ResourceGroupName
----                                   ---- -------- ----                  -----------------
"b9029ae7-0000-0100-0000-65016d2a0000"      eastus   myCollectionEndpoint  AMCS-TEST
"ba021b4b-0000-0100-0000-650170c20000"      eastus   myCollectionEndpoint2 AMCS-TEST

This command lists all the data collection endpoints for the current subscription.

Example 2: Get data collection endpoints for the given resource group

Get-AzDataCollectionEndpoint -ResourceGroupName AMCS-TEST

Etag                                   Kind Location Name                  ResourceGroupName
----                                   ---- -------- ----                  -----------------
"b9029ae7-0000-0100-0000-65016d2a0000"      eastus   myCollectionEndpoint  AMCS-TEST
"ba021b4b-0000-0100-0000-650170c20000"      eastus   myCollectionEndpoint2 AMCS-TEST

This command lists data collection endpoints for the given resource group.

Example 3: Get a data collection endpoint

Get-AzDataCollectionEndpoint -ResourceGroupName AMCS-TEST -Name myCollection

ConfigurationAccessEndpoint         : https://mycollectionendpoint-bthd.eastus-1.handler.control.monitor.azure.com
Description                         : 
Etag                                : "b9029ae7-0000-0100-0000-65016d2a0000"
FailoverConfigurationActiveLocation : 
FailoverConfigurationLocation       : 
Id                                  : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/AMCS-TEST/providers/Microsoft.Insights/dataCollectionEndpoints/myCollectionEndpoint  
IdentityPrincipalId                 : 
IdentityTenantId                    : 
IdentityType                        : 
IdentityUserAssignedIdentity        : {
                                      }
ImmutableId                         : dce-014e59a439e04f44af4b97b16b7614df
Kind                                : 
Location                            : eastus
LogIngestionEndpoint                : https://mycollectionendpoint-bthd.eastus-1.ingest.monitor.azure.com
MetadataProvisionedBy               : 
MetadataProvisionedByResourceId     : 
MetricIngestionEndpoint             : https://mycollectionendpoint-bthd.eastus-1.metrics.ingest.monitor.azure.com
Name                                : myCollectionEndpoint
NetworkAclsPublicNetworkAccess      : Enabled
PrivateLinkScopedResource           : 
ProvisioningState                   : Succeeded
ResourceGroupName                   : AMCS-TEST
SystemDataCreatedAt                 : 9/13/2023 8:04:55 AM
SystemDataCreatedBy                 : v-jiaji@microsoft.com
SystemDataCreatedByType             : User
SystemDataLastModifiedAt            : 9/13/2023 8:04:55 AM
SystemDataLastModifiedBy            : v-jiaji@microsoft.com
SystemDataLastModifiedByType        : User
Tag                                 : {
                                      }
Type                                : Microsoft.Insights/dataCollectionEndpoints

This command lists one (a list with a single element) data collection endpoint.

Parameters

-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

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

-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

Inputs

IDataCollectionRuleIdentity

Outputs

IDataCollectionEndpointResource