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
2 changes: 1 addition & 1 deletion src/TimeSeriesInsights/docs/Az.TimeSeriesInsights.md
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 @@ -47,7 +47,7 @@ policy002 Microsoft.TimeSeriesInsights/Environments/AccessPolicies

This command lists all access policies under a specified environment.

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

Expand All @@ -58,6 +58,18 @@ policy001 Microsoft.TimeSeriesInsights/Environments/AccessPolicies

This command gets a specified access policy.

### Example 3: Get a specified access policy by object
```powershell
PS C:\>$ap = Get-AzTimeSeriesInsightsAccessPolicy -EnvironmentName tsi-envv8u56x -ResourceGroupName tsi-test-i01k5l -Name tsi-apilgj5y
PS C:\>Get-AzTimeSeriesInsightsAccessPolicy -InputObject $ap

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

This command gets a specified access policy.

## PARAMETERS

### -DefaultProfile
Expand Down
29 changes: 29 additions & 0 deletions src/TimeSeriesInsights/docs/Get-AzTimeSeriesInsightsEnvironment.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,35 @@ Type : Microsoft.TimeSeriesInsights/Environments

This command lists all time series insights environments in a resource group.

### Example 3: Get a time series insights environment by object
```powershell
PS C:\> $env = Get-AzTimeSeriesInsightsEnvironment -ResourceGroupName tsi-test-i01k5l -EnvironmentName tsi-envv8u56x
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
```

This command gets a time series insights environments.

## PARAMETERS

### -DefaultProfile
Expand Down
25 changes: 23 additions & 2 deletions src/TimeSeriesInsights/docs/Get-AzTimeSeriesInsightsEventSource.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,9 +70,9 @@ Type : Microsoft.TimeSeriesInsights/Environments/EventSources

This command lists all event sources under the specified environments.

### Example 2: Get a specified event source
### Example 2: Get a specified event source by name
```powershell
PS C:\> et-AzTimeSeriesInsightsEventSource -ResourceGroupName testgroup -EnvironmentName tsitest001 -Name iots001
PS C:\> 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 @@ -90,6 +90,27 @@ Type : Microsoft.TimeSeriesInsights/Environments/EventSources

This command gets a specific event source.

### Example 3: Get a specified event source by object
```powershell
PS C:\> $es = Get-AzTimeSeriesInsightsEventSource -ResourceGroupName tsi-test-i01k5l -EnvironmentName tsi-envv8u56x -Name tsi-esrfyi9h
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
```

This command gets a specific event source.

## PARAMETERS

### -DefaultProfile
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ 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: Get a specified reference data set by name
```powershell
PS C:\> Get-AzTimeSeriesInsightsReferenceDataSet -EnvironmentName tsitest001 -ResourceGroupName testgroup -ReferenceDataSetName dstest001

Expand All @@ -58,6 +58,18 @@ eastus dstest001 Microsoft.TimeSeriesInsights/Environments/ReferenceDataSets

This command gets a specified reference data set.

### Example 3: Get a specified reference data set by object
```powershell
PS C:\> $ds = Get-AzTimeSeriesInsightsReferenceDataSet -ResourceGroupName tsi-test-i01k5l -EnvironmentName tsi-envv8u56x -Name tsirdsqwufij
PS C:\>Get-AzTimeSeriesInsightsReferenceDataSet -InputObject $ds

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

This command gets a specified reference data set.

## PARAMETERS

### -DefaultProfile
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,14 +29,23 @@ Deletes the access policy with the specified name in the specified subscription,

## EXAMPLES

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

```

This command removes a specified access policy.

### Example 2: Remove a specified access policy by object
```powershell
PS C:\> $policy = Get-AzTimeSeriesInsightsAccessPolicy -EnvironmentName tsitest001 -Name policy001 -ResourceGroupName testgroup
PS C:\> Remove-AzTimeSeriesInsightsAccessPolicy -InputObject $policy

