From de9a4fab2cedb34e6e3e9d2a72442e5046c4b9a3 Mon Sep 17 00:00:00 2001 From: LucasYao93 Date: Wed, 8 Apr 2020 23:31:54 -0700 Subject: [PATCH 1/3] modified and deleted file. --- .../Get-AzTimeSeriesInsightsEnvironment.md | 2 +- .../Az.TimeSeriesInsights-TestResults.xml | 173 ------------------ 2 files changed, 1 insertion(+), 174 deletions(-) delete mode 100644 src/TimeSeriesInsights/test/Az.TimeSeriesInsights-TestResults.xml diff --git a/src/TimeSeriesInsights/examples/Get-AzTimeSeriesInsightsEnvironment.md b/src/TimeSeriesInsights/examples/Get-AzTimeSeriesInsightsEnvironment.md index b2f1a722375c..fbe15c40b7b0 100644 --- a/src/TimeSeriesInsights/examples/Get-AzTimeSeriesInsightsEnvironment.md +++ b/src/TimeSeriesInsights/examples/Get-AzTimeSeriesInsightsEnvironment.md @@ -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 diff --git a/src/TimeSeriesInsights/test/Az.TimeSeriesInsights-TestResults.xml b/src/TimeSeriesInsights/test/Az.TimeSeriesInsights-TestResults.xml deleted file mode 100644 index f89de130ad8b..000000000000 --- a/src/TimeSeriesInsights/test/Az.TimeSeriesInsights-TestResults.xml +++ /dev/null @@ -1,173 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file From 26aeb75fd677714bb86d58d90b345d0b000e937c Mon Sep 17 00:00:00 2001 From: LucasYao93 Date: Thu, 9 Apr 2020 00:30:04 -0700 Subject: [PATCH 2/3] Modified readme.md and Rebuild docs. --- .../{ => exports}/Az.TimeSeriesInsights.md | 2 +- .../Get-AzTimeSeriesInsightsAccessPolicy.md | 23 +++++++---- .../Get-AzTimeSeriesInsightsEnvironment.md | 40 +++++++++++++++---- .../Get-AzTimeSeriesInsightsEventSource.md | 32 +++++++++++---- ...et-AzTimeSeriesInsightsReferenceDataSet.md | 23 +++++++---- .../New-AzTimeSeriesInsightsAccessPolicy.md | 8 ++-- .../New-AzTimeSeriesInsightsEnvironment.md | 26 ++++++------ .../New-AzTimeSeriesInsightsEventSource.md | 30 +++++++------- ...ew-AzTimeSeriesInsightsReferenceDataSet.md | 11 +++-- ...Remove-AzTimeSeriesInsightsAccessPolicy.md | 12 ++++-- .../Remove-AzTimeSeriesInsightsEnvironment.md | 12 ++++-- .../Remove-AzTimeSeriesInsightsEventSource.md | 12 ++++-- ...ve-AzTimeSeriesInsightsReferenceDataSet.md | 12 ++++-- ...Update-AzTimeSeriesInsightsAccessPolicy.md | 15 +++++-- .../Update-AzTimeSeriesInsightsEnvironment.md | 38 +++++++++++++----- .../Update-AzTimeSeriesInsightsEventSource.md | 23 +++++++++-- ...te-AzTimeSeriesInsightsReferenceDataSet.md | 15 +++++-- src/TimeSeriesInsights/docs/readme.md | 4 +- src/TimeSeriesInsights/readme.md | 3 -- 19 files changed, 231 insertions(+), 110 deletions(-) rename src/TimeSeriesInsights/docs/{ => exports}/Az.TimeSeriesInsights.md (98%) rename src/TimeSeriesInsights/docs/{ => exports}/Get-AzTimeSeriesInsightsAccessPolicy.md (86%) rename src/TimeSeriesInsights/docs/{ => exports}/Get-AzTimeSeriesInsightsEnvironment.md (82%) rename src/TimeSeriesInsights/docs/{ => exports}/Get-AzTimeSeriesInsightsEventSource.md (81%) rename src/TimeSeriesInsights/docs/{ => exports}/Get-AzTimeSeriesInsightsReferenceDataSet.md (85%) rename src/TimeSeriesInsights/docs/{ => exports}/New-AzTimeSeriesInsightsAccessPolicy.md (92%) rename src/TimeSeriesInsights/docs/{ => exports}/New-AzTimeSeriesInsightsEnvironment.md (90%) rename src/TimeSeriesInsights/docs/{ => exports}/New-AzTimeSeriesInsightsEventSource.md (84%) rename src/TimeSeriesInsights/docs/{ => exports}/New-AzTimeSeriesInsightsReferenceDataSet.md (92%) rename src/TimeSeriesInsights/docs/{ => exports}/Remove-AzTimeSeriesInsightsAccessPolicy.md (91%) rename src/TimeSeriesInsights/docs/{ => exports}/Remove-AzTimeSeriesInsightsEnvironment.md (92%) rename src/TimeSeriesInsights/docs/{ => exports}/Remove-AzTimeSeriesInsightsEventSource.md (91%) rename src/TimeSeriesInsights/docs/{ => exports}/Remove-AzTimeSeriesInsightsReferenceDataSet.md (91%) rename src/TimeSeriesInsights/docs/{ => exports}/Update-AzTimeSeriesInsightsAccessPolicy.md (90%) rename src/TimeSeriesInsights/docs/{ => exports}/Update-AzTimeSeriesInsightsEnvironment.md (85%) rename src/TimeSeriesInsights/docs/{ => exports}/Update-AzTimeSeriesInsightsEventSource.md (82%) rename src/TimeSeriesInsights/docs/{ => exports}/Update-AzTimeSeriesInsightsReferenceDataSet.md (89%) diff --git a/src/TimeSeriesInsights/docs/Az.TimeSeriesInsights.md b/src/TimeSeriesInsights/docs/exports/Az.TimeSeriesInsights.md similarity index 98% rename from src/TimeSeriesInsights/docs/Az.TimeSeriesInsights.md rename to src/TimeSeriesInsights/docs/exports/Az.TimeSeriesInsights.md index 39a4ad65476b..34438cff1e97 100644 --- a/src/TimeSeriesInsights/docs/Az.TimeSeriesInsights.md +++ b/src/TimeSeriesInsights/docs/exports/Az.TimeSeriesInsights.md @@ -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 diff --git a/src/TimeSeriesInsights/docs/Get-AzTimeSeriesInsightsAccessPolicy.md b/src/TimeSeriesInsights/docs/exports/Get-AzTimeSeriesInsightsAccessPolicy.md similarity index 86% rename from src/TimeSeriesInsights/docs/Get-AzTimeSeriesInsightsAccessPolicy.md rename to src/TimeSeriesInsights/docs/exports/Get-AzTimeSeriesInsightsAccessPolicy.md index b2c9b658e028..072dba5c4784 100644 --- a/src/TimeSeriesInsights/docs/Get-AzTimeSeriesInsightsAccessPolicy.md +++ b/src/TimeSeriesInsights/docs/exports/Get-AzTimeSeriesInsightsAccessPolicy.md @@ -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 diff --git a/src/TimeSeriesInsights/docs/Get-AzTimeSeriesInsightsEnvironment.md b/src/TimeSeriesInsights/docs/exports/Get-AzTimeSeriesInsightsEnvironment.md similarity index 82% rename from src/TimeSeriesInsights/docs/Get-AzTimeSeriesInsightsEnvironment.md rename to src/TimeSeriesInsights/docs/exports/Get-AzTimeSeriesInsightsEnvironment.md index bd07927232ed..bc19cf52ce88 100644 --- a/src/TimeSeriesInsights/docs/Get-AzTimeSeriesInsightsEnvironment.md +++ b/src/TimeSeriesInsights/docs/exports/Get-AzTimeSeriesInsightsEnvironment.md @@ -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 @@ -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 @@ -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 diff --git a/src/TimeSeriesInsights/docs/Get-AzTimeSeriesInsightsEventSource.md b/src/TimeSeriesInsights/docs/exports/Get-AzTimeSeriesInsightsEventSource.md similarity index 81% rename from src/TimeSeriesInsights/docs/Get-AzTimeSeriesInsightsEventSource.md rename to src/TimeSeriesInsights/docs/exports/Get-AzTimeSeriesInsightsEventSource.md index 28e69f50d162..f09117a14f37 100644 --- a/src/TimeSeriesInsights/docs/Get-AzTimeSeriesInsightsEventSource.md +++ b/src/TimeSeriesInsights/docs/exports/Get-AzTimeSeriesInsightsEventSource.md @@ -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 @@ -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 @@ -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 diff --git a/src/TimeSeriesInsights/docs/Get-AzTimeSeriesInsightsReferenceDataSet.md b/src/TimeSeriesInsights/docs/exports/Get-AzTimeSeriesInsightsReferenceDataSet.md similarity index 85% rename from src/TimeSeriesInsights/docs/Get-AzTimeSeriesInsightsReferenceDataSet.md rename to src/TimeSeriesInsights/docs/exports/Get-AzTimeSeriesInsightsReferenceDataSet.md index 71e32b3820d5..2f50bf1bdf8a 100644 --- a/src/TimeSeriesInsights/docs/Get-AzTimeSeriesInsightsReferenceDataSet.md +++ b/src/TimeSeriesInsights/docs/exports/Get-AzTimeSeriesInsightsReferenceDataSet.md @@ -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 diff --git a/src/TimeSeriesInsights/docs/New-AzTimeSeriesInsightsAccessPolicy.md b/src/TimeSeriesInsights/docs/exports/New-AzTimeSeriesInsightsAccessPolicy.md similarity index 92% rename from src/TimeSeriesInsights/docs/New-AzTimeSeriesInsightsAccessPolicy.md rename to src/TimeSeriesInsights/docs/exports/New-AzTimeSeriesInsightsAccessPolicy.md index 430182482b7c..162194784140 100644 --- a/src/TimeSeriesInsights/docs/New-AzTimeSeriesInsightsAccessPolicy.md +++ b/src/TimeSeriesInsights/docs/exports/New-AzTimeSeriesInsightsAccessPolicy.md @@ -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 diff --git a/src/TimeSeriesInsights/docs/New-AzTimeSeriesInsightsEnvironment.md b/src/TimeSeriesInsights/docs/exports/New-AzTimeSeriesInsightsEnvironment.md similarity index 90% rename from src/TimeSeriesInsights/docs/New-AzTimeSeriesInsightsEnvironment.md rename to src/TimeSeriesInsights/docs/exports/New-AzTimeSeriesInsightsEnvironment.md index b40d12d786f4..a0bf7c8a4754 100644 --- a/src/TimeSeriesInsights/docs/New-AzTimeSeriesInsightsEnvironment.md +++ b/src/TimeSeriesInsights/docs/exports/New-AzTimeSeriesInsightsEnvironment.md @@ -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 diff --git a/src/TimeSeriesInsights/docs/New-AzTimeSeriesInsightsEventSource.md b/src/TimeSeriesInsights/docs/exports/New-AzTimeSeriesInsightsEventSource.md similarity index 84% rename from src/TimeSeriesInsights/docs/New-AzTimeSeriesInsightsEventSource.md rename to src/TimeSeriesInsights/docs/exports/New-AzTimeSeriesInsightsEventSource.md index c4507fd76bb8..41ba4e2cffa2 100644 --- a/src/TimeSeriesInsights/docs/New-AzTimeSeriesInsightsEventSource.md +++ b/src/TimeSeriesInsights/docs/exports/New-AzTimeSeriesInsightsEventSource.md @@ -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 diff --git a/src/TimeSeriesInsights/docs/New-AzTimeSeriesInsightsReferenceDataSet.md b/src/TimeSeriesInsights/docs/exports/New-AzTimeSeriesInsightsReferenceDataSet.md similarity index 92% rename from src/TimeSeriesInsights/docs/New-AzTimeSeriesInsightsReferenceDataSet.md rename to src/TimeSeriesInsights/docs/exports/New-AzTimeSeriesInsightsReferenceDataSet.md index dbdcd7485872..8eaebe5f9e9f 100644 --- a/src/TimeSeriesInsights/docs/New-AzTimeSeriesInsightsReferenceDataSet.md +++ b/src/TimeSeriesInsights/docs/exports/New-AzTimeSeriesInsightsReferenceDataSet.md @@ -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 diff --git a/src/TimeSeriesInsights/docs/Remove-AzTimeSeriesInsightsAccessPolicy.md b/src/TimeSeriesInsights/docs/exports/Remove-AzTimeSeriesInsightsAccessPolicy.md similarity index 91% rename from src/TimeSeriesInsights/docs/Remove-AzTimeSeriesInsightsAccessPolicy.md rename to src/TimeSeriesInsights/docs/exports/Remove-AzTimeSeriesInsightsAccessPolicy.md index 627b4f5b080c..dbaad0b458d0 100644 --- a/src/TimeSeriesInsights/docs/Remove-AzTimeSeriesInsightsAccessPolicy.md +++ b/src/TimeSeriesInsights/docs/exports/Remove-AzTimeSeriesInsightsAccessPolicy.md @@ -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 diff --git a/src/TimeSeriesInsights/docs/Remove-AzTimeSeriesInsightsEnvironment.md b/src/TimeSeriesInsights/docs/exports/Remove-AzTimeSeriesInsightsEnvironment.md similarity index 92% rename from src/TimeSeriesInsights/docs/Remove-AzTimeSeriesInsightsEnvironment.md rename to src/TimeSeriesInsights/docs/exports/Remove-AzTimeSeriesInsightsEnvironment.md index 5dd00eca1b5c..ed7e09bdab76 100644 --- a/src/TimeSeriesInsights/docs/Remove-AzTimeSeriesInsightsEnvironment.md +++ b/src/TimeSeriesInsights/docs/exports/Remove-AzTimeSeriesInsightsEnvironment.md @@ -29,13 +29,19 @@ Deletes the environment with the specified name in the specified subscription an ## EXAMPLES -### Example 1: Remove a time series insights environment +### -------------------------- EXAMPLE 1 -------------------------- ```powershell -PS C:\> Remove-AzTimeSeriesInsightsEnvironment -ResourceGroupName testgroup -Name tsill +Remove-AzTimeSeriesInsightsEnvironment -ResourceGroupName testgroup -Name tsill +``` + + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +$env = Get-AzTimeSeriesInsightsEnvironment -ResourceGroupName testgroup -Name tsill ``` -This command removes a time series insights environment. +PS C:\\> Remove-AzTimeSeriesInsightsEnvironment -InputObject $env ## PARAMETERS diff --git a/src/TimeSeriesInsights/docs/Remove-AzTimeSeriesInsightsEventSource.md b/src/TimeSeriesInsights/docs/exports/Remove-AzTimeSeriesInsightsEventSource.md similarity index 91% rename from src/TimeSeriesInsights/docs/Remove-AzTimeSeriesInsightsEventSource.md rename to src/TimeSeriesInsights/docs/exports/Remove-AzTimeSeriesInsightsEventSource.md index 8c4b37446b5f..2b3590e510e0 100644 --- a/src/TimeSeriesInsights/docs/Remove-AzTimeSeriesInsightsEventSource.md +++ b/src/TimeSeriesInsights/docs/exports/Remove-AzTimeSeriesInsightsEventSource.md @@ -29,13 +29,19 @@ Deletes the event source with the specified name in the specified subscription, ## EXAMPLES -### Example 1: Remove a specified event source +### -------------------------- EXAMPLE 1 -------------------------- ```powershell -PS C:\> Remove-AzTimeSeriesInsightsEventSource -EnvironmentName tsitest001 -Name iots001 -ResourceGroupName testgroup +Remove-AzTimeSeriesInsightsEventSource -EnvironmentName tsitest001 -Name iots001 -ResourceGroupName testgroup +``` + + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +$es = Get-AzTimeSeriesInsightsEventSource -EnvironmentName tsitest001 -ResourceGroupName testgroup -Name iots001 ``` -This removes a specific event source. +PS C:\\> Remove-AzTimeSeriesInsightsEventSource -InputObject $es ## PARAMETERS diff --git a/src/TimeSeriesInsights/docs/Remove-AzTimeSeriesInsightsReferenceDataSet.md b/src/TimeSeriesInsights/docs/exports/Remove-AzTimeSeriesInsightsReferenceDataSet.md similarity index 91% rename from src/TimeSeriesInsights/docs/Remove-AzTimeSeriesInsightsReferenceDataSet.md rename to src/TimeSeriesInsights/docs/exports/Remove-AzTimeSeriesInsightsReferenceDataSet.md index c7c8deae209c..fec6104e095d 100644 --- a/src/TimeSeriesInsights/docs/Remove-AzTimeSeriesInsightsReferenceDataSet.md +++ b/src/TimeSeriesInsights/docs/exports/Remove-AzTimeSeriesInsightsReferenceDataSet.md @@ -30,13 +30,19 @@ Deletes the reference data set with the specified name in the specified subscrip ## EXAMPLES -### Example 1: Remove a specified reference data set +### -------------------------- EXAMPLE 1 -------------------------- ```powershell -PS C:\> Remove-AzTimeSeriesInsightsReferenceDataSet -EnvironmentName tsitest001 -Name dstest001 -ResourceGroupName testgroup +Remove-AzTimeSeriesInsightsReferenceDataSet -EnvironmentName tsitest001 -Name dstest001 -ResourceGroupName testgroup +``` + + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +$ds = Get-AzTimeSeriesInsightsReferenceDataSet -EnvironmentName tsitest001 -Name dstest001 -ResourceGroupName testgroup ``` -This command removes a specified reference data set. +PS C:\\> Remove-AzTimeSeriesInsightsReferenceDataSet -InputObject $ds ## PARAMETERS diff --git a/src/TimeSeriesInsights/docs/Update-AzTimeSeriesInsightsAccessPolicy.md b/src/TimeSeriesInsights/docs/exports/Update-AzTimeSeriesInsightsAccessPolicy.md similarity index 90% rename from src/TimeSeriesInsights/docs/Update-AzTimeSeriesInsightsAccessPolicy.md rename to src/TimeSeriesInsights/docs/exports/Update-AzTimeSeriesInsightsAccessPolicy.md index 2bdfda120a6c..a47fb1b219d6 100644 --- a/src/TimeSeriesInsights/docs/Update-AzTimeSeriesInsightsAccessPolicy.md +++ b/src/TimeSeriesInsights/docs/exports/Update-AzTimeSeriesInsightsAccessPolicy.md @@ -30,16 +30,25 @@ Updates the access policy with the specified name in the specified subscription, ## EXAMPLES -### Example 1: Update a specified access policy +### -------------------------- EXAMPLE 1 -------------------------- ```powershell -PS C:\> Update-AzTimeSeriesInsightsAccessPolicy -EnvironmentName tsitest001 -Name policy001 -ResourceGroupName testgroup -Role Contributor,Reader +Update-AzTimeSeriesInsightsAccessPolicy -EnvironmentName tsitest001 -Name policy001 -ResourceGroupName testgroup -Role Contributor,Reader +``` Name Type ---- ---- policy001 Microsoft.TimeSeriesInsights/Environments/AccessPolicies + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +$policy = Get-AzTimeSeriesInsightsAccessPolicy -EnvironmentName tsitest001 -ResourceGroupName $env.resourceGroup -Name policy001 ``` -This command updates a specified access policy. +PS C:\\> Update-AzTimeSeriesInsightsAccessPolicy -InputObject $policy -Role Contributor + +Name Type +---- ---- +policy001 Microsoft.TimeSeriesInsights/Environments/AccessPolicies ## PARAMETERS diff --git a/src/TimeSeriesInsights/docs/Update-AzTimeSeriesInsightsEnvironment.md b/src/TimeSeriesInsights/docs/exports/Update-AzTimeSeriesInsightsEnvironment.md similarity index 85% rename from src/TimeSeriesInsights/docs/Update-AzTimeSeriesInsightsEnvironment.md rename to src/TimeSeriesInsights/docs/exports/Update-AzTimeSeriesInsightsEnvironment.md index b6141ca0943b..892b58480ef1 100644 --- a/src/TimeSeriesInsights/docs/Update-AzTimeSeriesInsightsEnvironment.md +++ b/src/TimeSeriesInsights/docs/exports/Update-AzTimeSeriesInsightsEnvironment.md @@ -33,9 +33,10 @@ Updates the environment with the specified name in the specified subscription an ## EXAMPLES -### Example 1: Update a standard time series insights environment +### -------------------------- EXAMPLE 1 -------------------------- ```powershell -PS C:\> Update-AzTimeSeriesInsightsEnvironment -ResourceGroupName testgroup -Name tsitest001 -Capacity 5 -Sku S1 +Update-AzTimeSeriesInsightsEnvironment -ResourceGroupName testgroup -Name tsitest001 -Capacity 5 -Sku S1 +``` DataAccessFqdn : b6d113a4-0865-405f-b09e-ad4355b5d046.env.timeseries.azure.com DataAccessId : b6d113a4-0865-405f-b09e-ad4355b5d046 @@ -58,18 +59,35 @@ StateDetailMessage : StorageLimitExceededBehavior : PurgeOldData Tag : Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.Api20180815Preview.TrackedResourceTags 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 -------------------------- ```powershell -PS C:\> {{ Add code here }} - -{{ Add output here }} +$env = Get-AzTimeSeriesInsightsEnvironment -ResourceGroupName testgroup -Name tsitest001 ``` -{{ Add description here }} +PS C:\\> PS C:\\> Update-AzTimeSeriesInsightsEnvironment -InputObject $env -Capacity 6 -Sku S1 + +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 ## PARAMETERS diff --git a/src/TimeSeriesInsights/docs/Update-AzTimeSeriesInsightsEventSource.md b/src/TimeSeriesInsights/docs/exports/Update-AzTimeSeriesInsightsEventSource.md similarity index 82% rename from src/TimeSeriesInsights/docs/Update-AzTimeSeriesInsightsEventSource.md rename to src/TimeSeriesInsights/docs/exports/Update-AzTimeSeriesInsightsEventSource.md index fe5013c066ea..b8ffdbc93d70 100644 --- a/src/TimeSeriesInsights/docs/Update-AzTimeSeriesInsightsEventSource.md +++ b/src/TimeSeriesInsights/docs/exports/Update-AzTimeSeriesInsightsEventSource.md @@ -30,9 +30,10 @@ Updates the event source with the specified name in the specified subscription, ## EXAMPLES -### Example 1: Update a specified event source +### -------------------------- EXAMPLE 1 -------------------------- ```powershell -PS C:\> Update-AzTimeSeriesInsightsEventSource -EnvironmentName tsitest001 -Name iots001 -ResourceGroupName testgroup -Tag @{"tgk"="001"} +Update-AzTimeSeriesInsightsEventSource -EnvironmentName tsitest001 -Name iots001 -ResourceGroupName testgroup -Tag @{"tgk"="001"} +``` ConsumerGroupName : testgroup2 EventSourceResourceId : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/testgroup2/providers/Microsoft.Devices/IotHubs/iotname001 @@ -45,9 +46,25 @@ Name : iots001 Tag : Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.Api20180815Preview.TrackedResourceTags TimestampPropertyName : Type : Microsoft.TimeSeriesInsights/Environments/EventSources + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +$es = Get-AzTimeSeriesInsightsEventSource -EnvironmentName tsitest001 -ResourceGroupName testgroup -Name iots001 ``` -This command updates a specific event source. +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 ## PARAMETERS diff --git a/src/TimeSeriesInsights/docs/Update-AzTimeSeriesInsightsReferenceDataSet.md b/src/TimeSeriesInsights/docs/exports/Update-AzTimeSeriesInsightsReferenceDataSet.md similarity index 89% rename from src/TimeSeriesInsights/docs/Update-AzTimeSeriesInsightsReferenceDataSet.md rename to src/TimeSeriesInsights/docs/exports/Update-AzTimeSeriesInsightsReferenceDataSet.md index 692a916fcbf5..1573ec3aa43a 100644 --- a/src/TimeSeriesInsights/docs/Update-AzTimeSeriesInsightsReferenceDataSet.md +++ b/src/TimeSeriesInsights/docs/exports/Update-AzTimeSeriesInsightsReferenceDataSet.md @@ -30,16 +30,25 @@ Updates the reference data set with the specified name in the specified subscrip ## EXAMPLES -### Example 1: Update a specified reference data set +### -------------------------- EXAMPLE 1 -------------------------- ```powershell -PS C:\> Update-AzTimeSeriesInsightsReferenceDataSet -EnvironmentName tsitest001 -Name dstest001 -ResourceGroupName testgroup -Tag @{"tstg"="lb001"} +Update-AzTimeSeriesInsightsReferenceDataSet -EnvironmentName tsitest001 -Name dstest001 -ResourceGroupName testgroup -Tag @{"tstg"="lb001"} +``` Location Name Type -------- ---- ---- eastus dstest001 Microsoft.TimeSeriesInsights/Environments/ReferenceDataSets + +### -------------------------- EXAMPLE 2 -------------------------- +```powershell +$ds = Get-AzTimeSeriesInsightsReferenceDataSet -EnvironmentName tsitest001 -ResourceGroupName testgroup -ReferenceDataSetName dstest001 ``` -This command updates a specified reference data set. +PS C:\\> Update-AzTimeSeriesInsightsReferenceDataSet -InputObject $ds -Tag @{"tstg"="lb001"} + +Location Name Type +-------- ---- ---- +eastus dstest001 Microsoft.TimeSeriesInsights/Environments/ReferenceDataSets ## PARAMETERS diff --git a/src/TimeSeriesInsights/docs/readme.md b/src/TimeSeriesInsights/docs/readme.md index 8f5f212dd65a..22ecd21751d2 100644 --- a/src/TimeSeriesInsights/docs/readme.md +++ b/src/TimeSeriesInsights/docs/readme.md @@ -1,5 +1,5 @@ # Docs -This directory contains the documentation of the cmdlets for the `Az.TimeSeriesInsights` module. To run documentation generation, use the `generate-help.ps1` script at the root module folder. Files in this folder will *always be overriden on regeneration*. To update documentation examples, please use the `..\examples` folder. +This directory contains the documentation of the cmdlets for the `Az.TimeSeriesInsights` module. To run documentation generation, use the `generate-help.ps1` script at the root module folder. Files in this folder will *always be overriden on regeneration*. To update documentation examples, please use the `../examples` folder. ## Info - Modifiable: no @@ -8,4 +8,4 @@ This directory contains the documentation of the cmdlets for the `Az.TimeSeriesI - Packaged: yes ## Details -The process of documentation generation loads `Az.TimeSeriesInsights` and analyzes the exported cmdlets from the module. It recognizes the [help comments](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_comment_based_help) that are generated into the scripts in the `..\exports` folder. Additionally, when writing custom cmdlets in the `..\custom` folder, you can use the help comments syntax, which decorate the exported scripts at build-time. The documentation examples are taken from the `..\examples` folder. \ No newline at end of file +The process of documentation generation loads `Az.TimeSeriesInsights` and analyzes the exported cmdlets from the module. It recognizes the [help comments](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_comment_based_help) that are generated into the scripts in the `../exports` folder. Additionally, when writing custom cmdlets in the `../custom` folder, you can use the help comments syntax, which decorate the exported scripts at build-time. The documentation examples are taken from the `../examples` folder. \ No newline at end of file diff --git a/src/TimeSeriesInsights/readme.md b/src/TimeSeriesInsights/readme.md index 2ec5e3ec6e24..bb18d5bfb834 100644 --- a/src/TimeSeriesInsights/readme.md +++ b/src/TimeSeriesInsights/readme.md @@ -61,15 +61,12 @@ directive: - from: swagger-document where: $ transform: return $.replace(/Microsoft.IotHub/g, "Microsoft.IoTHub") -<<<<<<< HEAD -======= - from: swagger-document where: $ transform: return $.replace(/\/eventSources\//g, "/eventsources/") - from: swagger-document where: $ transform: return $.replace(/\/accessPolicies\//g, "/accesspolicies/") ->>>>>>> upstream/generation # Remove the unneeded parameter set - where: variant: ^CreateViaIdentity$|^CreateViaIdentityExpanded$|^Update$|^UpdateViaIdentity$ From b00dbb8f95d12471b22a736d854b4afe590834ac Mon Sep 17 00:00:00 2001 From: LucasYao93 Date: Thu, 9 Apr 2020 02:19:35 -0700 Subject: [PATCH 3/3] Rebuild docs folder. --- .../{exports => }/Az.TimeSeriesInsights.md | 0 .../Get-AzTimeSeriesInsightsAccessPolicy.md | 27 ++++++++++------- .../Get-AzTimeSeriesInsightsEnvironment.md | 27 ++++++++++------- .../Get-AzTimeSeriesInsightsEventSource.md | 27 ++++++++++------- ...et-AzTimeSeriesInsightsReferenceDataSet.md | 27 ++++++++++------- .../New-AzTimeSeriesInsightsAccessPolicy.md | 8 +++-- .../New-AzTimeSeriesInsightsEnvironment.md | 26 ++++++++-------- .../New-AzTimeSeriesInsightsEventSource.md | 30 ++++++++++--------- ...ew-AzTimeSeriesInsightsReferenceDataSet.md | 11 +++---- ...Remove-AzTimeSeriesInsightsAccessPolicy.md | 15 ++++++---- .../Remove-AzTimeSeriesInsightsEnvironment.md | 15 ++++++---- .../Remove-AzTimeSeriesInsightsEventSource.md | 15 ++++++---- ...ve-AzTimeSeriesInsightsReferenceDataSet.md | 15 ++++++---- ...Update-AzTimeSeriesInsightsAccessPolicy.md | 19 +++++++----- .../Update-AzTimeSeriesInsightsEnvironment.md | 19 +++++++----- .../Update-AzTimeSeriesInsightsEventSource.md | 19 +++++++----- ...te-AzTimeSeriesInsightsReferenceDataSet.md | 19 +++++++----- src/TimeSeriesInsights/docs/readme.md | 11 ------- 18 files changed, 185 insertions(+), 145 deletions(-) rename src/TimeSeriesInsights/docs/{exports => }/Az.TimeSeriesInsights.md (100%) rename src/TimeSeriesInsights/docs/{exports => }/Get-AzTimeSeriesInsightsAccessPolicy.md (86%) rename src/TimeSeriesInsights/docs/{exports => }/Get-AzTimeSeriesInsightsEnvironment.md (92%) rename src/TimeSeriesInsights/docs/{exports => }/Get-AzTimeSeriesInsightsEventSource.md (91%) rename src/TimeSeriesInsights/docs/{exports => }/Get-AzTimeSeriesInsightsReferenceDataSet.md (85%) rename src/TimeSeriesInsights/docs/{exports => }/New-AzTimeSeriesInsightsAccessPolicy.md (92%) rename src/TimeSeriesInsights/docs/{exports => }/New-AzTimeSeriesInsightsEnvironment.md (90%) rename src/TimeSeriesInsights/docs/{exports => }/New-AzTimeSeriesInsightsEventSource.md (84%) rename src/TimeSeriesInsights/docs/{exports => }/New-AzTimeSeriesInsightsReferenceDataSet.md (92%) rename src/TimeSeriesInsights/docs/{exports => }/Remove-AzTimeSeriesInsightsAccessPolicy.md (90%) rename src/TimeSeriesInsights/docs/{exports => }/Remove-AzTimeSeriesInsightsEnvironment.md (90%) rename src/TimeSeriesInsights/docs/{exports => }/Remove-AzTimeSeriesInsightsEventSource.md (91%) rename src/TimeSeriesInsights/docs/{exports => }/Remove-AzTimeSeriesInsightsReferenceDataSet.md (90%) rename src/TimeSeriesInsights/docs/{exports => }/Update-AzTimeSeriesInsightsAccessPolicy.md (90%) rename src/TimeSeriesInsights/docs/{exports => }/Update-AzTimeSeriesInsightsEnvironment.md (94%) rename src/TimeSeriesInsights/docs/{exports => }/Update-AzTimeSeriesInsightsEventSource.md (92%) rename src/TimeSeriesInsights/docs/{exports => }/Update-AzTimeSeriesInsightsReferenceDataSet.md (90%) delete mode 100644 src/TimeSeriesInsights/docs/readme.md diff --git a/src/TimeSeriesInsights/docs/exports/Az.TimeSeriesInsights.md b/src/TimeSeriesInsights/docs/Az.TimeSeriesInsights.md similarity index 100% rename from src/TimeSeriesInsights/docs/exports/Az.TimeSeriesInsights.md rename to src/TimeSeriesInsights/docs/Az.TimeSeriesInsights.md diff --git a/src/TimeSeriesInsights/docs/exports/Get-AzTimeSeriesInsightsAccessPolicy.md b/src/TimeSeriesInsights/docs/Get-AzTimeSeriesInsightsAccessPolicy.md similarity index 86% rename from src/TimeSeriesInsights/docs/exports/Get-AzTimeSeriesInsightsAccessPolicy.md rename to src/TimeSeriesInsights/docs/Get-AzTimeSeriesInsightsAccessPolicy.md index 072dba5c4784..1fca48eeea87 100644 --- a/src/TimeSeriesInsights/docs/exports/Get-AzTimeSeriesInsightsAccessPolicy.md +++ b/src/TimeSeriesInsights/docs/Get-AzTimeSeriesInsightsAccessPolicy.md @@ -35,35 +35,40 @@ Gets the access policy with the specified name in the specified environment. ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### Example 1: List all access policies under a specified environment ```powershell -Get-AzTimeSeriesInsightsAccessPolicy -EnvironmentName tsitest001 -ResourceGroupName testgroup -``` +PS C:\> 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 -------------------------- +### Example 2: Get a specified access policy by name ```powershell -Get-AzTimeSeriesInsightsAccessPolicy -EnvironmentName tsitest001 -ResourceGroupName testgroup -Name policy001 -``` +PS C:\> 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 ``` -PS C:\\>Get-AzTimeSeriesInsightsAccessPolicy -InputObject $ap +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 diff --git a/src/TimeSeriesInsights/docs/exports/Get-AzTimeSeriesInsightsEnvironment.md b/src/TimeSeriesInsights/docs/Get-AzTimeSeriesInsightsEnvironment.md similarity index 92% rename from src/TimeSeriesInsights/docs/exports/Get-AzTimeSeriesInsightsEnvironment.md rename to src/TimeSeriesInsights/docs/Get-AzTimeSeriesInsightsEnvironment.md index bc19cf52ce88..7c9a28c1dcf5 100644 --- a/src/TimeSeriesInsights/docs/exports/Get-AzTimeSeriesInsightsEnvironment.md +++ b/src/TimeSeriesInsights/docs/Get-AzTimeSeriesInsightsEnvironment.md @@ -41,10 +41,9 @@ Gets the environment with the specified name in the specified subscription and r ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### Example 1: Get a time series insights environment ```powershell -Get-AzTimeSeriesInsightsEnvironment -ResourceGroupName testgroup -Name tsitest001 -``` +PS C:\> Get-AzTimeSeriesInsightsEnvironment -ResourceGroupName testgroup -Name tsitest001 DataAccessFqdn : b6d113a4-0865-405f-b09e-ad4355b5d046.env.timeseries.azure.com DataAccessId : b6d113a4-0865-405f-b09e-ad4355b5d046 @@ -67,11 +66,13 @@ 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 -------------------------- +### Example 2: List all time series insights environments ```powershell -Get-AzTimeSeriesInsightsEnvironment -ResourceGroupName testgroup -``` +PS C:\> Get-AzTimeSeriesInsightsEnvironment -ResourceGroupName testgroup DataAccessFqdn : 3de1d1e1-4f9b-4bc6-aad3-a835597dcd86.env.timeseries.azure.com DataAccessId : 3de1d1e1-4f9b-4bc6-aad3-a835597dcd86 @@ -116,13 +117,14 @@ 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 ``` -PS C:\\> Get-AzTimeSeriesInsightsEnvironment -InputObject $env +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 @@ -144,6 +146,9 @@ 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 diff --git a/src/TimeSeriesInsights/docs/exports/Get-AzTimeSeriesInsightsEventSource.md b/src/TimeSeriesInsights/docs/Get-AzTimeSeriesInsightsEventSource.md similarity index 91% rename from src/TimeSeriesInsights/docs/exports/Get-AzTimeSeriesInsightsEventSource.md rename to src/TimeSeriesInsights/docs/Get-AzTimeSeriesInsightsEventSource.md index f09117a14f37..29c20eaf5a5d 100644 --- a/src/TimeSeriesInsights/docs/exports/Get-AzTimeSeriesInsightsEventSource.md +++ b/src/TimeSeriesInsights/docs/Get-AzTimeSeriesInsightsEventSource.md @@ -35,10 +35,9 @@ Gets the event source with the specified name in the specified environment. ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### Example 1: List all event sources under the specified environment ```powershell -Get-AzTimeSeriesInsightsEventSource -ResourceGroupName testgroup -EnvironmentName tsitest001 -``` +PS C:\> Get-AzTimeSeriesInsightsEventSource -ResourceGroupName testgroup -EnvironmentName tsitest001 ConsumerGroupName : testgroup2 EventHubName : hubname001 @@ -67,11 +66,13 @@ 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 -------------------------- +### Example 2: Get a specified event source by name ```powershell -Get-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 @@ -85,13 +86,14 @@ 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 ``` -PS C:\\> Get-AzTimeSeriesInsightsEventSource -InputObject $es +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 @@ -105,6 +107,9 @@ 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 diff --git a/src/TimeSeriesInsights/docs/exports/Get-AzTimeSeriesInsightsReferenceDataSet.md b/src/TimeSeriesInsights/docs/Get-AzTimeSeriesInsightsReferenceDataSet.md similarity index 85% rename from src/TimeSeriesInsights/docs/exports/Get-AzTimeSeriesInsightsReferenceDataSet.md rename to src/TimeSeriesInsights/docs/Get-AzTimeSeriesInsightsReferenceDataSet.md index 2f50bf1bdf8a..69801f9b127c 100644 --- a/src/TimeSeriesInsights/docs/exports/Get-AzTimeSeriesInsightsReferenceDataSet.md +++ b/src/TimeSeriesInsights/docs/Get-AzTimeSeriesInsightsReferenceDataSet.md @@ -35,35 +35,40 @@ Gets the reference data set with the specified name in the specified environment ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### Example 1: List all reference data sets under the specified environment ```powershell -Get-AzTimeSeriesInsightsReferenceDataSet -EnvironmentName tsitest001 -ResourceGroupName testgroup -``` +PS C:\> 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. -### -------------------------- EXAMPLE 2 -------------------------- +### Example 2: Get a specified reference data set by name ```powershell -Get-AzTimeSeriesInsightsReferenceDataSet -EnvironmentName tsitest001 -ResourceGroupName testgroup -ReferenceDataSetName dstest001 -``` +PS C:\> 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 ``` -PS C:\\>Get-AzTimeSeriesInsightsReferenceDataSet -InputObject $ds +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 diff --git a/src/TimeSeriesInsights/docs/exports/New-AzTimeSeriesInsightsAccessPolicy.md b/src/TimeSeriesInsights/docs/New-AzTimeSeriesInsightsAccessPolicy.md similarity index 92% rename from src/TimeSeriesInsights/docs/exports/New-AzTimeSeriesInsightsAccessPolicy.md rename to src/TimeSeriesInsights/docs/New-AzTimeSeriesInsightsAccessPolicy.md index 162194784140..430182482b7c 100644 --- a/src/TimeSeriesInsights/docs/exports/New-AzTimeSeriesInsightsAccessPolicy.md +++ b/src/TimeSeriesInsights/docs/New-AzTimeSeriesInsightsAccessPolicy.md @@ -23,14 +23,16 @@ Create or update an access policy in the specified environment. ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### Example 1: Create an access policy for a specified environment ```powershell -New-AzTimeSeriesInsightsAccessPolicy -EnvironmentName tsitest001 -ResourceGroupName testgroup -PrincipalObjectId ce74a389-b5e8-4f16-89c7-787031ddd903 -Role Contributor -Name policy001 -``` +PS C:\> 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 diff --git a/src/TimeSeriesInsights/docs/exports/New-AzTimeSeriesInsightsEnvironment.md b/src/TimeSeriesInsights/docs/New-AzTimeSeriesInsightsEnvironment.md similarity index 90% rename from src/TimeSeriesInsights/docs/exports/New-AzTimeSeriesInsightsEnvironment.md rename to src/TimeSeriesInsights/docs/New-AzTimeSeriesInsightsEnvironment.md index a0bf7c8a4754..b40d12d786f4 100644 --- a/src/TimeSeriesInsights/docs/exports/New-AzTimeSeriesInsightsEnvironment.md +++ b/src/TimeSeriesInsights/docs/New-AzTimeSeriesInsightsEnvironment.md @@ -34,29 +34,31 @@ Create an environment in the specified subscription and resource group. ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### Example 1: Create a standard time series insights environment ```powershell -$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 +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 Kind Location Name SkuCapacity SkuName Type ---- -------- ---- ----------- ------- ---- Standard eastus tsitest001 2 S1 Microsoft.TimeSeriesInsights/Environments - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -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'} +This command creates a standard time series insights environment. + +### Example 2: Create a longterm time series insights environment +```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'} Kind Location Name SkuCapacity SkuName Type ---- -------- ---- ----------- ------- ---- LongTerm eastus tsitest002 1 L1 Microsoft.TimeSeriesInsights/Environments +``` + +This command creates a longterm time series insights environment. ## PARAMETERS diff --git a/src/TimeSeriesInsights/docs/exports/New-AzTimeSeriesInsightsEventSource.md b/src/TimeSeriesInsights/docs/New-AzTimeSeriesInsightsEventSource.md similarity index 84% rename from src/TimeSeriesInsights/docs/exports/New-AzTimeSeriesInsightsEventSource.md rename to src/TimeSeriesInsights/docs/New-AzTimeSeriesInsightsEventSource.md index 41ba4e2cffa2..c4507fd76bb8 100644 --- a/src/TimeSeriesInsights/docs/exports/New-AzTimeSeriesInsightsEventSource.md +++ b/src/TimeSeriesInsights/docs/New-AzTimeSeriesInsightsEventSource.md @@ -34,32 +34,34 @@ Create an event source under the specified environment. ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### Example 1: Create an eventhub event source under the specified environment ```powershell -$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 +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 Kind Location Name Type ---- -------- ---- ---- Microsoft.EventHub eastus estest001 Microsoft.TimeSeriesInsights/Environments/EventSources - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -$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 +This command creates an eventhub event source under the specified environment. + +### Example 2: Create an iothub event source under the specified environment +```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 -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 diff --git a/src/TimeSeriesInsights/docs/exports/New-AzTimeSeriesInsightsReferenceDataSet.md b/src/TimeSeriesInsights/docs/New-AzTimeSeriesInsightsReferenceDataSet.md similarity index 92% rename from src/TimeSeriesInsights/docs/exports/New-AzTimeSeriesInsightsReferenceDataSet.md rename to src/TimeSeriesInsights/docs/New-AzTimeSeriesInsightsReferenceDataSet.md index 8eaebe5f9e9f..dbdcd7485872 100644 --- a/src/TimeSeriesInsights/docs/exports/New-AzTimeSeriesInsightsReferenceDataSet.md +++ b/src/TimeSeriesInsights/docs/New-AzTimeSeriesInsightsReferenceDataSet.md @@ -24,16 +24,17 @@ Create or update a reference data set in the specified environment. ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### Example 1: Create a reference data set for a specified environment ```powershell -$mykeyproperties = @{ "name" = "device01"; "type" = "Double"} -``` - -PS C:\\> New-AzTimeSeriesInsightsReferenceDataSet -EnvironmentName tsitest001 -Name dstest001 -ResourceGroupName testgroup -Location eastus -DataStringComparisonBehavior Ordinal -KeyProperty $mykeyproperties +PS C:\> $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 diff --git a/src/TimeSeriesInsights/docs/exports/Remove-AzTimeSeriesInsightsAccessPolicy.md b/src/TimeSeriesInsights/docs/Remove-AzTimeSeriesInsightsAccessPolicy.md similarity index 90% rename from src/TimeSeriesInsights/docs/exports/Remove-AzTimeSeriesInsightsAccessPolicy.md rename to src/TimeSeriesInsights/docs/Remove-AzTimeSeriesInsightsAccessPolicy.md index dbaad0b458d0..4dd267b1e719 100644 --- a/src/TimeSeriesInsights/docs/exports/Remove-AzTimeSeriesInsightsAccessPolicy.md +++ b/src/TimeSeriesInsights/docs/Remove-AzTimeSeriesInsightsAccessPolicy.md @@ -29,19 +29,22 @@ Deletes the access policy with the specified name in the specified subscription, ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### Example 1: Remove a specified access policy by name ```powershell -Remove-AzTimeSeriesInsightsAccessPolicy -EnvironmentName tsitest001 -Name policy001 -ResourceGroupName testgroup -``` +PS C:\> Remove-AzTimeSeriesInsightsAccessPolicy -EnvironmentName tsitest001 -Name policy001 -ResourceGroupName testgroup +``` +This command removes a specified access policy. -### -------------------------- EXAMPLE 2 -------------------------- +### Example 2: Remove a specified access policy by object ```powershell -$policy = Get-AzTimeSeriesInsightsAccessPolicy -EnvironmentName tsitest001 -Name policy001 -ResourceGroupName testgroup +PS C:\> $policy = Get-AzTimeSeriesInsightsAccessPolicy -EnvironmentName tsitest001 -Name policy001 -ResourceGroupName testgroup +PS C:\> Remove-AzTimeSeriesInsightsAccessPolicy -InputObject $policy + ``` -PS C:\\> Remove-AzTimeSeriesInsightsAccessPolicy -InputObject $policy +This command removes a specified access policy. ## PARAMETERS diff --git a/src/TimeSeriesInsights/docs/exports/Remove-AzTimeSeriesInsightsEnvironment.md b/src/TimeSeriesInsights/docs/Remove-AzTimeSeriesInsightsEnvironment.md similarity index 90% rename from src/TimeSeriesInsights/docs/exports/Remove-AzTimeSeriesInsightsEnvironment.md rename to src/TimeSeriesInsights/docs/Remove-AzTimeSeriesInsightsEnvironment.md index ed7e09bdab76..606ab8675bad 100644 --- a/src/TimeSeriesInsights/docs/exports/Remove-AzTimeSeriesInsightsEnvironment.md +++ b/src/TimeSeriesInsights/docs/Remove-AzTimeSeriesInsightsEnvironment.md @@ -29,19 +29,22 @@ Deletes the environment with the specified name in the specified subscription an ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### Example 1: Remove a time series insights environment by name ```powershell -Remove-AzTimeSeriesInsightsEnvironment -ResourceGroupName testgroup -Name tsill -``` +PS C:\> Remove-AzTimeSeriesInsightsEnvironment -ResourceGroupName testgroup -Name tsill +``` +This command removes a time series insights environment. -### -------------------------- EXAMPLE 2 -------------------------- +### Example 2: Remove a time series insights environment by object ```powershell -$env = Get-AzTimeSeriesInsightsEnvironment -ResourceGroupName testgroup -Name tsill +PS C:\> $env = Get-AzTimeSeriesInsightsEnvironment -ResourceGroupName testgroup -Name tsill +PS C:\> Remove-AzTimeSeriesInsightsEnvironment -InputObject $env + ``` -PS C:\\> Remove-AzTimeSeriesInsightsEnvironment -InputObject $env +This command removes a time series insights environment. ## PARAMETERS diff --git a/src/TimeSeriesInsights/docs/exports/Remove-AzTimeSeriesInsightsEventSource.md b/src/TimeSeriesInsights/docs/Remove-AzTimeSeriesInsightsEventSource.md similarity index 91% rename from src/TimeSeriesInsights/docs/exports/Remove-AzTimeSeriesInsightsEventSource.md rename to src/TimeSeriesInsights/docs/Remove-AzTimeSeriesInsightsEventSource.md index 2b3590e510e0..fd8d562d1889 100644 --- a/src/TimeSeriesInsights/docs/exports/Remove-AzTimeSeriesInsightsEventSource.md +++ b/src/TimeSeriesInsights/docs/Remove-AzTimeSeriesInsightsEventSource.md @@ -29,19 +29,22 @@ Deletes the event source with the specified name in the specified subscription, ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### Example 1: Remove a specified event source by name ```powershell -Remove-AzTimeSeriesInsightsEventSource -EnvironmentName tsitest001 -Name iots001 -ResourceGroupName testgroup -``` +PS C:\> Remove-AzTimeSeriesInsightsEventSource -EnvironmentName tsitest001 -Name iots001 -ResourceGroupName testgroup +``` +This removes a specific event source. -### -------------------------- EXAMPLE 2 -------------------------- +### Example 2: Remove a specified event source by object ```powershell -$es = Get-AzTimeSeriesInsightsEventSource -EnvironmentName tsitest001 -ResourceGroupName testgroup -Name iots001 +PS C:\> $es = Get-AzTimeSeriesInsightsEventSource -EnvironmentName tsitest001 -ResourceGroupName testgroup -Name iots001 +PS C:\> Remove-AzTimeSeriesInsightsEventSource -InputObject $es + ``` -PS C:\\> Remove-AzTimeSeriesInsightsEventSource -InputObject $es +This removes a specific event source. ## PARAMETERS diff --git a/src/TimeSeriesInsights/docs/exports/Remove-AzTimeSeriesInsightsReferenceDataSet.md b/src/TimeSeriesInsights/docs/Remove-AzTimeSeriesInsightsReferenceDataSet.md similarity index 90% rename from src/TimeSeriesInsights/docs/exports/Remove-AzTimeSeriesInsightsReferenceDataSet.md rename to src/TimeSeriesInsights/docs/Remove-AzTimeSeriesInsightsReferenceDataSet.md index fec6104e095d..b774b17dcb4a 100644 --- a/src/TimeSeriesInsights/docs/exports/Remove-AzTimeSeriesInsightsReferenceDataSet.md +++ b/src/TimeSeriesInsights/docs/Remove-AzTimeSeriesInsightsReferenceDataSet.md @@ -30,19 +30,22 @@ Deletes the reference data set with the specified name in the specified subscrip ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### Example 1: Remove a specified reference data set by name ```powershell -Remove-AzTimeSeriesInsightsReferenceDataSet -EnvironmentName tsitest001 -Name dstest001 -ResourceGroupName testgroup -``` +PS C:\> Remove-AzTimeSeriesInsightsReferenceDataSet -EnvironmentName tsitest001 -Name dstest001 -ResourceGroupName testgroup +``` +This command removes a specified reference data set. -### -------------------------- EXAMPLE 2 -------------------------- +### Example 2: Remove a specified reference data set by object ```powershell -$ds = Get-AzTimeSeriesInsightsReferenceDataSet -EnvironmentName tsitest001 -Name dstest001 -ResourceGroupName testgroup +PS C:\> $ds = Get-AzTimeSeriesInsightsReferenceDataSet -EnvironmentName tsitest001 -Name dstest001 -ResourceGroupName testgroup +PS C:\> Remove-AzTimeSeriesInsightsReferenceDataSet -InputObject $ds + ``` -PS C:\\> Remove-AzTimeSeriesInsightsReferenceDataSet -InputObject $ds +This command removes a specified reference data set. ## PARAMETERS diff --git a/src/TimeSeriesInsights/docs/exports/Update-AzTimeSeriesInsightsAccessPolicy.md b/src/TimeSeriesInsights/docs/Update-AzTimeSeriesInsightsAccessPolicy.md similarity index 90% rename from src/TimeSeriesInsights/docs/exports/Update-AzTimeSeriesInsightsAccessPolicy.md rename to src/TimeSeriesInsights/docs/Update-AzTimeSeriesInsightsAccessPolicy.md index a47fb1b219d6..2d20d53a4dd5 100644 --- a/src/TimeSeriesInsights/docs/exports/Update-AzTimeSeriesInsightsAccessPolicy.md +++ b/src/TimeSeriesInsights/docs/Update-AzTimeSeriesInsightsAccessPolicy.md @@ -30,25 +30,28 @@ Updates the access policy with the specified name in the specified subscription, ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### Example 1: Update a specified access policy by name ```powershell -Update-AzTimeSeriesInsightsAccessPolicy -EnvironmentName tsitest001 -Name policy001 -ResourceGroupName testgroup -Role Contributor,Reader -``` +PS C:\> Update-AzTimeSeriesInsightsAccessPolicy -EnvironmentName tsitest001 -Name policy001 -ResourceGroupName testgroup -Role Contributor,Reader Name Type ---- ---- policy001 Microsoft.TimeSeriesInsights/Environments/AccessPolicies - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -$policy = Get-AzTimeSeriesInsightsAccessPolicy -EnvironmentName tsitest001 -ResourceGroupName $env.resourceGroup -Name policy001 ``` -PS C:\\> Update-AzTimeSeriesInsightsAccessPolicy -InputObject $policy -Role Contributor +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 diff --git a/src/TimeSeriesInsights/docs/exports/Update-AzTimeSeriesInsightsEnvironment.md b/src/TimeSeriesInsights/docs/Update-AzTimeSeriesInsightsEnvironment.md similarity index 94% rename from src/TimeSeriesInsights/docs/exports/Update-AzTimeSeriesInsightsEnvironment.md rename to src/TimeSeriesInsights/docs/Update-AzTimeSeriesInsightsEnvironment.md index 892b58480ef1..63ef1475949c 100644 --- a/src/TimeSeriesInsights/docs/exports/Update-AzTimeSeriesInsightsEnvironment.md +++ b/src/TimeSeriesInsights/docs/Update-AzTimeSeriesInsightsEnvironment.md @@ -33,10 +33,9 @@ Updates the environment with the specified name in the specified subscription an ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### Example 1: Update a standard time series insights environment ```powershell -Update-AzTimeSeriesInsightsEnvironment -ResourceGroupName testgroup -Name tsitest001 -Capacity 5 -Sku S1 -``` +PS C:\> Update-AzTimeSeriesInsightsEnvironment -ResourceGroupName testgroup -Name tsitest001 -Capacity 5 -Sku S1 DataAccessFqdn : b6d113a4-0865-405f-b09e-ad4355b5d046.env.timeseries.azure.com DataAccessId : b6d113a4-0865-405f-b09e-ad4355b5d046 @@ -59,13 +58,14 @@ StateDetailMessage : StorageLimitExceededBehavior : PurgeOldData Tag : Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.Api20180815Preview.TrackedResourceTags Type : Microsoft.TimeSeriesInsights/Environments - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -$env = Get-AzTimeSeriesInsightsEnvironment -ResourceGroupName testgroup -Name tsitest001 ``` -PS C:\\> PS C:\\> Update-AzTimeSeriesInsightsEnvironment -InputObject $env -Capacity 6 -Sku S1 +This command updates a standard time series insights environment. + +### Example 2: Update a standard time series insights environment +```powershell +PS C:\> $env = Get-AzTimeSeriesInsightsEnvironment -ResourceGroupName testgroup -Name tsitest001 +PS C:\> PS C:\> Update-AzTimeSeriesInsightsEnvironment -InputObject $env -Capacity 6 -Sku S1 DataAccessFqdn : b6d113a4-0865-405f-b09e-ad4355b5d046.env.timeseries.azure.com DataAccessId : b6d113a4-0865-405f-b09e-ad4355b5d046 @@ -88,6 +88,9 @@ StateDetailMessage : StorageLimitExceededBehavior : PurgeOldData Tag : Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.Api20180815Preview.TrackedResourceTags Type : Microsoft.TimeSeriesInsights/Environments +``` + +This command updates a standard time series insights environment. ## PARAMETERS diff --git a/src/TimeSeriesInsights/docs/exports/Update-AzTimeSeriesInsightsEventSource.md b/src/TimeSeriesInsights/docs/Update-AzTimeSeriesInsightsEventSource.md similarity index 92% rename from src/TimeSeriesInsights/docs/exports/Update-AzTimeSeriesInsightsEventSource.md rename to src/TimeSeriesInsights/docs/Update-AzTimeSeriesInsightsEventSource.md index b8ffdbc93d70..a73e116fe2dd 100644 --- a/src/TimeSeriesInsights/docs/exports/Update-AzTimeSeriesInsightsEventSource.md +++ b/src/TimeSeriesInsights/docs/Update-AzTimeSeriesInsightsEventSource.md @@ -30,10 +30,9 @@ Updates the event source with the specified name in the specified subscription, ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### Example 1: Update a specified event source by name ```powershell -Update-AzTimeSeriesInsightsEventSource -EnvironmentName tsitest001 -Name iots001 -ResourceGroupName testgroup -Tag @{"tgk"="001"} -``` +PS C:\> Update-AzTimeSeriesInsightsEventSource -EnvironmentName tsitest001 -Name iots001 -ResourceGroupName testgroup -Tag @{"tgk"="001"} ConsumerGroupName : testgroup2 EventSourceResourceId : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/testgroup2/providers/Microsoft.Devices/IotHubs/iotname001 @@ -46,13 +45,14 @@ Name : iots001 Tag : Microsoft.Azure.PowerShell.Cmdlets.TimeSeriesInsights.Models.Api20180815Preview.TrackedResourceTags TimestampPropertyName : Type : Microsoft.TimeSeriesInsights/Environments/EventSources - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -$es = Get-AzTimeSeriesInsightsEventSource -EnvironmentName tsitest001 -ResourceGroupName testgroup -Name iots001 ``` -PS C:\\> Update-AzTimeSeriesInsightsEventSource -InputObject -Tag @{"tgb"="002"} +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 @@ -65,6 +65,9 @@ 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 diff --git a/src/TimeSeriesInsights/docs/exports/Update-AzTimeSeriesInsightsReferenceDataSet.md b/src/TimeSeriesInsights/docs/Update-AzTimeSeriesInsightsReferenceDataSet.md similarity index 90% rename from src/TimeSeriesInsights/docs/exports/Update-AzTimeSeriesInsightsReferenceDataSet.md rename to src/TimeSeriesInsights/docs/Update-AzTimeSeriesInsightsReferenceDataSet.md index 1573ec3aa43a..d31f8bc3a0ba 100644 --- a/src/TimeSeriesInsights/docs/exports/Update-AzTimeSeriesInsightsReferenceDataSet.md +++ b/src/TimeSeriesInsights/docs/Update-AzTimeSeriesInsightsReferenceDataSet.md @@ -30,25 +30,28 @@ Updates the reference data set with the specified name in the specified subscrip ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### Example 1: Update a specified reference data set by name ```powershell -Update-AzTimeSeriesInsightsReferenceDataSet -EnvironmentName tsitest001 -Name dstest001 -ResourceGroupName testgroup -Tag @{"tstg"="lb001"} -``` +PS C:\> Update-AzTimeSeriesInsightsReferenceDataSet -EnvironmentName tsitest001 -Name dstest001 -ResourceGroupName testgroup -Tag @{"tstg"="lb001"} Location Name Type -------- ---- ---- eastus dstest001 Microsoft.TimeSeriesInsights/Environments/ReferenceDataSets - -### -------------------------- EXAMPLE 2 -------------------------- -```powershell -$ds = Get-AzTimeSeriesInsightsReferenceDataSet -EnvironmentName tsitest001 -ResourceGroupName testgroup -ReferenceDataSetName dstest001 ``` -PS C:\\> Update-AzTimeSeriesInsightsReferenceDataSet -InputObject $ds -Tag @{"tstg"="lb001"} +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 diff --git a/src/TimeSeriesInsights/docs/readme.md b/src/TimeSeriesInsights/docs/readme.md deleted file mode 100644 index 22ecd21751d2..000000000000 --- a/src/TimeSeriesInsights/docs/readme.md +++ /dev/null @@ -1,11 +0,0 @@ -# Docs -This directory contains the documentation of the cmdlets for the `Az.TimeSeriesInsights` module. To run documentation generation, use the `generate-help.ps1` script at the root module folder. Files in this folder will *always be overriden on regeneration*. To update documentation examples, please use the `../examples` folder. - -## Info -- Modifiable: no -- Generated: all -- Committed: yes -- Packaged: yes - -## Details -The process of documentation generation loads `Az.TimeSeriesInsights` and analyzes the exported cmdlets from the module. It recognizes the [help comments](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_comment_based_help) that are generated into the scripts in the `../exports` folder. Additionally, when writing custom cmdlets in the `../custom` folder, you can use the help comments syntax, which decorate the exported scripts at build-time. The documentation examples are taken from the `../examples` folder. \ No newline at end of file