Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
Module Name: Az.TimeSeriesInsights
Module Guid: 19712dc5-d904-4d19-bf3a-7a01dd02cc5d
Module Guid: 02d7130c-f4fa-4432-b57e-c66af9708f66
Download Help Link: https://docs.microsoft.com/en-us/powershell/module/az.timeseriesinsights
Help Version: 1.0.0.0
Locale: en-US
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,28 +35,35 @@ Gets the access policy with the specified name in the specified environment.

## EXAMPLES

### Example 1: List all access policies under a specified environment
### -------------------------- EXAMPLE 1 --------------------------
```powershell
PS C:\> Get-AzTimeSeriesInsightsAccessPolicy -EnvironmentName tsitest001 -ResourceGroupName testgroup
Get-AzTimeSeriesInsightsAccessPolicy -EnvironmentName tsitest001 -ResourceGroupName testgroup
```

Name Type
---- ----
policy001 Microsoft.TimeSeriesInsights/Environments/AccessPolicies
policy002 Microsoft.TimeSeriesInsights/Environments/AccessPolicies
```

This command lists all access policies under a specified environment.

### Example 2: Get a specified access policy
### -------------------------- EXAMPLE 2 --------------------------
```powershell
PS C:\> Get-AzTimeSeriesInsightsAccessPolicy -EnvironmentName tsitest001 -ResourceGroupName testgroup -Name policy001
Get-AzTimeSeriesInsightsAccessPolicy -EnvironmentName tsitest001 -ResourceGroupName testgroup -Name policy001
```

Name Type
---- ----
policy001 Microsoft.TimeSeriesInsights/Environments/AccessPolicies

### -------------------------- EXAMPLE 3 --------------------------
```powershell
$ap = Get-AzTimeSeriesInsightsAccessPolicy -EnvironmentName tsi-envv8u56x -ResourceGroupName tsi-test-i01k5l -Name tsi-apilgj5y
```

This command gets a specified access policy.
PS C:\\>Get-AzTimeSeriesInsightsAccessPolicy -InputObject $ap

Name Type
---- ----
policy001 Microsoft.TimeSeriesInsights/Environments/AccessPolicies

## PARAMETERS

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,10 @@ Gets the environment with the specified name in the specified subscription and r

## EXAMPLES

### Example 1: Get a time series insights environment
### -------------------------- EXAMPLE 1 --------------------------
```powershell
PS C:\> Get-AzTimeSeriesInsightsEnvironment -ResourceGroupName testgroup -Name tsitest001
Get-AzTimeSeriesInsightsEnvironment -ResourceGroupName testgroup -Name tsitest001
```

DataAccessFqdn : b6d113a4-0865-405f-b09e-ad4355b5d046.env.timeseries.azure.com
DataAccessId : b6d113a4-0865-405f-b09e-ad4355b5d046
Expand All @@ -66,13 +67,11 @@ StateDetailMessage :
StorageLimitExceededBehavior : PurgeOldData
Tag : Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.Api20180815Preview.TrackedResourceTags
Type : Microsoft.TimeSeriesInsights/Environments
```

This command gets a time series insights environment.

### Example 2: List all time series insights environments
### -------------------------- EXAMPLE 2 --------------------------
```powershell
PS C:\> Get-AzTimeSeriesInsightsEnvironment -ResourceGroupName testgroup
Get-AzTimeSeriesInsightsEnvironment -ResourceGroupName testgroup
```

DataAccessFqdn : 3de1d1e1-4f9b-4bc6-aad3-a835597dcd86.env.timeseries.azure.com
DataAccessId : 3de1d1e1-4f9b-4bc6-aad3-a835597dcd86
Expand Down Expand Up @@ -117,9 +116,34 @@ StateDetailMessage :
StorageLimitExceededBehavior : PurgeOldData
Tag : Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.Api20180815Preview.TrackedResourceTags
Type : Microsoft.TimeSeriesInsights/Environments

