Get-AzDataCollectionEndpoint
Returns the specified data collection endpoint.
Syntax
List1 (Default)
Get-AzDataCollectionEndpoint
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Get
Get-AzDataCollectionEndpoint
-Name <String>
-ResourceGroupName <String>
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
List
Get-AzDataCollectionEndpoint
-ResourceGroupName <String>
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
GetViaIdentity
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.
Parameter properties
Type: PSObject
Default value: None Supports wildcards: False DontShow: False Aliases: AzureRMContext, AzureCredential
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Identity Parameter
GetViaIdentity
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-Name
The name of the data collection endpoint.
The name is case insensitive.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: DataCollectionEndpointName
Parameter sets
Get
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ResourceGroupName
The name of the resource group.
The name is case insensitive.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
Get
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
List
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SubscriptionId
The ID of the target subscription.
Parameter properties
Type: String [ ]
Default value: (Get-AzContext).Subscription.Id Supports wildcards: False DontShow: False
Parameter sets
List1
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Get
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
List
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters .
Outputs