```

This command removes a specified access policy.

## PARAMETERS

### -DefaultProfile
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,14 +29,23 @@ Deletes the environment with the specified name in the specified subscription an

## EXAMPLES

### Example 1: Remove a time series insights environment
### Example 1: Remove a time series insights environment by name
```powershell
PS C:\> Remove-AzTimeSeriesInsightsEnvironment -ResourceGroupName testgroup -Name tsill

```

This command removes a time series insights environment.

### Example 2: Remove a time series insights environment by object
```powershell
PS C:\> $env = Get-AzTimeSeriesInsightsEnvironment -ResourceGroupName testgroup -Name tsill
PS C:\> Remove-AzTimeSeriesInsightsEnvironment -InputObject $env

```

This command removes a time series insights environment.

## PARAMETERS

### -DefaultProfile
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,14 +29,23 @@ Deletes the event source with the specified name in the specified subscription,

## EXAMPLES

### Example 1: Remove a specified event source
### Example 1: Remove a specified event source by name
```powershell
PS C:\> Remove-AzTimeSeriesInsightsEventSource -EnvironmentName tsitest001 -Name iots001 -ResourceGroupName testgroup

```

This removes a specific event source.

### Example 2: Remove a specified event source by object
```powershell
PS C:\> $es = Get-AzTimeSeriesInsightsEventSource -EnvironmentName tsitest001 -ResourceGroupName testgroup -Name iots001
PS C:\> Remove-AzTimeSeriesInsightsEventSource -InputObject $es

```

This removes a specific event source.

## PARAMETERS

### -DefaultProfile
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,14 +30,23 @@ Deletes the reference data set with the specified name in the specified subscrip

## EXAMPLES

### Example 1: Remove a specified reference data set
### Example 1: Remove a specified reference data set by name
```powershell
PS C:\> Remove-AzTimeSeriesInsightsReferenceDataSet -EnvironmentName tsitest001 -Name dstest001 -ResourceGroupName testgroup

```

This command removes a specified reference data set.

### Example 2: Remove a specified reference data set by object
```powershell
PS C:\> $ds = Get-AzTimeSeriesInsightsReferenceDataSet -EnvironmentName tsitest001 -Name dstest001 -ResourceGroupName testgroup
PS C:\> Remove-AzTimeSeriesInsightsReferenceDataSet -InputObject $ds

```

This command removes a specified reference data set.

## PARAMETERS

### -DefaultProfile
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Updates the access policy with the specified name in the specified subscription,

## EXAMPLES

### Example 1: Update a specified access policy
### Example 1: Update a specified access policy by name
```powershell
PS C:\> Update-AzTimeSeriesInsightsAccessPolicy -EnvironmentName tsitest001 -Name policy001 -ResourceGroupName testgroup -Role Contributor,Reader

Expand All @@ -41,6 +41,18 @@ policy001 Microsoft.TimeSeriesInsights/Environments/AccessPolicies

This command updates a specified access policy.

### Example 2: Update a specified access policy by object
```powershell
PS C:\> $policy = Get-AzTimeSeriesInsightsAccessPolicy -EnvironmentName tsitest001 -ResourceGroupName $env.resourceGroup -Name policy001
PS C:\> Update-AzTimeSeriesInsightsAccessPolicy -InputObject $policy -Role Contributor

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

This command updates a specified access policy.

## PARAMETERS

### -DefaultProfile
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,14 +62,35 @@ Type : Microsoft.TimeSeriesInsights/Environments

This command updates a standard time series insights environment.

### Example 2: {{ Api definition for update a longterm environment is missing in swagger and should be added in the future}}
### Example 2: Update a standard time series insights environment
```powershell
PS C:\> {{ Add code here }}
PS C:\> $env = Get-AzTimeSeriesInsightsEnvironment -ResourceGroupName testgroup -Name tsitest001
PS C:\> PS C:\> Update-AzTimeSeriesInsightsEnvironment -InputObject $env -Capacity 6 -Sku S1