### -------------------------- EXAMPLE 3 --------------------------
```powershell
$env = Get-AzTimeSeriesInsightsEnvironment -ResourceGroupName tsi-test-i01k5l -EnvironmentName tsi-envv8u56x
```

This command lists all time series insights environments in a resource group.
PS C:\\> Get-AzTimeSeriesInsightsEnvironment -InputObject $env

DataAccessFqdn : d76a61f2-8a30-41a5-9587-f241eb9b48d9.env.timeseries.azure.com
DataAccessId : d76a61f2-8a30-41a5-9587-f241eb9b48d9
DataRetentionTime : 1.01:25:00
Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/tsi-test-i01k5l/providers/Microsoft.TimeSeriesInsights/environments/tsi-envv8u56x
IngressState :
Kind : Standard
Location : eastus2
Name : tsi-envv8u56x
PartitionKeyProperty :
PropertyUsageState :
Sku : Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.Api20180815Preview.Sku
SkuCapacity : 1
SkuName : S1
StateDetailCode :
StateDetailCurrentCount :
StateDetailMaxCount :
StateDetailMessage :
StorageLimitExceededBehavior : PurgeOldData
Tag : Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.Api20180815Preview.TrackedResourceTags
Type : Microsoft.TimeSeriesInsights/Environments

## PARAMETERS

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,10 @@ Gets the event source with the specified name in the specified environment.

## EXAMPLES

### Example 1: List all event sources under the specified environment
### -------------------------- EXAMPLE 1 --------------------------
```powershell
PS C:\> Get-AzTimeSeriesInsightsEventSource -ResourceGroupName testgroup -EnvironmentName tsitest001
Get-AzTimeSeriesInsightsEventSource -ResourceGroupName testgroup -EnvironmentName tsitest001
```

ConsumerGroupName : testgroup2
EventHubName : hubname001
Expand Down Expand Up @@ -66,13 +67,11 @@ Name : iots001
Tag : Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.Api20180815Preview.TrackedResourceTags
TimestampPropertyName :
Type : Microsoft.TimeSeriesInsights/Environments/EventSources
```

This command lists all event sources under the specified environments.

### Example 2: Get a specified event source
### -------------------------- EXAMPLE 2 --------------------------
```powershell
PS C:\> et-AzTimeSeriesInsightsEventSource -ResourceGroupName testgroup -EnvironmentName tsitest001 -Name iots001
Get-AzTimeSeriesInsightsEventSource -ResourceGroupName testgroup -EnvironmentName tsitest001 -Name iots001
```

ConsumerGroupName : testgroup2
EventSourceResourceId : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/testgroup2/providers/Microsoft.Devices/IotHubs/iotname001
Expand All @@ -86,9 +85,26 @@ Name : iots001
Tag : Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.Api20180815Preview.TrackedResourceTags
TimestampPropertyName :
Type : Microsoft.TimeSeriesInsights/Environments/EventSources

### -------------------------- EXAMPLE 3 --------------------------
```powershell
$es = Get-AzTimeSeriesInsightsEventSource -ResourceGroupName tsi-test-i01k5l -EnvironmentName tsi-envv8u56x -Name tsi-esrfyi9h
```

This command gets a specific event source.
PS C:\\> Get-AzTimeSeriesInsightsEventSource -InputObject $es

ConsumerGroupName : tsi-test-i01k5l
EventHubName : eventhubname-d2rvmp
EventSourceResourceId : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/tsi-test-i01k5l/providers/Microsoft.EventHub/namespaces/eventhubspace-0t3khp/eventhubs/eventhubname-d2rvmp
Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/tsi-test-i01k5l/providers/Microsoft.TimeSeriesInsights/environments/tsi-envv8u56x/eventsources/tsi-esrfyi9h
KeyName : RootManageSharedAccessKey
Kind : Microsoft.EventHub
Location : eastus2
Name : tsi-esrfyi9h
ServiceBusNamespace : eventhubspace-0t3khp
Tag : Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.Api20180815Preview.TrackedResourceTags
TimestampPropertyName :
Type : Microsoft.TimeSeriesInsights/Environments/EventSources

## PARAMETERS

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,28 +35,35 @@ Gets the reference data set with the specified name in the specified environment

## EXAMPLES

### Example 1: List all reference data sets under the specified environment
### -------------------------- EXAMPLE 1 --------------------------
```powershell
PS C:\> Get-AzTimeSeriesInsightsReferenceDataSet -EnvironmentName tsitest001 -ResourceGroupName testgroup
Get-AzTimeSeriesInsightsReferenceDataSet -EnvironmentName tsitest001 -ResourceGroupName testgroup
```

Location Name Type
-------- ---- ----
eastus dstest001 Microsoft.TimeSeriesInsights/Environments/ReferenceDataSets
eastus dstest002 Microsoft.TimeSeriesInsights/Environments/ReferenceDataSets
```

