From 48321bfd55e73a5d247e8c167da9c2e7e552f2b0 Mon Sep 17 00:00:00 2001 From: Qi Pan <43341456+Pan-Qi@users.noreply.github.com> Date: Thu, 21 Aug 2025 17:12:56 +1000 Subject: [PATCH] Migrate Kusto to autorest v4 --- .../Kusto.Autorest/Properties/AssemblyInfo.cs | 26 + src/Kusto/Kusto.Autorest/README.md | 49 +- .../Microsoft.Kusto/Clusters-Databases.json | 43 -- .../Clusters-privateEndpointConnections.json | 95 ---- .../Clusters-privateLinkResources.json | 52 -- .../UX/Microsoft.Kusto/Clusters.json | 76 --- ...Invoke-AzKustoDataConnectionValidation.ps1 | 89 ++- .../custom/New-AzKustoDataConnection.ps1 | 522 +++++++++--------- .../custom/New-AzKustoDatabase.ps1 | 325 +++++------ .../custom/Update-AzKustoDataConnection.ps1 | 85 ++- .../custom/Update-AzKustoDatabase.ps1 | 73 ++- .../docs/Add-AzKustoClusterCalloutPolicy.md | 58 +- .../Add-AzKustoClusterLanguageExtension.md | 56 +- .../docs/Add-AzKustoDatabasePrincipal.md | 81 ++- src/Kusto/Kusto.Autorest/docs/Az.Kusto.md | 40 +- ...et-AzKustoAttachedDatabaseConfiguration.md | 26 +- .../Kusto.Autorest/docs/Get-AzKustoCluster.md | 3 +- .../docs/Get-AzKustoClusterCalloutPolicy.md | 2 +- .../Get-AzKustoClusterFollowerDatabase.md | 2 +- .../Get-AzKustoClusterFollowerDatabaseGet.md | 2 +- .../Get-AzKustoClusterLanguageExtension.md | 2 +- ...lusterOutboundNetworkDependencyEndpoint.md | 2 +- .../Get-AzKustoClusterPrincipalAssignment.md | 26 +- .../docs/Get-AzKustoClusterSku.md | 4 +- .../docs/Get-AzKustoDataConnection.md | 49 +- .../docs/Get-AzKustoDatabase.md | 26 +- .../docs/Get-AzKustoDatabasePrincipal.md | 2 +- .../Get-AzKustoDatabasePrincipalAssignment.md | 49 +- .../docs/Get-AzKustoManagedPrivateEndpoint.md | 26 +- .../docs/Get-AzKustoOperationsResult.md | 26 +- .../Get-AzKustoOperationsResultLocation.md | 24 +- .../Get-AzKustoPrivateEndpointConnection.md | 174 ------ .../docs/Get-AzKustoPrivateLinkResource.md | 172 ------ .../docs/Get-AzKustoSandboxCustomImage.md | 26 +- .../Kusto.Autorest/docs/Get-AzKustoScript.md | 49 +- .../Kusto.Autorest/docs/Get-AzKustoSku.md | 2 +- .../docs/Invoke-AzKustoClusterMigration.md | 56 +- .../Invoke-AzKustoDataConnectionValidation.md | 47 +- ...ke-AzKustoDetachClusterFollowerDatabase.md | 55 +- ...ke-AzKustoDiagnoseClusterVirtualNetwork.md | 3 +- .../Invoke-AzKustoInviteDatabaseFollower.md | 115 +++- ...ew-AzKustoAttachedDatabaseConfiguration.md | 122 +++- .../Kusto.Autorest/docs/New-AzKustoCluster.md | 205 ++++--- .../New-AzKustoClusterPrincipalAssignment.md | 93 +++- .../docs/New-AzKustoDataConnection.md | 102 +++- .../docs/New-AzKustoDatabase.md | 84 ++- .../New-AzKustoDatabasePrincipalAssignment.md | 121 +++- .../docs/New-AzKustoManagedPrivateEndpoint.md | 102 +++- .../New-AzKustoPrivateEndpointConnection.md | 248 --------- .../docs/New-AzKustoSandboxCustomImage.md | 100 +++- .../Kusto.Autorest/docs/New-AzKustoScript.md | 150 ++++- ...ve-AzKustoAttachedDatabaseConfiguration.md | 24 +- .../docs/Remove-AzKustoCluster.md | 1 - .../Remove-AzKustoClusterCalloutPolicy.md | 56 +- .../Remove-AzKustoClusterLanguageExtension.md | 56 +- ...emove-AzKustoClusterPrincipalAssignment.md | 25 +- .../docs/Remove-AzKustoDataConnection.md | 47 +- .../docs/Remove-AzKustoDatabase.md | 24 +- .../docs/Remove-AzKustoDatabasePrincipal.md | 81 ++- ...move-AzKustoDatabasePrincipalAssignment.md | 49 +- .../Remove-AzKustoManagedPrivateEndpoint.md | 24 +- ...Remove-AzKustoPrivateEndpointConnection.md | 225 -------- .../docs/Remove-AzKustoSandboxCustomImage.md | 24 +- .../docs/Remove-AzKustoScript.md | 47 +- .../docs/Start-AzKustoCluster.md | 1 - .../docs/Stop-AzKustoCluster.md | 1 - ...edDatabaseConfigurationNameAvailability.md | 55 +- .../Test-AzKustoClusterNameAvailability.md | 51 +- ...sterPrincipalAssignmentNameAvailability.md | 55 +- ...t-AzKustoDataConnectionNameAvailability.md | 78 ++- .../Test-AzKustoDatabaseNameAvailability.md | 61 +- ...basePrincipalAssignmentNameAvailability.md | 78 ++- ...oManagedPrivateEndpointNameAvailability.md | 55 +- ...KustoSandboxCustomImageNameAvailability.md | 55 +- .../Test-AzKustoScriptNameAvailability.md | 78 ++- .../docs/Update-AzKustoCluster.md | 171 ++---- .../docs/Update-AzKustoDataConnection.md | 124 +++-- .../docs/Update-AzKustoDatabase.md | 101 +++- .../Update-AzKustoManagedPrivateEndpoint.md | 105 +++- .../docs/Update-AzKustoSandboxCustomImage.md | 103 +++- .../docs/Update-AzKustoScript.md | 186 +++++-- .../Get-AzKustoPrivateEndpointConnection.md | 26 - .../Get-AzKustoPrivateLinkResource.md | 27 - .../New-AzKustoPrivateEndpointConnection.md | 14 - src/Kusto/Kusto.Autorest/examples/README.md | 11 + ...Remove-AzKustoPrivateEndpointConnection.md | 6 - src/Kusto/Kusto.Autorest/generate-info.json | 3 - src/Kusto/Kusto.Autorest/resources/README.md | 11 + .../Add-AzKustoClusterCalloutPolicy.Tests.ps1 | 4 +- .../Get-AzKustoClusterCalloutPolicy.Tests.ps1 | 4 +- ...AzKustoOperationsResultsLocation.Tests.ps1 | 21 + ...move-AzKustoClusterCalloutPolicy.Tests.ps1 | 4 +- src/Kusto/Kusto.sln | 89 ++- src/Kusto/Kusto/Az.Kusto.psd1 | 20 +- .../help/Add-AzKustoClusterCalloutPolicy.md | 58 +- .../Add-AzKustoClusterLanguageExtension.md | 56 +- .../help/Add-AzKustoDatabasePrincipal.md | 82 ++- src/Kusto/Kusto/help/Az.Kusto.md | 38 +- ...et-AzKustoAttachedDatabaseConfiguration.md | 26 +- src/Kusto/Kusto/help/Get-AzKustoCluster.md | 3 +- .../help/Get-AzKustoClusterCalloutPolicy.md | 2 +- .../Get-AzKustoClusterFollowerDatabase.md | 2 +- .../Get-AzKustoClusterFollowerDatabaseGet.md | 2 +- .../Get-AzKustoClusterLanguageExtension.md | 2 +- ...lusterOutboundNetworkDependencyEndpoint.md | 2 +- .../Get-AzKustoClusterPrincipalAssignment.md | 26 +- src/Kusto/Kusto/help/Get-AzKustoClusterSku.md | 4 +- .../Kusto/help/Get-AzKustoDataConnection.md | 49 +- src/Kusto/Kusto/help/Get-AzKustoDatabase.md | 26 +- .../help/Get-AzKustoDatabasePrincipal.md | 2 +- .../Get-AzKustoDatabasePrincipalAssignment.md | 50 +- .../help/Get-AzKustoManagedPrivateEndpoint.md | 26 +- .../Kusto/help/Get-AzKustoOperationsResult.md | 26 +- .../Get-AzKustoOperationsResultLocation.md | 24 +- .../Get-AzKustoPrivateEndpointConnection.md | 175 ------ .../help/Get-AzKustoPrivateLinkResource.md | 173 ------ .../help/Get-AzKustoSandboxCustomImage.md | 26 +- src/Kusto/Kusto/help/Get-AzKustoScript.md | 49 +- src/Kusto/Kusto/help/Get-AzKustoSku.md | 2 +- .../help/Invoke-AzKustoClusterMigration.md | 56 +- .../Invoke-AzKustoDataConnectionValidation.md | 63 +-- ...ke-AzKustoDetachClusterFollowerDatabase.md | 55 +- ...ke-AzKustoDiagnoseClusterVirtualNetwork.md | 3 +- .../Invoke-AzKustoInviteDatabaseFollower.md | 115 +++- ...ew-AzKustoAttachedDatabaseConfiguration.md | 125 ++++- src/Kusto/Kusto/help/New-AzKustoCluster.md | 203 ++++--- .../New-AzKustoClusterPrincipalAssignment.md | 95 +++- .../Kusto/help/New-AzKustoDataConnection.md | 126 +++-- src/Kusto/Kusto/help/New-AzKustoDatabase.md | 82 ++- .../New-AzKustoDatabasePrincipalAssignment.md | 126 ++++- .../help/New-AzKustoManagedPrivateEndpoint.md | 107 +++- .../New-AzKustoPrivateEndpointConnection.md | 247 --------- .../help/New-AzKustoSandboxCustomImage.md | 104 +++- src/Kusto/Kusto/help/New-AzKustoScript.md | 157 +++++- ...ve-AzKustoAttachedDatabaseConfiguration.md | 25 +- src/Kusto/Kusto/help/Remove-AzKustoCluster.md | 1 - .../Remove-AzKustoClusterCalloutPolicy.md | 56 +- .../Remove-AzKustoClusterLanguageExtension.md | 56 +- ...emove-AzKustoClusterPrincipalAssignment.md | 25 +- .../help/Remove-AzKustoDataConnection.md | 48 +- .../Kusto/help/Remove-AzKustoDatabase.md | 24 +- .../help/Remove-AzKustoDatabasePrincipal.md | 82 ++- ...move-AzKustoDatabasePrincipalAssignment.md | 49 +- .../Remove-AzKustoManagedPrivateEndpoint.md | 25 +- ...Remove-AzKustoPrivateEndpointConnection.md | 224 -------- .../help/Remove-AzKustoSandboxCustomImage.md | 25 +- src/Kusto/Kusto/help/Remove-AzKustoScript.md | 48 +- src/Kusto/Kusto/help/Start-AzKustoCluster.md | 1 - src/Kusto/Kusto/help/Stop-AzKustoCluster.md | 1 - ...edDatabaseConfigurationNameAvailability.md | 55 +- .../Test-AzKustoClusterNameAvailability.md | 51 +- ...sterPrincipalAssignmentNameAvailability.md | 55 +- ...t-AzKustoDataConnectionNameAvailability.md | 79 ++- .../Test-AzKustoDatabaseNameAvailability.md | 63 ++- ...basePrincipalAssignmentNameAvailability.md | 79 ++- ...oManagedPrivateEndpointNameAvailability.md | 55 +- ...KustoSandboxCustomImageNameAvailability.md | 55 +- .../Test-AzKustoScriptNameAvailability.md | 78 ++- src/Kusto/Kusto/help/Update-AzKustoCluster.md | 170 ++---- .../help/Update-AzKustoDataConnection.md | 164 ++++-- .../Kusto/help/Update-AzKustoDatabase.md | 91 ++- .../Update-AzKustoManagedPrivateEndpoint.md | 106 +++- .../help/Update-AzKustoSandboxCustomImage.md | 103 +++- src/Kusto/Kusto/help/Update-AzKustoScript.md | 189 +++++-- 164 files changed, 6875 insertions(+), 4051 deletions(-) create mode 100644 src/Kusto/Kusto.Autorest/Properties/AssemblyInfo.cs delete mode 100644 src/Kusto/Kusto.Autorest/UX/Microsoft.Kusto/Clusters-privateEndpointConnections.json delete mode 100644 src/Kusto/Kusto.Autorest/UX/Microsoft.Kusto/Clusters-privateLinkResources.json delete mode 100644 src/Kusto/Kusto.Autorest/docs/Get-AzKustoPrivateEndpointConnection.md delete mode 100644 src/Kusto/Kusto.Autorest/docs/Get-AzKustoPrivateLinkResource.md delete mode 100644 src/Kusto/Kusto.Autorest/docs/New-AzKustoPrivateEndpointConnection.md delete mode 100644 src/Kusto/Kusto.Autorest/docs/Remove-AzKustoPrivateEndpointConnection.md delete mode 100644 src/Kusto/Kusto.Autorest/examples/Get-AzKustoPrivateEndpointConnection.md delete mode 100644 src/Kusto/Kusto.Autorest/examples/Get-AzKustoPrivateLinkResource.md delete mode 100644 src/Kusto/Kusto.Autorest/examples/New-AzKustoPrivateEndpointConnection.md create mode 100644 src/Kusto/Kusto.Autorest/examples/README.md delete mode 100644 src/Kusto/Kusto.Autorest/examples/Remove-AzKustoPrivateEndpointConnection.md delete mode 100644 src/Kusto/Kusto.Autorest/generate-info.json create mode 100644 src/Kusto/Kusto.Autorest/resources/README.md create mode 100644 src/Kusto/Kusto.Autorest/test/Get-AzKustoOperationsResultsLocation.Tests.ps1 delete mode 100644 src/Kusto/Kusto/help/Get-AzKustoPrivateEndpointConnection.md delete mode 100644 src/Kusto/Kusto/help/Get-AzKustoPrivateLinkResource.md delete mode 100644 src/Kusto/Kusto/help/New-AzKustoPrivateEndpointConnection.md delete mode 100644 src/Kusto/Kusto/help/Remove-AzKustoPrivateEndpointConnection.md diff --git a/src/Kusto/Kusto.Autorest/Properties/AssemblyInfo.cs b/src/Kusto/Kusto.Autorest/Properties/AssemblyInfo.cs new file mode 100644 index 000000000000..1048eb154a27 --- /dev/null +++ b/src/Kusto/Kusto.Autorest/Properties/AssemblyInfo.cs @@ -0,0 +1,26 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the Apache License, Version 2.0 (the ""License""); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// http://www.apache.org/licenses/LICENSE-2.0 +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an ""AS IS"" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// Code generated by Microsoft (R) AutoRest Code Generator.Changes may cause incorrect behavior and will be lost if the code +// is regenerated. + +using System; +using System.Reflection; +using System.Runtime.CompilerServices; +using System.Runtime.InteropServices; + +[assembly: System.Reflection.AssemblyCompanyAttribute("Microsoft")] +[assembly: System.Reflection.AssemblyCopyrightAttribute("Copyright © Microsoft")] +[assembly: System.Reflection.AssemblyProductAttribute("Microsoft Azure PowerShell")] +[assembly: System.Reflection.AssemblyTitleAttribute("Microsoft Azure PowerShell - Kusto")] +[assembly: System.Reflection.AssemblyFileVersionAttribute("0.1.0.0")] +[assembly: System.Reflection.AssemblyVersionAttribute("0.1.0.0")] +[assembly: System.Runtime.InteropServices.ComVisibleAttribute(false)] +[assembly: System.CLSCompliantAttribute(false)] \ No newline at end of file diff --git a/src/Kusto/Kusto.Autorest/README.md b/src/Kusto/Kusto.Autorest/README.md index 794587c8b268..af75a2ba884c 100644 --- a/src/Kusto/Kusto.Autorest/README.md +++ b/src/Kusto/Kusto.Autorest/README.md @@ -67,14 +67,9 @@ subject-prefix: $(service-name) clear-output-folder: true output-folder: . ``` - + diff --git a/src/Kusto/Kusto.Autorest/UX/Microsoft.Kusto/Clusters-Databases.json b/src/Kusto/Kusto.Autorest/UX/Microsoft.Kusto/Clusters-Databases.json index 8472d95ab6e6..7e247b7228a9 100644 --- a/src/Kusto/Kusto.Autorest/UX/Microsoft.Kusto/Clusters-Databases.json +++ b/src/Kusto/Kusto.Autorest/UX/Microsoft.Kusto/Clusters-Databases.json @@ -48,49 +48,6 @@ } ] }, - { - "name": "Invoke-AzKustoInviteDatabaseFollower", - "description": "Generates an invitation token that allows attaching a follower database to this database.", - "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/Clusters/{clusterName}/Databases/{databaseName}/inviteFollower", - "help": { - "learnMore": { - "url": "https://learn.microsoft.com/powershell/module/az.kusto/invoke-azkustoinvitedatabasefollower" - }, - "parameterSets": [ - { - "parameters": [ - "-ClusterName ", - "-DatabaseName ", - "-ResourceGroupName ", - "[-SubscriptionId ]" - ] - } - ] - }, - "examples": [ - { - "description": "Generates an invitation token that allows attaching a follower database to this database.", - "parameters": [ - { - "name": "-ClusterName", - "value": "[Path.clusterName]" - }, - { - "name": "-DatabaseName", - "value": "[Path.databaseName]" - }, - { - "name": "-ResourceGroupName", - "value": "[Path.resourceGroupName]" - }, - { - "name": "-SubscriptionId", - "value": "[Path.subscriptionId]" - } - ] - } - ] - }, { "name": "Remove-AzKustoDatabase", "description": "Deletes the database with the given name.", diff --git a/src/Kusto/Kusto.Autorest/UX/Microsoft.Kusto/Clusters-privateEndpointConnections.json b/src/Kusto/Kusto.Autorest/UX/Microsoft.Kusto/Clusters-privateEndpointConnections.json deleted file mode 100644 index ef3e8c894b80..000000000000 --- a/src/Kusto/Kusto.Autorest/UX/Microsoft.Kusto/Clusters-privateEndpointConnections.json +++ /dev/null @@ -1,95 +0,0 @@ -{ - "resourceType": "Clusters/privateEndpointConnections", - "apiVersion": "2024-04-13", - "learnMore": { - "url": "https://learn.microsoft.com/powershell/module/az.kusto" - }, - "commands": [ - { - "name": "Get-AzKustoPrivateEndpointConnection", - "description": "Gets a private endpoint connection.", - "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/Clusters/{clusterName}/privateEndpointConnections/{privateEndpointConnectionName}", - "help": { - "learnMore": { - "url": "https://learn.microsoft.com/powershell/module/az.kusto/get-azkustoprivateendpointconnection" - }, - "parameterSets": [ - { - "parameters": [ - "-ClusterName ", - "-Name ", - "-ResourceGroupName ", - "[-SubscriptionId ]" - ] - } - ] - }, - "examples": [ - { - "description": "Gets a private endpoint connection.", - "parameters": [ - { - "name": "-ClusterName", - "value": "[Path.clusterName]" - }, - { - "name": "-Name", - "value": "[Path.privateEndpointConnectionName]" - }, - { - "name": "-ResourceGroupName", - "value": "[Path.resourceGroupName]" - }, - { - "name": "-SubscriptionId", - "value": "[Path.subscriptionId]" - } - ] - } - ] - }, - { - "name": "Remove-AzKustoPrivateEndpointConnection", - "description": "Deletes a private endpoint connection with a given name.", - "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/Clusters/{clusterName}/privateEndpointConnections/{privateEndpointConnectionName}", - "help": { - "learnMore": { - "url": "https://learn.microsoft.com/powershell/module/az.kusto/remove-azkustoprivateendpointconnection" - }, - "parameterSets": [ - { - "parameters": [ - "-ClusterName ", - "-Name ", - "-ResourceGroupName ", - "[-SubscriptionId ]" - ] - } - ] - }, - "examples": [ - { - "description": "Deletes a private endpoint connection with a given name.", - "parameters": [ - { - "name": "-ClusterName", - "value": "[Path.clusterName]" - }, - { - "name": "-Name", - "value": "[Path.privateEndpointConnectionName]" - }, - { - "name": "-ResourceGroupName", - "value": "[Path.resourceGroupName]" - }, - { - "name": "-SubscriptionId", - "value": "[Path.subscriptionId]" - } - ] - } - ] - } - ] -} diff --git a/src/Kusto/Kusto.Autorest/UX/Microsoft.Kusto/Clusters-privateLinkResources.json b/src/Kusto/Kusto.Autorest/UX/Microsoft.Kusto/Clusters-privateLinkResources.json deleted file mode 100644 index 5c8bdb336e86..000000000000 --- a/src/Kusto/Kusto.Autorest/UX/Microsoft.Kusto/Clusters-privateLinkResources.json +++ /dev/null @@ -1,52 +0,0 @@ -{ - "resourceType": "Clusters/privateLinkResources", - "apiVersion": "2024-04-13", - "learnMore": { - "url": "https://learn.microsoft.com/powershell/module/az.kusto" - }, - "commands": [ - { - "name": "Get-AzKustoPrivateLinkResource", - "description": "Gets a private link resource.", - "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/Clusters/{clusterName}/privateLinkResources/{privateLinkResourceName}", - "help": { - "learnMore": { - "url": "https://learn.microsoft.com/powershell/module/az.kusto/get-azkustoprivatelinkresource" - }, - "parameterSets": [ - { - "parameters": [ - "-ClusterName ", - "-Name ", - "-ResourceGroupName ", - "[-SubscriptionId ]" - ] - } - ] - }, - "examples": [ - { - "description": "Gets a private link resource.", - "parameters": [ - { - "name": "-ClusterName", - "value": "[Path.clusterName]" - }, - { - "name": "-Name", - "value": "[Path.privateLinkResourceName]" - }, - { - "name": "-ResourceGroupName", - "value": "[Path.resourceGroupName]" - }, - { - "name": "-SubscriptionId", - "value": "[Path.subscriptionId]" - } - ] - } - ] - } - ] -} diff --git a/src/Kusto/Kusto.Autorest/UX/Microsoft.Kusto/Clusters.json b/src/Kusto/Kusto.Autorest/UX/Microsoft.Kusto/Clusters.json index ae17edd5f6d6..51d7dc7e98f0 100644 --- a/src/Kusto/Kusto.Autorest/UX/Microsoft.Kusto/Clusters.json +++ b/src/Kusto/Kusto.Autorest/UX/Microsoft.Kusto/Clusters.json @@ -43,44 +43,6 @@ } ] }, - { - "name": "Invoke-AzKustoClusterMigration", - "description": "Migrate data from a Kusto cluster to another cluster.", - "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/Clusters/{clusterName}/migrate", - "help": { - "learnMore": { - "url": "https://learn.microsoft.com/powershell/module/az.kusto/invoke-azkustoclustermigration" - }, - "parameterSets": [ - { - "parameters": [ - "-Name ", - "-ResourceGroupName ", - "[-SubscriptionId ]" - ] - } - ] - }, - "examples": [ - { - "description": "Migrate data from a Kusto cluster to another cluster.", - "parameters": [ - { - "name": "-Name", - "value": "[Path.clusterName]" - }, - { - "name": "-ResourceGroupName", - "value": "[Path.resourceGroupName]" - }, - { - "name": "-SubscriptionId", - "value": "[Path.subscriptionId]" - } - ] - } - ] - }, { "name": "Invoke-AzKustoDiagnoseClusterVirtualNetwork", "description": "Diagnoses network connectivity status for external resources on which the service is dependent on.", @@ -119,44 +81,6 @@ } ] }, - { - "name": "Remove-AzKustoClusterCalloutPolicy", - "description": "Removes callout policy for engine services.", - "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/Clusters/{clusterName}/removeCalloutPolicy", - "help": { - "learnMore": { - "url": "https://learn.microsoft.com/powershell/module/az.kusto/remove-azkustoclustercalloutpolicy" - }, - "parameterSets": [ - { - "parameters": [ - "-ClusterName ", - "-ResourceGroupName ", - "[-SubscriptionId ]" - ] - } - ] - }, - "examples": [ - { - "description": "Removes callout policy for engine services.", - "parameters": [ - { - "name": "-ClusterName", - "value": "[Path.clusterName]" - }, - { - "name": "-ResourceGroupName", - "value": "[Path.resourceGroupName]" - }, - { - "name": "-SubscriptionId", - "value": "[Path.subscriptionId]" - } - ] - } - ] - }, { "name": "Remove-AzKustoCluster", "description": "Deletes a Kusto cluster.", diff --git a/src/Kusto/Kusto.Autorest/custom/Invoke-AzKustoDataConnectionValidation.ps1 b/src/Kusto/Kusto.Autorest/custom/Invoke-AzKustoDataConnectionValidation.ps1 index 6a85a51cd17e..26c65ac8e7a8 100644 --- a/src/Kusto/Kusto.Autorest/custom/Invoke-AzKustoDataConnectionValidation.ps1 +++ b/src/Kusto/Kusto.Autorest/custom/Invoke-AzKustoDataConnectionValidation.ps1 @@ -1,7 +1,6 @@ # ---------------------------------------------------------------------------------- -# -# Copyright Microsoft Corporation +# Copyright (c) Microsoft Corporation. All rights reserved. # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at @@ -11,6 +10,8 @@ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. +# Code generated by Microsoft (R) AutoRest Code Generator.Changes may cause incorrect behavior and will be lost if the code +# is regenerated. # ---------------------------------------------------------------------------------- <# @@ -19,19 +20,64 @@ Checks that the data connection parameters are valid. .Description Checks that the data connection parameters are valid. .Example - $dataConnectionProperties = New-Object -Type Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.EventHubDataConnection -Property @{Location=$location; Kind=$kind; EventHubResourceId=$eventHubResourceId; DataFormat=$dataFormat; ConsumerGroup='Default'; Compression= "None"; TableName = $tableName; MappingRuleName = $tableMappingName} - $dataConnectionValidation = New-Object -Type Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.DataConnectionValidation -Property @{DataConnectionName=$dataConnectionName; Property=$dataConnectionProperties} -Invoke-AzKustoDataConnectionValidation -ResourceGroupName $resourceGroupName -ClusterName $clusterName -DatabaseName $databaseName -Parameter $dataConnectionValidation - -ErrorMessage ------------- -event hub resource id and consumer group tuple provided are already used - +{{ Add code here }} +.Example +{{ Add code here }} + +.Inputs +Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IDataConnectionValidation +.Inputs +Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +.Outputs +Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IDataConnectionValidationListResult +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +CLUSTERINPUTOBJECT : Identity Parameter + [AttachedDatabaseConfigurationName ]: The name of the attached database configuration. + [ClusterName ]: The name of the Kusto cluster. + [DataConnectionName ]: The name of the data connection. + [DatabaseName ]: The name of the database in the Kusto cluster. + [Id ]: Resource identity path + [Location ]: The name of Azure region. + [ManagedPrivateEndpointName ]: The name of the managed private endpoint. + [OperationId ]: The ID of an ongoing async operation. + [PrincipalAssignmentName ]: The name of the Kusto principalAssignment. + [PrivateEndpointConnectionName ]: The name of the private endpoint connection. + [PrivateLinkResourceName ]: The name of the private link resource. + [ResourceGroupName ]: The name of the resource group. The name is case insensitive. + [SandboxCustomImageName ]: The name of the sandbox custom image. + [ScriptName ]: The name of the Kusto database script. + [SubscriptionId ]: The ID of the target subscription. + +INPUTOBJECT : Identity Parameter + [AttachedDatabaseConfigurationName ]: The name of the attached database configuration. + [ClusterName ]: The name of the Kusto cluster. + [DataConnectionName ]: The name of the data connection. + [DatabaseName ]: The name of the database in the Kusto cluster. + [Id ]: Resource identity path + [Location ]: The name of Azure region. + [ManagedPrivateEndpointName ]: The name of the managed private endpoint. + [OperationId ]: The ID of an ongoing async operation. + [PrincipalAssignmentName ]: The name of the Kusto principalAssignment. + [PrivateEndpointConnectionName ]: The name of the private endpoint connection. + [PrivateLinkResourceName ]: The name of the private link resource. + [ResourceGroupName ]: The name of the resource group. The name is case insensitive. + [SandboxCustomImageName ]: The name of the sandbox custom image. + [ScriptName ]: The name of the Kusto database script. + [SubscriptionId ]: The ID of the target subscription. + +PARAMETER : Class representing an data connection validation. + [DataConnectionName ]: The name of the data connection. + [Kind ]: Kind of the endpoint for the data connection + [Location ]: Resource location. .Link https://learn.microsoft.com/powershell/module/az.kusto/invoke-azkustodataconnectionvalidation #> function Invoke-AzKustoDataConnectionValidation { - [OutputType([Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IDataConnectionValidationResult])] + [OutputType([Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IDataConnectionValidationResult])] [CmdletBinding(DefaultParameterSetName = 'DataExpandedEventHub', PositionalBinding = $false, SupportsShouldProcess, ConfirmImpact = 'Medium')] param( [Parameter(ParameterSetName = 'DataExpandedEventHub', Mandatory)] @@ -78,9 +124,9 @@ function Invoke-AzKustoDataConnectionValidation { ${InputObject}, [Parameter(Mandatory)] - [ArgumentCompleter( { param ( $CommandName, $ParameterName, $WordToComplete, $CommandAst, $FakeBoundParameters ) return @('EventHub', 'EventGrid', 'IotHub') })] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.PSArgumentCompleterAttribute("EventHub", "EventGrid", "IotHub", "CosmosDb")] [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Body')] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.Kind] + [System.String] # Kind of the endpoint for the data connection ${Kind}, @@ -107,8 +153,9 @@ function Invoke-AzKustoDataConnectionValidation { [Parameter(ParameterSetName = 'UpdateExpandedEventGrid')] [Parameter(ParameterSetName = 'UpdateViaIdentityExpandedEventGrid')] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.PSArgumentCompleterAttribute("Microsoft.Storage.BlobCreated", "Microsoft.Storage.BlobRenamed")] [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Body')] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.BlobStorageEventType] + [System.String] # The name of blob storage event type to process. ${BlobStorageEventType}, @@ -149,8 +196,9 @@ function Invoke-AzKustoDataConnectionValidation { [Parameter(ParameterSetName = 'DataExpandedEventHub')] [Parameter(ParameterSetName = 'DataViaIdentityExpandedEventHub')] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.PSArgumentCompleterAttribute("None", "GZip")] [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Body')] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.Compression] + [System.String] # The event hub messages compression type. ${Compression}, @@ -190,8 +238,9 @@ function Invoke-AzKustoDataConnectionValidation { [Parameter(ParameterSetName = 'DataViaIdentityExpandedEventGrid')] [Parameter(ParameterSetName = 'DataExpandedIotHub')] [Parameter(ParameterSetName = 'DataViaIdentityExpandedIotHub')] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.PSArgumentCompleterAttribute("Single", "Multi")] [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Body')] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.DatabaseRouting] + [System.String] # Indication for database routing information from the data connection, by default only database routing information is allowed. ${DatabaseRouting}, @@ -267,13 +316,13 @@ function Invoke-AzKustoDataConnectionValidation { process { try { - $Parameter = [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.DataConnectionValidation]::new() + $Parameter = [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.DataConnectionValidation]::new() $Parameter.DataConnectionName = $PSBoundParameters['DataConnectionName'] $null = $PSBoundParameters.Remove('DataConnectionName') if ($PSBoundParameters['Kind'] -eq 'EventHub') { - $Parameter.Property = [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.EventHubDataConnection]::new() + $Parameter.Property = [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.EventHubDataConnection]::new() $Parameter.Property.EventHubResourceId = $PSBoundParameters['EventHubResourceId'] $null = $PSBoundParameters.Remove('EventHubResourceId') @@ -304,7 +353,7 @@ function Invoke-AzKustoDataConnectionValidation { } } elseif ($PSBoundParameters['Kind'] -eq 'EventGrid') { - $Parameter.Property = [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.EventGridDataConnection]::new() + $Parameter.Property = [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.EventGridDataConnection]::new() $Parameter.Property.EventHubResourceId = $PSBoundParameters['EventHubResourceId'] $null = $PSBoundParameters.Remove('EventHubResourceId') @@ -338,7 +387,7 @@ function Invoke-AzKustoDataConnectionValidation { } } else { - $Parameter.Property = [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IotHubDataConnection]::new() + $Parameter.Property = [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IotHubDataConnection]::new() $Parameter.Property.IotHubResourceId = $PSBoundParameters['IotHubResourceId'] $null = $PSBoundParameters.Remove('IotHubResourceId') diff --git a/src/Kusto/Kusto.Autorest/custom/New-AzKustoDataConnection.ps1 b/src/Kusto/Kusto.Autorest/custom/New-AzKustoDataConnection.ps1 index 9727df2cf6af..d26a69843993 100644 --- a/src/Kusto/Kusto.Autorest/custom/New-AzKustoDataConnection.ps1 +++ b/src/Kusto/Kusto.Autorest/custom/New-AzKustoDataConnection.ps1 @@ -1,7 +1,6 @@ # ---------------------------------------------------------------------------------- -# -# Copyright Microsoft Corporation +# Copyright (c) Microsoft Corporation. All rights reserved. # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at @@ -11,268 +10,287 @@ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. +# Code generated by Microsoft (R) AutoRest Code Generator.Changes may cause incorrect behavior and will be lost if the code +# is regenerated. # ---------------------------------------------------------------------------------- <# .Synopsis -Creates or updates a data connection. +Create a data connection. .Description -Creates or updates a data connection. +Create a data connection. .Example -$dataConnectionProperties = New-Object -Type Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.EventHubDataConnection -Property @{Location="East US"; Kind="EventHub"; EventHubResourceId="/subscriptions/$subscriptionId/resourcegroups/testrg/providers/Microsoft.EventHub/namespaces/myeventhubns/eventhubs/myeventhub"; DataFormat="JSON"; ConsumerGroup='Default'; Compression= "None"; TableName = "Events"; MappingRuleName = "EventsMapping"} -New-AzKustoDataConnection -ResourceGroupName "testrg" -ClusterName "testnewkustocluster" -DatabaseName "mykustodatabase" -DataConnectionName "mykustodataconnection" -Parameter $dataConnectionProperties +New-AzKustoDataConnection -ResourceGroupName "testrg" -ClusterName "testnewkustocluster" -DatabaseName "mykustodatabase" -DataConnectionName "myeventhubdc" -Location "East US" -Kind "EventHub" -EventHubResourceId "/subscriptions/$subscriptionId/resourcegroups/testrg/providers/Microsoft.EventHub/namespaces/myeventhubns/eventhubs/myeventhub" -DataFormat "MULTIJSON" -ConsumerGroup '$Default' -Compression "None" -TableName "Events" -MappingRuleName "EventsMapping" +.Example +New-AzKustoDataConnection -ResourceGroupName "testrg" -ClusterName "testnewkustocluster" -DatabaseName "mykustodatabase" -DataConnectionName "myeventgriddc" -Location "East US" -Kind "EventGrid" -EventHubResourceId "/subscriptions/$subscriptionId/resourcegroups/testrg/providers/Microsoft.EventHub/namespaces/myeventhubns/eventhubs/myeventhub" -StorageAccountResourceId "/subscriptions/$subscriptionId/resourcegroups/testrg/providers/Microsoft.Storage/storageAccounts/mystorage" -DataFormat "MULTIJSON" -ConsumerGroup '$Default' -TableName "Events" -MappingRuleName "EventsMapping" +.Example +New-AzKustoDataConnection -ResourceGroupName "testrg" -ClusterName "testnewkustocluster" -DatabaseName "mykustodatabase" -DataConnectionName "myiothubdc" -Location "East US" -Kind "IotHub" -IotHubResourceId "/subscriptions/$subscriptionId/resourcegroups/testrg/providers/Microsoft.Devices/IotHubs/myiothub" -SharedAccessPolicyName "myiothubpolicy" -DataFormat "MULTIJSON" -ConsumerGroup '$Default' -TableName "Events" -MappingRuleName "EventsMapping" -Kind Location Name Type ----- -------- ---- ---- -EventHub East US testnewkustocluster/mykustodatabase/mykustodataconnection Microsoft.Kusto/Clusters/Databases/DataConnections +.Inputs +Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IDataConnection +.Outputs +Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IDataConnection +.Notes +COMPLEX PARAMETER PROPERTIES +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +PARAMETER : Class representing an data connection. + Kind : Kind of the endpoint for the data connection + [Location ]: Resource location. .Link https://learn.microsoft.com/powershell/module/az.kusto/new-azkustodataconnection #> function New-AzKustoDataConnection { - [OutputType([Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IDataConnection])] - [CmdletBinding(DefaultParameterSetName = 'CreateExpandedEventHub', PositionalBinding = $false, SupportsShouldProcess, ConfirmImpact = 'Medium')] - param( - [Parameter(Mandatory)] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Path')] - [System.String] - # The name of the Kusto cluster. - ${ClusterName}, - - [Parameter(Mandatory)] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Path')] - [System.String] - # The name of the database in the Kusto cluster. - ${DatabaseName}, - - [Parameter(Mandatory)] - [Alias('DataConnectionName')] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Path')] - [System.String] - # The name of the data connection. - ${Name}, - - [Parameter(Mandatory)] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Path')] - [System.String] - # The name of the resource group containing the Kusto cluster. - ${ResourceGroupName}, - - [Parameter()] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Path')] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Runtime.DefaultInfo(Script = '(Get-AzContext).Subscription.Id')] - [System.String] - # Gets subscription credentials which uniquely identify Microsoft Azure subscription. - # The subscription ID forms part of the URI for every service call. - ${SubscriptionId}, - - [Parameter(Mandatory)] - [ArgumentCompleter( { param ( $CommandName, $ParameterName, $WordToComplete, $CommandAst, $FakeBoundParameters ) return @('EventHub', 'EventGrid', 'IotHub', 'CosmosDb') })] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Body')] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.Kind] - # Kind of the endpoint for the data connection - ${Kind}, - - [Parameter(ParameterSetName = 'CreateExpandedEventHub', Mandatory)] - [Parameter(ParameterSetName = 'CreateExpandedEventGrid', Mandatory)] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Body')] - [System.String] - # The resource ID of the event hub to be used to create a data connection / event grid is configured to send events. - ${EventHubResourceId}, - - [Parameter(ParameterSetName = 'CreateExpandedEventHub', Mandatory)] - [Parameter(ParameterSetName = 'CreateExpandedEventGrid', Mandatory)] - [Parameter(ParameterSetName = 'CreateExpandedIotHub', Mandatory)] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Body')] - [System.String] - # The event/iot hub consumer group. - ${ConsumerGroup}, - - [Parameter(ParameterSetName = 'CreateExpandedEventGrid')] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Body')] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.BlobStorageEventType] - # The name of blob storage event type to process. - ${BlobStorageEventType}, - - [Parameter(ParameterSetName = 'CreateExpandedEventGrid')] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Body')] - [System.Management.Automation.SwitchParameter] - # If set to true, indicates that ingestion should ignore the first record of every file. - ${IgnoreFirstRecord}, - - [Parameter(ParameterSetName = 'CreateExpandedEventHub')] - [Parameter(ParameterSetName = 'CreateExpandedEventGrid')] - [Parameter(ParameterSetName = 'CreateExpandedIotHub')] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Body')] - [System.String] - [ValidateSet( "MULTIJSON", "JSON", "CSV", "TSV", "SCSV", "SOHSV", "PSV", "TXT", "RAW", "SINGLEJSON", "AVRO", "TSVE", "PARQUET", "ORC", "APACHEAVRO", "W3CLOGFILE")] - # The data format of the message. Optionally the data format can be added to each message. - ${DataFormat}, - - [Parameter(ParameterSetName = 'CreateExpandedEventHub')] - [Parameter(ParameterSetName = 'CreateExpandedIotHub')] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Body')] - [System.String[]] - # System properties of the event/iot hub. - ${EventSystemProperty}, - - [Parameter()] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Body')] - [System.String] - # The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message. - ${MappingRuleName}, - - [Parameter(ParameterSetName = 'CreateExpandedEventHub')] - [Parameter(ParameterSetName = 'CreateExpandedEventGrid')] - [Parameter(ParameterSetName = 'CreateExpandedIotHub')] - [Parameter(ParameterSetName = 'CreateExpandedCosmosDb', Mandatory)] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Body')] - [System.String] - # The table where the data should be ingested. Optionally the table information can be added to each message. - ${TableName}, - - [Parameter(ParameterSetName = 'CreateExpandedEventHub')] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Body')] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.Compression] - # The event hub messages compression type. - ${Compression}, - - [Parameter(ParameterSetName = 'CreateExpandedEventGrid', Mandatory)] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Body')] - [System.String] - # The resource ID of the storage account where the data resides. - ${StorageAccountResourceId}, - - [Parameter(ParameterSetName = 'CreateExpandedIotHub', Mandatory)] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Body')] - [System.String] - # The resource ID of the Iot hub to be used to create a data connection. - ${IotHubResourceId}, - - [Parameter(ParameterSetName = 'CreateExpandedIotHub', Mandatory)] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Body')] - [System.String] - # The name of the share access policy. - ${SharedAccessPolicyName}, - - [Parameter(ParameterSetName = 'CreateExpandedEventHub')] - [Parameter(ParameterSetName = 'CreateExpandedEventGrid')] - [Parameter(ParameterSetName = 'CreateExpandedCosmosDb', Mandatory)] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Body')] - [System.String] - # The resource ID of a managed identity (system or user assigned) to be used to authenticate with external resources. - ${ManagedIdentityResourceId}, - - [Parameter(ParameterSetName = 'CreateExpandedEventHub')] - [Parameter(ParameterSetName = 'CreateExpandedEventGrid')] - [Parameter(ParameterSetName = 'CreateExpandedIotHub')] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Body')] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.DatabaseRouting] - # Indication for database routing information from the data connection, by default only database routing information is allowed. - ${DatabaseRouting}, - - [Parameter(ParameterSetName = 'CreateExpandedEventHub')] - [Parameter(ParameterSetName = 'CreateExpandedIotHub')] - [Parameter(ParameterSetName = 'CreateExpandedCosmosDb')] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Body')] - [System.DateTime] - # When defined, the data connection retrieves existing Event hub events created since the Retrieval start date. It can only retrieve events retained by the Event hub, based on its retention period. - ${RetrievalStartDate}, - - [Parameter(ParameterSetName = 'CreateExpandedEventGrid')] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Body')] - [System.String] - # The resource ID of the event grid that is subscribed to the storage account events. - ${EventGridResourceId}, - - [Parameter(ParameterSetName = 'CreateExpandedCosmosDb', Mandatory)] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Body')] - [System.String] - # The resource ID of the Cosmos DB account used to create the data connection. - ${CosmosDbAccountResourceId}, - - [Parameter(ParameterSetName = 'CreateExpandedCosmosDb', Mandatory)] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Body')] - [System.String] - # The name of an existing database in the Cosmos DB account. - ${CosmosDbDatabase}, - - [Parameter(ParameterSetName = 'CreateExpandedCosmosDb', Mandatory)] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Body')] - [System.String] - # The name of an existing container in the Cosmos DB database. - ${CosmosDbContainer}, - - [Parameter(Mandatory)] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Body')] - [System.String] - # Resource location. - ${Location}, - - [Parameter()] - [Alias('AzureRMContext', 'AzureCredential')] - [ValidateNotNull()] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Azure')] - [System.Management.Automation.PSObject] - # The credentials, account, tenant, and subscription used for communication with Azure. - ${DefaultProfile}, - - [Parameter()] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Runtime')] - [System.Management.Automation.SwitchParameter] - # Run the command as a job - ${AsJob}, - - [Parameter(DontShow)] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Runtime')] - [System.Management.Automation.SwitchParameter] - # Wait for .NET debugger to attach - ${Break}, - - [Parameter(DontShow)] - [ValidateNotNull()] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Runtime')] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Runtime.SendAsyncStep[]] - # SendAsync Pipeline Steps to be appended to the front of the pipeline - ${HttpPipelineAppend}, - - [Parameter(DontShow)] - [ValidateNotNull()] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Runtime')] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Runtime.SendAsyncStep[]] - # SendAsync Pipeline Steps to be prepended to the front of the pipeline - ${HttpPipelinePrepend}, - - [Parameter()] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Runtime')] - [System.Management.Automation.SwitchParameter] - # Run the command asynchronously - ${NoWait}, - - [Parameter(DontShow)] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Runtime')] - [System.Uri] - # The URI for the proxy server to use - ${Proxy}, - - [Parameter(DontShow)] - [ValidateNotNull()] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Runtime')] - [System.Management.Automation.PSCredential] - # Credentials for a proxy server to use for the remote call - ${ProxyCredential}, - - [Parameter(DontShow)] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Runtime')] - [System.Management.Automation.SwitchParameter] - # Use the default credentials for the proxy - ${ProxyUseDefaultCredentials} - ) - +[OutputType([Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IDataConnection])] +[CmdletBinding(DefaultParameterSetName='CreateExpandedEventHub', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] +param( + [Parameter(Mandatory)] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Path')] + [System.String] + # The name of the Kusto cluster. + ${ClusterName}, + + [Parameter(Mandatory)] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Path')] + [System.String] + # The name of the database in the Kusto cluster. + ${DatabaseName}, + + [Parameter(Mandatory)] + [Alias('DataConnectionName')] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Path')] + [System.String] + # The name of the data connection. + ${Name}, + + [Parameter(Mandatory)] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Path')] + [System.String] + # The name of the resource group. + # The name is case insensitive. + ${ResourceGroupName}, + + [Parameter()] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Path')] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Runtime.DefaultInfo(Script='(Get-AzContext).Subscription.Id')] + [System.String] + # The ID of the target subscription. + ${SubscriptionId}, + + [Parameter(ParameterSetName = 'CreateExpandedEventHub', Mandatory)] + [Parameter(ParameterSetName = 'CreateExpandedEventGrid', Mandatory)] + [Parameter(ParameterSetName = 'CreateExpandedIotHub', Mandatory)] + [Parameter(ParameterSetName = 'CreateExpandedCosmosDb', Mandatory)] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.PSArgumentCompleterAttribute("EventHub", "EventGrid", "IotHub", "CosmosDb")] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Body')] + [System.String] + # Kind of the endpoint for the data connection + ${Kind}, + + [Parameter(ParameterSetName = 'CreateExpandedEventHub', Mandatory)] + [Parameter(ParameterSetName = 'CreateExpandedEventGrid', Mandatory)] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Body')] + [System.String] + # The resource ID of the event hub to be used to create a data connection / event grid is configured to send events. + ${EventHubResourceId}, + + [Parameter(ParameterSetName = 'CreateExpandedEventHub', Mandatory)] + [Parameter(ParameterSetName = 'CreateExpandedEventGrid', Mandatory)] + [Parameter(ParameterSetName = 'CreateExpandedIotHub', Mandatory)] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Body')] + [System.String] + # The event/iot hub consumer group. + ${ConsumerGroup}, + + [Parameter(ParameterSetName = 'CreateExpandedEventGrid')] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.PSArgumentCompleterAttribute("Microsoft.Storage.BlobCreated", "Microsoft.Storage.BlobRenamed")] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Body')] + [System.String] + # The name of blob storage event type to process. + ${BlobStorageEventType}, + + [Parameter(ParameterSetName = 'CreateExpandedEventGrid')] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Body')] + [System.Management.Automation.SwitchParameter] + # If set to true, indicates that ingestion should ignore the first record of every file. + ${IgnoreFirstRecord}, + + [Parameter(ParameterSetName = 'CreateExpandedEventHub')] + [Parameter(ParameterSetName = 'CreateExpandedEventGrid')] + [Parameter(ParameterSetName = 'CreateExpandedIotHub')] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Body')] + [System.String] + [ValidateSet( "MULTIJSON", "JSON", "CSV", "TSV", "SCSV", "SOHSV", "PSV", "TXT", "RAW", "SINGLEJSON", "AVRO", "TSVE", "PARQUET", "ORC", "APACHEAVRO", "W3CLOGFILE")] + # The data format of the message. Optionally the data format can be added to each message. + ${DataFormat}, + + [Parameter(ParameterSetName = 'CreateExpandedEventHub')] + [Parameter(ParameterSetName = 'CreateExpandedIotHub')] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Body')] + [System.String[]] + # System properties of the event/iot hub. + ${EventSystemProperty}, + + [Parameter()] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Body')] + [System.String] + # The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message. + ${MappingRuleName}, + + [Parameter(ParameterSetName = 'CreateExpandedEventHub')] + [Parameter(ParameterSetName = 'CreateExpandedEventGrid')] + [Parameter(ParameterSetName = 'CreateExpandedIotHub')] + [Parameter(ParameterSetName = 'CreateExpandedCosmosDb', Mandatory)] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Body')] + [System.String] + # The table where the data should be ingested. Optionally the table information can be added to each message. + ${TableName}, + + [Parameter(ParameterSetName = 'CreateExpandedEventHub')] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.PSArgumentCompleterAttribute("None", "GZip")] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Body')] + [System.String] + # The event hub messages compression type. + ${Compression}, + + [Parameter(ParameterSetName = 'CreateExpandedEventGrid', Mandatory)] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Body')] + [System.String] + # The resource ID of the storage account where the data resides. + ${StorageAccountResourceId}, + + [Parameter(ParameterSetName = 'CreateExpandedIotHub', Mandatory)] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Body')] + [System.String] + # The resource ID of the Iot hub to be used to create a data connection. + ${IotHubResourceId}, + + [Parameter(ParameterSetName = 'CreateExpandedIotHub', Mandatory)] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Body')] + [System.String] + # The name of the share access policy. + ${SharedAccessPolicyName}, + + [Parameter(ParameterSetName = 'CreateExpandedEventHub')] + [Parameter(ParameterSetName = 'CreateExpandedEventGrid')] + [Parameter(ParameterSetName = 'CreateExpandedCosmosDb', Mandatory)] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Body')] + [System.String] + # The resource ID of a managed identity (system or user assigned) to be used to authenticate with external resources. + ${ManagedIdentityResourceId}, + + [Parameter(ParameterSetName = 'CreateExpandedEventHub')] + [Parameter(ParameterSetName = 'CreateExpandedEventGrid')] + [Parameter(ParameterSetName = 'CreateExpandedIotHub')] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.PSArgumentCompleterAttribute("Single", "Multi")] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Body')] + [System.String] + # Indication for database routing information from the data connection, by default only database routing information is allowed. + ${DatabaseRouting}, + + [Parameter(ParameterSetName = 'CreateExpandedEventHub')] + [Parameter(ParameterSetName = 'CreateExpandedIotHub')] + [Parameter(ParameterSetName = 'CreateExpandedCosmosDb')] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Body')] + [System.DateTime] + # When defined, the data connection retrieves existing Event hub events created since the Retrieval start date. It can only retrieve events retained by the Event hub, based on its retention period. + ${RetrievalStartDate}, + + [Parameter(ParameterSetName = 'CreateExpandedEventGrid')] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Body')] + [System.String] + # The resource ID of the event grid that is subscribed to the storage account events. + ${EventGridResourceId}, + + [Parameter(ParameterSetName = 'CreateExpandedCosmosDb', Mandatory)] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Body')] + [System.String] + # The resource ID of the Cosmos DB account used to create the data connection. + ${CosmosDbAccountResourceId}, + + [Parameter(ParameterSetName = 'CreateExpandedCosmosDb', Mandatory)] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Body')] + [System.String] + # The name of an existing database in the Cosmos DB account. + ${CosmosDbDatabase}, + + [Parameter(ParameterSetName = 'CreateExpandedCosmosDb', Mandatory)] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Body')] + [System.String] + # The name of an existing container in the Cosmos DB database. + ${CosmosDbContainer}, + + [Parameter(Mandatory)] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Body')] + [System.String] + # Resource location. + ${Location}, + + [Parameter()] + [Alias('AzureRMContext', 'AzureCredential')] + [ValidateNotNull()] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Azure')] + [System.Management.Automation.PSObject] + # The DefaultProfile parameter is not functional. + # Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + ${DefaultProfile}, + + [Parameter()] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Runtime')] + [System.Management.Automation.SwitchParameter] + # Run the command as a job + ${AsJob}, + + [Parameter(DontShow)] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Runtime')] + [System.Management.Automation.SwitchParameter] + # Wait for .NET debugger to attach + ${Break}, + + [Parameter(DontShow)] + [ValidateNotNull()] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Runtime')] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Runtime.SendAsyncStep[]] + # SendAsync Pipeline Steps to be appended to the front of the pipeline + ${HttpPipelineAppend}, + + [Parameter(DontShow)] + [ValidateNotNull()] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Runtime')] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Runtime.SendAsyncStep[]] + # SendAsync Pipeline Steps to be prepended to the front of the pipeline + ${HttpPipelinePrepend}, + + [Parameter()] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Runtime')] + [System.Management.Automation.SwitchParameter] + # Run the command asynchronously + ${NoWait}, + + [Parameter(DontShow)] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Runtime')] + [System.Uri] + # The URI for the proxy server to use + ${Proxy}, + + [Parameter(DontShow)] + [ValidateNotNull()] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Runtime')] + [System.Management.Automation.PSCredential] + # Credentials for a proxy server to use for the remote call + ${ProxyCredential}, + + [Parameter(DontShow)] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Runtime')] + [System.Management.Automation.SwitchParameter] + # Use the default credentials for the proxy + ${ProxyUseDefaultCredentials} +) process { try { if ($PSBoundParameters['Kind'] -eq 'EventHub') { - $Parameter = [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.EventHubDataConnection]::new() + $Parameter = [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.EventHubDataConnection]::new() $Parameter.EventHubResourceId = $PSBoundParameters['EventHubResourceId'] $null = $PSBoundParameters.Remove('EventHubResourceId') @@ -313,7 +331,7 @@ function New-AzKustoDataConnection { } } elseif ($PSBoundParameters['Kind'] -eq 'EventGrid') { - $Parameter = [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.EventGridDataConnection]::new() + $Parameter = [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.EventGridDataConnection]::new() $Parameter.EventHubResourceId = $PSBoundParameters['EventHubResourceId'] $null = $PSBoundParameters.Remove('EventHubResourceId') @@ -357,7 +375,7 @@ function New-AzKustoDataConnection { } } elseif ($PSBoundParameters['Kind'] -eq 'IotHub') { - $Parameter = [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IotHubDataConnection]::new() + $Parameter = [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IotHubDataConnection]::new() $Parameter.IotHubResourceId = $PSBoundParameters['IotHubResourceId'] $null = $PSBoundParameters.Remove('IotHubResourceId') @@ -391,7 +409,7 @@ function New-AzKustoDataConnection { } } elseif ($PSBoundParameters['Kind'] -eq 'CosmosDb') { - $Parameter = [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.CosmosDbDataConnection]::new() + $Parameter = [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.CosmosDbDataConnection]::new() $Parameter.TableName = $PSBoundParameters['TableName'] $null = $PSBoundParameters.Remove('TableName') diff --git a/src/Kusto/Kusto.Autorest/custom/New-AzKustoDatabase.ps1 b/src/Kusto/Kusto.Autorest/custom/New-AzKustoDatabase.ps1 index 8847a5047988..6b8df58f7761 100644 --- a/src/Kusto/Kusto.Autorest/custom/New-AzKustoDatabase.ps1 +++ b/src/Kusto/Kusto.Autorest/custom/New-AzKustoDatabase.ps1 @@ -1,7 +1,6 @@ # ---------------------------------------------------------------------------------- -# -# Copyright Microsoft Corporation +# Copyright (c) Microsoft Corporation. All rights reserved. # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at @@ -11,171 +10,185 @@ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. +# Code generated by Microsoft (R) AutoRest Code Generator.Changes may cause incorrect behavior and will be lost if the code +# is regenerated. # ---------------------------------------------------------------------------------- <# .Synopsis -Creates or updates a database. +Create a database. .Description -Creates or updates a database. +Create a database. .Example -New-AzKustoDatabase -ResourceGroupName testrg -ClusterName testnewkustocluster -Name mykustodatabase -Kind ReadWrite -Location 'East US' -CallerRole Admin - - -Kind Location Name Type ----- -------- ---- ---- -ReadWrite East US testnewkustocluster/mykustodatabase Microsoft.Kusto/Clusters/Databases +New-AzKustoDatabase -ResourceGroupName testrg -ClusterName testnewkustocluster -Name mykustodatabase -Kind ReadWrite -Location 'East US' + +.Inputs +Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IDatabase +.Outputs +Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IDatabase +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +PARAMETER : Class representing a Kusto database. + Kind : Kind of the database + [Location ]: Resource location. +.Link +https://learn.microsoft.com/powershell/module/az.kusto/new-azkustodatabase #> function New-AzKustoDatabase { - [OutputType([Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IDatabase])] - [CmdletBinding(PositionalBinding = $false, SupportsShouldProcess, ConfirmImpact = 'Medium')] - param( - [Parameter(Mandatory)] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Path')] - [System.String] - # The name of the Kusto cluster. - ${ClusterName}, - - [Parameter(Mandatory)] - [Alias('DatabaseName')] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Path')] - [System.String] - # The name of the database in the Kusto cluster. - ${Name}, - - [Parameter(Mandatory)] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Path')] - [System.String] - # The name of the resource group containing the Kusto cluster. - ${ResourceGroupName}, - - [Parameter()] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Path')] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Runtime.DefaultInfo(Script = '(Get-AzContext).Subscription.Id')] - [System.String] - # Gets subscription credentials which uniquely identify Microsoft Azure subscription. - # The subscription ID forms part of the URI for every service call. - ${SubscriptionId}, - - [Parameter(Mandatory)] - [ArgumentCompleter( { param ( $CommandName, $ParameterName, $WordToComplete, $CommandAst, $FakeBoundParameters ) return @('ReadWrite') })] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Body')] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.Kind] - # Kind of the database - ${Kind}, - - [Parameter()] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Body')] - [System.TimeSpan] - # The time the data should be kept in cache for fast queries in TimeSpan. - ${HotCachePeriod}, - - [Parameter()] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Body')] - [System.TimeSpan] - # The time the data should be kept before it stops being accessible to queries in TimeSpan. - ${SoftDeletePeriod}, - - [Parameter()] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Body')] - [System.String] - # The name of the key vault key. - ${KeyVaultPropertyKeyName}, - - [Parameter()] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Body')] - [System.String] - # The Uri of the key vault. - ${KeyVaultPropertyKeyVaultUri}, - - [Parameter()] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Body')] - [System.String] - # The version of the key vault key. - ${KeyVaultPropertyKeyVersion}, - - [Parameter()] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Body')] - [System.String] - # The user assigned identity (ARM resource id) that has access to the key. - ${KeyVaultPropertyUserIdentity}, - - [Parameter()] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Query')] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.CallerRole] - # By default, any user who run operation on a database become an Admin on it. - # This property allows the caller to exclude the caller from Admins list. - ${CallerRole}, - - [Parameter()] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Body')] - [System.String] - # Resource location. - ${Location}, - - [Parameter()] - [Alias('AzureRMContext', 'AzureCredential')] - [ValidateNotNull()] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Azure')] - [System.Management.Automation.PSObject] - # The credentials, account, tenant, and subscription used for communication with Azure. - ${DefaultProfile}, - - [Parameter()] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Runtime')] - [System.Management.Automation.SwitchParameter] - # Run the command as a job - ${AsJob}, - - [Parameter(DontShow)] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Runtime')] - [System.Management.Automation.SwitchParameter] - # Wait for .NET debugger to attach - ${Break}, - - [Parameter(DontShow)] - [ValidateNotNull()] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Runtime')] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Runtime.SendAsyncStep[]] - # SendAsync Pipeline Steps to be appended to the front of the pipeline - ${HttpPipelineAppend}, - - [Parameter(DontShow)] - [ValidateNotNull()] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Runtime')] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Runtime.SendAsyncStep[]] - # SendAsync Pipeline Steps to be prepended to the front of the pipeline - ${HttpPipelinePrepend}, - - [Parameter()] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Runtime')] - [System.Management.Automation.SwitchParameter] - # Run the command asynchronously - ${NoWait}, - - [Parameter(DontShow)] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Runtime')] - [System.Uri] - # The URI for the proxy server to use - ${Proxy}, - - [Parameter(DontShow)] - [ValidateNotNull()] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Runtime')] - [System.Management.Automation.PSCredential] - # Credentials for a proxy server to use for the remote call - ${ProxyCredential}, - - [Parameter(DontShow)] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Runtime')] - [System.Management.Automation.SwitchParameter] - # Use the default credentials for the proxy - ${ProxyUseDefaultCredentials} - ) +[OutputType([Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IDatabase])] +[CmdletBinding(DefaultParameterSetName='CreateReadWrite', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] +param( + [Parameter(Mandatory)] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Path')] + [System.String] + # The name of the Kusto cluster. + ${ClusterName}, + + [Parameter(Mandatory)] + [Alias('DatabaseName')] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Path')] + [System.String] + # The name of the database in the Kusto cluster. + ${Name}, + + [Parameter(Mandatory)] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Path')] + [System.String] + # The name of the resource group. + # The name is case insensitive. + ${ResourceGroupName}, + + [Parameter()] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Path')] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Runtime.DefaultInfo(Script='(Get-AzContext).Subscription.Id')] + [System.String] + # The ID of the target subscription. + ${SubscriptionId}, + + [Parameter()] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.PSArgumentCompleterAttribute("Admin", "None")] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Query')] + [System.String] + # By default, any user who run operation on a database become an Admin on it. + # This property allows the caller to exclude the caller from Admins list. + ${CallerRole}, + + [Parameter(Mandatory)] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.PSArgumentCompleterAttribute("ReadWrite", "ReadOnlyFollowing")] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Body')] + [System.String] + # Kind of the database + ${Kind}, + + [Parameter()] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Body')] + [System.TimeSpan] + # The time the data should be kept in cache for fast queries in TimeSpan. + ${HotCachePeriod}, + + [Parameter()] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Body')] + [System.TimeSpan] + # The time the data should be kept before it stops being accessible to queries in TimeSpan. + ${SoftDeletePeriod}, + + [Parameter()] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Body')] + [System.String] + # The name of the key vault key. + ${KeyVaultPropertyKeyName}, + + [Parameter()] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Body')] + [System.String] + # The Uri of the key vault. + ${KeyVaultPropertyKeyVaultUri}, + + [Parameter()] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Body')] + [System.String] + # The version of the key vault key. + ${KeyVaultPropertyKeyVersion}, + + [Parameter()] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Body')] + [System.String] + # The user assigned identity (ARM resource id) that has access to the key. + ${KeyVaultPropertyUserIdentity}, + + [Parameter()] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Body')] + [System.String] + # Resource location. + ${Location}, + + [Parameter()] + [Alias('AzureRMContext', 'AzureCredential')] + [ValidateNotNull()] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Azure')] + [System.Management.Automation.PSObject] + # The DefaultProfile parameter is not functional. + # Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + ${DefaultProfile}, + + [Parameter()] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Runtime')] + [System.Management.Automation.SwitchParameter] + # Run the command as a job + ${AsJob}, + + [Parameter(DontShow)] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Runtime')] + [System.Management.Automation.SwitchParameter] + # Wait for .NET debugger to attach + ${Break}, + + [Parameter(DontShow)] + [ValidateNotNull()] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Runtime')] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Runtime.SendAsyncStep[]] + # SendAsync Pipeline Steps to be appended to the front of the pipeline + ${HttpPipelineAppend}, + + [Parameter(DontShow)] + [ValidateNotNull()] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Runtime')] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Runtime.SendAsyncStep[]] + # SendAsync Pipeline Steps to be prepended to the front of the pipeline + ${HttpPipelinePrepend}, + + [Parameter()] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Runtime')] + [System.Management.Automation.SwitchParameter] + # Run the command asynchronously + ${NoWait}, + + [Parameter(DontShow)] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Runtime')] + [System.Uri] + # The URI for the proxy server to use + ${Proxy}, + + [Parameter(DontShow)] + [ValidateNotNull()] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Runtime')] + [System.Management.Automation.PSCredential] + # Credentials for a proxy server to use for the remote call + ${ProxyCredential}, + + [Parameter(DontShow)] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Runtime')] + [System.Management.Automation.SwitchParameter] + # Use the default credentials for the proxy + ${ProxyUseDefaultCredentials} +) process { try { - $Parameter = [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ReadWriteDatabase]::new() + $Parameter = [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ReadWriteDatabase]::new() $Parameter.Kind = $PSBoundParameters['Kind'] $null = $PSBoundParameters.Remove('Kind') diff --git a/src/Kusto/Kusto.Autorest/custom/Update-AzKustoDataConnection.ps1 b/src/Kusto/Kusto.Autorest/custom/Update-AzKustoDataConnection.ps1 index 0413131b65f6..91cdecd1ed3e 100644 --- a/src/Kusto/Kusto.Autorest/custom/Update-AzKustoDataConnection.ps1 +++ b/src/Kusto/Kusto.Autorest/custom/Update-AzKustoDataConnection.ps1 @@ -1,7 +1,6 @@ # ---------------------------------------------------------------------------------- -# -# Copyright Microsoft Corporation +# Copyright (c) Microsoft Corporation. All rights reserved. # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at @@ -11,26 +10,67 @@ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. +# Code generated by Microsoft (R) AutoRest Code Generator.Changes may cause incorrect behavior and will be lost if the code +# is regenerated. # ---------------------------------------------------------------------------------- <# .Synopsis -Updates a data connection. +Update a data connection. .Description -Updates a data connection. +Update a data connection. .Example -$dataConnectionProperties = New-Object -Type Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.EventHubDataConnection -Property @{Location="East US"; Kind="EventHub"; EventHubResourceId="/subscriptions/$subscriptionId/resourcegroups/$resourceGroupName/providers/Microsoft.EventHub/namespaces/myeventhubns/eventhubs/myeventhub"; DataFormat="JSON"; ConsumerGroup='Default'; Compression= "None"; TableName = "Events"; MappingRuleName = "EventsMapping1"} -Update-AzKustoDataConnection -ResourceGroupName $resourceGroupName -ClusterName "testnewkustocluster" -DatabaseName "mykustodatabase" -DataConnectionName "mykustodataconnection" -Parameter $dataConnectionProperties - -Kind Location Name Type ----- -------- ---- ---- -EventHub East US testnewkustocluster/mykustodatabase/mykustodataconnection Microsoft.Kusto/Clusters/Databases/DataConnections - +Update-AzKustoDataConnection -ResourceGroupName "testrg" -ClusterName "testnewkustocluster" -DatabaseName "mykustodatabase" -DataConnectionName "myeventhubdc" -Location "East US" -Kind "EventHub" -EventHubResourceId "/subscriptions/$subscriptionId/resourcegroups/testrg/providers/Microsoft.EventHub/namespaces/myeventhubns/eventhubs/myeventhub" -DataFormat "MULTIJSON" -ConsumerGroup '$Default' -Compression "None" -TableName "Events" -MappingRuleName "NewEventsMapping" +.Example +Update-AzKustoDataConnection -ResourceGroupName "testrg" -ClusterName "testnewkustocluster" -DatabaseName "mykustodatabase" -DataConnectionName "myeventgriddc" -Location "East US" -Kind "EventGrid" -EventHubResourceId "/subscriptions/$subscriptionId/resourcegroups/testrg/providers/Microsoft.EventHub/namespaces/myeventhubns/eventhubs/myeventhub" -StorageAccountResourceId "/subscriptions/$subscriptionId/resourcegroups/testrg/providers/Microsoft.Storage/storageAccounts/mystorage" -DataFormat "MULTIJSON" -ConsumerGroup '$Default' -TableName "Events" -MappingRuleName "NewEventsMapping" +.Example +Update-AzKustoDataConnection -ResourceGroupName "testrg" -ClusterName "testnewkustocluster" -DatabaseName "mykustodatabase" -DataConnectionName "myiothubdc" -Location "East US" -Kind "IotHub" -IotHubResourceId "/subscriptions/$subscriptionId/resourcegroups/testrg/providers/Microsoft.Devices/IotHubs/myiothub" -SharedAccessPolicyName "myiothubpolicy" -DataFormat "MULTIJSON" -ConsumerGroup '$Default' -TableName "Events" -MappingRuleName "NewEventsMapping" +.Example +$dataConnection = Get-AzKustoDataConnection -ResourceGroupName "testrg" -ClusterName "testnewkustocluster" -DatabaseName "mykustodatabase" -DataConnectionName "myeventhubdc" +Update-AzKustoDataConnection -InputObject $dataConnection -Location "East US" -Kind "EventHub" -EventHubResourceId "/subscriptions/$subscriptionId/resourcegroups/testrg/providers/Microsoft.EventHub/namespaces/myeventhubns/eventhubs/myeventhub" -DataFormat "MULTIJSON" -ConsumerGroup '$Default' -Compression "None" -TableName "Events" -MappingRuleName "NewEventsMapping" +.Example +$dataConnection = Get-AzKustoDataConnection -ResourceGroupName "testrg" -ClusterName "testnewkustocluster" -DatabaseName "mykustodatabase" -DataConnectionName "myeventgriddc" +Update-AzKustoDataConnection -InputObject $dataConnection -Location "East US" -Kind "EventGrid" -EventHubResourceId "/subscriptions/$subscriptionId/resourcegroups/testrg/providers/Microsoft.EventHub/namespaces/myeventhubns/eventhubs/myeventhub" -StorageAccountResourceId "/subscriptions/$subscriptionId/resourcegroups/testrg/providers/Microsoft.Storage/storageAccounts/mystorage" -DataFormat "MULTIJSON" -ConsumerGroup '$Default' -TableName "Events" -MappingRuleName "NewEventsMapping" +.Example +$dataConnection = Get-AzKustoDataConnection -ResourceGroupName "testrg" -ClusterName "testnewkustocluster" -DatabaseName "mykustodatabase" -DataConnectionName "myiothubdc" +Update-AzKustoDataConnection -InputObject $dataConnection -Location "East US" -Kind "IotHub" -IotHubResourceId "/subscriptions/$subscriptionId/resourcegroups/testrg/providers/Microsoft.Devices/IotHubs/myiothub" -SharedAccessPolicyName "myiothubpolicy" -DataFormat "MULTIJSON" -ConsumerGroup '$Default' -TableName "Events" -MappingRuleName "NewEventsMapping" + +.Inputs +Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IDataConnection +.Inputs +Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +.Outputs +Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IDataConnection +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : Identity Parameter + [AttachedDatabaseConfigurationName ]: The name of the attached database configuration. + [ClusterName ]: The name of the Kusto cluster. + [DataConnectionName ]: The name of the data connection. + [DatabaseName ]: The name of the database in the Kusto cluster. + [Id ]: Resource identity path + [Location ]: The name of Azure region. + [ManagedPrivateEndpointName ]: The name of the managed private endpoint. + [OperationId ]: The ID of an ongoing async operation. + [PrincipalAssignmentName ]: The name of the Kusto principalAssignment. + [PrivateEndpointConnectionName ]: The name of the private endpoint connection. + [PrivateLinkResourceName ]: The name of the private link resource. + [ResourceGroupName ]: The name of the resource group. The name is case insensitive. + [SandboxCustomImageName ]: The name of the sandbox custom image. + [ScriptName ]: The name of the Kusto database script. + [SubscriptionId ]: The ID of the target subscription. + +PARAMETER : Class representing an data connection. + Kind : Kind of the endpoint for the data connection + [Location ]: Resource location. .Link https://learn.microsoft.com/powershell/module/az.kusto/update-azkustodataconnection #> function Update-AzKustoDataConnection { - [OutputType([Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IDataConnection])] + [OutputType([Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IDataConnection])] [CmdletBinding(DefaultParameterSetName = 'UpdateExpandedEventHub', PositionalBinding = $false, SupportsShouldProcess, ConfirmImpact = 'Medium')] param( [Parameter(ParameterSetName = 'UpdateExpandedEventHub', Mandatory)] @@ -92,9 +132,9 @@ function Update-AzKustoDataConnection { ${InputObject}, [Parameter(Mandatory)] - [ArgumentCompleter( { param ( $CommandName, $ParameterName, $WordToComplete, $CommandAst, $FakeBoundParameters ) return @('EventHub', 'EventGrid', 'IotHub', 'CosmosDb') })] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.PSArgumentCompleterAttribute("EventHub", "EventGrid", "IotHub", "CosmosDb")] [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Body')] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.Kind] + [System.String] # Kind of the endpoint for the data connection ${Kind}, @@ -120,8 +160,9 @@ function Update-AzKustoDataConnection { [Parameter(ParameterSetName = 'UpdateExpandedEventGrid')] [Parameter(ParameterSetName = 'UpdateViaIdentityExpandedEventGrid')] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.PSArgumentCompleterAttribute("Microsoft.Storage.BlobCreated", "Microsoft.Storage.BlobRenamed")] [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Body')] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.BlobStorageEventType] + [System.String] # The name of blob storage event type to process. ${BlobStorageEventType}, @@ -174,8 +215,9 @@ function Update-AzKustoDataConnection { [Parameter(ParameterSetName = 'UpdateExpandedEventHub')] [Parameter(ParameterSetName = 'UpdateViaIdentityExpandedEventHub')] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.PSArgumentCompleterAttribute("None", "GZip")] [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Body')] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.Compression] + [System.String] # The event hub messages compression type. ${Compression}, @@ -217,8 +259,9 @@ function Update-AzKustoDataConnection { [Parameter(ParameterSetName = 'UpdateViaIdentityExpandedEventGrid')] [Parameter(ParameterSetName = 'UpdateExpandedIotHub')] [Parameter(ParameterSetName = 'UpdateViaIdentityExpandedIotHub')] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.PSArgumentCompleterAttribute("Single", "Multi")] [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Body')] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.DatabaseRouting] + [System.String] # Indication for database routing information from the data connection, by default only database routing information is allowed. ${DatabaseRouting}, @@ -330,7 +373,7 @@ function Update-AzKustoDataConnection { process { try { if ($PSBoundParameters['Kind'] -eq 'EventHub') { - $Parameter = [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.EventHubDataConnection]::new() + $Parameter = [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.EventHubDataConnection]::new() $Parameter.EventHubResourceId = $PSBoundParameters['EventHubResourceId'] $null = $PSBoundParameters.Remove('EventHubResourceId') @@ -371,7 +414,7 @@ function Update-AzKustoDataConnection { } } elseif ($PSBoundParameters['Kind'] -eq 'EventGrid') { - $Parameter = [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.EventGridDataConnection]::new() + $Parameter = [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.EventGridDataConnection]::new() $Parameter.EventHubResourceId = $PSBoundParameters['EventHubResourceId'] $null = $PSBoundParameters.Remove('EventHubResourceId') @@ -415,7 +458,7 @@ function Update-AzKustoDataConnection { } } elseif ($PSBoundParameters['Kind'] -eq 'IotHub') { - $Parameter = [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IotHubDataConnection]::new() + $Parameter = [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IotHubDataConnection]::new() $Parameter.IotHubResourceId = $PSBoundParameters['IotHubResourceId'] $null = $PSBoundParameters.Remove('IotHubResourceId') @@ -449,7 +492,7 @@ function Update-AzKustoDataConnection { } } elseif ($PSBoundParameters['Kind'] -eq 'CosmosDb') { - $Parameter = [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.CosmosDbDataConnection]::new() + $Parameter = [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.CosmosDbDataConnection]::new() $Parameter.TableName = $PSBoundParameters['TableName'] $null = $PSBoundParameters.Remove('TableName') diff --git a/src/Kusto/Kusto.Autorest/custom/Update-AzKustoDatabase.ps1 b/src/Kusto/Kusto.Autorest/custom/Update-AzKustoDatabase.ps1 index a482285a7eb0..8c0c58487903 100644 --- a/src/Kusto/Kusto.Autorest/custom/Update-AzKustoDatabase.ps1 +++ b/src/Kusto/Kusto.Autorest/custom/Update-AzKustoDatabase.ps1 @@ -1,7 +1,6 @@ # ---------------------------------------------------------------------------------- -# -# Copyright Microsoft Corporation +# Copyright (c) Microsoft Corporation. All rights reserved. # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at @@ -11,27 +10,68 @@ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. +# Code generated by Microsoft (R) AutoRest Code Generator.Changes may cause incorrect behavior and will be lost if the code +# is regenerated. # ---------------------------------------------------------------------------------- <# .Synopsis -Updates a database. +Update a database. .Description -Updates a database. +Update a database. .Example $2ds = New-TimeSpan -Days 2 $4ds = New-TimeSpan -Days 4 -Update-AzKustoDatabase -ResourceGroupName testrg -ClusterName testnewkustocluster -Name mykustodatabase -Kind ReadWrite -SoftDeletePeriod $4ds -HotCachePeriod $2ds -Location 'East US' -CallerRole Admin - -Kind Location Name Type ----- -------- ---- ---- -ReadWrite East US testnewkustocluster/mykustodatabase Microsoft.Kusto/Clusters/Databases - +Update-AzKustoDatabase -ResourceGroupName testrg -ClusterName testnewkustocluster -Name mykustodatabase -Kind ReadWrite -SoftDeletePeriod $4ds -HotCachePeriod $2ds -Location 'East US' +.Example +$database = Get-AzKustoDatabase -ResourceGroupName testrg -ClusterName testnewkustocluster -Name mykustodatabase +$2ds = New-TimeSpan -Days 2 +$4ds = New-TimeSpan -Days 4 +Update-AzKustoDatabase -InputObject $database -Kind ReadWrite -SoftDeletePeriod $4ds -HotCachePeriod $2ds -Location 'East US' +.Example +$2ds = New-TimeSpan -Days 2 +Update-AzKustoDatabase -ResourceGroupName testrg -ClusterName myfollowercluster -Name mykustodatabase -Kind ReadOnlyFollowing -HotCachePeriod $2ds -Location 'East US' +.Example +$database = Get-AzKustoDatabase -ResourceGroupName testrg -ClusterName myfollowercluster -Name mykustodatabase +$2ds = New-TimeSpan -Days 2 +Update-AzKustoDatabase -InputObject $database -Kind ReadOnlyFollowing -HotCachePeriod $2ds -Location 'East US' + +.Inputs +Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IDatabase +.Inputs +Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +.Outputs +Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IDatabase +.Notes +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + +INPUTOBJECT : Identity Parameter + [AttachedDatabaseConfigurationName ]: The name of the attached database configuration. + [ClusterName ]: The name of the Kusto cluster. + [DataConnectionName ]: The name of the data connection. + [DatabaseName ]: The name of the database in the Kusto cluster. + [Id ]: Resource identity path + [Location ]: The name of Azure region. + [ManagedPrivateEndpointName ]: The name of the managed private endpoint. + [OperationId ]: The ID of an ongoing async operation. + [PrincipalAssignmentName ]: The name of the Kusto principalAssignment. + [PrivateEndpointConnectionName ]: The name of the private endpoint connection. + [PrivateLinkResourceName ]: The name of the private link resource. + [ResourceGroupName ]: The name of the resource group. The name is case insensitive. + [SandboxCustomImageName ]: The name of the sandbox custom image. + [ScriptName ]: The name of the Kusto database script. + [SubscriptionId ]: The ID of the target subscription. + +PARAMETER : Class representing a Kusto database. + Kind : Kind of the database + [Location ]: Resource location. .Link https://learn.microsoft.com/powershell/module/az.kusto/update-azkustodatabase #> function Update-AzKustoDatabase { - [OutputType([Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IDatabase])] + [OutputType([Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IDatabase])] [CmdletBinding(DefaultParameterSetName = 'UpdateExpanded', PositionalBinding = $false, SupportsShouldProcess, ConfirmImpact = 'Medium')] param( [Parameter(ParameterSetName = 'UpdateExpanded', Mandatory)] @@ -69,9 +109,9 @@ function Update-AzKustoDatabase { ${InputObject}, [Parameter(Mandatory)] - [ArgumentCompleter( { param ( $CommandName, $ParameterName, $WordToComplete, $CommandAst, $FakeBoundParameters ) return @('ReadWrite', 'ReadOnlyFollowing') })] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.PSArgumentCompleterAttribute("ReadWrite", "ReadOnlyFollowing")] [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Body')] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.Kind] + [System.String] # Kind of the database ${Kind}, @@ -117,8 +157,9 @@ function Update-AzKustoDatabase { ${KeyVaultPropertyUserIdentity}, [Parameter()] + [Microsoft.Azure.PowerShell.Cmdlets.Kusto.PSArgumentCompleterAttribute("Admin", "None")] [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Category('Query')] - [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.CallerRole] + [System.String] # By default, any user who run operation on a database become an Admin on it. # This property allows the caller to exclude the caller from Admins list. ${CallerRole}, @@ -194,11 +235,11 @@ function Update-AzKustoDatabase { { if ($PSBoundParameters['Kind'] -eq 'ReadWrite') { - $Parameter = [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ReadWriteDatabase]::new() + $Parameter = [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ReadWriteDatabase]::new() } else { - $Parameter = [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ReadOnlyFollowingDatabase]::new() + $Parameter = [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ReadOnlyFollowingDatabase]::new() } $Parameter.Kind = $PSBoundParameters['Kind'] diff --git a/src/Kusto/Kusto.Autorest/docs/Add-AzKustoClusterCalloutPolicy.md b/src/Kusto/Kusto.Autorest/docs/Add-AzKustoClusterCalloutPolicy.md index 4e63a238c4e3..5ddf01bb4886 100644 --- a/src/Kusto/Kusto.Autorest/docs/Add-AzKustoClusterCalloutPolicy.md +++ b/src/Kusto/Kusto.Autorest/docs/Add-AzKustoClusterCalloutPolicy.md @@ -25,6 +25,20 @@ Add-AzKustoClusterCalloutPolicy -InputObject [-NextLink ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] ``` +### AddViaJsonFilePath +``` +Add-AzKustoClusterCalloutPolicy -ClusterName -ResourceGroupName -JsonFilePath + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +### AddViaJsonString +``` +Add-AzKustoClusterCalloutPolicy -ClusterName -ResourceGroupName -JsonString + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + ## DESCRIPTION Adds a list of callout policies for engine services. @@ -69,7 +83,7 @@ The name of the Kusto cluster. ```yaml Type: System.String -Parameter Sets: AddExpanded +Parameter Sets: AddExpanded, AddViaJsonFilePath, AddViaJsonString Aliases: Required: True @@ -97,7 +111,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -111,12 +124,42 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -JsonFilePath +Path of Json file supplied to the Add operation + +```yaml +Type: System.String +Parameter Sets: AddViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Add operation + +```yaml +Type: System.String +Parameter Sets: AddViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -NextLink The URL to get the next set of callout policies list results if there are any. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: AddExpanded, AddViaIdentityExpanded Aliases: Required: False @@ -162,7 +205,7 @@ The name is case insensitive. ```yaml Type: System.String -Parameter Sets: AddExpanded +Parameter Sets: AddExpanded, AddViaJsonFilePath, AddViaJsonString Aliases: Required: True @@ -177,7 +220,7 @@ The ID of the target subscription. ```yaml Type: System.String -Parameter Sets: AddExpanded +Parameter Sets: AddExpanded, AddViaJsonFilePath, AddViaJsonString Aliases: Required: False @@ -189,11 +232,10 @@ Accept wildcard characters: False ### -Value A list of the service's callout policies. -To construct, see NOTES section for VALUE properties and create a hash table. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ICalloutPolicy[] -Parameter Sets: (All) +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ICalloutPolicy[] +Parameter Sets: AddExpanded, AddViaIdentityExpanded Aliases: Required: False diff --git a/src/Kusto/Kusto.Autorest/docs/Add-AzKustoClusterLanguageExtension.md b/src/Kusto/Kusto.Autorest/docs/Add-AzKustoClusterLanguageExtension.md index 7c1ac2518591..61a14b4b233b 100644 --- a/src/Kusto/Kusto.Autorest/docs/Add-AzKustoClusterLanguageExtension.md +++ b/src/Kusto/Kusto.Autorest/docs/Add-AzKustoClusterLanguageExtension.md @@ -25,6 +25,20 @@ Add-AzKustoClusterLanguageExtension -InputObject [-Value ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] ``` +### AddViaJsonFilePath +``` +Add-AzKustoClusterLanguageExtension -ClusterName -ResourceGroupName -JsonFilePath + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +### AddViaJsonString +``` +Add-AzKustoClusterLanguageExtension -ClusterName -ResourceGroupName -JsonString + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + ## DESCRIPTION Add a list of language extensions that can run within KQL queries. @@ -59,7 +73,7 @@ The name of the Kusto cluster. ```yaml Type: System.String -Parameter Sets: AddExpanded +Parameter Sets: AddExpanded, AddViaJsonFilePath, AddViaJsonString Aliases: Required: True @@ -87,7 +101,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -101,6 +114,36 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -JsonFilePath +Path of Json file supplied to the Add operation + +```yaml +Type: System.String +Parameter Sets: AddViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Add operation + +```yaml +Type: System.String +Parameter Sets: AddViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -NoWait Run the command asynchronously @@ -137,7 +180,7 @@ The name is case insensitive. ```yaml Type: System.String -Parameter Sets: AddExpanded +Parameter Sets: AddExpanded, AddViaJsonFilePath, AddViaJsonString Aliases: Required: True @@ -152,7 +195,7 @@ The ID of the target subscription. ```yaml Type: System.String -Parameter Sets: AddExpanded +Parameter Sets: AddExpanded, AddViaJsonFilePath, AddViaJsonString Aliases: Required: False @@ -164,11 +207,10 @@ Accept wildcard characters: False ### -Value The list of language extensions. -To construct, see NOTES section for VALUE properties and create a hash table. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ILanguageExtension[] -Parameter Sets: (All) +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ILanguageExtension[] +Parameter Sets: AddExpanded, AddViaIdentityExpanded Aliases: Required: False diff --git a/src/Kusto/Kusto.Autorest/docs/Add-AzKustoDatabasePrincipal.md b/src/Kusto/Kusto.Autorest/docs/Add-AzKustoDatabasePrincipal.md index 6d621cff94fa..e979152c363e 100644 --- a/src/Kusto/Kusto.Autorest/docs/Add-AzKustoDatabasePrincipal.md +++ b/src/Kusto/Kusto.Autorest/docs/Add-AzKustoDatabasePrincipal.md @@ -19,12 +19,32 @@ Add-AzKustoDatabasePrincipal -ClusterName -DatabaseName -Resou [] ``` +### AddViaIdentityClusterExpanded +``` +Add-AzKustoDatabasePrincipal -ClusterInputObject -DatabaseName + [-Value ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + ### AddViaIdentityExpanded ``` Add-AzKustoDatabasePrincipal -InputObject [-Value ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] ``` +### AddViaJsonFilePath +``` +Add-AzKustoDatabasePrincipal -ClusterName -DatabaseName -ResourceGroupName + -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### AddViaJsonString +``` +Add-AzKustoDatabasePrincipal -ClusterName -DatabaseName -ResourceGroupName + -JsonString [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + ## DESCRIPTION Add Database principals permissions. @@ -46,12 +66,27 @@ The above command adds Database principals permissions ## PARAMETERS +### -ClusterInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: AddViaIdentityClusterExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ClusterName The name of the Kusto cluster. ```yaml Type: System.String -Parameter Sets: AddExpanded +Parameter Sets: AddExpanded, AddViaJsonFilePath, AddViaJsonString Aliases: Required: True @@ -66,7 +101,7 @@ The name of the database in the Kusto cluster. ```yaml Type: System.String -Parameter Sets: AddExpanded +Parameter Sets: AddExpanded, AddViaIdentityClusterExpanded, AddViaJsonFilePath, AddViaJsonString Aliases: Required: True @@ -94,7 +129,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -108,13 +142,43 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -JsonFilePath +Path of Json file supplied to the Add operation + +```yaml +Type: System.String +Parameter Sets: AddViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Add operation + +```yaml +Type: System.String +Parameter Sets: AddViaJsonString +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: AddExpanded +Parameter Sets: AddExpanded, AddViaJsonFilePath, AddViaJsonString Aliases: Required: True @@ -129,7 +193,7 @@ The ID of the target subscription. ```yaml Type: System.String -Parameter Sets: AddExpanded +Parameter Sets: AddExpanded, AddViaJsonFilePath, AddViaJsonString Aliases: Required: False @@ -141,11 +205,10 @@ Accept wildcard characters: False ### -Value The list of Kusto database principals. -To construct, see NOTES section for VALUE properties and create a hash table. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IDatabasePrincipal[] -Parameter Sets: (All) +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IDatabasePrincipal[] +Parameter Sets: AddExpanded, AddViaIdentityClusterExpanded, AddViaIdentityExpanded Aliases: Required: False @@ -195,7 +258,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IDatabasePrincipal +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IDatabasePrincipalListResult ## NOTES diff --git a/src/Kusto/Kusto.Autorest/docs/Az.Kusto.md b/src/Kusto/Kusto.Autorest/docs/Az.Kusto.md index 2fb3d8d283a5..d7d9241b6647 100644 --- a/src/Kusto/Kusto.Autorest/docs/Az.Kusto.md +++ b/src/Kusto/Kusto.Autorest/docs/Az.Kusto.md @@ -1,6 +1,6 @@ --- Module Name: Az.Kusto -Module Guid: 18c61846-f6f0-425e-ba4b-5cf903e2bdd8 +Module Guid: bb1802ad-3127-41c9-b7d1-5842bba6fec4 Download Help Link: https://learn.microsoft.com/powershell/module/az.kusto Help Version: 1.0.0.0 Locale: en-US @@ -68,12 +68,6 @@ Returns operation results. ### [Get-AzKustoOperationsResultLocation](Get-AzKustoOperationsResultLocation.md) Returns operation results. -### [Get-AzKustoPrivateEndpointConnection](Get-AzKustoPrivateEndpointConnection.md) -Gets a private endpoint connection. - -### [Get-AzKustoPrivateLinkResource](Get-AzKustoPrivateLinkResource.md) -Gets a private link resource. - ### [Get-AzKustoSandboxCustomImage](Get-AzKustoSandboxCustomImage.md) Returns a sandbox custom image @@ -99,34 +93,31 @@ Diagnoses network connectivity status for external resources on which the servic Generates an invitation token that allows attaching a follower database to this database. ### [New-AzKustoAttachedDatabaseConfiguration](New-AzKustoAttachedDatabaseConfiguration.md) -Creates or updates an attached database configuration. +Create an attached database configuration. ### [New-AzKustoCluster](New-AzKustoCluster.md) -Create or update a Kusto cluster. +Create a Kusto cluster. ### [New-AzKustoClusterPrincipalAssignment](New-AzKustoClusterPrincipalAssignment.md) Create a Kusto cluster principalAssignment. ### [New-AzKustoDatabase](New-AzKustoDatabase.md) -Creates or updates a database. +Create a database. ### [New-AzKustoDatabasePrincipalAssignment](New-AzKustoDatabasePrincipalAssignment.md) -Creates a Kusto cluster database principalAssignment. +Create a Kusto cluster database principalAssignment. ### [New-AzKustoDataConnection](New-AzKustoDataConnection.md) -Creates or updates a data connection. +Create a data connection. ### [New-AzKustoManagedPrivateEndpoint](New-AzKustoManagedPrivateEndpoint.md) -Creates a managed private endpoint. - -### [New-AzKustoPrivateEndpointConnection](New-AzKustoPrivateEndpointConnection.md) -Approve or reject a private endpoint connection with a given name. +Create a managed private endpoint. ### [New-AzKustoSandboxCustomImage](New-AzKustoSandboxCustomImage.md) -Creates or updates a sandbox custom image. +Create a sandbox custom image. ### [New-AzKustoScript](New-AzKustoScript.md) -Creates a Kusto database script. +Create a Kusto database script. ### [Remove-AzKustoAttachedDatabaseConfiguration](Remove-AzKustoAttachedDatabaseConfiguration.md) Deletes the attached database configuration with the given name. @@ -158,9 +149,6 @@ Deletes the data connection with the given name. ### [Remove-AzKustoManagedPrivateEndpoint](Remove-AzKustoManagedPrivateEndpoint.md) Deletes a managed private endpoint. -### [Remove-AzKustoPrivateEndpointConnection](Remove-AzKustoPrivateEndpointConnection.md) -Deletes a private endpoint connection with a given name. - ### [Remove-AzKustoSandboxCustomImage](Remove-AzKustoSandboxCustomImage.md) Deletes a sandbox custom image. @@ -204,17 +192,17 @@ Checks that the script name is valid and is not already in use. Update a Kusto cluster. ### [Update-AzKustoDatabase](Update-AzKustoDatabase.md) -Updates a database. +Update a database. ### [Update-AzKustoDataConnection](Update-AzKustoDataConnection.md) -Updates a data connection. +Update a data connection. ### [Update-AzKustoManagedPrivateEndpoint](Update-AzKustoManagedPrivateEndpoint.md) -Updates a managed private endpoint. +Update a managed private endpoint. ### [Update-AzKustoSandboxCustomImage](Update-AzKustoSandboxCustomImage.md) -Updates a sandbox custom image. +Update a sandbox custom image. ### [Update-AzKustoScript](Update-AzKustoScript.md) -Updates a database script. +Update a database script. diff --git a/src/Kusto/Kusto.Autorest/docs/Get-AzKustoAttachedDatabaseConfiguration.md b/src/Kusto/Kusto.Autorest/docs/Get-AzKustoAttachedDatabaseConfiguration.md index 166a1b6b2091..a2c57bc5a76b 100644 --- a/src/Kusto/Kusto.Autorest/docs/Get-AzKustoAttachedDatabaseConfiguration.md +++ b/src/Kusto/Kusto.Autorest/docs/Get-AzKustoAttachedDatabaseConfiguration.md @@ -30,6 +30,12 @@ Get-AzKustoAttachedDatabaseConfiguration -InputObject [-Default [] ``` +### GetViaIdentityCluster +``` +Get-AzKustoAttachedDatabaseConfiguration -ClusterInputObject -Name + [-DefaultProfile ] [] +``` + ## DESCRIPTION Returns an attached database configuration. @@ -63,6 +69,21 @@ The above command returns the AttachedDatabaseConfigurations named "myfollowerco ## PARAMETERS +### -ClusterInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: GetViaIdentityCluster +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ClusterName The name of the Kusto cluster. @@ -96,7 +117,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -115,7 +135,7 @@ The name of the attached database configuration. ```yaml Type: System.String -Parameter Sets: Get +Parameter Sets: Get, GetViaIdentityCluster Aliases: AttachedDatabaseConfigurationName Required: True @@ -165,7 +185,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IAttachedDatabaseConfiguration +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IAttachedDatabaseConfiguration ## NOTES diff --git a/src/Kusto/Kusto.Autorest/docs/Get-AzKustoCluster.md b/src/Kusto/Kusto.Autorest/docs/Get-AzKustoCluster.md index c567916d2de0..b8ddcf0a1b49 100644 --- a/src/Kusto/Kusto.Autorest/docs/Get-AzKustoCluster.md +++ b/src/Kusto/Kusto.Autorest/docs/Get-AzKustoCluster.md @@ -86,7 +86,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -155,7 +154,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ICluster +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ICluster ## NOTES diff --git a/src/Kusto/Kusto.Autorest/docs/Get-AzKustoClusterCalloutPolicy.md b/src/Kusto/Kusto.Autorest/docs/Get-AzKustoClusterCalloutPolicy.md index 4e6aa6ee05f9..bfb59aacbb79 100644 --- a/src/Kusto/Kusto.Autorest/docs/Get-AzKustoClusterCalloutPolicy.md +++ b/src/Kusto/Kusto.Autorest/docs/Get-AzKustoClusterCalloutPolicy.md @@ -144,7 +144,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ICalloutPolicy +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ICalloutPolicy ## NOTES diff --git a/src/Kusto/Kusto.Autorest/docs/Get-AzKustoClusterFollowerDatabase.md b/src/Kusto/Kusto.Autorest/docs/Get-AzKustoClusterFollowerDatabase.md index eb7782e9202e..5fd1743668a4 100644 --- a/src/Kusto/Kusto.Autorest/docs/Get-AzKustoClusterFollowerDatabase.md +++ b/src/Kusto/Kusto.Autorest/docs/Get-AzKustoClusterFollowerDatabase.md @@ -137,7 +137,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IFollowerDatabaseDefinition +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IFollowerDatabaseDefinition ## NOTES diff --git a/src/Kusto/Kusto.Autorest/docs/Get-AzKustoClusterFollowerDatabaseGet.md b/src/Kusto/Kusto.Autorest/docs/Get-AzKustoClusterFollowerDatabaseGet.md index edda6faa3935..da0fddb5b055 100644 --- a/src/Kusto/Kusto.Autorest/docs/Get-AzKustoClusterFollowerDatabaseGet.md +++ b/src/Kusto/Kusto.Autorest/docs/Get-AzKustoClusterFollowerDatabaseGet.md @@ -134,7 +134,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IFollowerDatabaseDefinitionGet +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IFollowerDatabaseDefinitionGet ## NOTES diff --git a/src/Kusto/Kusto.Autorest/docs/Get-AzKustoClusterLanguageExtension.md b/src/Kusto/Kusto.Autorest/docs/Get-AzKustoClusterLanguageExtension.md index 9dfb02ddbb98..b946c6678afd 100644 --- a/src/Kusto/Kusto.Autorest/docs/Get-AzKustoClusterLanguageExtension.md +++ b/src/Kusto/Kusto.Autorest/docs/Get-AzKustoClusterLanguageExtension.md @@ -138,7 +138,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ILanguageExtension +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ILanguageExtension ## NOTES diff --git a/src/Kusto/Kusto.Autorest/docs/Get-AzKustoClusterOutboundNetworkDependencyEndpoint.md b/src/Kusto/Kusto.Autorest/docs/Get-AzKustoClusterOutboundNetworkDependencyEndpoint.md index 027432eee5e3..04cd80b4a01d 100644 --- a/src/Kusto/Kusto.Autorest/docs/Get-AzKustoClusterOutboundNetworkDependencyEndpoint.md +++ b/src/Kusto/Kusto.Autorest/docs/Get-AzKustoClusterOutboundNetworkDependencyEndpoint.md @@ -109,7 +109,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IOutboundNetworkDependenciesEndpoint +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IOutboundNetworkDependenciesEndpoint ## NOTES diff --git a/src/Kusto/Kusto.Autorest/docs/Get-AzKustoClusterPrincipalAssignment.md b/src/Kusto/Kusto.Autorest/docs/Get-AzKustoClusterPrincipalAssignment.md index 69f3f4be40ba..df06ba2f299e 100644 --- a/src/Kusto/Kusto.Autorest/docs/Get-AzKustoClusterPrincipalAssignment.md +++ b/src/Kusto/Kusto.Autorest/docs/Get-AzKustoClusterPrincipalAssignment.md @@ -30,6 +30,12 @@ Get-AzKustoClusterPrincipalAssignment -InputObject [-DefaultPro [] ``` +### GetViaIdentityCluster +``` +Get-AzKustoClusterPrincipalAssignment -ClusterInputObject -PrincipalAssignmentName + [-DefaultProfile ] [] +``` + ## DESCRIPTION Gets a Kusto cluster principalAssignment. @@ -63,6 +69,21 @@ The above command returns the Kusto cluster principalAssignment named "kustoprin ## PARAMETERS +### -ClusterInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: GetViaIdentityCluster +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ClusterName The name of the Kusto cluster. @@ -96,7 +117,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -115,7 +135,7 @@ The name of the Kusto principalAssignment. ```yaml Type: System.String -Parameter Sets: Get +Parameter Sets: Get, GetViaIdentityCluster Aliases: Required: True @@ -165,7 +185,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IClusterPrincipalAssignment +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IClusterPrincipalAssignment ## NOTES diff --git a/src/Kusto/Kusto.Autorest/docs/Get-AzKustoClusterSku.md b/src/Kusto/Kusto.Autorest/docs/Get-AzKustoClusterSku.md index 550fc7cd1db3..50931e920cb3 100644 --- a/src/Kusto/Kusto.Autorest/docs/Get-AzKustoClusterSku.md +++ b/src/Kusto/Kusto.Autorest/docs/Get-AzKustoClusterSku.md @@ -162,9 +162,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IAzureResourceSku +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IAzureResourceSku -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ISkuDescription +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ISkuDescription ## NOTES diff --git a/src/Kusto/Kusto.Autorest/docs/Get-AzKustoDataConnection.md b/src/Kusto/Kusto.Autorest/docs/Get-AzKustoDataConnection.md index 5d50c799b507..49d395ac2b6d 100644 --- a/src/Kusto/Kusto.Autorest/docs/Get-AzKustoDataConnection.md +++ b/src/Kusto/Kusto.Autorest/docs/Get-AzKustoDataConnection.md @@ -29,6 +29,18 @@ Get-AzKustoDataConnection -ClusterName -DatabaseName -Name [-DefaultProfile ] [] ``` +### GetViaIdentityCluster +``` +Get-AzKustoDataConnection -ClusterInputObject -DatabaseName -Name + [-DefaultProfile ] [] +``` + +### GetViaIdentityDatabase +``` +Get-AzKustoDataConnection -DatabaseInputObject -Name [-DefaultProfile ] + [] +``` + ## DESCRIPTION Returns a data connection. @@ -62,6 +74,21 @@ The above command returns the data connection named "mykustodataconnection" in d ## PARAMETERS +### -ClusterInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: GetViaIdentityCluster +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ClusterName The name of the Kusto cluster. @@ -77,12 +104,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DatabaseInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: GetViaIdentityDatabase +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -DatabaseName The name of the database in the Kusto cluster. ```yaml Type: System.String -Parameter Sets: Get, List +Parameter Sets: Get, GetViaIdentityCluster, List Aliases: Required: True @@ -110,7 +152,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -129,7 +170,7 @@ The name of the data connection. ```yaml Type: System.String -Parameter Sets: Get +Parameter Sets: Get, GetViaIdentityCluster, GetViaIdentityDatabase Aliases: DataConnectionName Required: True @@ -179,7 +220,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IDataConnection +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IDataConnection ## NOTES diff --git a/src/Kusto/Kusto.Autorest/docs/Get-AzKustoDatabase.md b/src/Kusto/Kusto.Autorest/docs/Get-AzKustoDatabase.md index 6da16d97644c..8d760d926dfd 100644 --- a/src/Kusto/Kusto.Autorest/docs/Get-AzKustoDatabase.md +++ b/src/Kusto/Kusto.Autorest/docs/Get-AzKustoDatabase.md @@ -29,6 +29,12 @@ Get-AzKustoDatabase -ClusterName -Name -ResourceGroupName [-DefaultProfile ] [] ``` +### GetViaIdentityCluster +``` +Get-AzKustoDatabase -ClusterInputObject -Name [-DefaultProfile ] + [] +``` + ## DESCRIPTION Returns a database. @@ -63,6 +69,21 @@ The above command returns the Kusto database named "mykustodatabase" in the clus ## PARAMETERS +### -ClusterInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: GetViaIdentityCluster +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ClusterName The name of the Kusto cluster. @@ -96,7 +117,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -115,7 +135,7 @@ The name of the database in the Kusto cluster. ```yaml Type: System.String -Parameter Sets: Get +Parameter Sets: Get, GetViaIdentityCluster Aliases: DatabaseName Required: True @@ -196,7 +216,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IDatabase +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IDatabase ## NOTES diff --git a/src/Kusto/Kusto.Autorest/docs/Get-AzKustoDatabasePrincipal.md b/src/Kusto/Kusto.Autorest/docs/Get-AzKustoDatabasePrincipal.md index ee5ece89a445..5c43eb52e718 100644 --- a/src/Kusto/Kusto.Autorest/docs/Get-AzKustoDatabasePrincipal.md +++ b/src/Kusto/Kusto.Autorest/docs/Get-AzKustoDatabasePrincipal.md @@ -153,7 +153,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IDatabasePrincipal +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IDatabasePrincipal ## NOTES diff --git a/src/Kusto/Kusto.Autorest/docs/Get-AzKustoDatabasePrincipalAssignment.md b/src/Kusto/Kusto.Autorest/docs/Get-AzKustoDatabasePrincipalAssignment.md index 5efc4067fdcb..90ceba9d055b 100644 --- a/src/Kusto/Kusto.Autorest/docs/Get-AzKustoDatabasePrincipalAssignment.md +++ b/src/Kusto/Kusto.Autorest/docs/Get-AzKustoDatabasePrincipalAssignment.md @@ -31,6 +31,18 @@ Get-AzKustoDatabasePrincipalAssignment -InputObject [-DefaultPr [] ``` +### GetViaIdentityCluster +``` +Get-AzKustoDatabasePrincipalAssignment -ClusterInputObject -DatabaseName + -PrincipalAssignmentName [-DefaultProfile ] [] +``` + +### GetViaIdentityDatabase +``` +Get-AzKustoDatabasePrincipalAssignment -DatabaseInputObject -PrincipalAssignmentName + [-DefaultProfile ] [] +``` + ## DESCRIPTION Gets a Kusto cluster database principalAssignment. @@ -66,6 +78,21 @@ The above command returns all all PrincipalAssignment named "kustoprincipal1" in ## PARAMETERS +### -ClusterInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: GetViaIdentityCluster +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ClusterName The name of the Kusto cluster. @@ -81,12 +108,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DatabaseInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: GetViaIdentityDatabase +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -DatabaseName The name of the database in the Kusto cluster. ```yaml Type: System.String -Parameter Sets: Get, List +Parameter Sets: Get, GetViaIdentityCluster, List Aliases: Required: True @@ -114,7 +156,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -133,7 +174,7 @@ The name of the Kusto principalAssignment. ```yaml Type: System.String -Parameter Sets: Get +Parameter Sets: Get, GetViaIdentityCluster, GetViaIdentityDatabase Aliases: Required: True @@ -183,7 +224,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IDatabasePrincipalAssignment +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IDatabasePrincipalAssignment ## NOTES diff --git a/src/Kusto/Kusto.Autorest/docs/Get-AzKustoManagedPrivateEndpoint.md b/src/Kusto/Kusto.Autorest/docs/Get-AzKustoManagedPrivateEndpoint.md index bbd428639743..8027a47c717c 100644 --- a/src/Kusto/Kusto.Autorest/docs/Get-AzKustoManagedPrivateEndpoint.md +++ b/src/Kusto/Kusto.Autorest/docs/Get-AzKustoManagedPrivateEndpoint.md @@ -30,6 +30,12 @@ Get-AzKustoManagedPrivateEndpoint -InputObject [-DefaultProfile [] ``` +### GetViaIdentityCluster +``` +Get-AzKustoManagedPrivateEndpoint -ClusterInputObject -Name + [-DefaultProfile ] [] +``` + ## DESCRIPTION Gets a managed private endpoint. @@ -64,6 +70,21 @@ The above command returns the Kusto ManagedPrivateEndpoint named "ManagedPrivate ## PARAMETERS +### -ClusterInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: GetViaIdentityCluster +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ClusterName The name of the Kusto cluster. @@ -97,7 +118,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -116,7 +136,7 @@ The name of the managed private endpoint. ```yaml Type: System.String -Parameter Sets: Get +Parameter Sets: Get, GetViaIdentityCluster Aliases: ManagedPrivateEndpointName Required: True @@ -166,7 +186,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IManagedPrivateEndpoint +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IManagedPrivateEndpoint ## NOTES diff --git a/src/Kusto/Kusto.Autorest/docs/Get-AzKustoOperationsResult.md b/src/Kusto/Kusto.Autorest/docs/Get-AzKustoOperationsResult.md index 80c2831f931a..c22ff053a38b 100644 --- a/src/Kusto/Kusto.Autorest/docs/Get-AzKustoOperationsResult.md +++ b/src/Kusto/Kusto.Autorest/docs/Get-AzKustoOperationsResult.md @@ -23,6 +23,12 @@ Get-AzKustoOperationsResult -Location -OperationId [-Subscript Get-AzKustoOperationsResult -InputObject [-DefaultProfile ] [] ``` +### GetViaIdentityLocation +``` +Get-AzKustoOperationsResult -LocationInputObject -OperationId + [-DefaultProfile ] [] +``` + ## DESCRIPTION Returns operation results. @@ -61,7 +67,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -90,12 +95,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -LocationInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: GetViaIdentityLocation +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -OperationId The ID of an ongoing async operation. ```yaml Type: System.String -Parameter Sets: Get +Parameter Sets: Get, GetViaIdentityLocation Aliases: Required: True @@ -129,7 +149,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IOperationResult +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IOperationResult ## NOTES diff --git a/src/Kusto/Kusto.Autorest/docs/Get-AzKustoOperationsResultLocation.md b/src/Kusto/Kusto.Autorest/docs/Get-AzKustoOperationsResultLocation.md index 76d943b42a2f..c1dfb7c6905d 100644 --- a/src/Kusto/Kusto.Autorest/docs/Get-AzKustoOperationsResultLocation.md +++ b/src/Kusto/Kusto.Autorest/docs/Get-AzKustoOperationsResultLocation.md @@ -24,6 +24,12 @@ Get-AzKustoOperationsResultLocation -InputObject [-DefaultProfi [] ``` +### GetViaIdentityLocation +``` +Get-AzKustoOperationsResultLocation -LocationInputObject -OperationId + [-DefaultProfile ] [-PassThru] [] +``` + ## DESCRIPTION Returns operation results. @@ -62,7 +68,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -91,12 +96,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -LocationInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: GetViaIdentityLocation +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -OperationId The ID of an ongoing async operation. ```yaml Type: System.String -Parameter Sets: Get +Parameter Sets: Get, GetViaIdentityLocation Aliases: Required: True diff --git a/src/Kusto/Kusto.Autorest/docs/Get-AzKustoPrivateEndpointConnection.md b/src/Kusto/Kusto.Autorest/docs/Get-AzKustoPrivateEndpointConnection.md deleted file mode 100644 index 1ddf2511e14e..000000000000 --- a/src/Kusto/Kusto.Autorest/docs/Get-AzKustoPrivateEndpointConnection.md +++ /dev/null @@ -1,174 +0,0 @@ ---- -external help file: -Module Name: Az.Kusto -online version: https://learn.microsoft.com/powershell/module/az.kusto/get-azkustoprivateendpointconnection -schema: 2.0.0 ---- - -# Get-AzKustoPrivateEndpointConnection - -## SYNOPSIS -Gets a private endpoint connection. - -## SYNTAX - -### List (Default) -``` -Get-AzKustoPrivateEndpointConnection -ClusterName -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [] -``` - -### Get -``` -Get-AzKustoPrivateEndpointConnection -ClusterName -Name -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [] -``` - -### GetViaIdentity -``` -Get-AzKustoPrivateEndpointConnection -InputObject [-DefaultProfile ] - [] -``` - -## DESCRIPTION -Gets a private endpoint connection. - -## EXAMPLES - -### Example 1: List all Kusto PrivateEndpointConnection in a cluster by name -```powershell -Get-AzKustoPrivateEndpointConnection -ClusterName "mycluster" -ResourceGroupName "testrg" -SubscriptionId "12345678-1234-1234-1234-123456789098" -``` - -```output -Name Type ----- ---- -privateEndpointConnectionName1 Microsoft.Kusto/Clusters/PrivateEndpointConnections -privateEndpointConnectionName2 Microsoft.Kusto/Clusters/PrivateEndpointConnections -``` - -The above command returns all Kusto PrivateEndpointConnection in the cluster "mycluster" found in the resource group "testrg". - -### Example 2: Get a specific Kusto PrivateEndpointConnection by name -```powershell -Get-AzKustoPrivateEndpointConnection -ClusterName "mycluster" -ResourceGroupName "testrg" -SubscriptionId "12345678-1234-1234-1234-123456789098" -Name "privateEndpointConnectionName" -``` - -```output -Name Type ----- ---- -privateEndpointConnectionName Microsoft.Kusto/Clusters/PrivateEndpointConnections -``` - -The above command returns the Kusto PrivateEndpointConnection named "privateEndpointConnectionName" in the cluster "mycluster" found in the resource group "testrg". - -## PARAMETERS - -### -ClusterName -The name of the Kusto cluster. - -```yaml -Type: System.String -Parameter Sets: Get, List -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 -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the private endpoint connection. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: PrivateEndpointConnectionName - -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. - -```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.Kusto.Models.IKustoIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IPrivateEndpointConnection - -## NOTES - -## RELATED LINKS - diff --git a/src/Kusto/Kusto.Autorest/docs/Get-AzKustoPrivateLinkResource.md b/src/Kusto/Kusto.Autorest/docs/Get-AzKustoPrivateLinkResource.md deleted file mode 100644 index 836462f8fe4a..000000000000 --- a/src/Kusto/Kusto.Autorest/docs/Get-AzKustoPrivateLinkResource.md +++ /dev/null @@ -1,172 +0,0 @@ ---- -external help file: -Module Name: Az.Kusto -online version: https://learn.microsoft.com/powershell/module/az.kusto/get-azkustoprivatelinkresource -schema: 2.0.0 ---- - -# Get-AzKustoPrivateLinkResource - -## SYNOPSIS -Gets a private link resource. - -## SYNTAX - -### List (Default) -``` -Get-AzKustoPrivateLinkResource -ClusterName -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [] -``` - -### Get -``` -Get-AzKustoPrivateLinkResource -ClusterName -Name -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [] -``` - -### GetViaIdentity -``` -Get-AzKustoPrivateLinkResource -InputObject [-DefaultProfile ] [] -``` - -## DESCRIPTION -Gets a private link resource. - -## EXAMPLES - -### Example 1: List all PrivateLinkResource in a cluster -```powershell -Get-AzKustoPrivateLinkResource -ClusterName "mycluster" -ResourceGroupName "testrg" -``` - -```output -Name Type ----- ---- -mycluster/cluster Microsoft.Kusto/Clusters/PrivateLinkResources -``` - -The above command returns all PrivateLinkResource in the cluster "mycluster" found in the resource group "testrg". - -### Example 2: Get a specific PrivateLinkResource by name -```powershell -Get-AzKustoPrivateLinkResource -ClusterName "mycluster" -ResourceGroupName "testrg" -Name "ManagedPrivateEndpointName" -``` - -```output -Name Type ----- ---- -mycluster/cluster Microsoft.Kusto/Clusters/PrivateLinkResources -``` - -The above command returns the PrivateLinkResource named "mycluster/cluster" in the cluster "mycluster" found in the resource group "testrg". - -## PARAMETERS - -### -ClusterName -The name of the Kusto cluster. - -```yaml -Type: System.String -Parameter Sets: Get, List -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 -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the private link resource. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: PrivateLinkResourceName - -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. - -```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.Kusto.Models.IKustoIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IPrivateLinkResource - -## NOTES - -## RELATED LINKS - diff --git a/src/Kusto/Kusto.Autorest/docs/Get-AzKustoSandboxCustomImage.md b/src/Kusto/Kusto.Autorest/docs/Get-AzKustoSandboxCustomImage.md index 5262b8a02318..6232a8732778 100644 --- a/src/Kusto/Kusto.Autorest/docs/Get-AzKustoSandboxCustomImage.md +++ b/src/Kusto/Kusto.Autorest/docs/Get-AzKustoSandboxCustomImage.md @@ -29,6 +29,12 @@ Get-AzKustoSandboxCustomImage -ClusterName -Name -ResourceGrou Get-AzKustoSandboxCustomImage -InputObject [-DefaultProfile ] [] ``` +### GetViaIdentityCluster +``` +Get-AzKustoSandboxCustomImage -ClusterInputObject -Name [-DefaultProfile ] + [] +``` + ## DESCRIPTION Returns a sandbox custom image @@ -62,6 +68,21 @@ The above command returns a Kusto sandbox custom image named "myImage" in cluste ## PARAMETERS +### -ClusterInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: GetViaIdentityCluster +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ClusterName The name of the Kusto cluster. @@ -95,7 +116,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -114,7 +134,7 @@ The name of the sandbox custom image. ```yaml Type: System.String -Parameter Sets: Get +Parameter Sets: Get, GetViaIdentityCluster Aliases: SandboxCustomImageName Required: True @@ -164,7 +184,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ISandboxCustomImage +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ISandboxCustomImage ## NOTES diff --git a/src/Kusto/Kusto.Autorest/docs/Get-AzKustoScript.md b/src/Kusto/Kusto.Autorest/docs/Get-AzKustoScript.md index 2d26e6f527c0..d3f7d6ba7f39 100644 --- a/src/Kusto/Kusto.Autorest/docs/Get-AzKustoScript.md +++ b/src/Kusto/Kusto.Autorest/docs/Get-AzKustoScript.md @@ -29,6 +29,18 @@ Get-AzKustoScript -ClusterName -DatabaseName -Name -R Get-AzKustoScript -InputObject [-DefaultProfile ] [] ``` +### GetViaIdentityCluster +``` +Get-AzKustoScript -ClusterInputObject -DatabaseName -Name + [-DefaultProfile ] [] +``` + +### GetViaIdentityDatabase +``` +Get-AzKustoScript -DatabaseInputObject -Name [-DefaultProfile ] + [] +``` + ## DESCRIPTION Gets a Kusto cluster database script. @@ -62,6 +74,21 @@ The above command returns the Kusto database script named "newkustoscript" in th ## PARAMETERS +### -ClusterInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: GetViaIdentityCluster +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ClusterName The name of the Kusto cluster. @@ -77,12 +104,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DatabaseInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: GetViaIdentityDatabase +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -DatabaseName The name of the database in the Kusto cluster. ```yaml Type: System.String -Parameter Sets: Get, List +Parameter Sets: Get, GetViaIdentityCluster, List Aliases: Required: True @@ -110,7 +152,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -129,7 +170,7 @@ The name of the Kusto database script. ```yaml Type: System.String -Parameter Sets: Get +Parameter Sets: Get, GetViaIdentityCluster, GetViaIdentityDatabase Aliases: ScriptName Required: True @@ -179,7 +220,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IScript +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IScript ## NOTES diff --git a/src/Kusto/Kusto.Autorest/docs/Get-AzKustoSku.md b/src/Kusto/Kusto.Autorest/docs/Get-AzKustoSku.md index 3a1331f6185c..b8c4f5fd5449 100644 --- a/src/Kusto/Kusto.Autorest/docs/Get-AzKustoSku.md +++ b/src/Kusto/Kusto.Autorest/docs/Get-AzKustoSku.md @@ -132,7 +132,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ISkuDescription +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ISkuDescription ## NOTES diff --git a/src/Kusto/Kusto.Autorest/docs/Invoke-AzKustoClusterMigration.md b/src/Kusto/Kusto.Autorest/docs/Invoke-AzKustoClusterMigration.md index 0cf2a1fb243e..9f45867a2bcf 100644 --- a/src/Kusto/Kusto.Autorest/docs/Invoke-AzKustoClusterMigration.md +++ b/src/Kusto/Kusto.Autorest/docs/Invoke-AzKustoClusterMigration.md @@ -38,6 +38,20 @@ Invoke-AzKustoClusterMigration -InputObject -ClusterResourceId [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] ``` +### MigrateViaJsonFilePath +``` +Invoke-AzKustoClusterMigration -Name -ResourceGroupName -JsonFilePath + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +### MigrateViaJsonString +``` +Invoke-AzKustoClusterMigration -Name -ResourceGroupName -JsonString + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + ## DESCRIPTION Migrate data from a Kusto cluster to another cluster. @@ -69,10 +83,9 @@ Accept wildcard characters: False ### -ClusterMigrateRequest A cluster migrate request. -To construct, see NOTES section for CLUSTERMIGRATEREQUEST properties and create a hash table. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IClusterMigrateRequest +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IClusterMigrateRequest Parameter Sets: Migrate, MigrateViaIdentity Aliases: @@ -116,7 +129,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -130,12 +142,42 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -JsonFilePath +Path of Json file supplied to the Migrate operation + +```yaml +Type: System.String +Parameter Sets: MigrateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Migrate operation + +```yaml +Type: System.String +Parameter Sets: MigrateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name The name of the Kusto cluster. ```yaml Type: System.String -Parameter Sets: Migrate, MigrateExpanded +Parameter Sets: Migrate, MigrateExpanded, MigrateViaJsonFilePath, MigrateViaJsonString Aliases: ClusterName Required: True @@ -181,7 +223,7 @@ The name is case insensitive. ```yaml Type: System.String -Parameter Sets: Migrate, MigrateExpanded +Parameter Sets: Migrate, MigrateExpanded, MigrateViaJsonFilePath, MigrateViaJsonString Aliases: Required: True @@ -196,7 +238,7 @@ The ID of the target subscription. ```yaml Type: System.String -Parameter Sets: Migrate, MigrateExpanded +Parameter Sets: Migrate, MigrateExpanded, MigrateViaJsonFilePath, MigrateViaJsonString Aliases: Required: False @@ -242,7 +284,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IClusterMigrateRequest +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IClusterMigrateRequest ### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity diff --git a/src/Kusto/Kusto.Autorest/docs/Invoke-AzKustoDataConnectionValidation.md b/src/Kusto/Kusto.Autorest/docs/Invoke-AzKustoDataConnectionValidation.md index b25ab47a2cd8..74ed345006fd 100644 --- a/src/Kusto/Kusto.Autorest/docs/Invoke-AzKustoDataConnectionValidation.md +++ b/src/Kusto/Kusto.Autorest/docs/Invoke-AzKustoDataConnectionValidation.md @@ -16,8 +16,8 @@ Checks that the data connection parameters are valid. ``` Invoke-AzKustoDataConnectionValidation -ClusterName -DatabaseName -ResourceGroupName -ConsumerGroup -DataConnectionName -EventHubResourceId - -Kind -Location [-SubscriptionId ] [-Compression ] - [-DatabaseRouting ] [-DataFormat ] [-EventSystemProperty ] + -Kind -Location [-SubscriptionId ] [-Compression ] + [-DatabaseRouting ] [-DataFormat ] [-EventSystemProperty ] [-ManagedIdentityResourceId ] [-MappingRuleName ] [-RetrievalStartDate ] [-TableName ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] ``` @@ -26,8 +26,8 @@ Invoke-AzKustoDataConnectionValidation -ClusterName -DatabaseName -DatabaseName -ResourceGroupName -ConsumerGroup -DataConnectionName -EventHubResourceId - -Kind -Location -StorageAccountResourceId [-SubscriptionId ] - [-DatabaseRouting ] [-DataFormat ] [-EventGridResourceId ] + -Kind -Location -StorageAccountResourceId [-SubscriptionId ] + [-DatabaseRouting ] [-DataFormat ] [-EventGridResourceId ] [-ManagedIdentityResourceId ] [-MappingRuleName ] [-TableName ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] ``` @@ -36,8 +36,8 @@ Invoke-AzKustoDataConnectionValidation -ClusterName -DatabaseName -DatabaseName -ResourceGroupName -ConsumerGroup -DataConnectionName -IotHubResourceId - -Kind -Location -SharedAccessPolicyName [-SubscriptionId ] - [-DatabaseRouting ] [-DataFormat ] [-EventSystemProperty ] + -Kind -Location -SharedAccessPolicyName [-SubscriptionId ] + [-DatabaseRouting ] [-DataFormat ] [-EventSystemProperty ] [-MappingRuleName ] [-RetrievalStartDate ] [-TableName ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] ``` @@ -45,8 +45,8 @@ Invoke-AzKustoDataConnectionValidation -ClusterName -DatabaseName -ConsumerGroup - -DataConnectionName -EventHubResourceId -Kind -Location - -StorageAccountResourceId [-DatabaseRouting ] [-DataFormat ] + -DataConnectionName -EventHubResourceId -Kind -Location + -StorageAccountResourceId [-DatabaseRouting ] [-DataFormat ] [-EventGridResourceId ] [-ManagedIdentityResourceId ] [-MappingRuleName ] [-TableName ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] ``` @@ -54,34 +54,33 @@ Invoke-AzKustoDataConnectionValidation -InputObject -ConsumerGr ### DataViaIdentityExpandedEventHub ``` Invoke-AzKustoDataConnectionValidation -InputObject -ConsumerGroup - -DataConnectionName -EventHubResourceId -Kind -Location - [-Compression ] [-DatabaseRouting ] [-DataFormat ] - [-EventSystemProperty ] [-ManagedIdentityResourceId ] [-MappingRuleName ] - [-RetrievalStartDate ] [-TableName ] [-DefaultProfile ] [-Confirm] [-WhatIf] - [] + -DataConnectionName -EventHubResourceId -Kind -Location + [-Compression ] [-DatabaseRouting ] [-DataFormat ] [-EventSystemProperty ] + [-ManagedIdentityResourceId ] [-MappingRuleName ] [-RetrievalStartDate ] + [-TableName ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] ``` ### DataViaIdentityExpandedIotHub ``` Invoke-AzKustoDataConnectionValidation -InputObject -ConsumerGroup - -DataConnectionName -IotHubResourceId -Kind -Location - -SharedAccessPolicyName [-DatabaseRouting ] [-DataFormat ] + -DataConnectionName -IotHubResourceId -Kind -Location + -SharedAccessPolicyName [-DatabaseRouting ] [-DataFormat ] [-EventSystemProperty ] [-MappingRuleName ] [-RetrievalStartDate ] [-TableName ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] ``` ### UpdateExpandedEventGrid ``` -Invoke-AzKustoDataConnectionValidation -ConsumerGroup -DataConnectionName -Kind - -Location [-BlobStorageEventType ] [-DataFormat ] [-IgnoreFirstRecord] +Invoke-AzKustoDataConnectionValidation -ConsumerGroup -DataConnectionName -Kind + -Location [-BlobStorageEventType ] [-DataFormat ] [-IgnoreFirstRecord] [-MappingRuleName ] [-TableName ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] ``` ### UpdateViaIdentityExpandedEventGrid ``` -Invoke-AzKustoDataConnectionValidation -ConsumerGroup -DataConnectionName -Kind - -Location [-BlobStorageEventType ] [-DataFormat ] [-IgnoreFirstRecord] +Invoke-AzKustoDataConnectionValidation -ConsumerGroup -DataConnectionName -Kind + -Location [-BlobStorageEventType ] [-DataFormat ] [-IgnoreFirstRecord] [-MappingRuleName ] [-TableName ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] ``` @@ -178,7 +177,7 @@ The above command validates IotHub data connection named "myiothubdc" for the da The name of blob storage event type to process. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.BlobStorageEventType +Type: System.String Parameter Sets: UpdateExpandedEventGrid, UpdateViaIdentityExpandedEventGrid Aliases: @@ -208,7 +207,7 @@ Accept wildcard characters: False The event hub messages compression type. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.Compression +Type: System.String Parameter Sets: DataExpandedEventHub, DataViaIdentityExpandedEventHub Aliases: @@ -253,7 +252,7 @@ Accept wildcard characters: False Indication for database routing information from the data connection, by default only database routing information is allowed. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.DatabaseRouting +Type: System.String Parameter Sets: DataExpandedEventGrid, DataExpandedEventHub, DataExpandedIotHub, DataViaIdentityExpandedEventGrid, DataViaIdentityExpandedEventHub, DataViaIdentityExpandedIotHub Aliases: @@ -405,7 +404,7 @@ Accept wildcard characters: False Kind of the endpoint for the data connection ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.Kind +Type: System.String Parameter Sets: (All) Aliases: @@ -595,7 +594,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IDataConnectionValidationResult +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IDataConnectionValidationResult ## NOTES diff --git a/src/Kusto/Kusto.Autorest/docs/Invoke-AzKustoDetachClusterFollowerDatabase.md b/src/Kusto/Kusto.Autorest/docs/Invoke-AzKustoDetachClusterFollowerDatabase.md index b229ab4669c6..3c46aa233f59 100644 --- a/src/Kusto/Kusto.Autorest/docs/Invoke-AzKustoDetachClusterFollowerDatabase.md +++ b/src/Kusto/Kusto.Autorest/docs/Invoke-AzKustoDetachClusterFollowerDatabase.md @@ -26,6 +26,20 @@ Invoke-AzKustoDetachClusterFollowerDatabase -InputObject [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] ``` +### DetachViaJsonFilePath +``` +Invoke-AzKustoDetachClusterFollowerDatabase -ClusterName -ResourceGroupName + -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +### DetachViaJsonString +``` +Invoke-AzKustoDetachClusterFollowerDatabase -ClusterName -ResourceGroupName + -JsonString [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-Confirm] [-WhatIf] [] +``` + ## DESCRIPTION Detaches all followers of a database owned by this cluster. @@ -60,7 +74,7 @@ Resource name of the attached database configuration in the follower cluster. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: DetachExpanded, DetachViaIdentityExpanded Aliases: Required: True @@ -75,7 +89,7 @@ The name of the Kusto cluster. ```yaml Type: System.String -Parameter Sets: DetachExpanded +Parameter Sets: DetachExpanded, DetachViaJsonFilePath, DetachViaJsonString Aliases: Required: True @@ -90,7 +104,7 @@ Resource id of the cluster that follows a database owned by this cluster. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: DetachExpanded, DetachViaIdentityExpanded Aliases: Required: True @@ -118,7 +132,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -132,6 +145,36 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -JsonFilePath +Path of Json file supplied to the Detach operation + +```yaml +Type: System.String +Parameter Sets: DetachViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Detach operation + +```yaml +Type: System.String +Parameter Sets: DetachViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -NoWait Run the command asynchronously @@ -168,7 +211,7 @@ The name is case insensitive. ```yaml Type: System.String -Parameter Sets: DetachExpanded +Parameter Sets: DetachExpanded, DetachViaJsonFilePath, DetachViaJsonString Aliases: Required: True @@ -183,7 +226,7 @@ The ID of the target subscription. ```yaml Type: System.String -Parameter Sets: DetachExpanded +Parameter Sets: DetachExpanded, DetachViaJsonFilePath, DetachViaJsonString Aliases: Required: False diff --git a/src/Kusto/Kusto.Autorest/docs/Invoke-AzKustoDiagnoseClusterVirtualNetwork.md b/src/Kusto/Kusto.Autorest/docs/Invoke-AzKustoDiagnoseClusterVirtualNetwork.md index 61fd6f665241..f884c0c0f2dc 100644 --- a/src/Kusto/Kusto.Autorest/docs/Invoke-AzKustoDiagnoseClusterVirtualNetwork.md +++ b/src/Kusto/Kusto.Autorest/docs/Invoke-AzKustoDiagnoseClusterVirtualNetwork.md @@ -87,7 +87,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -187,7 +186,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### System.String +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IDiagnoseVirtualNetworkResult ## NOTES diff --git a/src/Kusto/Kusto.Autorest/docs/Invoke-AzKustoInviteDatabaseFollower.md b/src/Kusto/Kusto.Autorest/docs/Invoke-AzKustoInviteDatabaseFollower.md index b8c5e4dbed81..41559d10b9bb 100644 --- a/src/Kusto/Kusto.Autorest/docs/Invoke-AzKustoInviteDatabaseFollower.md +++ b/src/Kusto/Kusto.Autorest/docs/Invoke-AzKustoInviteDatabaseFollower.md @@ -39,6 +39,26 @@ Invoke-AzKustoInviteDatabaseFollower -InputObject -Parameter ] [-Confirm] [-WhatIf] [] ``` +### InviteViaIdentityCluster +``` +Invoke-AzKustoInviteDatabaseFollower -ClusterInputObject -DatabaseName + -Parameter [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### InviteViaIdentityClusterExpanded +``` +Invoke-AzKustoInviteDatabaseFollower -ClusterInputObject -DatabaseName + -InviteeEmail [-TableLevelSharingPropertyExternalTablesToExclude ] + [-TableLevelSharingPropertyExternalTablesToInclude ] + [-TableLevelSharingPropertyFunctionsToExclude ] + [-TableLevelSharingPropertyFunctionsToInclude ] + [-TableLevelSharingPropertyMaterializedViewsToExclude ] + [-TableLevelSharingPropertyMaterializedViewsToInclude ] + [-TableLevelSharingPropertyTablesToExclude ] [-TableLevelSharingPropertyTablesToInclude ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + ### InviteViaIdentityExpanded ``` Invoke-AzKustoInviteDatabaseFollower -InputObject -InviteeEmail @@ -52,6 +72,20 @@ Invoke-AzKustoInviteDatabaseFollower -InputObject -InviteeEmail [-DefaultProfile ] [-Confirm] [-WhatIf] [] ``` +### InviteViaJsonFilePath +``` +Invoke-AzKustoInviteDatabaseFollower -ClusterName -DatabaseName -ResourceGroupName + -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### InviteViaJsonString +``` +Invoke-AzKustoInviteDatabaseFollower -ClusterName -DatabaseName -ResourceGroupName + -JsonString [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + ## DESCRIPTION Generates an invitation token that allows attaching a follower database to this database. @@ -66,12 +100,27 @@ Invite a user to follow database "myDatabase" in cluster "myCluster" in resource ## PARAMETERS +### -ClusterInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: InviteViaIdentityCluster, InviteViaIdentityClusterExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ClusterName The name of the Kusto cluster. ```yaml Type: System.String -Parameter Sets: Invite, InviteExpanded +Parameter Sets: Invite, InviteExpanded, InviteViaJsonFilePath, InviteViaJsonString Aliases: Required: True @@ -86,7 +135,7 @@ The name of the database in the Kusto cluster. ```yaml Type: System.String -Parameter Sets: Invite, InviteExpanded +Parameter Sets: Invite, InviteExpanded, InviteViaIdentityCluster, InviteViaIdentityClusterExpanded, InviteViaJsonFilePath, InviteViaJsonString Aliases: Required: True @@ -114,7 +163,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -133,7 +181,37 @@ The email of the invited user for which the follower invitation is generated. ```yaml Type: System.String -Parameter Sets: InviteExpanded, InviteViaIdentityExpanded +Parameter Sets: InviteExpanded, InviteViaIdentityClusterExpanded, InviteViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Invite operation + +```yaml +Type: System.String +Parameter Sets: InviteViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Invite operation + +```yaml +Type: System.String +Parameter Sets: InviteViaJsonString Aliases: Required: True @@ -145,11 +223,10 @@ Accept wildcard characters: False ### -Parameter The request to invite a follower to a database. -To construct, see NOTES section for PARAMETER properties and create a hash table. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IDatabaseInviteFollowerRequest -Parameter Sets: Invite, InviteViaIdentity +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IDatabaseInviteFollowerRequest +Parameter Sets: Invite, InviteViaIdentity, InviteViaIdentityCluster Aliases: Required: True @@ -165,7 +242,7 @@ The name is case insensitive. ```yaml Type: System.String -Parameter Sets: Invite, InviteExpanded +Parameter Sets: Invite, InviteExpanded, InviteViaJsonFilePath, InviteViaJsonString Aliases: Required: True @@ -180,7 +257,7 @@ The ID of the target subscription. ```yaml Type: System.String -Parameter Sets: Invite, InviteExpanded +Parameter Sets: Invite, InviteExpanded, InviteViaJsonFilePath, InviteViaJsonString Aliases: Required: False @@ -195,7 +272,7 @@ List of external tables to exclude from the follower database ```yaml Type: System.String[] -Parameter Sets: InviteExpanded, InviteViaIdentityExpanded +Parameter Sets: InviteExpanded, InviteViaIdentityClusterExpanded, InviteViaIdentityExpanded Aliases: Required: False @@ -210,7 +287,7 @@ List of external tables to include in the follower database ```yaml Type: System.String[] -Parameter Sets: InviteExpanded, InviteViaIdentityExpanded +Parameter Sets: InviteExpanded, InviteViaIdentityClusterExpanded, InviteViaIdentityExpanded Aliases: Required: False @@ -225,7 +302,7 @@ List of functions to exclude from the follower database ```yaml Type: System.String[] -Parameter Sets: InviteExpanded, InviteViaIdentityExpanded +Parameter Sets: InviteExpanded, InviteViaIdentityClusterExpanded, InviteViaIdentityExpanded Aliases: Required: False @@ -240,7 +317,7 @@ List of functions to include in the follower database ```yaml Type: System.String[] -Parameter Sets: InviteExpanded, InviteViaIdentityExpanded +Parameter Sets: InviteExpanded, InviteViaIdentityClusterExpanded, InviteViaIdentityExpanded Aliases: Required: False @@ -255,7 +332,7 @@ List of materialized views to exclude from the follower database ```yaml Type: System.String[] -Parameter Sets: InviteExpanded, InviteViaIdentityExpanded +Parameter Sets: InviteExpanded, InviteViaIdentityClusterExpanded, InviteViaIdentityExpanded Aliases: Required: False @@ -270,7 +347,7 @@ List of materialized views to include in the follower database ```yaml Type: System.String[] -Parameter Sets: InviteExpanded, InviteViaIdentityExpanded +Parameter Sets: InviteExpanded, InviteViaIdentityClusterExpanded, InviteViaIdentityExpanded Aliases: Required: False @@ -285,7 +362,7 @@ List of tables to exclude from the follower database ```yaml Type: System.String[] -Parameter Sets: InviteExpanded, InviteViaIdentityExpanded +Parameter Sets: InviteExpanded, InviteViaIdentityClusterExpanded, InviteViaIdentityExpanded Aliases: Required: False @@ -300,7 +377,7 @@ List of tables to include in the follower database ```yaml Type: System.String[] -Parameter Sets: InviteExpanded, InviteViaIdentityExpanded +Parameter Sets: InviteExpanded, InviteViaIdentityClusterExpanded, InviteViaIdentityExpanded Aliases: Required: False @@ -346,13 +423,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IDatabaseInviteFollowerRequest +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IDatabaseInviteFollowerRequest ### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity ## OUTPUTS -### System.String +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IDatabaseInviteFollowerResult ## NOTES diff --git a/src/Kusto/Kusto.Autorest/docs/New-AzKustoAttachedDatabaseConfiguration.md b/src/Kusto/Kusto.Autorest/docs/New-AzKustoAttachedDatabaseConfiguration.md index 8b08bfb4a991..9031e07206f2 100644 --- a/src/Kusto/Kusto.Autorest/docs/New-AzKustoAttachedDatabaseConfiguration.md +++ b/src/Kusto/Kusto.Autorest/docs/New-AzKustoAttachedDatabaseConfiguration.md @@ -8,15 +8,30 @@ schema: 2.0.0 # New-AzKustoAttachedDatabaseConfiguration ## SYNOPSIS -Creates or updates an attached database configuration. +Create an attached database configuration. ## SYNTAX +### CreateExpanded (Default) ``` New-AzKustoAttachedDatabaseConfiguration -ClusterName -Name -ResourceGroupName [-SubscriptionId ] [-ClusterResourceId ] [-DatabaseName ] - [-DatabaseNameOverride ] [-DatabaseNamePrefix ] - [-DefaultPrincipalsModificationKind ] [-Location ] + [-DatabaseNameOverride ] [-DatabaseNamePrefix ] [-DefaultPrincipalsModificationKind ] + [-Location ] [-TableLevelSharingPropertyExternalTablesToExclude ] + [-TableLevelSharingPropertyExternalTablesToInclude ] + [-TableLevelSharingPropertyFunctionsToExclude ] + [-TableLevelSharingPropertyFunctionsToInclude ] + [-TableLevelSharingPropertyMaterializedViewsToExclude ] + [-TableLevelSharingPropertyMaterializedViewsToInclude ] + [-TableLevelSharingPropertyTablesToExclude ] [-TableLevelSharingPropertyTablesToInclude ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### CreateViaIdentityClusterExpanded +``` +New-AzKustoAttachedDatabaseConfiguration -ClusterInputObject -Name + [-ClusterResourceId ] [-DatabaseName ] [-DatabaseNameOverride ] + [-DatabaseNamePrefix ] [-DefaultPrincipalsModificationKind ] [-Location ] [-TableLevelSharingPropertyExternalTablesToExclude ] [-TableLevelSharingPropertyExternalTablesToInclude ] [-TableLevelSharingPropertyFunctionsToExclude ] @@ -27,8 +42,22 @@ New-AzKustoAttachedDatabaseConfiguration -ClusterName -Name -R [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] ``` +### CreateViaJsonFilePath +``` +New-AzKustoAttachedDatabaseConfiguration -ClusterName -Name -ResourceGroupName + -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +### CreateViaJsonString +``` +New-AzKustoAttachedDatabaseConfiguration -ClusterName -Name -ResourceGroupName + -JsonString [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + ## DESCRIPTION -Creates or updates an attached database configuration. +Create an attached database configuration. ## EXAMPLES @@ -63,12 +92,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ClusterInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: CreateViaIdentityClusterExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ClusterName The name of the Kusto cluster. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString Aliases: Required: True @@ -83,7 +127,7 @@ The resource id of the cluster where the databases you would like to attach resi ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded Aliases: Required: False @@ -98,7 +142,7 @@ The name of the database which you would like to attach, use * if you want to fo ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded Aliases: Required: False @@ -114,7 +158,7 @@ Relevant only when attaching to a specific database. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded Aliases: Required: False @@ -130,7 +174,7 @@ When following an entire cluster, that prefix would be added to all of the datab ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded Aliases: Required: False @@ -144,8 +188,8 @@ Accept wildcard characters: False The default principals modification kind ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.DefaultPrincipalsModificationKind -Parameter Sets: (All) +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded Aliases: Required: False @@ -171,12 +215,42 @@ 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 +``` + ### -Location Resource location. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded Aliases: Required: False @@ -222,7 +296,7 @@ The name is case insensitive. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString Aliases: Required: True @@ -237,7 +311,7 @@ The ID of the target subscription. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString Aliases: Required: False @@ -252,7 +326,7 @@ List of external tables to exclude from the follower database ```yaml Type: System.String[] -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded Aliases: Required: False @@ -267,7 +341,7 @@ List of external tables to include in the follower database ```yaml Type: System.String[] -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded Aliases: Required: False @@ -282,7 +356,7 @@ List of functions to exclude from the follower database ```yaml Type: System.String[] -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded Aliases: Required: False @@ -297,7 +371,7 @@ List of functions to include in the follower database ```yaml Type: System.String[] -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded Aliases: Required: False @@ -312,7 +386,7 @@ List of materialized views to exclude from the follower database ```yaml Type: System.String[] -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded Aliases: Required: False @@ -327,7 +401,7 @@ List of materialized views to include in the follower database ```yaml Type: System.String[] -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded Aliases: Required: False @@ -342,7 +416,7 @@ List of tables to exclude from the follower database ```yaml Type: System.String[] -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded Aliases: Required: False @@ -357,7 +431,7 @@ List of tables to include in the follower database ```yaml Type: System.String[] -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded Aliases: Required: False @@ -403,9 +477,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity + ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IAttachedDatabaseConfiguration +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IAttachedDatabaseConfiguration ## NOTES diff --git a/src/Kusto/Kusto.Autorest/docs/New-AzKustoCluster.md b/src/Kusto/Kusto.Autorest/docs/New-AzKustoCluster.md index cd42d82106cc..a6348bcbe9a5 100644 --- a/src/Kusto/Kusto.Autorest/docs/New-AzKustoCluster.md +++ b/src/Kusto/Kusto.Autorest/docs/New-AzKustoCluster.md @@ -8,31 +8,46 @@ schema: 2.0.0 # New-AzKustoCluster ## SYNOPSIS -Create or update a Kusto cluster. +Create a Kusto cluster. ## SYNTAX +### CreateExpanded (Default) ``` -New-AzKustoCluster -Name -ResourceGroupName -Location -SkuName - -SkuTier [-SubscriptionId ] [-IfMatch ] [-IfNoneMatch ] +New-AzKustoCluster -Name -ResourceGroupName -Location -SkuName + -SkuTier [-SubscriptionId ] [-IfMatch ] [-IfNoneMatch ] [-AcceptedAudience ] [-AllowedFqdnList ] [-AllowedIPRangeList ] [-CalloutPolicy ] [-EnableAutoStop] [-EnableDiskEncryption] [-EnableDoubleEncryption] - [-EnablePurge] [-EnableStreamingIngest] [-EngineType ] [-IdentityType ] - [-IdentityUserAssignedIdentity ] [-KeyVaultPropertyKeyName ] - [-KeyVaultPropertyKeyVaultUri ] [-KeyVaultPropertyKeyVersion ] - [-KeyVaultPropertyUserIdentity ] [-LanguageExtensionValue ] - [-OptimizedAutoscaleIsEnabled] [-OptimizedAutoscaleMaximum ] [-OptimizedAutoscaleMinimum ] - [-OptimizedAutoscaleVersion ] [-PublicIPType ] - [-PublicNetworkAccess ] [-RestrictOutboundNetworkAccess ] - [-SkuCapacity ] [-Tag ] [-TrustedExternalTenant ] + [-EnablePurge] [-EnableStreamingIngest] [-EnableSystemAssignedIdentity] [-EngineType ] + [-KeyVaultPropertyKeyName ] [-KeyVaultPropertyKeyVaultUri ] + [-KeyVaultPropertyKeyVersion ] [-KeyVaultPropertyUserIdentity ] + [-LanguageExtensionValue ] [-OptimizedAutoscaleIsEnabled] + [-OptimizedAutoscaleMaximum ] [-OptimizedAutoscaleMinimum ] + [-OptimizedAutoscaleVersion ] [-PublicIPType ] [-PublicNetworkAccess ] + [-RestrictOutboundNetworkAccess ] [-SkuCapacity ] [-Tag ] + [-TrustedExternalTenant ] [-UserAssignedIdentity ] [-VirtualClusterGraduationProperty ] [-VirtualNetworkConfigurationDataManagementPublicIPId ] - [-VirtualNetworkConfigurationEnginePublicIPId ] [-VirtualNetworkConfigurationState ] + [-VirtualNetworkConfigurationEnginePublicIPId ] [-VirtualNetworkConfigurationState ] [-VirtualNetworkConfigurationSubnetId ] [-Zone ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] ``` +### CreateViaJsonFilePath +``` +New-AzKustoCluster -Name -ResourceGroupName -JsonFilePath + [-SubscriptionId ] [-IfMatch ] [-IfNoneMatch ] [-DefaultProfile ] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### CreateViaJsonString +``` +New-AzKustoCluster -Name -ResourceGroupName -JsonString [-SubscriptionId ] + [-IfMatch ] [-IfNoneMatch ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + ## DESCRIPTION -Create or update a Kusto cluster. +Create a Kusto cluster. ## EXAMPLES @@ -53,11 +68,10 @@ The above command creates a new Kusto cluster named "testnewkustocluster" in the ### -AcceptedAudience The cluster's accepted audiences. -To construct, see NOTES section for ACCEPTEDAUDIENCE properties and create a hash table. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IAcceptedAudiences[] -Parameter Sets: (All) +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IAcceptedAudiences[] +Parameter Sets: CreateExpanded Aliases: Required: False @@ -72,7 +86,7 @@ List of allowed FQDNs(Fully Qualified Domain Name) for egress from Cluster. ```yaml Type: System.String[] -Parameter Sets: (All) +Parameter Sets: CreateExpanded Aliases: Required: False @@ -87,7 +101,7 @@ The list of ips in the format of CIDR allowed to connect to the cluster. ```yaml Type: System.String[] -Parameter Sets: (All) +Parameter Sets: CreateExpanded Aliases: Required: False @@ -114,11 +128,10 @@ Accept wildcard characters: False ### -CalloutPolicy List of callout policies for egress from Cluster. -To construct, see NOTES section for CALLOUTPOLICY properties and create a hash table. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ICalloutPolicy[] -Parameter Sets: (All) +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ICalloutPolicy[] +Parameter Sets: CreateExpanded Aliases: Required: False @@ -149,7 +162,7 @@ A boolean value that indicates if the cluster could be automatically stopped (du ```yaml Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) +Parameter Sets: CreateExpanded Aliases: Required: False @@ -164,7 +177,7 @@ A boolean value that indicates if the cluster's disks are encrypted. ```yaml Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) +Parameter Sets: CreateExpanded Aliases: Required: False @@ -179,7 +192,7 @@ A boolean value that indicates if double encryption is enabled. ```yaml Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) +Parameter Sets: CreateExpanded Aliases: Required: False @@ -194,7 +207,7 @@ A boolean value that indicates if the purge operations are enabled. ```yaml Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) +Parameter Sets: CreateExpanded Aliases: Required: False @@ -209,7 +222,22 @@ A boolean value that indicates if the streaming ingest is enabled. ```yaml Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableSystemAssignedIdentity +Determines whether to enable a system-assigned identity for the resource. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CreateExpanded Aliases: Required: False @@ -223,8 +251,8 @@ Accept wildcard characters: False The engine type ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.EngineType -Parameter Sets: (All) +Type: System.String +Parameter Sets: CreateExpanded Aliases: Required: False @@ -234,13 +262,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IdentityType -The type of managed identity used. -The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. -The type 'None' will remove all identities. +### -IfMatch +The ETag of the cluster. +Omit this value to always overwrite the current cluster. +Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.IdentityType +Type: System.String Parameter Sets: (All) Aliases: @@ -251,12 +279,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IdentityUserAssignedIdentity -The list of user identities associated with the Kusto cluster. -The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. +### -IfNoneMatch +Set to '*' to allow a new cluster to be created, but to prevent updating an existing cluster. +Other values will result in a 412 Pre-condition Failed response. ```yaml -Type: System.Collections.Hashtable +Type: System.String Parameter Sets: (All) Aliases: @@ -267,33 +295,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IfMatch -The ETag of the cluster. -Omit this value to always overwrite the current cluster. -Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes. +### -JsonFilePath +Path of Json file supplied to the Create operation ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateViaJsonFilePath Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -IfNoneMatch -Set to '*' to allow a new cluster to be created, but to prevent updating an existing cluster. -Other values will result in a 412 Pre-condition Failed response. +### -JsonString +Json string supplied to the Create operation ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateViaJsonString Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -305,7 +330,7 @@ The name of the key vault key. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded Aliases: Required: False @@ -320,7 +345,7 @@ The Uri of the key vault. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded Aliases: Required: False @@ -335,7 +360,7 @@ The version of the key vault key. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded Aliases: Required: False @@ -350,7 +375,7 @@ The user assigned identity (ARM resource id) that has access to the key. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded Aliases: Required: False @@ -362,11 +387,10 @@ Accept wildcard characters: False ### -LanguageExtensionValue The list of language extensions. -To construct, see NOTES section for LANGUAGEEXTENSIONVALUE properties and create a hash table. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ILanguageExtension[] -Parameter Sets: (All) +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ILanguageExtension[] +Parameter Sets: CreateExpanded Aliases: Required: False @@ -381,7 +405,7 @@ The geo-location where the resource lives ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded Aliases: Required: True @@ -426,7 +450,7 @@ A boolean value that indicate if the optimized autoscale feature is enabled or n ```yaml Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) +Parameter Sets: CreateExpanded Aliases: Required: False @@ -441,7 +465,7 @@ Maximum allowed instances count. ```yaml Type: System.Int32 -Parameter Sets: (All) +Parameter Sets: CreateExpanded Aliases: Required: False @@ -456,7 +480,7 @@ Minimum allowed instances count. ```yaml Type: System.Int32 -Parameter Sets: (All) +Parameter Sets: CreateExpanded Aliases: Required: False @@ -471,7 +495,7 @@ The version of the template defined, for instance 1. ```yaml Type: System.Int32 -Parameter Sets: (All) +Parameter Sets: CreateExpanded Aliases: Required: False @@ -485,8 +509,8 @@ Accept wildcard characters: False Indicates what public IP type to create - IPv4 (default), or DualStack (both IPv4 and IPv6) ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.PublicIPType -Parameter Sets: (All) +Type: System.String +Parameter Sets: CreateExpanded Aliases: Required: False @@ -501,8 +525,8 @@ Public network access to the cluster is enabled by default. When disabled, only private endpoint connection to the cluster is allowed ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.PublicNetworkAccess -Parameter Sets: (All) +Type: System.String +Parameter Sets: CreateExpanded Aliases: Required: False @@ -533,8 +557,8 @@ Whether or not to restrict outbound network access. Value is optional but if passed in, must be 'Enabled' or 'Disabled' ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.ClusterNetworkAccessFlag -Parameter Sets: (All) +Type: System.String +Parameter Sets: CreateExpanded Aliases: Required: False @@ -549,7 +573,7 @@ The number of instances of the cluster. ```yaml Type: System.Int32 -Parameter Sets: (All) +Parameter Sets: CreateExpanded Aliases: Required: False @@ -563,8 +587,8 @@ Accept wildcard characters: False SKU name. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.AzureSkuName -Parameter Sets: (All) +Type: System.String +Parameter Sets: CreateExpanded Aliases: Required: True @@ -578,8 +602,8 @@ Accept wildcard characters: False SKU tier. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.AzureSkuTier -Parameter Sets: (All) +Type: System.String +Parameter Sets: CreateExpanded Aliases: Required: True @@ -609,7 +633,7 @@ Resource tags. ```yaml Type: System.Collections.Hashtable -Parameter Sets: (All) +Parameter Sets: CreateExpanded Aliases: Required: False @@ -621,11 +645,26 @@ Accept wildcard characters: False ### -TrustedExternalTenant The cluster's external tenants. -To construct, see NOTES section for TRUSTEDEXTERNALTENANT properties and create a hash table. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ITrustedExternalTenant[] -Parameter Sets: (All) +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ITrustedExternalTenant[] +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +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: CreateExpanded Aliases: Required: False @@ -640,7 +679,7 @@ Virtual Cluster graduation properties ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded Aliases: Required: False @@ -655,7 +694,7 @@ Data management's service public IP address resource id. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded Aliases: Required: False @@ -670,7 +709,7 @@ Engine service's public IP address resource id. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded Aliases: Required: False @@ -684,8 +723,8 @@ Accept wildcard characters: False When enabled, the cluster is deployed into the configured subnet, when disabled it will be removed from the subnet. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.VnetState -Parameter Sets: (All) +Type: System.String +Parameter Sets: CreateExpanded Aliases: Required: False @@ -700,7 +739,7 @@ The subnet resource id. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded Aliases: Required: False @@ -715,7 +754,7 @@ The availability zones of the cluster. ```yaml Type: System.String[] -Parameter Sets: (All) +Parameter Sets: CreateExpanded Aliases: Required: False @@ -763,7 +802,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ICluster +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ICluster ## NOTES diff --git a/src/Kusto/Kusto.Autorest/docs/New-AzKustoClusterPrincipalAssignment.md b/src/Kusto/Kusto.Autorest/docs/New-AzKustoClusterPrincipalAssignment.md index 236df3793fd5..3ac08c11a63c 100644 --- a/src/Kusto/Kusto.Autorest/docs/New-AzKustoClusterPrincipalAssignment.md +++ b/src/Kusto/Kusto.Autorest/docs/New-AzKustoClusterPrincipalAssignment.md @@ -12,13 +12,35 @@ Create a Kusto cluster principalAssignment. ## SYNTAX +### CreateExpanded (Default) ``` New-AzKustoClusterPrincipalAssignment -ClusterName -PrincipalAssignmentName - -ResourceGroupName [-SubscriptionId ] [-PrincipalId ] - [-PrincipalType ] [-Role ] [-TenantId ] + -ResourceGroupName [-SubscriptionId ] [-PrincipalId ] [-PrincipalType ] + [-Role ] [-TenantId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +### CreateViaIdentityClusterExpanded +``` +New-AzKustoClusterPrincipalAssignment -ClusterInputObject -PrincipalAssignmentName + [-PrincipalId ] [-PrincipalType ] [-Role ] [-TenantId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] ``` +### CreateViaJsonFilePath +``` +New-AzKustoClusterPrincipalAssignment -ClusterName -PrincipalAssignmentName + -ResourceGroupName -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### CreateViaJsonString +``` +New-AzKustoClusterPrincipalAssignment -ClusterName -PrincipalAssignmentName + -ResourceGroupName -JsonString [-SubscriptionId ] [-DefaultProfile ] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + ## DESCRIPTION Create a Kusto cluster principalAssignment. @@ -54,12 +76,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ClusterInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: CreateViaIdentityClusterExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ClusterName The name of the Kusto cluster. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString Aliases: Required: True @@ -85,6 +122,36 @@ 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 +``` + ### -NoWait Run the command asynchronously @@ -121,7 +188,7 @@ It can be a user email, application ID, or security group name. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded Aliases: Required: False @@ -135,8 +202,8 @@ Accept wildcard characters: False Principal type. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.PrincipalType -Parameter Sets: (All) +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded Aliases: Required: False @@ -152,7 +219,7 @@ The name is case insensitive. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString Aliases: Required: True @@ -166,8 +233,8 @@ Accept wildcard characters: False Cluster principal role. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.ClusterPrincipalRole -Parameter Sets: (All) +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded Aliases: Required: False @@ -182,7 +249,7 @@ The ID of the target subscription. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString Aliases: Required: False @@ -197,7 +264,7 @@ The tenant id of the principal ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded Aliases: Required: False @@ -243,9 +310,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity + ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IClusterPrincipalAssignment +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IClusterPrincipalAssignment ## NOTES diff --git a/src/Kusto/Kusto.Autorest/docs/New-AzKustoDataConnection.md b/src/Kusto/Kusto.Autorest/docs/New-AzKustoDataConnection.md index 3fe07ef59f22..e3404a4ee822 100644 --- a/src/Kusto/Kusto.Autorest/docs/New-AzKustoDataConnection.md +++ b/src/Kusto/Kusto.Autorest/docs/New-AzKustoDataConnection.md @@ -8,26 +8,25 @@ schema: 2.0.0 # New-AzKustoDataConnection ## SYNOPSIS -Creates or updates a data connection. +Create a data connection. ## SYNTAX ### CreateExpandedEventHub (Default) ``` New-AzKustoDataConnection -ClusterName -DatabaseName -Name - -ResourceGroupName -ConsumerGroup -EventHubResourceId -Kind - -Location [-SubscriptionId ] [-Compression ] - [-DatabaseRouting ] [-DataFormat ] [-EventSystemProperty ] - [-ManagedIdentityResourceId ] [-MappingRuleName ] [-RetrievalStartDate ] - [-TableName ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] - [] + -ResourceGroupName -ConsumerGroup -EventHubResourceId -Kind + -Location [-SubscriptionId ] [-Compression ] [-DatabaseRouting ] + [-DataFormat ] [-EventSystemProperty ] [-ManagedIdentityResourceId ] + [-MappingRuleName ] [-RetrievalStartDate ] [-TableName ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] ``` ### CreateExpandedCosmosDb ``` New-AzKustoDataConnection -ClusterName -DatabaseName -Name -ResourceGroupName -CosmosDbAccountResourceId -CosmosDbContainer - -CosmosDbDatabase -Kind -Location -ManagedIdentityResourceId + -CosmosDbDatabase -Kind -Location -ManagedIdentityResourceId -TableName [-SubscriptionId ] [-MappingRuleName ] [-RetrievalStartDate ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] ``` @@ -35,9 +34,9 @@ New-AzKustoDataConnection -ClusterName -DatabaseName -Name -DatabaseName -Name - -ResourceGroupName -ConsumerGroup -EventHubResourceId -Kind + -ResourceGroupName -ConsumerGroup -EventHubResourceId -Kind -Location -StorageAccountResourceId [-SubscriptionId ] - [-BlobStorageEventType ] [-DatabaseRouting ] [-DataFormat ] + [-BlobStorageEventType ] [-DatabaseRouting ] [-DataFormat ] [-EventGridResourceId ] [-IgnoreFirstRecord] [-ManagedIdentityResourceId ] [-MappingRuleName ] [-TableName ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] @@ -46,15 +45,29 @@ New-AzKustoDataConnection -ClusterName -DatabaseName -Name -DatabaseName -Name - -ResourceGroupName -ConsumerGroup -IotHubResourceId -Kind - -Location -SharedAccessPolicyName [-SubscriptionId ] - [-DatabaseRouting ] [-DataFormat ] [-EventSystemProperty ] - [-MappingRuleName ] [-RetrievalStartDate ] [-TableName ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] + -ResourceGroupName -ConsumerGroup -IotHubResourceId -Kind + -Location -SharedAccessPolicyName [-SubscriptionId ] [-DatabaseRouting ] + [-DataFormat ] [-EventSystemProperty ] [-MappingRuleName ] + [-RetrievalStartDate ] [-TableName ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [] +``` + +### CreateViaJsonFilePath +``` +New-AzKustoDataConnection -ClusterName -DatabaseName -Name + -ResourceGroupName -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### CreateViaJsonString +``` +New-AzKustoDataConnection -ClusterName -DatabaseName -Name + -ResourceGroupName -JsonString [-SubscriptionId ] [-DefaultProfile ] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] ``` ## DESCRIPTION -Creates or updates a data connection. +Create a data connection. ## EXAMPLES @@ -118,7 +131,7 @@ Accept wildcard characters: False The name of blob storage event type to process. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.BlobStorageEventType +Type: System.String Parameter Sets: CreateExpandedEventGrid Aliases: @@ -148,7 +161,7 @@ Accept wildcard characters: False The event hub messages compression type. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.Compression +Type: System.String Parameter Sets: CreateExpandedEventHub Aliases: @@ -238,7 +251,7 @@ Accept wildcard characters: False Indication for database routing information from the data connection, by default only database routing information is allowed. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.DatabaseRouting +Type: System.String Parameter Sets: CreateExpandedEventGrid, CreateExpandedEventHub, CreateExpandedIotHub Aliases: @@ -266,7 +279,8 @@ Accept wildcard characters: False ``` ### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. +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 @@ -355,12 +369,42 @@ 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 +``` + ### -Kind Kind of the endpoint for the data connection ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.Kind -Parameter Sets: (All) +Type: System.String +Parameter Sets: CreateExpandedCosmosDb, CreateExpandedEventGrid, CreateExpandedEventHub, CreateExpandedIotHub Aliases: Required: True @@ -375,7 +419,7 @@ Resource location. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpandedCosmosDb, CreateExpandedEventGrid, CreateExpandedEventHub, CreateExpandedIotHub Aliases: Required: True @@ -406,7 +450,7 @@ Optionally the mapping information can be added to each message. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpandedCosmosDb, CreateExpandedEventGrid, CreateExpandedEventHub, CreateExpandedIotHub Aliases: Required: False @@ -447,7 +491,8 @@ Accept wildcard characters: False ``` ### -ResourceGroupName -The name of the resource group containing the Kusto cluster. +The name of the resource group. +The name is case insensitive. ```yaml Type: System.String @@ -508,8 +553,7 @@ Accept wildcard characters: False ``` ### -SubscriptionId -Gets subscription credentials which uniquely identify Microsoft Azure subscription. -The subscription ID forms part of the URI for every service call. +The ID of the target subscription. ```yaml Type: System.String @@ -529,7 +573,7 @@ Optionally the table information can be added to each message. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpandedCosmosDb, CreateExpandedEventGrid, CreateExpandedEventHub, CreateExpandedIotHub Aliases: Required: True @@ -577,7 +621,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IDataConnection +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IDataConnection ## NOTES diff --git a/src/Kusto/Kusto.Autorest/docs/New-AzKustoDatabase.md b/src/Kusto/Kusto.Autorest/docs/New-AzKustoDatabase.md index fef307c1e648..fc1262f6b1e3 100644 --- a/src/Kusto/Kusto.Autorest/docs/New-AzKustoDatabase.md +++ b/src/Kusto/Kusto.Autorest/docs/New-AzKustoDatabase.md @@ -8,21 +8,36 @@ schema: 2.0.0 # New-AzKustoDatabase ## SYNOPSIS -Creates or updates a database. +Create a database. ## SYNTAX +### CreateReadWrite (Default) ``` -New-AzKustoDatabase -ClusterName -Name -ResourceGroupName -Kind - [-SubscriptionId ] [-CallerRole ] [-HotCachePeriod ] +New-AzKustoDatabase -ClusterName -Name -ResourceGroupName -Kind + [-SubscriptionId ] [-CallerRole ] [-HotCachePeriod ] [-KeyVaultPropertyKeyName ] [-KeyVaultPropertyKeyVaultUri ] [-KeyVaultPropertyKeyVersion ] [-KeyVaultPropertyUserIdentity ] [-Location ] [-SoftDeletePeriod ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] ``` +### CreateViaJsonFilePath +``` +New-AzKustoDatabase -ClusterName -Name -ResourceGroupName -JsonFilePath + [-SubscriptionId ] [-CallerRole ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +### CreateViaJsonString +``` +New-AzKustoDatabase -ClusterName -Name -ResourceGroupName -JsonString + [-SubscriptionId ] [-CallerRole ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + ## DESCRIPTION -Creates or updates a database. +Create a database. ## EXAMPLES @@ -61,7 +76,7 @@ By default, any user who run operation on a database become an Admin on it. This property allows the caller to exclude the caller from Admins list. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.CallerRole +Type: System.String Parameter Sets: (All) Aliases: @@ -88,7 +103,8 @@ Accept wildcard characters: False ``` ### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. +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 @@ -107,7 +123,7 @@ The time the data should be kept in cache for fast queries in TimeSpan. ```yaml Type: System.TimeSpan -Parameter Sets: (All) +Parameter Sets: CreateReadWrite Aliases: Required: False @@ -117,12 +133,42 @@ 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 +``` + ### -KeyVaultPropertyKeyName The name of the key vault key. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateReadWrite Aliases: Required: False @@ -137,7 +183,7 @@ The Uri of the key vault. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateReadWrite Aliases: Required: False @@ -152,7 +198,7 @@ The version of the key vault key. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateReadWrite Aliases: Required: False @@ -167,7 +213,7 @@ The user assigned identity (ARM resource id) that has access to the key. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateReadWrite Aliases: Required: False @@ -181,8 +227,8 @@ Accept wildcard characters: False Kind of the database ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.Kind -Parameter Sets: (All) +Type: System.String +Parameter Sets: CreateReadWrite Aliases: Required: True @@ -197,7 +243,7 @@ Resource location. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateReadWrite Aliases: Required: False @@ -238,7 +284,8 @@ Accept wildcard characters: False ``` ### -ResourceGroupName -The name of the resource group containing the Kusto cluster. +The name of the resource group. +The name is case insensitive. ```yaml Type: System.String @@ -257,7 +304,7 @@ The time the data should be kept before it stops being accessible to queries in ```yaml Type: System.TimeSpan -Parameter Sets: (All) +Parameter Sets: CreateReadWrite Aliases: Required: False @@ -268,8 +315,7 @@ Accept wildcard characters: False ``` ### -SubscriptionId -Gets subscription credentials which uniquely identify Microsoft Azure subscription. -The subscription ID forms part of the URI for every service call. +The ID of the target subscription. ```yaml Type: System.String @@ -321,7 +367,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IDatabase +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IDatabase ## NOTES diff --git a/src/Kusto/Kusto.Autorest/docs/New-AzKustoDatabasePrincipalAssignment.md b/src/Kusto/Kusto.Autorest/docs/New-AzKustoDatabasePrincipalAssignment.md index b0f0f8fd5681..9328096cdb31 100644 --- a/src/Kusto/Kusto.Autorest/docs/New-AzKustoDatabasePrincipalAssignment.md +++ b/src/Kusto/Kusto.Autorest/docs/New-AzKustoDatabasePrincipalAssignment.md @@ -8,19 +8,50 @@ schema: 2.0.0 # New-AzKustoDatabasePrincipalAssignment ## SYNOPSIS -Creates a Kusto cluster database principalAssignment. +Create a Kusto cluster database principalAssignment. ## SYNTAX +### CreateExpanded (Default) ``` New-AzKustoDatabasePrincipalAssignment -ClusterName -DatabaseName -PrincipalAssignmentName -ResourceGroupName [-SubscriptionId ] - [-PrincipalId ] [-PrincipalType ] [-Role ] [-TenantId ] + [-PrincipalId ] [-PrincipalType ] [-Role ] [-TenantId ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### CreateViaIdentityClusterExpanded +``` +New-AzKustoDatabasePrincipalAssignment -ClusterInputObject -DatabaseName + -PrincipalAssignmentName [-PrincipalId ] [-PrincipalType ] [-Role ] + [-TenantId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +### CreateViaIdentityDatabaseExpanded +``` +New-AzKustoDatabasePrincipalAssignment -DatabaseInputObject -PrincipalAssignmentName + [-PrincipalId ] [-PrincipalType ] [-Role ] [-TenantId ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### CreateViaJsonFilePath +``` +New-AzKustoDatabasePrincipalAssignment -ClusterName -DatabaseName + -PrincipalAssignmentName -ResourceGroupName -JsonFilePath + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +### CreateViaJsonString +``` +New-AzKustoDatabasePrincipalAssignment -ClusterName -DatabaseName + -PrincipalAssignmentName -ResourceGroupName -JsonString [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] ``` ## DESCRIPTION -Creates a Kusto cluster database principalAssignment. +Create a Kusto cluster database principalAssignment. ## EXAMPLES @@ -54,12 +85,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ClusterInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: CreateViaIdentityClusterExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ClusterName The name of the Kusto cluster. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString Aliases: Required: True @@ -69,12 +115,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DatabaseInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: CreateViaIdentityDatabaseExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -DatabaseName The name of the database in the Kusto cluster. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded, CreateViaJsonFilePath, CreateViaJsonString Aliases: Required: True @@ -100,6 +161,36 @@ 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 +``` + ### -NoWait Run the command asynchronously @@ -136,7 +227,7 @@ It can be a user email, application ID, or security group name. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded, CreateViaIdentityDatabaseExpanded Aliases: Required: False @@ -150,8 +241,8 @@ Accept wildcard characters: False Principal type. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.PrincipalType -Parameter Sets: (All) +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded, CreateViaIdentityDatabaseExpanded Aliases: Required: False @@ -167,7 +258,7 @@ The name is case insensitive. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString Aliases: Required: True @@ -181,8 +272,8 @@ Accept wildcard characters: False Database principal role. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.DatabasePrincipalRole -Parameter Sets: (All) +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded, CreateViaIdentityDatabaseExpanded Aliases: Required: False @@ -197,7 +288,7 @@ The ID of the target subscription. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString Aliases: Required: False @@ -212,7 +303,7 @@ The tenant id of the principal ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded, CreateViaIdentityDatabaseExpanded Aliases: Required: False @@ -258,9 +349,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity + ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IDatabasePrincipalAssignment +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IDatabasePrincipalAssignment ## NOTES diff --git a/src/Kusto/Kusto.Autorest/docs/New-AzKustoManagedPrivateEndpoint.md b/src/Kusto/Kusto.Autorest/docs/New-AzKustoManagedPrivateEndpoint.md index 9e4ec92caffa..a82f05a26f7d 100644 --- a/src/Kusto/Kusto.Autorest/docs/New-AzKustoManagedPrivateEndpoint.md +++ b/src/Kusto/Kusto.Autorest/docs/New-AzKustoManagedPrivateEndpoint.md @@ -8,7 +8,7 @@ schema: 2.0.0 # New-AzKustoManagedPrivateEndpoint ## SYNOPSIS -Creates a managed private endpoint. +Create a managed private endpoint. ## SYNTAX @@ -27,8 +27,36 @@ New-AzKustoManagedPrivateEndpoint -ClusterName -Name -Resource [-NoWait] [-Confirm] [-WhatIf] [] ``` +### CreateViaIdentityCluster +``` +New-AzKustoManagedPrivateEndpoint -ClusterInputObject -Name + -Parameter [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +### CreateViaIdentityClusterExpanded +``` +New-AzKustoManagedPrivateEndpoint -ClusterInputObject -Name [-GroupId ] + [-PrivateLinkResourceId ] [-PrivateLinkResourceRegion ] [-RequestMessage ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### CreateViaJsonFilePath +``` +New-AzKustoManagedPrivateEndpoint -ClusterName -Name -ResourceGroupName + -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +### CreateViaJsonString +``` +New-AzKustoManagedPrivateEndpoint -ClusterName -Name -ResourceGroupName + -JsonString [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + ## DESCRIPTION -Creates a managed private endpoint. +Create a managed private endpoint. ## EXAMPLES @@ -62,12 +90,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ClusterInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: CreateViaIdentityCluster, CreateViaIdentityClusterExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ClusterName The name of the Kusto cluster. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: Create, CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString Aliases: Required: True @@ -98,7 +141,7 @@ The groupId in which the managed private endpoint is created. ```yaml Type: System.String -Parameter Sets: CreateExpanded +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded Aliases: Required: False @@ -108,6 +151,36 @@ 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 +``` + ### -Name The name of the managed private endpoint. @@ -140,11 +213,10 @@ Accept wildcard characters: False ### -Parameter Class representing a managed private endpoint. -To construct, see NOTES section for PARAMETER properties and create a hash table. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IManagedPrivateEndpoint -Parameter Sets: Create +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IManagedPrivateEndpoint +Parameter Sets: Create, CreateViaIdentityCluster Aliases: Required: True @@ -159,7 +231,7 @@ The ARM resource ID of the resource for which the managed private endpoint is cr ```yaml Type: System.String -Parameter Sets: CreateExpanded +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded Aliases: Required: False @@ -174,7 +246,7 @@ The region of the resource to which the managed private endpoint is created. ```yaml Type: System.String -Parameter Sets: CreateExpanded +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded Aliases: Required: False @@ -189,7 +261,7 @@ The user request message. ```yaml Type: System.String -Parameter Sets: CreateExpanded +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded Aliases: Required: False @@ -205,7 +277,7 @@ The name is case insensitive. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: Create, CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString Aliases: Required: True @@ -220,7 +292,7 @@ The ID of the target subscription. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: Create, CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString Aliases: Required: False @@ -266,11 +338,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IManagedPrivateEndpoint +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IManagedPrivateEndpoint ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IManagedPrivateEndpoint +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IManagedPrivateEndpoint ## NOTES diff --git a/src/Kusto/Kusto.Autorest/docs/New-AzKustoPrivateEndpointConnection.md b/src/Kusto/Kusto.Autorest/docs/New-AzKustoPrivateEndpointConnection.md deleted file mode 100644 index 9e7f204b4697..000000000000 --- a/src/Kusto/Kusto.Autorest/docs/New-AzKustoPrivateEndpointConnection.md +++ /dev/null @@ -1,248 +0,0 @@ ---- -external help file: -Module Name: Az.Kusto -online version: https://learn.microsoft.com/powershell/module/az.kusto/new-azkustoprivateendpointconnection -schema: 2.0.0 ---- - -# New-AzKustoPrivateEndpointConnection - -## SYNOPSIS -Approve or reject a private endpoint connection with a given name. - -## SYNTAX - -### CreateExpanded (Default) -``` -New-AzKustoPrivateEndpointConnection -ClusterName -Name -ResourceGroupName - [-SubscriptionId ] [-PrivateLinkServiceConnectionStateDescription ] - [-PrivateLinkServiceConnectionStateStatus ] [-DefaultProfile ] [-AsJob] [-NoWait] - [-Confirm] [-WhatIf] [] -``` - -### Create -``` -New-AzKustoPrivateEndpointConnection -ClusterName -Name -ResourceGroupName - -Parameter [-SubscriptionId ] [-DefaultProfile ] [-AsJob] - [-NoWait] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Approve or reject a private endpoint connection with a given name. - -## EXAMPLES - -### Example 1: Create a new PrivateEndpointConnection in a cluster -```powershell -New-AzKustoPrivateEndpointConnection -ClusterName "mycluster" -ResourceGroupName "testrg" -SubscriptionId "12345678-1234-1234-1234-123456789098" -Parameter $privateEndpointConnection -Name "testprivateconnection-12345678-1234-1234-1234-123456789098" -``` - -```output -Name Type ----- ---- -testprivateconnection-12345678-1234-1234-1234-123456789098 Microsoft.Kusto/Clusters/PrivateEndpointConnections -``` - -The above command creates a new PrivateEndpointConnection in the cluster "mycluster" found in the resource group "testrg". - -## 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 -``` - -### -ClusterName -The name of the Kusto cluster. - -```yaml -Type: System.String -Parameter Sets: (All) -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 -``` - -### -Name -The name of the private endpoint connection. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: PrivateEndpointConnectionName - -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 -``` - -### -Parameter -A private endpoint connection -To construct, see NOTES section for PARAMETER properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IPrivateEndpointConnection -Parameter Sets: Create -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PrivateLinkServiceConnectionStateDescription -The private link service connection description. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrivateLinkServiceConnectionStateStatus -The private link service connection status. - -```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. - -```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 - -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IPrivateEndpointConnection - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IPrivateEndpointConnection - -## NOTES - -## RELATED LINKS - diff --git a/src/Kusto/Kusto.Autorest/docs/New-AzKustoSandboxCustomImage.md b/src/Kusto/Kusto.Autorest/docs/New-AzKustoSandboxCustomImage.md index 9f9239dfcdda..43abfed4e347 100644 --- a/src/Kusto/Kusto.Autorest/docs/New-AzKustoSandboxCustomImage.md +++ b/src/Kusto/Kusto.Autorest/docs/New-AzKustoSandboxCustomImage.md @@ -8,7 +8,7 @@ schema: 2.0.0 # New-AzKustoSandboxCustomImage ## SYNOPSIS -Creates or updates a sandbox custom image. +Create a sandbox custom image. ## SYNTAX @@ -27,8 +27,36 @@ New-AzKustoSandboxCustomImage -ClusterName -Name -ResourceGrou [-Confirm] [-WhatIf] [] ``` +### CreateViaIdentityCluster +``` +New-AzKustoSandboxCustomImage -ClusterInputObject -Name + -Parameter [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +### CreateViaIdentityClusterExpanded +``` +New-AzKustoSandboxCustomImage -ClusterInputObject -Name [-BaseImageName ] + [-LanguageVersion ] [-RequirementsFileContent ] [-DefaultProfile ] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### CreateViaJsonFilePath +``` +New-AzKustoSandboxCustomImage -ClusterName -Name -ResourceGroupName + -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +### CreateViaJsonString +``` +New-AzKustoSandboxCustomImage -ClusterName -Name -ResourceGroupName + -JsonString [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + ## DESCRIPTION -Creates or updates a sandbox custom image. +Create a sandbox custom image. ## EXAMPLES @@ -69,7 +97,7 @@ Either this property or languageVersion should be specified. ```yaml Type: System.String -Parameter Sets: CreateExpanded +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded Aliases: Required: False @@ -79,12 +107,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ClusterInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: CreateViaIdentityCluster, CreateViaIdentityClusterExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ClusterName The name of the Kusto cluster. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: Create, CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString Aliases: Required: True @@ -110,13 +153,43 @@ 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 +``` + ### -LanguageVersion The version of the language. Either this property or baseImageName should be specified. ```yaml Type: System.String -Parameter Sets: CreateExpanded +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded Aliases: Required: False @@ -158,11 +231,10 @@ Accept wildcard characters: False ### -Parameter Class representing a Kusto sandbox custom image. -To construct, see NOTES section for PARAMETER properties and create a hash table. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ISandboxCustomImage -Parameter Sets: Create +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ISandboxCustomImage +Parameter Sets: Create, CreateViaIdentityCluster Aliases: Required: True @@ -177,7 +249,7 @@ The requirements file content. ```yaml Type: System.String -Parameter Sets: CreateExpanded +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded Aliases: Required: False @@ -193,7 +265,7 @@ The name is case insensitive. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: Create, CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString Aliases: Required: True @@ -208,7 +280,7 @@ The ID of the target subscription. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: Create, CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString Aliases: Required: False @@ -254,11 +326,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ISandboxCustomImage +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ISandboxCustomImage ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ISandboxCustomImage +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ISandboxCustomImage ## NOTES diff --git a/src/Kusto/Kusto.Autorest/docs/New-AzKustoScript.md b/src/Kusto/Kusto.Autorest/docs/New-AzKustoScript.md index d05d318f47bf..ec8d518c3278 100644 --- a/src/Kusto/Kusto.Autorest/docs/New-AzKustoScript.md +++ b/src/Kusto/Kusto.Autorest/docs/New-AzKustoScript.md @@ -8,7 +8,7 @@ schema: 2.0.0 # New-AzKustoScript ## SYNOPSIS -Creates a Kusto database script. +Create a Kusto database script. ## SYNTAX @@ -16,9 +16,9 @@ Creates a Kusto database script. ``` New-AzKustoScript -ClusterName -DatabaseName -Name -ResourceGroupName [-SubscriptionId ] [-ContinueOnError] [-ForceUpdateTag ] - [-PrincipalPermissionsAction ] [-ScriptContent ] - [-ScriptLevel ] [-ScriptUrl ] [-ScriptUrlSasToken ] [-DefaultProfile ] - [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] + [-PrincipalPermissionsAction ] [-ScriptContent ] [-ScriptLevel ] + [-ScriptUrl ] [-ScriptUrlSasToken ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [] ``` ### Create @@ -28,8 +28,51 @@ New-AzKustoScript -ClusterName -DatabaseName -Name -R [-WhatIf] [] ``` +### CreateViaIdentityCluster +``` +New-AzKustoScript -ClusterInputObject -DatabaseName -Name + -Parameter [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +### CreateViaIdentityClusterExpanded +``` +New-AzKustoScript -ClusterInputObject -DatabaseName -Name + [-ContinueOnError] [-ForceUpdateTag ] [-PrincipalPermissionsAction ] + [-ScriptContent ] [-ScriptLevel ] [-ScriptUrl ] [-ScriptUrlSasToken ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### CreateViaIdentityDatabase +``` +New-AzKustoScript -DatabaseInputObject -Name -Parameter + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### CreateViaIdentityDatabaseExpanded +``` +New-AzKustoScript -DatabaseInputObject -Name [-ContinueOnError] + [-ForceUpdateTag ] [-PrincipalPermissionsAction ] [-ScriptContent ] + [-ScriptLevel ] [-ScriptUrl ] [-ScriptUrlSasToken ] [-DefaultProfile ] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### CreateViaJsonFilePath +``` +New-AzKustoScript -ClusterName -DatabaseName -Name -ResourceGroupName + -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +### CreateViaJsonString +``` +New-AzKustoScript -ClusterName -DatabaseName -Name -ResourceGroupName + -JsonString [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + ## DESCRIPTION -Creates a Kusto database script. +Create a Kusto database script. ## EXAMPLES @@ -65,12 +108,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ClusterInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: CreateViaIdentityCluster, CreateViaIdentityClusterExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ClusterName The name of the Kusto cluster. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: Create, CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString Aliases: Required: True @@ -85,7 +143,7 @@ Flag that indicates whether to continue if one of the command fails. ```yaml Type: System.Management.Automation.SwitchParameter -Parameter Sets: CreateExpanded +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded, CreateViaIdentityDatabaseExpanded Aliases: Required: False @@ -95,12 +153,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DatabaseInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: CreateViaIdentityDatabase, CreateViaIdentityDatabaseExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -DatabaseName The name of the database in the Kusto cluster. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: Create, CreateExpanded, CreateViaIdentityCluster, CreateViaIdentityClusterExpanded, CreateViaJsonFilePath, CreateViaJsonString Aliases: Required: True @@ -132,7 +205,7 @@ If changed the script will be applied again. ```yaml Type: System.String -Parameter Sets: CreateExpanded +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded, CreateViaIdentityDatabaseExpanded Aliases: Required: False @@ -142,6 +215,36 @@ 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 +``` + ### -Name The name of the Kusto database script. @@ -174,11 +277,10 @@ Accept wildcard characters: False ### -Parameter Class representing a database script. -To construct, see NOTES section for PARAMETER properties and create a hash table. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IScript -Parameter Sets: Create +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IScript +Parameter Sets: Create, CreateViaIdentityCluster, CreateViaIdentityDatabase Aliases: Required: True @@ -192,8 +294,8 @@ Accept wildcard characters: False Indicates if the permissions for the script caller are kept following completion of the script. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.PrincipalPermissionsAction -Parameter Sets: CreateExpanded +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded, CreateViaIdentityDatabaseExpanded Aliases: Required: False @@ -209,7 +311,7 @@ The name is case insensitive. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: Create, CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString Aliases: Required: True @@ -226,7 +328,7 @@ Must not be used together with scriptUrl and scriptUrlSasToken properties. ```yaml Type: System.String -Parameter Sets: CreateExpanded +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded, CreateViaIdentityDatabaseExpanded Aliases: Required: False @@ -241,8 +343,8 @@ Differentiates between the type of script commands included - Database or Cluste The default is Database. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.ScriptLevel -Parameter Sets: CreateExpanded +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded, CreateViaIdentityDatabaseExpanded Aliases: Required: False @@ -258,7 +360,7 @@ Must not be used together with scriptContent property ```yaml Type: System.String -Parameter Sets: CreateExpanded +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded, CreateViaIdentityDatabaseExpanded Aliases: Required: False @@ -274,7 +376,7 @@ Must be provided when using scriptUrl property. ```yaml Type: System.String -Parameter Sets: CreateExpanded +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded, CreateViaIdentityDatabaseExpanded Aliases: Required: False @@ -289,7 +391,7 @@ The ID of the target subscription. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: Create, CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString Aliases: Required: False @@ -335,11 +437,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IScript +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IScript ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IScript +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IScript ## NOTES diff --git a/src/Kusto/Kusto.Autorest/docs/Remove-AzKustoAttachedDatabaseConfiguration.md b/src/Kusto/Kusto.Autorest/docs/Remove-AzKustoAttachedDatabaseConfiguration.md index 595b3bb7e184..84b9aa804d8b 100644 --- a/src/Kusto/Kusto.Autorest/docs/Remove-AzKustoAttachedDatabaseConfiguration.md +++ b/src/Kusto/Kusto.Autorest/docs/Remove-AzKustoAttachedDatabaseConfiguration.md @@ -25,6 +25,12 @@ Remove-AzKustoAttachedDatabaseConfiguration -InputObject [-Defa [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] ``` +### DeleteViaIdentityCluster +``` +Remove-AzKustoAttachedDatabaseConfiguration -ClusterInputObject -Name + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + ## DESCRIPTION Deletes the attached database configuration with the given name. @@ -54,6 +60,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ClusterInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: DeleteViaIdentityCluster +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ClusterName The name of the Kusto cluster. @@ -87,7 +108,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -106,7 +126,7 @@ The name of the attached database configuration. ```yaml Type: System.String -Parameter Sets: Delete +Parameter Sets: Delete, DeleteViaIdentityCluster Aliases: AttachedDatabaseConfigurationName Required: True diff --git a/src/Kusto/Kusto.Autorest/docs/Remove-AzKustoCluster.md b/src/Kusto/Kusto.Autorest/docs/Remove-AzKustoCluster.md index c45c06f8818b..80f727ffcb5a 100644 --- a/src/Kusto/Kusto.Autorest/docs/Remove-AzKustoCluster.md +++ b/src/Kusto/Kusto.Autorest/docs/Remove-AzKustoCluster.md @@ -71,7 +71,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity diff --git a/src/Kusto/Kusto.Autorest/docs/Remove-AzKustoClusterCalloutPolicy.md b/src/Kusto/Kusto.Autorest/docs/Remove-AzKustoClusterCalloutPolicy.md index a93e30da2564..3dc7813e14d7 100644 --- a/src/Kusto/Kusto.Autorest/docs/Remove-AzKustoClusterCalloutPolicy.md +++ b/src/Kusto/Kusto.Autorest/docs/Remove-AzKustoClusterCalloutPolicy.md @@ -38,6 +38,20 @@ Remove-AzKustoClusterCalloutPolicy -InputObject [-CalloutId ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] ``` +### RemoveViaJsonFilePath +``` +Remove-AzKustoClusterCalloutPolicy -ClusterName -ResourceGroupName -JsonFilePath + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +### RemoveViaJsonString +``` +Remove-AzKustoClusterCalloutPolicy -ClusterName -ResourceGroupName -JsonString + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + ## DESCRIPTION Removes callout policy for engine services. @@ -84,10 +98,9 @@ Accept wildcard characters: False ### -CalloutPolicy Configuration for an external callout policy to remove. -To construct, see NOTES section for CALLOUTPOLICY properties and create a hash table. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ICalloutPolicyToRemove +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ICalloutPolicyToRemove Parameter Sets: Remove, RemoveViaIdentity Aliases: @@ -103,7 +116,7 @@ The name of the Kusto cluster. ```yaml Type: System.String -Parameter Sets: Remove, RemoveExpanded +Parameter Sets: Remove, RemoveExpanded, RemoveViaJsonFilePath, RemoveViaJsonString Aliases: Required: True @@ -131,7 +144,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -145,6 +157,36 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -JsonFilePath +Path of Json file supplied to the Remove operation + +```yaml +Type: System.String +Parameter Sets: RemoveViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Remove operation + +```yaml +Type: System.String +Parameter Sets: RemoveViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -NoWait Run the command asynchronously @@ -181,7 +223,7 @@ The name is case insensitive. ```yaml Type: System.String -Parameter Sets: Remove, RemoveExpanded +Parameter Sets: Remove, RemoveExpanded, RemoveViaJsonFilePath, RemoveViaJsonString Aliases: Required: True @@ -196,7 +238,7 @@ The ID of the target subscription. ```yaml Type: System.String -Parameter Sets: Remove, RemoveExpanded +Parameter Sets: Remove, RemoveExpanded, RemoveViaJsonFilePath, RemoveViaJsonString Aliases: Required: False @@ -242,7 +284,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ICalloutPolicyToRemove +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ICalloutPolicyToRemove ### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity diff --git a/src/Kusto/Kusto.Autorest/docs/Remove-AzKustoClusterLanguageExtension.md b/src/Kusto/Kusto.Autorest/docs/Remove-AzKustoClusterLanguageExtension.md index 1f4fe1592fb0..668a8e6b2c3d 100644 --- a/src/Kusto/Kusto.Autorest/docs/Remove-AzKustoClusterLanguageExtension.md +++ b/src/Kusto/Kusto.Autorest/docs/Remove-AzKustoClusterLanguageExtension.md @@ -25,6 +25,20 @@ Remove-AzKustoClusterLanguageExtension -InputObject [-Value ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] ``` +### RemoveViaJsonFilePath +``` +Remove-AzKustoClusterLanguageExtension -ClusterName -ResourceGroupName + -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +### RemoveViaJsonString +``` +Remove-AzKustoClusterLanguageExtension -ClusterName -ResourceGroupName -JsonString + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + ## DESCRIPTION Remove a list of language extensions that can run within KQL queries. @@ -59,7 +73,7 @@ The name of the Kusto cluster. ```yaml Type: System.String -Parameter Sets: RemoveExpanded +Parameter Sets: RemoveExpanded, RemoveViaJsonFilePath, RemoveViaJsonString Aliases: Required: True @@ -87,7 +101,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -101,6 +114,36 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -JsonFilePath +Path of Json file supplied to the Remove operation + +```yaml +Type: System.String +Parameter Sets: RemoveViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Remove operation + +```yaml +Type: System.String +Parameter Sets: RemoveViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -NoWait Run the command asynchronously @@ -137,7 +180,7 @@ The name is case insensitive. ```yaml Type: System.String -Parameter Sets: RemoveExpanded +Parameter Sets: RemoveExpanded, RemoveViaJsonFilePath, RemoveViaJsonString Aliases: Required: True @@ -152,7 +195,7 @@ The ID of the target subscription. ```yaml Type: System.String -Parameter Sets: RemoveExpanded +Parameter Sets: RemoveExpanded, RemoveViaJsonFilePath, RemoveViaJsonString Aliases: Required: False @@ -164,11 +207,10 @@ Accept wildcard characters: False ### -Value The list of language extensions. -To construct, see NOTES section for VALUE properties and create a hash table. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ILanguageExtension[] -Parameter Sets: (All) +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ILanguageExtension[] +Parameter Sets: RemoveExpanded, RemoveViaIdentityExpanded Aliases: Required: False diff --git a/src/Kusto/Kusto.Autorest/docs/Remove-AzKustoClusterPrincipalAssignment.md b/src/Kusto/Kusto.Autorest/docs/Remove-AzKustoClusterPrincipalAssignment.md index 863aa6d08a64..4d4d9342c80b 100644 --- a/src/Kusto/Kusto.Autorest/docs/Remove-AzKustoClusterPrincipalAssignment.md +++ b/src/Kusto/Kusto.Autorest/docs/Remove-AzKustoClusterPrincipalAssignment.md @@ -25,6 +25,13 @@ Remove-AzKustoClusterPrincipalAssignment -InputObject [-Default [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] ``` +### DeleteViaIdentityCluster +``` +Remove-AzKustoClusterPrincipalAssignment -ClusterInputObject + -PrincipalAssignmentName [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] + [-WhatIf] [] +``` + ## DESCRIPTION Deletes a Kusto cluster principalAssignment. @@ -54,6 +61,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ClusterInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: DeleteViaIdentityCluster +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ClusterName The name of the Kusto cluster. @@ -87,7 +109,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -136,7 +157,7 @@ The name of the Kusto principalAssignment. ```yaml Type: System.String -Parameter Sets: Delete +Parameter Sets: Delete, DeleteViaIdentityCluster Aliases: Required: True diff --git a/src/Kusto/Kusto.Autorest/docs/Remove-AzKustoDataConnection.md b/src/Kusto/Kusto.Autorest/docs/Remove-AzKustoDataConnection.md index 54bf9cc2eb45..0fc5c2c6eb69 100644 --- a/src/Kusto/Kusto.Autorest/docs/Remove-AzKustoDataConnection.md +++ b/src/Kusto/Kusto.Autorest/docs/Remove-AzKustoDataConnection.md @@ -25,6 +25,18 @@ Remove-AzKustoDataConnection -InputObject [-DefaultProfile ] ``` +### DeleteViaIdentityCluster +``` +Remove-AzKustoDataConnection -ClusterInputObject -DatabaseName -Name + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentityDatabase +``` +Remove-AzKustoDataConnection -DatabaseInputObject -Name [-DefaultProfile ] + [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + ## DESCRIPTION Deletes the data connection with the given name. @@ -54,6 +66,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ClusterInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: DeleteViaIdentityCluster +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ClusterName The name of the Kusto cluster. @@ -69,12 +96,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DatabaseInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: DeleteViaIdentityDatabase +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -DatabaseName The name of the database in the Kusto cluster. ```yaml Type: System.String -Parameter Sets: Delete +Parameter Sets: Delete, DeleteViaIdentityCluster Aliases: Required: True @@ -102,7 +144,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -121,7 +162,7 @@ The name of the data connection. ```yaml Type: System.String -Parameter Sets: Delete +Parameter Sets: Delete, DeleteViaIdentityCluster, DeleteViaIdentityDatabase Aliases: DataConnectionName Required: True diff --git a/src/Kusto/Kusto.Autorest/docs/Remove-AzKustoDatabase.md b/src/Kusto/Kusto.Autorest/docs/Remove-AzKustoDatabase.md index 4a9ff9af21d4..28671bbee226 100644 --- a/src/Kusto/Kusto.Autorest/docs/Remove-AzKustoDatabase.md +++ b/src/Kusto/Kusto.Autorest/docs/Remove-AzKustoDatabase.md @@ -25,6 +25,12 @@ Remove-AzKustoDatabase -InputObject [-DefaultProfile [-PassThru] [-Confirm] [-WhatIf] [] ``` +### DeleteViaIdentityCluster +``` +Remove-AzKustoDatabase -ClusterInputObject -Name [-DefaultProfile ] + [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + ## DESCRIPTION Deletes the database with the given name. @@ -54,6 +60,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ClusterInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: DeleteViaIdentityCluster +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ClusterName The name of the Kusto cluster. @@ -87,7 +108,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -106,7 +126,7 @@ The name of the database in the Kusto cluster. ```yaml Type: System.String -Parameter Sets: Delete +Parameter Sets: Delete, DeleteViaIdentityCluster Aliases: DatabaseName Required: True diff --git a/src/Kusto/Kusto.Autorest/docs/Remove-AzKustoDatabasePrincipal.md b/src/Kusto/Kusto.Autorest/docs/Remove-AzKustoDatabasePrincipal.md index 149bf76095f2..46cbab4a364e 100644 --- a/src/Kusto/Kusto.Autorest/docs/Remove-AzKustoDatabasePrincipal.md +++ b/src/Kusto/Kusto.Autorest/docs/Remove-AzKustoDatabasePrincipal.md @@ -19,12 +19,32 @@ Remove-AzKustoDatabasePrincipal -ClusterName -DatabaseName -Re [] ``` +### RemoveViaIdentityClusterExpanded +``` +Remove-AzKustoDatabasePrincipal -ClusterInputObject -DatabaseName + [-Value ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + ### RemoveViaIdentityExpanded ``` Remove-AzKustoDatabasePrincipal -InputObject [-Value ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] ``` +### RemoveViaJsonFilePath +``` +Remove-AzKustoDatabasePrincipal -ClusterName -DatabaseName -ResourceGroupName + -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### RemoveViaJsonString +``` +Remove-AzKustoDatabasePrincipal -ClusterName -DatabaseName -ResourceGroupName + -JsonString [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + ## DESCRIPTION Remove Database principals permissions. @@ -45,12 +65,27 @@ The above command removes Database principals permissions ## PARAMETERS +### -ClusterInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: RemoveViaIdentityClusterExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ClusterName The name of the Kusto cluster. ```yaml Type: System.String -Parameter Sets: RemoveExpanded +Parameter Sets: RemoveExpanded, RemoveViaJsonFilePath, RemoveViaJsonString Aliases: Required: True @@ -65,7 +100,7 @@ The name of the database in the Kusto cluster. ```yaml Type: System.String -Parameter Sets: RemoveExpanded +Parameter Sets: RemoveExpanded, RemoveViaIdentityClusterExpanded, RemoveViaJsonFilePath, RemoveViaJsonString Aliases: Required: True @@ -93,7 +128,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -107,13 +141,43 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -JsonFilePath +Path of Json file supplied to the Remove operation + +```yaml +Type: System.String +Parameter Sets: RemoveViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Remove operation + +```yaml +Type: System.String +Parameter Sets: RemoveViaJsonString +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: RemoveExpanded +Parameter Sets: RemoveExpanded, RemoveViaJsonFilePath, RemoveViaJsonString Aliases: Required: True @@ -128,7 +192,7 @@ The ID of the target subscription. ```yaml Type: System.String -Parameter Sets: RemoveExpanded +Parameter Sets: RemoveExpanded, RemoveViaJsonFilePath, RemoveViaJsonString Aliases: Required: False @@ -140,11 +204,10 @@ Accept wildcard characters: False ### -Value The list of Kusto database principals. -To construct, see NOTES section for VALUE properties and create a hash table. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IDatabasePrincipal[] -Parameter Sets: (All) +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IDatabasePrincipal[] +Parameter Sets: RemoveExpanded, RemoveViaIdentityClusterExpanded, RemoveViaIdentityExpanded Aliases: Required: False @@ -194,7 +257,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IDatabasePrincipal +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IDatabasePrincipalListResult ## NOTES diff --git a/src/Kusto/Kusto.Autorest/docs/Remove-AzKustoDatabasePrincipalAssignment.md b/src/Kusto/Kusto.Autorest/docs/Remove-AzKustoDatabasePrincipalAssignment.md index f009f70e9958..55ba3d1a4f78 100644 --- a/src/Kusto/Kusto.Autorest/docs/Remove-AzKustoDatabasePrincipalAssignment.md +++ b/src/Kusto/Kusto.Autorest/docs/Remove-AzKustoDatabasePrincipalAssignment.md @@ -25,6 +25,20 @@ Remove-AzKustoDatabasePrincipalAssignment -InputObject [-Defaul [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] ``` +### DeleteViaIdentityCluster +``` +Remove-AzKustoDatabasePrincipalAssignment -ClusterInputObject -DatabaseName + -PrincipalAssignmentName [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] + [-WhatIf] [] +``` + +### DeleteViaIdentityDatabase +``` +Remove-AzKustoDatabasePrincipalAssignment -DatabaseInputObject + -PrincipalAssignmentName [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] + [-WhatIf] [] +``` + ## DESCRIPTION Deletes a Kusto principalAssignment. @@ -54,6 +68,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ClusterInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: DeleteViaIdentityCluster +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ClusterName The name of the Kusto cluster. @@ -69,12 +98,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DatabaseInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: DeleteViaIdentityDatabase +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -DatabaseName The name of the database in the Kusto cluster. ```yaml Type: System.String -Parameter Sets: Delete +Parameter Sets: Delete, DeleteViaIdentityCluster Aliases: Required: True @@ -102,7 +146,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -151,7 +194,7 @@ The name of the Kusto principalAssignment. ```yaml Type: System.String -Parameter Sets: Delete +Parameter Sets: Delete, DeleteViaIdentityCluster, DeleteViaIdentityDatabase Aliases: Required: True diff --git a/src/Kusto/Kusto.Autorest/docs/Remove-AzKustoManagedPrivateEndpoint.md b/src/Kusto/Kusto.Autorest/docs/Remove-AzKustoManagedPrivateEndpoint.md index bf5a23fe997e..59647ccacd11 100644 --- a/src/Kusto/Kusto.Autorest/docs/Remove-AzKustoManagedPrivateEndpoint.md +++ b/src/Kusto/Kusto.Autorest/docs/Remove-AzKustoManagedPrivateEndpoint.md @@ -25,6 +25,12 @@ Remove-AzKustoManagedPrivateEndpoint -InputObject [-DefaultProf [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] ``` +### DeleteViaIdentityCluster +``` +Remove-AzKustoManagedPrivateEndpoint -ClusterInputObject -Name + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + ## DESCRIPTION Deletes a managed private endpoint. @@ -54,6 +60,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ClusterInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: DeleteViaIdentityCluster +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ClusterName The name of the Kusto cluster. @@ -87,7 +108,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -106,7 +126,7 @@ The name of the managed private endpoint. ```yaml Type: System.String -Parameter Sets: Delete +Parameter Sets: Delete, DeleteViaIdentityCluster Aliases: ManagedPrivateEndpointName Required: True diff --git a/src/Kusto/Kusto.Autorest/docs/Remove-AzKustoPrivateEndpointConnection.md b/src/Kusto/Kusto.Autorest/docs/Remove-AzKustoPrivateEndpointConnection.md deleted file mode 100644 index 83a6186d5aab..000000000000 --- a/src/Kusto/Kusto.Autorest/docs/Remove-AzKustoPrivateEndpointConnection.md +++ /dev/null @@ -1,225 +0,0 @@ ---- -external help file: -Module Name: Az.Kusto -online version: https://learn.microsoft.com/powershell/module/az.kusto/remove-azkustoprivateendpointconnection -schema: 2.0.0 ---- - -# Remove-AzKustoPrivateEndpointConnection - -## SYNOPSIS -Deletes a private endpoint connection with a given name. - -## SYNTAX - -### Delete (Default) -``` -Remove-AzKustoPrivateEndpointConnection -ClusterName -Name -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] - [] -``` - -### DeleteViaIdentity -``` -Remove-AzKustoPrivateEndpointConnection -InputObject [-DefaultProfile ] [-AsJob] - [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION -Deletes a private endpoint connection with a given name. - -## EXAMPLES - -### Example 1: Delete an existing Kusto PrivateEndpointConnection by name -```powershell -Remove-AzKustoPrivateEndpointConnection -ClusterName "mycluster" -ResourceGroupName "testrg" -Name "testprivateconnection-12345678-1234-1234-1234-123456789098" -``` - -The above command deletes the Kusto PrivateEndpointConnection named "testprivateconnection-12345678-1234-1234-1234-123456789098" in the cluster "mycluster" found in the resource group "testrg". - -## 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 -``` - -### -ClusterName -The name of the Kusto cluster. - -```yaml -Type: System.String -Parameter Sets: Delete -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 -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity -Parameter Sets: DeleteViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the private endpoint connection. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: PrivateEndpointConnectionName - -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. - -```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.Kusto.Models.IKustoIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - diff --git a/src/Kusto/Kusto.Autorest/docs/Remove-AzKustoSandboxCustomImage.md b/src/Kusto/Kusto.Autorest/docs/Remove-AzKustoSandboxCustomImage.md index 6078bc738fd8..88e3e82143b8 100644 --- a/src/Kusto/Kusto.Autorest/docs/Remove-AzKustoSandboxCustomImage.md +++ b/src/Kusto/Kusto.Autorest/docs/Remove-AzKustoSandboxCustomImage.md @@ -25,6 +25,12 @@ Remove-AzKustoSandboxCustomImage -InputObject [-DefaultProfile [-PassThru] [-Confirm] [-WhatIf] [] ``` +### DeleteViaIdentityCluster +``` +Remove-AzKustoSandboxCustomImage -ClusterInputObject -Name + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + ## DESCRIPTION Deletes a sandbox custom image. @@ -54,6 +60,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ClusterInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: DeleteViaIdentityCluster +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ClusterName The name of the Kusto cluster. @@ -87,7 +108,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -106,7 +126,7 @@ The name of the sandbox custom image. ```yaml Type: System.String -Parameter Sets: Delete +Parameter Sets: Delete, DeleteViaIdentityCluster Aliases: SandboxCustomImageName Required: True diff --git a/src/Kusto/Kusto.Autorest/docs/Remove-AzKustoScript.md b/src/Kusto/Kusto.Autorest/docs/Remove-AzKustoScript.md index b12142579d36..21f50697f6cf 100644 --- a/src/Kusto/Kusto.Autorest/docs/Remove-AzKustoScript.md +++ b/src/Kusto/Kusto.Autorest/docs/Remove-AzKustoScript.md @@ -25,6 +25,18 @@ Remove-AzKustoScript -InputObject [-DefaultProfile ] [-Confirm] [-WhatIf] [] ``` +### DeleteViaIdentityCluster +``` +Remove-AzKustoScript -ClusterInputObject -DatabaseName -Name + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentityDatabase +``` +Remove-AzKustoScript -DatabaseInputObject -Name [-DefaultProfile ] + [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + ## DESCRIPTION Deletes a Kusto database script. @@ -54,6 +66,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ClusterInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: DeleteViaIdentityCluster +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ClusterName The name of the Kusto cluster. @@ -69,12 +96,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DatabaseInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: DeleteViaIdentityDatabase +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -DatabaseName The name of the database in the Kusto cluster. ```yaml Type: System.String -Parameter Sets: Delete +Parameter Sets: Delete, DeleteViaIdentityCluster Aliases: Required: True @@ -102,7 +144,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -121,7 +162,7 @@ The name of the Kusto database script. ```yaml Type: System.String -Parameter Sets: Delete +Parameter Sets: Delete, DeleteViaIdentityCluster, DeleteViaIdentityDatabase Aliases: ScriptName Required: True diff --git a/src/Kusto/Kusto.Autorest/docs/Start-AzKustoCluster.md b/src/Kusto/Kusto.Autorest/docs/Start-AzKustoCluster.md index 175737438245..21530c80a554 100644 --- a/src/Kusto/Kusto.Autorest/docs/Start-AzKustoCluster.md +++ b/src/Kusto/Kusto.Autorest/docs/Start-AzKustoCluster.md @@ -71,7 +71,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity diff --git a/src/Kusto/Kusto.Autorest/docs/Stop-AzKustoCluster.md b/src/Kusto/Kusto.Autorest/docs/Stop-AzKustoCluster.md index d9956d4e8ff3..5a3b9474f989 100644 --- a/src/Kusto/Kusto.Autorest/docs/Stop-AzKustoCluster.md +++ b/src/Kusto/Kusto.Autorest/docs/Stop-AzKustoCluster.md @@ -71,7 +71,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity diff --git a/src/Kusto/Kusto.Autorest/docs/Test-AzKustoAttachedDatabaseConfigurationNameAvailability.md b/src/Kusto/Kusto.Autorest/docs/Test-AzKustoAttachedDatabaseConfigurationNameAvailability.md index 08627c2a43cc..0b43cfd3e7d1 100644 --- a/src/Kusto/Kusto.Autorest/docs/Test-AzKustoAttachedDatabaseConfigurationNameAvailability.md +++ b/src/Kusto/Kusto.Autorest/docs/Test-AzKustoAttachedDatabaseConfigurationNameAvailability.md @@ -25,6 +25,20 @@ Test-AzKustoAttachedDatabaseConfigurationNameAvailability -InputObject ] [-Confirm] [-WhatIf] [] ``` +### CheckViaJsonFilePath +``` +Test-AzKustoAttachedDatabaseConfigurationNameAvailability -ClusterName -ResourceGroupName + -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### CheckViaJsonString +``` +Test-AzKustoAttachedDatabaseConfigurationNameAvailability -ClusterName -ResourceGroupName + -JsonString [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + ## DESCRIPTION Checks that the attached database configuration resource name is valid and is not already in use. @@ -50,7 +64,7 @@ The name of the Kusto cluster. ```yaml Type: System.String -Parameter Sets: CheckExpanded +Parameter Sets: CheckExpanded, CheckViaJsonFilePath, CheckViaJsonString Aliases: Required: True @@ -78,7 +92,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -92,12 +105,42 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -JsonFilePath +Path of Json file supplied to the Check operation + +```yaml +Type: System.String +Parameter Sets: CheckViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Check operation + +```yaml +Type: System.String +Parameter Sets: CheckViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name Attached database resource name. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CheckExpanded, CheckViaIdentityExpanded Aliases: Required: True @@ -113,7 +156,7 @@ The name is case insensitive. ```yaml Type: System.String -Parameter Sets: CheckExpanded +Parameter Sets: CheckExpanded, CheckViaJsonFilePath, CheckViaJsonString Aliases: Required: True @@ -128,7 +171,7 @@ The ID of the target subscription. ```yaml Type: System.String -Parameter Sets: CheckExpanded +Parameter Sets: CheckExpanded, CheckViaJsonFilePath, CheckViaJsonString Aliases: Required: False @@ -178,7 +221,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ICheckNameResult +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ICheckNameResult ## NOTES diff --git a/src/Kusto/Kusto.Autorest/docs/Test-AzKustoClusterNameAvailability.md b/src/Kusto/Kusto.Autorest/docs/Test-AzKustoClusterNameAvailability.md index 82f330fa7a5d..dd3d841c1f96 100644 --- a/src/Kusto/Kusto.Autorest/docs/Test-AzKustoClusterNameAvailability.md +++ b/src/Kusto/Kusto.Autorest/docs/Test-AzKustoClusterNameAvailability.md @@ -24,6 +24,18 @@ Test-AzKustoClusterNameAvailability -InputObject -Name [-Confirm] [-WhatIf] [] ``` +### CheckViaJsonFilePath +``` +Test-AzKustoClusterNameAvailability -Location -JsonFilePath [-SubscriptionId ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### CheckViaJsonString +``` +Test-AzKustoClusterNameAvailability -Location -JsonString [-SubscriptionId ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + ## DESCRIPTION Checks that the cluster name is valid and is not already in use. @@ -75,7 +87,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -89,12 +100,42 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -JsonFilePath +Path of Json file supplied to the Check operation + +```yaml +Type: System.String +Parameter Sets: CheckViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Check operation + +```yaml +Type: System.String +Parameter Sets: CheckViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Location The name of Azure region. ```yaml Type: System.String -Parameter Sets: CheckExpanded +Parameter Sets: CheckExpanded, CheckViaJsonFilePath, CheckViaJsonString Aliases: Required: True @@ -109,7 +150,7 @@ Cluster name. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CheckExpanded, CheckViaIdentityExpanded Aliases: Required: True @@ -124,7 +165,7 @@ The ID of the target subscription. ```yaml Type: System.String -Parameter Sets: CheckExpanded +Parameter Sets: CheckExpanded, CheckViaJsonFilePath, CheckViaJsonString Aliases: Required: False @@ -174,7 +215,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ICheckNameResult +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ICheckNameResult ## NOTES diff --git a/src/Kusto/Kusto.Autorest/docs/Test-AzKustoClusterPrincipalAssignmentNameAvailability.md b/src/Kusto/Kusto.Autorest/docs/Test-AzKustoClusterPrincipalAssignmentNameAvailability.md index 1b3783f42f74..2ea1ed290749 100644 --- a/src/Kusto/Kusto.Autorest/docs/Test-AzKustoClusterPrincipalAssignmentNameAvailability.md +++ b/src/Kusto/Kusto.Autorest/docs/Test-AzKustoClusterPrincipalAssignmentNameAvailability.md @@ -25,6 +25,20 @@ Test-AzKustoClusterPrincipalAssignmentNameAvailability -InputObject ] [-Confirm] [-WhatIf] [] ``` +### CheckViaJsonFilePath +``` +Test-AzKustoClusterPrincipalAssignmentNameAvailability -ClusterName -ResourceGroupName + -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### CheckViaJsonString +``` +Test-AzKustoClusterPrincipalAssignmentNameAvailability -ClusterName -ResourceGroupName + -JsonString [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + ## DESCRIPTION Checks that the principal assignment name is valid and is not already in use. @@ -63,7 +77,7 @@ The name of the Kusto cluster. ```yaml Type: System.String -Parameter Sets: CheckExpanded +Parameter Sets: CheckExpanded, CheckViaJsonFilePath, CheckViaJsonString Aliases: Required: True @@ -91,7 +105,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -105,12 +118,42 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -JsonFilePath +Path of Json file supplied to the Check operation + +```yaml +Type: System.String +Parameter Sets: CheckViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Check operation + +```yaml +Type: System.String +Parameter Sets: CheckViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name Principal Assignment resource name. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CheckExpanded, CheckViaIdentityExpanded Aliases: Required: True @@ -126,7 +169,7 @@ The name is case insensitive. ```yaml Type: System.String -Parameter Sets: CheckExpanded +Parameter Sets: CheckExpanded, CheckViaJsonFilePath, CheckViaJsonString Aliases: Required: True @@ -141,7 +184,7 @@ The ID of the target subscription. ```yaml Type: System.String -Parameter Sets: CheckExpanded +Parameter Sets: CheckExpanded, CheckViaJsonFilePath, CheckViaJsonString Aliases: Required: False @@ -191,7 +234,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ICheckNameResult +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ICheckNameResult ## NOTES diff --git a/src/Kusto/Kusto.Autorest/docs/Test-AzKustoDataConnectionNameAvailability.md b/src/Kusto/Kusto.Autorest/docs/Test-AzKustoDataConnectionNameAvailability.md index 0c7b435bc52f..c0281b649a7d 100644 --- a/src/Kusto/Kusto.Autorest/docs/Test-AzKustoDataConnectionNameAvailability.md +++ b/src/Kusto/Kusto.Autorest/docs/Test-AzKustoDataConnectionNameAvailability.md @@ -19,12 +19,32 @@ Test-AzKustoDataConnectionNameAvailability -ClusterName -DatabaseName < [-WhatIf] [] ``` +### CheckViaIdentityClusterExpanded +``` +Test-AzKustoDataConnectionNameAvailability -ClusterInputObject -DatabaseName + -Name [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + ### CheckViaIdentityExpanded ``` Test-AzKustoDataConnectionNameAvailability -InputObject -Name [-DefaultProfile ] [-Confirm] [-WhatIf] [] ``` +### CheckViaJsonFilePath +``` +Test-AzKustoDataConnectionNameAvailability -ClusterName -DatabaseName + -ResourceGroupName -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] + [-Confirm] [-WhatIf] [] +``` + +### CheckViaJsonString +``` +Test-AzKustoDataConnectionNameAvailability -ClusterName -DatabaseName + -ResourceGroupName -JsonString [-SubscriptionId ] [-DefaultProfile ] + [-Confirm] [-WhatIf] [] +``` + ## DESCRIPTION Checks that the data connection name is valid and is not already in use. @@ -58,12 +78,27 @@ The above command returns whether or not a Data Connection named "mydataconnecti ## PARAMETERS +### -ClusterInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: CheckViaIdentityClusterExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ClusterName The name of the Kusto cluster. ```yaml Type: System.String -Parameter Sets: CheckExpanded +Parameter Sets: CheckExpanded, CheckViaJsonFilePath, CheckViaJsonString Aliases: Required: True @@ -78,7 +113,7 @@ The name of the database in the Kusto cluster. ```yaml Type: System.String -Parameter Sets: CheckExpanded +Parameter Sets: CheckExpanded, CheckViaIdentityClusterExpanded, CheckViaJsonFilePath, CheckViaJsonString Aliases: Required: True @@ -106,7 +141,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -120,12 +154,42 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -JsonFilePath +Path of Json file supplied to the Check operation + +```yaml +Type: System.String +Parameter Sets: CheckViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Check operation + +```yaml +Type: System.String +Parameter Sets: CheckViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name Data Connection name. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CheckExpanded, CheckViaIdentityClusterExpanded, CheckViaIdentityExpanded Aliases: Required: True @@ -141,7 +205,7 @@ The name is case insensitive. ```yaml Type: System.String -Parameter Sets: CheckExpanded +Parameter Sets: CheckExpanded, CheckViaJsonFilePath, CheckViaJsonString Aliases: Required: True @@ -156,7 +220,7 @@ The ID of the target subscription. ```yaml Type: System.String -Parameter Sets: CheckExpanded +Parameter Sets: CheckExpanded, CheckViaJsonFilePath, CheckViaJsonString Aliases: Required: False @@ -206,7 +270,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ICheckNameResult +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ICheckNameResult ## NOTES diff --git a/src/Kusto/Kusto.Autorest/docs/Test-AzKustoDatabaseNameAvailability.md b/src/Kusto/Kusto.Autorest/docs/Test-AzKustoDatabaseNameAvailability.md index 15228a6bffc4..d7b2bba98e6d 100644 --- a/src/Kusto/Kusto.Autorest/docs/Test-AzKustoDatabaseNameAvailability.md +++ b/src/Kusto/Kusto.Autorest/docs/Test-AzKustoDatabaseNameAvailability.md @@ -15,16 +15,28 @@ Checks that the databases resource name is valid and is not already in use. ### CheckExpanded (Default) ``` Test-AzKustoDatabaseNameAvailability -ClusterName -ResourceGroupName -Name - -Type [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] + -Type [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] ``` ### CheckViaIdentityExpanded ``` -Test-AzKustoDatabaseNameAvailability -InputObject -Name -Type +Test-AzKustoDatabaseNameAvailability -InputObject -Name -Type [-DefaultProfile ] [-Confirm] [-WhatIf] [] ``` +### CheckViaJsonFilePath +``` +Test-AzKustoDatabaseNameAvailability -ClusterName -ResourceGroupName -JsonFilePath + [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### CheckViaJsonString +``` +Test-AzKustoDatabaseNameAvailability -ClusterName -ResourceGroupName -JsonString + [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + ## DESCRIPTION Checks that the databases resource name is valid and is not already in use. @@ -63,7 +75,7 @@ The name of the Kusto cluster. ```yaml Type: System.String -Parameter Sets: CheckExpanded +Parameter Sets: CheckExpanded, CheckViaJsonFilePath, CheckViaJsonString Aliases: Required: True @@ -91,7 +103,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -105,12 +116,42 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -JsonFilePath +Path of Json file supplied to the Check operation + +```yaml +Type: System.String +Parameter Sets: CheckViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Check operation + +```yaml +Type: System.String +Parameter Sets: CheckViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name Resource name. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CheckExpanded, CheckViaIdentityExpanded Aliases: Required: True @@ -126,7 +167,7 @@ The name is case insensitive. ```yaml Type: System.String -Parameter Sets: CheckExpanded +Parameter Sets: CheckExpanded, CheckViaJsonFilePath, CheckViaJsonString Aliases: Required: True @@ -141,7 +182,7 @@ The ID of the target subscription. ```yaml Type: System.String -Parameter Sets: CheckExpanded +Parameter Sets: CheckExpanded, CheckViaJsonFilePath, CheckViaJsonString Aliases: Required: False @@ -155,8 +196,8 @@ Accept wildcard characters: False The type of resource, for instance Microsoft.Kusto/Clusters/databases. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.Type -Parameter Sets: (All) +Type: System.String +Parameter Sets: CheckExpanded, CheckViaIdentityExpanded Aliases: Required: True @@ -206,7 +247,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ICheckNameResult +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ICheckNameResult ## NOTES diff --git a/src/Kusto/Kusto.Autorest/docs/Test-AzKustoDatabasePrincipalAssignmentNameAvailability.md b/src/Kusto/Kusto.Autorest/docs/Test-AzKustoDatabasePrincipalAssignmentNameAvailability.md index 39e0cd464c43..d2a781fc883a 100644 --- a/src/Kusto/Kusto.Autorest/docs/Test-AzKustoDatabasePrincipalAssignmentNameAvailability.md +++ b/src/Kusto/Kusto.Autorest/docs/Test-AzKustoDatabasePrincipalAssignmentNameAvailability.md @@ -19,12 +19,32 @@ Test-AzKustoDatabasePrincipalAssignmentNameAvailability -ClusterName -D [-WhatIf] [] ``` +### CheckViaIdentityClusterExpanded +``` +Test-AzKustoDatabasePrincipalAssignmentNameAvailability -ClusterInputObject + -DatabaseName -Name [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + ### CheckViaIdentityExpanded ``` Test-AzKustoDatabasePrincipalAssignmentNameAvailability -InputObject -Name [-DefaultProfile ] [-Confirm] [-WhatIf] [] ``` +### CheckViaJsonFilePath +``` +Test-AzKustoDatabasePrincipalAssignmentNameAvailability -ClusterName -DatabaseName + -ResourceGroupName -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] + [-Confirm] [-WhatIf] [] +``` + +### CheckViaJsonString +``` +Test-AzKustoDatabasePrincipalAssignmentNameAvailability -ClusterName -DatabaseName + -ResourceGroupName -JsonString [-SubscriptionId ] [-DefaultProfile ] + [-Confirm] [-WhatIf] [] +``` + ## DESCRIPTION Checks that the database principal assignment is valid and is not already in use. @@ -58,12 +78,27 @@ The above command returns whether or not a PrincipalAssignment named "myprincipa ## PARAMETERS +### -ClusterInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: CheckViaIdentityClusterExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ClusterName The name of the Kusto cluster. ```yaml Type: System.String -Parameter Sets: CheckExpanded +Parameter Sets: CheckExpanded, CheckViaJsonFilePath, CheckViaJsonString Aliases: Required: True @@ -78,7 +113,7 @@ The name of the database in the Kusto cluster. ```yaml Type: System.String -Parameter Sets: CheckExpanded +Parameter Sets: CheckExpanded, CheckViaIdentityClusterExpanded, CheckViaJsonFilePath, CheckViaJsonString Aliases: Required: True @@ -106,7 +141,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -120,12 +154,42 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -JsonFilePath +Path of Json file supplied to the Check operation + +```yaml +Type: System.String +Parameter Sets: CheckViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Check operation + +```yaml +Type: System.String +Parameter Sets: CheckViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name Principal Assignment resource name. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CheckExpanded, CheckViaIdentityClusterExpanded, CheckViaIdentityExpanded Aliases: Required: True @@ -141,7 +205,7 @@ The name is case insensitive. ```yaml Type: System.String -Parameter Sets: CheckExpanded +Parameter Sets: CheckExpanded, CheckViaJsonFilePath, CheckViaJsonString Aliases: Required: True @@ -156,7 +220,7 @@ The ID of the target subscription. ```yaml Type: System.String -Parameter Sets: CheckExpanded +Parameter Sets: CheckExpanded, CheckViaJsonFilePath, CheckViaJsonString Aliases: Required: False @@ -206,7 +270,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ICheckNameResult +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ICheckNameResult ## NOTES diff --git a/src/Kusto/Kusto.Autorest/docs/Test-AzKustoManagedPrivateEndpointNameAvailability.md b/src/Kusto/Kusto.Autorest/docs/Test-AzKustoManagedPrivateEndpointNameAvailability.md index b53c89158f40..76255cdc67fd 100644 --- a/src/Kusto/Kusto.Autorest/docs/Test-AzKustoManagedPrivateEndpointNameAvailability.md +++ b/src/Kusto/Kusto.Autorest/docs/Test-AzKustoManagedPrivateEndpointNameAvailability.md @@ -25,6 +25,20 @@ Test-AzKustoManagedPrivateEndpointNameAvailability -InputObject [-DefaultProfile ] [-Confirm] [-WhatIf] [] ``` +### CheckViaJsonFilePath +``` +Test-AzKustoManagedPrivateEndpointNameAvailability -ClusterName -ResourceGroupName + -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### CheckViaJsonString +``` +Test-AzKustoManagedPrivateEndpointNameAvailability -ClusterName -ResourceGroupName + -JsonString [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + ## DESCRIPTION Checks that the managed private endpoints resource name is valid and is not already in use. @@ -50,7 +64,7 @@ The name of the Kusto cluster. ```yaml Type: System.String -Parameter Sets: CheckExpanded +Parameter Sets: CheckExpanded, CheckViaJsonFilePath, CheckViaJsonString Aliases: Required: True @@ -78,7 +92,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -92,12 +105,42 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -JsonFilePath +Path of Json file supplied to the Check operation + +```yaml +Type: System.String +Parameter Sets: CheckViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Check operation + +```yaml +Type: System.String +Parameter Sets: CheckViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name Managed private endpoint resource name. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CheckExpanded, CheckViaIdentityExpanded Aliases: Required: True @@ -113,7 +156,7 @@ The name is case insensitive. ```yaml Type: System.String -Parameter Sets: CheckExpanded +Parameter Sets: CheckExpanded, CheckViaJsonFilePath, CheckViaJsonString Aliases: Required: True @@ -128,7 +171,7 @@ The ID of the target subscription. ```yaml Type: System.String -Parameter Sets: CheckExpanded +Parameter Sets: CheckExpanded, CheckViaJsonFilePath, CheckViaJsonString Aliases: Required: False @@ -178,7 +221,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ICheckNameResult +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ICheckNameResult ## NOTES diff --git a/src/Kusto/Kusto.Autorest/docs/Test-AzKustoSandboxCustomImageNameAvailability.md b/src/Kusto/Kusto.Autorest/docs/Test-AzKustoSandboxCustomImageNameAvailability.md index 4fe77cffa908..754c5f273f51 100644 --- a/src/Kusto/Kusto.Autorest/docs/Test-AzKustoSandboxCustomImageNameAvailability.md +++ b/src/Kusto/Kusto.Autorest/docs/Test-AzKustoSandboxCustomImageNameAvailability.md @@ -25,6 +25,20 @@ Test-AzKustoSandboxCustomImageNameAvailability -InputObject -Na [-DefaultProfile ] [-Confirm] [-WhatIf] [] ``` +### CheckViaJsonFilePath +``` +Test-AzKustoSandboxCustomImageNameAvailability -ClusterName -ResourceGroupName + -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### CheckViaJsonString +``` +Test-AzKustoSandboxCustomImageNameAvailability -ClusterName -ResourceGroupName + -JsonString [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + ## DESCRIPTION Checks that the sandbox custom image resource name is valid and is not already in use. @@ -50,7 +64,7 @@ The name of the Kusto cluster. ```yaml Type: System.String -Parameter Sets: CheckExpanded +Parameter Sets: CheckExpanded, CheckViaJsonFilePath, CheckViaJsonString Aliases: Required: True @@ -78,7 +92,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -92,12 +105,42 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -JsonFilePath +Path of Json file supplied to the Check operation + +```yaml +Type: System.String +Parameter Sets: CheckViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Check operation + +```yaml +Type: System.String +Parameter Sets: CheckViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name Sandbox custom image resource name. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CheckExpanded, CheckViaIdentityExpanded Aliases: Required: True @@ -113,7 +156,7 @@ The name is case insensitive. ```yaml Type: System.String -Parameter Sets: CheckExpanded +Parameter Sets: CheckExpanded, CheckViaJsonFilePath, CheckViaJsonString Aliases: Required: True @@ -128,7 +171,7 @@ The ID of the target subscription. ```yaml Type: System.String -Parameter Sets: CheckExpanded +Parameter Sets: CheckExpanded, CheckViaJsonFilePath, CheckViaJsonString Aliases: Required: False @@ -178,7 +221,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ICheckNameResult +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ICheckNameResult ## NOTES diff --git a/src/Kusto/Kusto.Autorest/docs/Test-AzKustoScriptNameAvailability.md b/src/Kusto/Kusto.Autorest/docs/Test-AzKustoScriptNameAvailability.md index 2879d27ecd78..505d759005eb 100644 --- a/src/Kusto/Kusto.Autorest/docs/Test-AzKustoScriptNameAvailability.md +++ b/src/Kusto/Kusto.Autorest/docs/Test-AzKustoScriptNameAvailability.md @@ -19,12 +19,32 @@ Test-AzKustoScriptNameAvailability -ClusterName -DatabaseName [] ``` +### CheckViaIdentityClusterExpanded +``` +Test-AzKustoScriptNameAvailability -ClusterInputObject -DatabaseName -Name + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + ### CheckViaIdentityExpanded ``` Test-AzKustoScriptNameAvailability -InputObject -Name [-DefaultProfile ] [-Confirm] [-WhatIf] [] ``` +### CheckViaJsonFilePath +``` +Test-AzKustoScriptNameAvailability -ClusterName -DatabaseName -ResourceGroupName + -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### CheckViaJsonString +``` +Test-AzKustoScriptNameAvailability -ClusterName -DatabaseName -ResourceGroupName + -JsonString [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + ## DESCRIPTION Checks that the script name is valid and is not already in use. @@ -58,12 +78,27 @@ The above command checks that the script name which is not valid. ## PARAMETERS +### -ClusterInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: CheckViaIdentityClusterExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ClusterName The name of the Kusto cluster. ```yaml Type: System.String -Parameter Sets: CheckExpanded +Parameter Sets: CheckExpanded, CheckViaJsonFilePath, CheckViaJsonString Aliases: Required: True @@ -78,7 +113,7 @@ The name of the database in the Kusto cluster. ```yaml Type: System.String -Parameter Sets: CheckExpanded +Parameter Sets: CheckExpanded, CheckViaIdentityClusterExpanded, CheckViaJsonFilePath, CheckViaJsonString Aliases: Required: True @@ -106,7 +141,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -120,12 +154,42 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -JsonFilePath +Path of Json file supplied to the Check operation + +```yaml +Type: System.String +Parameter Sets: CheckViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Check operation + +```yaml +Type: System.String +Parameter Sets: CheckViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name Script name. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CheckExpanded, CheckViaIdentityClusterExpanded, CheckViaIdentityExpanded Aliases: Required: True @@ -141,7 +205,7 @@ The name is case insensitive. ```yaml Type: System.String -Parameter Sets: CheckExpanded +Parameter Sets: CheckExpanded, CheckViaJsonFilePath, CheckViaJsonString Aliases: Required: True @@ -156,7 +220,7 @@ The ID of the target subscription. ```yaml Type: System.String -Parameter Sets: CheckExpanded +Parameter Sets: CheckExpanded, CheckViaJsonFilePath, CheckViaJsonString Aliases: Required: False @@ -206,7 +270,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ICheckNameResult +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ICheckNameResult ## NOTES diff --git a/src/Kusto/Kusto.Autorest/docs/Update-AzKustoCluster.md b/src/Kusto/Kusto.Autorest/docs/Update-AzKustoCluster.md index 944841d328b5..c997ca3dc8dc 100644 --- a/src/Kusto/Kusto.Autorest/docs/Update-AzKustoCluster.md +++ b/src/Kusto/Kusto.Autorest/docs/Update-AzKustoCluster.md @@ -15,41 +15,34 @@ Update a Kusto cluster. ### UpdateExpanded (Default) ``` Update-AzKustoCluster -Name -ResourceGroupName [-SubscriptionId ] - [-IfMatch ] [-AcceptedAudience ] [-AllowedFqdnList ] - [-AllowedIPRangeList ] [-CalloutPolicy ] [-EnableAutoStop] - [-EnableDiskEncryption] [-EnableDoubleEncryption] [-EnablePurge] [-EnableStreamingIngest] - [-EngineType ] [-IdentityType ] [-IdentityUserAssignedIdentity ] - [-KeyVaultPropertyKeyName ] [-KeyVaultPropertyKeyVaultUri ] - [-KeyVaultPropertyKeyVersion ] [-KeyVaultPropertyUserIdentity ] - [-LanguageExtensionValue ] [-Location ] [-OptimizedAutoscaleIsEnabled] - [-OptimizedAutoscaleMaximum ] [-OptimizedAutoscaleMinimum ] - [-OptimizedAutoscaleVersion ] [-PublicIPType ] - [-PublicNetworkAccess ] [-RestrictOutboundNetworkAccess ] - [-SkuCapacity ] [-SkuName ] [-SkuTier ] [-Tag ] - [-TrustedExternalTenant ] [-VirtualClusterGraduationProperty ] - [-VirtualNetworkConfigurationDataManagementPublicIPId ] - [-VirtualNetworkConfigurationEnginePublicIPId ] [-VirtualNetworkConfigurationState ] - [-VirtualNetworkConfigurationSubnetId ] [-Zone ] [-DefaultProfile ] [-AsJob] + [-IfMatch ] [-IfNoneMatch ] [-AcceptedAudience ] + [-AllowedFqdnList ] [-AllowedIPRangeList ] [-CalloutPolicy ] + [-EnableAutoStop] [-EnableDiskEncryption] [-EnableDoubleEncryption] [-EnablePurge] [-EnableStreamingIngest] + [-EnableSystemAssignedIdentity ] [-EngineType ] [-KeyVaultPropertyKeyName ] + [-KeyVaultPropertyKeyVaultUri ] [-KeyVaultPropertyKeyVersion ] + [-KeyVaultPropertyUserIdentity ] [-LanguageExtensionValue ] + [-OptimizedAutoscaleIsEnabled] [-OptimizedAutoscaleMaximum ] [-OptimizedAutoscaleMinimum ] + [-OptimizedAutoscaleVersion ] [-PublicIPType ] [-PublicNetworkAccess ] + [-RestrictOutboundNetworkAccess ] [-SkuCapacity ] [-SkuName ] [-SkuTier ] + [-Tag ] [-TrustedExternalTenant ] [-UserAssignedIdentity ] + [-VirtualNetworkConfigurationState ] [-Zone ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] ``` ### UpdateViaIdentityExpanded ``` -Update-AzKustoCluster -InputObject [-IfMatch ] +Update-AzKustoCluster -InputObject [-IfMatch ] [-IfNoneMatch ] [-AcceptedAudience ] [-AllowedFqdnList ] [-AllowedIPRangeList ] [-CalloutPolicy ] [-EnableAutoStop] [-EnableDiskEncryption] [-EnableDoubleEncryption] - [-EnablePurge] [-EnableStreamingIngest] [-EngineType ] [-IdentityType ] - [-IdentityUserAssignedIdentity ] [-KeyVaultPropertyKeyName ] - [-KeyVaultPropertyKeyVaultUri ] [-KeyVaultPropertyKeyVersion ] - [-KeyVaultPropertyUserIdentity ] [-LanguageExtensionValue ] - [-Location ] [-OptimizedAutoscaleIsEnabled] [-OptimizedAutoscaleMaximum ] - [-OptimizedAutoscaleMinimum ] [-OptimizedAutoscaleVersion ] [-PublicIPType ] - [-PublicNetworkAccess ] [-RestrictOutboundNetworkAccess ] - [-SkuCapacity ] [-SkuName ] [-SkuTier ] [-Tag ] - [-TrustedExternalTenant ] [-VirtualClusterGraduationProperty ] - [-VirtualNetworkConfigurationDataManagementPublicIPId ] - [-VirtualNetworkConfigurationEnginePublicIPId ] [-VirtualNetworkConfigurationState ] - [-VirtualNetworkConfigurationSubnetId ] [-Zone ] [-DefaultProfile ] [-AsJob] + [-EnablePurge] [-EnableStreamingIngest] [-EnableSystemAssignedIdentity ] [-EngineType ] + [-KeyVaultPropertyKeyName ] [-KeyVaultPropertyKeyVaultUri ] + [-KeyVaultPropertyKeyVersion ] [-KeyVaultPropertyUserIdentity ] + [-LanguageExtensionValue ] [-OptimizedAutoscaleIsEnabled] + [-OptimizedAutoscaleMaximum ] [-OptimizedAutoscaleMinimum ] + [-OptimizedAutoscaleVersion ] [-PublicIPType ] [-PublicNetworkAccess ] + [-RestrictOutboundNetworkAccess ] [-SkuCapacity ] [-SkuName ] [-SkuTier ] + [-Tag ] [-TrustedExternalTenant ] [-UserAssignedIdentity ] + [-VirtualNetworkConfigurationState ] [-Zone ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] ``` @@ -88,10 +81,9 @@ The above command updates the cluster "testnewkustocluster" found in the resourc ### -AcceptedAudience The cluster's accepted audiences. -To construct, see NOTES section for ACCEPTEDAUDIENCE properties and create a hash table. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IAcceptedAudiences[] +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IAcceptedAudiences[] Parameter Sets: (All) Aliases: @@ -149,10 +141,9 @@ Accept wildcard characters: False ### -CalloutPolicy List of callout policies for egress from Cluster. -To construct, see NOTES section for CALLOUTPOLICY properties and create a hash table. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ICalloutPolicy[] +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ICalloutPolicy[] Parameter Sets: (All) Aliases: @@ -254,11 +245,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EngineType -The engine type +### -EnableSystemAssignedIdentity +Determines whether to enable a system-assigned identity for the resource. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.EngineType +Type: System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -269,13 +260,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IdentityType -The type of managed identity used. -The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. -The type 'None' will remove all identities. +### -EngineType +The engine type ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.IdentityType +Type: System.String Parameter Sets: (All) Aliases: @@ -286,12 +275,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IdentityUserAssignedIdentity -The list of user identities associated with the Kusto cluster. -The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. +### -IfMatch +The ETag of the cluster. +Omit this value to always overwrite the current cluster. +Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes. ```yaml -Type: System.Collections.Hashtable +Type: System.String Parameter Sets: (All) Aliases: @@ -302,10 +292,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IfMatch -The ETag of the cluster. -Omit this value to always overwrite the current cluster. -Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes. +### -IfNoneMatch +Set to '*' to allow a new cluster to be created, but to prevent updating an existing cluster. +Other values will result in a 412 Pre-condition Failed response. ```yaml Type: System.String @@ -321,7 +310,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -397,25 +385,9 @@ Accept wildcard characters: False ### -LanguageExtensionValue The list of language extensions. -To construct, see NOTES section for LANGUAGEEXTENSIONVALUE properties and create a hash table. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ILanguageExtension[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Resource location. - -```yaml -Type: System.String +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ILanguageExtension[] Parameter Sets: (All) Aliases: @@ -520,7 +492,7 @@ Accept wildcard characters: False Indicates what public IP type to create - IPv4 (default), or DualStack (both IPv4 and IPv6) ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.PublicIPType +Type: System.String Parameter Sets: (All) Aliases: @@ -536,7 +508,7 @@ Public network access to the cluster is enabled by default. When disabled, only private endpoint connection to the cluster is allowed ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.PublicNetworkAccess +Type: System.String Parameter Sets: (All) Aliases: @@ -568,7 +540,7 @@ Whether or not to restrict outbound network access. Value is optional but if passed in, must be 'Enabled' or 'Disabled' ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.ClusterNetworkAccessFlag +Type: System.String Parameter Sets: (All) Aliases: @@ -598,7 +570,7 @@ Accept wildcard characters: False SKU name. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.AzureSkuName +Type: System.String Parameter Sets: (All) Aliases: @@ -613,7 +585,7 @@ Accept wildcard characters: False SKU tier. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.AzureSkuTier +Type: System.String Parameter Sets: (All) Aliases: @@ -656,10 +628,9 @@ Accept wildcard characters: False ### -TrustedExternalTenant The cluster's external tenants. -To construct, see NOTES section for TRUSTEDEXTERNALTENANT properties and create a hash table. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ITrustedExternalTenant[] +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ITrustedExternalTenant[] Parameter Sets: (All) Aliases: @@ -670,41 +641,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -VirtualClusterGraduationProperty -Virtual Cluster graduation properties +### -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: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualNetworkConfigurationDataManagementPublicIPId -Data management's service public IP address resource id. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualNetworkConfigurationEnginePublicIPId -Engine service's public IP address resource id. - -```yaml -Type: System.String +Type: System.String[] Parameter Sets: (All) Aliases: @@ -718,21 +660,6 @@ Accept wildcard characters: False ### -VirtualNetworkConfigurationState When enabled, the cluster is deployed into the configured subnet, when disabled it will be removed from the subnet. -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.VnetState -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualNetworkConfigurationSubnetId -The subnet resource id. - ```yaml Type: System.String Parameter Sets: (All) @@ -800,7 +727,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ICluster +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ICluster ## NOTES diff --git a/src/Kusto/Kusto.Autorest/docs/Update-AzKustoDataConnection.md b/src/Kusto/Kusto.Autorest/docs/Update-AzKustoDataConnection.md index 982bce3d8ecc..b26cf0c64573 100644 --- a/src/Kusto/Kusto.Autorest/docs/Update-AzKustoDataConnection.md +++ b/src/Kusto/Kusto.Autorest/docs/Update-AzKustoDataConnection.md @@ -8,26 +8,25 @@ schema: 2.0.0 # Update-AzKustoDataConnection ## SYNOPSIS -Updates a data connection. +Update a data connection. ## SYNTAX ### UpdateExpandedEventHub (Default) ``` Update-AzKustoDataConnection -ClusterName -DatabaseName -Name - -ResourceGroupName -ConsumerGroup -EventHubResourceId -Kind - -Location [-SubscriptionId ] [-Compression ] - [-DatabaseRouting ] [-DataFormat ] [-EventSystemProperty ] - [-ManagedIdentityResourceId ] [-MappingRuleName ] [-RetrievalStartDate ] - [-TableName ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] - [] + -ResourceGroupName -ConsumerGroup -EventHubResourceId -Kind + -Location [-SubscriptionId ] [-Compression ] [-DatabaseRouting ] + [-DataFormat ] [-EventSystemProperty ] [-ManagedIdentityResourceId ] + [-MappingRuleName ] [-RetrievalStartDate ] [-TableName ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] ``` ### UpdateExpandedCosmosDb ``` Update-AzKustoDataConnection -ClusterName -DatabaseName -Name -ResourceGroupName -CosmosDbAccountResourceId -CosmosDbContainer - -CosmosDbDatabase -Kind -Location -ManagedIdentityResourceId + -CosmosDbDatabase -Kind -Location -ManagedIdentityResourceId -TableName [-SubscriptionId ] [-MappingRuleName ] [-RetrievalStartDate ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] ``` @@ -35,9 +34,9 @@ Update-AzKustoDataConnection -ClusterName -DatabaseName -Name ### UpdateExpandedEventGrid ``` Update-AzKustoDataConnection -ClusterName -DatabaseName -Name - -ResourceGroupName -ConsumerGroup -EventHubResourceId -Kind + -ResourceGroupName -ConsumerGroup -EventHubResourceId -Kind -Location -StorageAccountResourceId [-SubscriptionId ] - [-BlobStorageEventType ] [-DatabaseRouting ] [-DataFormat ] + [-BlobStorageEventType ] [-DatabaseRouting ] [-DataFormat ] [-EventGridResourceId ] [-IgnoreFirstRecord] [-ManagedIdentityResourceId ] [-MappingRuleName ] [-TableName ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] @@ -46,17 +45,17 @@ Update-AzKustoDataConnection -ClusterName -DatabaseName -Name ### UpdateExpandedIotHub ``` Update-AzKustoDataConnection -ClusterName -DatabaseName -Name - -ResourceGroupName -ConsumerGroup -IotHubResourceId -Kind - -Location -SharedAccessPolicyName [-SubscriptionId ] - [-DatabaseRouting ] [-DataFormat ] [-EventSystemProperty ] - [-MappingRuleName ] [-RetrievalStartDate ] [-TableName ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] + -ResourceGroupName -ConsumerGroup -IotHubResourceId -Kind + -Location -SharedAccessPolicyName [-SubscriptionId ] [-DatabaseRouting ] + [-DataFormat ] [-EventSystemProperty ] [-MappingRuleName ] + [-RetrievalStartDate ] [-TableName ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [] ``` ### UpdateViaIdentityExpandedCosmosDb ``` Update-AzKustoDataConnection -InputObject -CosmosDbAccountResourceId - -CosmosDbContainer -CosmosDbDatabase -Kind -Location + -CosmosDbContainer -CosmosDbDatabase -Kind -Location -ManagedIdentityResourceId -TableName [-MappingRuleName ] [-RetrievalStartDate ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] @@ -65,8 +64,8 @@ Update-AzKustoDataConnection -InputObject -CosmosDbAccountResou ### UpdateViaIdentityExpandedEventGrid ``` Update-AzKustoDataConnection -InputObject -ConsumerGroup - -EventHubResourceId -Kind -Location -StorageAccountResourceId - [-BlobStorageEventType ] [-DatabaseRouting ] [-DataFormat ] + -EventHubResourceId -Kind -Location -StorageAccountResourceId + [-BlobStorageEventType ] [-DatabaseRouting ] [-DataFormat ] [-EventGridResourceId ] [-IgnoreFirstRecord] [-ManagedIdentityResourceId ] [-MappingRuleName ] [-TableName ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] @@ -75,8 +74,8 @@ Update-AzKustoDataConnection -InputObject -ConsumerGroup -ConsumerGroup - -EventHubResourceId -Kind -Location [-Compression ] - [-DatabaseRouting ] [-DataFormat ] [-EventSystemProperty ] + -EventHubResourceId -Kind -Location [-Compression ] + [-DatabaseRouting ] [-DataFormat ] [-EventSystemProperty ] [-ManagedIdentityResourceId ] [-MappingRuleName ] [-RetrievalStartDate ] [-TableName ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] @@ -85,14 +84,28 @@ Update-AzKustoDataConnection -InputObject -ConsumerGroup -ConsumerGroup -IotHubResourceId - -Kind -Location -SharedAccessPolicyName [-DatabaseRouting ] + -Kind -Location -SharedAccessPolicyName [-DatabaseRouting ] [-DataFormat ] [-EventSystemProperty ] [-MappingRuleName ] [-RetrievalStartDate ] [-TableName ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] ``` +### UpdateViaJsonFilePath +``` +Update-AzKustoDataConnection -ClusterName -DatabaseName -Name + -ResourceGroupName -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaJsonString +``` +Update-AzKustoDataConnection -ClusterName -DatabaseName -Name + -ResourceGroupName -JsonString [-SubscriptionId ] [-DefaultProfile ] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + ## DESCRIPTION -Updates a data connection. +Update a data connection. ## EXAMPLES @@ -198,7 +211,7 @@ Accept wildcard characters: False The name of blob storage event type to process. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.BlobStorageEventType +Type: System.String Parameter Sets: UpdateExpandedEventGrid, UpdateViaIdentityExpandedEventGrid Aliases: @@ -214,7 +227,7 @@ The name of the Kusto cluster. ```yaml Type: System.String -Parameter Sets: UpdateExpandedCosmosDb, UpdateExpandedEventGrid, UpdateExpandedEventHub, UpdateExpandedIotHub +Parameter Sets: UpdateExpandedCosmosDb, UpdateExpandedEventGrid, UpdateExpandedEventHub, UpdateExpandedIotHub, UpdateViaJsonFilePath, UpdateViaJsonString Aliases: Required: True @@ -228,7 +241,7 @@ Accept wildcard characters: False The event hub messages compression type. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.Compression +Type: System.String Parameter Sets: UpdateExpandedEventHub, UpdateViaIdentityExpandedEventHub Aliases: @@ -304,7 +317,7 @@ The name of the database in the Kusto cluster. ```yaml Type: System.String -Parameter Sets: UpdateExpandedCosmosDb, UpdateExpandedEventGrid, UpdateExpandedEventHub, UpdateExpandedIotHub +Parameter Sets: UpdateExpandedCosmosDb, UpdateExpandedEventGrid, UpdateExpandedEventHub, UpdateExpandedIotHub, UpdateViaJsonFilePath, UpdateViaJsonString Aliases: Required: True @@ -318,7 +331,7 @@ Accept wildcard characters: False Indication for database routing information from the data connection, by default only database routing information is allowed. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.DatabaseRouting +Type: System.String Parameter Sets: UpdateExpandedEventGrid, UpdateExpandedEventHub, UpdateExpandedIotHub, UpdateViaIdentityExpandedEventGrid, UpdateViaIdentityExpandedEventHub, UpdateViaIdentityExpandedIotHub Aliases: @@ -346,7 +359,8 @@ Accept wildcard characters: False ``` ### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. +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 @@ -451,12 +465,42 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -JsonFilePath +Path of Json file supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Kind Kind of the endpoint for the data connection ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.Kind -Parameter Sets: (All) +Type: System.String +Parameter Sets: UpdateExpandedCosmosDb, UpdateExpandedEventGrid, UpdateExpandedEventHub, UpdateExpandedIotHub, UpdateViaIdentityExpandedCosmosDb, UpdateViaIdentityExpandedEventGrid, UpdateViaIdentityExpandedEventHub, UpdateViaIdentityExpandedIotHub Aliases: Required: True @@ -471,7 +515,7 @@ Resource location. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: UpdateExpandedCosmosDb, UpdateExpandedEventGrid, UpdateExpandedEventHub, UpdateExpandedIotHub, UpdateViaIdentityExpandedCosmosDb, UpdateViaIdentityExpandedEventGrid, UpdateViaIdentityExpandedEventHub, UpdateViaIdentityExpandedIotHub Aliases: Required: True @@ -502,7 +546,7 @@ Optionally the mapping information can be added to each message. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: UpdateExpandedCosmosDb, UpdateExpandedEventGrid, UpdateExpandedEventHub, UpdateExpandedIotHub, UpdateViaIdentityExpandedCosmosDb, UpdateViaIdentityExpandedEventGrid, UpdateViaIdentityExpandedEventHub, UpdateViaIdentityExpandedIotHub Aliases: Required: False @@ -517,7 +561,7 @@ The name of the data connection. ```yaml Type: System.String -Parameter Sets: UpdateExpandedCosmosDb, UpdateExpandedEventGrid, UpdateExpandedEventHub, UpdateExpandedIotHub +Parameter Sets: UpdateExpandedCosmosDb, UpdateExpandedEventGrid, UpdateExpandedEventHub, UpdateExpandedIotHub, UpdateViaJsonFilePath, UpdateViaJsonString Aliases: DataConnectionName Required: True @@ -543,11 +587,12 @@ Accept wildcard characters: False ``` ### -ResourceGroupName -The name of the resource group containing the Kusto cluster. +The name of the resource group. +The name is case insensitive. ```yaml Type: System.String -Parameter Sets: UpdateExpandedCosmosDb, UpdateExpandedEventGrid, UpdateExpandedEventHub, UpdateExpandedIotHub +Parameter Sets: UpdateExpandedCosmosDb, UpdateExpandedEventGrid, UpdateExpandedEventHub, UpdateExpandedIotHub, UpdateViaJsonFilePath, UpdateViaJsonString Aliases: Required: True @@ -604,12 +649,11 @@ Accept wildcard characters: False ``` ### -SubscriptionId -Gets subscription credentials which uniquely identify Microsoft Azure subscription. -The subscription ID forms part of the URI for every service call. +The ID of the target subscription. ```yaml Type: System.String -Parameter Sets: UpdateExpandedCosmosDb, UpdateExpandedEventGrid, UpdateExpandedEventHub, UpdateExpandedIotHub +Parameter Sets: UpdateExpandedCosmosDb, UpdateExpandedEventGrid, UpdateExpandedEventHub, UpdateExpandedIotHub, UpdateViaJsonFilePath, UpdateViaJsonString Aliases: Required: False @@ -625,7 +669,7 @@ Optionally the table information can be added to each message. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: UpdateExpandedCosmosDb, UpdateExpandedEventGrid, UpdateExpandedEventHub, UpdateExpandedIotHub, UpdateViaIdentityExpandedCosmosDb, UpdateViaIdentityExpandedEventGrid, UpdateViaIdentityExpandedEventHub, UpdateViaIdentityExpandedIotHub Aliases: Required: True @@ -675,7 +719,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IDataConnection +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IDataConnection ## NOTES diff --git a/src/Kusto/Kusto.Autorest/docs/Update-AzKustoDatabase.md b/src/Kusto/Kusto.Autorest/docs/Update-AzKustoDatabase.md index bad72b148030..ed941220e954 100644 --- a/src/Kusto/Kusto.Autorest/docs/Update-AzKustoDatabase.md +++ b/src/Kusto/Kusto.Autorest/docs/Update-AzKustoDatabase.md @@ -8,14 +8,14 @@ schema: 2.0.0 # Update-AzKustoDatabase ## SYNOPSIS -Updates a database. +Update a database. ## SYNTAX ### UpdateExpanded (Default) ``` -Update-AzKustoDatabase -ClusterName -Name -ResourceGroupName -Kind - -Location [-SubscriptionId ] [-CallerRole ] [-HotCachePeriod ] +Update-AzKustoDatabase -ClusterName -Name -ResourceGroupName -Kind + -Location [-SubscriptionId ] [-CallerRole ] [-HotCachePeriod ] [-KeyVaultPropertyKeyName ] [-KeyVaultPropertyKeyVaultUri ] [-KeyVaultPropertyKeyVersion ] [-KeyVaultPropertyUserIdentity ] [-SoftDeletePeriod ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] @@ -24,15 +24,29 @@ Update-AzKustoDatabase -ClusterName -Name -ResourceGroupName < ### UpdateViaIdentityExpanded ``` -Update-AzKustoDatabase -InputObject -Kind -Location - [-CallerRole ] [-HotCachePeriod ] [-KeyVaultPropertyKeyName ] - [-KeyVaultPropertyKeyVaultUri ] [-KeyVaultPropertyKeyVersion ] - [-KeyVaultPropertyUserIdentity ] [-SoftDeletePeriod ] [-DefaultProfile ] [-AsJob] - [-NoWait] [-Confirm] [-WhatIf] [] +Update-AzKustoDatabase -InputObject -Kind -Location [-CallerRole ] + [-HotCachePeriod ] [-KeyVaultPropertyKeyName ] [-KeyVaultPropertyKeyVaultUri ] + [-KeyVaultPropertyKeyVersion ] [-KeyVaultPropertyUserIdentity ] + [-SoftDeletePeriod ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +### UpdateViaJsonFilePath +``` +Update-AzKustoDatabase -ClusterName -Name -ResourceGroupName -JsonFilePath + [-SubscriptionId ] [-CallerRole ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +### UpdateViaJsonString +``` +Update-AzKustoDatabase -ClusterName -Name -ResourceGroupName -JsonString + [-SubscriptionId ] [-CallerRole ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] ``` ## DESCRIPTION -Updates a database. +Update a database. ## EXAMPLES @@ -118,7 +132,7 @@ By default, any user who run operation on a database become an Admin on it. This property allows the caller to exclude the caller from Admins list. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.CallerRole +Type: System.String Parameter Sets: (All) Aliases: @@ -134,7 +148,7 @@ The name of the Kusto cluster. ```yaml Type: System.String -Parameter Sets: UpdateExpanded +Parameter Sets: UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString Aliases: Required: True @@ -145,7 +159,8 @@ Accept wildcard characters: False ``` ### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. +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 @@ -164,7 +179,7 @@ The time the data should be kept in cache for fast queries in TimeSpan. ```yaml Type: System.TimeSpan -Parameter Sets: (All) +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: Required: False @@ -190,12 +205,42 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -JsonFilePath +Path of Json file supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -KeyVaultPropertyKeyName The name of the key vault key. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: Required: False @@ -210,7 +255,7 @@ The Uri of the key vault. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: Required: False @@ -225,7 +270,7 @@ The version of the key vault key. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: Required: False @@ -240,7 +285,7 @@ The user assigned identity (ARM resource id) that has access to the key. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: Required: False @@ -254,8 +299,8 @@ Accept wildcard characters: False Kind of the database ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.Kind -Parameter Sets: (All) +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: Required: True @@ -270,7 +315,7 @@ Resource location. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: Required: True @@ -285,7 +330,7 @@ The name of the database in the Kusto cluster. ```yaml Type: System.String -Parameter Sets: UpdateExpanded +Parameter Sets: UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString Aliases: DatabaseName Required: True @@ -311,11 +356,12 @@ Accept wildcard characters: False ``` ### -ResourceGroupName -The name of the resource group containing the Kusto cluster. +The name of the resource group. +The name is case insensitive. ```yaml Type: System.String -Parameter Sets: UpdateExpanded +Parameter Sets: UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString Aliases: Required: True @@ -330,7 +376,7 @@ The time the data should be kept before it stops being accessible to queries in ```yaml Type: System.TimeSpan -Parameter Sets: (All) +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: Required: False @@ -341,12 +387,11 @@ Accept wildcard characters: False ``` ### -SubscriptionId -Gets subscription credentials which uniquely identify Microsoft Azure subscription. -The subscription ID forms part of the URI for every service call. +The ID of the target subscription. ```yaml Type: System.String -Parameter Sets: UpdateExpanded +Parameter Sets: UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString Aliases: Required: False @@ -396,7 +441,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IDatabase +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IDatabase ## NOTES diff --git a/src/Kusto/Kusto.Autorest/docs/Update-AzKustoManagedPrivateEndpoint.md b/src/Kusto/Kusto.Autorest/docs/Update-AzKustoManagedPrivateEndpoint.md index efff6d63dffc..4c0cfcd87828 100644 --- a/src/Kusto/Kusto.Autorest/docs/Update-AzKustoManagedPrivateEndpoint.md +++ b/src/Kusto/Kusto.Autorest/docs/Update-AzKustoManagedPrivateEndpoint.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Update-AzKustoManagedPrivateEndpoint ## SYNOPSIS -Updates a managed private endpoint. +Update a managed private endpoint. ## SYNTAX @@ -33,6 +33,20 @@ Update-AzKustoManagedPrivateEndpoint -InputObject -Parameter ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] ``` +### UpdateViaIdentityCluster +``` +Update-AzKustoManagedPrivateEndpoint -ClusterInputObject -Name + -Parameter [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +### UpdateViaIdentityClusterExpanded +``` +Update-AzKustoManagedPrivateEndpoint -ClusterInputObject -Name [-GroupId ] + [-PrivateLinkResourceId ] [-PrivateLinkResourceRegion ] [-RequestMessage ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + ### UpdateViaIdentityExpanded ``` Update-AzKustoManagedPrivateEndpoint -InputObject [-GroupId ] @@ -40,8 +54,22 @@ Update-AzKustoManagedPrivateEndpoint -InputObject [-GroupId ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] ``` +### UpdateViaJsonFilePath +``` +Update-AzKustoManagedPrivateEndpoint -ClusterName -Name -ResourceGroupName + -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +### UpdateViaJsonString +``` +Update-AzKustoManagedPrivateEndpoint -ClusterName -Name -ResourceGroupName + -JsonString [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + ## DESCRIPTION -Updates a managed private endpoint. +Update a managed private endpoint. ## EXAMPLES @@ -75,12 +103,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ClusterInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: UpdateViaIdentityCluster, UpdateViaIdentityClusterExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ClusterName The name of the Kusto cluster. ```yaml Type: System.String -Parameter Sets: Update, UpdateExpanded +Parameter Sets: Update, UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString Aliases: Required: True @@ -111,7 +154,7 @@ The groupId in which the managed private endpoint is created. ```yaml Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Parameter Sets: UpdateExpanded, UpdateViaIdentityClusterExpanded, UpdateViaIdentityExpanded Aliases: Required: False @@ -123,7 +166,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -137,12 +179,42 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -JsonFilePath +Path of Json file supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name The name of the managed private endpoint. ```yaml Type: System.String -Parameter Sets: Update, UpdateExpanded +Parameter Sets: Update, UpdateExpanded, UpdateViaIdentityCluster, UpdateViaIdentityClusterExpanded, UpdateViaJsonFilePath, UpdateViaJsonString Aliases: ManagedPrivateEndpointName Required: True @@ -169,11 +241,10 @@ Accept wildcard characters: False ### -Parameter Class representing a managed private endpoint. -To construct, see NOTES section for PARAMETER properties and create a hash table. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IManagedPrivateEndpoint -Parameter Sets: Update, UpdateViaIdentity +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IManagedPrivateEndpoint +Parameter Sets: Update, UpdateViaIdentity, UpdateViaIdentityCluster Aliases: Required: True @@ -188,7 +259,7 @@ The ARM resource ID of the resource for which the managed private endpoint is cr ```yaml Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Parameter Sets: UpdateExpanded, UpdateViaIdentityClusterExpanded, UpdateViaIdentityExpanded Aliases: Required: False @@ -203,7 +274,7 @@ The region of the resource to which the managed private endpoint is created. ```yaml Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Parameter Sets: UpdateExpanded, UpdateViaIdentityClusterExpanded, UpdateViaIdentityExpanded Aliases: Required: False @@ -218,7 +289,7 @@ The user request message. ```yaml Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Parameter Sets: UpdateExpanded, UpdateViaIdentityClusterExpanded, UpdateViaIdentityExpanded Aliases: Required: False @@ -234,7 +305,7 @@ The name is case insensitive. ```yaml Type: System.String -Parameter Sets: Update, UpdateExpanded +Parameter Sets: Update, UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString Aliases: Required: True @@ -249,7 +320,7 @@ The ID of the target subscription. ```yaml Type: System.String -Parameter Sets: Update, UpdateExpanded +Parameter Sets: Update, UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString Aliases: Required: False @@ -295,13 +366,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IManagedPrivateEndpoint - ### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IManagedPrivateEndpoint + ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IManagedPrivateEndpoint +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IManagedPrivateEndpoint ## NOTES diff --git a/src/Kusto/Kusto.Autorest/docs/Update-AzKustoSandboxCustomImage.md b/src/Kusto/Kusto.Autorest/docs/Update-AzKustoSandboxCustomImage.md index b3381db0adba..d93a0363851c 100644 --- a/src/Kusto/Kusto.Autorest/docs/Update-AzKustoSandboxCustomImage.md +++ b/src/Kusto/Kusto.Autorest/docs/Update-AzKustoSandboxCustomImage.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Update-AzKustoSandboxCustomImage ## SYNOPSIS -Updates a sandbox custom image. +Update a sandbox custom image. ## SYNTAX @@ -33,6 +33,20 @@ Update-AzKustoSandboxCustomImage -InputObject -Parameter ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] ``` +### UpdateViaIdentityCluster +``` +Update-AzKustoSandboxCustomImage -ClusterInputObject -Name + -Parameter [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +### UpdateViaIdentityClusterExpanded +``` +Update-AzKustoSandboxCustomImage -ClusterInputObject -Name [-BaseImageName ] + [-LanguageVersion ] [-RequirementsFileContent ] [-DefaultProfile ] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [] +``` + ### UpdateViaIdentityExpanded ``` Update-AzKustoSandboxCustomImage -InputObject [-BaseImageName ] @@ -40,8 +54,22 @@ Update-AzKustoSandboxCustomImage -InputObject [-BaseImageName < [-NoWait] [-Confirm] [-WhatIf] [] ``` +### UpdateViaJsonFilePath +``` +Update-AzKustoSandboxCustomImage -ClusterName -Name -ResourceGroupName + -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +### UpdateViaJsonString +``` +Update-AzKustoSandboxCustomImage -ClusterName -Name -ResourceGroupName + -JsonString [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + ## DESCRIPTION -Updates a sandbox custom image. +Update a sandbox custom image. ## EXAMPLES @@ -82,7 +110,7 @@ Either this property or languageVersion should be specified. ```yaml Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Parameter Sets: UpdateExpanded, UpdateViaIdentityClusterExpanded, UpdateViaIdentityExpanded Aliases: Required: False @@ -92,12 +120,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ClusterInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: UpdateViaIdentityCluster, UpdateViaIdentityClusterExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ClusterName The name of the Kusto cluster. ```yaml Type: System.String -Parameter Sets: Update, UpdateExpanded +Parameter Sets: Update, UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString Aliases: Required: True @@ -125,7 +168,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -139,13 +181,43 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -JsonFilePath +Path of Json file supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -LanguageVersion The version of the language. Either this property or baseImageName should be specified. ```yaml Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Parameter Sets: UpdateExpanded, UpdateViaIdentityClusterExpanded, UpdateViaIdentityExpanded Aliases: Required: False @@ -160,7 +232,7 @@ The name of the sandbox custom image. ```yaml Type: System.String -Parameter Sets: Update, UpdateExpanded +Parameter Sets: Update, UpdateExpanded, UpdateViaIdentityCluster, UpdateViaIdentityClusterExpanded, UpdateViaJsonFilePath, UpdateViaJsonString Aliases: SandboxCustomImageName Required: True @@ -187,11 +259,10 @@ Accept wildcard characters: False ### -Parameter Class representing a Kusto sandbox custom image. -To construct, see NOTES section for PARAMETER properties and create a hash table. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ISandboxCustomImage -Parameter Sets: Update, UpdateViaIdentity +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ISandboxCustomImage +Parameter Sets: Update, UpdateViaIdentity, UpdateViaIdentityCluster Aliases: Required: True @@ -206,7 +277,7 @@ The requirements file content. ```yaml Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Parameter Sets: UpdateExpanded, UpdateViaIdentityClusterExpanded, UpdateViaIdentityExpanded Aliases: Required: False @@ -222,7 +293,7 @@ The name is case insensitive. ```yaml Type: System.String -Parameter Sets: Update, UpdateExpanded +Parameter Sets: Update, UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString Aliases: Required: True @@ -237,7 +308,7 @@ The ID of the target subscription. ```yaml Type: System.String -Parameter Sets: Update, UpdateExpanded +Parameter Sets: Update, UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString Aliases: Required: False @@ -283,13 +354,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ISandboxCustomImage - ### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ISandboxCustomImage + ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ISandboxCustomImage +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ISandboxCustomImage ## NOTES diff --git a/src/Kusto/Kusto.Autorest/docs/Update-AzKustoScript.md b/src/Kusto/Kusto.Autorest/docs/Update-AzKustoScript.md index 11a3081b5327..cd7de1f98d20 100644 --- a/src/Kusto/Kusto.Autorest/docs/Update-AzKustoScript.md +++ b/src/Kusto/Kusto.Autorest/docs/Update-AzKustoScript.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Update-AzKustoScript ## SYNOPSIS -Updates a database script. +Update a database script. ## SYNTAX @@ -16,9 +16,8 @@ Updates a database script. ``` Update-AzKustoScript -ClusterName -DatabaseName -Name -ResourceGroupName [-SubscriptionId ] [-ContinueOnError] [-ForceUpdateTag ] - [-PrincipalPermissionsAction ] [-ScriptContent ] - [-ScriptLevel ] [-ScriptUrl ] [-ScriptUrlSasToken ] [-DefaultProfile ] - [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] + [-PrincipalPermissionsAction ] [-ScriptLevel ] [-ScriptUrl ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] ``` ### Update @@ -34,16 +33,58 @@ Update-AzKustoScript -InputObject -Parameter [-Defaul [-NoWait] [-Confirm] [-WhatIf] [] ``` +### UpdateViaIdentityCluster +``` +Update-AzKustoScript -ClusterInputObject -DatabaseName -Name + -Parameter [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +### UpdateViaIdentityClusterExpanded +``` +Update-AzKustoScript -ClusterInputObject -DatabaseName -Name + [-ContinueOnError] [-ForceUpdateTag ] [-PrincipalPermissionsAction ] [-ScriptLevel ] + [-ScriptUrl ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +### UpdateViaIdentityDatabase +``` +Update-AzKustoScript -DatabaseInputObject -Name -Parameter + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityDatabaseExpanded +``` +Update-AzKustoScript -DatabaseInputObject -Name [-ContinueOnError] + [-ForceUpdateTag ] [-PrincipalPermissionsAction ] [-ScriptLevel ] + [-ScriptUrl ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + ### UpdateViaIdentityExpanded ``` Update-AzKustoScript -InputObject [-ContinueOnError] [-ForceUpdateTag ] - [-PrincipalPermissionsAction ] [-ScriptContent ] - [-ScriptLevel ] [-ScriptUrl ] [-ScriptUrlSasToken ] [-DefaultProfile ] - [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] + [-PrincipalPermissionsAction ] [-ScriptLevel ] [-ScriptUrl ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaJsonFilePath +``` +Update-AzKustoScript -ClusterName -DatabaseName -Name -ResourceGroupName + -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +### UpdateViaJsonString +``` +Update-AzKustoScript -ClusterName -DatabaseName -Name -ResourceGroupName + -JsonString [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] ``` ## DESCRIPTION -Updates a database script. +Update a database script. ## EXAMPLES @@ -77,12 +118,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ClusterInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: UpdateViaIdentityCluster, UpdateViaIdentityClusterExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ClusterName The name of the Kusto cluster. ```yaml Type: System.String -Parameter Sets: Update, UpdateExpanded +Parameter Sets: Update, UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString Aliases: Required: True @@ -97,7 +153,7 @@ Flag that indicates whether to continue if one of the command fails. ```yaml Type: System.Management.Automation.SwitchParameter -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Parameter Sets: UpdateExpanded, UpdateViaIdentityClusterExpanded, UpdateViaIdentityDatabaseExpanded, UpdateViaIdentityExpanded Aliases: Required: False @@ -107,12 +163,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DatabaseInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: UpdateViaIdentityDatabase, UpdateViaIdentityDatabaseExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -DatabaseName The name of the database in the Kusto cluster. ```yaml Type: System.String -Parameter Sets: Update, UpdateExpanded +Parameter Sets: Update, UpdateExpanded, UpdateViaIdentityCluster, UpdateViaIdentityClusterExpanded, UpdateViaJsonFilePath, UpdateViaJsonString Aliases: Required: True @@ -144,7 +215,7 @@ If changed the script will be applied again. ```yaml Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Parameter Sets: UpdateExpanded, UpdateViaIdentityClusterExpanded, UpdateViaIdentityDatabaseExpanded, UpdateViaIdentityExpanded Aliases: Required: False @@ -156,7 +227,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -170,12 +240,42 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -JsonFilePath +Path of Json file supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name The name of the Kusto database script. ```yaml Type: System.String -Parameter Sets: Update, UpdateExpanded +Parameter Sets: Update, UpdateExpanded, UpdateViaIdentityCluster, UpdateViaIdentityClusterExpanded, UpdateViaIdentityDatabase, UpdateViaIdentityDatabaseExpanded, UpdateViaJsonFilePath, UpdateViaJsonString Aliases: ScriptName Required: True @@ -202,11 +302,10 @@ Accept wildcard characters: False ### -Parameter Class representing a database script. -To construct, see NOTES section for PARAMETER properties and create a hash table. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IScript -Parameter Sets: Update, UpdateViaIdentity +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IScript +Parameter Sets: Update, UpdateViaIdentity, UpdateViaIdentityCluster, UpdateViaIdentityDatabase Aliases: Required: True @@ -220,8 +319,8 @@ Accept wildcard characters: False Indicates if the permissions for the script caller are kept following completion of the script. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.PrincipalPermissionsAction -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityClusterExpanded, UpdateViaIdentityDatabaseExpanded, UpdateViaIdentityExpanded Aliases: Required: False @@ -237,7 +336,7 @@ The name is case insensitive. ```yaml Type: System.String -Parameter Sets: Update, UpdateExpanded +Parameter Sets: Update, UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString Aliases: Required: True @@ -247,30 +346,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ScriptContent -The script content. -This property should be used when the script is provide inline and not through file in a SA. -Must not be used together with scriptUrl and scriptUrlSasToken properties. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ScriptLevel Differentiates between the type of script commands included - Database or Cluster. The default is Database. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.ScriptLevel -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityClusterExpanded, UpdateViaIdentityDatabaseExpanded, UpdateViaIdentityExpanded Aliases: Required: False @@ -286,23 +368,7 @@ Must not be used together with scriptContent property ```yaml Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ScriptUrlSasToken -The SaS token that provide read access to the file which contain the script. -Must be provided when using scriptUrl property. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Parameter Sets: UpdateExpanded, UpdateViaIdentityClusterExpanded, UpdateViaIdentityDatabaseExpanded, UpdateViaIdentityExpanded Aliases: Required: False @@ -317,7 +383,7 @@ The ID of the target subscription. ```yaml Type: System.String -Parameter Sets: Update, UpdateExpanded +Parameter Sets: Update, UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString Aliases: Required: False @@ -363,13 +429,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IScript - ### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IScript + ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IScript +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IScript ## NOTES diff --git a/src/Kusto/Kusto.Autorest/examples/Get-AzKustoPrivateEndpointConnection.md b/src/Kusto/Kusto.Autorest/examples/Get-AzKustoPrivateEndpointConnection.md deleted file mode 100644 index 2a690f7739f8..000000000000 --- a/src/Kusto/Kusto.Autorest/examples/Get-AzKustoPrivateEndpointConnection.md +++ /dev/null @@ -1,26 +0,0 @@ -### Example 1: List all Kusto PrivateEndpointConnection in a cluster by name -```powershell -Get-AzKustoPrivateEndpointConnection -ClusterName "mycluster" -ResourceGroupName "testrg" -SubscriptionId "12345678-1234-1234-1234-123456789098" -``` - -```output -Name Type ----- ---- -privateEndpointConnectionName1 Microsoft.Kusto/Clusters/PrivateEndpointConnections -privateEndpointConnectionName2 Microsoft.Kusto/Clusters/PrivateEndpointConnections -``` - -The above command returns all Kusto PrivateEndpointConnection in the cluster "mycluster" found in the resource group "testrg". - -### Example 2: Get a specific Kusto PrivateEndpointConnection by name -```powershell -Get-AzKustoPrivateEndpointConnection -ClusterName "mycluster" -ResourceGroupName "testrg" -SubscriptionId "12345678-1234-1234-1234-123456789098" -Name "privateEndpointConnectionName" -``` - -```output -Name Type ----- ---- -privateEndpointConnectionName Microsoft.Kusto/Clusters/PrivateEndpointConnections -``` - -The above command returns the Kusto PrivateEndpointConnection named "privateEndpointConnectionName" in the cluster "mycluster" found in the resource group "testrg". diff --git a/src/Kusto/Kusto.Autorest/examples/Get-AzKustoPrivateLinkResource.md b/src/Kusto/Kusto.Autorest/examples/Get-AzKustoPrivateLinkResource.md deleted file mode 100644 index 8bfa60f70a51..000000000000 --- a/src/Kusto/Kusto.Autorest/examples/Get-AzKustoPrivateLinkResource.md +++ /dev/null @@ -1,27 +0,0 @@ -## EXAMPLES - -### Example 1: List all PrivateLinkResource in a cluster -```powershell -Get-AzKustoPrivateLinkResource -ClusterName "mycluster" -ResourceGroupName "testrg" -``` - -```output -Name Type ----- ---- -mycluster/cluster Microsoft.Kusto/Clusters/PrivateLinkResources -``` - -The above command returns all PrivateLinkResource in the cluster "mycluster" found in the resource group "testrg". - -### Example 2: Get a specific PrivateLinkResource by name -```powershell -Get-AzKustoPrivateLinkResource -ClusterName "mycluster" -ResourceGroupName "testrg" -Name "ManagedPrivateEndpointName" -``` - -```output -Name Type ----- ---- -mycluster/cluster Microsoft.Kusto/Clusters/PrivateLinkResources -``` - -The above command returns the PrivateLinkResource named "mycluster/cluster" in the cluster "mycluster" found in the resource group "testrg". diff --git a/src/Kusto/Kusto.Autorest/examples/New-AzKustoPrivateEndpointConnection.md b/src/Kusto/Kusto.Autorest/examples/New-AzKustoPrivateEndpointConnection.md deleted file mode 100644 index 84d75b1a33ba..000000000000 --- a/src/Kusto/Kusto.Autorest/examples/New-AzKustoPrivateEndpointConnection.md +++ /dev/null @@ -1,14 +0,0 @@ -## EXAMPLES - -### Example 1: Create a new PrivateEndpointConnection in a cluster -```powershell -New-AzKustoPrivateEndpointConnection -ClusterName "mycluster" -ResourceGroupName "testrg" -SubscriptionId "12345678-1234-1234-1234-123456789098" -Parameter $privateEndpointConnection -Name "testprivateconnection-12345678-1234-1234-1234-123456789098" -``` - -```output -Name Type ----- ---- -testprivateconnection-12345678-1234-1234-1234-123456789098 Microsoft.Kusto/Clusters/PrivateEndpointConnections -``` - -The above command creates a new PrivateEndpointConnection in the cluster "mycluster" found in the resource group "testrg". diff --git a/src/Kusto/Kusto.Autorest/examples/README.md b/src/Kusto/Kusto.Autorest/examples/README.md new file mode 100644 index 000000000000..ac871d71fc72 --- /dev/null +++ b/src/Kusto/Kusto.Autorest/examples/README.md @@ -0,0 +1,11 @@ +# Examples +This directory contains examples from the exported cmdlets of the module. When `build-module.ps1` is ran, example stub files will be generated here. If your module support Azure Profiles, the example stubs will be in individual profile folders. These example stubs should be updated to show how the cmdlet is used. The examples are imported into the documentation when `generate-help.ps1` is ran. + +## Info +- Modifiable: yes +- Generated: partial +- Committed: yes +- Packaged: no + +## Purpose +This separates the example documentation details from the generated documentation information provided directly from the generated cmdlets. Since the cmdlets don't have examples from the REST spec, this provides a means to add examples easily. The example stubs provide the markdown format that is required. The 3 core elements are: the name of the example, the code information of the example, and the description of the example. That information, if the markdown format is followed, will be available to documentation generation and be part of the documents in the `..\docs` folder. \ No newline at end of file diff --git a/src/Kusto/Kusto.Autorest/examples/Remove-AzKustoPrivateEndpointConnection.md b/src/Kusto/Kusto.Autorest/examples/Remove-AzKustoPrivateEndpointConnection.md deleted file mode 100644 index c49b3aa0e7ec..000000000000 --- a/src/Kusto/Kusto.Autorest/examples/Remove-AzKustoPrivateEndpointConnection.md +++ /dev/null @@ -1,6 +0,0 @@ -### Example 1: Delete an existing Kusto PrivateEndpointConnection by name -```powershell -Remove-AzKustoPrivateEndpointConnection -ClusterName "mycluster" -ResourceGroupName "testrg" -Name "testprivateconnection-12345678-1234-1234-1234-123456789098" -``` - -The above command deletes the Kusto PrivateEndpointConnection named "testprivateconnection-12345678-1234-1234-1234-123456789098" in the cluster "mycluster" found in the resource group "testrg". \ No newline at end of file diff --git a/src/Kusto/Kusto.Autorest/generate-info.json b/src/Kusto/Kusto.Autorest/generate-info.json deleted file mode 100644 index d14c359c756c..000000000000 --- a/src/Kusto/Kusto.Autorest/generate-info.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "generate_Id": "40f46aea-89a5-45d0-ab7d-f0026f22a621" -} diff --git a/src/Kusto/Kusto.Autorest/resources/README.md b/src/Kusto/Kusto.Autorest/resources/README.md new file mode 100644 index 000000000000..937f07f8fec2 --- /dev/null +++ b/src/Kusto/Kusto.Autorest/resources/README.md @@ -0,0 +1,11 @@ +# Resources +This directory can contain any additional resources for module that are not required at runtime. This directory **does not** get packaged with the module. If you have assets for custom implementation, place them into the `..\custom` folder. + +## Info +- Modifiable: yes +- Generated: no +- Committed: yes +- Packaged: no + +## Purpose +Use this folder to put anything you want to keep around as part of the repository for the module, but is not something that is required for the module. For example, development files, packaged builds, or additional information. This is only intended to be used in repositories where the module's output directory is cleaned, but tangential resources for the module want to remain intact. \ No newline at end of file diff --git a/src/Kusto/Kusto.Autorest/test/Add-AzKustoClusterCalloutPolicy.Tests.ps1 b/src/Kusto/Kusto.Autorest/test/Add-AzKustoClusterCalloutPolicy.Tests.ps1 index 3e349f34b973..6e49c037ffd9 100644 --- a/src/Kusto/Kusto.Autorest/test/Add-AzKustoClusterCalloutPolicy.Tests.ps1 +++ b/src/Kusto/Kusto.Autorest/test/Add-AzKustoClusterCalloutPolicy.Tests.ps1 @@ -20,12 +20,12 @@ Describe 'Add-AzKustoClusterCalloutPolicy' { $clusterName = $env.kustoClusterName $subscriptionId = $env.subscriptionId $apiVersion = $env.kustoApiVersion - $kustoCalloutPolicy = [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ICalloutPolicy]@{ + $kustoCalloutPolicy = [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ICalloutPolicy]@{ calloutType = "kusto" outboundAccess = "Allow" calloutUriRegex = "*" } - $sqlCalloutPolicy = [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ICalloutPolicy]@{ + $sqlCalloutPolicy = [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ICalloutPolicy]@{ calloutType = "sql" outboundAccess = "Deny" calloutUriRegex = "*" diff --git a/src/Kusto/Kusto.Autorest/test/Get-AzKustoClusterCalloutPolicy.Tests.ps1 b/src/Kusto/Kusto.Autorest/test/Get-AzKustoClusterCalloutPolicy.Tests.ps1 index 95d0bbf15bdd..18931d4154e2 100644 --- a/src/Kusto/Kusto.Autorest/test/Get-AzKustoClusterCalloutPolicy.Tests.ps1 +++ b/src/Kusto/Kusto.Autorest/test/Get-AzKustoClusterCalloutPolicy.Tests.ps1 @@ -20,12 +20,12 @@ Describe 'Get-AzKustoClusterCalloutPolicy' { $clusterName = $env.kustoClusterName $subscriptionId = $env.subscriptionId $apiVersion = $env.kustoApiVersion - $cosmosdbCalloutPolicy = [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ICalloutPolicy]@{ + $cosmosdbCalloutPolicy = [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ICalloutPolicy]@{ calloutType = "cosmosdb" outboundAccess = "Allow" calloutUriRegex = "*" } - $postgresqlCalloutPolicy = [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ICalloutPolicy]@{ + $postgresqlCalloutPolicy = [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ICalloutPolicy]@{ calloutType = "postgresql" outboundAccess = "Deny" calloutUriRegex = "*" diff --git a/src/Kusto/Kusto.Autorest/test/Get-AzKustoOperationsResultsLocation.Tests.ps1 b/src/Kusto/Kusto.Autorest/test/Get-AzKustoOperationsResultsLocation.Tests.ps1 new file mode 100644 index 000000000000..ad89d273362f --- /dev/null +++ b/src/Kusto/Kusto.Autorest/test/Get-AzKustoOperationsResultsLocation.Tests.ps1 @@ -0,0 +1,21 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Get-AzKustoOperationsResultsLocation')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Get-AzKustoOperationsResultsLocation.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Get-AzKustoOperationsResultsLocation' { + It 'GetViaIdentityLocation' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/Kusto/Kusto.Autorest/test/Remove-AzKustoClusterCalloutPolicy.Tests.ps1 b/src/Kusto/Kusto.Autorest/test/Remove-AzKustoClusterCalloutPolicy.Tests.ps1 index 536bbe8a4189..a27f48743052 100644 --- a/src/Kusto/Kusto.Autorest/test/Remove-AzKustoClusterCalloutPolicy.Tests.ps1 +++ b/src/Kusto/Kusto.Autorest/test/Remove-AzKustoClusterCalloutPolicy.Tests.ps1 @@ -20,12 +20,12 @@ Describe 'Remove-AzKustoClusterCalloutPolicy' { $clusterName = $env.kustoClusterName $subscriptionId = $env.subscriptionId $apiVersion = $env.kustoApiVersion - $sandboxCalloutPolicy = [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ICalloutPolicy]@{ + $sandboxCalloutPolicy = [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ICalloutPolicy]@{ calloutType = "sandbox_artifacts" outboundAccess = "Allow" calloutUriRegex = "*" } - $genevametricsCalloutPolicy = [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ICalloutPolicy]@{ + $genevametricsCalloutPolicy = [Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ICalloutPolicy]@{ calloutType = "genevametrics" outboundAccess = "Deny" calloutUriRegex = "*" diff --git a/src/Kusto/Kusto.sln b/src/Kusto/Kusto.sln index b5c48b063364..2ccb44bcd43e 100644 --- a/src/Kusto/Kusto.sln +++ b/src/Kusto/Kusto.sln @@ -1,4 +1,4 @@ - + Microsoft Visual Studio Solution File, Format Version 12.00 # Visual Studio Version 17 VisualStudioVersion = 17.0.31903.59 @@ -19,49 +19,119 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Authenticators", "..\Accoun EndProject Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Kusto", "Kusto\Kusto.csproj", "{6D96BABF-EE42-497D-B773-E295E93BD811}" EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Az.Kusto", "..\..\generated\Kusto\Kusto.Autorest\Az.Kusto.csproj", "{BA41BA3B-FD27-4AF6-BFC3-307380FF7427}" +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Kusto.Autorest", "Kusto.Autorest", "{04AF7B78-B9F9-241E-6631-08803AF21AEB}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Az.Kusto", "..\..\generated\Kusto\Kusto.Autorest\Az.Kusto.csproj", "{C7CFB9AA-97D6-42A1-A26F-EAC5AF77DFB1}" EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution Debug|Any CPU = Debug|Any CPU + Debug|x64 = Debug|x64 + Debug|x86 = Debug|x86 Release|Any CPU = Release|Any CPU - EndGlobalSection - GlobalSection(SolutionProperties) = preSolution - HideSolutionNode = FALSE + Release|x64 = Release|x64 + Release|x86 = Release|x86 EndGlobalSection GlobalSection(ProjectConfigurationPlatforms) = postSolution {AF7FD2C3-22D7-44E1-9494-14BE58EC35D8}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {AF7FD2C3-22D7-44E1-9494-14BE58EC35D8}.Debug|Any CPU.Build.0 = Debug|Any CPU + {AF7FD2C3-22D7-44E1-9494-14BE58EC35D8}.Debug|x64.ActiveCfg = Debug|Any CPU + {AF7FD2C3-22D7-44E1-9494-14BE58EC35D8}.Debug|x64.Build.0 = Debug|Any CPU + {AF7FD2C3-22D7-44E1-9494-14BE58EC35D8}.Debug|x86.ActiveCfg = Debug|Any CPU + {AF7FD2C3-22D7-44E1-9494-14BE58EC35D8}.Debug|x86.Build.0 = Debug|Any CPU {AF7FD2C3-22D7-44E1-9494-14BE58EC35D8}.Release|Any CPU.ActiveCfg = Release|Any CPU {AF7FD2C3-22D7-44E1-9494-14BE58EC35D8}.Release|Any CPU.Build.0 = Release|Any CPU + {AF7FD2C3-22D7-44E1-9494-14BE58EC35D8}.Release|x64.ActiveCfg = Release|Any CPU + {AF7FD2C3-22D7-44E1-9494-14BE58EC35D8}.Release|x64.Build.0 = Release|Any CPU + {AF7FD2C3-22D7-44E1-9494-14BE58EC35D8}.Release|x86.ActiveCfg = Release|Any CPU + {AF7FD2C3-22D7-44E1-9494-14BE58EC35D8}.Release|x86.Build.0 = Release|Any CPU {308AE335-C05E-4273-8AF5-5C65EB1D9D6F}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {308AE335-C05E-4273-8AF5-5C65EB1D9D6F}.Debug|Any CPU.Build.0 = Debug|Any CPU + {308AE335-C05E-4273-8AF5-5C65EB1D9D6F}.Debug|x64.ActiveCfg = Debug|Any CPU + {308AE335-C05E-4273-8AF5-5C65EB1D9D6F}.Debug|x64.Build.0 = Debug|Any CPU + {308AE335-C05E-4273-8AF5-5C65EB1D9D6F}.Debug|x86.ActiveCfg = Debug|Any CPU + {308AE335-C05E-4273-8AF5-5C65EB1D9D6F}.Debug|x86.Build.0 = Debug|Any CPU {308AE335-C05E-4273-8AF5-5C65EB1D9D6F}.Release|Any CPU.ActiveCfg = Release|Any CPU {308AE335-C05E-4273-8AF5-5C65EB1D9D6F}.Release|Any CPU.Build.0 = Release|Any CPU + {308AE335-C05E-4273-8AF5-5C65EB1D9D6F}.Release|x64.ActiveCfg = Release|Any CPU + {308AE335-C05E-4273-8AF5-5C65EB1D9D6F}.Release|x64.Build.0 = Release|Any CPU + {308AE335-C05E-4273-8AF5-5C65EB1D9D6F}.Release|x86.ActiveCfg = Release|Any CPU + {308AE335-C05E-4273-8AF5-5C65EB1D9D6F}.Release|x86.Build.0 = Release|Any CPU {2CF71B22-1E0C-419A-8B5B-C46FFCEA1574}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {2CF71B22-1E0C-419A-8B5B-C46FFCEA1574}.Debug|Any CPU.Build.0 = Debug|Any CPU + {2CF71B22-1E0C-419A-8B5B-C46FFCEA1574}.Debug|x64.ActiveCfg = Debug|Any CPU + {2CF71B22-1E0C-419A-8B5B-C46FFCEA1574}.Debug|x64.Build.0 = Debug|Any CPU + {2CF71B22-1E0C-419A-8B5B-C46FFCEA1574}.Debug|x86.ActiveCfg = Debug|Any CPU + {2CF71B22-1E0C-419A-8B5B-C46FFCEA1574}.Debug|x86.Build.0 = Debug|Any CPU {2CF71B22-1E0C-419A-8B5B-C46FFCEA1574}.Release|Any CPU.ActiveCfg = Release|Any CPU {2CF71B22-1E0C-419A-8B5B-C46FFCEA1574}.Release|Any CPU.Build.0 = Release|Any CPU + {2CF71B22-1E0C-419A-8B5B-C46FFCEA1574}.Release|x64.ActiveCfg = Release|Any CPU + {2CF71B22-1E0C-419A-8B5B-C46FFCEA1574}.Release|x64.Build.0 = Release|Any CPU + {2CF71B22-1E0C-419A-8B5B-C46FFCEA1574}.Release|x86.ActiveCfg = Release|Any CPU + {2CF71B22-1E0C-419A-8B5B-C46FFCEA1574}.Release|x86.Build.0 = Release|Any CPU {9CB2D02D-795B-48C9-BDC9-39313209D993}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {9CB2D02D-795B-48C9-BDC9-39313209D993}.Debug|Any CPU.Build.0 = Debug|Any CPU + {9CB2D02D-795B-48C9-BDC9-39313209D993}.Debug|x64.ActiveCfg = Debug|Any CPU + {9CB2D02D-795B-48C9-BDC9-39313209D993}.Debug|x64.Build.0 = Debug|Any CPU + {9CB2D02D-795B-48C9-BDC9-39313209D993}.Debug|x86.ActiveCfg = Debug|Any CPU + {9CB2D02D-795B-48C9-BDC9-39313209D993}.Debug|x86.Build.0 = Debug|Any CPU {9CB2D02D-795B-48C9-BDC9-39313209D993}.Release|Any CPU.ActiveCfg = Release|Any CPU {9CB2D02D-795B-48C9-BDC9-39313209D993}.Release|Any CPU.Build.0 = Release|Any CPU + {9CB2D02D-795B-48C9-BDC9-39313209D993}.Release|x64.ActiveCfg = Release|Any CPU + {9CB2D02D-795B-48C9-BDC9-39313209D993}.Release|x64.Build.0 = Release|Any CPU + {9CB2D02D-795B-48C9-BDC9-39313209D993}.Release|x86.ActiveCfg = Release|Any CPU + {9CB2D02D-795B-48C9-BDC9-39313209D993}.Release|x86.Build.0 = Release|Any CPU {AC2C9D97-39CF-4BAF-BC27-F568D230791B}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {AC2C9D97-39CF-4BAF-BC27-F568D230791B}.Debug|Any CPU.Build.0 = Debug|Any CPU + {AC2C9D97-39CF-4BAF-BC27-F568D230791B}.Debug|x64.ActiveCfg = Debug|Any CPU + {AC2C9D97-39CF-4BAF-BC27-F568D230791B}.Debug|x64.Build.0 = Debug|Any CPU + {AC2C9D97-39CF-4BAF-BC27-F568D230791B}.Debug|x86.ActiveCfg = Debug|Any CPU + {AC2C9D97-39CF-4BAF-BC27-F568D230791B}.Debug|x86.Build.0 = Debug|Any CPU {AC2C9D97-39CF-4BAF-BC27-F568D230791B}.Release|Any CPU.ActiveCfg = Release|Any CPU {AC2C9D97-39CF-4BAF-BC27-F568D230791B}.Release|Any CPU.Build.0 = Release|Any CPU + {AC2C9D97-39CF-4BAF-BC27-F568D230791B}.Release|x64.ActiveCfg = Release|Any CPU + {AC2C9D97-39CF-4BAF-BC27-F568D230791B}.Release|x64.Build.0 = Release|Any CPU + {AC2C9D97-39CF-4BAF-BC27-F568D230791B}.Release|x86.ActiveCfg = Release|Any CPU + {AC2C9D97-39CF-4BAF-BC27-F568D230791B}.Release|x86.Build.0 = Release|Any CPU {A6E0CB4A-53C8-4A17-A222-A3A7DDA65A86}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {A6E0CB4A-53C8-4A17-A222-A3A7DDA65A86}.Debug|Any CPU.Build.0 = Debug|Any CPU + {A6E0CB4A-53C8-4A17-A222-A3A7DDA65A86}.Debug|x64.ActiveCfg = Debug|Any CPU + {A6E0CB4A-53C8-4A17-A222-A3A7DDA65A86}.Debug|x64.Build.0 = Debug|Any CPU + {A6E0CB4A-53C8-4A17-A222-A3A7DDA65A86}.Debug|x86.ActiveCfg = Debug|Any CPU + {A6E0CB4A-53C8-4A17-A222-A3A7DDA65A86}.Debug|x86.Build.0 = Debug|Any CPU {A6E0CB4A-53C8-4A17-A222-A3A7DDA65A86}.Release|Any CPU.ActiveCfg = Release|Any CPU {A6E0CB4A-53C8-4A17-A222-A3A7DDA65A86}.Release|Any CPU.Build.0 = Release|Any CPU + {A6E0CB4A-53C8-4A17-A222-A3A7DDA65A86}.Release|x64.ActiveCfg = Release|Any CPU + {A6E0CB4A-53C8-4A17-A222-A3A7DDA65A86}.Release|x64.Build.0 = Release|Any CPU + {A6E0CB4A-53C8-4A17-A222-A3A7DDA65A86}.Release|x86.ActiveCfg = Release|Any CPU + {A6E0CB4A-53C8-4A17-A222-A3A7DDA65A86}.Release|x86.Build.0 = Release|Any CPU {6D96BABF-EE42-497D-B773-E295E93BD811}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {6D96BABF-EE42-497D-B773-E295E93BD811}.Debug|Any CPU.Build.0 = Debug|Any CPU + {6D96BABF-EE42-497D-B773-E295E93BD811}.Debug|x64.ActiveCfg = Debug|Any CPU + {6D96BABF-EE42-497D-B773-E295E93BD811}.Debug|x64.Build.0 = Debug|Any CPU + {6D96BABF-EE42-497D-B773-E295E93BD811}.Debug|x86.ActiveCfg = Debug|Any CPU + {6D96BABF-EE42-497D-B773-E295E93BD811}.Debug|x86.Build.0 = Debug|Any CPU {6D96BABF-EE42-497D-B773-E295E93BD811}.Release|Any CPU.ActiveCfg = Release|Any CPU {6D96BABF-EE42-497D-B773-E295E93BD811}.Release|Any CPU.Build.0 = Release|Any CPU - {BA41BA3B-FD27-4AF6-BFC3-307380FF7427}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {BA41BA3B-FD27-4AF6-BFC3-307380FF7427}.Debug|Any CPU.Build.0 = Debug|Any CPU - {BA41BA3B-FD27-4AF6-BFC3-307380FF7427}.Release|Any CPU.ActiveCfg = Release|Any CPU - {BA41BA3B-FD27-4AF6-BFC3-307380FF7427}.Release|Any CPU.Build.0 = Release|Any CPU + {6D96BABF-EE42-497D-B773-E295E93BD811}.Release|x64.ActiveCfg = Release|Any CPU + {6D96BABF-EE42-497D-B773-E295E93BD811}.Release|x64.Build.0 = Release|Any CPU + {6D96BABF-EE42-497D-B773-E295E93BD811}.Release|x86.ActiveCfg = Release|Any CPU + {6D96BABF-EE42-497D-B773-E295E93BD811}.Release|x86.Build.0 = Release|Any CPU + {C7CFB9AA-97D6-42A1-A26F-EAC5AF77DFB1}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {C7CFB9AA-97D6-42A1-A26F-EAC5AF77DFB1}.Debug|Any CPU.Build.0 = Debug|Any CPU + {C7CFB9AA-97D6-42A1-A26F-EAC5AF77DFB1}.Debug|x64.ActiveCfg = Debug|Any CPU + {C7CFB9AA-97D6-42A1-A26F-EAC5AF77DFB1}.Debug|x64.Build.0 = Debug|Any CPU + {C7CFB9AA-97D6-42A1-A26F-EAC5AF77DFB1}.Debug|x86.ActiveCfg = Debug|Any CPU + {C7CFB9AA-97D6-42A1-A26F-EAC5AF77DFB1}.Debug|x86.Build.0 = Debug|Any CPU + {C7CFB9AA-97D6-42A1-A26F-EAC5AF77DFB1}.Release|Any CPU.ActiveCfg = Release|Any CPU + {C7CFB9AA-97D6-42A1-A26F-EAC5AF77DFB1}.Release|Any CPU.Build.0 = Release|Any CPU + {C7CFB9AA-97D6-42A1-A26F-EAC5AF77DFB1}.Release|x64.ActiveCfg = Release|Any CPU + {C7CFB9AA-97D6-42A1-A26F-EAC5AF77DFB1}.Release|x64.Build.0 = Release|Any CPU + {C7CFB9AA-97D6-42A1-A26F-EAC5AF77DFB1}.Release|x86.ActiveCfg = Release|Any CPU + {C7CFB9AA-97D6-42A1-A26F-EAC5AF77DFB1}.Release|x86.Build.0 = Release|Any CPU + EndGlobalSection + GlobalSection(SolutionProperties) = preSolution + HideSolutionNode = FALSE EndGlobalSection GlobalSection(NestedProjects) = preSolution {AF7FD2C3-22D7-44E1-9494-14BE58EC35D8} = {2153FD1F-A819-4EF3-ACB1-501A9F3A1B96} @@ -70,5 +140,6 @@ Global {9CB2D02D-795B-48C9-BDC9-39313209D993} = {2153FD1F-A819-4EF3-ACB1-501A9F3A1B96} {AC2C9D97-39CF-4BAF-BC27-F568D230791B} = {2153FD1F-A819-4EF3-ACB1-501A9F3A1B96} {A6E0CB4A-53C8-4A17-A222-A3A7DDA65A86} = {2153FD1F-A819-4EF3-ACB1-501A9F3A1B96} + {C7CFB9AA-97D6-42A1-A26F-EAC5AF77DFB1} = {04AF7B78-B9F9-241E-6631-08803AF21AEB} EndGlobalSection EndGlobal diff --git a/src/Kusto/Kusto/Az.Kusto.psd1 b/src/Kusto/Kusto/Az.Kusto.psd1 index 3979b766e72c..db07217166a0 100644 --- a/src/Kusto/Kusto/Az.Kusto.psd1 +++ b/src/Kusto/Kusto/Az.Kusto.psd1 @@ -3,7 +3,7 @@ # # Generated by: Microsoft Corporation # -# Generated on: 1/9/2025 +# Generated on: 8/21/2025 # @{ @@ -51,16 +51,16 @@ DotNetFrameworkVersion = '4.7.2' # ProcessorArchitecture = '' # Modules that must be imported into the global environment prior to importing this module -RequiredModules = @(@{ModuleName = 'Az.Accounts'; ModuleVersion = '4.0.1'; }) +RequiredModules = @(@{ModuleName = 'Az.Accounts'; ModuleVersion = '5.2.0'; }) # Assemblies that must be loaded prior to importing this module RequiredAssemblies = 'Kusto.Autorest/bin/Az.Kusto.private.dll' # Script files (.ps1) that are run in the caller's environment prior to importing this module. -# ScriptsToProcess = @() +ScriptsToProcess = @() # Type files (.ps1xml) to be loaded when importing this module -# TypesToProcess = @() +TypesToProcess = @() # Format files (.ps1xml) to be loaded when importing this module FormatsToProcess = 'Kusto.Autorest/Az.Kusto.format.ps1xml' @@ -84,10 +84,8 @@ FunctionsToExport = 'Add-AzKustoClusterCalloutPolicy', 'Get-AzKustoDataConnection', 'Get-AzKustoManagedPrivateEndpoint', 'Get-AzKustoOperationsResult', 'Get-AzKustoOperationsResultLocation', - 'Get-AzKustoPrivateEndpointConnection', - 'Get-AzKustoPrivateLinkResource', 'Get-AzKustoSandboxCustomImage', - 'Get-AzKustoScript', 'Get-AzKustoSku', - 'Invoke-AzKustoClusterMigration', + 'Get-AzKustoSandboxCustomImage', 'Get-AzKustoScript', + 'Get-AzKustoSku', 'Invoke-AzKustoClusterMigration', 'Invoke-AzKustoDataConnectionValidation', 'Invoke-AzKustoDetachClusterFollowerDatabase', 'Invoke-AzKustoDiagnoseClusterVirtualNetwork', @@ -96,7 +94,6 @@ FunctionsToExport = 'Add-AzKustoClusterCalloutPolicy', 'New-AzKustoClusterPrincipalAssignment', 'New-AzKustoDatabase', 'New-AzKustoDatabasePrincipalAssignment', 'New-AzKustoDataConnection', 'New-AzKustoManagedPrivateEndpoint', - 'New-AzKustoPrivateEndpointConnection', 'New-AzKustoSandboxCustomImage', 'New-AzKustoScript', 'Remove-AzKustoAttachedDatabaseConfiguration', 'Remove-AzKustoCluster', 'Remove-AzKustoClusterCalloutPolicy', @@ -106,7 +103,6 @@ FunctionsToExport = 'Add-AzKustoClusterCalloutPolicy', 'Remove-AzKustoDatabasePrincipalAssignment', 'Remove-AzKustoDataConnection', 'Remove-AzKustoManagedPrivateEndpoint', - 'Remove-AzKustoPrivateEndpointConnection', 'Remove-AzKustoSandboxCustomImage', 'Remove-AzKustoScript', 'Start-AzKustoCluster', 'Stop-AzKustoCluster', 'Test-AzKustoAttachedDatabaseConfigurationNameAvailability', @@ -146,7 +142,7 @@ PrivateData = @{ PSData = @{ # Tags applied to this module. These help with module discovery in online galleries. - Tags = 'Azure','ResourceManager','ARM','PSModule','Kusto' + Tags = 'Azure', 'ResourceManager', 'ARM', 'PSModule', 'Kusto' # A URL to the license for this module. LicenseUri = 'https://aka.ms/azps-license' @@ -176,7 +172,7 @@ PrivateData = @{ } # End of PSData hashtable - } # End of PrivateData hashtable +} # End of PrivateData hashtable # HelpInfo URI of this module # HelpInfoURI = '' diff --git a/src/Kusto/Kusto/help/Add-AzKustoClusterCalloutPolicy.md b/src/Kusto/Kusto/help/Add-AzKustoClusterCalloutPolicy.md index 20835519d7fa..c1a0cc03c97c 100644 --- a/src/Kusto/Kusto/help/Add-AzKustoClusterCalloutPolicy.md +++ b/src/Kusto/Kusto/help/Add-AzKustoClusterCalloutPolicy.md @@ -19,6 +19,20 @@ Add-AzKustoClusterCalloutPolicy -ClusterName -ResourceGroupName ] ``` +### AddViaJsonString +``` +Add-AzKustoClusterCalloutPolicy -ClusterName -ResourceGroupName [-SubscriptionId ] + -JsonString [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-WhatIf] [-Confirm] [] +``` + +### AddViaJsonFilePath +``` +Add-AzKustoClusterCalloutPolicy -ClusterName -ResourceGroupName [-SubscriptionId ] + -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-WhatIf] [-Confirm] [] +``` + ### AddViaIdentityExpanded ``` Add-AzKustoClusterCalloutPolicy -InputObject [-NextLink ] [-Value ] @@ -70,7 +84,7 @@ The name of the Kusto cluster. ```yaml Type: System.String -Parameter Sets: AddExpanded +Parameter Sets: AddExpanded, AddViaJsonString, AddViaJsonFilePath Aliases: Required: True @@ -98,7 +112,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -112,12 +125,42 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -JsonFilePath +Path of Json file supplied to the Add operation + +```yaml +Type: System.String +Parameter Sets: AddViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Add operation + +```yaml +Type: System.String +Parameter Sets: AddViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -NextLink The URL to get the next set of callout policies list results if there are any. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: AddExpanded, AddViaIdentityExpanded Aliases: Required: False @@ -163,7 +206,7 @@ The name is case insensitive. ```yaml Type: System.String -Parameter Sets: AddExpanded +Parameter Sets: AddExpanded, AddViaJsonString, AddViaJsonFilePath Aliases: Required: True @@ -178,7 +221,7 @@ The ID of the target subscription. ```yaml Type: System.String -Parameter Sets: AddExpanded +Parameter Sets: AddExpanded, AddViaJsonString, AddViaJsonFilePath Aliases: Required: False @@ -190,11 +233,10 @@ Accept wildcard characters: False ### -Value A list of the service's callout policies. -To construct, see NOTES section for VALUE properties and create a hash table. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ICalloutPolicy[] -Parameter Sets: (All) +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ICalloutPolicy[] +Parameter Sets: AddExpanded, AddViaIdentityExpanded Aliases: Required: False diff --git a/src/Kusto/Kusto/help/Add-AzKustoClusterLanguageExtension.md b/src/Kusto/Kusto/help/Add-AzKustoClusterLanguageExtension.md index 20ffcfee9ce0..51551ea9d6e5 100644 --- a/src/Kusto/Kusto/help/Add-AzKustoClusterLanguageExtension.md +++ b/src/Kusto/Kusto/help/Add-AzKustoClusterLanguageExtension.md @@ -19,6 +19,20 @@ Add-AzKustoClusterLanguageExtension -ClusterName -ResourceGroupName ] ``` +### AddViaJsonString +``` +Add-AzKustoClusterLanguageExtension -ClusterName -ResourceGroupName + [-SubscriptionId ] -JsonString [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-WhatIf] [-Confirm] [] +``` + +### AddViaJsonFilePath +``` +Add-AzKustoClusterLanguageExtension -ClusterName -ResourceGroupName + [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-WhatIf] [-Confirm] [] +``` + ### AddViaIdentityExpanded ``` Add-AzKustoClusterLanguageExtension -InputObject [-Value ] @@ -60,7 +74,7 @@ The name of the Kusto cluster. ```yaml Type: System.String -Parameter Sets: AddExpanded +Parameter Sets: AddExpanded, AddViaJsonString, AddViaJsonFilePath Aliases: Required: True @@ -88,7 +102,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -102,6 +115,36 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -JsonFilePath +Path of Json file supplied to the Add operation + +```yaml +Type: System.String +Parameter Sets: AddViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Add operation + +```yaml +Type: System.String +Parameter Sets: AddViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -NoWait Run the command asynchronously @@ -138,7 +181,7 @@ The name is case insensitive. ```yaml Type: System.String -Parameter Sets: AddExpanded +Parameter Sets: AddExpanded, AddViaJsonString, AddViaJsonFilePath Aliases: Required: True @@ -153,7 +196,7 @@ The ID of the target subscription. ```yaml Type: System.String -Parameter Sets: AddExpanded +Parameter Sets: AddExpanded, AddViaJsonString, AddViaJsonFilePath Aliases: Required: False @@ -165,11 +208,10 @@ Accept wildcard characters: False ### -Value The list of language extensions. -To construct, see NOTES section for VALUE properties and create a hash table. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ILanguageExtension[] -Parameter Sets: (All) +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ILanguageExtension[] +Parameter Sets: AddExpanded, AddViaIdentityExpanded Aliases: Required: False diff --git a/src/Kusto/Kusto/help/Add-AzKustoDatabasePrincipal.md b/src/Kusto/Kusto/help/Add-AzKustoDatabasePrincipal.md index e5cf87b2a42b..397385ae0561 100644 --- a/src/Kusto/Kusto/help/Add-AzKustoDatabasePrincipal.md +++ b/src/Kusto/Kusto/help/Add-AzKustoDatabasePrincipal.md @@ -19,6 +19,27 @@ Add-AzKustoDatabasePrincipal -ClusterName -DatabaseName -Resou [-WhatIf] [-Confirm] [] ``` +### AddViaJsonString +``` +Add-AzKustoDatabasePrincipal -ClusterName -DatabaseName -ResourceGroupName + [-SubscriptionId ] -JsonString [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### AddViaJsonFilePath +``` +Add-AzKustoDatabasePrincipal -ClusterName -DatabaseName -ResourceGroupName + [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### AddViaIdentityClusterExpanded +``` +Add-AzKustoDatabasePrincipal -DatabaseName -ClusterInputObject + [-Value ] [-DefaultProfile ] [-WhatIf] + [-Confirm] [] +``` + ### AddViaIdentityExpanded ``` Add-AzKustoDatabasePrincipal -InputObject [-Value ] @@ -46,12 +67,27 @@ The above command adds Database principals permissions ## PARAMETERS +### -ClusterInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: AddViaIdentityClusterExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ClusterName The name of the Kusto cluster. ```yaml Type: System.String -Parameter Sets: AddExpanded +Parameter Sets: AddExpanded, AddViaJsonString, AddViaJsonFilePath Aliases: Required: True @@ -66,7 +102,7 @@ The name of the database in the Kusto cluster. ```yaml Type: System.String -Parameter Sets: AddExpanded +Parameter Sets: AddExpanded, AddViaJsonString, AddViaJsonFilePath, AddViaIdentityClusterExpanded Aliases: Required: True @@ -94,7 +130,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -108,13 +143,43 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -JsonFilePath +Path of Json file supplied to the Add operation + +```yaml +Type: System.String +Parameter Sets: AddViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Add operation + +```yaml +Type: System.String +Parameter Sets: AddViaJsonString +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: AddExpanded +Parameter Sets: AddExpanded, AddViaJsonString, AddViaJsonFilePath Aliases: Required: True @@ -129,7 +194,7 @@ The ID of the target subscription. ```yaml Type: System.String -Parameter Sets: AddExpanded +Parameter Sets: AddExpanded, AddViaJsonString, AddViaJsonFilePath Aliases: Required: False @@ -141,11 +206,10 @@ Accept wildcard characters: False ### -Value The list of Kusto database principals. -To construct, see NOTES section for VALUE properties and create a hash table. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IDatabasePrincipal[] -Parameter Sets: (All) +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IDatabasePrincipal[] +Parameter Sets: AddExpanded, AddViaIdentityClusterExpanded, AddViaIdentityExpanded Aliases: Required: False @@ -195,7 +259,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IDatabasePrincipal +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IDatabasePrincipalListResult ## NOTES diff --git a/src/Kusto/Kusto/help/Az.Kusto.md b/src/Kusto/Kusto/help/Az.Kusto.md index 2fb3d8d283a5..d6110e502df8 100644 --- a/src/Kusto/Kusto/help/Az.Kusto.md +++ b/src/Kusto/Kusto/help/Az.Kusto.md @@ -68,12 +68,6 @@ Returns operation results. ### [Get-AzKustoOperationsResultLocation](Get-AzKustoOperationsResultLocation.md) Returns operation results. -### [Get-AzKustoPrivateEndpointConnection](Get-AzKustoPrivateEndpointConnection.md) -Gets a private endpoint connection. - -### [Get-AzKustoPrivateLinkResource](Get-AzKustoPrivateLinkResource.md) -Gets a private link resource. - ### [Get-AzKustoSandboxCustomImage](Get-AzKustoSandboxCustomImage.md) Returns a sandbox custom image @@ -99,34 +93,31 @@ Diagnoses network connectivity status for external resources on which the servic Generates an invitation token that allows attaching a follower database to this database. ### [New-AzKustoAttachedDatabaseConfiguration](New-AzKustoAttachedDatabaseConfiguration.md) -Creates or updates an attached database configuration. +Create an attached database configuration. ### [New-AzKustoCluster](New-AzKustoCluster.md) -Create or update a Kusto cluster. +Create a Kusto cluster. ### [New-AzKustoClusterPrincipalAssignment](New-AzKustoClusterPrincipalAssignment.md) Create a Kusto cluster principalAssignment. ### [New-AzKustoDatabase](New-AzKustoDatabase.md) -Creates or updates a database. +Create a database. ### [New-AzKustoDatabasePrincipalAssignment](New-AzKustoDatabasePrincipalAssignment.md) -Creates a Kusto cluster database principalAssignment. +Create a Kusto cluster database principalAssignment. ### [New-AzKustoDataConnection](New-AzKustoDataConnection.md) -Creates or updates a data connection. +Create a data connection. ### [New-AzKustoManagedPrivateEndpoint](New-AzKustoManagedPrivateEndpoint.md) -Creates a managed private endpoint. - -### [New-AzKustoPrivateEndpointConnection](New-AzKustoPrivateEndpointConnection.md) -Approve or reject a private endpoint connection with a given name. +Create a managed private endpoint. ### [New-AzKustoSandboxCustomImage](New-AzKustoSandboxCustomImage.md) -Creates or updates a sandbox custom image. +Create a sandbox custom image. ### [New-AzKustoScript](New-AzKustoScript.md) -Creates a Kusto database script. +Create a Kusto database script. ### [Remove-AzKustoAttachedDatabaseConfiguration](Remove-AzKustoAttachedDatabaseConfiguration.md) Deletes the attached database configuration with the given name. @@ -158,9 +149,6 @@ Deletes the data connection with the given name. ### [Remove-AzKustoManagedPrivateEndpoint](Remove-AzKustoManagedPrivateEndpoint.md) Deletes a managed private endpoint. -### [Remove-AzKustoPrivateEndpointConnection](Remove-AzKustoPrivateEndpointConnection.md) -Deletes a private endpoint connection with a given name. - ### [Remove-AzKustoSandboxCustomImage](Remove-AzKustoSandboxCustomImage.md) Deletes a sandbox custom image. @@ -204,17 +192,17 @@ Checks that the script name is valid and is not already in use. Update a Kusto cluster. ### [Update-AzKustoDatabase](Update-AzKustoDatabase.md) -Updates a database. +Update a database. ### [Update-AzKustoDataConnection](Update-AzKustoDataConnection.md) -Updates a data connection. +Update a data connection. ### [Update-AzKustoManagedPrivateEndpoint](Update-AzKustoManagedPrivateEndpoint.md) -Updates a managed private endpoint. +Update a managed private endpoint. ### [Update-AzKustoSandboxCustomImage](Update-AzKustoSandboxCustomImage.md) -Updates a sandbox custom image. +Update a sandbox custom image. ### [Update-AzKustoScript](Update-AzKustoScript.md) -Updates a database script. +Update a database script. diff --git a/src/Kusto/Kusto/help/Get-AzKustoAttachedDatabaseConfiguration.md b/src/Kusto/Kusto/help/Get-AzKustoAttachedDatabaseConfiguration.md index 258b2f7df945..84f5010ef0b8 100644 --- a/src/Kusto/Kusto/help/Get-AzKustoAttachedDatabaseConfiguration.md +++ b/src/Kusto/Kusto/help/Get-AzKustoAttachedDatabaseConfiguration.md @@ -26,6 +26,12 @@ Get-AzKustoAttachedDatabaseConfiguration -ClusterName -Name -R [] ``` +### GetViaIdentityCluster +``` +Get-AzKustoAttachedDatabaseConfiguration -Name -ClusterInputObject + [-DefaultProfile ] [] +``` + ### GetViaIdentity ``` Get-AzKustoAttachedDatabaseConfiguration -InputObject [-DefaultProfile ] @@ -65,6 +71,21 @@ The above command returns the AttachedDatabaseConfigurations named "myfollowerco ## PARAMETERS +### -ClusterInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: GetViaIdentityCluster +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ClusterName The name of the Kusto cluster. @@ -98,7 +119,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -117,7 +137,7 @@ The name of the attached database configuration. ```yaml Type: System.String -Parameter Sets: Get +Parameter Sets: Get, GetViaIdentityCluster Aliases: AttachedDatabaseConfigurationName Required: True @@ -167,7 +187,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IAttachedDatabaseConfiguration +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IAttachedDatabaseConfiguration ## NOTES diff --git a/src/Kusto/Kusto/help/Get-AzKustoCluster.md b/src/Kusto/Kusto/help/Get-AzKustoCluster.md index 10931572f5d6..c42f772cd415 100644 --- a/src/Kusto/Kusto/help/Get-AzKustoCluster.md +++ b/src/Kusto/Kusto/help/Get-AzKustoCluster.md @@ -88,7 +88,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -157,7 +156,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ICluster +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ICluster ## NOTES diff --git a/src/Kusto/Kusto/help/Get-AzKustoClusterCalloutPolicy.md b/src/Kusto/Kusto/help/Get-AzKustoClusterCalloutPolicy.md index b81382b8def8..97b52455b5aa 100644 --- a/src/Kusto/Kusto/help/Get-AzKustoClusterCalloutPolicy.md +++ b/src/Kusto/Kusto/help/Get-AzKustoClusterCalloutPolicy.md @@ -142,7 +142,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ICalloutPolicy +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ICalloutPolicy ## NOTES diff --git a/src/Kusto/Kusto/help/Get-AzKustoClusterFollowerDatabase.md b/src/Kusto/Kusto/help/Get-AzKustoClusterFollowerDatabase.md index 8ccb29b9baab..b87483b3c2c6 100644 --- a/src/Kusto/Kusto/help/Get-AzKustoClusterFollowerDatabase.md +++ b/src/Kusto/Kusto/help/Get-AzKustoClusterFollowerDatabase.md @@ -138,7 +138,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IFollowerDatabaseDefinition +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IFollowerDatabaseDefinition ## NOTES diff --git a/src/Kusto/Kusto/help/Get-AzKustoClusterFollowerDatabaseGet.md b/src/Kusto/Kusto/help/Get-AzKustoClusterFollowerDatabaseGet.md index 2d767f20eb72..5526afbb0497 100644 --- a/src/Kusto/Kusto/help/Get-AzKustoClusterFollowerDatabaseGet.md +++ b/src/Kusto/Kusto/help/Get-AzKustoClusterFollowerDatabaseGet.md @@ -135,7 +135,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IFollowerDatabaseDefinitionGet +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IFollowerDatabaseDefinitionGet ## NOTES diff --git a/src/Kusto/Kusto/help/Get-AzKustoClusterLanguageExtension.md b/src/Kusto/Kusto/help/Get-AzKustoClusterLanguageExtension.md index 3d70ae8f8ca3..c0f46f4e99de 100644 --- a/src/Kusto/Kusto/help/Get-AzKustoClusterLanguageExtension.md +++ b/src/Kusto/Kusto/help/Get-AzKustoClusterLanguageExtension.md @@ -139,7 +139,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ILanguageExtension +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ILanguageExtension ## NOTES diff --git a/src/Kusto/Kusto/help/Get-AzKustoClusterOutboundNetworkDependencyEndpoint.md b/src/Kusto/Kusto/help/Get-AzKustoClusterOutboundNetworkDependencyEndpoint.md index 3ccf31e15062..efe375bb7056 100644 --- a/src/Kusto/Kusto/help/Get-AzKustoClusterOutboundNetworkDependencyEndpoint.md +++ b/src/Kusto/Kusto/help/Get-AzKustoClusterOutboundNetworkDependencyEndpoint.md @@ -110,7 +110,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IOutboundNetworkDependenciesEndpoint +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IOutboundNetworkDependenciesEndpoint ## NOTES diff --git a/src/Kusto/Kusto/help/Get-AzKustoClusterPrincipalAssignment.md b/src/Kusto/Kusto/help/Get-AzKustoClusterPrincipalAssignment.md index 3af20aaf7253..a32ffd831413 100644 --- a/src/Kusto/Kusto/help/Get-AzKustoClusterPrincipalAssignment.md +++ b/src/Kusto/Kusto/help/Get-AzKustoClusterPrincipalAssignment.md @@ -26,6 +26,12 @@ Get-AzKustoClusterPrincipalAssignment -ClusterName -PrincipalAssignment [] ``` +### GetViaIdentityCluster +``` +Get-AzKustoClusterPrincipalAssignment -PrincipalAssignmentName -ClusterInputObject + [-DefaultProfile ] [] +``` + ### GetViaIdentity ``` Get-AzKustoClusterPrincipalAssignment -InputObject [-DefaultProfile ] @@ -65,6 +71,21 @@ The above command returns the Kusto cluster principalAssignment named "kustoprin ## PARAMETERS +### -ClusterInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: GetViaIdentityCluster +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ClusterName The name of the Kusto cluster. @@ -98,7 +119,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -117,7 +137,7 @@ The name of the Kusto principalAssignment. ```yaml Type: System.String -Parameter Sets: Get +Parameter Sets: Get, GetViaIdentityCluster Aliases: Required: True @@ -167,7 +187,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IClusterPrincipalAssignment +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IClusterPrincipalAssignment ## NOTES diff --git a/src/Kusto/Kusto/help/Get-AzKustoClusterSku.md b/src/Kusto/Kusto/help/Get-AzKustoClusterSku.md index 58785f899dc0..b354567f6f52 100644 --- a/src/Kusto/Kusto/help/Get-AzKustoClusterSku.md +++ b/src/Kusto/Kusto/help/Get-AzKustoClusterSku.md @@ -163,9 +163,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IAzureResourceSku +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IAzureResourceSku -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ISkuDescription +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ISkuDescription ## NOTES diff --git a/src/Kusto/Kusto/help/Get-AzKustoDataConnection.md b/src/Kusto/Kusto/help/Get-AzKustoDataConnection.md index a50923c03fec..35c67714bf39 100644 --- a/src/Kusto/Kusto/help/Get-AzKustoDataConnection.md +++ b/src/Kusto/Kusto/help/Get-AzKustoDataConnection.md @@ -26,6 +26,18 @@ Get-AzKustoDataConnection -ClusterName -DatabaseName -Name ] ``` +### GetViaIdentityCluster +``` +Get-AzKustoDataConnection -DatabaseName -Name -ClusterInputObject + [-DefaultProfile ] [] +``` + +### GetViaIdentityDatabase +``` +Get-AzKustoDataConnection -Name -DatabaseInputObject [-DefaultProfile ] + [] +``` + ### GetViaIdentity ``` Get-AzKustoDataConnection -InputObject [-DefaultProfile ] @@ -65,6 +77,21 @@ The above command returns the data connection named "mykustodataconnection" in d ## PARAMETERS +### -ClusterInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: GetViaIdentityCluster +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ClusterName The name of the Kusto cluster. @@ -80,12 +107,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DatabaseInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: GetViaIdentityDatabase +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -DatabaseName The name of the database in the Kusto cluster. ```yaml Type: System.String -Parameter Sets: List, Get +Parameter Sets: List, Get, GetViaIdentityCluster Aliases: Required: True @@ -113,7 +155,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -132,7 +173,7 @@ The name of the data connection. ```yaml Type: System.String -Parameter Sets: Get +Parameter Sets: Get, GetViaIdentityCluster, GetViaIdentityDatabase Aliases: DataConnectionName Required: True @@ -182,7 +223,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IDataConnection +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IDataConnection ## NOTES diff --git a/src/Kusto/Kusto/help/Get-AzKustoDatabase.md b/src/Kusto/Kusto/help/Get-AzKustoDatabase.md index b5aba36a9148..9d7040d197e7 100644 --- a/src/Kusto/Kusto/help/Get-AzKustoDatabase.md +++ b/src/Kusto/Kusto/help/Get-AzKustoDatabase.md @@ -26,6 +26,12 @@ Get-AzKustoDatabase -ClusterName -Name -ResourceGroupName ] ``` +### GetViaIdentityCluster +``` +Get-AzKustoDatabase -Name -ClusterInputObject [-DefaultProfile ] + [] +``` + ### GetViaIdentity ``` Get-AzKustoDatabase -InputObject [-DefaultProfile ] @@ -66,6 +72,21 @@ The above command returns the Kusto database named "mykustodatabase" in the clus ## PARAMETERS +### -ClusterInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: GetViaIdentityCluster +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ClusterName The name of the Kusto cluster. @@ -99,7 +120,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -118,7 +138,7 @@ The name of the database in the Kusto cluster. ```yaml Type: System.String -Parameter Sets: Get +Parameter Sets: Get, GetViaIdentityCluster Aliases: DatabaseName Required: True @@ -199,7 +219,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IDatabase +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IDatabase ## NOTES diff --git a/src/Kusto/Kusto/help/Get-AzKustoDatabasePrincipal.md b/src/Kusto/Kusto/help/Get-AzKustoDatabasePrincipal.md index fcc6ebb05385..97fcde2af4db 100644 --- a/src/Kusto/Kusto/help/Get-AzKustoDatabasePrincipal.md +++ b/src/Kusto/Kusto/help/Get-AzKustoDatabasePrincipal.md @@ -154,7 +154,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IDatabasePrincipal +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IDatabasePrincipal ## NOTES diff --git a/src/Kusto/Kusto/help/Get-AzKustoDatabasePrincipalAssignment.md b/src/Kusto/Kusto/help/Get-AzKustoDatabasePrincipalAssignment.md index 6f1e3e43b902..696e0e962500 100644 --- a/src/Kusto/Kusto/help/Get-AzKustoDatabasePrincipalAssignment.md +++ b/src/Kusto/Kusto/help/Get-AzKustoDatabasePrincipalAssignment.md @@ -26,6 +26,19 @@ Get-AzKustoDatabasePrincipalAssignment -ClusterName -DatabaseName ] [] ``` +### GetViaIdentityCluster +``` +Get-AzKustoDatabasePrincipalAssignment -DatabaseName -PrincipalAssignmentName + -ClusterInputObject [-DefaultProfile ] + [] +``` + +### GetViaIdentityDatabase +``` +Get-AzKustoDatabasePrincipalAssignment -PrincipalAssignmentName -DatabaseInputObject + [-DefaultProfile ] [] +``` + ### GetViaIdentity ``` Get-AzKustoDatabasePrincipalAssignment -InputObject [-DefaultProfile ] @@ -67,6 +80,21 @@ The above command returns all all PrincipalAssignment named "kustoprincipal1" in ## PARAMETERS +### -ClusterInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: GetViaIdentityCluster +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ClusterName The name of the Kusto cluster. @@ -82,12 +110,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DatabaseInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: GetViaIdentityDatabase +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -DatabaseName The name of the database in the Kusto cluster. ```yaml Type: System.String -Parameter Sets: List, Get +Parameter Sets: List, Get, GetViaIdentityCluster Aliases: Required: True @@ -115,7 +158,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -134,7 +176,7 @@ The name of the Kusto principalAssignment. ```yaml Type: System.String -Parameter Sets: Get +Parameter Sets: Get, GetViaIdentityCluster, GetViaIdentityDatabase Aliases: Required: True @@ -184,7 +226,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IDatabasePrincipalAssignment +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IDatabasePrincipalAssignment ## NOTES diff --git a/src/Kusto/Kusto/help/Get-AzKustoManagedPrivateEndpoint.md b/src/Kusto/Kusto/help/Get-AzKustoManagedPrivateEndpoint.md index 77f767e2091e..c8a2653941c6 100644 --- a/src/Kusto/Kusto/help/Get-AzKustoManagedPrivateEndpoint.md +++ b/src/Kusto/Kusto/help/Get-AzKustoManagedPrivateEndpoint.md @@ -26,6 +26,12 @@ Get-AzKustoManagedPrivateEndpoint -ClusterName -Name -Resource [] ``` +### GetViaIdentityCluster +``` +Get-AzKustoManagedPrivateEndpoint -Name -ClusterInputObject + [-DefaultProfile ] [] +``` + ### GetViaIdentity ``` Get-AzKustoManagedPrivateEndpoint -InputObject [-DefaultProfile ] @@ -66,6 +72,21 @@ The above command returns the Kusto ManagedPrivateEndpoint named "ManagedPrivate ## PARAMETERS +### -ClusterInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: GetViaIdentityCluster +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ClusterName The name of the Kusto cluster. @@ -99,7 +120,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -118,7 +138,7 @@ The name of the managed private endpoint. ```yaml Type: System.String -Parameter Sets: Get +Parameter Sets: Get, GetViaIdentityCluster Aliases: ManagedPrivateEndpointName Required: True @@ -168,7 +188,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IManagedPrivateEndpoint +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IManagedPrivateEndpoint ## NOTES diff --git a/src/Kusto/Kusto/help/Get-AzKustoOperationsResult.md b/src/Kusto/Kusto/help/Get-AzKustoOperationsResult.md index a42dd0b1d6e9..e17889ff9575 100644 --- a/src/Kusto/Kusto/help/Get-AzKustoOperationsResult.md +++ b/src/Kusto/Kusto/help/Get-AzKustoOperationsResult.md @@ -18,6 +18,12 @@ Get-AzKustoOperationsResult -Location -OperationId [-Subscript [-DefaultProfile ] [] ``` +### GetViaIdentityLocation +``` +Get-AzKustoOperationsResult -OperationId -LocationInputObject + [-DefaultProfile ] [] +``` + ### GetViaIdentity ``` Get-AzKustoOperationsResult -InputObject [-DefaultProfile ] @@ -62,7 +68,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -91,12 +96,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -LocationInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: GetViaIdentityLocation +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -OperationId The ID of an ongoing async operation. ```yaml Type: System.String -Parameter Sets: Get +Parameter Sets: Get, GetViaIdentityLocation Aliases: Required: True @@ -130,7 +150,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IOperationResult +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IOperationResult ## NOTES diff --git a/src/Kusto/Kusto/help/Get-AzKustoOperationsResultLocation.md b/src/Kusto/Kusto/help/Get-AzKustoOperationsResultLocation.md index c7b125bee551..a40e4a67ff0c 100644 --- a/src/Kusto/Kusto/help/Get-AzKustoOperationsResultLocation.md +++ b/src/Kusto/Kusto/help/Get-AzKustoOperationsResultLocation.md @@ -18,6 +18,12 @@ Get-AzKustoOperationsResultLocation -Location -OperationId [-S [-DefaultProfile ] [-PassThru] [] ``` +### GetViaIdentityLocation +``` +Get-AzKustoOperationsResultLocation -OperationId -LocationInputObject + [-DefaultProfile ] [-PassThru] [] +``` + ### GetViaIdentity ``` Get-AzKustoOperationsResultLocation -InputObject [-DefaultProfile ] [-PassThru] @@ -62,7 +68,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -91,12 +96,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -LocationInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: GetViaIdentityLocation +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -OperationId The ID of an ongoing async operation. ```yaml Type: System.String -Parameter Sets: Get +Parameter Sets: Get, GetViaIdentityLocation Aliases: Required: True diff --git a/src/Kusto/Kusto/help/Get-AzKustoPrivateEndpointConnection.md b/src/Kusto/Kusto/help/Get-AzKustoPrivateEndpointConnection.md deleted file mode 100644 index 51095491a102..000000000000 --- a/src/Kusto/Kusto/help/Get-AzKustoPrivateEndpointConnection.md +++ /dev/null @@ -1,175 +0,0 @@ ---- -external help file: Az.Kusto-help.xml -Module Name: Az.Kusto -online version: https://learn.microsoft.com/powershell/module/az.kusto/get-azkustoprivateendpointconnection -schema: 2.0.0 ---- - -# Get-AzKustoPrivateEndpointConnection - -## SYNOPSIS -Gets a private endpoint connection. - -## SYNTAX - -### List (Default) -``` -Get-AzKustoPrivateEndpointConnection -ClusterName -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] - [] -``` - -### Get -``` -Get-AzKustoPrivateEndpointConnection -ClusterName -Name -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] - [] -``` - -### GetViaIdentity -``` -Get-AzKustoPrivateEndpointConnection -InputObject [-DefaultProfile ] - [] -``` - -## DESCRIPTION -Gets a private endpoint connection. - -## EXAMPLES - -### Example 1: List all Kusto PrivateEndpointConnection in a cluster by name -```powershell -Get-AzKustoPrivateEndpointConnection -ClusterName "mycluster" -ResourceGroupName "testrg" -SubscriptionId "12345678-1234-1234-1234-123456789098" -``` - -```output -Name Type ----- ---- -privateEndpointConnectionName1 Microsoft.Kusto/Clusters/PrivateEndpointConnections -privateEndpointConnectionName2 Microsoft.Kusto/Clusters/PrivateEndpointConnections -``` - -The above command returns all Kusto PrivateEndpointConnection in the cluster "mycluster" found in the resource group "testrg". - -### Example 2: Get a specific Kusto PrivateEndpointConnection by name -```powershell -Get-AzKustoPrivateEndpointConnection -ClusterName "mycluster" -ResourceGroupName "testrg" -SubscriptionId "12345678-1234-1234-1234-123456789098" -Name "privateEndpointConnectionName" -``` - -```output -Name Type ----- ---- -privateEndpointConnectionName Microsoft.Kusto/Clusters/PrivateEndpointConnections -``` - -The above command returns the Kusto PrivateEndpointConnection named "privateEndpointConnectionName" in the cluster "mycluster" found in the resource group "testrg". - -## PARAMETERS - -### -ClusterName -The name of the Kusto cluster. - -```yaml -Type: System.String -Parameter Sets: List, Get -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 -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the private endpoint connection. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: PrivateEndpointConnectionName - -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: List, Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The ID of the target subscription. - -```yaml -Type: System.String[] -Parameter Sets: List, Get -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.Kusto.Models.IKustoIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IPrivateEndpointConnection - -## NOTES - -## RELATED LINKS diff --git a/src/Kusto/Kusto/help/Get-AzKustoPrivateLinkResource.md b/src/Kusto/Kusto/help/Get-AzKustoPrivateLinkResource.md deleted file mode 100644 index 9849359f38da..000000000000 --- a/src/Kusto/Kusto/help/Get-AzKustoPrivateLinkResource.md +++ /dev/null @@ -1,173 +0,0 @@ ---- -external help file: Az.Kusto-help.xml -Module Name: Az.Kusto -online version: https://learn.microsoft.com/powershell/module/az.kusto/get-azkustoprivatelinkresource -schema: 2.0.0 ---- - -# Get-AzKustoPrivateLinkResource - -## SYNOPSIS -Gets a private link resource. - -## SYNTAX - -### List (Default) -``` -Get-AzKustoPrivateLinkResource -ClusterName -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [] -``` - -### Get -``` -Get-AzKustoPrivateLinkResource -ClusterName -Name -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] - [] -``` - -### GetViaIdentity -``` -Get-AzKustoPrivateLinkResource -InputObject [-DefaultProfile ] - [] -``` - -## DESCRIPTION -Gets a private link resource. - -## EXAMPLES - -### Example 1: List all PrivateLinkResource in a cluster -```powershell -Get-AzKustoPrivateLinkResource -ClusterName "mycluster" -ResourceGroupName "testrg" -``` - -```output -Name Type ----- ---- -mycluster/cluster Microsoft.Kusto/Clusters/PrivateLinkResources -``` - -The above command returns all PrivateLinkResource in the cluster "mycluster" found in the resource group "testrg". - -### Example 2: Get a specific PrivateLinkResource by name -```powershell -Get-AzKustoPrivateLinkResource -ClusterName "mycluster" -ResourceGroupName "testrg" -Name "ManagedPrivateEndpointName" -``` - -```output -Name Type ----- ---- -mycluster/cluster Microsoft.Kusto/Clusters/PrivateLinkResources -``` - -The above command returns the PrivateLinkResource named "mycluster/cluster" in the cluster "mycluster" found in the resource group "testrg". - -## PARAMETERS - -### -ClusterName -The name of the Kusto cluster. - -```yaml -Type: System.String -Parameter Sets: List, Get -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 -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity -Parameter Sets: GetViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the private link resource. - -```yaml -Type: System.String -Parameter Sets: Get -Aliases: PrivateLinkResourceName - -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: List, Get -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubscriptionId -The ID of the target subscription. - -```yaml -Type: System.String[] -Parameter Sets: List, Get -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.Kusto.Models.IKustoIdentity - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IPrivateLinkResource - -## NOTES - -## RELATED LINKS diff --git a/src/Kusto/Kusto/help/Get-AzKustoSandboxCustomImage.md b/src/Kusto/Kusto/help/Get-AzKustoSandboxCustomImage.md index 78adca9c54ce..a23d8d466266 100644 --- a/src/Kusto/Kusto/help/Get-AzKustoSandboxCustomImage.md +++ b/src/Kusto/Kusto/help/Get-AzKustoSandboxCustomImage.md @@ -25,6 +25,12 @@ Get-AzKustoSandboxCustomImage -ClusterName -Name -ResourceGrou [] ``` +### GetViaIdentityCluster +``` +Get-AzKustoSandboxCustomImage -Name -ClusterInputObject [-DefaultProfile ] + [] +``` + ### GetViaIdentity ``` Get-AzKustoSandboxCustomImage -InputObject [-DefaultProfile ] @@ -64,6 +70,21 @@ The above command returns a Kusto sandbox custom image named "myImage" in cluste ## PARAMETERS +### -ClusterInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: GetViaIdentityCluster +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ClusterName The name of the Kusto cluster. @@ -97,7 +118,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -116,7 +136,7 @@ The name of the sandbox custom image. ```yaml Type: System.String -Parameter Sets: Get +Parameter Sets: Get, GetViaIdentityCluster Aliases: SandboxCustomImageName Required: True @@ -166,7 +186,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ISandboxCustomImage +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ISandboxCustomImage ## NOTES diff --git a/src/Kusto/Kusto/help/Get-AzKustoScript.md b/src/Kusto/Kusto/help/Get-AzKustoScript.md index 6f493d510688..c53ebe4edc88 100644 --- a/src/Kusto/Kusto/help/Get-AzKustoScript.md +++ b/src/Kusto/Kusto/help/Get-AzKustoScript.md @@ -26,6 +26,18 @@ Get-AzKustoScript -ClusterName -DatabaseName -Name -R [] ``` +### GetViaIdentityCluster +``` +Get-AzKustoScript -DatabaseName -Name -ClusterInputObject + [-DefaultProfile ] [] +``` + +### GetViaIdentityDatabase +``` +Get-AzKustoScript -Name -DatabaseInputObject [-DefaultProfile ] + [] +``` + ### GetViaIdentity ``` Get-AzKustoScript -InputObject [-DefaultProfile ] @@ -65,6 +77,21 @@ The above command returns the Kusto database script named "newkustoscript" in th ## PARAMETERS +### -ClusterInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: GetViaIdentityCluster +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ClusterName The name of the Kusto cluster. @@ -80,12 +107,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DatabaseInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: GetViaIdentityDatabase +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -DatabaseName The name of the database in the Kusto cluster. ```yaml Type: System.String -Parameter Sets: List, Get +Parameter Sets: List, Get, GetViaIdentityCluster Aliases: Required: True @@ -113,7 +155,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -132,7 +173,7 @@ The name of the Kusto database script. ```yaml Type: System.String -Parameter Sets: Get +Parameter Sets: Get, GetViaIdentityCluster, GetViaIdentityDatabase Aliases: ScriptName Required: True @@ -182,7 +223,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IScript +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IScript ## NOTES diff --git a/src/Kusto/Kusto/help/Get-AzKustoSku.md b/src/Kusto/Kusto/help/Get-AzKustoSku.md index 6be3cb93206e..226ab2cdfa02 100644 --- a/src/Kusto/Kusto/help/Get-AzKustoSku.md +++ b/src/Kusto/Kusto/help/Get-AzKustoSku.md @@ -132,7 +132,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ISkuDescription +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ISkuDescription ## NOTES diff --git a/src/Kusto/Kusto/help/Invoke-AzKustoClusterMigration.md b/src/Kusto/Kusto/help/Invoke-AzKustoClusterMigration.md index e7bda33c07f3..09caac4dcfcc 100644 --- a/src/Kusto/Kusto/help/Invoke-AzKustoClusterMigration.md +++ b/src/Kusto/Kusto/help/Invoke-AzKustoClusterMigration.md @@ -19,6 +19,20 @@ Invoke-AzKustoClusterMigration -Name -ResourceGroupName [-Subs [-WhatIf] [-Confirm] [] ``` +### MigrateViaJsonString +``` +Invoke-AzKustoClusterMigration -Name -ResourceGroupName [-SubscriptionId ] + -JsonString [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-WhatIf] [-Confirm] [] +``` + +### MigrateViaJsonFilePath +``` +Invoke-AzKustoClusterMigration -Name -ResourceGroupName [-SubscriptionId ] + -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-WhatIf] [-Confirm] [] +``` + ### Migrate ``` Invoke-AzKustoClusterMigration -Name -ResourceGroupName [-SubscriptionId ] @@ -71,10 +85,9 @@ Accept wildcard characters: False ### -ClusterMigrateRequest A cluster migrate request. -To construct, see NOTES section for CLUSTERMIGRATEREQUEST properties and create a hash table. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IClusterMigrateRequest +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IClusterMigrateRequest Parameter Sets: Migrate, MigrateViaIdentity Aliases: @@ -118,7 +131,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -132,12 +144,42 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -JsonFilePath +Path of Json file supplied to the Migrate operation + +```yaml +Type: System.String +Parameter Sets: MigrateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Migrate operation + +```yaml +Type: System.String +Parameter Sets: MigrateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name The name of the Kusto cluster. ```yaml Type: System.String -Parameter Sets: MigrateExpanded, Migrate +Parameter Sets: MigrateExpanded, MigrateViaJsonString, MigrateViaJsonFilePath, Migrate Aliases: ClusterName Required: True @@ -183,7 +225,7 @@ The name is case insensitive. ```yaml Type: System.String -Parameter Sets: MigrateExpanded, Migrate +Parameter Sets: MigrateExpanded, MigrateViaJsonString, MigrateViaJsonFilePath, Migrate Aliases: Required: True @@ -198,7 +240,7 @@ The ID of the target subscription. ```yaml Type: System.String -Parameter Sets: MigrateExpanded, Migrate +Parameter Sets: MigrateExpanded, MigrateViaJsonString, MigrateViaJsonFilePath, Migrate Aliases: Required: False @@ -244,7 +286,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IClusterMigrateRequest +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IClusterMigrateRequest ### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity diff --git a/src/Kusto/Kusto/help/Invoke-AzKustoDataConnectionValidation.md b/src/Kusto/Kusto/help/Invoke-AzKustoDataConnectionValidation.md index 68f6d196d89a..01bf044a081e 100644 --- a/src/Kusto/Kusto/help/Invoke-AzKustoDataConnectionValidation.md +++ b/src/Kusto/Kusto/help/Invoke-AzKustoDataConnectionValidation.md @@ -15,19 +15,19 @@ Checks that the data connection parameters are valid. ### DataExpandedEventHub (Default) ``` Invoke-AzKustoDataConnectionValidation -ClusterName -DatabaseName -ResourceGroupName - [-SubscriptionId ] -Kind -DataConnectionName -ConsumerGroup + [-SubscriptionId ] -Kind -DataConnectionName -ConsumerGroup -Location -EventHubResourceId [-DataFormat ] [-EventSystemProperty ] - [-MappingRuleName ] [-TableName ] [-Compression ] - [-ManagedIdentityResourceId ] [-DatabaseRouting ] [-RetrievalStartDate ] + [-MappingRuleName ] [-TableName ] [-Compression ] + [-ManagedIdentityResourceId ] [-DatabaseRouting ] [-RetrievalStartDate ] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### DataExpandedEventGrid ``` Invoke-AzKustoDataConnectionValidation -ClusterName -DatabaseName -ResourceGroupName - [-SubscriptionId ] -Kind -DataConnectionName -ConsumerGroup + [-SubscriptionId ] -Kind -DataConnectionName -ConsumerGroup -Location -EventHubResourceId [-DataFormat ] [-MappingRuleName ] - [-TableName ] [-ManagedIdentityResourceId ] [-DatabaseRouting ] + [-TableName ] [-ManagedIdentityResourceId ] [-DatabaseRouting ] -StorageAccountResourceId [-EventGridResourceId ] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` @@ -35,54 +35,55 @@ Invoke-AzKustoDataConnectionValidation -ClusterName -DatabaseName -DatabaseName -ResourceGroupName - [-SubscriptionId ] -Kind -DataConnectionName -ConsumerGroup + [-SubscriptionId ] -Kind -DataConnectionName -ConsumerGroup -Location [-DataFormat ] [-EventSystemProperty ] [-MappingRuleName ] - [-TableName ] [-DatabaseRouting ] [-RetrievalStartDate ] - -IotHubResourceId -SharedAccessPolicyName [-DefaultProfile ] - [-WhatIf] [-Confirm] [] + [-TableName ] [-DatabaseRouting ] [-RetrievalStartDate ] -IotHubResourceId + -SharedAccessPolicyName [-DefaultProfile ] [-WhatIf] + [-Confirm] [] ``` ### DataViaIdentityExpandedEventHub ``` -Invoke-AzKustoDataConnectionValidation -InputObject -Kind -DataConnectionName - -ConsumerGroup -Location -EventHubResourceId [-DataFormat ] - [-EventSystemProperty ] [-MappingRuleName ] [-TableName ] - [-Compression ] [-ManagedIdentityResourceId ] [-DatabaseRouting ] +Invoke-AzKustoDataConnectionValidation -InputObject -Kind + -DataConnectionName -ConsumerGroup -Location -EventHubResourceId + [-DataFormat ] [-EventSystemProperty ] [-MappingRuleName ] [-TableName ] + [-Compression ] [-ManagedIdentityResourceId ] [-DatabaseRouting ] [-RetrievalStartDate ] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### DataViaIdentityExpandedEventGrid ``` -Invoke-AzKustoDataConnectionValidation -InputObject -Kind -DataConnectionName - -ConsumerGroup -Location -EventHubResourceId [-DataFormat ] - [-MappingRuleName ] [-TableName ] [-ManagedIdentityResourceId ] - [-DatabaseRouting ] -StorageAccountResourceId [-EventGridResourceId ] +Invoke-AzKustoDataConnectionValidation -InputObject -Kind + -DataConnectionName -ConsumerGroup -Location -EventHubResourceId + [-DataFormat ] [-MappingRuleName ] [-TableName ] [-ManagedIdentityResourceId ] + [-DatabaseRouting ] -StorageAccountResourceId [-EventGridResourceId ] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### DataViaIdentityExpandedIotHub ``` -Invoke-AzKustoDataConnectionValidation -InputObject -Kind -DataConnectionName - -ConsumerGroup -Location [-DataFormat ] [-EventSystemProperty ] - [-MappingRuleName ] [-TableName ] [-DatabaseRouting ] - [-RetrievalStartDate ] -IotHubResourceId -SharedAccessPolicyName - [-DefaultProfile ] [-WhatIf] [-Confirm] [] +Invoke-AzKustoDataConnectionValidation -InputObject -Kind + -DataConnectionName -ConsumerGroup -Location [-DataFormat ] + [-EventSystemProperty ] [-MappingRuleName ] [-TableName ] + [-DatabaseRouting ] [-RetrievalStartDate ] -IotHubResourceId + -SharedAccessPolicyName [-DefaultProfile ] [-WhatIf] + [-Confirm] [] ``` ### UpdateExpandedEventGrid ``` -Invoke-AzKustoDataConnectionValidation -Kind -DataConnectionName -ConsumerGroup +Invoke-AzKustoDataConnectionValidation -Kind -DataConnectionName -ConsumerGroup -Location [-DataFormat ] [-MappingRuleName ] [-TableName ] - [-BlobStorageEventType ] [-IgnoreFirstRecord] [-DefaultProfile ] + [-BlobStorageEventType ] [-IgnoreFirstRecord] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### UpdateViaIdentityExpandedEventGrid ``` -Invoke-AzKustoDataConnectionValidation -Kind -DataConnectionName -ConsumerGroup +Invoke-AzKustoDataConnectionValidation -Kind -DataConnectionName -ConsumerGroup -Location [-DataFormat ] [-MappingRuleName ] [-TableName ] - [-BlobStorageEventType ] [-IgnoreFirstRecord] [-DefaultProfile ] + [-BlobStorageEventType ] [-IgnoreFirstRecord] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` @@ -178,7 +179,7 @@ The above command validates IotHub data connection named "myiothubdc" for the da The name of blob storage event type to process. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.BlobStorageEventType +Type: System.String Parameter Sets: UpdateExpandedEventGrid, UpdateViaIdentityExpandedEventGrid Aliases: @@ -208,7 +209,7 @@ Accept wildcard characters: False The event hub messages compression type. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.Compression +Type: System.String Parameter Sets: DataExpandedEventHub, DataViaIdentityExpandedEventHub Aliases: @@ -253,7 +254,7 @@ Accept wildcard characters: False Indication for database routing information from the data connection, by default only database routing information is allowed. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.DatabaseRouting +Type: System.String Parameter Sets: DataExpandedEventHub, DataExpandedEventGrid, DataExpandedIotHub, DataViaIdentityExpandedEventHub, DataViaIdentityExpandedEventGrid, DataViaIdentityExpandedIotHub Aliases: @@ -405,7 +406,7 @@ Accept wildcard characters: False Kind of the endpoint for the data connection ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.Kind +Type: System.String Parameter Sets: (All) Aliases: @@ -595,7 +596,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IDataConnectionValidationResult +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IDataConnectionValidationResult ## NOTES diff --git a/src/Kusto/Kusto/help/Invoke-AzKustoDetachClusterFollowerDatabase.md b/src/Kusto/Kusto/help/Invoke-AzKustoDetachClusterFollowerDatabase.md index 83a32ca57106..10210f6bafaf 100644 --- a/src/Kusto/Kusto/help/Invoke-AzKustoDetachClusterFollowerDatabase.md +++ b/src/Kusto/Kusto/help/Invoke-AzKustoDetachClusterFollowerDatabase.md @@ -20,6 +20,20 @@ Invoke-AzKustoDetachClusterFollowerDatabase -ClusterName -ResourceGroup [-Confirm] [] ``` +### DetachViaJsonString +``` +Invoke-AzKustoDetachClusterFollowerDatabase -ClusterName -ResourceGroupName + [-SubscriptionId ] -JsonString [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-WhatIf] [-Confirm] [] +``` + +### DetachViaJsonFilePath +``` +Invoke-AzKustoDetachClusterFollowerDatabase -ClusterName -ResourceGroupName + [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-WhatIf] [-Confirm] [] +``` + ### DetachViaIdentityExpanded ``` Invoke-AzKustoDetachClusterFollowerDatabase -InputObject @@ -61,7 +75,7 @@ Resource name of the attached database configuration in the follower cluster. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: DetachExpanded, DetachViaIdentityExpanded Aliases: Required: True @@ -76,7 +90,7 @@ The name of the Kusto cluster. ```yaml Type: System.String -Parameter Sets: DetachExpanded +Parameter Sets: DetachExpanded, DetachViaJsonString, DetachViaJsonFilePath Aliases: Required: True @@ -91,7 +105,7 @@ Resource id of the cluster that follows a database owned by this cluster. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: DetachExpanded, DetachViaIdentityExpanded Aliases: Required: True @@ -119,7 +133,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -133,6 +146,36 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -JsonFilePath +Path of Json file supplied to the Detach operation + +```yaml +Type: System.String +Parameter Sets: DetachViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Detach operation + +```yaml +Type: System.String +Parameter Sets: DetachViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -NoWait Run the command asynchronously @@ -169,7 +212,7 @@ The name is case insensitive. ```yaml Type: System.String -Parameter Sets: DetachExpanded +Parameter Sets: DetachExpanded, DetachViaJsonString, DetachViaJsonFilePath Aliases: Required: True @@ -184,7 +227,7 @@ The ID of the target subscription. ```yaml Type: System.String -Parameter Sets: DetachExpanded +Parameter Sets: DetachExpanded, DetachViaJsonString, DetachViaJsonFilePath Aliases: Required: False diff --git a/src/Kusto/Kusto/help/Invoke-AzKustoDiagnoseClusterVirtualNetwork.md b/src/Kusto/Kusto/help/Invoke-AzKustoDiagnoseClusterVirtualNetwork.md index dbd7b223fac6..2f0a3fe0a5ef 100644 --- a/src/Kusto/Kusto/help/Invoke-AzKustoDiagnoseClusterVirtualNetwork.md +++ b/src/Kusto/Kusto/help/Invoke-AzKustoDiagnoseClusterVirtualNetwork.md @@ -87,7 +87,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -187,7 +186,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### System.String +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IDiagnoseVirtualNetworkResult ## NOTES diff --git a/src/Kusto/Kusto/help/Invoke-AzKustoInviteDatabaseFollower.md b/src/Kusto/Kusto/help/Invoke-AzKustoInviteDatabaseFollower.md index 922ec911333c..bf112937ef1e 100644 --- a/src/Kusto/Kusto/help/Invoke-AzKustoInviteDatabaseFollower.md +++ b/src/Kusto/Kusto/help/Invoke-AzKustoInviteDatabaseFollower.md @@ -26,6 +26,20 @@ Invoke-AzKustoInviteDatabaseFollower -ClusterName -DatabaseName ] [-WhatIf] [-Confirm] [] ``` +### InviteViaJsonString +``` +Invoke-AzKustoInviteDatabaseFollower -ClusterName -DatabaseName -ResourceGroupName + [-SubscriptionId ] -JsonString [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### InviteViaJsonFilePath +``` +Invoke-AzKustoInviteDatabaseFollower -ClusterName -DatabaseName -ResourceGroupName + [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + ### Invite ``` Invoke-AzKustoInviteDatabaseFollower -ClusterName -DatabaseName -ResourceGroupName @@ -33,6 +47,26 @@ Invoke-AzKustoInviteDatabaseFollower -ClusterName -DatabaseName ] ``` +### InviteViaIdentityClusterExpanded +``` +Invoke-AzKustoInviteDatabaseFollower -DatabaseName -ClusterInputObject + -InviteeEmail [-TableLevelSharingPropertyExternalTablesToExclude ] + [-TableLevelSharingPropertyExternalTablesToInclude ] + [-TableLevelSharingPropertyFunctionsToExclude ] + [-TableLevelSharingPropertyFunctionsToInclude ] + [-TableLevelSharingPropertyMaterializedViewsToExclude ] + [-TableLevelSharingPropertyMaterializedViewsToInclude ] + [-TableLevelSharingPropertyTablesToExclude ] [-TableLevelSharingPropertyTablesToInclude ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### InviteViaIdentityCluster +``` +Invoke-AzKustoInviteDatabaseFollower -DatabaseName -ClusterInputObject + -Parameter [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + ### InviteViaIdentityExpanded ``` Invoke-AzKustoInviteDatabaseFollower -InputObject -InviteeEmail @@ -66,12 +100,27 @@ Invite a user to follow database "myDatabase" in cluster "myCluster" in resource ## PARAMETERS +### -ClusterInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: InviteViaIdentityClusterExpanded, InviteViaIdentityCluster +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ClusterName The name of the Kusto cluster. ```yaml Type: System.String -Parameter Sets: InviteExpanded, Invite +Parameter Sets: InviteExpanded, InviteViaJsonString, InviteViaJsonFilePath, Invite Aliases: Required: True @@ -86,7 +135,7 @@ The name of the database in the Kusto cluster. ```yaml Type: System.String -Parameter Sets: InviteExpanded, Invite +Parameter Sets: InviteExpanded, InviteViaJsonString, InviteViaJsonFilePath, Invite, InviteViaIdentityClusterExpanded, InviteViaIdentityCluster Aliases: Required: True @@ -114,7 +163,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -133,7 +181,37 @@ The email of the invited user for which the follower invitation is generated. ```yaml Type: System.String -Parameter Sets: InviteExpanded, InviteViaIdentityExpanded +Parameter Sets: InviteExpanded, InviteViaIdentityClusterExpanded, InviteViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Invite operation + +```yaml +Type: System.String +Parameter Sets: InviteViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Invite operation + +```yaml +Type: System.String +Parameter Sets: InviteViaJsonString Aliases: Required: True @@ -145,11 +223,10 @@ Accept wildcard characters: False ### -Parameter The request to invite a follower to a database. -To construct, see NOTES section for PARAMETER properties and create a hash table. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IDatabaseInviteFollowerRequest -Parameter Sets: Invite, InviteViaIdentity +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IDatabaseInviteFollowerRequest +Parameter Sets: Invite, InviteViaIdentityCluster, InviteViaIdentity Aliases: Required: True @@ -165,7 +242,7 @@ The name is case insensitive. ```yaml Type: System.String -Parameter Sets: InviteExpanded, Invite +Parameter Sets: InviteExpanded, InviteViaJsonString, InviteViaJsonFilePath, Invite Aliases: Required: True @@ -180,7 +257,7 @@ The ID of the target subscription. ```yaml Type: System.String -Parameter Sets: InviteExpanded, Invite +Parameter Sets: InviteExpanded, InviteViaJsonString, InviteViaJsonFilePath, Invite Aliases: Required: False @@ -195,7 +272,7 @@ List of external tables to exclude from the follower database ```yaml Type: System.String[] -Parameter Sets: InviteExpanded, InviteViaIdentityExpanded +Parameter Sets: InviteExpanded, InviteViaIdentityClusterExpanded, InviteViaIdentityExpanded Aliases: Required: False @@ -210,7 +287,7 @@ List of external tables to include in the follower database ```yaml Type: System.String[] -Parameter Sets: InviteExpanded, InviteViaIdentityExpanded +Parameter Sets: InviteExpanded, InviteViaIdentityClusterExpanded, InviteViaIdentityExpanded Aliases: Required: False @@ -225,7 +302,7 @@ List of functions to exclude from the follower database ```yaml Type: System.String[] -Parameter Sets: InviteExpanded, InviteViaIdentityExpanded +Parameter Sets: InviteExpanded, InviteViaIdentityClusterExpanded, InviteViaIdentityExpanded Aliases: Required: False @@ -240,7 +317,7 @@ List of functions to include in the follower database ```yaml Type: System.String[] -Parameter Sets: InviteExpanded, InviteViaIdentityExpanded +Parameter Sets: InviteExpanded, InviteViaIdentityClusterExpanded, InviteViaIdentityExpanded Aliases: Required: False @@ -255,7 +332,7 @@ List of materialized views to exclude from the follower database ```yaml Type: System.String[] -Parameter Sets: InviteExpanded, InviteViaIdentityExpanded +Parameter Sets: InviteExpanded, InviteViaIdentityClusterExpanded, InviteViaIdentityExpanded Aliases: Required: False @@ -270,7 +347,7 @@ List of materialized views to include in the follower database ```yaml Type: System.String[] -Parameter Sets: InviteExpanded, InviteViaIdentityExpanded +Parameter Sets: InviteExpanded, InviteViaIdentityClusterExpanded, InviteViaIdentityExpanded Aliases: Required: False @@ -285,7 +362,7 @@ List of tables to exclude from the follower database ```yaml Type: System.String[] -Parameter Sets: InviteExpanded, InviteViaIdentityExpanded +Parameter Sets: InviteExpanded, InviteViaIdentityClusterExpanded, InviteViaIdentityExpanded Aliases: Required: False @@ -300,7 +377,7 @@ List of tables to include in the follower database ```yaml Type: System.String[] -Parameter Sets: InviteExpanded, InviteViaIdentityExpanded +Parameter Sets: InviteExpanded, InviteViaIdentityClusterExpanded, InviteViaIdentityExpanded Aliases: Required: False @@ -346,13 +423,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IDatabaseInviteFollowerRequest +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IDatabaseInviteFollowerRequest ### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity ## OUTPUTS -### System.String +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IDatabaseInviteFollowerResult ## NOTES diff --git a/src/Kusto/Kusto/help/New-AzKustoAttachedDatabaseConfiguration.md b/src/Kusto/Kusto/help/New-AzKustoAttachedDatabaseConfiguration.md index 3f5b87bc09cb..5c412ba2bbf1 100644 --- a/src/Kusto/Kusto/help/New-AzKustoAttachedDatabaseConfiguration.md +++ b/src/Kusto/Kusto/help/New-AzKustoAttachedDatabaseConfiguration.md @@ -8,15 +8,45 @@ schema: 2.0.0 # New-AzKustoAttachedDatabaseConfiguration ## SYNOPSIS -Creates or updates an attached database configuration. +Create an attached database configuration. ## SYNTAX +### CreateExpanded (Default) ``` -New-AzKustoAttachedDatabaseConfiguration -ClusterName -Name -ResourceGroupName +New-AzKustoAttachedDatabaseConfiguration -Name -ClusterName -ResourceGroupName [-SubscriptionId ] [-ClusterResourceId ] [-DatabaseName ] - [-DatabaseNameOverride ] [-DatabaseNamePrefix ] - [-DefaultPrincipalsModificationKind ] [-Location ] + [-DatabaseNameOverride ] [-DatabaseNamePrefix ] [-DefaultPrincipalsModificationKind ] + [-Location ] [-TableLevelSharingPropertyExternalTablesToExclude ] + [-TableLevelSharingPropertyExternalTablesToInclude ] + [-TableLevelSharingPropertyFunctionsToExclude ] + [-TableLevelSharingPropertyFunctionsToInclude ] + [-TableLevelSharingPropertyMaterializedViewsToExclude ] + [-TableLevelSharingPropertyMaterializedViewsToInclude ] + [-TableLevelSharingPropertyTablesToExclude ] [-TableLevelSharingPropertyTablesToInclude ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [] +``` + +### CreateViaJsonString +``` +New-AzKustoAttachedDatabaseConfiguration -Name -ClusterName -ResourceGroupName + [-SubscriptionId ] -JsonString [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### CreateViaJsonFilePath +``` +New-AzKustoAttachedDatabaseConfiguration -Name -ClusterName -ResourceGroupName + [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### CreateViaIdentityClusterExpanded +``` +New-AzKustoAttachedDatabaseConfiguration -Name -ClusterInputObject + [-ClusterResourceId ] [-DatabaseName ] [-DatabaseNameOverride ] + [-DatabaseNamePrefix ] [-DefaultPrincipalsModificationKind ] [-Location ] [-TableLevelSharingPropertyExternalTablesToExclude ] [-TableLevelSharingPropertyExternalTablesToInclude ] [-TableLevelSharingPropertyFunctionsToExclude ] @@ -29,7 +59,7 @@ New-AzKustoAttachedDatabaseConfiguration -ClusterName -Name -R ``` ## DESCRIPTION -Creates or updates an attached database configuration. +Create an attached database configuration. ## EXAMPLES @@ -64,12 +94,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ClusterInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: CreateViaIdentityClusterExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ClusterName The name of the Kusto cluster. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath Aliases: Required: True @@ -84,7 +129,7 @@ The resource id of the cluster where the databases you would like to attach resi ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded Aliases: Required: False @@ -99,7 +144,7 @@ The name of the database which you would like to attach, use * if you want to fo ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded Aliases: Required: False @@ -115,7 +160,7 @@ Relevant only when attaching to a specific database. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded Aliases: Required: False @@ -131,7 +176,7 @@ When following an entire cluster, that prefix would be added to all of the datab ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded Aliases: Required: False @@ -145,8 +190,8 @@ Accept wildcard characters: False The default principals modification kind ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.DefaultPrincipalsModificationKind -Parameter Sets: (All) +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded Aliases: Required: False @@ -172,12 +217,42 @@ 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 +``` + ### -Location Resource location. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded Aliases: Required: False @@ -223,7 +298,7 @@ The name is case insensitive. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath Aliases: Required: True @@ -238,7 +313,7 @@ The ID of the target subscription. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath Aliases: Required: False @@ -253,7 +328,7 @@ List of external tables to exclude from the follower database ```yaml Type: System.String[] -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded Aliases: Required: False @@ -268,7 +343,7 @@ List of external tables to include in the follower database ```yaml Type: System.String[] -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded Aliases: Required: False @@ -283,7 +358,7 @@ List of functions to exclude from the follower database ```yaml Type: System.String[] -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded Aliases: Required: False @@ -298,7 +373,7 @@ List of functions to include in the follower database ```yaml Type: System.String[] -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded Aliases: Required: False @@ -313,7 +388,7 @@ List of materialized views to exclude from the follower database ```yaml Type: System.String[] -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded Aliases: Required: False @@ -328,7 +403,7 @@ List of materialized views to include in the follower database ```yaml Type: System.String[] -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded Aliases: Required: False @@ -343,7 +418,7 @@ List of tables to exclude from the follower database ```yaml Type: System.String[] -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded Aliases: Required: False @@ -358,7 +433,7 @@ List of tables to include in the follower database ```yaml Type: System.String[] -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded Aliases: Required: False @@ -404,9 +479,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity + ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IAttachedDatabaseConfiguration +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IAttachedDatabaseConfiguration ## NOTES diff --git a/src/Kusto/Kusto/help/New-AzKustoCluster.md b/src/Kusto/Kusto/help/New-AzKustoCluster.md index f43b4447b8d0..68ffb1d3ad8b 100644 --- a/src/Kusto/Kusto/help/New-AzKustoCluster.md +++ b/src/Kusto/Kusto/help/New-AzKustoCluster.md @@ -8,31 +8,46 @@ schema: 2.0.0 # New-AzKustoCluster ## SYNOPSIS -Create or update a Kusto cluster. +Create a Kusto cluster. ## SYNTAX +### CreateExpanded (Default) ``` New-AzKustoCluster -Name -ResourceGroupName [-SubscriptionId ] [-IfMatch ] - [-IfNoneMatch ] -Location -SkuName -SkuTier + [-IfNoneMatch ] -Location -SkuName -SkuTier [-AcceptedAudience ] [-AllowedFqdnList ] [-AllowedIPRangeList ] [-CalloutPolicy ] [-EnableAutoStop] [-EnableDiskEncryption] [-EnableDoubleEncryption] - [-EnablePurge] [-EnableStreamingIngest] [-EngineType ] [-IdentityType ] - [-IdentityUserAssignedIdentity ] [-KeyVaultPropertyKeyName ] - [-KeyVaultPropertyKeyVaultUri ] [-KeyVaultPropertyKeyVersion ] - [-KeyVaultPropertyUserIdentity ] [-LanguageExtensionValue ] - [-OptimizedAutoscaleIsEnabled] [-OptimizedAutoscaleMaximum ] [-OptimizedAutoscaleMinimum ] - [-OptimizedAutoscaleVersion ] [-PublicIPType ] - [-PublicNetworkAccess ] [-RestrictOutboundNetworkAccess ] + [-EnablePurge] [-EnableStreamingIngest] [-EnableSystemAssignedIdentity] [-EngineType ] + [-KeyVaultPropertyKeyName ] [-KeyVaultPropertyKeyVaultUri ] + [-KeyVaultPropertyKeyVersion ] [-KeyVaultPropertyUserIdentity ] + [-LanguageExtensionValue ] [-OptimizedAutoscaleIsEnabled] + [-OptimizedAutoscaleMaximum ] [-OptimizedAutoscaleMinimum ] [-OptimizedAutoscaleVersion ] + [-PublicIPType ] [-PublicNetworkAccess ] [-RestrictOutboundNetworkAccess ] [-SkuCapacity ] [-Tag ] [-TrustedExternalTenant ] - [-VirtualClusterGraduationProperty ] [-VirtualNetworkConfigurationDataManagementPublicIPId ] - [-VirtualNetworkConfigurationEnginePublicIPId ] [-VirtualNetworkConfigurationState ] + [-UserAssignedIdentity ] [-VirtualClusterGraduationProperty ] + [-VirtualNetworkConfigurationDataManagementPublicIPId ] + [-VirtualNetworkConfigurationEnginePublicIPId ] [-VirtualNetworkConfigurationState ] [-VirtualNetworkConfigurationSubnetId ] [-Zone ] [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] ``` +### CreateViaJsonFilePath +``` +New-AzKustoCluster -Name -ResourceGroupName [-SubscriptionId ] [-IfMatch ] + [-IfNoneMatch ] -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### CreateViaJsonString +``` +New-AzKustoCluster -Name -ResourceGroupName [-SubscriptionId ] [-IfMatch ] + [-IfNoneMatch ] -JsonString [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + ## DESCRIPTION -Create or update a Kusto cluster. +Create a Kusto cluster. ## EXAMPLES @@ -53,11 +68,10 @@ The above command creates a new Kusto cluster named "testnewkustocluster" in the ### -AcceptedAudience The cluster's accepted audiences. -To construct, see NOTES section for ACCEPTEDAUDIENCE properties and create a hash table. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IAcceptedAudiences[] -Parameter Sets: (All) +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IAcceptedAudiences[] +Parameter Sets: CreateExpanded Aliases: Required: False @@ -72,7 +86,7 @@ List of allowed FQDNs(Fully Qualified Domain Name) for egress from Cluster. ```yaml Type: System.String[] -Parameter Sets: (All) +Parameter Sets: CreateExpanded Aliases: Required: False @@ -87,7 +101,7 @@ The list of ips in the format of CIDR allowed to connect to the cluster. ```yaml Type: System.String[] -Parameter Sets: (All) +Parameter Sets: CreateExpanded Aliases: Required: False @@ -114,11 +128,10 @@ Accept wildcard characters: False ### -CalloutPolicy List of callout policies for egress from Cluster. -To construct, see NOTES section for CALLOUTPOLICY properties and create a hash table. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ICalloutPolicy[] -Parameter Sets: (All) +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ICalloutPolicy[] +Parameter Sets: CreateExpanded Aliases: Required: False @@ -149,7 +162,7 @@ A boolean value that indicates if the cluster could be automatically stopped (du ```yaml Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) +Parameter Sets: CreateExpanded Aliases: Required: False @@ -164,7 +177,7 @@ A boolean value that indicates if the cluster's disks are encrypted. ```yaml Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) +Parameter Sets: CreateExpanded Aliases: Required: False @@ -179,7 +192,7 @@ A boolean value that indicates if double encryption is enabled. ```yaml Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) +Parameter Sets: CreateExpanded Aliases: Required: False @@ -194,7 +207,7 @@ A boolean value that indicates if the purge operations are enabled. ```yaml Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) +Parameter Sets: CreateExpanded Aliases: Required: False @@ -209,7 +222,22 @@ A boolean value that indicates if the streaming ingest is enabled. ```yaml Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableSystemAssignedIdentity +Determines whether to enable a system-assigned identity for the resource. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CreateExpanded Aliases: Required: False @@ -223,8 +251,8 @@ Accept wildcard characters: False The engine type ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.EngineType -Parameter Sets: (All) +Type: System.String +Parameter Sets: CreateExpanded Aliases: Required: False @@ -234,13 +262,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IdentityType -The type of managed identity used. -The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. -The type 'None' will remove all identities. +### -IfMatch +The ETag of the cluster. +Omit this value to always overwrite the current cluster. +Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.IdentityType +Type: System.String Parameter Sets: (All) Aliases: @@ -251,12 +279,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IdentityUserAssignedIdentity -The list of user identities associated with the Kusto cluster. -The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. +### -IfNoneMatch +Set to '*' to allow a new cluster to be created, but to prevent updating an existing cluster. +Other values will result in a 412 Pre-condition Failed response. ```yaml -Type: System.Collections.Hashtable +Type: System.String Parameter Sets: (All) Aliases: @@ -267,33 +295,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IfMatch -The ETag of the cluster. -Omit this value to always overwrite the current cluster. -Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes. +### -JsonFilePath +Path of Json file supplied to the Create operation ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateViaJsonFilePath Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -IfNoneMatch -Set to '*' to allow a new cluster to be created, but to prevent updating an existing cluster. -Other values will result in a 412 Pre-condition Failed response. +### -JsonString +Json string supplied to the Create operation ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateViaJsonString Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -305,7 +330,7 @@ The name of the key vault key. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded Aliases: Required: False @@ -320,7 +345,7 @@ The Uri of the key vault. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded Aliases: Required: False @@ -335,7 +360,7 @@ The version of the key vault key. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded Aliases: Required: False @@ -350,7 +375,7 @@ The user assigned identity (ARM resource id) that has access to the key. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded Aliases: Required: False @@ -362,11 +387,10 @@ Accept wildcard characters: False ### -LanguageExtensionValue The list of language extensions. -To construct, see NOTES section for LANGUAGEEXTENSIONVALUE properties and create a hash table. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ILanguageExtension[] -Parameter Sets: (All) +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ILanguageExtension[] +Parameter Sets: CreateExpanded Aliases: Required: False @@ -381,7 +405,7 @@ The geo-location where the resource lives ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded Aliases: Required: True @@ -426,7 +450,7 @@ A boolean value that indicate if the optimized autoscale feature is enabled or n ```yaml Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) +Parameter Sets: CreateExpanded Aliases: Required: False @@ -441,7 +465,7 @@ Maximum allowed instances count. ```yaml Type: System.Int32 -Parameter Sets: (All) +Parameter Sets: CreateExpanded Aliases: Required: False @@ -456,7 +480,7 @@ Minimum allowed instances count. ```yaml Type: System.Int32 -Parameter Sets: (All) +Parameter Sets: CreateExpanded Aliases: Required: False @@ -471,7 +495,7 @@ The version of the template defined, for instance 1. ```yaml Type: System.Int32 -Parameter Sets: (All) +Parameter Sets: CreateExpanded Aliases: Required: False @@ -485,8 +509,8 @@ Accept wildcard characters: False Indicates what public IP type to create - IPv4 (default), or DualStack (both IPv4 and IPv6) ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.PublicIPType -Parameter Sets: (All) +Type: System.String +Parameter Sets: CreateExpanded Aliases: Required: False @@ -501,8 +525,8 @@ Public network access to the cluster is enabled by default. When disabled, only private endpoint connection to the cluster is allowed ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.PublicNetworkAccess -Parameter Sets: (All) +Type: System.String +Parameter Sets: CreateExpanded Aliases: Required: False @@ -533,8 +557,8 @@ Whether or not to restrict outbound network access. Value is optional but if passed in, must be 'Enabled' or 'Disabled' ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.ClusterNetworkAccessFlag -Parameter Sets: (All) +Type: System.String +Parameter Sets: CreateExpanded Aliases: Required: False @@ -549,7 +573,7 @@ The number of instances of the cluster. ```yaml Type: System.Int32 -Parameter Sets: (All) +Parameter Sets: CreateExpanded Aliases: Required: False @@ -563,8 +587,8 @@ Accept wildcard characters: False SKU name. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.AzureSkuName -Parameter Sets: (All) +Type: System.String +Parameter Sets: CreateExpanded Aliases: Required: True @@ -578,8 +602,8 @@ Accept wildcard characters: False SKU tier. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.AzureSkuTier -Parameter Sets: (All) +Type: System.String +Parameter Sets: CreateExpanded Aliases: Required: True @@ -609,7 +633,7 @@ Resource tags. ```yaml Type: System.Collections.Hashtable -Parameter Sets: (All) +Parameter Sets: CreateExpanded Aliases: Required: False @@ -621,11 +645,26 @@ Accept wildcard characters: False ### -TrustedExternalTenant The cluster's external tenants. -To construct, see NOTES section for TRUSTEDEXTERNALTENANT properties and create a hash table. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ITrustedExternalTenant[] -Parameter Sets: (All) +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ITrustedExternalTenant[] +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +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: CreateExpanded Aliases: Required: False @@ -640,7 +679,7 @@ Virtual Cluster graduation properties ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded Aliases: Required: False @@ -655,7 +694,7 @@ Data management's service public IP address resource id. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded Aliases: Required: False @@ -670,7 +709,7 @@ Engine service's public IP address resource id. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded Aliases: Required: False @@ -684,8 +723,8 @@ Accept wildcard characters: False When enabled, the cluster is deployed into the configured subnet, when disabled it will be removed from the subnet. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.VnetState -Parameter Sets: (All) +Type: System.String +Parameter Sets: CreateExpanded Aliases: Required: False @@ -700,7 +739,7 @@ The subnet resource id. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded Aliases: Required: False @@ -715,7 +754,7 @@ The availability zones of the cluster. ```yaml Type: System.String[] -Parameter Sets: (All) +Parameter Sets: CreateExpanded Aliases: Required: False @@ -763,7 +802,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ICluster +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ICluster ## NOTES diff --git a/src/Kusto/Kusto/help/New-AzKustoClusterPrincipalAssignment.md b/src/Kusto/Kusto/help/New-AzKustoClusterPrincipalAssignment.md index 65b12ace4e4f..7a6d393d6281 100644 --- a/src/Kusto/Kusto/help/New-AzKustoClusterPrincipalAssignment.md +++ b/src/Kusto/Kusto/help/New-AzKustoClusterPrincipalAssignment.md @@ -12,10 +12,32 @@ Create a Kusto cluster principalAssignment. ## SYNTAX +### CreateExpanded (Default) ``` -New-AzKustoClusterPrincipalAssignment -ClusterName -PrincipalAssignmentName - -ResourceGroupName [-SubscriptionId ] [-PrincipalId ] - [-PrincipalType ] [-Role ] [-TenantId ] +New-AzKustoClusterPrincipalAssignment -PrincipalAssignmentName -ClusterName + -ResourceGroupName [-SubscriptionId ] [-PrincipalId ] [-PrincipalType ] + [-Role ] [-TenantId ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### CreateViaJsonString +``` +New-AzKustoClusterPrincipalAssignment -PrincipalAssignmentName -ClusterName + -ResourceGroupName [-SubscriptionId ] -JsonString [-DefaultProfile ] + [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] +``` + +### CreateViaJsonFilePath +``` +New-AzKustoClusterPrincipalAssignment -PrincipalAssignmentName -ClusterName + -ResourceGroupName [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] + [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] +``` + +### CreateViaIdentityClusterExpanded +``` +New-AzKustoClusterPrincipalAssignment -PrincipalAssignmentName -ClusterInputObject + [-PrincipalId ] [-PrincipalType ] [-Role ] [-TenantId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] ``` @@ -55,12 +77,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ClusterInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: CreateViaIdentityClusterExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ClusterName The name of the Kusto cluster. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath Aliases: Required: True @@ -86,6 +123,36 @@ 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 +``` + ### -NoWait Run the command asynchronously @@ -122,7 +189,7 @@ It can be a user email, application ID, or security group name. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded Aliases: Required: False @@ -136,8 +203,8 @@ Accept wildcard characters: False Principal type. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.PrincipalType -Parameter Sets: (All) +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded Aliases: Required: False @@ -153,7 +220,7 @@ The name is case insensitive. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath Aliases: Required: True @@ -167,8 +234,8 @@ Accept wildcard characters: False Cluster principal role. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.ClusterPrincipalRole -Parameter Sets: (All) +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded Aliases: Required: False @@ -183,7 +250,7 @@ The ID of the target subscription. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath Aliases: Required: False @@ -198,7 +265,7 @@ The tenant id of the principal ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded Aliases: Required: False @@ -244,9 +311,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity + ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IClusterPrincipalAssignment +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IClusterPrincipalAssignment ## NOTES diff --git a/src/Kusto/Kusto/help/New-AzKustoDataConnection.md b/src/Kusto/Kusto/help/New-AzKustoDataConnection.md index a0b4b9f280a5..1a160f8dc7b9 100644 --- a/src/Kusto/Kusto/help/New-AzKustoDataConnection.md +++ b/src/Kusto/Kusto/help/New-AzKustoDataConnection.md @@ -8,37 +8,52 @@ schema: 2.0.0 # New-AzKustoDataConnection ## SYNOPSIS -Creates or updates a data connection. +Create a data connection. ## SYNTAX ### CreateExpandedEventHub (Default) ``` New-AzKustoDataConnection -ClusterName -DatabaseName -Name - -ResourceGroupName [-SubscriptionId ] -Kind -Location [-TableName ] - -EventHubResourceId -ConsumerGroup [-DataFormat ] [-EventSystemProperty ] - [-MappingRuleName ] [-Compression ] [-ManagedIdentityResourceId ] - [-DatabaseRouting ] [-RetrievalStartDate ] [-DefaultProfile ] [-AsJob] - [-NoWait] [-WhatIf] [-Confirm] [] + -ResourceGroupName [-SubscriptionId ] -Kind -EventHubResourceId + -ConsumerGroup -Location [-DataFormat ] [-EventSystemProperty ] + [-MappingRuleName ] [-TableName ] [-Compression ] + [-ManagedIdentityResourceId ] [-DatabaseRouting ] [-RetrievalStartDate ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [] +``` + +### CreateViaJsonFilePath +``` +New-AzKustoDataConnection -ClusterName -DatabaseName -Name + -ResourceGroupName [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] + [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] +``` + +### CreateViaJsonString +``` +New-AzKustoDataConnection -ClusterName -DatabaseName -Name + -ResourceGroupName [-SubscriptionId ] -JsonString [-DefaultProfile ] + [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] ``` ### CreateExpandedEventGrid ``` New-AzKustoDataConnection -ClusterName -DatabaseName -Name - -ResourceGroupName [-SubscriptionId ] -Kind -Location [-TableName ] - -EventHubResourceId -ConsumerGroup [-DataFormat ] [-MappingRuleName ] - [-ManagedIdentityResourceId ] [-DatabaseRouting ] -StorageAccountResourceId - [-BlobStorageEventType ] [-IgnoreFirstRecord] [-EventGridResourceId ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] - [] + -ResourceGroupName [-SubscriptionId ] -Kind -EventHubResourceId + -ConsumerGroup -Location [-DataFormat ] [-MappingRuleName ] + [-TableName ] [-ManagedIdentityResourceId ] [-DatabaseRouting ] + -StorageAccountResourceId [-BlobStorageEventType ] [-IgnoreFirstRecord] + [-EventGridResourceId ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] ``` ### CreateExpandedIotHub ``` New-AzKustoDataConnection -ClusterName -DatabaseName -Name - -ResourceGroupName [-SubscriptionId ] -Kind -Location [-TableName ] - -ConsumerGroup [-DataFormat ] [-EventSystemProperty ] [-MappingRuleName ] - [-DatabaseRouting ] [-RetrievalStartDate ] -IotHubResourceId + -ResourceGroupName [-SubscriptionId ] -Kind -ConsumerGroup + -Location [-DataFormat ] [-EventSystemProperty ] [-MappingRuleName ] + [-TableName ] [-DatabaseRouting ] [-RetrievalStartDate ] -IotHubResourceId -SharedAccessPolicyName [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] ``` @@ -46,15 +61,15 @@ New-AzKustoDataConnection -ClusterName -DatabaseName -Name -DatabaseName -Name - -ResourceGroupName [-SubscriptionId ] -Kind -Location [-TableName ] - [-MappingRuleName ] -ManagedIdentityResourceId [-RetrievalStartDate ] - -CosmosDbAccountResourceId -CosmosDbDatabase -CosmosDbContainer - [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] - [] + -ResourceGroupName [-SubscriptionId ] -Kind -Location + [-MappingRuleName ] -TableName -ManagedIdentityResourceId + [-RetrievalStartDate ] -CosmosDbAccountResourceId -CosmosDbDatabase + -CosmosDbContainer [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -Creates or updates a data connection. +Create a data connection. ## EXAMPLES @@ -118,7 +133,7 @@ Accept wildcard characters: False The name of blob storage event type to process. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.BlobStorageEventType +Type: System.String Parameter Sets: CreateExpandedEventGrid Aliases: @@ -148,7 +163,7 @@ Accept wildcard characters: False The event hub messages compression type. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.Compression +Type: System.String Parameter Sets: CreateExpandedEventHub Aliases: @@ -238,7 +253,7 @@ Accept wildcard characters: False Indication for database routing information from the data connection, by default only database routing information is allowed. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.DatabaseRouting +Type: System.String Parameter Sets: CreateExpandedEventHub, CreateExpandedEventGrid, CreateExpandedIotHub Aliases: @@ -266,7 +281,8 @@ Accept wildcard characters: False ``` ### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. +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 @@ -355,12 +371,42 @@ 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 +``` + ### -Kind Kind of the endpoint for the data connection ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.Kind -Parameter Sets: (All) +Type: System.String +Parameter Sets: CreateExpandedEventHub, CreateExpandedEventGrid, CreateExpandedIotHub, CreateExpandedCosmosDb Aliases: Required: True @@ -375,7 +421,7 @@ Resource location. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpandedEventHub, CreateExpandedEventGrid, CreateExpandedIotHub, CreateExpandedCosmosDb Aliases: Required: True @@ -418,7 +464,7 @@ Optionally the mapping information can be added to each message. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpandedEventHub, CreateExpandedEventGrid, CreateExpandedIotHub, CreateExpandedCosmosDb Aliases: Required: False @@ -459,7 +505,8 @@ Accept wildcard characters: False ``` ### -ResourceGroupName -The name of the resource group containing the Kusto cluster. +The name of the resource group. +The name is case insensitive. ```yaml Type: System.String @@ -520,8 +567,7 @@ Accept wildcard characters: False ``` ### -SubscriptionId -Gets subscription credentials which uniquely identify Microsoft Azure subscription. -The subscription ID forms part of the URI for every service call. +The ID of the target subscription. ```yaml Type: System.String @@ -541,7 +587,7 @@ Optionally the table information can be added to each message. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpandedEventHub, CreateExpandedEventGrid, CreateExpandedIotHub Aliases: Required: False @@ -551,6 +597,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` +```yaml +Type: System.String +Parameter Sets: CreateExpandedCosmosDb +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Confirm Prompts you for confirmation before running the cmdlet. @@ -589,7 +647,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IDataConnection +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IDataConnection ## NOTES diff --git a/src/Kusto/Kusto/help/New-AzKustoDatabase.md b/src/Kusto/Kusto/help/New-AzKustoDatabase.md index 4b0b3c8dd06b..29f8914f5e09 100644 --- a/src/Kusto/Kusto/help/New-AzKustoDatabase.md +++ b/src/Kusto/Kusto/help/New-AzKustoDatabase.md @@ -8,21 +8,36 @@ schema: 2.0.0 # New-AzKustoDatabase ## SYNOPSIS -Creates or updates a database. +Create a database. ## SYNTAX +### CreateReadWrite (Default) ``` New-AzKustoDatabase -ClusterName -Name -ResourceGroupName [-SubscriptionId ] - [-CallerRole ] -Kind [-HotCachePeriod ] [-SoftDeletePeriod ] + [-CallerRole ] -Kind [-HotCachePeriod ] [-SoftDeletePeriod ] [-KeyVaultPropertyKeyName ] [-KeyVaultPropertyKeyVaultUri ] [-KeyVaultPropertyKeyVersion ] [-KeyVaultPropertyUserIdentity ] [-Location ] [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] ``` +### CreateViaJsonFilePath +``` +New-AzKustoDatabase -ClusterName -Name -ResourceGroupName [-SubscriptionId ] + [-CallerRole ] -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### CreateViaJsonString +``` +New-AzKustoDatabase -ClusterName -Name -ResourceGroupName [-SubscriptionId ] + [-CallerRole ] -JsonString [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + ## DESCRIPTION -Creates or updates a database. +Create a database. ## EXAMPLES @@ -61,7 +76,7 @@ By default, any user who run operation on a database become an Admin on it. This property allows the caller to exclude the caller from Admins list. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.CallerRole +Type: System.String Parameter Sets: (All) Aliases: @@ -88,7 +103,8 @@ Accept wildcard characters: False ``` ### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. +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 @@ -107,7 +123,7 @@ The time the data should be kept in cache for fast queries in TimeSpan. ```yaml Type: System.TimeSpan -Parameter Sets: (All) +Parameter Sets: CreateReadWrite Aliases: Required: False @@ -117,12 +133,42 @@ 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 +``` + ### -KeyVaultPropertyKeyName The name of the key vault key. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateReadWrite Aliases: Required: False @@ -137,7 +183,7 @@ The Uri of the key vault. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateReadWrite Aliases: Required: False @@ -152,7 +198,7 @@ The version of the key vault key. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateReadWrite Aliases: Required: False @@ -167,7 +213,7 @@ The user assigned identity (ARM resource id) that has access to the key. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateReadWrite Aliases: Required: False @@ -181,8 +227,8 @@ Accept wildcard characters: False Kind of the database ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.Kind -Parameter Sets: (All) +Type: System.String +Parameter Sets: CreateReadWrite Aliases: Required: True @@ -197,7 +243,7 @@ Resource location. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateReadWrite Aliases: Required: False @@ -238,7 +284,8 @@ Accept wildcard characters: False ``` ### -ResourceGroupName -The name of the resource group containing the Kusto cluster. +The name of the resource group. +The name is case insensitive. ```yaml Type: System.String @@ -257,7 +304,7 @@ The time the data should be kept before it stops being accessible to queries in ```yaml Type: System.TimeSpan -Parameter Sets: (All) +Parameter Sets: CreateReadWrite Aliases: Required: False @@ -268,8 +315,7 @@ Accept wildcard characters: False ``` ### -SubscriptionId -Gets subscription credentials which uniquely identify Microsoft Azure subscription. -The subscription ID forms part of the URI for every service call. +The ID of the target subscription. ```yaml Type: System.String @@ -321,7 +367,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IDatabase +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IDatabase ## NOTES diff --git a/src/Kusto/Kusto/help/New-AzKustoDatabasePrincipalAssignment.md b/src/Kusto/Kusto/help/New-AzKustoDatabasePrincipalAssignment.md index d817d8ce1dd2..0dd45f7b04b9 100644 --- a/src/Kusto/Kusto/help/New-AzKustoDatabasePrincipalAssignment.md +++ b/src/Kusto/Kusto/help/New-AzKustoDatabasePrincipalAssignment.md @@ -8,20 +8,52 @@ schema: 2.0.0 # New-AzKustoDatabasePrincipalAssignment ## SYNOPSIS -Creates a Kusto cluster database principalAssignment. +Create a Kusto cluster database principalAssignment. ## SYNTAX +### CreateExpanded (Default) ``` -New-AzKustoDatabasePrincipalAssignment -ClusterName -DatabaseName - -PrincipalAssignmentName -ResourceGroupName [-SubscriptionId ] - [-PrincipalId ] [-PrincipalType ] [-Role ] [-TenantId ] +New-AzKustoDatabasePrincipalAssignment -PrincipalAssignmentName -ClusterName + -DatabaseName -ResourceGroupName [-SubscriptionId ] [-PrincipalId ] + [-PrincipalType ] [-Role ] [-TenantId ] [-DefaultProfile ] [-AsJob] + [-NoWait] [-WhatIf] [-Confirm] [] +``` + +### CreateViaJsonString +``` +New-AzKustoDatabasePrincipalAssignment -PrincipalAssignmentName -ClusterName + -DatabaseName -ResourceGroupName [-SubscriptionId ] -JsonString + [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [] +``` + +### CreateViaJsonFilePath +``` +New-AzKustoDatabasePrincipalAssignment -PrincipalAssignmentName -ClusterName + -DatabaseName -ResourceGroupName [-SubscriptionId ] -JsonFilePath + [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [] +``` + +### CreateViaIdentityClusterExpanded +``` +New-AzKustoDatabasePrincipalAssignment -PrincipalAssignmentName -DatabaseName + -ClusterInputObject [-PrincipalId ] [-PrincipalType ] [-Role ] + [-TenantId ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### CreateViaIdentityDatabaseExpanded +``` +New-AzKustoDatabasePrincipalAssignment -PrincipalAssignmentName -DatabaseInputObject + [-PrincipalId ] [-PrincipalType ] [-Role ] [-TenantId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -Creates a Kusto cluster database principalAssignment. +Create a Kusto cluster database principalAssignment. ## EXAMPLES @@ -55,12 +87,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ClusterInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: CreateViaIdentityClusterExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ClusterName The name of the Kusto cluster. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath Aliases: Required: True @@ -70,12 +117,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DatabaseInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: CreateViaIdentityDatabaseExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -DatabaseName The name of the database in the Kusto cluster. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath, CreateViaIdentityClusterExpanded Aliases: Required: True @@ -101,6 +163,36 @@ 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 +``` + ### -NoWait Run the command asynchronously @@ -137,7 +229,7 @@ It can be a user email, application ID, or security group name. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded, CreateViaIdentityDatabaseExpanded Aliases: Required: False @@ -151,8 +243,8 @@ Accept wildcard characters: False Principal type. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.PrincipalType -Parameter Sets: (All) +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded, CreateViaIdentityDatabaseExpanded Aliases: Required: False @@ -168,7 +260,7 @@ The name is case insensitive. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath Aliases: Required: True @@ -182,8 +274,8 @@ Accept wildcard characters: False Database principal role. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.DatabasePrincipalRole -Parameter Sets: (All) +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded, CreateViaIdentityDatabaseExpanded Aliases: Required: False @@ -198,7 +290,7 @@ The ID of the target subscription. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath Aliases: Required: False @@ -213,7 +305,7 @@ The tenant id of the principal ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded, CreateViaIdentityDatabaseExpanded Aliases: Required: False @@ -259,9 +351,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity + ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IDatabasePrincipalAssignment +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IDatabasePrincipalAssignment ## NOTES diff --git a/src/Kusto/Kusto/help/New-AzKustoManagedPrivateEndpoint.md b/src/Kusto/Kusto/help/New-AzKustoManagedPrivateEndpoint.md index 4d16e4ae278e..66596d4917e1 100644 --- a/src/Kusto/Kusto/help/New-AzKustoManagedPrivateEndpoint.md +++ b/src/Kusto/Kusto/help/New-AzKustoManagedPrivateEndpoint.md @@ -8,27 +8,56 @@ schema: 2.0.0 # New-AzKustoManagedPrivateEndpoint ## SYNOPSIS -Creates a managed private endpoint. +Create a managed private endpoint. ## SYNTAX ### CreateExpanded (Default) ``` -New-AzKustoManagedPrivateEndpoint -ClusterName -Name -ResourceGroupName +New-AzKustoManagedPrivateEndpoint -Name -ClusterName -ResourceGroupName [-SubscriptionId ] [-GroupId ] [-PrivateLinkResourceId ] [-PrivateLinkResourceRegion ] [-RequestMessage ] [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] ``` +### CreateViaJsonString +``` +New-AzKustoManagedPrivateEndpoint -Name -ClusterName -ResourceGroupName + [-SubscriptionId ] -JsonString [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### CreateViaJsonFilePath +``` +New-AzKustoManagedPrivateEndpoint -Name -ClusterName -ResourceGroupName + [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + ### Create ``` -New-AzKustoManagedPrivateEndpoint -ClusterName -Name -ResourceGroupName +New-AzKustoManagedPrivateEndpoint -Name -ClusterName -ResourceGroupName [-SubscriptionId ] -Parameter [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] ``` +### CreateViaIdentityClusterExpanded +``` +New-AzKustoManagedPrivateEndpoint -Name -ClusterInputObject [-GroupId ] + [-PrivateLinkResourceId ] [-PrivateLinkResourceRegion ] [-RequestMessage ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [] +``` + +### CreateViaIdentityCluster +``` +New-AzKustoManagedPrivateEndpoint -Name -ClusterInputObject + -Parameter [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + ## DESCRIPTION -Creates a managed private endpoint. +Create a managed private endpoint. ## EXAMPLES @@ -62,12 +91,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ClusterInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: CreateViaIdentityClusterExpanded, CreateViaIdentityCluster +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ClusterName The name of the Kusto cluster. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath, Create Aliases: Required: True @@ -98,7 +142,7 @@ The groupId in which the managed private endpoint is created. ```yaml Type: System.String -Parameter Sets: CreateExpanded +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded Aliases: Required: False @@ -108,6 +152,36 @@ 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 +``` + ### -Name The name of the managed private endpoint. @@ -140,11 +214,10 @@ Accept wildcard characters: False ### -Parameter Class representing a managed private endpoint. -To construct, see NOTES section for PARAMETER properties and create a hash table. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IManagedPrivateEndpoint -Parameter Sets: Create +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IManagedPrivateEndpoint +Parameter Sets: Create, CreateViaIdentityCluster Aliases: Required: True @@ -159,7 +232,7 @@ The ARM resource ID of the resource for which the managed private endpoint is cr ```yaml Type: System.String -Parameter Sets: CreateExpanded +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded Aliases: Required: False @@ -174,7 +247,7 @@ The region of the resource to which the managed private endpoint is created. ```yaml Type: System.String -Parameter Sets: CreateExpanded +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded Aliases: Required: False @@ -189,7 +262,7 @@ The user request message. ```yaml Type: System.String -Parameter Sets: CreateExpanded +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded Aliases: Required: False @@ -205,7 +278,7 @@ The name is case insensitive. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath, Create Aliases: Required: True @@ -220,7 +293,7 @@ The ID of the target subscription. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath, Create Aliases: Required: False @@ -266,11 +339,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IManagedPrivateEndpoint +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IManagedPrivateEndpoint ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IManagedPrivateEndpoint +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IManagedPrivateEndpoint ## NOTES diff --git a/src/Kusto/Kusto/help/New-AzKustoPrivateEndpointConnection.md b/src/Kusto/Kusto/help/New-AzKustoPrivateEndpointConnection.md deleted file mode 100644 index 6b427d286e5f..000000000000 --- a/src/Kusto/Kusto/help/New-AzKustoPrivateEndpointConnection.md +++ /dev/null @@ -1,247 +0,0 @@ ---- -external help file: Az.Kusto-help.xml -Module Name: Az.Kusto -online version: https://learn.microsoft.com/powershell/module/az.kusto/new-azkustoprivateendpointconnection -schema: 2.0.0 ---- - -# New-AzKustoPrivateEndpointConnection - -## SYNOPSIS -Approve or reject a private endpoint connection with a given name. - -## SYNTAX - -### CreateExpanded (Default) -``` -New-AzKustoPrivateEndpointConnection -ClusterName -Name -ResourceGroupName - [-SubscriptionId ] [-PrivateLinkServiceConnectionStateDescription ] - [-PrivateLinkServiceConnectionStateStatus ] [-DefaultProfile ] [-AsJob] [-NoWait] - [-WhatIf] [-Confirm] [] -``` - -### Create -``` -New-AzKustoPrivateEndpointConnection -ClusterName -Name -ResourceGroupName - [-SubscriptionId ] -Parameter [-DefaultProfile ] [-AsJob] - [-NoWait] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Approve or reject a private endpoint connection with a given name. - -## EXAMPLES - -### Example 1: Create a new PrivateEndpointConnection in a cluster -```powershell -New-AzKustoPrivateEndpointConnection -ClusterName "mycluster" -ResourceGroupName "testrg" -SubscriptionId "12345678-1234-1234-1234-123456789098" -Parameter $privateEndpointConnection -Name "testprivateconnection-12345678-1234-1234-1234-123456789098" -``` - -```output -Name Type ----- ---- -testprivateconnection-12345678-1234-1234-1234-123456789098 Microsoft.Kusto/Clusters/PrivateEndpointConnections -``` - -The above command creates a new PrivateEndpointConnection in the cluster "mycluster" found in the resource group "testrg". - -## 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 -``` - -### -ClusterName -The name of the Kusto cluster. - -```yaml -Type: System.String -Parameter Sets: (All) -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 -``` - -### -Name -The name of the private endpoint connection. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: PrivateEndpointConnectionName - -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 -``` - -### -Parameter -A private endpoint connection -To construct, see NOTES section for PARAMETER properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IPrivateEndpointConnection -Parameter Sets: Create -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PrivateLinkServiceConnectionStateDescription -The private link service connection description. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrivateLinkServiceConnectionStateStatus -The private link service connection status. - -```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. - -```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 - -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IPrivateEndpointConnection - -## OUTPUTS - -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IPrivateEndpointConnection - -## NOTES - -## RELATED LINKS diff --git a/src/Kusto/Kusto/help/New-AzKustoSandboxCustomImage.md b/src/Kusto/Kusto/help/New-AzKustoSandboxCustomImage.md index 9a241ee342ec..cdae84dbdc14 100644 --- a/src/Kusto/Kusto/help/New-AzKustoSandboxCustomImage.md +++ b/src/Kusto/Kusto/help/New-AzKustoSandboxCustomImage.md @@ -8,27 +8,55 @@ schema: 2.0.0 # New-AzKustoSandboxCustomImage ## SYNOPSIS -Creates or updates a sandbox custom image. +Create a sandbox custom image. ## SYNTAX ### CreateExpanded (Default) ``` -New-AzKustoSandboxCustomImage -ClusterName -Name -ResourceGroupName +New-AzKustoSandboxCustomImage -Name -ClusterName -ResourceGroupName [-SubscriptionId ] [-BaseImageName ] [-LanguageVersion ] [-RequirementsFileContent ] [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] ``` +### CreateViaJsonString +``` +New-AzKustoSandboxCustomImage -Name -ClusterName -ResourceGroupName + [-SubscriptionId ] -JsonString [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### CreateViaJsonFilePath +``` +New-AzKustoSandboxCustomImage -Name -ClusterName -ResourceGroupName + [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + ### Create ``` -New-AzKustoSandboxCustomImage -ClusterName -Name -ResourceGroupName +New-AzKustoSandboxCustomImage -Name -ClusterName -ResourceGroupName [-SubscriptionId ] -Parameter [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] ``` +### CreateViaIdentityClusterExpanded +``` +New-AzKustoSandboxCustomImage -Name -ClusterInputObject [-BaseImageName ] + [-LanguageVersion ] [-RequirementsFileContent ] [-DefaultProfile ] [-AsJob] + [-NoWait] [-WhatIf] [-Confirm] [] +``` + +### CreateViaIdentityCluster +``` +New-AzKustoSandboxCustomImage -Name -ClusterInputObject + -Parameter [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + ## DESCRIPTION -Creates or updates a sandbox custom image. +Create a sandbox custom image. ## EXAMPLES @@ -69,7 +97,7 @@ Either this property or languageVersion should be specified. ```yaml Type: System.String -Parameter Sets: CreateExpanded +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded Aliases: Required: False @@ -79,12 +107,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ClusterInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: CreateViaIdentityClusterExpanded, CreateViaIdentityCluster +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ClusterName The name of the Kusto cluster. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath, Create Aliases: Required: True @@ -110,13 +153,43 @@ 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 +``` + ### -LanguageVersion The version of the language. Either this property or baseImageName should be specified. ```yaml Type: System.String -Parameter Sets: CreateExpanded +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded Aliases: Required: False @@ -158,11 +231,10 @@ Accept wildcard characters: False ### -Parameter Class representing a Kusto sandbox custom image. -To construct, see NOTES section for PARAMETER properties and create a hash table. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ISandboxCustomImage -Parameter Sets: Create +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ISandboxCustomImage +Parameter Sets: Create, CreateViaIdentityCluster Aliases: Required: True @@ -177,7 +249,7 @@ The requirements file content. ```yaml Type: System.String -Parameter Sets: CreateExpanded +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded Aliases: Required: False @@ -193,7 +265,7 @@ The name is case insensitive. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath, Create Aliases: Required: True @@ -208,7 +280,7 @@ The ID of the target subscription. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath, Create Aliases: Required: False @@ -254,11 +326,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ISandboxCustomImage +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ISandboxCustomImage ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ISandboxCustomImage +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ISandboxCustomImage ## NOTES diff --git a/src/Kusto/Kusto/help/New-AzKustoScript.md b/src/Kusto/Kusto/help/New-AzKustoScript.md index 6023d22ddbf0..0c34bc2248df 100644 --- a/src/Kusto/Kusto/help/New-AzKustoScript.md +++ b/src/Kusto/Kusto/help/New-AzKustoScript.md @@ -8,28 +8,72 @@ schema: 2.0.0 # New-AzKustoScript ## SYNOPSIS -Creates a Kusto database script. +Create a Kusto database script. ## SYNTAX ### CreateExpanded (Default) ``` -New-AzKustoScript -ClusterName -DatabaseName -Name -ResourceGroupName +New-AzKustoScript -Name -ClusterName -DatabaseName -ResourceGroupName [-SubscriptionId ] [-ContinueOnError] [-ForceUpdateTag ] - [-PrincipalPermissionsAction ] [-ScriptContent ] - [-ScriptLevel ] [-ScriptUrl ] [-ScriptUrlSasToken ] [-DefaultProfile ] - [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] + [-PrincipalPermissionsAction ] [-ScriptContent ] [-ScriptLevel ] [-ScriptUrl ] + [-ScriptUrlSasToken ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### CreateViaJsonString +``` +New-AzKustoScript -Name -ClusterName -DatabaseName -ResourceGroupName + [-SubscriptionId ] -JsonString [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### CreateViaJsonFilePath +``` +New-AzKustoScript -Name -ClusterName -DatabaseName -ResourceGroupName + [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] ``` ### Create ``` -New-AzKustoScript -ClusterName -DatabaseName -Name -ResourceGroupName +New-AzKustoScript -Name -ClusterName -DatabaseName -ResourceGroupName [-SubscriptionId ] -Parameter [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] ``` +### CreateViaIdentityClusterExpanded +``` +New-AzKustoScript -Name -DatabaseName -ClusterInputObject [-ContinueOnError] + [-ForceUpdateTag ] [-PrincipalPermissionsAction ] [-ScriptContent ] + [-ScriptLevel ] [-ScriptUrl ] [-ScriptUrlSasToken ] [-DefaultProfile ] + [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] +``` + +### CreateViaIdentityCluster +``` +New-AzKustoScript -Name -DatabaseName -ClusterInputObject + -Parameter [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### CreateViaIdentityDatabaseExpanded +``` +New-AzKustoScript -Name -DatabaseInputObject [-ContinueOnError] + [-ForceUpdateTag ] [-PrincipalPermissionsAction ] [-ScriptContent ] + [-ScriptLevel ] [-ScriptUrl ] [-ScriptUrlSasToken ] [-DefaultProfile ] + [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] +``` + +### CreateViaIdentityDatabase +``` +New-AzKustoScript -Name -DatabaseInputObject -Parameter + [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [] +``` + ## DESCRIPTION -Creates a Kusto database script. +Create a Kusto database script. ## EXAMPLES @@ -44,7 +88,7 @@ Name Type testnewkustocluster/mykustodatabase/newkustoscript Microsoft.Kusto/Clusters/Databases/Scripts ``` -The above command creates a Kusto database script named "newkustoscript" in the resource group "testrg". +The above command creates a Kusto database script named "newkustocript" in the resource group "testrg". This script contains database scoped commands and the permissions of the script executor will be removed upon completion @@ -65,12 +109,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ClusterInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: CreateViaIdentityClusterExpanded, CreateViaIdentityCluster +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ClusterName The name of the Kusto cluster. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath, Create Aliases: Required: True @@ -85,7 +144,7 @@ Flag that indicates whether to continue if one of the command fails. ```yaml Type: System.Management.Automation.SwitchParameter -Parameter Sets: CreateExpanded +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded, CreateViaIdentityDatabaseExpanded Aliases: Required: False @@ -95,12 +154,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DatabaseInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: CreateViaIdentityDatabaseExpanded, CreateViaIdentityDatabase +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -DatabaseName The name of the database in the Kusto cluster. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath, Create, CreateViaIdentityClusterExpanded, CreateViaIdentityCluster Aliases: Required: True @@ -132,7 +206,7 @@ If changed the script will be applied again. ```yaml Type: System.String -Parameter Sets: CreateExpanded +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded, CreateViaIdentityDatabaseExpanded Aliases: Required: False @@ -142,6 +216,36 @@ 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 +``` + ### -Name The name of the Kusto database script. @@ -174,11 +278,10 @@ Accept wildcard characters: False ### -Parameter Class representing a database script. -To construct, see NOTES section for PARAMETER properties and create a hash table. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IScript -Parameter Sets: Create +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IScript +Parameter Sets: Create, CreateViaIdentityCluster, CreateViaIdentityDatabase Aliases: Required: True @@ -192,8 +295,8 @@ Accept wildcard characters: False Indicates if the permissions for the script caller are kept following completion of the script. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.PrincipalPermissionsAction -Parameter Sets: CreateExpanded +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded, CreateViaIdentityDatabaseExpanded Aliases: Required: False @@ -209,7 +312,7 @@ The name is case insensitive. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath, Create Aliases: Required: True @@ -226,7 +329,7 @@ Must not be used together with scriptUrl and scriptUrlSasToken properties. ```yaml Type: System.String -Parameter Sets: CreateExpanded +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded, CreateViaIdentityDatabaseExpanded Aliases: Required: False @@ -241,8 +344,8 @@ Differentiates between the type of script commands included - Database or Cluste The default is Database. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.ScriptLevel -Parameter Sets: CreateExpanded +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded, CreateViaIdentityDatabaseExpanded Aliases: Required: False @@ -258,7 +361,7 @@ Must not be used together with scriptContent property ```yaml Type: System.String -Parameter Sets: CreateExpanded +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded, CreateViaIdentityDatabaseExpanded Aliases: Required: False @@ -274,7 +377,7 @@ Must be provided when using scriptUrl property. ```yaml Type: System.String -Parameter Sets: CreateExpanded +Parameter Sets: CreateExpanded, CreateViaIdentityClusterExpanded, CreateViaIdentityDatabaseExpanded Aliases: Required: False @@ -289,7 +392,7 @@ The ID of the target subscription. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath, Create Aliases: Required: False @@ -335,11 +438,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IScript +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity + +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IScript ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IScript +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IScript ## NOTES diff --git a/src/Kusto/Kusto/help/Remove-AzKustoAttachedDatabaseConfiguration.md b/src/Kusto/Kusto/help/Remove-AzKustoAttachedDatabaseConfiguration.md index d4bf6f479123..5052383bd59e 100644 --- a/src/Kusto/Kusto/help/Remove-AzKustoAttachedDatabaseConfiguration.md +++ b/src/Kusto/Kusto/help/Remove-AzKustoAttachedDatabaseConfiguration.md @@ -19,6 +19,13 @@ Remove-AzKustoAttachedDatabaseConfiguration -ClusterName -Name [-WhatIf] [-Confirm] [] ``` +### DeleteViaIdentityCluster +``` +Remove-AzKustoAttachedDatabaseConfiguration -Name -ClusterInputObject + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] + [-Confirm] [] +``` + ### DeleteViaIdentity ``` Remove-AzKustoAttachedDatabaseConfiguration -InputObject [-DefaultProfile ] [-AsJob] @@ -54,6 +61,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ClusterInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: DeleteViaIdentityCluster +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ClusterName The name of the Kusto cluster. @@ -87,7 +109,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -106,7 +127,7 @@ The name of the attached database configuration. ```yaml Type: System.String -Parameter Sets: Delete +Parameter Sets: Delete, DeleteViaIdentityCluster Aliases: AttachedDatabaseConfigurationName Required: True diff --git a/src/Kusto/Kusto/help/Remove-AzKustoCluster.md b/src/Kusto/Kusto/help/Remove-AzKustoCluster.md index fbe477e4a0f4..7259626fe642 100644 --- a/src/Kusto/Kusto/help/Remove-AzKustoCluster.md +++ b/src/Kusto/Kusto/help/Remove-AzKustoCluster.md @@ -72,7 +72,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity diff --git a/src/Kusto/Kusto/help/Remove-AzKustoClusterCalloutPolicy.md b/src/Kusto/Kusto/help/Remove-AzKustoClusterCalloutPolicy.md index 5fb5e7bbf425..6e95c5eb252f 100644 --- a/src/Kusto/Kusto/help/Remove-AzKustoClusterCalloutPolicy.md +++ b/src/Kusto/Kusto/help/Remove-AzKustoClusterCalloutPolicy.md @@ -19,6 +19,20 @@ Remove-AzKustoClusterCalloutPolicy -ClusterName -ResourceGroupName ] ``` +### RemoveViaJsonString +``` +Remove-AzKustoClusterCalloutPolicy -ClusterName -ResourceGroupName [-SubscriptionId ] + -JsonString [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-WhatIf] [-Confirm] [] +``` + +### RemoveViaJsonFilePath +``` +Remove-AzKustoClusterCalloutPolicy -ClusterName -ResourceGroupName [-SubscriptionId ] + -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-WhatIf] [-Confirm] [] +``` + ### Remove ``` Remove-AzKustoClusterCalloutPolicy -ClusterName -ResourceGroupName [-SubscriptionId ] @@ -86,10 +100,9 @@ Accept wildcard characters: False ### -CalloutPolicy Configuration for an external callout policy to remove. -To construct, see NOTES section for CALLOUTPOLICY properties and create a hash table. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ICalloutPolicyToRemove +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ICalloutPolicyToRemove Parameter Sets: Remove, RemoveViaIdentity Aliases: @@ -105,7 +118,7 @@ The name of the Kusto cluster. ```yaml Type: System.String -Parameter Sets: RemoveExpanded, Remove +Parameter Sets: RemoveExpanded, RemoveViaJsonString, RemoveViaJsonFilePath, Remove Aliases: Required: True @@ -133,7 +146,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -147,6 +159,36 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -JsonFilePath +Path of Json file supplied to the Remove operation + +```yaml +Type: System.String +Parameter Sets: RemoveViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Remove operation + +```yaml +Type: System.String +Parameter Sets: RemoveViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -NoWait Run the command asynchronously @@ -183,7 +225,7 @@ The name is case insensitive. ```yaml Type: System.String -Parameter Sets: RemoveExpanded, Remove +Parameter Sets: RemoveExpanded, RemoveViaJsonString, RemoveViaJsonFilePath, Remove Aliases: Required: True @@ -198,7 +240,7 @@ The ID of the target subscription. ```yaml Type: System.String -Parameter Sets: RemoveExpanded, Remove +Parameter Sets: RemoveExpanded, RemoveViaJsonString, RemoveViaJsonFilePath, Remove Aliases: Required: False @@ -244,7 +286,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ICalloutPolicyToRemove +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ICalloutPolicyToRemove ### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity diff --git a/src/Kusto/Kusto/help/Remove-AzKustoClusterLanguageExtension.md b/src/Kusto/Kusto/help/Remove-AzKustoClusterLanguageExtension.md index 21cc9aced7f3..c79684634ae2 100644 --- a/src/Kusto/Kusto/help/Remove-AzKustoClusterLanguageExtension.md +++ b/src/Kusto/Kusto/help/Remove-AzKustoClusterLanguageExtension.md @@ -19,6 +19,20 @@ Remove-AzKustoClusterLanguageExtension -ClusterName -ResourceGroupName [-PassThru] [-WhatIf] [-Confirm] [] ``` +### RemoveViaJsonString +``` +Remove-AzKustoClusterLanguageExtension -ClusterName -ResourceGroupName + [-SubscriptionId ] -JsonString [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-WhatIf] [-Confirm] [] +``` + +### RemoveViaJsonFilePath +``` +Remove-AzKustoClusterLanguageExtension -ClusterName -ResourceGroupName + [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-WhatIf] [-Confirm] [] +``` + ### RemoveViaIdentityExpanded ``` Remove-AzKustoClusterLanguageExtension -InputObject [-Value ] @@ -60,7 +74,7 @@ The name of the Kusto cluster. ```yaml Type: System.String -Parameter Sets: RemoveExpanded +Parameter Sets: RemoveExpanded, RemoveViaJsonString, RemoveViaJsonFilePath Aliases: Required: True @@ -88,7 +102,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -102,6 +115,36 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -JsonFilePath +Path of Json file supplied to the Remove operation + +```yaml +Type: System.String +Parameter Sets: RemoveViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Remove operation + +```yaml +Type: System.String +Parameter Sets: RemoveViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -NoWait Run the command asynchronously @@ -138,7 +181,7 @@ The name is case insensitive. ```yaml Type: System.String -Parameter Sets: RemoveExpanded +Parameter Sets: RemoveExpanded, RemoveViaJsonString, RemoveViaJsonFilePath Aliases: Required: True @@ -153,7 +196,7 @@ The ID of the target subscription. ```yaml Type: System.String -Parameter Sets: RemoveExpanded +Parameter Sets: RemoveExpanded, RemoveViaJsonString, RemoveViaJsonFilePath Aliases: Required: False @@ -165,11 +208,10 @@ Accept wildcard characters: False ### -Value The list of language extensions. -To construct, see NOTES section for VALUE properties and create a hash table. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ILanguageExtension[] -Parameter Sets: (All) +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ILanguageExtension[] +Parameter Sets: RemoveExpanded, RemoveViaIdentityExpanded Aliases: Required: False diff --git a/src/Kusto/Kusto/help/Remove-AzKustoClusterPrincipalAssignment.md b/src/Kusto/Kusto/help/Remove-AzKustoClusterPrincipalAssignment.md index 03be4cabf3a3..1b84da05ef39 100644 --- a/src/Kusto/Kusto/help/Remove-AzKustoClusterPrincipalAssignment.md +++ b/src/Kusto/Kusto/help/Remove-AzKustoClusterPrincipalAssignment.md @@ -19,6 +19,13 @@ Remove-AzKustoClusterPrincipalAssignment -ClusterName -PrincipalAssignm [-PassThru] [-WhatIf] [-Confirm] [] ``` +### DeleteViaIdentityCluster +``` +Remove-AzKustoClusterPrincipalAssignment -PrincipalAssignmentName -ClusterInputObject + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] + [-Confirm] [] +``` + ### DeleteViaIdentity ``` Remove-AzKustoClusterPrincipalAssignment -InputObject [-DefaultProfile ] [-AsJob] @@ -54,6 +61,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ClusterInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: DeleteViaIdentityCluster +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ClusterName The name of the Kusto cluster. @@ -87,7 +109,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -136,7 +157,7 @@ The name of the Kusto principalAssignment. ```yaml Type: System.String -Parameter Sets: Delete +Parameter Sets: Delete, DeleteViaIdentityCluster Aliases: Required: True diff --git a/src/Kusto/Kusto/help/Remove-AzKustoDataConnection.md b/src/Kusto/Kusto/help/Remove-AzKustoDataConnection.md index 0601528d60a5..991136986599 100644 --- a/src/Kusto/Kusto/help/Remove-AzKustoDataConnection.md +++ b/src/Kusto/Kusto/help/Remove-AzKustoDataConnection.md @@ -19,6 +19,19 @@ Remove-AzKustoDataConnection -ClusterName -DatabaseName -Name [-PassThru] [-WhatIf] [-Confirm] [] ``` +### DeleteViaIdentityCluster +``` +Remove-AzKustoDataConnection -DatabaseName -Name -ClusterInputObject + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] + [-Confirm] [] +``` + +### DeleteViaIdentityDatabase +``` +Remove-AzKustoDataConnection -Name -DatabaseInputObject [-DefaultProfile ] + [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] +``` + ### DeleteViaIdentity ``` Remove-AzKustoDataConnection -InputObject [-DefaultProfile ] [-AsJob] [-NoWait] @@ -54,6 +67,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ClusterInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: DeleteViaIdentityCluster +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ClusterName The name of the Kusto cluster. @@ -69,12 +97,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DatabaseInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: DeleteViaIdentityDatabase +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -DatabaseName The name of the database in the Kusto cluster. ```yaml Type: System.String -Parameter Sets: Delete +Parameter Sets: Delete, DeleteViaIdentityCluster Aliases: Required: True @@ -102,7 +145,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -121,7 +163,7 @@ The name of the data connection. ```yaml Type: System.String -Parameter Sets: Delete +Parameter Sets: Delete, DeleteViaIdentityCluster, DeleteViaIdentityDatabase Aliases: DataConnectionName Required: True diff --git a/src/Kusto/Kusto/help/Remove-AzKustoDatabase.md b/src/Kusto/Kusto/help/Remove-AzKustoDatabase.md index cd55d55ce0b0..1b14af512298 100644 --- a/src/Kusto/Kusto/help/Remove-AzKustoDatabase.md +++ b/src/Kusto/Kusto/help/Remove-AzKustoDatabase.md @@ -19,6 +19,12 @@ Remove-AzKustoDatabase -ClusterName -Name -ResourceGroupName < [-WhatIf] [-Confirm] [] ``` +### DeleteViaIdentityCluster +``` +Remove-AzKustoDatabase -Name -ClusterInputObject [-DefaultProfile ] + [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] +``` + ### DeleteViaIdentity ``` Remove-AzKustoDatabase -InputObject [-DefaultProfile ] [-AsJob] [-NoWait] @@ -54,6 +60,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ClusterInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: DeleteViaIdentityCluster +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ClusterName The name of the Kusto cluster. @@ -87,7 +108,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -106,7 +126,7 @@ The name of the database in the Kusto cluster. ```yaml Type: System.String -Parameter Sets: Delete +Parameter Sets: Delete, DeleteViaIdentityCluster Aliases: DatabaseName Required: True diff --git a/src/Kusto/Kusto/help/Remove-AzKustoDatabasePrincipal.md b/src/Kusto/Kusto/help/Remove-AzKustoDatabasePrincipal.md index 261fc7a64fc7..5192847a1603 100644 --- a/src/Kusto/Kusto/help/Remove-AzKustoDatabasePrincipal.md +++ b/src/Kusto/Kusto/help/Remove-AzKustoDatabasePrincipal.md @@ -19,6 +19,27 @@ Remove-AzKustoDatabasePrincipal -ClusterName -DatabaseName -Re [-WhatIf] [-Confirm] [] ``` +### RemoveViaJsonString +``` +Remove-AzKustoDatabasePrincipal -ClusterName -DatabaseName -ResourceGroupName + [-SubscriptionId ] -JsonString [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### RemoveViaJsonFilePath +``` +Remove-AzKustoDatabasePrincipal -ClusterName -DatabaseName -ResourceGroupName + [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### RemoveViaIdentityClusterExpanded +``` +Remove-AzKustoDatabasePrincipal -DatabaseName -ClusterInputObject + [-Value ] [-DefaultProfile ] [-WhatIf] + [-Confirm] [] +``` + ### RemoveViaIdentityExpanded ``` Remove-AzKustoDatabasePrincipal -InputObject [-Value ] @@ -45,12 +66,27 @@ The above command removes Database principals permissions ## PARAMETERS +### -ClusterInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: RemoveViaIdentityClusterExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ClusterName The name of the Kusto cluster. ```yaml Type: System.String -Parameter Sets: RemoveExpanded +Parameter Sets: RemoveExpanded, RemoveViaJsonString, RemoveViaJsonFilePath Aliases: Required: True @@ -65,7 +101,7 @@ The name of the database in the Kusto cluster. ```yaml Type: System.String -Parameter Sets: RemoveExpanded +Parameter Sets: RemoveExpanded, RemoveViaJsonString, RemoveViaJsonFilePath, RemoveViaIdentityClusterExpanded Aliases: Required: True @@ -93,7 +129,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -107,13 +142,43 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -JsonFilePath +Path of Json file supplied to the Remove operation + +```yaml +Type: System.String +Parameter Sets: RemoveViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Remove operation + +```yaml +Type: System.String +Parameter Sets: RemoveViaJsonString +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: RemoveExpanded +Parameter Sets: RemoveExpanded, RemoveViaJsonString, RemoveViaJsonFilePath Aliases: Required: True @@ -128,7 +193,7 @@ The ID of the target subscription. ```yaml Type: System.String -Parameter Sets: RemoveExpanded +Parameter Sets: RemoveExpanded, RemoveViaJsonString, RemoveViaJsonFilePath Aliases: Required: False @@ -140,11 +205,10 @@ Accept wildcard characters: False ### -Value The list of Kusto database principals. -To construct, see NOTES section for VALUE properties and create a hash table. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IDatabasePrincipal[] -Parameter Sets: (All) +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IDatabasePrincipal[] +Parameter Sets: RemoveExpanded, RemoveViaIdentityClusterExpanded, RemoveViaIdentityExpanded Aliases: Required: False @@ -194,7 +258,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IDatabasePrincipal +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IDatabasePrincipalListResult ## NOTES diff --git a/src/Kusto/Kusto/help/Remove-AzKustoDatabasePrincipalAssignment.md b/src/Kusto/Kusto/help/Remove-AzKustoDatabasePrincipalAssignment.md index 44a7a16c3188..45a807f269c8 100644 --- a/src/Kusto/Kusto/help/Remove-AzKustoDatabasePrincipalAssignment.md +++ b/src/Kusto/Kusto/help/Remove-AzKustoDatabasePrincipalAssignment.md @@ -20,6 +20,20 @@ Remove-AzKustoDatabasePrincipalAssignment -ClusterName -DatabaseName ] ``` +### DeleteViaIdentityCluster +``` +Remove-AzKustoDatabasePrincipalAssignment -DatabaseName -PrincipalAssignmentName + -ClusterInputObject [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-WhatIf] [-Confirm] [] +``` + +### DeleteViaIdentityDatabase +``` +Remove-AzKustoDatabasePrincipalAssignment -PrincipalAssignmentName + -DatabaseInputObject [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-WhatIf] [-Confirm] [] +``` + ### DeleteViaIdentity ``` Remove-AzKustoDatabasePrincipalAssignment -InputObject [-DefaultProfile ] [-AsJob] @@ -55,6 +69,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ClusterInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: DeleteViaIdentityCluster +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ClusterName The name of the Kusto cluster. @@ -70,12 +99,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DatabaseInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: DeleteViaIdentityDatabase +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -DatabaseName The name of the database in the Kusto cluster. ```yaml Type: System.String -Parameter Sets: Delete +Parameter Sets: Delete, DeleteViaIdentityCluster Aliases: Required: True @@ -103,7 +147,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -152,7 +195,7 @@ The name of the Kusto principalAssignment. ```yaml Type: System.String -Parameter Sets: Delete +Parameter Sets: Delete, DeleteViaIdentityCluster, DeleteViaIdentityDatabase Aliases: Required: True diff --git a/src/Kusto/Kusto/help/Remove-AzKustoManagedPrivateEndpoint.md b/src/Kusto/Kusto/help/Remove-AzKustoManagedPrivateEndpoint.md index 530a73c4c7cd..713eadb646a5 100644 --- a/src/Kusto/Kusto/help/Remove-AzKustoManagedPrivateEndpoint.md +++ b/src/Kusto/Kusto/help/Remove-AzKustoManagedPrivateEndpoint.md @@ -19,6 +19,13 @@ Remove-AzKustoManagedPrivateEndpoint -ClusterName -Name -Resou [-WhatIf] [-Confirm] [] ``` +### DeleteViaIdentityCluster +``` +Remove-AzKustoManagedPrivateEndpoint -Name -ClusterInputObject + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] + [-Confirm] [] +``` + ### DeleteViaIdentity ``` Remove-AzKustoManagedPrivateEndpoint -InputObject [-DefaultProfile ] [-AsJob] @@ -54,6 +61,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ClusterInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: DeleteViaIdentityCluster +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ClusterName The name of the Kusto cluster. @@ -87,7 +109,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -106,7 +127,7 @@ The name of the managed private endpoint. ```yaml Type: System.String -Parameter Sets: Delete +Parameter Sets: Delete, DeleteViaIdentityCluster Aliases: ManagedPrivateEndpointName Required: True diff --git a/src/Kusto/Kusto/help/Remove-AzKustoPrivateEndpointConnection.md b/src/Kusto/Kusto/help/Remove-AzKustoPrivateEndpointConnection.md deleted file mode 100644 index e2faa69f1b83..000000000000 --- a/src/Kusto/Kusto/help/Remove-AzKustoPrivateEndpointConnection.md +++ /dev/null @@ -1,224 +0,0 @@ ---- -external help file: Az.Kusto-help.xml -Module Name: Az.Kusto -online version: https://learn.microsoft.com/powershell/module/az.kusto/remove-azkustoprivateendpointconnection -schema: 2.0.0 ---- - -# Remove-AzKustoPrivateEndpointConnection - -## SYNOPSIS -Deletes a private endpoint connection with a given name. - -## SYNTAX - -### Delete (Default) -``` -Remove-AzKustoPrivateEndpointConnection -ClusterName -Name -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] - [-WhatIf] [-Confirm] [] -``` - -### DeleteViaIdentity -``` -Remove-AzKustoPrivateEndpointConnection -InputObject [-DefaultProfile ] [-AsJob] - [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Deletes a private endpoint connection with a given name. - -## EXAMPLES - -### Example 1: Delete an existing Kusto PrivateEndpointConnection by name -```powershell -Remove-AzKustoPrivateEndpointConnection -ClusterName "mycluster" -ResourceGroupName "testrg" -Name "testprivateconnection-12345678-1234-1234-1234-123456789098" -``` - -The above command deletes the Kusto PrivateEndpointConnection named "testprivateconnection-12345678-1234-1234-1234-123456789098" in the cluster "mycluster" found in the resource group "testrg". - -## 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 -``` - -### -ClusterName -The name of the Kusto cluster. - -```yaml -Type: System.String -Parameter Sets: Delete -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 -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity -Parameter Sets: DeleteViaIdentity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -The name of the private endpoint connection. - -```yaml -Type: System.String -Parameter Sets: Delete -Aliases: PrivateEndpointConnectionName - -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. - -```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.Kusto.Models.IKustoIdentity - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS diff --git a/src/Kusto/Kusto/help/Remove-AzKustoSandboxCustomImage.md b/src/Kusto/Kusto/help/Remove-AzKustoSandboxCustomImage.md index 0f183480563b..041818506401 100644 --- a/src/Kusto/Kusto/help/Remove-AzKustoSandboxCustomImage.md +++ b/src/Kusto/Kusto/help/Remove-AzKustoSandboxCustomImage.md @@ -19,6 +19,13 @@ Remove-AzKustoSandboxCustomImage -ClusterName -Name -ResourceG [-WhatIf] [-Confirm] [] ``` +### DeleteViaIdentityCluster +``` +Remove-AzKustoSandboxCustomImage -Name -ClusterInputObject + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] + [-Confirm] [] +``` + ### DeleteViaIdentity ``` Remove-AzKustoSandboxCustomImage -InputObject [-DefaultProfile ] [-AsJob] [-NoWait] @@ -54,6 +61,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ClusterInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: DeleteViaIdentityCluster +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ClusterName The name of the Kusto cluster. @@ -87,7 +109,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -106,7 +127,7 @@ The name of the sandbox custom image. ```yaml Type: System.String -Parameter Sets: Delete +Parameter Sets: Delete, DeleteViaIdentityCluster Aliases: SandboxCustomImageName Required: True diff --git a/src/Kusto/Kusto/help/Remove-AzKustoScript.md b/src/Kusto/Kusto/help/Remove-AzKustoScript.md index f90f7d0230b8..93df57bea8f9 100644 --- a/src/Kusto/Kusto/help/Remove-AzKustoScript.md +++ b/src/Kusto/Kusto/help/Remove-AzKustoScript.md @@ -19,6 +19,19 @@ Remove-AzKustoScript -ClusterName -DatabaseName -Name [-WhatIf] [-Confirm] [] ``` +### DeleteViaIdentityCluster +``` +Remove-AzKustoScript -DatabaseName -Name -ClusterInputObject + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] + [-Confirm] [] +``` + +### DeleteViaIdentityDatabase +``` +Remove-AzKustoScript -Name -DatabaseInputObject [-DefaultProfile ] [-AsJob] + [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] +``` + ### DeleteViaIdentity ``` Remove-AzKustoScript -InputObject [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] @@ -54,6 +67,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ClusterInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: DeleteViaIdentityCluster +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ClusterName The name of the Kusto cluster. @@ -69,12 +97,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DatabaseInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: DeleteViaIdentityDatabase +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -DatabaseName The name of the database in the Kusto cluster. ```yaml Type: System.String -Parameter Sets: Delete +Parameter Sets: Delete, DeleteViaIdentityCluster Aliases: Required: True @@ -102,7 +145,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -121,7 +163,7 @@ The name of the Kusto database script. ```yaml Type: System.String -Parameter Sets: Delete +Parameter Sets: Delete, DeleteViaIdentityCluster, DeleteViaIdentityDatabase Aliases: ScriptName Required: True diff --git a/src/Kusto/Kusto/help/Start-AzKustoCluster.md b/src/Kusto/Kusto/help/Start-AzKustoCluster.md index 63270465d78c..4e5ba75500c7 100644 --- a/src/Kusto/Kusto/help/Start-AzKustoCluster.md +++ b/src/Kusto/Kusto/help/Start-AzKustoCluster.md @@ -72,7 +72,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity diff --git a/src/Kusto/Kusto/help/Stop-AzKustoCluster.md b/src/Kusto/Kusto/help/Stop-AzKustoCluster.md index 2125c859afaa..94abf481a107 100644 --- a/src/Kusto/Kusto/help/Stop-AzKustoCluster.md +++ b/src/Kusto/Kusto/help/Stop-AzKustoCluster.md @@ -72,7 +72,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity diff --git a/src/Kusto/Kusto/help/Test-AzKustoAttachedDatabaseConfigurationNameAvailability.md b/src/Kusto/Kusto/help/Test-AzKustoAttachedDatabaseConfigurationNameAvailability.md index 001a276e11e8..e8fe699dcfe2 100644 --- a/src/Kusto/Kusto/help/Test-AzKustoAttachedDatabaseConfigurationNameAvailability.md +++ b/src/Kusto/Kusto/help/Test-AzKustoAttachedDatabaseConfigurationNameAvailability.md @@ -19,6 +19,20 @@ Test-AzKustoAttachedDatabaseConfigurationNameAvailability -ClusterName [-WhatIf] [-Confirm] [] ``` +### CheckViaJsonString +``` +Test-AzKustoAttachedDatabaseConfigurationNameAvailability -ClusterName -ResourceGroupName + [-SubscriptionId ] -JsonString [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### CheckViaJsonFilePath +``` +Test-AzKustoAttachedDatabaseConfigurationNameAvailability -ClusterName -ResourceGroupName + [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + ### CheckViaIdentityExpanded ``` Test-AzKustoAttachedDatabaseConfigurationNameAvailability -InputObject -Name @@ -50,7 +64,7 @@ The name of the Kusto cluster. ```yaml Type: System.String -Parameter Sets: CheckExpanded +Parameter Sets: CheckExpanded, CheckViaJsonString, CheckViaJsonFilePath Aliases: Required: True @@ -78,7 +92,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -92,12 +105,42 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -JsonFilePath +Path of Json file supplied to the Check operation + +```yaml +Type: System.String +Parameter Sets: CheckViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Check operation + +```yaml +Type: System.String +Parameter Sets: CheckViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name Attached database resource name. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CheckExpanded, CheckViaIdentityExpanded Aliases: Required: True @@ -113,7 +156,7 @@ The name is case insensitive. ```yaml Type: System.String -Parameter Sets: CheckExpanded +Parameter Sets: CheckExpanded, CheckViaJsonString, CheckViaJsonFilePath Aliases: Required: True @@ -128,7 +171,7 @@ The ID of the target subscription. ```yaml Type: System.String -Parameter Sets: CheckExpanded +Parameter Sets: CheckExpanded, CheckViaJsonString, CheckViaJsonFilePath Aliases: Required: False @@ -178,7 +221,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ICheckNameResult +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ICheckNameResult ## NOTES diff --git a/src/Kusto/Kusto/help/Test-AzKustoClusterNameAvailability.md b/src/Kusto/Kusto/help/Test-AzKustoClusterNameAvailability.md index e09eedd21033..55a027e56e93 100644 --- a/src/Kusto/Kusto/help/Test-AzKustoClusterNameAvailability.md +++ b/src/Kusto/Kusto/help/Test-AzKustoClusterNameAvailability.md @@ -18,6 +18,18 @@ Test-AzKustoClusterNameAvailability -Location [-SubscriptionId [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` +### CheckViaJsonString +``` +Test-AzKustoClusterNameAvailability -Location [-SubscriptionId ] -JsonString + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### CheckViaJsonFilePath +``` +Test-AzKustoClusterNameAvailability -Location [-SubscriptionId ] -JsonFilePath + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + ### CheckViaIdentityExpanded ``` Test-AzKustoClusterNameAvailability -InputObject -Name [-DefaultProfile ] @@ -75,7 +87,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -89,12 +100,42 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -JsonFilePath +Path of Json file supplied to the Check operation + +```yaml +Type: System.String +Parameter Sets: CheckViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Check operation + +```yaml +Type: System.String +Parameter Sets: CheckViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Location The name of Azure region. ```yaml Type: System.String -Parameter Sets: CheckExpanded +Parameter Sets: CheckExpanded, CheckViaJsonString, CheckViaJsonFilePath Aliases: Required: True @@ -109,7 +150,7 @@ Cluster name. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CheckExpanded, CheckViaIdentityExpanded Aliases: Required: True @@ -124,7 +165,7 @@ The ID of the target subscription. ```yaml Type: System.String -Parameter Sets: CheckExpanded +Parameter Sets: CheckExpanded, CheckViaJsonString, CheckViaJsonFilePath Aliases: Required: False @@ -174,7 +215,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ICheckNameResult +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ICheckNameResult ## NOTES diff --git a/src/Kusto/Kusto/help/Test-AzKustoClusterPrincipalAssignmentNameAvailability.md b/src/Kusto/Kusto/help/Test-AzKustoClusterPrincipalAssignmentNameAvailability.md index 452049ea498b..f7f6ac008045 100644 --- a/src/Kusto/Kusto/help/Test-AzKustoClusterPrincipalAssignmentNameAvailability.md +++ b/src/Kusto/Kusto/help/Test-AzKustoClusterPrincipalAssignmentNameAvailability.md @@ -19,6 +19,20 @@ Test-AzKustoClusterPrincipalAssignmentNameAvailability -ClusterName -Re [-WhatIf] [-Confirm] [] ``` +### CheckViaJsonString +``` +Test-AzKustoClusterPrincipalAssignmentNameAvailability -ClusterName -ResourceGroupName + [-SubscriptionId ] -JsonString [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### CheckViaJsonFilePath +``` +Test-AzKustoClusterPrincipalAssignmentNameAvailability -ClusterName -ResourceGroupName + [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + ### CheckViaIdentityExpanded ``` Test-AzKustoClusterPrincipalAssignmentNameAvailability -InputObject -Name @@ -63,7 +77,7 @@ The name of the Kusto cluster. ```yaml Type: System.String -Parameter Sets: CheckExpanded +Parameter Sets: CheckExpanded, CheckViaJsonString, CheckViaJsonFilePath Aliases: Required: True @@ -91,7 +105,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -105,12 +118,42 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -JsonFilePath +Path of Json file supplied to the Check operation + +```yaml +Type: System.String +Parameter Sets: CheckViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Check operation + +```yaml +Type: System.String +Parameter Sets: CheckViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name Principal Assignment resource name. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CheckExpanded, CheckViaIdentityExpanded Aliases: Required: True @@ -126,7 +169,7 @@ The name is case insensitive. ```yaml Type: System.String -Parameter Sets: CheckExpanded +Parameter Sets: CheckExpanded, CheckViaJsonString, CheckViaJsonFilePath Aliases: Required: True @@ -141,7 +184,7 @@ The ID of the target subscription. ```yaml Type: System.String -Parameter Sets: CheckExpanded +Parameter Sets: CheckExpanded, CheckViaJsonString, CheckViaJsonFilePath Aliases: Required: False @@ -191,7 +234,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ICheckNameResult +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ICheckNameResult ## NOTES diff --git a/src/Kusto/Kusto/help/Test-AzKustoDataConnectionNameAvailability.md b/src/Kusto/Kusto/help/Test-AzKustoDataConnectionNameAvailability.md index fb46b3365717..0a472ef6c7dd 100644 --- a/src/Kusto/Kusto/help/Test-AzKustoDataConnectionNameAvailability.md +++ b/src/Kusto/Kusto/help/Test-AzKustoDataConnectionNameAvailability.md @@ -19,6 +19,27 @@ Test-AzKustoDataConnectionNameAvailability -ClusterName -DatabaseName < [-WhatIf] [-Confirm] [] ``` +### CheckViaJsonString +``` +Test-AzKustoDataConnectionNameAvailability -ClusterName -DatabaseName + -ResourceGroupName [-SubscriptionId ] -JsonString [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### CheckViaJsonFilePath +``` +Test-AzKustoDataConnectionNameAvailability -ClusterName -DatabaseName + -ResourceGroupName [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### CheckViaIdentityClusterExpanded +``` +Test-AzKustoDataConnectionNameAvailability -DatabaseName -ClusterInputObject + -Name [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + ### CheckViaIdentityExpanded ``` Test-AzKustoDataConnectionNameAvailability -InputObject -Name @@ -58,12 +79,27 @@ The above command returns whether or not a Data Connection named "mydataconnecti ## PARAMETERS +### -ClusterInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: CheckViaIdentityClusterExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ClusterName The name of the Kusto cluster. ```yaml Type: System.String -Parameter Sets: CheckExpanded +Parameter Sets: CheckExpanded, CheckViaJsonString, CheckViaJsonFilePath Aliases: Required: True @@ -78,7 +114,7 @@ The name of the database in the Kusto cluster. ```yaml Type: System.String -Parameter Sets: CheckExpanded +Parameter Sets: CheckExpanded, CheckViaJsonString, CheckViaJsonFilePath, CheckViaIdentityClusterExpanded Aliases: Required: True @@ -106,7 +142,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -120,12 +155,42 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -JsonFilePath +Path of Json file supplied to the Check operation + +```yaml +Type: System.String +Parameter Sets: CheckViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Check operation + +```yaml +Type: System.String +Parameter Sets: CheckViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name Data Connection name. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CheckExpanded, CheckViaIdentityClusterExpanded, CheckViaIdentityExpanded Aliases: Required: True @@ -141,7 +206,7 @@ The name is case insensitive. ```yaml Type: System.String -Parameter Sets: CheckExpanded +Parameter Sets: CheckExpanded, CheckViaJsonString, CheckViaJsonFilePath Aliases: Required: True @@ -156,7 +221,7 @@ The ID of the target subscription. ```yaml Type: System.String -Parameter Sets: CheckExpanded +Parameter Sets: CheckExpanded, CheckViaJsonString, CheckViaJsonFilePath Aliases: Required: False @@ -206,7 +271,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ICheckNameResult +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ICheckNameResult ## NOTES diff --git a/src/Kusto/Kusto/help/Test-AzKustoDatabaseNameAvailability.md b/src/Kusto/Kusto/help/Test-AzKustoDatabaseNameAvailability.md index 237e4fad6766..115567a06607 100644 --- a/src/Kusto/Kusto/help/Test-AzKustoDatabaseNameAvailability.md +++ b/src/Kusto/Kusto/help/Test-AzKustoDatabaseNameAvailability.md @@ -15,13 +15,27 @@ Checks that the databases resource name is valid and is not already in use. ### CheckExpanded (Default) ``` Test-AzKustoDatabaseNameAvailability -ClusterName -ResourceGroupName - [-SubscriptionId ] -Name -Type [-DefaultProfile ] + [-SubscriptionId ] -Name -Type [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### CheckViaJsonString +``` +Test-AzKustoDatabaseNameAvailability -ClusterName -ResourceGroupName + [-SubscriptionId ] -JsonString [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### CheckViaJsonFilePath +``` +Test-AzKustoDatabaseNameAvailability -ClusterName -ResourceGroupName + [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### CheckViaIdentityExpanded ``` -Test-AzKustoDatabaseNameAvailability -InputObject -Name -Type +Test-AzKustoDatabaseNameAvailability -InputObject -Name -Type [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` @@ -63,7 +77,7 @@ The name of the Kusto cluster. ```yaml Type: System.String -Parameter Sets: CheckExpanded +Parameter Sets: CheckExpanded, CheckViaJsonString, CheckViaJsonFilePath Aliases: Required: True @@ -91,7 +105,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -105,12 +118,42 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -JsonFilePath +Path of Json file supplied to the Check operation + +```yaml +Type: System.String +Parameter Sets: CheckViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Check operation + +```yaml +Type: System.String +Parameter Sets: CheckViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name Resource name. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CheckExpanded, CheckViaIdentityExpanded Aliases: Required: True @@ -126,7 +169,7 @@ The name is case insensitive. ```yaml Type: System.String -Parameter Sets: CheckExpanded +Parameter Sets: CheckExpanded, CheckViaJsonString, CheckViaJsonFilePath Aliases: Required: True @@ -141,7 +184,7 @@ The ID of the target subscription. ```yaml Type: System.String -Parameter Sets: CheckExpanded +Parameter Sets: CheckExpanded, CheckViaJsonString, CheckViaJsonFilePath Aliases: Required: False @@ -155,8 +198,8 @@ Accept wildcard characters: False The type of resource, for instance Microsoft.Kusto/Clusters/databases. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.Type -Parameter Sets: (All) +Type: System.String +Parameter Sets: CheckExpanded, CheckViaIdentityExpanded Aliases: Required: True @@ -206,7 +249,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ICheckNameResult +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ICheckNameResult ## NOTES diff --git a/src/Kusto/Kusto/help/Test-AzKustoDatabasePrincipalAssignmentNameAvailability.md b/src/Kusto/Kusto/help/Test-AzKustoDatabasePrincipalAssignmentNameAvailability.md index 7f1e553f6c8e..ec8802d15575 100644 --- a/src/Kusto/Kusto/help/Test-AzKustoDatabasePrincipalAssignmentNameAvailability.md +++ b/src/Kusto/Kusto/help/Test-AzKustoDatabasePrincipalAssignmentNameAvailability.md @@ -19,6 +19,27 @@ Test-AzKustoDatabasePrincipalAssignmentNameAvailability -ClusterName -D [-WhatIf] [-Confirm] [] ``` +### CheckViaJsonString +``` +Test-AzKustoDatabasePrincipalAssignmentNameAvailability -ClusterName -DatabaseName + -ResourceGroupName [-SubscriptionId ] -JsonString [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### CheckViaJsonFilePath +``` +Test-AzKustoDatabasePrincipalAssignmentNameAvailability -ClusterName -DatabaseName + -ResourceGroupName [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### CheckViaIdentityClusterExpanded +``` +Test-AzKustoDatabasePrincipalAssignmentNameAvailability -DatabaseName + -ClusterInputObject -Name [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + ### CheckViaIdentityExpanded ``` Test-AzKustoDatabasePrincipalAssignmentNameAvailability -InputObject -Name @@ -58,12 +79,27 @@ The above command returns whether or not a PrincipalAssignment named "myprincipa ## PARAMETERS +### -ClusterInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: CheckViaIdentityClusterExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ClusterName The name of the Kusto cluster. ```yaml Type: System.String -Parameter Sets: CheckExpanded +Parameter Sets: CheckExpanded, CheckViaJsonString, CheckViaJsonFilePath Aliases: Required: True @@ -78,7 +114,7 @@ The name of the database in the Kusto cluster. ```yaml Type: System.String -Parameter Sets: CheckExpanded +Parameter Sets: CheckExpanded, CheckViaJsonString, CheckViaJsonFilePath, CheckViaIdentityClusterExpanded Aliases: Required: True @@ -106,7 +142,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -120,12 +155,42 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -JsonFilePath +Path of Json file supplied to the Check operation + +```yaml +Type: System.String +Parameter Sets: CheckViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Check operation + +```yaml +Type: System.String +Parameter Sets: CheckViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name Principal Assignment resource name. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CheckExpanded, CheckViaIdentityClusterExpanded, CheckViaIdentityExpanded Aliases: Required: True @@ -141,7 +206,7 @@ The name is case insensitive. ```yaml Type: System.String -Parameter Sets: CheckExpanded +Parameter Sets: CheckExpanded, CheckViaJsonString, CheckViaJsonFilePath Aliases: Required: True @@ -156,7 +221,7 @@ The ID of the target subscription. ```yaml Type: System.String -Parameter Sets: CheckExpanded +Parameter Sets: CheckExpanded, CheckViaJsonString, CheckViaJsonFilePath Aliases: Required: False @@ -206,7 +271,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ICheckNameResult +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ICheckNameResult ## NOTES diff --git a/src/Kusto/Kusto/help/Test-AzKustoManagedPrivateEndpointNameAvailability.md b/src/Kusto/Kusto/help/Test-AzKustoManagedPrivateEndpointNameAvailability.md index 23b5d6d18116..599083966068 100644 --- a/src/Kusto/Kusto/help/Test-AzKustoManagedPrivateEndpointNameAvailability.md +++ b/src/Kusto/Kusto/help/Test-AzKustoManagedPrivateEndpointNameAvailability.md @@ -19,6 +19,20 @@ Test-AzKustoManagedPrivateEndpointNameAvailability -ClusterName -Resour [-WhatIf] [-Confirm] [] ``` +### CheckViaJsonString +``` +Test-AzKustoManagedPrivateEndpointNameAvailability -ClusterName -ResourceGroupName + [-SubscriptionId ] -JsonString [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### CheckViaJsonFilePath +``` +Test-AzKustoManagedPrivateEndpointNameAvailability -ClusterName -ResourceGroupName + [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + ### CheckViaIdentityExpanded ``` Test-AzKustoManagedPrivateEndpointNameAvailability -InputObject -Name @@ -50,7 +64,7 @@ The name of the Kusto cluster. ```yaml Type: System.String -Parameter Sets: CheckExpanded +Parameter Sets: CheckExpanded, CheckViaJsonString, CheckViaJsonFilePath Aliases: Required: True @@ -78,7 +92,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -92,12 +105,42 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -JsonFilePath +Path of Json file supplied to the Check operation + +```yaml +Type: System.String +Parameter Sets: CheckViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Check operation + +```yaml +Type: System.String +Parameter Sets: CheckViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name Managed private endpoint resource name. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CheckExpanded, CheckViaIdentityExpanded Aliases: Required: True @@ -113,7 +156,7 @@ The name is case insensitive. ```yaml Type: System.String -Parameter Sets: CheckExpanded +Parameter Sets: CheckExpanded, CheckViaJsonString, CheckViaJsonFilePath Aliases: Required: True @@ -128,7 +171,7 @@ The ID of the target subscription. ```yaml Type: System.String -Parameter Sets: CheckExpanded +Parameter Sets: CheckExpanded, CheckViaJsonString, CheckViaJsonFilePath Aliases: Required: False @@ -178,7 +221,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ICheckNameResult +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ICheckNameResult ## NOTES diff --git a/src/Kusto/Kusto/help/Test-AzKustoSandboxCustomImageNameAvailability.md b/src/Kusto/Kusto/help/Test-AzKustoSandboxCustomImageNameAvailability.md index 95b1f36332b8..eb7cd78f956f 100644 --- a/src/Kusto/Kusto/help/Test-AzKustoSandboxCustomImageNameAvailability.md +++ b/src/Kusto/Kusto/help/Test-AzKustoSandboxCustomImageNameAvailability.md @@ -19,6 +19,20 @@ Test-AzKustoSandboxCustomImageNameAvailability -ClusterName -ResourceGr [-WhatIf] [-Confirm] [] ``` +### CheckViaJsonString +``` +Test-AzKustoSandboxCustomImageNameAvailability -ClusterName -ResourceGroupName + [-SubscriptionId ] -JsonString [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### CheckViaJsonFilePath +``` +Test-AzKustoSandboxCustomImageNameAvailability -ClusterName -ResourceGroupName + [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + ### CheckViaIdentityExpanded ``` Test-AzKustoSandboxCustomImageNameAvailability -InputObject -Name @@ -50,7 +64,7 @@ The name of the Kusto cluster. ```yaml Type: System.String -Parameter Sets: CheckExpanded +Parameter Sets: CheckExpanded, CheckViaJsonString, CheckViaJsonFilePath Aliases: Required: True @@ -78,7 +92,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -92,12 +105,42 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -JsonFilePath +Path of Json file supplied to the Check operation + +```yaml +Type: System.String +Parameter Sets: CheckViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Check operation + +```yaml +Type: System.String +Parameter Sets: CheckViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name Sandbox custom image resource name. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CheckExpanded, CheckViaIdentityExpanded Aliases: Required: True @@ -113,7 +156,7 @@ The name is case insensitive. ```yaml Type: System.String -Parameter Sets: CheckExpanded +Parameter Sets: CheckExpanded, CheckViaJsonString, CheckViaJsonFilePath Aliases: Required: True @@ -128,7 +171,7 @@ The ID of the target subscription. ```yaml Type: System.String -Parameter Sets: CheckExpanded +Parameter Sets: CheckExpanded, CheckViaJsonString, CheckViaJsonFilePath Aliases: Required: False @@ -178,7 +221,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ICheckNameResult +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ICheckNameResult ## NOTES diff --git a/src/Kusto/Kusto/help/Test-AzKustoScriptNameAvailability.md b/src/Kusto/Kusto/help/Test-AzKustoScriptNameAvailability.md index 85ff7ba6aee3..752afec46fc0 100644 --- a/src/Kusto/Kusto/help/Test-AzKustoScriptNameAvailability.md +++ b/src/Kusto/Kusto/help/Test-AzKustoScriptNameAvailability.md @@ -19,6 +19,26 @@ Test-AzKustoScriptNameAvailability -ClusterName -DatabaseName [-WhatIf] [-Confirm] [] ``` +### CheckViaJsonString +``` +Test-AzKustoScriptNameAvailability -ClusterName -DatabaseName -ResourceGroupName + [-SubscriptionId ] -JsonString [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### CheckViaJsonFilePath +``` +Test-AzKustoScriptNameAvailability -ClusterName -DatabaseName -ResourceGroupName + [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### CheckViaIdentityClusterExpanded +``` +Test-AzKustoScriptNameAvailability -DatabaseName -ClusterInputObject -Name + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + ### CheckViaIdentityExpanded ``` Test-AzKustoScriptNameAvailability -InputObject -Name [-DefaultProfile ] @@ -58,12 +78,27 @@ The above command checks that the script name which is not valid. ## PARAMETERS +### -ClusterInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: CheckViaIdentityClusterExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ClusterName The name of the Kusto cluster. ```yaml Type: System.String -Parameter Sets: CheckExpanded +Parameter Sets: CheckExpanded, CheckViaJsonString, CheckViaJsonFilePath Aliases: Required: True @@ -78,7 +113,7 @@ The name of the database in the Kusto cluster. ```yaml Type: System.String -Parameter Sets: CheckExpanded +Parameter Sets: CheckExpanded, CheckViaJsonString, CheckViaJsonFilePath, CheckViaIdentityClusterExpanded Aliases: Required: True @@ -106,7 +141,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -120,12 +154,42 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -JsonFilePath +Path of Json file supplied to the Check operation + +```yaml +Type: System.String +Parameter Sets: CheckViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Check operation + +```yaml +Type: System.String +Parameter Sets: CheckViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name Script name. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CheckExpanded, CheckViaIdentityClusterExpanded, CheckViaIdentityExpanded Aliases: Required: True @@ -141,7 +205,7 @@ The name is case insensitive. ```yaml Type: System.String -Parameter Sets: CheckExpanded +Parameter Sets: CheckExpanded, CheckViaJsonString, CheckViaJsonFilePath Aliases: Required: True @@ -156,7 +220,7 @@ The ID of the target subscription. ```yaml Type: System.String -Parameter Sets: CheckExpanded +Parameter Sets: CheckExpanded, CheckViaJsonString, CheckViaJsonFilePath Aliases: Required: False @@ -206,7 +270,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ICheckNameResult +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ICheckNameResult ## NOTES diff --git a/src/Kusto/Kusto/help/Update-AzKustoCluster.md b/src/Kusto/Kusto/help/Update-AzKustoCluster.md index 77a9d2e3e97c..f04173e6dc0f 100644 --- a/src/Kusto/Kusto/help/Update-AzKustoCluster.md +++ b/src/Kusto/Kusto/help/Update-AzKustoCluster.md @@ -15,40 +15,34 @@ Update a Kusto cluster. ### UpdateExpanded (Default) ``` Update-AzKustoCluster -Name -ResourceGroupName [-SubscriptionId ] [-IfMatch ] - [-AcceptedAudience ] [-AllowedFqdnList ] [-AllowedIPRangeList ] - [-CalloutPolicy ] [-EnableAutoStop] [-EnableDiskEncryption] [-EnableDoubleEncryption] - [-EnablePurge] [-EnableStreamingIngest] [-EngineType ] [-IdentityType ] - [-IdentityUserAssignedIdentity ] [-KeyVaultPropertyKeyName ] - [-KeyVaultPropertyKeyVaultUri ] [-KeyVaultPropertyKeyVersion ] - [-KeyVaultPropertyUserIdentity ] [-LanguageExtensionValue ] [-Location ] - [-OptimizedAutoscaleIsEnabled] [-OptimizedAutoscaleMaximum ] [-OptimizedAutoscaleMinimum ] - [-OptimizedAutoscaleVersion ] [-PublicIPType ] - [-PublicNetworkAccess ] [-RestrictOutboundNetworkAccess ] - [-SkuCapacity ] [-SkuName ] [-SkuTier ] [-Tag ] - [-TrustedExternalTenant ] [-VirtualClusterGraduationProperty ] - [-VirtualNetworkConfigurationDataManagementPublicIPId ] - [-VirtualNetworkConfigurationEnginePublicIPId ] [-VirtualNetworkConfigurationState ] - [-VirtualNetworkConfigurationSubnetId ] [-Zone ] [-DefaultProfile ] [-AsJob] + [-IfNoneMatch ] [-AcceptedAudience ] [-AllowedFqdnList ] + [-AllowedIPRangeList ] [-CalloutPolicy ] [-EnableAutoStop] [-EnableDiskEncryption] + [-EnableDoubleEncryption] [-EnablePurge] [-EnableStreamingIngest] [-EnableSystemAssignedIdentity ] + [-EngineType ] [-KeyVaultPropertyKeyName ] [-KeyVaultPropertyKeyVaultUri ] + [-KeyVaultPropertyKeyVersion ] [-KeyVaultPropertyUserIdentity ] + [-LanguageExtensionValue ] [-OptimizedAutoscaleIsEnabled] + [-OptimizedAutoscaleMaximum ] [-OptimizedAutoscaleMinimum ] [-OptimizedAutoscaleVersion ] + [-PublicIPType ] [-PublicNetworkAccess ] [-RestrictOutboundNetworkAccess ] + [-SkuCapacity ] [-SkuName ] [-SkuTier ] [-Tag ] + [-TrustedExternalTenant ] [-UserAssignedIdentity ] + [-VirtualNetworkConfigurationState ] [-Zone ] [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] ``` ### UpdateViaIdentityExpanded ``` -Update-AzKustoCluster -InputObject [-IfMatch ] +Update-AzKustoCluster -InputObject [-IfMatch ] [-IfNoneMatch ] [-AcceptedAudience ] [-AllowedFqdnList ] [-AllowedIPRangeList ] [-CalloutPolicy ] [-EnableAutoStop] [-EnableDiskEncryption] [-EnableDoubleEncryption] - [-EnablePurge] [-EnableStreamingIngest] [-EngineType ] [-IdentityType ] - [-IdentityUserAssignedIdentity ] [-KeyVaultPropertyKeyName ] - [-KeyVaultPropertyKeyVaultUri ] [-KeyVaultPropertyKeyVersion ] - [-KeyVaultPropertyUserIdentity ] [-LanguageExtensionValue ] [-Location ] - [-OptimizedAutoscaleIsEnabled] [-OptimizedAutoscaleMaximum ] [-OptimizedAutoscaleMinimum ] - [-OptimizedAutoscaleVersion ] [-PublicIPType ] - [-PublicNetworkAccess ] [-RestrictOutboundNetworkAccess ] - [-SkuCapacity ] [-SkuName ] [-SkuTier ] [-Tag ] - [-TrustedExternalTenant ] [-VirtualClusterGraduationProperty ] - [-VirtualNetworkConfigurationDataManagementPublicIPId ] - [-VirtualNetworkConfigurationEnginePublicIPId ] [-VirtualNetworkConfigurationState ] - [-VirtualNetworkConfigurationSubnetId ] [-Zone ] [-DefaultProfile ] [-AsJob] + [-EnablePurge] [-EnableStreamingIngest] [-EnableSystemAssignedIdentity ] [-EngineType ] + [-KeyVaultPropertyKeyName ] [-KeyVaultPropertyKeyVaultUri ] + [-KeyVaultPropertyKeyVersion ] [-KeyVaultPropertyUserIdentity ] + [-LanguageExtensionValue ] [-OptimizedAutoscaleIsEnabled] + [-OptimizedAutoscaleMaximum ] [-OptimizedAutoscaleMinimum ] [-OptimizedAutoscaleVersion ] + [-PublicIPType ] [-PublicNetworkAccess ] [-RestrictOutboundNetworkAccess ] + [-SkuCapacity ] [-SkuName ] [-SkuTier ] [-Tag ] + [-TrustedExternalTenant ] [-UserAssignedIdentity ] + [-VirtualNetworkConfigurationState ] [-Zone ] [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] ``` @@ -87,10 +81,9 @@ The above command updates the cluster "testnewkustocluster" found in the resourc ### -AcceptedAudience The cluster's accepted audiences. -To construct, see NOTES section for ACCEPTEDAUDIENCE properties and create a hash table. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IAcceptedAudiences[] +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IAcceptedAudiences[] Parameter Sets: (All) Aliases: @@ -148,10 +141,9 @@ Accept wildcard characters: False ### -CalloutPolicy List of callout policies for egress from Cluster. -To construct, see NOTES section for CALLOUTPOLICY properties and create a hash table. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ICalloutPolicy[] +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ICalloutPolicy[] Parameter Sets: (All) Aliases: @@ -253,11 +245,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EngineType -The engine type +### -EnableSystemAssignedIdentity +Determines whether to enable a system-assigned identity for the resource. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.EngineType +Type: System.Nullable`1[System.Boolean] Parameter Sets: (All) Aliases: @@ -268,13 +260,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IdentityType -The type of managed identity used. -The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. -The type 'None' will remove all identities. +### -EngineType +The engine type ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.IdentityType +Type: System.String Parameter Sets: (All) Aliases: @@ -285,12 +275,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IdentityUserAssignedIdentity -The list of user identities associated with the Kusto cluster. -The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. +### -IfMatch +The ETag of the cluster. +Omit this value to always overwrite the current cluster. +Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes. ```yaml -Type: System.Collections.Hashtable +Type: System.String Parameter Sets: (All) Aliases: @@ -301,10 +292,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IfMatch -The ETag of the cluster. -Omit this value to always overwrite the current cluster. -Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes. +### -IfNoneMatch +Set to '*' to allow a new cluster to be created, but to prevent updating an existing cluster. +Other values will result in a 412 Pre-condition Failed response. ```yaml Type: System.String @@ -320,7 +310,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -396,25 +385,9 @@ Accept wildcard characters: False ### -LanguageExtensionValue The list of language extensions. -To construct, see NOTES section for LANGUAGEEXTENSIONVALUE properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ILanguageExtension[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Resource location. ```yaml -Type: System.String +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ILanguageExtension[] Parameter Sets: (All) Aliases: @@ -519,7 +492,7 @@ Accept wildcard characters: False Indicates what public IP type to create - IPv4 (default), or DualStack (both IPv4 and IPv6) ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.PublicIPType +Type: System.String Parameter Sets: (All) Aliases: @@ -535,7 +508,7 @@ Public network access to the cluster is enabled by default. When disabled, only private endpoint connection to the cluster is allowed ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.PublicNetworkAccess +Type: System.String Parameter Sets: (All) Aliases: @@ -567,7 +540,7 @@ Whether or not to restrict outbound network access. Value is optional but if passed in, must be 'Enabled' or 'Disabled' ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.ClusterNetworkAccessFlag +Type: System.String Parameter Sets: (All) Aliases: @@ -597,7 +570,7 @@ Accept wildcard characters: False SKU name. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.AzureSkuName +Type: System.String Parameter Sets: (All) Aliases: @@ -612,7 +585,7 @@ Accept wildcard characters: False SKU tier. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.AzureSkuTier +Type: System.String Parameter Sets: (All) Aliases: @@ -655,10 +628,9 @@ Accept wildcard characters: False ### -TrustedExternalTenant The cluster's external tenants. -To construct, see NOTES section for TRUSTEDEXTERNALTENANT properties and create a hash table. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ITrustedExternalTenant[] +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ITrustedExternalTenant[] Parameter Sets: (All) Aliases: @@ -669,41 +641,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -VirtualClusterGraduationProperty -Virtual Cluster graduation properties +### -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: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualNetworkConfigurationDataManagementPublicIPId -Data management's service public IP address resource id. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualNetworkConfigurationEnginePublicIPId -Engine service's public IP address resource id. - -```yaml -Type: System.String +Type: System.String[] Parameter Sets: (All) Aliases: @@ -717,21 +660,6 @@ Accept wildcard characters: False ### -VirtualNetworkConfigurationState When enabled, the cluster is deployed into the configured subnet, when disabled it will be removed from the subnet. -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.VnetState -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualNetworkConfigurationSubnetId -The subnet resource id. - ```yaml Type: System.String Parameter Sets: (All) @@ -799,7 +727,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.ICluster +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.ICluster ## NOTES diff --git a/src/Kusto/Kusto/help/Update-AzKustoDataConnection.md b/src/Kusto/Kusto/help/Update-AzKustoDataConnection.md index c9671c58da31..145dcc9a0c68 100644 --- a/src/Kusto/Kusto/help/Update-AzKustoDataConnection.md +++ b/src/Kusto/Kusto/help/Update-AzKustoDataConnection.md @@ -8,37 +8,38 @@ schema: 2.0.0 # Update-AzKustoDataConnection ## SYNOPSIS -Updates a data connection. +Update a data connection. ## SYNTAX ### UpdateExpandedEventHub (Default) ``` Update-AzKustoDataConnection -ClusterName -DatabaseName -Name - -ResourceGroupName [-SubscriptionId ] -Kind -Location [-TableName ] - -EventHubResourceId -ConsumerGroup [-DataFormat ] [-EventSystemProperty ] - [-MappingRuleName ] [-Compression ] [-ManagedIdentityResourceId ] - [-DatabaseRouting ] [-RetrievalStartDate ] [-DefaultProfile ] [-AsJob] - [-NoWait] [-WhatIf] [-Confirm] [] + -ResourceGroupName [-SubscriptionId ] -Kind -EventHubResourceId + -ConsumerGroup -Location [-DataFormat ] [-EventSystemProperty ] + [-MappingRuleName ] [-TableName ] [-Compression ] + [-ManagedIdentityResourceId ] [-DatabaseRouting ] [-RetrievalStartDate ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [] ``` ### UpdateExpandedEventGrid ``` Update-AzKustoDataConnection -ClusterName -DatabaseName -Name - -ResourceGroupName [-SubscriptionId ] -Kind -Location [-TableName ] - -EventHubResourceId -ConsumerGroup [-DataFormat ] [-MappingRuleName ] - [-ManagedIdentityResourceId ] [-DatabaseRouting ] -StorageAccountResourceId - [-BlobStorageEventType ] [-IgnoreFirstRecord] [-EventGridResourceId ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] - [] + -ResourceGroupName [-SubscriptionId ] -Kind -EventHubResourceId + -ConsumerGroup -Location [-DataFormat ] [-MappingRuleName ] + [-TableName ] [-ManagedIdentityResourceId ] [-DatabaseRouting ] + -StorageAccountResourceId [-BlobStorageEventType ] [-IgnoreFirstRecord] + [-EventGridResourceId ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] ``` ### UpdateExpandedIotHub ``` Update-AzKustoDataConnection -ClusterName -DatabaseName -Name - -ResourceGroupName [-SubscriptionId ] -Kind -Location [-TableName ] - -ConsumerGroup [-DataFormat ] [-EventSystemProperty ] [-MappingRuleName ] - [-DatabaseRouting ] [-RetrievalStartDate ] -IotHubResourceId + -ResourceGroupName [-SubscriptionId ] -Kind -ConsumerGroup + -Location [-DataFormat ] [-EventSystemProperty ] [-MappingRuleName ] + [-TableName ] [-DatabaseRouting ] [-RetrievalStartDate ] -IotHubResourceId -SharedAccessPolicyName [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] ``` @@ -46,53 +47,67 @@ Update-AzKustoDataConnection -ClusterName -DatabaseName -Name ### UpdateExpandedCosmosDb ``` Update-AzKustoDataConnection -ClusterName -DatabaseName -Name - -ResourceGroupName [-SubscriptionId ] -Kind -Location [-TableName ] - [-MappingRuleName ] -ManagedIdentityResourceId [-RetrievalStartDate ] - -CosmosDbAccountResourceId -CosmosDbDatabase -CosmosDbContainer - [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] - [] + -ResourceGroupName [-SubscriptionId ] -Kind -Location + [-MappingRuleName ] -TableName -ManagedIdentityResourceId + [-RetrievalStartDate ] -CosmosDbAccountResourceId -CosmosDbDatabase + -CosmosDbContainer [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### UpdateViaJsonString +``` +Update-AzKustoDataConnection -ClusterName -DatabaseName -Name + -ResourceGroupName [-SubscriptionId ] -JsonString [-DefaultProfile ] + [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] +``` + +### UpdateViaJsonFilePath +``` +Update-AzKustoDataConnection -ClusterName -DatabaseName -Name + -ResourceGroupName [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] + [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] ``` ### UpdateViaIdentityExpandedEventHub ``` -Update-AzKustoDataConnection -InputObject -Kind -Location - [-TableName ] -EventHubResourceId -ConsumerGroup [-DataFormat ] - [-EventSystemProperty ] [-MappingRuleName ] [-Compression ] - [-ManagedIdentityResourceId ] [-DatabaseRouting ] [-RetrievalStartDate ] +Update-AzKustoDataConnection -InputObject -Kind -EventHubResourceId + -ConsumerGroup -Location [-DataFormat ] [-EventSystemProperty ] + [-MappingRuleName ] [-TableName ] [-Compression ] + [-ManagedIdentityResourceId ] [-DatabaseRouting ] [-RetrievalStartDate ] [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] ``` ### UpdateViaIdentityExpandedEventGrid ``` -Update-AzKustoDataConnection -InputObject -Kind -Location - [-TableName ] -EventHubResourceId -ConsumerGroup [-DataFormat ] - [-MappingRuleName ] [-ManagedIdentityResourceId ] [-DatabaseRouting ] - -StorageAccountResourceId [-BlobStorageEventType ] [-IgnoreFirstRecord] +Update-AzKustoDataConnection -InputObject -Kind -EventHubResourceId + -ConsumerGroup -Location [-DataFormat ] [-MappingRuleName ] + [-TableName ] [-ManagedIdentityResourceId ] [-DatabaseRouting ] + -StorageAccountResourceId [-BlobStorageEventType ] [-IgnoreFirstRecord] [-EventGridResourceId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] ``` ### UpdateViaIdentityExpandedIotHub ``` -Update-AzKustoDataConnection -InputObject -Kind -Location - [-TableName ] -ConsumerGroup [-DataFormat ] [-EventSystemProperty ] - [-MappingRuleName ] [-DatabaseRouting ] [-RetrievalStartDate ] - -IotHubResourceId -SharedAccessPolicyName [-DefaultProfile ] [-AsJob] [-NoWait] +Update-AzKustoDataConnection -InputObject -Kind -ConsumerGroup + -Location [-DataFormat ] [-EventSystemProperty ] [-MappingRuleName ] + [-TableName ] [-DatabaseRouting ] [-RetrievalStartDate ] -IotHubResourceId + -SharedAccessPolicyName [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] ``` ### UpdateViaIdentityExpandedCosmosDb ``` -Update-AzKustoDataConnection -InputObject -Kind -Location - [-TableName ] [-MappingRuleName ] -ManagedIdentityResourceId +Update-AzKustoDataConnection -InputObject -Kind -Location + [-MappingRuleName ] -TableName -ManagedIdentityResourceId [-RetrievalStartDate ] -CosmosDbAccountResourceId -CosmosDbDatabase -CosmosDbContainer [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -Updates a data connection. +Update a data connection. ## EXAMPLES @@ -198,7 +213,7 @@ Accept wildcard characters: False The name of blob storage event type to process. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.BlobStorageEventType +Type: System.String Parameter Sets: UpdateExpandedEventGrid, UpdateViaIdentityExpandedEventGrid Aliases: @@ -214,7 +229,7 @@ The name of the Kusto cluster. ```yaml Type: System.String -Parameter Sets: UpdateExpandedEventHub, UpdateExpandedEventGrid, UpdateExpandedIotHub, UpdateExpandedCosmosDb +Parameter Sets: UpdateExpandedEventHub, UpdateExpandedEventGrid, UpdateExpandedIotHub, UpdateExpandedCosmosDb, UpdateViaJsonString, UpdateViaJsonFilePath Aliases: Required: True @@ -228,7 +243,7 @@ Accept wildcard characters: False The event hub messages compression type. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.Compression +Type: System.String Parameter Sets: UpdateExpandedEventHub, UpdateViaIdentityExpandedEventHub Aliases: @@ -304,7 +319,7 @@ The name of the database in the Kusto cluster. ```yaml Type: System.String -Parameter Sets: UpdateExpandedEventHub, UpdateExpandedEventGrid, UpdateExpandedIotHub, UpdateExpandedCosmosDb +Parameter Sets: UpdateExpandedEventHub, UpdateExpandedEventGrid, UpdateExpandedIotHub, UpdateExpandedCosmosDb, UpdateViaJsonString, UpdateViaJsonFilePath Aliases: Required: True @@ -318,7 +333,7 @@ Accept wildcard characters: False Indication for database routing information from the data connection, by default only database routing information is allowed. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.DatabaseRouting +Type: System.String Parameter Sets: UpdateExpandedEventHub, UpdateExpandedEventGrid, UpdateExpandedIotHub, UpdateViaIdentityExpandedEventHub, UpdateViaIdentityExpandedEventGrid, UpdateViaIdentityExpandedIotHub Aliases: @@ -346,7 +361,8 @@ Accept wildcard characters: False ``` ### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. +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 @@ -451,12 +467,42 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -JsonFilePath +Path of Json file supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Kind Kind of the endpoint for the data connection ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.Kind -Parameter Sets: (All) +Type: System.String +Parameter Sets: UpdateExpandedEventHub, UpdateExpandedEventGrid, UpdateExpandedIotHub, UpdateExpandedCosmosDb, UpdateViaIdentityExpandedEventHub, UpdateViaIdentityExpandedEventGrid, UpdateViaIdentityExpandedIotHub, UpdateViaIdentityExpandedCosmosDb Aliases: Required: True @@ -471,7 +517,7 @@ Resource location. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: UpdateExpandedEventHub, UpdateExpandedEventGrid, UpdateExpandedIotHub, UpdateExpandedCosmosDb, UpdateViaIdentityExpandedEventHub, UpdateViaIdentityExpandedEventGrid, UpdateViaIdentityExpandedIotHub, UpdateViaIdentityExpandedCosmosDb Aliases: Required: True @@ -514,7 +560,7 @@ Optionally the mapping information can be added to each message. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: UpdateExpandedEventHub, UpdateExpandedEventGrid, UpdateExpandedIotHub, UpdateExpandedCosmosDb, UpdateViaIdentityExpandedEventHub, UpdateViaIdentityExpandedEventGrid, UpdateViaIdentityExpandedIotHub, UpdateViaIdentityExpandedCosmosDb Aliases: Required: False @@ -529,7 +575,7 @@ The name of the data connection. ```yaml Type: System.String -Parameter Sets: UpdateExpandedEventHub, UpdateExpandedEventGrid, UpdateExpandedIotHub, UpdateExpandedCosmosDb +Parameter Sets: UpdateExpandedEventHub, UpdateExpandedEventGrid, UpdateExpandedIotHub, UpdateExpandedCosmosDb, UpdateViaJsonString, UpdateViaJsonFilePath Aliases: DataConnectionName Required: True @@ -555,11 +601,12 @@ Accept wildcard characters: False ``` ### -ResourceGroupName -The name of the resource group containing the Kusto cluster. +The name of the resource group. +The name is case insensitive. ```yaml Type: System.String -Parameter Sets: UpdateExpandedEventHub, UpdateExpandedEventGrid, UpdateExpandedIotHub, UpdateExpandedCosmosDb +Parameter Sets: UpdateExpandedEventHub, UpdateExpandedEventGrid, UpdateExpandedIotHub, UpdateExpandedCosmosDb, UpdateViaJsonString, UpdateViaJsonFilePath Aliases: Required: True @@ -616,12 +663,11 @@ Accept wildcard characters: False ``` ### -SubscriptionId -Gets subscription credentials which uniquely identify Microsoft Azure subscription. -The subscription ID forms part of the URI for every service call. +The ID of the target subscription. ```yaml Type: System.String -Parameter Sets: UpdateExpandedEventHub, UpdateExpandedEventGrid, UpdateExpandedIotHub, UpdateExpandedCosmosDb +Parameter Sets: UpdateExpandedEventHub, UpdateExpandedEventGrid, UpdateExpandedIotHub, UpdateExpandedCosmosDb, UpdateViaJsonString, UpdateViaJsonFilePath Aliases: Required: False @@ -637,7 +683,7 @@ Optionally the table information can be added to each message. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: UpdateExpandedEventHub, UpdateExpandedEventGrid, UpdateExpandedIotHub, UpdateViaIdentityExpandedEventHub, UpdateViaIdentityExpandedEventGrid, UpdateViaIdentityExpandedIotHub Aliases: Required: False @@ -647,6 +693,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` +```yaml +Type: System.String +Parameter Sets: UpdateExpandedCosmosDb, UpdateViaIdentityExpandedCosmosDb +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Confirm Prompts you for confirmation before running the cmdlet. @@ -687,7 +745,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IDataConnection +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IDataConnection ## NOTES diff --git a/src/Kusto/Kusto/help/Update-AzKustoDatabase.md b/src/Kusto/Kusto/help/Update-AzKustoDatabase.md index fc9cd2f10302..99a0d04d4b0b 100644 --- a/src/Kusto/Kusto/help/Update-AzKustoDatabase.md +++ b/src/Kusto/Kusto/help/Update-AzKustoDatabase.md @@ -8,23 +8,37 @@ schema: 2.0.0 # Update-AzKustoDatabase ## SYNOPSIS -Updates a database. +Update a database. ## SYNTAX ### UpdateExpanded (Default) ``` Update-AzKustoDatabase -ClusterName -Name -ResourceGroupName - [-SubscriptionId ] [-CallerRole ] -Kind -Location + [-SubscriptionId ] [-CallerRole ] -Kind -Location [-HotCachePeriod ] [-SoftDeletePeriod ] [-KeyVaultPropertyKeyName ] [-KeyVaultPropertyKeyVaultUri ] [-KeyVaultPropertyKeyVersion ] [-KeyVaultPropertyUserIdentity ] [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] ``` +### UpdateViaJsonString +``` +Update-AzKustoDatabase -ClusterName -Name -ResourceGroupName + [-SubscriptionId ] [-CallerRole ] -JsonString [-DefaultProfile ] [-AsJob] + [-NoWait] [-WhatIf] [-Confirm] [] +``` + +### UpdateViaJsonFilePath +``` +Update-AzKustoDatabase -ClusterName -Name -ResourceGroupName + [-SubscriptionId ] [-CallerRole ] -JsonFilePath [-DefaultProfile ] [-AsJob] + [-NoWait] [-WhatIf] [-Confirm] [] +``` + ### UpdateViaIdentityExpanded ``` -Update-AzKustoDatabase -InputObject [-CallerRole ] -Kind -Location +Update-AzKustoDatabase -InputObject [-CallerRole ] -Kind -Location [-HotCachePeriod ] [-SoftDeletePeriod ] [-KeyVaultPropertyKeyName ] [-KeyVaultPropertyKeyVaultUri ] [-KeyVaultPropertyKeyVersion ] [-KeyVaultPropertyUserIdentity ] [-DefaultProfile ] [-AsJob] [-NoWait] @@ -32,7 +46,7 @@ Update-AzKustoDatabase -InputObject [-CallerRole ] ``` ## DESCRIPTION -Updates a database. +Update a database. ## EXAMPLES @@ -118,7 +132,7 @@ By default, any user who run operation on a database become an Admin on it. This property allows the caller to exclude the caller from Admins list. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.CallerRole +Type: System.String Parameter Sets: (All) Aliases: @@ -134,7 +148,7 @@ The name of the Kusto cluster. ```yaml Type: System.String -Parameter Sets: UpdateExpanded +Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath Aliases: Required: True @@ -145,7 +159,8 @@ Accept wildcard characters: False ``` ### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. +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 @@ -164,7 +179,7 @@ The time the data should be kept in cache for fast queries in TimeSpan. ```yaml Type: System.TimeSpan -Parameter Sets: (All) +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: Required: False @@ -190,12 +205,42 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -JsonFilePath +Path of Json file supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -KeyVaultPropertyKeyName The name of the key vault key. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: Required: False @@ -210,7 +255,7 @@ The Uri of the key vault. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: Required: False @@ -225,7 +270,7 @@ The version of the key vault key. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: Required: False @@ -240,7 +285,7 @@ The user assigned identity (ARM resource id) that has access to the key. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: Required: False @@ -254,8 +299,8 @@ Accept wildcard characters: False Kind of the database ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.Kind -Parameter Sets: (All) +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: Required: True @@ -270,7 +315,7 @@ Resource location. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: Required: True @@ -285,7 +330,7 @@ The name of the database in the Kusto cluster. ```yaml Type: System.String -Parameter Sets: UpdateExpanded +Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath Aliases: DatabaseName Required: True @@ -311,11 +356,12 @@ Accept wildcard characters: False ``` ### -ResourceGroupName -The name of the resource group containing the Kusto cluster. +The name of the resource group. +The name is case insensitive. ```yaml Type: System.String -Parameter Sets: UpdateExpanded +Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath Aliases: Required: True @@ -330,7 +376,7 @@ The time the data should be kept before it stops being accessible to queries in ```yaml Type: System.TimeSpan -Parameter Sets: (All) +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: Required: False @@ -341,12 +387,11 @@ Accept wildcard characters: False ``` ### -SubscriptionId -Gets subscription credentials which uniquely identify Microsoft Azure subscription. -The subscription ID forms part of the URI for every service call. +The ID of the target subscription. ```yaml Type: System.String -Parameter Sets: UpdateExpanded +Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath Aliases: Required: False @@ -396,7 +441,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IDatabase +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IDatabase ## NOTES diff --git a/src/Kusto/Kusto/help/Update-AzKustoManagedPrivateEndpoint.md b/src/Kusto/Kusto/help/Update-AzKustoManagedPrivateEndpoint.md index 81b5e1458a79..f6c8562274a2 100644 --- a/src/Kusto/Kusto/help/Update-AzKustoManagedPrivateEndpoint.md +++ b/src/Kusto/Kusto/help/Update-AzKustoManagedPrivateEndpoint.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Update-AzKustoManagedPrivateEndpoint ## SYNOPSIS -Updates a managed private endpoint. +Update a managed private endpoint. ## SYNTAX @@ -20,6 +20,20 @@ Update-AzKustoManagedPrivateEndpoint -ClusterName -Name -Resou [-NoWait] [-WhatIf] [-Confirm] [] ``` +### UpdateViaJsonString +``` +Update-AzKustoManagedPrivateEndpoint -ClusterName -Name -ResourceGroupName + [-SubscriptionId ] -JsonString [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### UpdateViaJsonFilePath +``` +Update-AzKustoManagedPrivateEndpoint -ClusterName -Name -ResourceGroupName + [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + ### Update ``` Update-AzKustoManagedPrivateEndpoint -ClusterName -Name -ResourceGroupName @@ -27,6 +41,21 @@ Update-AzKustoManagedPrivateEndpoint -ClusterName -Name -Resou [-NoWait] [-WhatIf] [-Confirm] [] ``` +### UpdateViaIdentityClusterExpanded +``` +Update-AzKustoManagedPrivateEndpoint -Name -ClusterInputObject [-GroupId ] + [-PrivateLinkResourceId ] [-PrivateLinkResourceRegion ] [-RequestMessage ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [] +``` + +### UpdateViaIdentityCluster +``` +Update-AzKustoManagedPrivateEndpoint -Name -ClusterInputObject + -Parameter [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + ### UpdateViaIdentityExpanded ``` Update-AzKustoManagedPrivateEndpoint -InputObject [-GroupId ] @@ -43,7 +72,7 @@ Update-AzKustoManagedPrivateEndpoint -InputObject -Parameter -Name -ResourceG [-WhatIf] [-Confirm] [] ``` +### UpdateViaJsonString +``` +Update-AzKustoSandboxCustomImage -ClusterName -Name -ResourceGroupName + [-SubscriptionId ] -JsonString [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### UpdateViaJsonFilePath +``` +Update-AzKustoSandboxCustomImage -ClusterName -Name -ResourceGroupName + [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + ### Update ``` Update-AzKustoSandboxCustomImage -ClusterName -Name -ResourceGroupName @@ -27,6 +41,20 @@ Update-AzKustoSandboxCustomImage -ClusterName -Name -ResourceG [-WhatIf] [-Confirm] [] ``` +### UpdateViaIdentityClusterExpanded +``` +Update-AzKustoSandboxCustomImage -Name -ClusterInputObject [-BaseImageName ] + [-LanguageVersion ] [-RequirementsFileContent ] [-DefaultProfile ] [-AsJob] + [-NoWait] [-WhatIf] [-Confirm] [] +``` + +### UpdateViaIdentityCluster +``` +Update-AzKustoSandboxCustomImage -Name -ClusterInputObject + -Parameter [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + ### UpdateViaIdentityExpanded ``` Update-AzKustoSandboxCustomImage -InputObject [-BaseImageName ] @@ -42,7 +70,7 @@ Update-AzKustoSandboxCustomImage -InputObject -Parameter -DatabaseName -Name -ResourceGroupName [-SubscriptionId ] [-ContinueOnError] [-ForceUpdateTag ] - [-PrincipalPermissionsAction ] [-ScriptContent ] - [-ScriptLevel ] [-ScriptUrl ] [-ScriptUrlSasToken ] [-DefaultProfile ] - [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] + [-PrincipalPermissionsAction ] [-ScriptLevel ] [-ScriptUrl ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [] +``` + +### UpdateViaJsonString +``` +Update-AzKustoScript -ClusterName -DatabaseName -Name -ResourceGroupName + [-SubscriptionId ] -JsonString [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### UpdateViaJsonFilePath +``` +Update-AzKustoScript -ClusterName -DatabaseName -Name -ResourceGroupName + [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] ``` ### Update @@ -28,12 +42,42 @@ Update-AzKustoScript -ClusterName -DatabaseName -Name [-WhatIf] [-Confirm] [] ``` +### UpdateViaIdentityClusterExpanded +``` +Update-AzKustoScript -DatabaseName -Name -ClusterInputObject + [-ContinueOnError] [-ForceUpdateTag ] [-PrincipalPermissionsAction ] [-ScriptLevel ] + [-ScriptUrl ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### UpdateViaIdentityCluster +``` +Update-AzKustoScript -DatabaseName -Name -ClusterInputObject + -Parameter [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### UpdateViaIdentityDatabaseExpanded +``` +Update-AzKustoScript -Name -DatabaseInputObject [-ContinueOnError] + [-ForceUpdateTag ] [-PrincipalPermissionsAction ] [-ScriptLevel ] + [-ScriptUrl ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### UpdateViaIdentityDatabase +``` +Update-AzKustoScript -Name -DatabaseInputObject -Parameter + [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [] +``` + ### UpdateViaIdentityExpanded ``` Update-AzKustoScript -InputObject [-ContinueOnError] [-ForceUpdateTag ] - [-PrincipalPermissionsAction ] [-ScriptContent ] - [-ScriptLevel ] [-ScriptUrl ] [-ScriptUrlSasToken ] [-DefaultProfile ] - [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] + [-PrincipalPermissionsAction ] [-ScriptLevel ] [-ScriptUrl ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [] ``` ### UpdateViaIdentity @@ -43,7 +87,7 @@ Update-AzKustoScript -InputObject -Parameter [-Defaul ``` ## DESCRIPTION -Updates a database script. +Update a database script. ## EXAMPLES @@ -77,12 +121,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ClusterInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: UpdateViaIdentityClusterExpanded, UpdateViaIdentityCluster +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ClusterName The name of the Kusto cluster. ```yaml Type: System.String -Parameter Sets: UpdateExpanded, Update +Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath, Update Aliases: Required: True @@ -97,7 +156,7 @@ Flag that indicates whether to continue if one of the command fails. ```yaml Type: System.Management.Automation.SwitchParameter -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Parameter Sets: UpdateExpanded, UpdateViaIdentityClusterExpanded, UpdateViaIdentityDatabaseExpanded, UpdateViaIdentityExpanded Aliases: Required: False @@ -107,12 +166,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DatabaseInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +Parameter Sets: UpdateViaIdentityDatabaseExpanded, UpdateViaIdentityDatabase +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -DatabaseName The name of the database in the Kusto cluster. ```yaml Type: System.String -Parameter Sets: UpdateExpanded, Update +Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath, Update, UpdateViaIdentityClusterExpanded, UpdateViaIdentityCluster Aliases: Required: True @@ -144,7 +218,7 @@ If changed the script will be applied again. ```yaml Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Parameter Sets: UpdateExpanded, UpdateViaIdentityClusterExpanded, UpdateViaIdentityDatabaseExpanded, UpdateViaIdentityExpanded Aliases: Required: False @@ -156,7 +230,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity @@ -170,12 +243,42 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -JsonFilePath +Path of Json file supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name The name of the Kusto database script. ```yaml Type: System.String -Parameter Sets: UpdateExpanded, Update +Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath, Update, UpdateViaIdentityClusterExpanded, UpdateViaIdentityCluster, UpdateViaIdentityDatabaseExpanded, UpdateViaIdentityDatabase Aliases: ScriptName Required: True @@ -202,11 +305,10 @@ Accept wildcard characters: False ### -Parameter Class representing a database script. -To construct, see NOTES section for PARAMETER properties and create a hash table. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IScript -Parameter Sets: Update, UpdateViaIdentity +Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IScript +Parameter Sets: Update, UpdateViaIdentityCluster, UpdateViaIdentityDatabase, UpdateViaIdentity Aliases: Required: True @@ -220,8 +322,8 @@ Accept wildcard characters: False Indicates if the permissions for the script caller are kept following completion of the script. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.PrincipalPermissionsAction -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityClusterExpanded, UpdateViaIdentityDatabaseExpanded, UpdateViaIdentityExpanded Aliases: Required: False @@ -237,7 +339,7 @@ The name is case insensitive. ```yaml Type: System.String -Parameter Sets: UpdateExpanded, Update +Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath, Update Aliases: Required: True @@ -247,30 +349,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ScriptContent -The script content. -This property should be used when the script is provide inline and not through file in a SA. -Must not be used together with scriptUrl and scriptUrlSasToken properties. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ScriptLevel Differentiates between the type of script commands included - Database or Cluster. The default is Database. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Kusto.Support.ScriptLevel -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityClusterExpanded, UpdateViaIdentityDatabaseExpanded, UpdateViaIdentityExpanded Aliases: Required: False @@ -286,23 +371,7 @@ Must not be used together with scriptContent property ```yaml Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ScriptUrlSasToken -The SaS token that provide read access to the file which contain the script. -Must be provided when using scriptUrl property. - -```yaml -Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Parameter Sets: UpdateExpanded, UpdateViaIdentityClusterExpanded, UpdateViaIdentityDatabaseExpanded, UpdateViaIdentityExpanded Aliases: Required: False @@ -317,7 +386,7 @@ The ID of the target subscription. ```yaml Type: System.String -Parameter Sets: UpdateExpanded, Update +Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath, Update Aliases: Required: False @@ -363,13 +432,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IScript - ### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IKustoIdentity +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IScript + ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.Api20240413.IScript +### Microsoft.Azure.PowerShell.Cmdlets.Kusto.Models.IScript ## NOTES