{{ Add output here }}
DataAccessFqdn : b6d113a4-0865-405f-b09e-ad4355b5d046.env.timeseries.azure.com
DataAccessId : b6d113a4-0865-405f-b09e-ad4355b5d046
DataRetentionTime : 1.01:25:00
Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/testgroup/providers/Microsoft.TimeSeriesInsights/environments/tsitest
001
IngressState :
Kind : Standard
Location : eastus
Name : tsitest001
PartitionKeyProperty :
PropertyUsageState :
Sku : Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.Api20180815Preview.Sku
SkuCapacity : 6
SkuName : S1
StateDetailCode :
StateDetailCurrentCount :
StateDetailMaxCount :
StateDetailMessage :
StorageLimitExceededBehavior : PurgeOldData
Tag : Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.Api20180815Preview.TrackedResourceTags
Type : Microsoft.TimeSeriesInsights/Environments
```

{{ Add description here }}
This command updates a standard time series insights environment.

## PARAMETERS

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Updates the event source with the specified name in the specified subscription,

## EXAMPLES

### Example 1: Update a specified event source
### Example 1: Update a specified event source by name
```powershell
PS C:\> Update-AzTimeSeriesInsightsEventSource -EnvironmentName tsitest001 -Name iots001 -ResourceGroupName testgroup -Tag @{"tgk"="001"}

Expand All @@ -49,6 +49,26 @@ Type : Microsoft.TimeSeriesInsights/Environments/EventSources

This command updates a specific event source.

### Example 3: Update a specified event source by object
```powershell
PS C:\>$es = Get-AzTimeSeriesInsightsEventSource -EnvironmentName tsitest001 -ResourceGroupName testgroup -Name iots001
PS C:\> Update-AzTimeSeriesInsightsEventSource -InputObject -Tag @{"tgb"="002"}

ConsumerGroupName : testgroup2
EventSourceResourceId : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/testgroup2/providers/Microsoft.Devices/IotHubs/iotname001
Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/testgroup/providers/Microsoft.TimeSeriesInsights/environments/tsitest001/eventsources/iots001
IotHubName : iotname001
KeyName : RootManageSharedAccessKey
Kind : Microsoft.IoTHub
Location : eastus
Name : iots001
Tag : Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.Api20180815Preview.TrackedResourceTags
TimestampPropertyName :
Type : Microsoft.TimeSeriesInsights/Environments/EventSources
```

This command updates a specific event source.

## PARAMETERS

### -DefaultProfile
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Updates the reference data set with the specified name in the specified subscrip

## EXAMPLES

### Example 1: Update a specified reference data set
### Example 1: Update a specified reference data set by name
```powershell
PS C:\> Update-AzTimeSeriesInsightsReferenceDataSet -EnvironmentName tsitest001 -Name dstest001 -ResourceGroupName testgroup -Tag @{"tstg"="lb001"}

Expand All @@ -41,6 +41,18 @@ eastus dstest001 Microsoft.TimeSeriesInsights/Environments/ReferenceDataSets

This command updates a specified reference data set.

### Example 2: Update a specified reference data set by object
```powershell
PS C:\> $ds = Get-AzTimeSeriesInsightsReferenceDataSet -EnvironmentName tsitest001 -ResourceGroupName testgroup -ReferenceDataSetName dstest001
PS C:\> Update-AzTimeSeriesInsightsReferenceDataSet -InputObject $ds -Tag @{"tstg"="lb001"}

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

This command updates a specified reference data set.

## PARAMETERS

### -DefaultProfile
Expand Down
11 changes: 0 additions & 11 deletions src/TimeSeriesInsights/docs/readme.md

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ Type : Microsoft.TimeSeriesInsights/Environments

This command lists all time series insights environments in a resource group.

### Example 3: Get a time series insights environments by object
### Example 3: Get a time series insights environment by object
```powershell
PS C:\> $env = Get-AzTimeSeriesInsightsEnvironment -ResourceGroupName tsi-test-i01k5l -EnvironmentName tsi-envv8u56x
PS C:\> Get-AzTimeSeriesInsightsEnvironment -InputObject $env
Expand Down
Loading