This command lists all reference data sets under the specified environment.

### Get a specified reference data set
### -------------------------- EXAMPLE 2 --------------------------
```powershell
PS C:\> Get-AzTimeSeriesInsightsReferenceDataSet -EnvironmentName tsitest001 -ResourceGroupName testgroup -ReferenceDataSetName dstest001
Get-AzTimeSeriesInsightsReferenceDataSet -EnvironmentName tsitest001 -ResourceGroupName testgroup -ReferenceDataSetName dstest001
```

Location Name Type
-------- ---- ----
eastus dstest001 Microsoft.TimeSeriesInsights/Environments/ReferenceDataSets

### -------------------------- EXAMPLE 3 --------------------------
```powershell
$ds = Get-AzTimeSeriesInsightsReferenceDataSet -ResourceGroupName tsi-test-i01k5l -EnvironmentName tsi-envv8u56x -Name tsirdsqwufij
```

This command gets a specified reference data set.
PS C:\\>Get-AzTimeSeriesInsightsReferenceDataSet -InputObject $ds

Location Name Type
-------- ---- ----
eastus2 tsirdsqwufij Microsoft.TimeSeriesInsights/Environments/ReferenceDataSets

## PARAMETERS

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,16 +23,14 @@ Create or update an access policy in the specified environment.

## EXAMPLES

### Example 1: Create an access policy for a specified environment
### -------------------------- EXAMPLE 1 --------------------------
```powershell
PS C:\> New-AzTimeSeriesInsightsAccessPolicy -EnvironmentName tsitest001 -ResourceGroupName testgroup -PrincipalObjectId ce74a389-b5e8-4f16-89c7-787031ddd903 -Role Contributor -Name policy001
New-AzTimeSeriesInsightsAccessPolicy -EnvironmentName tsitest001 -ResourceGroupName testgroup -PrincipalObjectId ce74a389-b5e8-4f16-89c7-787031ddd903 -Role Contributor -Name policy001
```

Name Type
---- ----
policy001 Microsoft.TimeSeriesInsights/Environments/AccessPolicies
```

This command creates an access policy for a specified environment.

## PARAMETERS

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,31 +34,29 @@ Create an environment in the specified subscription and resource group.

## EXAMPLES

### Example 1: Create a standard time series insights environment
### -------------------------- EXAMPLE 1 --------------------------
```powershell
PS C:\> $TimeSpan = New-TimeSpan -Days 1 -Hours 1 -Minutes 25
PS C:\> New-AzTimeSeriesInsightsEnvironment -ResourceGroupName testgroup -Name tsitest001 -Kind Standard -Location eastus -Sku S1 -DataRetentionTime $TimeSpan -Capacity 2
$TimeSpan = New-TimeSpan -Days 1 -Hours 1 -Minutes 25
```

PS C:\\> New-AzTimeSeriesInsightsEnvironment -ResourceGroupName testgroup -Name tsitest001 -Kind Standard -Location eastus -Sku S1 -DataRetentionTime $TimeSpan -Capacity 2

Kind Location Name SkuCapacity SkuName Type
---- -------- ---- ----------- ------- ----
Standard eastus tsitest001 2 S1 Microsoft.TimeSeriesInsights/Environments
```

