diff --git a/src/DynatraceObservability/DynatraceObservability.Autorest/Properties/AssemblyInfo.cs b/src/DynatraceObservability/DynatraceObservability.Autorest/Properties/AssemblyInfo.cs index 0cd5f0e72f41..3c8e8a3122b1 100644 --- a/src/DynatraceObservability/DynatraceObservability.Autorest/Properties/AssemblyInfo.cs +++ b/src/DynatraceObservability/DynatraceObservability.Autorest/Properties/AssemblyInfo.cs @@ -20,8 +20,7 @@ [assembly: System.Reflection.AssemblyCopyrightAttribute("Copyright © Microsoft")] [assembly: System.Reflection.AssemblyProductAttribute("Microsoft Azure PowerShell")] [assembly: System.Reflection.AssemblyTitleAttribute("Microsoft Azure PowerShell - DynatraceObservability")] -[assembly: System.Reflection.AssemblyFileVersionAttribute("0.2.0")] -[assembly: System.Reflection.AssemblyVersionAttribute("0.2.0")] +[assembly: System.Reflection.AssemblyFileVersionAttribute("0.3.0")] +[assembly: System.Reflection.AssemblyVersionAttribute("0.3.0")] [assembly: System.Runtime.InteropServices.ComVisibleAttribute(false)] [assembly: System.CLSCompliantAttribute(false)] - diff --git a/src/DynatraceObservability/DynatraceObservability.Autorest/README.md b/src/DynatraceObservability/DynatraceObservability.Autorest/README.md index 75585e92bba9..3e4e2a1cd144 100644 --- a/src/DynatraceObservability/DynatraceObservability.Autorest/README.md +++ b/src/DynatraceObservability/DynatraceObservability.Autorest/README.md @@ -27,8 +27,8 @@ For information on how to develop for `Az.DynatraceObservability`, see [how-to.m > see https://aka.ms/autorest ``` yaml -commit: 099640c73c1af7f9410f184d204807f9d0da2edb -tag: package-2023-04-27 +commit: a0793fce3022a236e74f774aac1b2fb07974a1ab +tag: package-2024-04-24 require: - $(this-folder)/../../readme.azure.noprofile.md - $(repo)/specification/dynatrace/resource-manager/readme.md @@ -41,6 +41,9 @@ subject-prefix: Dynatrace inlining-threshold: 100 +## Flags to use PATCH method for Update-* +disable-transform-identity-type: true + directive: - where: verb: Set @@ -82,6 +85,21 @@ directive: set: subject: MonitoredResource # remove cmdlet + - where: + verb: Update + subject-prefix: Dynatrace + subject: MonitoredSubscription + remove: true + - where: + verb: Get + subject-prefix: Dynatrace + subject: MonitorConnectedResourceCount + remove: true + - where: + verb: Get + subject-prefix: Dynatrace + subject: CreationSupported + remove: true # unsupport on server - where: subject: ^MonitorAccountCredential$ diff --git a/src/DynatraceObservability/DynatraceObservability.Autorest/UX/Dynatrace.Observability/monitors-singleSignOnConfigurations.json b/src/DynatraceObservability/DynatraceObservability.Autorest/UX/Dynatrace.Observability/monitors-singleSignOnConfigurations.json index 3cd684c5d1ed..39c000540d7b 100644 --- a/src/DynatraceObservability/DynatraceObservability.Autorest/UX/Dynatrace.Observability/monitors-singleSignOnConfigurations.json +++ b/src/DynatraceObservability/DynatraceObservability.Autorest/UX/Dynatrace.Observability/monitors-singleSignOnConfigurations.json @@ -1,6 +1,6 @@ { "resourceType": "monitors/singleSignOnConfigurations", - "apiVersion": "2023-04-27", + "apiVersion": "2024-04-24", "learnMore": { "url": "https://learn.microsoft.com/powershell/module/az.dynatraceobservability" }, diff --git a/src/DynatraceObservability/DynatraceObservability.Autorest/UX/Dynatrace.Observability/monitors-tagRules.json b/src/DynatraceObservability/DynatraceObservability.Autorest/UX/Dynatrace.Observability/monitors-tagRules.json index 9b5a4bfd2b33..b96e783ce7fd 100644 --- a/src/DynatraceObservability/DynatraceObservability.Autorest/UX/Dynatrace.Observability/monitors-tagRules.json +++ b/src/DynatraceObservability/DynatraceObservability.Autorest/UX/Dynatrace.Observability/monitors-tagRules.json @@ -1,6 +1,6 @@ { "resourceType": "monitors/tagRules", - "apiVersion": "2023-04-27", + "apiVersion": "2024-04-24", "learnMore": { "url": "https://learn.microsoft.com/powershell/module/az.dynatraceobservability" }, diff --git a/src/DynatraceObservability/DynatraceObservability.Autorest/UX/Dynatrace.Observability/monitors.json b/src/DynatraceObservability/DynatraceObservability.Autorest/UX/Dynatrace.Observability/monitors.json index 5e8b29fb11c5..82e6dbc73b43 100644 --- a/src/DynatraceObservability/DynatraceObservability.Autorest/UX/Dynatrace.Observability/monitors.json +++ b/src/DynatraceObservability/DynatraceObservability.Autorest/UX/Dynatrace.Observability/monitors.json @@ -1,17 +1,17 @@ { "resourceType": "monitors", - "apiVersion": "2023-04-27", + "apiVersion": "2024-04-24", "learnMore": { "url": "https://learn.microsoft.com/powershell/module/az.dynatraceobservability" }, "commands": [ { - "name": "Get-AzDynatraceMonitorMetricStatus", - "description": "Get metric status", - "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Dynatrace.Observability/monitors/{monitorName}/getMetricStatus", + "name": "Get-AzDynatraceMonitoredSubscription", + "description": "List the subscriptions currently being monitored by the Dynatrace monitor resource.", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Dynatrace.Observability/monitors/{monitorName}/monitoredSubscriptions/default", "help": { "learnMore": { - "url": "https://learn.microsoft.com/powershell/module/az.dynatraceobservability/get-azdynatracemonitormetricstatus" + "url": "https://learn.microsoft.com/powershell/module/az.dynatraceobservability/get-azdynatracemonitoredsubscription" }, "parameterSets": [ { @@ -25,7 +25,7 @@ }, "examples": [ { - "description": "Get metric status", + "description": "List the subscriptions currently being monitored by the Dynatrace monitor resource.", "parameters": [ { "name": "-MonitorName", @@ -119,6 +119,44 @@ } ] }, + { + "name": "Remove-AzDynatraceMonitoredSubscription", + "description": "Delete the subscriptions that are being monitored by the Dynatrace monitor resource", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Dynatrace.Observability/monitors/{monitorName}/monitoredSubscriptions/default", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.dynatraceobservability/remove-azdynatracemonitoredsubscription" + }, + "parameterSets": [ + { + "parameters": [ + "-MonitorName ", + "-ResourceGroupName ", + "[-SubscriptionId ]" + ] + } + ] + }, + "examples": [ + { + "description": "delete the subscriptions that are being monitored by the Dynatrace monitor resource", + "parameters": [ + { + "name": "-MonitorName", + "value": "[Path.monitorName]" + }, + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + } + ] + } + ] + }, { "name": "Remove-AzDynatraceMonitor", "description": "Delete a MonitorResource", diff --git a/src/DynatraceObservability/DynatraceObservability.Autorest/custom/Az.DynatraceObservability.custom.psm1 b/src/DynatraceObservability/DynatraceObservability.Autorest/custom/Az.DynatraceObservability.custom.psm1 index 29144135d88f..184cf37ed795 100644 --- a/src/DynatraceObservability/DynatraceObservability.Autorest/custom/Az.DynatraceObservability.custom.psm1 +++ b/src/DynatraceObservability/DynatraceObservability.Autorest/custom/Az.DynatraceObservability.custom.psm1 @@ -1,9 +1,9 @@ # region Generated # Load the private module dll - $null = Import-Module -PassThru -Name (Join-Path $PSScriptRoot '..\bin\Az.DynatraceObservability.private.dll') + $null = Import-Module -PassThru -Name (Join-Path $PSScriptRoot '../bin/Az.DynatraceObservability.private.dll') # Load the internal module - $internalModulePath = Join-Path $PSScriptRoot '..\internal\Az.DynatraceObservability.internal.psm1' + $internalModulePath = Join-Path $PSScriptRoot '../internal/Az.DynatraceObservability.internal.psm1' if(Test-Path $internalModulePath) { $null = Import-Module -Name $internalModulePath } diff --git a/src/DynatraceObservability/DynatraceObservability.Autorest/custom/README.md b/src/DynatraceObservability/DynatraceObservability.Autorest/custom/README.md index 58577378e1d8..9d24a95620f7 100644 --- a/src/DynatraceObservability/DynatraceObservability.Autorest/custom/README.md +++ b/src/DynatraceObservability/DynatraceObservability.Autorest/custom/README.md @@ -1,5 +1,5 @@ # Custom -This directory contains custom implementation for non-generated cmdlets for the `Az.DynatraceObservability` module. Both scripts (`.ps1`) and C# files (`.cs`) can be implemented here. They will be used during the build process in `build-module.ps1`, and create cmdlets into the `..\exports` folder. The only generated file into this folder is the `Az.DynatraceObservability.custom.psm1`. This file should not be modified. +This directory contains custom implementation for non-generated cmdlets for the `Az.DynatraceObservability` module. Both scripts (`.ps1`) and C# files (`.cs`) can be implemented here. They will be used during the build process in `build-module.ps1`, and create cmdlets into the `../exports` folder. The only generated file into this folder is the `Az.DynatraceObservability.custom.psm1`. This file should not be modified. ## Info - Modifiable: yes @@ -15,10 +15,10 @@ For C# cmdlets, they are compiled with the rest of the generated low-level cmdle For script cmdlets, these are loaded via the `Az.DynatraceObservability.custom.psm1`. Then, during the build process, this module is loaded and processed in the same manner as the C# cmdlets. The fundamental difference is the script cmdlets use the `ParameterSetName` attribute and C# cmdlets do not. To create a script cmdlet variant of a generated cmdlet, simply decorate all parameters in the script with the new `ParameterSetName` in the `Parameter` attribute. This will appropriately treat each parameter set as a separate variant when processed to be exported during the build. ## Purpose -This allows the modules to have cmdlets that were not defined in the REST specification. It also allows combining logic using generated cmdlets. This is a level of customization beyond what can be done using the [readme configuration options](https://github.com/Azure/autorest/blob/master/docs/powershell/options.md) that are currently available. These custom cmdlets are then referenced by the cmdlets created at build-time in the `..\exports` folder. +This allows the modules to have cmdlets that were not defined in the REST specification. It also allows combining logic using generated cmdlets. This is a level of customization beyond what can be done using the [readme configuration options](https://github.com/Azure/autorest/blob/master/docs/powershell/options.md) that are currently available. These custom cmdlets are then referenced by the cmdlets created at build-time in the `../exports` folder. ## Usage -The easiest way currently to start developing custom cmdlets is to copy an existing cmdlet. For C# cmdlets, copy one from the `generated/cmdlets` folder. For script cmdlets, build the project using `build-module.ps1` and copy one of the scripts from the `..\exports` folder. After that, if you want to add new parameter sets, follow the guidelines in the `Details` section above. For implementing a new cmdlets, at minimum, please keep these parameters: +The easiest way currently to start developing custom cmdlets is to copy an existing cmdlet. For C# cmdlets, copy one from the `generated/cmdlets` folder. For script cmdlets, build the project using `build-module.ps1` and copy one of the scripts from the `../exports` folder. After that, if you want to add new parameter sets, follow the guidelines in the `Details` section above. For implementing a new cmdlets, at minimum, please keep these parameters: - Break - DefaultProfile - HttpPipelineAppend @@ -36,6 +36,6 @@ For processing the cmdlets, we've created some additional attributes: - `Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.DoNotExportAttribute` - Used in C# and script cmdlets to suppress creating an exported cmdlet at build-time. These cmdlets will *not be exposed* by `Az.DynatraceObservability`. - `Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.InternalExportAttribute` - - Used in C# cmdlets to route exported cmdlets to the `..\internal`, which are *not exposed* by `Az.DynatraceObservability`. For more information, see [README.md](..\internal/README.md) in the `..\internal` folder. + - Used in C# cmdlets to route exported cmdlets to the `../internal`, which are *not exposed* by `Az.DynatraceObservability`. For more information, see [README.md](../internal/README.md) in the `../internal` folder. - `Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.ProfileAttribute` - Used in C# and script cmdlets to define which Azure profiles the cmdlet supports. This is only supported for Azure (`--azure`) modules. \ No newline at end of file diff --git a/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Az.DynatraceObservability.md b/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Az.DynatraceObservability.md index 2e73b8713752..79c966b8df6a 100644 --- a/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Az.DynatraceObservability.md +++ b/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Az.DynatraceObservability.md @@ -1,6 +1,6 @@ --- Module Name: Az.DynatraceObservability -Module Guid: f889aadf-56ba-485c-8077-283219e39439 +Module Guid: eada85a3-a8b1-4fc1-b953-defbdf14917f Download Help Link: https://learn.microsoft.com/powershell/module/az.dynatraceobservability Help Version: 1.0.0.0 Locale: en-US @@ -20,6 +20,9 @@ Gets list of App Services with Dynatrace PaaS OneAgent enabled ### [Get-AzDynatraceMonitoredResource](Get-AzDynatraceMonitoredResource.md) List the resources currently being monitored by the Dynatrace monitor resource. +### [Get-AzDynatraceMonitoredSubscription](Get-AzDynatraceMonitoredSubscription.md) +List the subscriptions currently being monitored by the Dynatrace monitor resource. + ### [Get-AzDynatraceMonitorHost](Get-AzDynatraceMonitorHost.md) List the VM/VMSS resources currently being monitored by the Dynatrace resource. @@ -27,7 +30,7 @@ List the VM/VMSS resources currently being monitored by the Dynatrace resource. Gets all the Dynatrace environments that a user can link a azure resource to ### [Get-AzDynatraceMonitorMarketplaceSaaSResourceDetail](Get-AzDynatraceMonitorMarketplaceSaaSResourceDetail.md) -Get Marketplace SaaS resource details of a tenant under a specific subscription +Get Marketplace SaaS resource details ### [Get-AzDynatraceMonitorMetricStatus](Get-AzDynatraceMonitorMetricStatus.md) Get metric status @@ -44,30 +47,42 @@ Get a TagRule ### [Get-AzDynatraceMonitorVMHostPayload](Get-AzDynatraceMonitorVMHostPayload.md) Returns the payload that needs to be passed in the request body for installing Dynatrace agent on a VM. +### [Invoke-AzDynatraceManageMonitorAgentInstallation](Invoke-AzDynatraceManageMonitorAgentInstallation.md) +Performs Dynatrace agent install/uninstall action through the Azure Dynatrace resource on the provided list of resources. + ### [New-AzDynatraceMonitor](New-AzDynatraceMonitor.md) -create a MonitorResource +Create a MonitorResource + +### [New-AzDynatraceMonitoredSubscription](New-AzDynatraceMonitoredSubscription.md) +Add the subscriptions that should be monitored by the Dynatrace monitor resource. ### [New-AzDynatraceMonitorFilteringTagObject](New-AzDynatraceMonitorFilteringTagObject.md) Create an in-memory object for FilteringTag. ### [New-AzDynatraceMonitorSSOConfig](New-AzDynatraceMonitorSSOConfig.md) -create a DynatraceSingleSignOnResource +Create a DynatraceSingleSignOnResource ### [New-AzDynatraceMonitorTagRule](New-AzDynatraceMonitorTagRule.md) -create a TagRule +Create a TagRule ### [Remove-AzDynatraceMonitor](Remove-AzDynatraceMonitor.md) Delete a MonitorResource +### [Remove-AzDynatraceMonitoredSubscription](Remove-AzDynatraceMonitoredSubscription.md) +Delete the subscriptions that are being monitored by the Dynatrace monitor resource + ### [Remove-AzDynatraceMonitorTagRule](Remove-AzDynatraceMonitorTagRule.md) Delete a TagRule ### [Update-AzDynatraceMonitor](Update-AzDynatraceMonitor.md) -update a MonitorResource +Update a MonitorResource + +### [Update-AzDynatraceMonitorPlan](Update-AzDynatraceMonitorPlan.md) +Upgrades the billing Plan for Dynatrace monitor resource. ### [Update-AzDynatraceMonitorSSOConfig](Update-AzDynatraceMonitorSSOConfig.md) -update a DynatraceSingleSignOnResource +Update a DynatraceSingleSignOnResource ### [Update-AzDynatraceMonitorTagRule](Update-AzDynatraceMonitorTagRule.md) -update a TagRule +Update a TagRule diff --git a/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Get-AzDynatraceMonitor.md b/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Get-AzDynatraceMonitor.md index f0ec459037f7..6fbc4fa13de7 100644 --- a/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Get-AzDynatraceMonitor.md +++ b/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Get-AzDynatraceMonitor.md @@ -158,6 +158,7 @@ Accept wildcard characters: False ### -SubscriptionId The ID of the target subscription. +The value must be an UUID. ```yaml Type: System.String[] diff --git a/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Get-AzDynatraceMonitorAppService.md b/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Get-AzDynatraceMonitorAppService.md index 64fa981e5628..fc79a75e748a 100644 --- a/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Get-AzDynatraceMonitorAppService.md +++ b/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Get-AzDynatraceMonitorAppService.md @@ -80,6 +80,7 @@ Accept wildcard characters: False ### -SubscriptionId The ID of the target subscription. +The value must be an UUID. ```yaml Type: System.String[] diff --git a/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Get-AzDynatraceMonitorHost.md b/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Get-AzDynatraceMonitorHost.md index 41652cbea8bc..6d59c649e933 100644 --- a/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Get-AzDynatraceMonitorHost.md +++ b/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Get-AzDynatraceMonitorHost.md @@ -80,6 +80,7 @@ Accept wildcard characters: False ### -SubscriptionId The ID of the target subscription. +The value must be an UUID. ```yaml Type: System.String[] diff --git a/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Get-AzDynatraceMonitorLinkableEnv.md b/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Get-AzDynatraceMonitorLinkableEnv.md index 3fe6d9ea6ee2..98881ed090f3 100644 --- a/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Get-AzDynatraceMonitorLinkableEnv.md +++ b/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Get-AzDynatraceMonitorLinkableEnv.md @@ -139,6 +139,7 @@ Accept wildcard characters: False ### -SubscriptionId The ID of the target subscription. +The value must be an UUID. ```yaml Type: System.String[] diff --git a/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Get-AzDynatraceMonitorMarketplaceSaaSResourceDetail.md b/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Get-AzDynatraceMonitorMarketplaceSaaSResourceDetail.md index 3c5c23befd70..6fcff8789ada 100644 --- a/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Get-AzDynatraceMonitorMarketplaceSaaSResourceDetail.md +++ b/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Get-AzDynatraceMonitorMarketplaceSaaSResourceDetail.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-AzDynatraceMonitorMarketplaceSaaSResourceDetail ## SYNOPSIS -Get Marketplace SaaS resource details of a tenant under a specific subscription +Get Marketplace SaaS resource details ## SYNTAX @@ -37,7 +37,7 @@ Get-AzDynatraceMonitorMarketplaceSaaSResourceDetail -JsonString [-Subsc ``` ## DESCRIPTION -Get Marketplace SaaS resource details of a tenant under a specific subscription +Get Marketplace SaaS resource details ## EXAMPLES @@ -119,6 +119,7 @@ Accept wildcard characters: False ### -SubscriptionId The ID of the target subscription. +The value must be an UUID. ```yaml Type: System.String[] diff --git a/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Get-AzDynatraceMonitorMetricStatus.md b/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Get-AzDynatraceMonitorMetricStatus.md index 7c81ec09ff63..9f66fba84396 100644 --- a/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Get-AzDynatraceMonitorMetricStatus.md +++ b/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Get-AzDynatraceMonitorMetricStatus.md @@ -12,16 +12,42 @@ Get metric status ## SYNTAX -### Get (Default) +### GetExpanded (Default) ``` Get-AzDynatraceMonitorMetricStatus -MonitorName -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] + [-SubscriptionId ] [-MonitoredResourceId ] [-DefaultProfile ] [-Confirm] + [-WhatIf] [] +``` + +### Get +``` +Get-AzDynatraceMonitorMetricStatus -MonitorName -ResourceGroupName + -Request [-SubscriptionId ] [-DefaultProfile ] [-Confirm] + [-WhatIf] [] ``` ### GetViaIdentity ``` -Get-AzDynatraceMonitorMetricStatus -InputObject [-DefaultProfile ] - [-Confirm] [-WhatIf] [] +Get-AzDynatraceMonitorMetricStatus -InputObject + -Request [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### GetViaIdentityExpanded +``` +Get-AzDynatraceMonitorMetricStatus -InputObject + [-MonitoredResourceId ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### GetViaJsonFilePath +``` +Get-AzDynatraceMonitorMetricStatus -MonitorName -ResourceGroupName -JsonFilePath + [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### GetViaJsonString +``` +Get-AzDynatraceMonitorMetricStatus -MonitorName -ResourceGroupName -JsonString + [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] ``` ## DESCRIPTION @@ -64,7 +90,7 @@ Identity Parameter ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.IDynatraceObservabilityIdentity -Parameter Sets: GetViaIdentity +Parameter Sets: GetViaIdentity, GetViaIdentityExpanded Aliases: Required: True @@ -74,12 +100,57 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -JsonFilePath +Path of Json file supplied to the Get operation + +```yaml +Type: System.String +Parameter Sets: GetViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Get operation + +```yaml +Type: System.String +Parameter Sets: GetViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonitoredResourceId +List of azure resource Id of monitored resources for which we get the metric status + +```yaml +Type: System.String[] +Parameter Sets: GetExpanded, GetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -MonitorName -Name of the Monitor resource +Name of the Monitors resource ```yaml Type: System.String -Parameter Sets: Get +Parameter Sets: Get, GetExpanded, GetViaJsonFilePath, GetViaJsonString Aliases: Required: True @@ -89,13 +160,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Request +Request for getting metric status for given monitored resource Ids + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.IMetricStatusRequest +Parameter Sets: Get, GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. ```yaml Type: System.String -Parameter Sets: Get +Parameter Sets: Get, GetExpanded, GetViaJsonFilePath, GetViaJsonString Aliases: Required: True @@ -107,10 +193,11 @@ Accept wildcard characters: False ### -SubscriptionId The ID of the target subscription. +The value must be an UUID. ```yaml Type: System.String[] -Parameter Sets: Get +Parameter Sets: Get, GetExpanded, GetViaJsonFilePath, GetViaJsonString Aliases: Required: False @@ -158,6 +245,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.IDynatraceObservabilityIdentity +### Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.IMetricStatusRequest + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.IMetricsStatusResponse diff --git a/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Get-AzDynatraceMonitorSSOConfig.md b/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Get-AzDynatraceMonitorSSOConfig.md index 9b1db5b49a1c..45272910f214 100644 --- a/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Get-AzDynatraceMonitorSSOConfig.md +++ b/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Get-AzDynatraceMonitorSSOConfig.md @@ -142,6 +142,7 @@ Accept wildcard characters: False ### -SubscriptionId The ID of the target subscription. +The value must be an UUID. ```yaml Type: System.String[] diff --git a/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Get-AzDynatraceMonitorSSODetail.md b/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Get-AzDynatraceMonitorSSODetail.md index 93be163b09c6..4590536d4093 100644 --- a/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Get-AzDynatraceMonitorSSODetail.md +++ b/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Get-AzDynatraceMonitorSSODetail.md @@ -129,6 +129,7 @@ Accept wildcard characters: False ### -SubscriptionId The ID of the target subscription. +The value must be an UUID. ```yaml Type: System.String[] diff --git a/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Get-AzDynatraceMonitorTagRule.md b/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Get-AzDynatraceMonitorTagRule.md index 549a947f6171..be223a69207f 100644 --- a/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Get-AzDynatraceMonitorTagRule.md +++ b/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Get-AzDynatraceMonitorTagRule.md @@ -143,6 +143,7 @@ Accept wildcard characters: False ### -SubscriptionId The ID of the target subscription. +The value must be an UUID. ```yaml Type: System.String[] diff --git a/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Get-AzDynatraceMonitorVMHostPayload.md b/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Get-AzDynatraceMonitorVMHostPayload.md index 90d63fe2f1b8..20a2fb287855 100644 --- a/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Get-AzDynatraceMonitorVMHostPayload.md +++ b/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Get-AzDynatraceMonitorVMHostPayload.md @@ -86,6 +86,7 @@ Accept wildcard characters: False ### -SubscriptionId The ID of the target subscription. +The value must be an UUID. ```yaml Type: System.String[] diff --git a/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Get-AzDynatraceMonitoredResource.md b/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Get-AzDynatraceMonitoredResource.md index a4baa091ee77..add10b1ad6d6 100644 --- a/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Get-AzDynatraceMonitoredResource.md +++ b/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Get-AzDynatraceMonitoredResource.md @@ -12,9 +12,29 @@ List the resources currently being monitored by the Dynatrace monitor resource. ## SYNTAX +### ListExpanded (Default) ``` Get-AzDynatraceMonitoredResource -MonitorName -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [] + [-SubscriptionId ] [-MonitoredResourceId ] [-DefaultProfile ] [-Confirm] + [-WhatIf] [] +``` + +### List +``` +Get-AzDynatraceMonitoredResource -MonitorName -ResourceGroupName + -Request [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### ListViaJsonFilePath +``` +Get-AzDynatraceMonitoredResource -MonitorName -ResourceGroupName -JsonFilePath + [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### ListViaJsonString +``` +Get-AzDynatraceMonitoredResource -MonitorName -ResourceGroupName -JsonString + [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] ``` ## DESCRIPTION @@ -47,6 +67,51 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -JsonFilePath +Path of Json file supplied to the List operation + +```yaml +Type: System.String +Parameter Sets: ListViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the List operation + +```yaml +Type: System.String +Parameter Sets: ListViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonitoredResourceId +List of azure resource Id of monitored resources for which we get the log status + +```yaml +Type: System.String[] +Parameter Sets: ListExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -MonitorName Monitor resource name @@ -62,6 +127,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Request +Request for getting log status for given monitored resource Ids + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.ILogStatusRequest +Parameter Sets: List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -80,6 +160,7 @@ Accept wildcard characters: False ### -SubscriptionId The ID of the target subscription. +The value must be an UUID. ```yaml Type: System.String[] @@ -93,11 +174,44 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS +### Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.ILogStatusRequest + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.IMonitoredResource diff --git a/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Get-AzDynatraceMonitoredSubscription.md b/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Get-AzDynatraceMonitoredSubscription.md new file mode 100644 index 000000000000..2d150b01309d --- /dev/null +++ b/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Get-AzDynatraceMonitoredSubscription.md @@ -0,0 +1,154 @@ +--- +external help file: +Module Name: Az.DynatraceObservability +online version: https://learn.microsoft.com/powershell/module/az.dynatraceobservability/get-azdynatracemonitoredsubscription +schema: 2.0.0 +--- + +# Get-AzDynatraceMonitoredSubscription + +## SYNOPSIS +List the subscriptions currently being monitored by the Dynatrace monitor resource. + +## SYNTAX + +### Get (Default) +``` +Get-AzDynatraceMonitoredSubscription -MonitorName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzDynatraceMonitoredSubscription -InputObject + [-DefaultProfile ] [] +``` + +### List +``` +Get-AzDynatraceMonitoredSubscription -MonitorName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +## DESCRIPTION +List the subscriptions currently being monitored by the Dynatrace monitor resource. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.IDynatraceObservabilityIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MonitorName +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.IDynatraceObservabilityIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.IMonitoredSubscriptionProperties + +## NOTES + +## RELATED LINKS + diff --git a/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Invoke-AzDynatraceManageMonitorAgentInstallation.md b/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Invoke-AzDynatraceManageMonitorAgentInstallation.md new file mode 100644 index 000000000000..5558ba7ac35c --- /dev/null +++ b/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Invoke-AzDynatraceManageMonitorAgentInstallation.md @@ -0,0 +1,301 @@ +--- +external help file: +Module Name: Az.DynatraceObservability +online version: https://learn.microsoft.com/powershell/module/az.dynatraceobservability/invoke-azdynatracemanagemonitoragentinstallation +schema: 2.0.0 +--- + +# Invoke-AzDynatraceManageMonitorAgentInstallation + +## SYNOPSIS +Performs Dynatrace agent install/uninstall action through the Azure Dynatrace resource on the provided list of resources. + +## SYNTAX + +### ManageViaIdentity (Default) +``` +Invoke-AzDynatraceManageMonitorAgentInstallation -InputObject + -Request [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +### Manage +``` +Invoke-AzDynatraceManageMonitorAgentInstallation -MonitorName -ResourceGroupName + -Request [-SubscriptionId ] [-DefaultProfile ] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### ManageExpanded +``` +Invoke-AzDynatraceManageMonitorAgentInstallation -MonitorName -ResourceGroupName + -Action -ManageAgentInstallationList [-SubscriptionId ] + [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### ManageViaIdentityExpanded +``` +Invoke-AzDynatraceManageMonitorAgentInstallation -InputObject + -Action -ManageAgentInstallationList [-DefaultProfile ] [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +### ManageViaJsonFilePath +``` +Invoke-AzDynatraceManageMonitorAgentInstallation -MonitorName -ResourceGroupName + -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] + [-WhatIf] [] +``` + +### ManageViaJsonString +``` +Invoke-AzDynatraceManageMonitorAgentInstallation -MonitorName -ResourceGroupName + -JsonString [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Performs Dynatrace agent install/uninstall action through the Azure Dynatrace resource on the provided list of resources. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -Action +Install/Uninstall action. + +```yaml +Type: System.String +Parameter Sets: ManageExpanded, ManageViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.IDynatraceObservabilityIdentity +Parameter Sets: ManageViaIdentity, ManageViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Manage operation + +```yaml +Type: System.String +Parameter Sets: ManageViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Manage operation + +```yaml +Type: System.String +Parameter Sets: ManageViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManageAgentInstallationList +The list of resources. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.IManageAgentList[] +Parameter Sets: ManageExpanded, ManageViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonitorName +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: Manage, ManageExpanded, ManageViaJsonFilePath, ManageViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Request +Request for performing Dynatrace agent install/uninstall action through the Azure Dynatrace resource on the provided list of agent resources. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.IManageAgentInstallationRequest +Parameter Sets: Manage, ManageViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Manage, ManageExpanded, ManageViaJsonFilePath, ManageViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Manage, ManageExpanded, ManageViaJsonFilePath, ManageViaJsonString +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.IDynatraceObservabilityIdentity + +### Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.IManageAgentInstallationRequest + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + diff --git a/src/DynatraceObservability/DynatraceObservability.Autorest/docs/New-AzDynatraceMonitor.md b/src/DynatraceObservability/DynatraceObservability.Autorest/docs/New-AzDynatraceMonitor.md index ef8d463c76dd..a536a1186869 100644 --- a/src/DynatraceObservability/DynatraceObservability.Autorest/docs/New-AzDynatraceMonitor.md +++ b/src/DynatraceObservability/DynatraceObservability.Autorest/docs/New-AzDynatraceMonitor.md @@ -8,22 +8,23 @@ schema: 2.0.0 # New-AzDynatraceMonitor ## SYNOPSIS -create a MonitorResource +Create a MonitorResource ## SYNTAX ### CreateExpanded (Default) ``` New-AzDynatraceMonitor -Name -ResourceGroupName -Location - [-SubscriptionId ] [-AccountId ] [-AccountRegionId ] [-EnableSystemAssignedIdentity] - [-EnvironmentId ] [-EnvironmentIngestionKey ] [-EnvironmentLandingUrl ] - [-EnvironmentLogsIngestionEndpoint ] [-EnvironmentUserId ] - [-MarketplaceSubscriptionStatus ] [-MonitoringStatus ] [-PlanBillingCycle ] - [-PlanDetail ] [-PlanEffectiveDate ] [-PlanUsageType ] - [-SingleSignOnAadDomain ] [-SingleSignOnEnterpriseAppId ] [-SingleSignOnState ] - [-SingleSignOnUrl ] [-Tag ] [-UserAssignedIdentity ] [-UserCountry ] - [-UserEmailAddress ] [-UserFirstName ] [-UserLastName ] [-UserPhoneNumber ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] + [-SubscriptionId ] [-AccountId ] [-AccountInfoCompanyName ] + [-AccountRegionId ] [-EnvironmentId ] [-EnvironmentIngestionKey ] + [-EnvironmentLandingUrl ] [-EnvironmentLogsIngestionEndpoint ] [-EnvironmentUserId ] + [-IdentityType ] [-MarketplaceSaasAutoRenew ] [-MarketplaceSubscriptionStatus ] + [-MonitoringStatus ] [-PlanBillingCycle ] [-PlanDetail ] + [-PlanEffectiveDate ] [-PlanUsageType ] [-SingleSignOnAadDomain ] + [-SingleSignOnEnterpriseAppId ] [-SingleSignOnState ] [-SingleSignOnUrl ] + [-Tag ] [-UserAssignedIdentity ] [-UserCountry ] [-UserEmailAddress ] + [-UserFirstName ] [-UserLastName ] [-UserPhoneNumber ] [-DefaultProfile ] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] ``` ### CreateViaJsonFilePath @@ -41,7 +42,7 @@ New-AzDynatraceMonitor -Name -ResourceGroupName -JsonString -ResourceGroupName -ResourceGroupName ``` ## DESCRIPTION -create a TagRule +Create a TagRule ## EXAMPLES @@ -285,6 +285,7 @@ Accept wildcard characters: False ### -SubscriptionId The ID of the target subscription. +The value must be an UUID. ```yaml Type: System.String diff --git a/src/DynatraceObservability/DynatraceObservability.Autorest/docs/New-AzDynatraceMonitoredSubscription.md b/src/DynatraceObservability/DynatraceObservability.Autorest/docs/New-AzDynatraceMonitoredSubscription.md new file mode 100644 index 000000000000..6bebb66653f2 --- /dev/null +++ b/src/DynatraceObservability/DynatraceObservability.Autorest/docs/New-AzDynatraceMonitoredSubscription.md @@ -0,0 +1,261 @@ +--- +external help file: +Module Name: Az.DynatraceObservability +online version: https://learn.microsoft.com/powershell/module/az.dynatraceobservability/new-azdynatracemonitoredsubscription +schema: 2.0.0 +--- + +# New-AzDynatraceMonitoredSubscription + +## SYNOPSIS +Add the subscriptions that should be monitored by the Dynatrace monitor resource. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzDynatraceMonitoredSubscription -MonitorName -ResourceGroupName + [-SubscriptionId ] [-MonitoredSubscriptionList ] [-Operation ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### CreateViaJsonFilePath +``` +New-AzDynatraceMonitoredSubscription -MonitorName -ResourceGroupName -JsonFilePath + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +### CreateViaJsonString +``` +New-AzDynatraceMonitoredSubscription -MonitorName -ResourceGroupName -JsonString + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Add the subscriptions that should be monitored by the Dynatrace monitor resource. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonitoredSubscriptionList +List of subscriptions and the state of the monitoring. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.IMonitoredSubscription[] +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonitorName +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Operation +The operation for the patch on the resource. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.IMonitoredSubscriptionProperties + +## NOTES + +## RELATED LINKS + diff --git a/src/DynatraceObservability/DynatraceObservability.Autorest/docs/README.md b/src/DynatraceObservability/DynatraceObservability.Autorest/docs/README.md index fafc89f4b6d5..4e196b61d31e 100644 --- a/src/DynatraceObservability/DynatraceObservability.Autorest/docs/README.md +++ b/src/DynatraceObservability/DynatraceObservability.Autorest/docs/README.md @@ -1,5 +1,5 @@ # Docs -This directory contains the documentation of the cmdlets for the `Az.DynatraceObservability` module. To run documentation generation, use the `generate-help.ps1` script at the root module folder. Files in this folder will *always be overridden on regeneration*. To update documentation examples, please use the `..\examples` folder. +This directory contains the documentation of the cmdlets for the `Az.DynatraceObservability` module. To run documentation generation, use the `generate-help.ps1` script at the root module folder. Files in this folder will *always be overridden 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.DynatraceOb - Packaged: yes ## Details -The process of documentation generation loads `Az.DynatraceObservability` and analyzes the exported cmdlets from the module. It recognizes the [help comments](https://learn.microsoft.com/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.DynatraceObservability` and analyzes the exported cmdlets from the module. It recognizes the [help comments](https://learn.microsoft.com/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/DynatraceObservability/DynatraceObservability.Autorest/docs/Remove-AzDynatraceMonitor.md b/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Remove-AzDynatraceMonitor.md index ef13422e3e1a..d9ca2734d42a 100644 --- a/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Remove-AzDynatraceMonitor.md +++ b/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Remove-AzDynatraceMonitor.md @@ -154,6 +154,7 @@ Accept wildcard characters: False ### -SubscriptionId The ID of the target subscription. +The value must be an UUID. ```yaml Type: System.String diff --git a/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Remove-AzDynatraceMonitorTagRule.md b/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Remove-AzDynatraceMonitorTagRule.md index aa7c3e76ebe1..fbba75b37ac8 100644 --- a/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Remove-AzDynatraceMonitorTagRule.md +++ b/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Remove-AzDynatraceMonitorTagRule.md @@ -175,6 +175,7 @@ Accept wildcard characters: False ### -SubscriptionId The ID of the target subscription. +The value must be an UUID. ```yaml Type: System.String diff --git a/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Remove-AzDynatraceMonitoredSubscription.md b/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Remove-AzDynatraceMonitoredSubscription.md new file mode 100644 index 000000000000..b0adc7deb08b --- /dev/null +++ b/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Remove-AzDynatraceMonitoredSubscription.md @@ -0,0 +1,225 @@ +--- +external help file: +Module Name: Az.DynatraceObservability +online version: https://learn.microsoft.com/powershell/module/az.dynatraceobservability/remove-azdynatracemonitoredsubscription +schema: 2.0.0 +--- + +# Remove-AzDynatraceMonitoredSubscription + +## SYNOPSIS +Delete the subscriptions that are being monitored by the Dynatrace monitor resource + +## SYNTAX + +### Delete (Default) +``` +Remove-AzDynatraceMonitoredSubscription -MonitorName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +### DeleteViaIdentity +``` +Remove-AzDynatraceMonitoredSubscription -InputObject + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Delete the subscriptions that are being monitored by the Dynatrace monitor resource + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.IDynatraceObservabilityIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MonitorName +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.IDynatraceObservabilityIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + diff --git a/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Update-AzDynatraceMonitor.md b/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Update-AzDynatraceMonitor.md index b8423fb6054b..5b57d0c86d6f 100644 --- a/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Update-AzDynatraceMonitor.md +++ b/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Update-AzDynatraceMonitor.md @@ -8,20 +8,24 @@ schema: 2.0.0 # Update-AzDynatraceMonitor ## SYNOPSIS -update a MonitorResource +Update a MonitorResource ## SYNTAX ### UpdateExpanded (Default) ``` Update-AzDynatraceMonitor -Name -ResourceGroupName [-SubscriptionId ] - [-Tag ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] + [-IdentityType ] [-PlanBillingCycle ] [-PlanDetail ] [-PlanEffectiveDate ] + [-PlanUsageType ] [-Tag ] [-UserAssignedIdentity ] [-DefaultProfile ] + [-Confirm] [-WhatIf] [] ``` ### UpdateViaIdentityExpanded ``` -Update-AzDynatraceMonitor -InputObject [-Tag ] - [-DefaultProfile ] [-Confirm] [-WhatIf] [] +Update-AzDynatraceMonitor -InputObject [-IdentityType ] + [-PlanBillingCycle ] [-PlanDetail ] [-PlanEffectiveDate ] [-PlanUsageType ] + [-Tag ] [-UserAssignedIdentity ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] ``` ### UpdateViaJsonFilePath @@ -37,7 +41,7 @@ Update-AzDynatraceMonitor -Name -ResourceGroupName -JsonString ``` ## DESCRIPTION -update a MonitorResource +Update a MonitorResource ## EXAMPLES @@ -85,6 +89,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -IdentityType +Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -InputObject Identity Parameter @@ -145,6 +164,68 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -PlanBillingCycle +different billing cycles like MONTHLY/WEEKLY. +this could be enum + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanDetail +plan id as published by Dynatrace + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanEffectiveDate +date when plan was applied + +```yaml +Type: System.DateTime +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanUsageType +different usage type like PAYG/COMMITTED. +this could be enum + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -163,6 +244,7 @@ Accept wildcard characters: False ### -SubscriptionId The ID of the target subscription. +The value must be an UUID. ```yaml Type: System.String @@ -191,6 +273,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -UserAssignedIdentity +The array of user assigned identities associated with the resource. +The elements in array will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.' + +```yaml +Type: System.String[] +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Confirm Prompts you for confirmation before running the cmdlet. diff --git a/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Update-AzDynatraceMonitorPlan.md b/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Update-AzDynatraceMonitorPlan.md new file mode 100644 index 000000000000..a68475bb3c56 --- /dev/null +++ b/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Update-AzDynatraceMonitorPlan.md @@ -0,0 +1,363 @@ +--- +external help file: +Module Name: Az.DynatraceObservability +online version: https://learn.microsoft.com/powershell/module/az.dynatraceobservability/update-azdynatracemonitorplan +schema: 2.0.0 +--- + +# Update-AzDynatraceMonitorPlan + +## SYNOPSIS +Upgrades the billing Plan for Dynatrace monitor resource. + +## SYNTAX + +### UpgradeExpanded (Default) +``` +Update-AzDynatraceMonitorPlan -MonitorName -ResourceGroupName [-SubscriptionId ] + [-PlanDataBillingCycle ] [-PlanDataEffectiveDate ] [-PlanDataPlanDetail ] + [-PlanDataUsageType ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] + [-WhatIf] [] +``` + +### Upgrade +``` +Update-AzDynatraceMonitorPlan -MonitorName -ResourceGroupName -Request + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +### UpgradeViaIdentity +``` +Update-AzDynatraceMonitorPlan -InputObject -Request + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### UpgradeViaIdentityExpanded +``` +Update-AzDynatraceMonitorPlan -InputObject [-PlanDataBillingCycle ] + [-PlanDataEffectiveDate ] [-PlanDataPlanDetail ] [-PlanDataUsageType ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### UpgradeViaJsonFilePath +``` +Update-AzDynatraceMonitorPlan -MonitorName -ResourceGroupName -JsonFilePath + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +### UpgradeViaJsonString +``` +Update-AzDynatraceMonitorPlan -MonitorName -ResourceGroupName -JsonString + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Upgrades the billing Plan for Dynatrace monitor resource. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.IDynatraceObservabilityIdentity +Parameter Sets: UpgradeViaIdentity, UpgradeViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Upgrade operation + +```yaml +Type: System.String +Parameter Sets: UpgradeViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Upgrade operation + +```yaml +Type: System.String +Parameter Sets: UpgradeViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonitorName +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: Upgrade, UpgradeExpanded, UpgradeViaJsonFilePath, UpgradeViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanDataBillingCycle +different billing cycles like MONTHLY/WEEKLY. +this could be enum + +```yaml +Type: System.String +Parameter Sets: UpgradeExpanded, UpgradeViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanDataEffectiveDate +date when plan was applied + +```yaml +Type: System.DateTime +Parameter Sets: UpgradeExpanded, UpgradeViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanDataPlanDetail +plan id as published by Dynatrace + +```yaml +Type: System.String +Parameter Sets: UpgradeExpanded, UpgradeViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanDataUsageType +different usage type like PAYG/COMMITTED. +this could be enum + +```yaml +Type: System.String +Parameter Sets: UpgradeExpanded, UpgradeViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Request +The billing plan properties for the upgrade plan call. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.IUpgradePlanRequest +Parameter Sets: Upgrade, UpgradeViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Upgrade, UpgradeExpanded, UpgradeViaJsonFilePath, UpgradeViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Upgrade, UpgradeExpanded, UpgradeViaJsonFilePath, UpgradeViaJsonString +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.IDynatraceObservabilityIdentity + +### Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.IUpgradePlanRequest + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + diff --git a/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Update-AzDynatraceMonitorSSOConfig.md b/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Update-AzDynatraceMonitorSSOConfig.md index 0b8d848e9d0a..21f8223787ef 100644 --- a/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Update-AzDynatraceMonitorSSOConfig.md +++ b/src/DynatraceObservability/DynatraceObservability.Autorest/docs/Update-AzDynatraceMonitorSSOConfig.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Update-AzDynatraceMonitorSSOConfig ## SYNOPSIS -update a DynatraceSingleSignOnResource +Update a DynatraceSingleSignOnResource ## SYNTAX @@ -35,7 +35,7 @@ Update-AzDynatraceMonitorSSOConfig -MonitorInputObject ] ``` ## DESCRIPTION -Get Marketplace SaaS resource details of a tenant under a specific subscription +Get Marketplace SaaS resource details ## EXAMPLES @@ -120,6 +120,7 @@ Accept wildcard characters: False ### -SubscriptionId The ID of the target subscription. +The value must be an UUID. ```yaml Type: System.String[] diff --git a/src/DynatraceObservability/DynatraceObservability/help/Get-AzDynatraceMonitorMetricStatus.md b/src/DynatraceObservability/DynatraceObservability/help/Get-AzDynatraceMonitorMetricStatus.md index a92be8ebfda4..279433c9d2dc 100644 --- a/src/DynatraceObservability/DynatraceObservability/help/Get-AzDynatraceMonitorMetricStatus.md +++ b/src/DynatraceObservability/DynatraceObservability/help/Get-AzDynatraceMonitorMetricStatus.md @@ -12,17 +12,46 @@ Get metric status ## SYNTAX -### Get (Default) +### GetExpanded (Default) ``` Get-AzDynatraceMonitorMetricStatus -MonitorName -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [-WhatIf] + [-SubscriptionId ] [-MonitoredResourceId ] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### GetViaJsonString +``` +Get-AzDynatraceMonitorMetricStatus -MonitorName -ResourceGroupName + [-SubscriptionId ] -JsonString [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### GetViaJsonFilePath +``` +Get-AzDynatraceMonitorMetricStatus -MonitorName -ResourceGroupName + [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### Get +``` +Get-AzDynatraceMonitorMetricStatus -MonitorName -ResourceGroupName + [-SubscriptionId ] -Request [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### GetViaIdentityExpanded +``` +Get-AzDynatraceMonitorMetricStatus -InputObject + [-MonitoredResourceId ] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### GetViaIdentity ``` -Get-AzDynatraceMonitorMetricStatus -InputObject [-DefaultProfile ] - [-WhatIf] [-Confirm] [] +Get-AzDynatraceMonitorMetricStatus -InputObject + -Request [-DefaultProfile ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -65,7 +94,7 @@ Identity Parameter ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.IDynatraceObservabilityIdentity -Parameter Sets: GetViaIdentity +Parameter Sets: GetViaIdentityExpanded, GetViaIdentity Aliases: Required: True @@ -75,12 +104,57 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -JsonFilePath +Path of Json file supplied to the Get operation + +```yaml +Type: System.String +Parameter Sets: GetViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Get operation + +```yaml +Type: System.String +Parameter Sets: GetViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonitoredResourceId +List of azure resource Id of monitored resources for which we get the metric status + +```yaml +Type: System.String[] +Parameter Sets: GetExpanded, GetViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -MonitorName -Name of the Monitor resource +Name of the Monitors resource ```yaml Type: System.String -Parameter Sets: Get +Parameter Sets: GetExpanded, GetViaJsonString, GetViaJsonFilePath, Get Aliases: Required: True @@ -90,13 +164,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Request +Request for getting metric status for given monitored resource Ids + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.IMetricStatusRequest +Parameter Sets: Get, GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. ```yaml Type: System.String -Parameter Sets: Get +Parameter Sets: GetExpanded, GetViaJsonString, GetViaJsonFilePath, Get Aliases: Required: True @@ -108,10 +197,11 @@ Accept wildcard characters: False ### -SubscriptionId The ID of the target subscription. +The value must be an UUID. ```yaml Type: System.String[] -Parameter Sets: Get +Parameter Sets: GetExpanded, GetViaJsonString, GetViaJsonFilePath, Get Aliases: Required: False @@ -159,6 +249,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.IDynatraceObservabilityIdentity +### Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.IMetricStatusRequest + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.IMetricsStatusResponse diff --git a/src/DynatraceObservability/DynatraceObservability/help/Get-AzDynatraceMonitorSSOConfig.md b/src/DynatraceObservability/DynatraceObservability/help/Get-AzDynatraceMonitorSSOConfig.md index e35d33882cfe..c15f0a00f8f0 100644 --- a/src/DynatraceObservability/DynatraceObservability/help/Get-AzDynatraceMonitorSSOConfig.md +++ b/src/DynatraceObservability/DynatraceObservability/help/Get-AzDynatraceMonitorSSOConfig.md @@ -142,6 +142,7 @@ Accept wildcard characters: False ### -SubscriptionId The ID of the target subscription. +The value must be an UUID. ```yaml Type: System.String[] diff --git a/src/DynatraceObservability/DynatraceObservability/help/Get-AzDynatraceMonitorSSODetail.md b/src/DynatraceObservability/DynatraceObservability/help/Get-AzDynatraceMonitorSSODetail.md index 62c991442f66..ea430cdee9e6 100644 --- a/src/DynatraceObservability/DynatraceObservability/help/Get-AzDynatraceMonitorSSODetail.md +++ b/src/DynatraceObservability/DynatraceObservability/help/Get-AzDynatraceMonitorSSODetail.md @@ -132,6 +132,7 @@ Accept wildcard characters: False ### -SubscriptionId The ID of the target subscription. +The value must be an UUID. ```yaml Type: System.String[] diff --git a/src/DynatraceObservability/DynatraceObservability/help/Get-AzDynatraceMonitorTagRule.md b/src/DynatraceObservability/DynatraceObservability/help/Get-AzDynatraceMonitorTagRule.md index 9c07e726fc1d..7b697b6b4843 100644 --- a/src/DynatraceObservability/DynatraceObservability/help/Get-AzDynatraceMonitorTagRule.md +++ b/src/DynatraceObservability/DynatraceObservability/help/Get-AzDynatraceMonitorTagRule.md @@ -143,6 +143,7 @@ Accept wildcard characters: False ### -SubscriptionId The ID of the target subscription. +The value must be an UUID. ```yaml Type: System.String[] diff --git a/src/DynatraceObservability/DynatraceObservability/help/Get-AzDynatraceMonitorVMHostPayload.md b/src/DynatraceObservability/DynatraceObservability/help/Get-AzDynatraceMonitorVMHostPayload.md index 6a1f83c168e4..28d668a179ba 100644 --- a/src/DynatraceObservability/DynatraceObservability/help/Get-AzDynatraceMonitorVMHostPayload.md +++ b/src/DynatraceObservability/DynatraceObservability/help/Get-AzDynatraceMonitorVMHostPayload.md @@ -34,7 +34,7 @@ EnvironmentId IngestionKey ihx78752 dt0c01.C3A5JBXDZ4C3SCZDRBJ3D23I.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx ``` -This command gets the payload that needs to be passed in the request body for installing Dynatrace agent on a VM. +This coammnd gets the payload that needs to be passed in the request body for installing Dynatrace agent on a VM. ## PARAMETERS @@ -87,6 +87,7 @@ Accept wildcard characters: False ### -SubscriptionId The ID of the target subscription. +The value must be an UUID. ```yaml Type: System.String[] diff --git a/src/DynatraceObservability/DynatraceObservability/help/Get-AzDynatraceMonitoredResource.md b/src/DynatraceObservability/DynatraceObservability/help/Get-AzDynatraceMonitoredResource.md index b8be344ad721..d64c18b5fb8d 100644 --- a/src/DynatraceObservability/DynatraceObservability/help/Get-AzDynatraceMonitoredResource.md +++ b/src/DynatraceObservability/DynatraceObservability/help/Get-AzDynatraceMonitoredResource.md @@ -12,9 +12,32 @@ List the resources currently being monitored by the Dynatrace monitor resource. ## SYNTAX +### ListExpanded (Default) ``` Get-AzDynatraceMonitoredResource -MonitorName -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [] + [-MonitoredResourceId ] [-DefaultProfile ] [-WhatIf] + [-Confirm] [] +``` + +### List +``` +Get-AzDynatraceMonitoredResource -MonitorName -ResourceGroupName [-SubscriptionId ] + -Request [-DefaultProfile ] [-WhatIf] + [-Confirm] [] +``` + +### ListViaJsonFilePath +``` +Get-AzDynatraceMonitoredResource -MonitorName -ResourceGroupName [-SubscriptionId ] + -JsonFilePath [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +### ListViaJsonString +``` +Get-AzDynatraceMonitoredResource -MonitorName -ResourceGroupName [-SubscriptionId ] + -JsonString [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -47,6 +70,51 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -JsonFilePath +Path of Json file supplied to the List operation + +```yaml +Type: System.String +Parameter Sets: ListViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the List operation + +```yaml +Type: System.String +Parameter Sets: ListViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonitoredResourceId +List of azure resource Id of monitored resources for which we get the log status + +```yaml +Type: System.String[] +Parameter Sets: ListExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -MonitorName Monitor resource name @@ -62,6 +130,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Request +Request for getting log status for given monitored resource Ids + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.ILogStatusRequest +Parameter Sets: List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -80,6 +163,7 @@ Accept wildcard characters: False ### -SubscriptionId The ID of the target subscription. +The value must be an UUID. ```yaml Type: System.String[] @@ -93,11 +177,44 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS +### Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.ILogStatusRequest + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.IMonitoredResource diff --git a/src/DynatraceObservability/DynatraceObservability/help/Get-AzDynatraceMonitoredSubscription.md b/src/DynatraceObservability/DynatraceObservability/help/Get-AzDynatraceMonitoredSubscription.md new file mode 100644 index 000000000000..5ef37ba2c307 --- /dev/null +++ b/src/DynatraceObservability/DynatraceObservability/help/Get-AzDynatraceMonitoredSubscription.md @@ -0,0 +1,155 @@ +--- +external help file: Az.DynatraceObservability-help.xml +Module Name: Az.DynatraceObservability +online version: https://learn.microsoft.com/powershell/module/az.dynatraceobservability/get-azdynatracemonitoredsubscription +schema: 2.0.0 +--- + +# Get-AzDynatraceMonitoredSubscription + +## SYNOPSIS +List the subscriptions currently being monitored by the Dynatrace monitor resource. + +## SYNTAX + +### Get (Default) +``` +Get-AzDynatraceMonitoredSubscription -MonitorName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +### List +``` +Get-AzDynatraceMonitoredSubscription -MonitorName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +### GetViaIdentity +``` +Get-AzDynatraceMonitoredSubscription -InputObject + [-DefaultProfile ] [] +``` + +## DESCRIPTION +List the subscriptions currently being monitored by the Dynatrace monitor resource. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.IDynatraceObservabilityIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MonitorName +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.IDynatraceObservabilityIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.IMonitoredSubscriptionProperties + +## NOTES + +## RELATED LINKS diff --git a/src/DynatraceObservability/DynatraceObservability/help/Invoke-AzDynatraceManageMonitorAgentInstallation.md b/src/DynatraceObservability/DynatraceObservability/help/Invoke-AzDynatraceManageMonitorAgentInstallation.md new file mode 100644 index 000000000000..ecc1a5e8870e --- /dev/null +++ b/src/DynatraceObservability/DynatraceObservability/help/Invoke-AzDynatraceManageMonitorAgentInstallation.md @@ -0,0 +1,301 @@ +--- +external help file: Az.DynatraceObservability-help.xml +Module Name: Az.DynatraceObservability +online version: https://learn.microsoft.com/powershell/module/az.dynatraceobservability/invoke-azdynatracemanagemonitoragentinstallation +schema: 2.0.0 +--- + +# Invoke-AzDynatraceManageMonitorAgentInstallation + +## SYNOPSIS +Performs Dynatrace agent install/uninstall action through the Azure Dynatrace resource on the provided list of resources. + +## SYNTAX + +### ManageViaIdentity (Default) +``` +Invoke-AzDynatraceManageMonitorAgentInstallation -InputObject + -Request [-DefaultProfile ] [-PassThru] + [-WhatIf] [-Confirm] [] +``` + +### ManageViaJsonString +``` +Invoke-AzDynatraceManageMonitorAgentInstallation -MonitorName -ResourceGroupName + [-SubscriptionId ] -JsonString [-DefaultProfile ] [-PassThru] + [-WhatIf] [-Confirm] [] +``` + +### ManageViaJsonFilePath +``` +Invoke-AzDynatraceManageMonitorAgentInstallation -MonitorName -ResourceGroupName + [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] [-PassThru] + [-WhatIf] [-Confirm] [] +``` + +### ManageExpanded +``` +Invoke-AzDynatraceManageMonitorAgentInstallation -MonitorName -ResourceGroupName + [-SubscriptionId ] -Action -ManageAgentInstallationList + [-DefaultProfile ] [-PassThru] [-WhatIf] [-Confirm] + [] +``` + +### Manage +``` +Invoke-AzDynatraceManageMonitorAgentInstallation -MonitorName -ResourceGroupName + [-SubscriptionId ] -Request [-DefaultProfile ] [-PassThru] + [-WhatIf] [-Confirm] [] +``` + +### ManageViaIdentityExpanded +``` +Invoke-AzDynatraceManageMonitorAgentInstallation -InputObject + -Action -ManageAgentInstallationList [-DefaultProfile ] [-PassThru] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Performs Dynatrace agent install/uninstall action through the Azure Dynatrace resource on the provided list of resources. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -Action +Install/Uninstall action. + +```yaml +Type: System.String +Parameter Sets: ManageExpanded, ManageViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.IDynatraceObservabilityIdentity +Parameter Sets: ManageViaIdentity, ManageViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Manage operation + +```yaml +Type: System.String +Parameter Sets: ManageViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Manage operation + +```yaml +Type: System.String +Parameter Sets: ManageViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManageAgentInstallationList +The list of resources. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.IManageAgentList[] +Parameter Sets: ManageExpanded, ManageViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonitorName +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: ManageViaJsonString, ManageViaJsonFilePath, ManageExpanded, Manage +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Request +Request for performing Dynatrace agent install/uninstall action through the Azure Dynatrace resource on the provided list of agent resources. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.IManageAgentInstallationRequest +Parameter Sets: ManageViaIdentity, Manage +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: ManageViaJsonString, ManageViaJsonFilePath, ManageExpanded, Manage +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: ManageViaJsonString, ManageViaJsonFilePath, ManageExpanded, Manage +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.IDynatraceObservabilityIdentity + +### Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.IManageAgentInstallationRequest + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/src/DynatraceObservability/DynatraceObservability/help/New-AzDynatraceMonitor.md b/src/DynatraceObservability/DynatraceObservability/help/New-AzDynatraceMonitor.md index ea86e19eab75..3d758e05e79a 100644 --- a/src/DynatraceObservability/DynatraceObservability/help/New-AzDynatraceMonitor.md +++ b/src/DynatraceObservability/DynatraceObservability/help/New-AzDynatraceMonitor.md @@ -8,18 +8,18 @@ schema: 2.0.0 # New-AzDynatraceMonitor ## SYNOPSIS -create a MonitorResource +Create a MonitorResource ## SYNTAX ### CreateExpanded (Default) ``` New-AzDynatraceMonitor -Name -ResourceGroupName [-SubscriptionId ] -Location - [-AccountId ] [-AccountRegionId ] [-EnableSystemAssignedIdentity] [-EnvironmentId ] + [-AccountId ] [-AccountInfoCompanyName ] [-AccountRegionId ] [-EnvironmentId ] [-EnvironmentIngestionKey ] [-EnvironmentLandingUrl ] - [-EnvironmentLogsIngestionEndpoint ] [-EnvironmentUserId ] - [-MarketplaceSubscriptionStatus ] [-MonitoringStatus ] [-PlanBillingCycle ] - [-PlanDetail ] [-PlanEffectiveDate ] [-PlanUsageType ] + [-EnvironmentLogsIngestionEndpoint ] [-EnvironmentUserId ] [-IdentityType ] + [-MarketplaceSaasAutoRenew ] [-MarketplaceSubscriptionStatus ] [-MonitoringStatus ] + [-PlanBillingCycle ] [-PlanDetail ] [-PlanEffectiveDate ] [-PlanUsageType ] [-SingleSignOnAadDomain ] [-SingleSignOnEnterpriseAppId ] [-SingleSignOnState ] [-SingleSignOnUrl ] [-Tag ] [-UserAssignedIdentity ] [-UserCountry ] [-UserEmailAddress ] [-UserFirstName ] [-UserLastName ] [-UserPhoneNumber ] @@ -42,7 +42,7 @@ New-AzDynatraceMonitor -Name -ResourceGroupName [-Subscription ``` ## DESCRIPTION -create a MonitorResource +Create a MonitorResource ## EXAMPLES @@ -76,6 +76,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AccountInfoCompanyName +Name of the customer account / company + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -AccountRegionId Region in which the account is created @@ -122,11 +137,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableSystemAssignedIdentity -Determines whether to enable a system-assigned identity for the resource. +### -EnvironmentId +Id of the environment created ```yaml -Type: System.Management.Automation.SwitchParameter +Type: System.String Parameter Sets: CreateExpanded Aliases: @@ -137,8 +152,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnvironmentId -Id of the environment created +### -EnvironmentIngestionKey +Ingestion key of the environment ```yaml Type: System.String @@ -152,8 +167,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnvironmentIngestionKey -Ingestion key of the environment +### -EnvironmentLandingUrl +Landing URL for Dynatrace environment ```yaml Type: System.String @@ -167,8 +182,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnvironmentLandingUrl -Landing URL for Dynatrace environment +### -EnvironmentLogsIngestionEndpoint +Ingestion endpoint used for sending logs ```yaml Type: System.String @@ -182,8 +197,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnvironmentLogsIngestionEndpoint -Ingestion endpoint used for sending logs +### -EnvironmentUserId +User id ```yaml Type: System.String @@ -197,8 +212,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnvironmentUserId -User id +### -IdentityType +The type of managed identity assigned to this resource. ```yaml Type: System.String @@ -257,6 +272,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -MarketplaceSaasAutoRenew +Marketplace resource autorenew flag + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -MarketplaceSubscriptionStatus Marketplace subscription status. @@ -457,6 +487,7 @@ Accept wildcard characters: False ### -SubscriptionId The ID of the target subscription. +The value must be an UUID. ```yaml Type: System.String diff --git a/src/DynatraceObservability/DynatraceObservability/help/New-AzDynatraceMonitorSSOConfig.md b/src/DynatraceObservability/DynatraceObservability/help/New-AzDynatraceMonitorSSOConfig.md index a9a3fcf85ec6..fba65ae0b2eb 100644 --- a/src/DynatraceObservability/DynatraceObservability/help/New-AzDynatraceMonitorSSOConfig.md +++ b/src/DynatraceObservability/DynatraceObservability/help/New-AzDynatraceMonitorSSOConfig.md @@ -8,7 +8,7 @@ schema: 2.0.0 # New-AzDynatraceMonitorSSOConfig ## SYNOPSIS -create a DynatraceSingleSignOnResource +Create a DynatraceSingleSignOnResource ## SYNTAX @@ -43,7 +43,7 @@ New-AzDynatraceMonitorSSOConfig -MonitorInputObject -ResourceGroupName + [-SubscriptionId ] [-MonitoredSubscriptionList ] [-Operation ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [] +``` + +### CreateViaJsonFilePath +``` +New-AzDynatraceMonitoredSubscription -MonitorName -ResourceGroupName + [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### CreateViaJsonString +``` +New-AzDynatraceMonitoredSubscription -MonitorName -ResourceGroupName + [-SubscriptionId ] -JsonString [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Add the subscriptions that should be monitored by the Dynatrace monitor resource. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonitoredSubscriptionList +List of subscriptions and the state of the monitoring. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.IMonitoredSubscription[] +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonitorName +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Operation +The operation for the patch on the resource. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.IMonitoredSubscriptionProperties + +## NOTES + +## RELATED LINKS diff --git a/src/DynatraceObservability/DynatraceObservability/help/Remove-AzDynatraceMonitor.md b/src/DynatraceObservability/DynatraceObservability/help/Remove-AzDynatraceMonitor.md index 32671a2cb671..344ed5621a7e 100644 --- a/src/DynatraceObservability/DynatraceObservability/help/Remove-AzDynatraceMonitor.md +++ b/src/DynatraceObservability/DynatraceObservability/help/Remove-AzDynatraceMonitor.md @@ -155,6 +155,7 @@ Accept wildcard characters: False ### -SubscriptionId The ID of the target subscription. +The value must be an UUID. ```yaml Type: System.String diff --git a/src/DynatraceObservability/DynatraceObservability/help/Remove-AzDynatraceMonitorTagRule.md b/src/DynatraceObservability/DynatraceObservability/help/Remove-AzDynatraceMonitorTagRule.md index b168fb24f1d7..6897e2071ea7 100644 --- a/src/DynatraceObservability/DynatraceObservability/help/Remove-AzDynatraceMonitorTagRule.md +++ b/src/DynatraceObservability/DynatraceObservability/help/Remove-AzDynatraceMonitorTagRule.md @@ -177,6 +177,7 @@ Accept wildcard characters: False ### -SubscriptionId The ID of the target subscription. +The value must be an UUID. ```yaml Type: System.String diff --git a/src/DynatraceObservability/DynatraceObservability/help/Remove-AzDynatraceMonitoredSubscription.md b/src/DynatraceObservability/DynatraceObservability/help/Remove-AzDynatraceMonitoredSubscription.md new file mode 100644 index 000000000000..5d857f956274 --- /dev/null +++ b/src/DynatraceObservability/DynatraceObservability/help/Remove-AzDynatraceMonitoredSubscription.md @@ -0,0 +1,225 @@ +--- +external help file: Az.DynatraceObservability-help.xml +Module Name: Az.DynatraceObservability +online version: https://learn.microsoft.com/powershell/module/az.dynatraceobservability/remove-azdynatracemonitoredsubscription +schema: 2.0.0 +--- + +# Remove-AzDynatraceMonitoredSubscription + +## SYNOPSIS +Delete the subscriptions that are being monitored by the Dynatrace monitor resource + +## SYNTAX + +### Delete (Default) +``` +Remove-AzDynatraceMonitoredSubscription -MonitorName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-WhatIf] [-Confirm] [] +``` + +### DeleteViaIdentity +``` +Remove-AzDynatraceMonitoredSubscription -InputObject + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] + [-Confirm] [] +``` + +## DESCRIPTION +Delete the subscriptions that are being monitored by the Dynatrace monitor resource + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.IDynatraceObservabilityIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MonitorName +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.IDynatraceObservabilityIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/src/DynatraceObservability/DynatraceObservability/help/Update-AzDynatraceMonitor.md b/src/DynatraceObservability/DynatraceObservability/help/Update-AzDynatraceMonitor.md index c5cbe5b4ad45..e9b114424002 100644 --- a/src/DynatraceObservability/DynatraceObservability/help/Update-AzDynatraceMonitor.md +++ b/src/DynatraceObservability/DynatraceObservability/help/Update-AzDynatraceMonitor.md @@ -8,15 +8,16 @@ schema: 2.0.0 # Update-AzDynatraceMonitor ## SYNOPSIS -update a MonitorResource +Update a MonitorResource ## SYNTAX ### UpdateExpanded (Default) ``` Update-AzDynatraceMonitor -Name -ResourceGroupName [-SubscriptionId ] - [-Tag ] [-DefaultProfile ] [-WhatIf] [-Confirm] - [] + [-IdentityType ] [-PlanBillingCycle ] [-PlanDetail ] [-PlanEffectiveDate ] + [-PlanUsageType ] [-Tag ] [-UserAssignedIdentity ] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] ``` ### UpdateViaJsonString @@ -35,12 +36,14 @@ Update-AzDynatraceMonitor -Name -ResourceGroupName [-Subscript ### UpdateViaIdentityExpanded ``` -Update-AzDynatraceMonitor -InputObject [-Tag ] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] +Update-AzDynatraceMonitor -InputObject [-IdentityType ] + [-PlanBillingCycle ] [-PlanDetail ] [-PlanEffectiveDate ] [-PlanUsageType ] + [-Tag ] [-UserAssignedIdentity ] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -update a MonitorResource +Update a MonitorResource ## EXAMPLES @@ -88,6 +91,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -IdentityType +Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -InputObject Identity Parameter @@ -148,6 +166,68 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -PlanBillingCycle +different billing cycles like MONTHLY/WEEKLY. +this could be enum + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanDetail +plan id as published by Dynatrace + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanEffectiveDate +date when plan was applied + +```yaml +Type: System.DateTime +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanUsageType +different usage type like PAYG/COMMITTED. +this could be enum + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -166,6 +246,7 @@ Accept wildcard characters: False ### -SubscriptionId The ID of the target subscription. +The value must be an UUID. ```yaml Type: System.String @@ -194,6 +275,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -UserAssignedIdentity +The array of user assigned identities associated with the resource. +The elements in array will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.' + +```yaml +Type: System.String[] +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Confirm Prompts you for confirmation before running the cmdlet. diff --git a/src/DynatraceObservability/DynatraceObservability/help/Update-AzDynatraceMonitorPlan.md b/src/DynatraceObservability/DynatraceObservability/help/Update-AzDynatraceMonitorPlan.md new file mode 100644 index 000000000000..f9b60e106540 --- /dev/null +++ b/src/DynatraceObservability/DynatraceObservability/help/Update-AzDynatraceMonitorPlan.md @@ -0,0 +1,364 @@ +--- +external help file: Az.DynatraceObservability-help.xml +Module Name: Az.DynatraceObservability +online version: https://learn.microsoft.com/powershell/module/az.dynatraceobservability/update-azdynatracemonitorplan +schema: 2.0.0 +--- + +# Update-AzDynatraceMonitorPlan + +## SYNOPSIS +Upgrades the billing Plan for Dynatrace monitor resource. + +## SYNTAX + +### UpgradeExpanded (Default) +``` +Update-AzDynatraceMonitorPlan -MonitorName -ResourceGroupName [-SubscriptionId ] + [-PlanDataBillingCycle ] [-PlanDataEffectiveDate ] [-PlanDataPlanDetail ] + [-PlanDataUsageType ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-WhatIf] [-Confirm] [] +``` + +### UpgradeViaJsonString +``` +Update-AzDynatraceMonitorPlan -MonitorName -ResourceGroupName [-SubscriptionId ] + -JsonString [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-WhatIf] [-Confirm] [] +``` + +### UpgradeViaJsonFilePath +``` +Update-AzDynatraceMonitorPlan -MonitorName -ResourceGroupName [-SubscriptionId ] + -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-WhatIf] [-Confirm] [] +``` + +### Upgrade +``` +Update-AzDynatraceMonitorPlan -MonitorName -ResourceGroupName [-SubscriptionId ] + -Request [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-WhatIf] [-Confirm] [] +``` + +### UpgradeViaIdentityExpanded +``` +Update-AzDynatraceMonitorPlan -InputObject [-PlanDataBillingCycle ] + [-PlanDataEffectiveDate ] [-PlanDataPlanDetail ] [-PlanDataUsageType ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] + [-Confirm] [] +``` + +### UpgradeViaIdentity +``` +Update-AzDynatraceMonitorPlan -InputObject -Request + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] + [-Confirm] [] +``` + +## DESCRIPTION +Upgrades the billing Plan for Dynatrace monitor resource. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.IDynatraceObservabilityIdentity +Parameter Sets: UpgradeViaIdentityExpanded, UpgradeViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Upgrade operation + +```yaml +Type: System.String +Parameter Sets: UpgradeViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Upgrade operation + +```yaml +Type: System.String +Parameter Sets: UpgradeViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonitorName +Monitor resource name + +```yaml +Type: System.String +Parameter Sets: UpgradeExpanded, UpgradeViaJsonString, UpgradeViaJsonFilePath, Upgrade +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanDataBillingCycle +different billing cycles like MONTHLY/WEEKLY. +this could be enum + +```yaml +Type: System.String +Parameter Sets: UpgradeExpanded, UpgradeViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanDataEffectiveDate +date when plan was applied + +```yaml +Type: System.DateTime +Parameter Sets: UpgradeExpanded, UpgradeViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanDataPlanDetail +plan id as published by Dynatrace + +```yaml +Type: System.String +Parameter Sets: UpgradeExpanded, UpgradeViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PlanDataUsageType +different usage type like PAYG/COMMITTED. +this could be enum + +```yaml +Type: System.String +Parameter Sets: UpgradeExpanded, UpgradeViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Request +The billing plan properties for the upgrade plan call. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.IUpgradePlanRequest +Parameter Sets: Upgrade, UpgradeViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpgradeExpanded, UpgradeViaJsonString, UpgradeViaJsonFilePath, Upgrade +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: UpgradeExpanded, UpgradeViaJsonString, UpgradeViaJsonFilePath, Upgrade +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.IDynatraceObservabilityIdentity + +### Microsoft.Azure.PowerShell.Cmdlets.DynatraceObservability.Models.IUpgradePlanRequest + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/src/DynatraceObservability/DynatraceObservability/help/Update-AzDynatraceMonitorSSOConfig.md b/src/DynatraceObservability/DynatraceObservability/help/Update-AzDynatraceMonitorSSOConfig.md index c635dfb330e7..620c4c03cc77 100644 --- a/src/DynatraceObservability/DynatraceObservability/help/Update-AzDynatraceMonitorSSOConfig.md +++ b/src/DynatraceObservability/DynatraceObservability/help/Update-AzDynatraceMonitorSSOConfig.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Update-AzDynatraceMonitorSSOConfig ## SYNOPSIS -update a DynatraceSingleSignOnResource +Update a DynatraceSingleSignOnResource ## SYNTAX @@ -37,7 +37,7 @@ Update-AzDynatraceMonitorSSOConfig -MonitorInputObject