This command creates a standard time series insights environment.

### Example 2: Create a longterm time series insights environment
### -------------------------- EXAMPLE 2 --------------------------
```powershell
PS C:\> New-AzStorageAccount -ResourceGroupName testgroup -AccountName staccount001 -Location eastus -SkuName Standard_GRS
PS C:\> $ks = Get-AzStorageAccountKey -ResourceGroupName "testgroup" -Name "staccount001"
PS C:\> $k = $ks[0] | ConvertTo-SecureString -AsPlainText -Force
PS C:\> New-AzTimeSeriesInsightsEnvironment -ResourceGroupName testgroup -Name tsitest002 -Kind LongTerm -Location eastus -Sku L1 -StorageAccountName staccount001 -StorageAccountKey $k -TimeSeriesIdProperty @{name='cdc';type='string'}
New-AzStorageAccount -ResourceGroupName testgroup -AccountName staccount001 -Location eastus -SkuName Standard_GRS
```

PS C:\\> $ks = Get-AzStorageAccountKey -ResourceGroupName "testgroup" -Name "staccount001"
PS C:\\> $k = $ks[0] | ConvertTo-SecureString -AsPlainText -Force
PS C:\\> New-AzTimeSeriesInsightsEnvironment -ResourceGroupName testgroup -Name tsitest002 -Kind LongTerm -Location eastus -Sku L1 -StorageAccountName staccount001 -StorageAccountKey $k -TimeSeriesIdProperty @{name='cdc';type='string'}

Kind Location Name SkuCapacity SkuName Type
---- -------- ---- ----------- ------- ----
LongTerm eastus tsitest002 1 L1 Microsoft.TimeSeriesInsights/Environments
```

This command creates a longterm time series insights environment.

## PARAMETERS

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,34 +34,32 @@ Create an event source under the specified environment.

## EXAMPLES

### Example 1: Create an eventhub event source under the specified environment
### -------------------------- EXAMPLE 1 --------------------------
```powershell
PS C:\> $ev = New-AzEventHub -ResourceGroupName testgroup2 -NamespaceName spacename001 -Name hubname001 -MessageRetentionInDays 3 -PartitionCount 2
PS C:\> $ks = Get-AzEventHubKey -ResourceGroupName testgroup2 -NamespaceName spacename001 -AuthorizationRuleName RootManageSharedAccessKey
PS C:\> $k = $ks.PrimaryKey | ConvertTo-SecureString -AsPlainText -Force
PS C:\> New-AzTimeSeriesInsightsEventSource -ResourceGroupName testgroup -Name estest001 -EnvironmentName tsitest001 -Kind Microsoft.EventHub -ConsumerGroupName testgroup2 -Location eastus -KeyName RootManageSharedAccessKey -ServiceBusNameSpace spacename001 -EventHubName hubname001 -EventSourceResourceId $ev.id -SharedAccessKey $k
$ev = New-AzEventHub -ResourceGroupName testgroup2 -NamespaceName spacename001 -Name hubname001 -MessageRetentionInDays 3 -PartitionCount 2
```

PS C:\\> $ks = Get-AzEventHubKey -ResourceGroupName testgroup2 -NamespaceName spacename001 -AuthorizationRuleName RootManageSharedAccessKey
PS C:\\> $k = $ks.PrimaryKey | ConvertTo-SecureString -AsPlainText -Force
PS C:\\> New-AzTimeSeriesInsightsEventSource -ResourceGroupName testgroup -Name estest001 -EnvironmentName tsitest001 -Kind Microsoft.EventHub -ConsumerGroupName testgroup2 -Location eastus -KeyName RootManageSharedAccessKey -ServiceBusNameSpace spacename001 -EventHubName hubname001 -EventSourceResourceId $ev.id -SharedAccessKey $k

Kind Location Name Type
---- -------- ---- ----
Microsoft.EventHub eastus estest001 Microsoft.TimeSeriesInsights/Environments/EventSources
```

This command creates an eventhub event source under the specified environment.

### Example 2: Create an iothub event source under the specified environment
### -------------------------- EXAMPLE 2 --------------------------
```powershell
PS C:\> $ev = New-AzIotHub -ResourceGroupName testgroup2 -Location eastus -Name iotname001 -SkuName S1 -Units 100
PS C:\> $ks = Get-AzIotHubKey -ResourceGroupName testgroup2 -Name iotname001
PS C:\> $k = $ks[0].PrimaryKey | ConvertTo-SecureString -AsPlainText -Force
PS C:\> New-AzTimeSeriesInsightsEventSource -ResourceGroupName testgroup -Name iots001
$ev = New-AzIotHub -ResourceGroupName testgroup2 -Location eastus -Name iotname001 -SkuName S1 -Units 100
```

PS C:\\> $ks = Get-AzIotHubKey -ResourceGroupName testgroup2 -Name iotname001
PS C:\\> $k = $ks[0].PrimaryKey | ConvertTo-SecureString -AsPlainText -Force
PS C:\\> New-AzTimeSeriesInsightsEventSource -ResourceGroupName testgroup -Name iots001
-EnvironmentName tsitest001 -Kind Microsoft.IoTHub -ConsumerGroupName testgroup2 -Location eastus -KeyName RootManageSharedAccessKey -IoTHubName iotname001 -EventSourceResourceId $ev.id -SharedAccessKey $k

Location Name Type Kind
-------- ---- ---- ----
eastus iots001 Microsoft.TimeSeriesInsights/Environments/EventSources Microsoft.IoTHub
```

This command creates an iothub event source under the specified environment.

## PARAMETERS

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,17 +24,16 @@ Create or update a reference data set in the specified environment.

## EXAMPLES

### Example 1: Create a reference data set for a specified environment
### -------------------------- EXAMPLE 1 --------------------------
```powershell
PS C:\> $mykeyproperties = @{ "name" = "device01"; "type" = "Double"}
PS C:\> New-AzTimeSeriesInsightsReferenceDataSet -EnvironmentName tsitest001 -Name dstest001 -ResourceGroupName testgroup -Location eastus -DataStringComparisonBehavior Ordinal -KeyProperty $mykeyproperties
$mykeyproperties = @{ "name" = "device01"; "type" = "Double"}
```

PS C:\\> New-AzTimeSeriesInsightsReferenceDataSet -EnvironmentName tsitest001 -Name dstest001 -ResourceGroupName testgroup -Location eastus -DataStringComparisonBehavior Ordinal -KeyProperty $mykeyproperties

Location Name Type
-------- ---- ----
eastus dstest001 Microsoft.TimeSeriesInsights/Environments/ReferenceDataSets
```

This command creates a reference data set for a specific environment.

## PARAMETERS

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,19 @@ Deletes the access policy with the specified name in the specified subscription,

## EXAMPLES

### Example 1: Remove a specified access policy
### -------------------------- EXAMPLE 1 --------------------------
```powershell
PS C:\> Remove-AzTimeSeriesInsightsAccessPolicy -EnvironmentName tsitest001 -Name policy001 -ResourceGroupName testgroup
Remove-AzTimeSeriesInsightsAccessPolicy -EnvironmentName tsitest001 -Name policy001 -ResourceGroupName testgroup
```



### -------------------------- EXAMPLE 2 --------------------------
```powershell
$policy = Get-AzTimeSeriesInsightsAccessPolicy -EnvironmentName tsitest001 -Name policy001 -ResourceGroupName testgroup
```

This command removes a specified access policy.
PS C:\\> Remove-AzTimeSeriesInsightsAccessPolicy -InputObject $policy

## PARAMETERS

Expand Down
Loading